Create and manage interconnect attachments

This page describes how to create and manage Google Distributed Cloud Edge interconnect attachment resources in a Distributed Cloud Edge zone.

This functionality is only available on Distributed Cloud Edge Racks. Distributed Cloud Edge Servers don't support interconnect attachment resources.

For more information about Distributed Cloud Edge interconnect attachments, see How Distributed Cloud Edge works.

Keep the following in mind:

  • We recommend that you create an interconnect attachment along with its corresponding router at the same time. For more information, see Create a router.
  • You can optionally specify a VLAN ID to use to tag the packets that pass through the interconnect attachment.
  • The VLAN ID that you specify for packet tagging is local to the interconnect attachment. In other words, a given interconnect attachment is not part of the same Layer 2 domain as the interconnect attachments associated with other interconnects, or subnetworks that are not associated with any interconnect attachments. Therefore, while the VLAN ID specified for packet tagging must be unique across all interconnect attachments created on the target interconnect, it can be reused on other interconnects and on subnetworks not associated with an interconnect attachment.

Create an interconnect attachment

To create a Distributed Cloud Edge interconnect attachment, complete the steps in this section.

To complete this task, you must have the Edge Network Admin role (roles/edgenetwork.admin) in your Google Cloud project.

gcloud

Use the gcloud edge-cloud networking interconnects attachments dedicated create command:

gcloud edge-cloud networking interconnects attachments dedicated create ATTACHMENT_NAME \
    --interconnect=INTERCONNECT_NAME \
    --network=NETWORK_NAME \
    --location=REGION \
    --zone=ZONE_NAME \
    --vlan-id=VLAN_ID \
    --mtu=MTU_SIZE

Replace the following:

  • ATTACHMENT_NAME: a descriptive name that uniquely identifies this interconnect attachment.
  • INTERCONNECT_NAME: the name of the interconnect to which this interconnect attachment connects.
  • NETWORK_NAME: the name of the Distributed Cloud Edge network that this interconnect attachment resource serves.
  • REGION: the Google Cloud region to which the target Distributed Cloud Edge zone belongs.
  • ZONE_NAME: the name of the target Distributed Cloud Edge zone.
  • VLAN_ID (optional): the VLAN ID with which packets that pass through this interconnect attachment are tagged. Valid values are between 2 and 4095. If you omit this value or set it to 0, the packets are untagged.
  • MTU_SIZE: the maximum transmission unit (MTU) size for the subnetwork that this interconnect attachment instantiates. Valid values are 1500 and 9000.

API

Make a POST request to the projects.locations.zones.interconnectAttachments.create method:

POST /v1/projects/PROJECT_ID/locations/REGION/zones/ZONE_NAME/interconnectAttachments?interconnectAttachmentId=ATTACHMENT_ID
 {
  "labels": { LABELS,
   },
  "interconnect": { INTERCONNECT_NAME,
   },
  "network": { NETWORK_NAME,
   },
  "vlanId": { VLAN_ID,
   },
  "mtu": { MTU_SIZE,
   },       
 }

Replace the following:

  • PROJECT_ID: the ID of the target Google Cloud project.
  • REGION: the Google Cloud region to which the target Distributed Cloud Edge zone belongs.
  • ZONE_NAME: the name of the target Distributed Cloud Edge zone.
  • ATTACHMENT_ID: an ID that uniquely identifies this interconnect attachment.
  • LABELS: a list of labels to apply to this interconnect attachment resource.
  • INTERCONNECT_NAME: the name of the interconnect to which this interconnect attachment connects.
  • NETWORK_NAME: the network that this interconnect attachment resource serves.
  • VLAN_ID: the VLAN ID for the subnetwork that this interconnect attachment instantiates on the router. Valid values are between 2 and 4095. A value of 0 configures the subnetwork as untagged.
  • MTU_SIZE: the maximum transmission unit (MTU) size for the subnetwork that this interconnect attachment instantiates. Valid values are 1500 and 9000.

List interconnect attachments

To list the Distributed Cloud Edge interconnect attachments in a Distributed Cloud Edge zone, complete the steps in this section.

To complete this task, you must have the Edge Network Viewer role (roles/edgenetwork.viewer) in your Google Cloud project.

gcloud

Use the gcloud edge-cloud networking interconnects attachments list command:

