CIcilium
bgp

Lists operational state of BGP peers

Changed on

Retrieves current operational state of BGP peers created by Cilium BGP virtual router. This includes session state, uptime, information per address family, etc. Deprecated: This will be removed in the future.

get/bgp/peers

Request

  • Base URL
    /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    none declared

Response

Success

namestring

Name of peer

local-asninteger

Local AS Number

peer-asninteger

Peer AS Number

peer-addressstring

IP Address of peer

tcp-password-enabledboolean

Set when a TCP password is configured for communications with this peer

ebgp-multihop-ttlinteger

Time To Live (TTL) value used in BGP packets sent to the eBGP neighbor. 1 implies that eBGP multi-hop feature is disabled (only a single hop is allowed).

peer-portinteger

TCP port number of peer

session-statestring

BGP peer operational state as described here https://www.rfc-editor.org/rfc/rfc4271#section-8.2.2

uptime-nanosecondsinteger

BGP peer connection uptime in nano seconds.

connect-retry-time-secondsinteger

Initial value for the BGP ConnectRetryTimer (RFC 4271, Section 8) in seconds

configured-hold-time-secondsinteger

Configured initial value for the BGP HoldTimer (RFC 4271, Section 4.2) in seconds. The configured value will be used for negotiation with the peer during the BGP session establishment.

applied-hold-time-secondsinteger

Applied initial value for the BGP HoldTimer (RFC 4271, Section 4.2) in seconds. The applied value holds the value that is in effect on the current BGP session.

configured-keep-alive-time-secondsinteger

Configured initial value for the BGP KeepaliveTimer (RFC 4271, Section 8) in seconds. The applied value may be different than the configured value, as it depends on the negotiated hold time interval.

applied-keep-alive-time-secondsinteger

Applied initial value for the BGP KeepaliveTimer (RFC 4271, Section 8) in seconds. The applied value holds the value that is in effect on the current BGP session.

Changes