Get BGP Peer Status from NB (v2.2)

GET 
/v2.2/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/bgppeers/status

List all the BGP peer statuses from NB.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

site_id stringrequired

The ID of the site.

element_id stringrequired

The ID of the element.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

id string

The ID.

tenant_id string

The tenant ID.

items BGPPeerStatusV2N2[]
Array [
direction string
The direction for the BGP peer.
downtime string
The downtime configured for the BGP peer.
id string
The ID of the BGP peer.
state string
The state of the BGP peer.
uptime string
The uptime configured for the BGP peer.
v4_capability_negotiated boolean
The v4 negotiated capability.
v6_capability_negotiated boolean
The v6 negotiated capability.
]

Example (from schema)

{
  "count": 0,
  "id": "string",
  "tenant_id": "string",
  "items": [
    {
      "direction": "string",
      "downtime": "string",
      "id": "string",
      "state": "string",
      "uptime": "string",
      "v4_capability_negotiated": true,
      "v6_capability_negotiated": true
    }
  ]
}

Loading...