Stay organized with collections
Save and categorize content based on your preferences.
Cloud Interconnect diagnostics let you troubleshoot your
Cross-Site Interconnect connections during provisioning and after
activation.
The diagnostics provide you detailed technical information about the
Google Cloud Cross-Site Interconnect connections on
demand.
Diagnostics during outages
In the event of a global outage,
don't use the diagnostics results from your
Cross-Site Interconnect connection to make decisions about
where to redirect your network traffic. A Cross-Site Interconnect
connection is a global resource. A global outage can prevent the diagnostics for
Cloud Interconnect from functioning properly.
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 Cross-Site Interconnect connection fails to progress
through the provisioning process.
The diagnostics results contain different data depending on what
stage in the provisioning process your
Cross-Site 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 help 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 Cross-Site Interconnect connection provisioning process
occurs in the following stages. You must meet the requirements in stage 1
before you can move on to stage 2:
Stage 1, circuit connection
The optical power state is OK for each link in the connection.
Stage 2, production configuration
The optical power state is OK for each link in the connection.
A temporary IP address is assigned to the untagged bundle interface.
Google Cloud verifies connectivity through a ping. The test
IP address is removed when the activation process is complete.
Use diagnostics
To see diagnostics information for the Cross-Site Interconnect
connection, follow these steps.
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.
GET https://compute.googleapis.com/compute/beta/projects/PROJECT_ID/global/interconnects/NAME/getDiagnostics
Replace the following:
PROJECT_ID: the ID of the Google Cloud project
NAME: the name of the Cross-Site Interconnect connection in your
project
If this command succeeds, it returns InterconnectDiagnostics output. To interpret the output, see the
command output reference later in this document.
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 Cross-Site Interconnect connection bundle on
the Google Cloud side.
links[]
Describes the status for each link on the Cross-Site 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[].macsec
The link's MACsec state. This field is omitted if you don't have
MACsec enabled.
links[].macsec.ckn
The connectivity association key name (CKN) in use. This
field is omitted if you don't have MACsec enabled.
links[].macsec.operational
The link's MACsec state. This field is omitted if you don't
have MACsec enabled. The following are the possible values:
TRUE: MACsec is operational on the link.
FALSE: MACsec isn't operational on the link.
links[].operationalState
The operational state of this Cross-Site Interconnect link. This field is
omitted if you don't have MACsec enabled. The following are the
possible values:
LINK_OPERATIONAL_STATUS_UP: The link is
operational.
LINK_OPERATIONAL_STATUS_DOWN: The link isn't
operational.
The link's operational state isn't affected by the link's MACsec
state.
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
DETACHED: The link is not configured within
the bundle.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-25 UTC."],[],[],null,["# Get diagnostics\n\nCloud Interconnect diagnostics let you troubleshoot your\nCross-Site Interconnect connections during provisioning and after\nactivation.\n\nThe diagnostics provide you detailed technical information about the\nGoogle Cloud Cross-Site Interconnect connections on\ndemand.\n|\n| **Preview**\n|\n|\n| This product is subject to the \"Pre-GA Offerings Terms\" in the General Service Terms section\n| of the [Service Specific Terms](/terms/service-terms#1).\n|\n| Pre-GA products are available \"as is\" and might have limited support.\n|\n| For more information, see the\n| [launch stage descriptions](/products#product-launch-stages).\n\nDiagnostics during outages\n--------------------------\n\nIn the event of a [global outage](https://status.cloud.google.com/),\ndon't use the diagnostics results from your\nCross-Site Interconnect connection to make decisions about\nwhere to redirect your network traffic. A Cross-Site Interconnect\nconnection is a global resource. A global outage can prevent the diagnostics for\nCloud Interconnect from functioning properly.\n\nDiagnostics during provisioning\n-------------------------------\n\nViewing diagnostics provides you with the information required to troubleshoot\nand fix problems in your on-premises router configuration, which can be helpful\nif your Cross-Site Interconnect connection fails to progress\nthrough the provisioning process.\n\nThe diagnostics results contain different data depending on [what\nstage](#provisioning-stages) in the provisioning process your\nCross-Site Interconnect connection is in. The major and minor\nsteps are listed in the next section. This diagnostic information provides you\nwith possible next steps\nto take to help ensure that the provisioning process progresses without further\nissues.\n\nUse the [command output reference](#output-reference) to interpret diagnostic\ncommand results or the information provided in the Google Cloud console.\n\n### Provisioning stages\n\nThe Cross-Site Interconnect connection provisioning process\noccurs in the following stages. You must meet the requirements in stage 1\nbefore you can move on to stage 2:\n\n- **Stage 1, circuit connection**\n\n - The optical power state is `OK` for each link in the connection.\n- **Stage 2, production configuration**\n\n - The optical power state is `OK` for each link in the connection.\n - A temporary IP address is assigned to the untagged bundle interface. Google Cloud verifies connectivity through a ping. The test IP address is removed when the activation process is complete.\n\nUse diagnostics\n---------------\n\nTo see diagnostics information for the Cross-Site Interconnect\nconnection, follow these steps.\n\n#### Permissions required for this task\n\nTo perform this task, you must have been granted the following permissions\n*or* the following Identity and Access Management (IAM) roles.\n\n**Permissions**\n\n- `compute.interconnects.get`\n- `compute.interconnects.use`\n\n**Roles**\n\n- Compute Network Admin (`roles/compute.networkAdmin`) \n\n### Console\n\n1. In the Google Cloud console, go to the **Interconnect** page.\n\n\n [Go to Interconnect](https://console.cloud.google.com/hybrid/interconnects/list)\n\n \u003cbr /\u003e\n\n2. On the **Physical connections** tab, select the name of a\n Cross-Site Interconnect connection.\n\n3. Diagnostics information is in the following locations on the connection\n details page:\n\n - For warnings or errors, see the **Status** field.\n - For the provisioned capacity of the Cross-Site Interconnect, see the **Provisioned capacity** field.\n - For additional details, such as link status and light levels, see the **Link circuit info** section.\n - For details such as the effective capacity of the connection or status of its wire groups, see the **Wire groups** section.\n\n### gcloud\n\nUse the [`gcloud beta compute interconnects get-diagnostics` command](/sdk/gcloud/reference/beta/compute/interconnects/get-diagnostics): \n\n```\ngcloud beta compute interconnects get-diagnostics NAME \\\n --project=PROJECT_ID\n```\n\nReplace the following:\n\n- \u003cvar translate=\"no\"\u003eNAME\u003c/var\u003e: the name of the Cross-Site Interconnect connection in your project\n- \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e: the ID of the Google Cloud project\n\n### API\n\nUse the [`interconnects.getDiagnostics`\nmethod](/compute/docs/reference/rest/beta/interconnects/getDiagnostics): \n\n```\nGET https://compute.googleapis.com/compute/beta/projects/PROJECT_ID/global/interconnects/NAME/getDiagnostics\n```\n\nReplace the following:\n\n- \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e: the ID of the Google Cloud project\n- \u003cvar translate=\"no\"\u003eNAME\u003c/var\u003e: the name of the Cross-Site Interconnect connection in your project\n\nIf this command succeeds, it returns `InterconnectDiagnostics` output. To interpret the output, see the\n[command output reference](#output-reference) later in this document.\n\nCommand output reference\n------------------------\n\nThe definitions for the output parameters for the `gcloud` commands and the\n[`interconnects.getDiagnostics`](/compute/docs/reference/rest/beta/interconnects/getDiagnostics)\nAPI are listed in the following table.\n| **Note:** If you want to trigger on-premises warnings for the value of the transmitting and receiving optical power, you can take a known good optical value, give it a 10% margin, and trigger warnings relative to that value. In general, a `-7dBm` warning and a `-11dBm` alarm are good optical value estimates for most links.\n\nWhat's next\n-----------\n\n- To create a Cross-Site Interconnect connection, see the\n [Cross-Site Interconnect provisioning overview](/network-connectivity/docs/interconnect/how-to/cross-site/provisioning-overview).\n\n- To help you solve common issues that you might encounter when using\n Cloud Interconnect, see\n [Troubleshooting](/network-connectivity/docs/interconnect/support/troubleshooting)."]]
