v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Gateways

Gateway cluster connectivity graph information

Retrieves information about gateways in a gateway-cluster, including their peers and their VLAN mismatches.

get/network-monitoring/v1/clusters/{cluster-name}/connectivity-graph

Path parameters

cluster-namestring const required

The name of the cluster to which the device belongs. If the device is not part of any cluster then the cluster name will be null.

Example:cluster 1

The name of the cluster formed by the gateway.

Response

Object containing information about gateways and their peers in a gateway-cluster.

idstring required

Primary identifier for the resource.

typestring required

The type of the resource.

Example response

{
  "nodes": [
    {
      "name": "9240-VPNC-7011",
      "role": "Leader",
      "health": "Good",
      "serialNumber": "CNP5KYH02L",
      "peers": [
        {
          "name": "BCX1540221",
          "vlanMismatch": "No",
          "mismatchedVlan": 0
        }
      ]
    },
    {
      "name": "BCX1540221",
      "role": "Member",
      "health": "Good",
      "serialNumber": "BCX1540221",
      "peers": [
        {
          "name": "9240-VPNC-7011",
          "vlanMismatch": "No",
          "mismatchedVlan": 0
        }
      ]
    }
  ],
  "id": "gw-cluster-2",
  "type": "network-monitoring/gateway-monitoring"
}