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

Successful response

Name	Datatype	Description
`id`	`string (uint64)`	[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 with RFC1035. 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?)
`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 and MACsec isn't supported and enabling MACsec fails.
`circuitInfos`	`array`	[Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
`creationTimestamp`	`string`	[Output Only] Creation timestamp in RFC3339 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.
`expectedOutages`	`array`	[Output Only] A list of outages expected for this Interconnect.
`googleIpAddress`	`string`	[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] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
`interconnectAttachments`	`array`	[Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
`interconnectGroups`	`array`	[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.
`kind`	`string`	[Output Only] Type of the resource. Always compute#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 error 412 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 the setLabels method. Each label key/value pair must comply with RFC1035. 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.
`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] 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.
`peerIpAddress`	`string`	[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] 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. 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, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH.
`requestedLinkCount`	`integer (int32)`	Target number of physical links in the link bundle, as requested by the customer.
`satisfiesPzs`	`boolean`	[Output Only] Reserved for future use.
`selfLink`	`string`	[Output Only] Server-defined URL for the resource.
`state`	`string`	[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.

Successful response

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] Type of resource. Always compute#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 than maxResults, 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] 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`	`filter`, `maxResults`, `orderBy`, `pageToken`, `returnPartialSuccess`	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 supports PATCH semantics and uses the JSON 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,
expectedOutages,
googleIpAddress,
googleReferenceId,
interconnectAttachments,
interconnectGroups,
interconnectType,
kind,
labelFingerprint,
labels,
linkType,
location,
macsec,
macsecEnabled,
nocContactEmail,
operationalStatus,
peerIpAddress,
provisionedLinkCount,
remoteLocation,
requestedFeatures,
requestedLinkCount,
satisfiesPzs,
selfLink,
state
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 filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}';

`INSERT` examples

insert
Manifest

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

