Get Diagnostics

Returns the interconnectDiagnostics for the specified interconnect

2 variables
19 variables

Returns the interconnectDiagnostics for the specified interconnect

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your data across Google Cloud Platform services
  • View and manage your Google Compute Engine resources
  • View your Google Compute Engine resources

Input

This building block consumes 2 input parameters

  = Parameter name
  = Format

project STRING Required

Project ID for this request

interconnect STRING Required

Name of the interconnect resource to query

Output

This building block provides 19 output parameters

  = Parameter name
  = Format

result OBJECT

Diagnostics information about interconnect, contains detailed and current technical information about Google?s side of the connection

result.arpCaches[] OBJECT

Describing the ARP neighbor entries seen on this link

result.arpCaches[].ipAddress STRING

The IP address of this ARP neighbor

result.arpCaches[].macAddress STRING

The MAC address of this ARP neighbor

result.links[] OBJECT

result.links[].arpCaches[] OBJECT

Describing the ARP neighbor entries seen on this link

result.links[].circuitId STRING

The unique ID for this link assigned during turn up by Google

result.links[].googleDemarc STRING

The Demarc address assigned by Google and provided in the LoA

result.links[].lacpStatus OBJECT

result.links[].lacpStatus.googleSystemId STRING

System ID of the port on Google?s side of the LACP exchange

result.links[].lacpStatus.neighborSystemId STRING

System ID of the port on the neighbor?s side of the LACP exchange

result.links[].lacpStatus.state ENUMERATION

The state of a LACP link, which can take one of the following values:

  • ACTIVE: The link is configured and active within the bundle.
  • DETACHED: The link is not configured within the bundle. This means that the rest of the object should be empty.

result.links[].receivingOpticalPower OBJECT

result.links[].receivingOpticalPower.state ENUMERATION

The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include:

  • 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.

result.links[].receivingOpticalPower.value FLOAT

Value of the current receiving or transmitting optical power, read in dBm. 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

result.links[].transmittingOpticalPower OBJECT

result.links[].transmittingOpticalPower.state ENUMERATION

The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include:

  • 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.

result.links[].transmittingOpticalPower.value FLOAT

Value of the current receiving or transmitting optical power, read in dBm. 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

result.macAddress STRING

The MAC address of the Interconnect's bundle interface