interconnects

Creates, updates, deletes, gets or lists an interconnects resource.

Overview

Name	`interconnects`
Type	Resource
Id	`google.compute.interconnects`

Fields

The following fields are returned by SELECT queries:

get
list

Name	Datatype	Description
`id`	`string (uint64)`	Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`name`	`string`	Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. (pattern: `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`)
`aaiEnabled`	`boolean`	Enable or disable the application awareness feature on this Cloud Interconnect.
`adminEnabled`	`boolean`	Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.
`applicationAwareInterconnect`	`object`	Configuration information for application awareness on this Cloud Interconnect. (id: InterconnectApplicationAwareInterconnect)
`availableFeatures`	`array`	[Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_MACSEC: If present, then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present, then the Interconnect connection is provisioned on non-MACsec capable ports. Any attempt to enable MACsec will fail. - IF_CROSS_SITE_NETWORK: If present, then the Interconnect connection is provisioned exclusively for Cross-Site Networking. Any attempt to configure VLAN attachments will fail. If not present, then the Interconnect connection is not provisioned for Cross-Site Networking. Any attempt to use it for Cross-Site Networking will fail.
`circuitInfos`	`array`	Output only. [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
`creationTimestamp`	`string`	Output only. [Output Only] Creation timestamp inRFC3339 text format.
`customerName`	`string`	Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource.
`effectiveLocation`	`string`	Output only. URL of the InterconnectLocation object that represents where this connection is to be provisioned. By default it will be the same as the location field.
`expectedOutages`	`array`	Output only. [Output Only] A list of outages expected for this Interconnect.
`googleIpAddress`	`string`	Output only. [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
`googleReferenceId`	`string`	Output only. [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
`interconnectAttachments`	`array`	Output only. [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
`interconnectGroups`	`array`	Output only. [Output Only] URLs of InterconnectGroups that include this Interconnect. Order is arbitrary and items are unique.
`interconnectType`	`string`	Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. (DEDICATED, IT_PRIVATE, PARTNER)
`kind`	`string`	Output only. [Output Only] Type of the resource. Alwayscompute#interconnect for interconnects. (default: compute#interconnect)
`labelFingerprint`	`string (byte)`	A fingerprint for the labels being applied to this Interconnect, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Interconnect.
`labels`	`object`	Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. Label values may be empty.
`linkType`	`string`	Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle. (LINK_TYPE_ETHERNET_100G_LR, LINK_TYPE_ETHERNET_10G_LR, LINK_TYPE_ETHERNET_400G_LR4)
`location`	`string`	URL of the InterconnectLocation object that represents where this connection is to be provisioned.
`macsec`	`object`	Configuration that enables Media Access Control security (MACsec) on the Cloud Interconnect connection between Google and your on-premises router. (id: InterconnectMacsec)
`macsecEnabled`	`boolean`	Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.
`nocContactEmail`	`string`	Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation.
`operationalStatus`	`string`	Output only. [Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. (OS_ACTIVE, OS_UNPROVISIONED)
`params`	`object`	Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. (id: InterconnectParams)
`peerIpAddress`	`string`	Output only. [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests.
`provisionedLinkCount`	`integer (int32)`	Output only. [Output Only] Number of links actually provisioned in this interconnect.
`remoteLocation`	`string`	Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.
`requestedFeatures`	`array`	Optional. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC: If specified, then the connection is created on MACsec capable hardware ports. If not specified, non-MACsec capable ports will also be considered. - IF_CROSS_SITE_NETWORK: If specified, then the connection is created exclusively for Cross-Site Networking. The connection can not be used for Cross-Site Networking unless this feature is specified.
`requestedLinkCount`	`integer (int32)`	Target number of physical links in the link bundle, as requested by the customer.
`satisfiesPzs`	`boolean`	Output only. [Output Only] Reserved for future use.
`selfLink`	`string`	Output only. [Output Only] Server-defined URL for the resource.
`state`	`string`	Output only. [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. (ACTIVE, UNPROVISIONED)
`subzone`	`string`	To be deprecated. (SUBZONE_A, SUBZONE_B)
`wireGroups`	`array`	Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups configured to use this Interconnect. The Interconnect cannot be deleted if this list is non-empty.

Name	Datatype	Description
`id`	`string`	[Output Only] Unique identifier for the resource; defined by the server.
`items`	`array`	A list of Interconnect resources.
`kind`	`string`	Output only. [Output Only] Type of resource. Alwayscompute#interconnectList for lists of interconnects. (default: compute#interconnectList)
`nextPageToken`	`string`	[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
`selfLink`	`string`	Output only. [Output Only] Server-defined URL for this resource.
`warning`	`object`	[Output Only] Informational warning message.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`project`, `interconnect`		Returns the specified Interconnect. Get a list of available Interconnects by making a list() request.
`list`	`select`	`project`	`returnPartialSuccess`, `orderBy`, `maxResults`, `pageToken`, `filter`	Retrieves the list of Interconnects available to the specified project.
`insert`	`insert`	`project`	`requestId`	Creates an Interconnect in the specified project using the data included in the request.
`patch`	`update`	`project`, `interconnect`	`requestId`	Updates the specified Interconnect with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and processing rules.
`delete`	`delete`	`project`, `interconnect`	`requestId`	Deletes the specified Interconnect.
`set_labels`	`exec`	`project`, `resource`		Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`interconnect`	`string`
`project`	`string`
`resource`	`string`
`filter`	`string`
`maxResults`	`integer (uint32)`
`orderBy`	`string`
`pageToken`	`string`
`requestId`	`string`
`returnPartialSuccess`	`boolean`

`SELECT` examples

get
list

Returns the specified Interconnect. Get a list of available Interconnects
by making a list() request.

SELECT
id,
name,
aaiEnabled,
adminEnabled,
applicationAwareInterconnect,
availableFeatures,
circuitInfos,
creationTimestamp,
customerName,
description,
effectiveLocation,
expectedOutages,
googleIpAddress,
googleReferenceId,
interconnectAttachments,
interconnectGroups,
interconnectType,
kind,
labelFingerprint,
labels,
linkType,
location,
macsec,
macsecEnabled,
nocContactEmail,
operationalStatus,
params,
peerIpAddress,
provisionedLinkCount,
remoteLocation,
requestedFeatures,
requestedLinkCount,
satisfiesPzs,
selfLink,
state,
subzone,
wireGroups
FROM google.compute.interconnects
WHERE project = '{{ project }}' -- required
AND interconnect = '{{ interconnect }}' -- required
;

Retrieves the list of Interconnects available to the specified project.

SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.interconnects
WHERE project = '{{ project }}' -- required
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND orderBy = '{{ orderBy }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
;

`INSERT` examples

insert
Manifest

Creates an Interconnect in the specified project using
the data included in the request.

INSERT INTO google.compute.interconnects (
data__subzone,
data__interconnectType,
data__adminEnabled,
data__requestedFeatures,
data__macsecEnabled,
data__linkType,
data__requestedLinkCount,
data__location,
data__labelFingerprint,
data__params,
data__labels,
data__aaiEnabled,
data__nocContactEmail,
data__customerName,
data__macsec,
data__availableFeatures,
data__applicationAwareInterconnect,
data__name,
data__remoteLocation,
data__description,
project,
requestId
)
SELECT 
'{{ subzone }}',
'{{ interconnectType }}',
{{ adminEnabled }},
'{{ requestedFeatures }}',
{{ macsecEnabled }},
'{{ linkType }}',
{{ requestedLinkCount }},
'{{ location }}',
'{{ labelFingerprint }}',
'{{ params }}',
'{{ labels }}',
{{ aaiEnabled }},
'{{ nocContactEmail }}',
'{{ customerName }}',
'{{ macsec }}',
'{{ availableFeatures }}',
'{{ applicationAwareInterconnect }}',
'{{ name }}',
'{{ remoteLocation }}',
'{{ description }}',
'{{ project }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

# Description fields are for documentation purposes
- name: interconnects
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the interconnects resource.
  - name: subzone
    value: "{{ subzone }}"
    description: |
      To be deprecated.
    valid_values: ['SUBZONE_A', 'SUBZONE_B']
  - name: interconnectType
    value: "{{ interconnectType }}"
    description: |
      Type of interconnect, which can take one of the following values:
      - PARTNER: A partner-managed interconnection shared between customers
      though a partner.
      - DEDICATED: A dedicated physical interconnection with the
      customer.
      Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.
    valid_values: ['DEDICATED', 'IT_PRIVATE', 'PARTNER']
  - name: adminEnabled
    value: {{ adminEnabled }}
    description: |
      Administrative status of the interconnect. When this is set to true, the
      Interconnect is functional and can carry traffic.
      When set to false, no packets can be carried over the interconnect and
      no BGP routes are exchanged over it. By default, the status is set to true.
  - name: requestedFeatures
    value:
      - "{{ requestedFeatures }}"
    description: |
      Optional. This parameter can be provided only with Interconnect INSERT. It
      isn't valid for Interconnect PATCH. List of features requested for this
      Interconnect connection, which can take one of the following values:
      - IF_MACSEC: If specified, then the connection is created on MACsec
      capable hardware ports. If not specified, non-MACsec capable ports will
      also be considered.
      - IF_CROSS_SITE_NETWORK: If specified, then the connection is created
      exclusively for Cross-Site Networking. The connection can not be used for
      Cross-Site Networking unless this feature is specified.
  - name: macsecEnabled
    value: {{ macsecEnabled }}
    description: |
      Enable or disable MACsec on this Interconnect connection. MACsec enablement
      fails if the MACsec object is not specified.
  - name: linkType
    value: "{{ linkType }}"
    description: |
      Type of link requested, which can take one of the following values:
      - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
      - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
      - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics.
      Note that this field indicates the speed of each of
      the links in the bundle, not the speed of the entire bundle.
    valid_values: ['LINK_TYPE_ETHERNET_100G_LR', 'LINK_TYPE_ETHERNET_10G_LR', 'LINK_TYPE_ETHERNET_400G_LR4']
  - name: requestedLinkCount
    value: {{ requestedLinkCount }}
    description: |
      Target number of physical links in the link bundle, as requested by the
      customer.
  - name: location
    value: "{{ location }}"
    description: |
      URL of the InterconnectLocation object that represents where this
      connection is to be provisioned.
  - name: labelFingerprint
    value: "{{ labelFingerprint }}"
    description: |
      A fingerprint for the labels being applied to this Interconnect, which
      is essentially a hash of the labels set used for optimistic locking. The
      fingerprint is initially generated by Compute Engine and changes after
      every request to modify or update labels. You must always provide an
      up-to-date fingerprint hash in order to update or change labels,
      otherwise the request will fail with error412 conditionNotMet.
      To see the latest fingerprint, make a get() request to
      retrieve an Interconnect.
  - name: params
    description: |
      Input only. [Input Only] Additional params passed with the request, but not persisted
      as part of resource payload.
    value:
      resourceManagerTags: "{{ resourceManagerTags }}"
  - name: labels
    value: "{{ labels }}"
    description: |
      Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
      Label values may be empty.
  - name: aaiEnabled
    value: {{ aaiEnabled }}
    description: |
      Enable or disable the application awareness feature on this Cloud
      Interconnect.
  - name: nocContactEmail
    value: "{{ nocContactEmail }}"
    description: |
      Email address to contact the customer NOC for operations and maintenance
      notifications regarding this Interconnect. If specified, this will be used
      for notifications in addition to all other forms described, such as
      Cloud Monitoring logs alerting and Cloud Notifications. This field is
      required for users who sign up for Cloud Interconnect using
      workforce identity federation.
  - name: customerName
    value: "{{ customerName }}"
    description: |
      Customer name, to put in the Letter of Authorization as the party
      authorized to request a crossconnect.
  - name: macsec
    description: |
      Configuration that enables Media Access Control security (MACsec) on the
      Cloud Interconnect connection between Google and your on-premises router.
    value:
      failOpen: {{ failOpen }}
      preSharedKeys:
        - startTime: "{{ startTime }}"
          name: "{{ name }}"
  - name: availableFeatures
    value:
      - "{{ availableFeatures }}"
    description: |
      [Output only] List of features available for this Interconnect connection,
      which can take one of the following values:
      - IF_MACSEC: If present, then the Interconnect connection is
      provisioned on MACsec capable hardware ports. If not present, then the
      Interconnect connection is provisioned on non-MACsec capable ports. Any
      attempt to enable MACsec will fail.
      - IF_CROSS_SITE_NETWORK: If present, then the Interconnect connection is
      provisioned exclusively for Cross-Site Networking. Any attempt to configure
      VLAN attachments will fail. If not present, then the Interconnect
      connection is not provisioned for Cross-Site Networking. Any attempt to use
      it for Cross-Site Networking will fail.
  - name: applicationAwareInterconnect
    description: |
      Configuration information for application awareness on this Cloud
      Interconnect.
    value:
      strictPriorityPolicy: "{{ strictPriorityPolicy }}"
      profileDescription: "{{ profileDescription }}"
      shapeAveragePercentages:
        - percentage: {{ percentage }}
          trafficClass: "{{ trafficClass }}"
      bandwidthPercentagePolicy:
        bandwidthPercentages:
          - percentage: {{ percentage }}
            trafficClass: "{{ trafficClass }}"
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource. Provided by the client when the resource is created.
      The name must be 1-63 characters long, and comply withRFC1035.
      Specifically, the name must be 1-63 characters long and match the regular
      expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
      character must be a lowercase letter, and all following characters must be
      a dash, lowercase letter, or digit, except the last character, which cannot
      be a dash.
  - name: remoteLocation
    value: "{{ remoteLocation }}"
    description: |
      Indicates that this is a Cross-Cloud Interconnect. This field specifies the
      location outside of Google's network that the interconnect is connected to.
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of this resource. Provide this property when you
      create the resource.
  - name: requestId
    value: "{{ requestId }}"

`UPDATE` examples

patch

Updates the specified Interconnect with the data included in the request.
This method supportsPATCH
semantics and uses theJSON merge
patch format and processing rules.

UPDATE google.compute.interconnects
SET 
data__subzone = '{{ subzone }}',
data__interconnectType = '{{ interconnectType }}',
data__adminEnabled = {{ adminEnabled }},
data__requestedFeatures = '{{ requestedFeatures }}',
data__macsecEnabled = {{ macsecEnabled }},
data__linkType = '{{ linkType }}',
data__requestedLinkCount = {{ requestedLinkCount }},
data__location = '{{ location }}',
data__labelFingerprint = '{{ labelFingerprint }}',
data__params = '{{ params }}',
data__labels = '{{ labels }}',
data__aaiEnabled = {{ aaiEnabled }},
data__nocContactEmail = '{{ nocContactEmail }}',
data__customerName = '{{ customerName }}',
data__macsec = '{{ macsec }}',
data__availableFeatures = '{{ availableFeatures }}',
data__applicationAwareInterconnect = '{{ applicationAwareInterconnect }}',
data__name = '{{ name }}',
data__remoteLocation = '{{ remoteLocation }}',
data__description = '{{ description }}'
WHERE 
project = '{{ project }}' --required
AND interconnect = '{{ interconnect }}' --required
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

`DELETE` examples

delete

Deletes the specified Interconnect.

DELETE FROM google.compute.interconnects
WHERE project = '{{ project }}' --required
AND interconnect = '{{ interconnect }}' --required
AND requestId = '{{ requestId }}'
;

Lifecycle Methods

set_labels

Sets the labels on an Interconnect. To learn more about labels,
read the Labeling
Resources documentation.

EXEC google.compute.interconnects.set_labels 
@project='{{ project }}' --required, 
@resource='{{ resource }}' --required 
@@json=
'{
"labels": "{{ labels }}", 
"labelFingerprint": "{{ labelFingerprint }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​