ProviderGatewayBgpNeighborStatus

An object representing the status of a Provider Gateway BGP Neighbor.

JSON Example

{
    "neighborId": "string",
    "edgeNodeRef": {
        "id": "2a4ba9ad-e8d5-409c-8cae-c06910cd9b47",
        "name": "string",
        "type": "string"
    },
    "sourceAddress": "string",
    "neighborAddress": "string",
    "remoteASNumber": "string",
    "connectionState": "string",
    "establishedConnectionCount": 0,
    "connectionDropCount": 0,
    "totalInPrefixCount": 0,
    "totalOutPrefixCount": 0,
    "localPort": 0,
    "remotePort": 0,
    "messagesReceived": 0,
    "messagesSent": 0,
    "timeSinceEstablished": 0,
    "announcedCapabilities": [
        "string"
    ],
    "negotiatedCapabilities": [
        "string"
    ]
}

string

neighborId

Optional

The unique id of this BGP neighbor.

ExtObjectReference

edgeNodeRef

Optional

Reference for entities which are external to VCD and do not have a VCD URN identifier.

string

sourceAddress

Optional

The IP address of the logical port.

string

neighborAddress

Optional

The IP address of the BGP neighbor.

string

remoteASNumber

Optional

AS number of the BGP neighbor.

string

connectionState

Optional

Current state of the BGP session. Possible values are:

INVALID
IDLE
CONNECT
ACTIVE
OPEN_SENT
OPEN_CONFIRM
ESTABLISHED
UNKNOWN

integer

establishedConnectionCount

Optional

Count of connections established.

integer

connectionDropCount

Optional

Count of connections dropped.

integer

totalInPrefixCount

Optional

Sum of prefix counts for IN direction across all address families.

integer

totalOutPrefixCount

Optional

Sum of prefix counts specified for OUT direction across all address families.

integer

localPort

Optional

TCP port number of the local BGP connection

integer

remotePort

Optional

TCP port number of the remote BGP connection

integer

messagesReceived

Optional

Count of messages received from the neighbor

integer

messagesSent

Optional

Count of messages sent to the neighbor

integer

timeSinceEstablished

Optional

Time in seconds since connection was established

array of string

announcedCapabilities

Optional

BGP capabilities sent to BGP neighbor

array of string

negotiatedCapabilities

Optional

BGP capabilities negotiated with BGP neighbor

Availability

Added in 38.1

Property Of

ProviderGatewayBgpNeighborsStatusList