v1

latestSwagger 2.02026-07-173949114.3 KB
bgp

Get all BGP session information for all network devices

For every Border Gateway Protocol (BGP) session running on the network, retrieves local node hostname, remote peer hostname, interface, router ID, and ASN, timestamp, VRF, connection state, IP and EVPN prefixes, and so forth. Refer to the BGPSession model for all data collected.

get/object/bgp

Query parameters

eq_timestampinteger

Display results for a given time. Time must be entered in Epoch format. For example, to display the results for Monday February 13, 2019 at 1:25 pm, use a time converter and enter 1550082300.

countinteger

Number of entries to display starting from the offset value. For example, a count of 100 displays 100 entries at a time.

offsetinteger

Used in combination with count, offest specifies the starting location within the set of entries returned. For example, an offset of 100 would display results beginning with entry 101.

Response

successful operation

opidinteger
hostnamestring
peer_namestring
timestampinteger
db_statestring
statestring
peer_router_idstring
peer_asninteger
peer_hostnamestring
asninteger
reasonstring
ipv4_pfx_rcvdinteger
ipv6_pfx_rcvdinteger
evpn_pfx_rcvdinteger
last_reset_timenumber float
up_timenumber float
conn_estdinteger
conn_droppedinteger
upd8_rxinteger
upd8_txinteger
vrfidinteger
vrfstring
tx_familiesstring
rx_familiesstring
objidstring