gcloud edge-cloud networking interconnects attachments list \
    --location=REGION \
    --zone=ZONE_NAME

Replace the following:

  • REGION: the Google Cloud region to which the target Distributed Cloud Edge zone belongs.
  • ZONE_NAME: the name of the target Distributed Cloud Edge zone.

API

Make a GET request to the projects.locations.zones.interconnectAttachments.list method:

GET /v1/projects/PROJECT_ID/locations/REGION/zones/ZONE_NAME/interconnectAttachments?filter=FILTER&pageSize=PAGE_SIZE&orderBy=SORT_BY&pageToken=PAGE_TOKEN

Replace the following:

  • PROJECT_ID: the ID of the target Google Cloud project.
  • REGION: the Google Cloud region to which the target Distributed Cloud Edge zone belongs.
  • ZONE_NAME: the name of the target Distributed Cloud Edge zone.
  • FILTER: an expression that constrains the returned results to specific values.
  • PAGE_SIZE: the number of results to return per page.
  • SORT_BY: a comma-delimited list of field names by which the returned results are sorted. The default sort order is ascending; for descending sort order, prefix the desired field with ~.
  • PAGE_TOKEN: a token received in the response to the last list request in the nextPageToken field in the response. Send this token to receive the following page of results.

Get information about an interconnect attachment

To get information about a Distributed Cloud Edge interconnect attachment, complete the steps in this section.

To complete this task, you must have the Edge Network Viewer role (roles/edgenetwork.viewer) in your Google Cloud project.

gcloud

Use the gcloud edge-cloud networking interconnects attachments describe command:

gcloud edge-cloud networking interconnects attachments describe ATTACHMENT_NAME \
    --location=REGION \
    --zone=ZONE_NAME

Replace the following:

  • ATTACHMENT_NAME: the name of the target interconnect attachment.
  • REGION: the Google Cloud region to which the target Distributed Cloud Edge zone belongs.
  • ZONE_NAME: the name of the target Distributed Cloud Edge zone.

API

Make a GET request to the projects.locations.zones.interconnectAttachments.get method:

GET /v1/projects/PROJECT_ID/locations/REGION/zones/ZONE_NAME/interconnectAttachments/ATTACHMENT_ID

Replace the following:

  • PROJECT_ID: the ID of the target Google Cloud project.
  • ATTACHMENT_ID: the name of the target interconnect attachment.
  • REGION: the Google Cloud region to which the target Distributed Cloud Edge zone belongs.
  • ZONE_NAME: the name of the target Distributed Cloud Edge zone.

This operation returns detailed information about the resource, including its provisioning state as follows:

  • PENDING: the resource has not yet begun provisioning and has not yet been propagated throughout the zone.
  • PROVISIONING: the resource is being provisioned; you must wait until it has been propagated throughout the zone.
  • RUNNING: the resource has been successfully provisioned and propagated throughout the zone; it is ready to use.
  • FAILED: the provisioning of the resource was not successful; the resource has not been propagated throughout the zone.

Delete an interconnect attachment

To delete a Distributed Cloud Edge interconnect attachment, complete the steps in this section.

To complete this task, you must have the Edge Network Admin role (roles/edgenetwork.admin) in your Google Cloud project.

gcloud

Use the gcloud edge-cloud networking interconnects attachments delete command:

gcloud edge-cloud networking interconnects attachments delete ATTACHMENT_NAME \
    --location=REGION \
    --zone=ZONE_NAME

Replace the following:

  • ATTACHMENT_NAME: the name of the target interconnect attachment.
  • REGION: the Google Cloud region to which the target Distributed Cloud Edge zone belongs.
  • ZONE_NAME: the name of the target Distributed Cloud Edge zone.

API

Make a DELETE request to the projects.locations.zones.interconnectAttachments.delete method:

DELETE /v1/projects/PROJECT_ID/locations/REGION/zones/ZONE_NAME/subnets/SUBNETWORK_ID

Replace the following:

  • PROJECT_ID: the ID of the target Google Cloud project.
  • ATTACHMENT_NAME: the name of the target interconnect attachment.
  • REGION: the Google Cloud region to which the target Distributed Cloud Edge zone belongs.
  • ZONE_NAME: the name of the target Distributed Cloud Edge zone.

What's next