interconnects

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

Overview

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

Fields

Name	Datatype	Description
`id`	`string`	[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.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource.
`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.
`availableFeatures`	`array`	[Output only] List of features available for this Interconnect connection, which can take one of the following values: - 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.
`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.
`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.
`labelFingerprint`	`string`	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. 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 information for enabling Media Access Control security (MACsec) on this Cloud Interconnect connection between Google and your on-premises router.
`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`	[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: - 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`	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.

Methods

Name	Accessible by	Required Params	Description
`get`	`SELECT`	`interconnect, project`	Returns the specified Interconnect. Get a list of available Interconnects by making a list() request.
`list`	`SELECT`	`project`	Retrieves the list of Interconnects available to the specified project.
`insert`	`INSERT`	`project`	Creates an Interconnect in the specified project using the data included in the request.
`delete`	`DELETE`	`interconnect, project`	Deletes the specified Interconnect.
`patch`	`UPDATE`	`interconnect, project`	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.
`set_labels`	`EXEC`	`project, resource`	Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation.

`SELECT` examples

Retrieves the list of Interconnects available to the specified project.

SELECT
id,
name,
description,
adminEnabled,
availableFeatures,
circuitInfos,
creationTimestamp,
customerName,
expectedOutages,
googleIpAddress,
googleReferenceId,
interconnectAttachments,
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 }}';

`INSERT` example

Use the following StackQL query and manifest file to create a new interconnects resource.

All Properties
Manifest

/*+ create */
INSERT INTO google.compute.interconnects (
project,
description,
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
)
SELECT 
'{{ project }}',
'{{ description }}',
'{{ 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 }}'
;

- name: your_resource_model_name
  props:
    - name: kind
      value: string
    - name: description
      value: string
    - name: selfLink
      value: string
    - name: id
      value: string
    - name: creationTimestamp
      value: string
    - name: name
      value: string
    - name: location
      value: string
    - name: linkType
      value: string
    - name: requestedLinkCount
      value: integer
    - name: interconnectType
      value: string
    - name: adminEnabled
      value: boolean
    - name: nocContactEmail
      value: string
    - name: customerName
      value: string
    - name: operationalStatus
      value: string
    - name: provisionedLinkCount
      value: integer
    - name: interconnectAttachments
      value:
        - string
    - name: peerIpAddress
      value: string
    - name: googleIpAddress
      value: string
    - name: googleReferenceId
      value: string
    - name: expectedOutages
      value:
        - - name: name
            value: string
          - name: description
            value: string
          - name: source
            value: string
          - name: state
            value: string
          - name: issueType
            value: string
          - name: affectedCircuits
            value:
              - string
          - name: startTime
            value: string
          - name: endTime
            value: string
    - name: circuitInfos
      value:
        - - name: googleCircuitId
            value: string
          - name: googleDemarcId
            value: string
          - name: customerDemarcId
            value: string
    - name: labels
      value: object
    - name: labelFingerprint
      value: string
    - name: state
      value: string
    - name: satisfiesPzs
      value: boolean
    - name: macsec
      value:
        - name: preSharedKeys
          value:
            - - name: name
                value: string
              - name: startTime
                value: string
        - name: failOpen
          value: boolean
    - name: macsecEnabled
      value: boolean
    - name: remoteLocation
      value: string
    - name: requestedFeatures
      value:
        - string
    - name: availableFeatures
      value:
        - string

`UPDATE` example

Updates a interconnects resource.

/*+ update */
UPDATE google.compute.interconnects
SET 
description = '{{ description }}',
name = '{{ name }}',
location = '{{ location }}',
linkType = '{{ linkType }}',
requestedLinkCount = '{{ requestedLinkCount }}',
interconnectType = '{{ interconnectType }}',
adminEnabled = true|false,
nocContactEmail = '{{ nocContactEmail }}',
customerName = '{{ customerName }}',
operationalStatus = '{{ operationalStatus }}',
provisionedLinkCount = '{{ provisionedLinkCount }}',
interconnectAttachments = '{{ interconnectAttachments }}',
peerIpAddress = '{{ peerIpAddress }}',
googleIpAddress = '{{ googleIpAddress }}',
googleReferenceId = '{{ googleReferenceId }}',
expectedOutages = '{{ expectedOutages }}',
circuitInfos = '{{ circuitInfos }}',
labels = '{{ labels }}',
labelFingerprint = '{{ labelFingerprint }}',
state = '{{ state }}',
satisfiesPzs = true|false,
macsec = '{{ macsec }}',
macsecEnabled = true|false,
remoteLocation = '{{ remoteLocation }}',
requestedFeatures = '{{ requestedFeatures }}',
availableFeatures = '{{ availableFeatures }}'
WHERE 
interconnect = '{{ interconnect }}'
AND project = '{{ project }}';

`DELETE` example

Deletes the specified interconnects resource.

/*+ delete */
DELETE FROM google.compute.interconnects
WHERE interconnect = '{{ interconnect }}'
AND project = '{{ project }}';

Overview​

Fields​

Methods​

SELECT examples​

INSERT example​

UPDATE example​

DELETE example​