INSERT INTO google.compute.interconnects (
data__kind,
data__description,
data__selfLink,
data__id,
data__creationTimestamp,
data__name,
data__location,
data__linkType,
data__requestedLinkCount,
data__interconnectType,
data__adminEnabled,
data__nocContactEmail,
data__customerName,
data__operationalStatus,
data__provisionedLinkCount,
data__interconnectAttachments,
data__peerIpAddress,
data__googleIpAddress,
data__googleReferenceId,
data__expectedOutages,
data__circuitInfos,
data__labels,
data__labelFingerprint,
data__state,
data__satisfiesPzs,
data__macsec,
data__macsecEnabled,
data__remoteLocation,
data__requestedFeatures,
data__availableFeatures,
data__applicationAwareInterconnect,
data__aaiEnabled,
data__interconnectGroups,
project,
requestId
)
SELECT 
'{{ kind }}',
'{{ description }}',
'{{ selfLink }}',
'{{ id }}',
'{{ creationTimestamp }}',
'{{ name }}',
'{{ location }}',
'{{ linkType }}',
{{ requestedLinkCount }},
'{{ interconnectType }}',
{{ adminEnabled }},
'{{ nocContactEmail }}',
'{{ customerName }}',
'{{ operationalStatus }}',
{{ provisionedLinkCount }},
'{{ interconnectAttachments }}',
'{{ peerIpAddress }}',
'{{ googleIpAddress }}',
'{{ googleReferenceId }}',
'{{ expectedOutages }}',
'{{ circuitInfos }}',
'{{ labels }}',
'{{ labelFingerprint }}',
'{{ state }}',
{{ satisfiesPzs }},
'{{ macsec }}',
{{ macsecEnabled }},
'{{ remoteLocation }}',
'{{ requestedFeatures }}',
'{{ availableFeatures }}',
'{{ applicationAwareInterconnect }}',
{{ aaiEnabled }},
'{{ interconnectGroups }}',
'{{ project }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
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: string
      description: Required parameter for the interconnects resource.
    - name: kind
      value: string
      description: >
        [Output Only] Type of the resource. Always compute#interconnect for interconnects.
        
      default: compute#interconnect
    - name: description
      value: string
      description: >
        An optional description of this resource. Provide this property when you create the resource.
        
    - name: selfLink
      value: string
      description: >
        [Output Only] Server-defined URL for the resource.
        
    - name: id
      value: string
      description: >
        [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        
    - name: creationTimestamp
      value: string
      description: >
        [Output Only] Creation timestamp in RFC3339 text format.
        
    - name: name
      value: string
      description: >
        Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. 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: location
      value: string
      description: >
        URL of the InterconnectLocation object that represents where this connection is to be provisioned.
        
    - name: linkType
      value: string
      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: integer
      description: >
        Target number of physical links in the link bundle, as requested by the customer.
        
    - name: interconnectType
      value: string
      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: boolean
      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: nocContactEmail
      value: string
      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: string
      description: >
        Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.
        
    - name: operationalStatus
      value: string
      description: >
        [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. 
        
      valid_values: ['OS_ACTIVE', 'OS_UNPROVISIONED']
    - name: provisionedLinkCount
      value: integer
      description: >
        [Output Only] Number of links actually provisioned in this interconnect.
        
    - name: interconnectAttachments
      value: array
      description: >
        [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
        
    - name: peerIpAddress
      value: string
      description: >
        [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.
        
    - name: googleIpAddress
      value: string
      description: >
        [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
        
    - name: googleReferenceId
      value: string
      description: >
        [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
        
    - name: expectedOutages
      value: array
      description: >
        [Output Only] A list of outages expected for this Interconnect.
        
    - name: circuitInfos
      value: array
      description: >
        [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.
        
    - name: labels
      value: object
      description: >
        Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
        
    - name: labelFingerprint
      value: string
      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 error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Interconnect.
        
    - name: state
      value: string
      description: >
        [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. 
        
      valid_values: ['ACTIVE', 'UNPROVISIONED']
    - name: satisfiesPzs
      value: boolean
      description: >
        [Output Only] Reserved for future use.
        
    - name: macsec
      value: object
      description: >
        Configuration that enables Media Access Control security (MACsec) on the Cloud Interconnect connection between Google and your on-premises router.
        
    - name: macsecEnabled
      value: boolean
      description: >
        Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.
        
    - name: remoteLocation
      value: string
      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: requestedFeatures
      value: array
      description: >
        Optional. 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, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH.
        
    - name: availableFeatures
      value: array
      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 and MACsec isn't supported and enabling MACsec fails.
        
    - name: applicationAwareInterconnect
      value: object
      description: >
        Configuration information for application awareness on this Cloud Interconnect.
        
    - name: aaiEnabled
      value: boolean
      description: >
        Enable or disable the application awareness feature on this Cloud Interconnect.
        
    - name: interconnectGroups
      value: array
      description: >
        [Output Only] URLs of InterconnectGroups that include this Interconnect. Order is arbitrary and items are unique.
        
    - name: requestId
      value: string

`UPDATE` examples

patch

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

UPDATE google.compute.interconnects
SET 
data__kind = '{{ kind }}',
data__description = '{{ description }}',
data__selfLink = '{{ selfLink }}',
data__id = '{{ id }}',
data__creationTimestamp = '{{ creationTimestamp }}',
data__name = '{{ name }}',
data__location = '{{ location }}',
data__linkType = '{{ linkType }}',
data__requestedLinkCount = {{ requestedLinkCount }},
data__interconnectType = '{{ interconnectType }}',
data__adminEnabled = {{ adminEnabled }},
data__nocContactEmail = '{{ nocContactEmail }}',
data__customerName = '{{ customerName }}',
data__operationalStatus = '{{ operationalStatus }}',
data__provisionedLinkCount = {{ provisionedLinkCount }},
data__interconnectAttachments = '{{ interconnectAttachments }}',
data__peerIpAddress = '{{ peerIpAddress }}',
data__googleIpAddress = '{{ googleIpAddress }}',
data__googleReferenceId = '{{ googleReferenceId }}',
data__expectedOutages = '{{ expectedOutages }}',
data__circuitInfos = '{{ circuitInfos }}',
data__labels = '{{ labels }}',
data__labelFingerprint = '{{ labelFingerprint }}',
data__state = '{{ state }}',
data__satisfiesPzs = {{ satisfiesPzs }},
data__macsec = '{{ macsec }}',
data__macsecEnabled = {{ macsecEnabled }},
data__remoteLocation = '{{ remoteLocation }}',
data__requestedFeatures = '{{ requestedFeatures }}',
data__availableFeatures = '{{ availableFeatures }}',
data__applicationAwareInterconnect = '{{ applicationAwareInterconnect }}',
data__aaiEnabled = {{ aaiEnabled }},
data__interconnectGroups = '{{ interconnectGroups }}'
WHERE 
project = '{{ project }}' --required
AND interconnect = '{{ interconnect }}' --required
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
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​