Get diagnostics

Cloud Interconnect diagnostics let you troubleshoot your Interconnect connections during provisioning and after activation.

The diagnostics provide you current, detailed technical information about the Google Cloud side of the Interconnect connections on demand.

Diagnostics during provisioning

Viewing diagnostics provides you with the information required to troubleshoot and fix problems in your on-premises router configuration, which can be helpful if your Interconnect connection fails to progress through the provisioning process.

The diagnostics results contain different data depending on what stage in the provisioning process your Interconnect connection is in. The major and minor steps are listed in the next section. This diagnostic information provides you with possible next steps to take to ensure that the provisioning process progresses without further issues.

Use the command output reference to interpret diagnostic command results or the information provided in the Google Cloud console.

Provisioning stages

The Interconnect connection provisioning process occurs in multiple stages. You must meet the following requirements in each stage before you can move on to the next one:

Stage 1 - Circuit connection:
- The optical power state is OK.
- LACP is detached.
- ARP entries are present on one or more circuits.
Stage 2 - Circuit qualification (multiple links):
- The optical power state is OK.
- LACP is detached.
- ARP entries are present on one or more circuits.
Stage 3 - Production configuration:
- The optical power state is OK.
- LACP is active.
- ARP entries are present on the Interconnect connection.

Use diagnostics

Permissions required for this task

To perform this task, you must have been granted the following permissions or the following Identity and Access Management (IAM) roles.

Permissions

compute.interconnects.get
compute.interconnects.use

Roles

roles/compute.networkAdmin

Console

In the Google Cloud console, go to the Cloud Interconnect Physical connections tab.

Go to Physical connections
Select the name of an Interconnect connection.
Diagnostics information is in the following locations on the connection details page:
- For warnings or errors, see the Status field in the upper-left corner of the page.
- For the provisioned capacity of the Interconnect connection, see the Provisioned capacity field.
- If you suspect issues with the Interconnect connection, see the VLAN attachments section for information such as the effective capacity of the connection or the number of down links.
- For additional details, such as light levels, see the Link circuit info section.

gcloud

Enter the following command to see diagnostics information for the Interconnect connection:

gcloud beta compute interconnects get-diagnostics NAME
  --project=PROJECT_ID

Replace the following:

NAME: the name of the Interconnect connection in your project
PROJECT_ID: the ID of the Google Cloud project

The command output should look similar to the following example:

macAddress: "00:11:22:33:44:55"
arpCache:
  macAddress: "55:44:33:22:11:00"
  ipAddress: "1.2.3.4"
links:
  - circuitId: "circuit-id-1"
    receivingOpticalPower:
      value: 0.4
      state: OK
    lacpStatus:
      state: ACTIVE
      googleSystemId: "00:11:22:33:44:55"
      neighborSystemId: "55:44:33:22:11:00"
  - circuitId: "circuit-id-2"
    receivingOpticalPower:
      value: 0.4
      state: OK
    lacpStatus:
      state: DETACHED
    arpCache:
      macAddress: "01:23:45:67:89:0a"
      ipAddress: "2.3.4.5"

API

Use the interconnects.getDiagnostics method:

 GET https://compute.googleapis.com/compute/projects/PROJECT_ID/global/interconnects/NAME/diagnostics

Replace the following:

PROJECT_ID: the ID of the Google Cloud project
NAME: the name of the Interconnect connection in your project

If this command succeeds, it returns InterconnectDiagnostics output in the following format. To interpret the output, see the command output reference.

{
  "macAddress": "00:11:22:33:44:55",
  "arpCache": [
    {
      "macAddress": "55:44:33:22:11:00",
      "ipAddress": "1.2.3.4"
    }
  ],
  "links": [
    {
      "circuitId": "circuit-id",
      "receivingOpticalPower": {
        "value": 0.4,
        "state": OK,
      },
      "lacpStatus": {
        "state": ACTIVE,
        "googleSystemId": "00:11:22:33:44:55",
        "neighborSystemId": "55:44:33:22:11:00"
      }
    },
    {
      "circuitId": "circuit-id",
      "receivingOpticalPower": {
        "value": 0.4,
        "state": OK,
      },
      "lacpStatus": {
        "state": DETACHED
      },
      "arpCache": [
        {
          "macAddress": "01:23:45:67:89:0a",
          "ipAddress": "2.3.4.5"
        }
      ]
    }
  ]
}

Command output reference

The definitions for the output parameters for the gcloud commands and the interconnects.getDiagnostics API are listed in the following table.

Output parameter	Description
`macAddress`	Describes the MAC address of the Interconnect connection bundle on the Google Cloud side.
`arpCache`	Describes individual neighbors currently seen by the Cloud Router in the ARP cache for the Interconnect connection. This is empty when the connection is not bundled.
`arpCache[].macAddress`	Lists the MAC address of this ARP neighbor.
`arpCache[].ipAddress`	Lists the IP address of this ARP neighbor.
`links[]`	Describes the status for each link on the Interconnect connection.
`links[].circuitId`	Lists the Google-assigned unique ID for this circuit, as assigned during circuit turn-up.
`links[].googleDemarc`	Describes the Google-assigned demarc, as assigned at circuit turn-up and provided by Google to the customer in the LOA.
`links[].receivingOpticalPower`	Describes the current value and status for the received light level.
`links[].receivingOpticalPower.value`	Lists the current value of the received light level, in dBm.
`links[].receivingOpticalPower.state`	The status of the current value when compared to the warning and alarm levels for the receiving transceiver: OK: The value has not crossed a warning threshold. LOW_WARNING: The value has crossed below the low warning threshold. HIGH_WARNING: The value has crossed above the high warning threshold. LOW_ALARM: The value has crossed below the low alarm threshold. HIGH_ALARM: The value has crossed above the high alarm threshold.
`links[].transmittingOpticalPower`	The current value and status for the transmit light level.
`links[].transmittingOpticalPower.value`	The current value of the transmitting light level, in dBm.
`links[].transmittingOpticalPower.state`	The status of the current value when compared to the warning and alarm levels for the transmitting transceiver: OK: The value has not crossed a warning threshold. LOW_WARNING: The value has crossed below the low warning threshold. HIGH_WARNING: The value has crossed above the high warning threshold. LOW_ALARM: The value has crossed below the low alarm threshold. HIGH_ALARM: The value has crossed above the high alarm threshold.
`links[].lacpStatus`	The LACP information for the single link.
`links[].lacpStatus.state`	ACTIVE: The link is configured and active within the bundle. DETACHED: The link is not configured within the bundle.
`links[].lacpStatus.googleSystemId`	The system ID of the port on the Google Cloud side of the LACP exchange.
`links[].lacpStatus.neighborSystemId`	The system ID of the port on the customer's side of the LACP exchange.
`links[].arpCache[]`	A list of `InterconnectDiagnostics.ARPEntry` objects, describing the ARP neighbor entries seen on this link. This is empty if the link is bundled.
`links[].arpCache[].macAddress`	The MAC address of this ARP neighbor on this link.
`links[].arpCache[].ipAddress`	The IP address of this ARP neighbor on this link.

What's next

To create an Interconnect connection, see the Dedicated Interconnect provisioning overview.
To learn more about Cloud Interconnect options, see the Cloud Interconnect overview.
To help you solve common issues that you might encounter when using Cloud Interconnect, see Troubleshooting.