BgpNeighborStatus

JSON Example

{
    "address_families": [
        {
            "in_prefix_count": 0,
            "out_prefix_count": 0,
            "type": "string"
        }
    ],
    "announced_capabilities": [
        "string"
    ],
    "connection_drop_count": 0,
    "connection_state": "string",
    "established_connection_count": 0,
    "graceful_restart": false,
    "graceful_restart_mode": "string",
    "hold_time": 0,
    "intent_path": "string",
    "keep_alive_interval": 0,
    "local_port": 0,
    "lr_component_id": "string",
    "messages_received": 0,
    "messages_sent": 0,
    "negotiated_capability": [
        "string"
    ],
    "neighbor_address": "string",
    "neighbor_edge_node": "string",
    "neighbor_router_id": "string",
    "remote_as_number": "string",
    "remote_port": 0,
    "remote_site": {
        "is_valid": false,
        "target_display_name": "string",
        "target_id": "string",
        "target_type": "string"
    },
    "source_address": "string",
    "time_since_established": 0,
    "total_in_prefix_count": 0,
    "total_out_prefix_count": 0,
    "transport_node": {
        "is_valid": false,
        "target_display_name": "string",
        "target_id": "string",
        "target_type": "string"
    },
    "type": "string"
}

array of BgpAddressFamily

address_families

Optional

Address families of BGP neighbor

array of string

announced_capabilities

Optional

BGP capabilities sent to BGP neighbor.

integer As int64 As int64

connection_drop_count

Optional

Count of connection drop

string

connection_state

Optional

Current state of the BGP session.

Possible values are : INVALID, IDLE, CONNECT, ACTIVE, OPEN_SENT, OPEN_CONFIRM, ESTABLISHED, UNKNOWN,

integer As int64 As int64

established_connection_count

Optional

Count of connections established

boolean

graceful_restart

Optional

Current state of graceful restart where graceful_restart = true indicates graceful restart is enabled and graceful_restart = false indicates graceful restart is disabled. This is deprecated field, use graceful_restart_mode instead.

string

graceful_restart_mode

Optional

Current state of graceful restart of BGP neighbor. Possible values are -

GR_AND_HELPER - Graceful restart with Helper
HELPER_ONLY - Helper only
DISABLE - Disabled

integer As int64 As int64

hold_time

Optional

Time in ms to wait for HELLO from BGP peer. If a HELLO packet is not seen from BGP Peer withing hold_time then BGP neighbor will be marked as down.

string

intent_path

Optional

policy intent path of bgp neighbor

integer As int64 As int64

keep_alive_interval

Optional

Time in ms to wait for HELLO packet from BGP peer

integer As int64 As int64

local_port

Optional

Constraints: minimum: 1 maximum: 65535

TCP port number of Local BGP connection

string

lr_component_id

Optional

Logical router component(Service Router/Distributed Router) id

integer As int64 As int64

messages_received

Optional

Count of messages received from the neighbor

integer As int64 As int64

messages_sent

Optional

Count of messages sent to the neighbor

array of string

negotiated_capability

Optional

BGP capabilities negotiated with BGP neighbor.

string As ip As ip

neighbor_address

Optional

The IP of the BGP neighbor

string

neighbor_edge_node

Optional

Inter-SR bgp neighbor edge node

string As ip As ip

neighbor_router_id

Optional

Router ID of the BGP neighbor.

string

remote_as_number

Optional

AS number of the BGP neighbor

integer As int64 As int64

remote_port

Optional

Constraints: minimum: 1 maximum: 65535

TCP port number of remote BGP Connection

ResourceReference

remote_site

Optional

A weak reference to an NSX resource.

string As ip As ip

source_address

Optional

The Ip address of logical port

integer As int64 As int64

time_since_established

Optional

Time(in seconds) since connection was established.

integer As int64 As int64

total_in_prefix_count

Optional

Sum of in prefixes counts across all address families.

integer As int64 As int64

total_out_prefix_count

Optional

Sum of out prefixes counts across all address families.

ResourceReference

transport_node

Optional

A weak reference to an NSX resource.

string

type

Optional

BGP neighbor type

Possible values are : INTER_SR, USER,

Property Of

InterSiteBgpSummary