neighborAddress | IpAddress | false | Address of the BGP peer, either in IPv4 or IPv6 |
peerDeviceName | String | true | Device name of the BGP peer if one could be discovered in the snapshot, otherwise absent. |
peerVrf | String | true | The VRF under which this connection was configured on the peer's device. Absent if peerDeviceName is absent. |
peerRouterId | IpAddress | true | Router ID of the peer. Present for devices with OS ACOS, APIC, ARISTA_EOS, ASA, CUMULUS, EXTREME_NOS, F5, FORTINET, FXOS, HP_COMWARE, HP_PROVISION, IOS, IOS_XE, IOS_XR, JUNOS, NXOS, PAN_OS, SG, SILVER_PEAK, T128, and VIPTELA. |
sessionState | BgpSessionState | true | Operational state of the BGP peer. Absent if enabled is false or if the data is not available. |
enabled | Bool | false | Whether the BGP peer is enabled. In cases where enabled is false, the local system does not initiate connections to the neighbor, and does not respond to TCP connections attempts from the neighbor. |
description | String | true | Description of the neighbor. |
peerAS | Integer | false | AS number of the peer. |
localAS | Integer | true | The secondary AS number of the local device if a local AS is configured for an eBGP peer. Absent if no local AS is configured, or the peer is not an eBGP peer. |
peerType | PeerType | true | Explicitly designate the neighbor as internal (iBGP) or external (eBGP). |
statistics | BgpNeighborStatistics | true | Absent if the session state is not ESTABLISHED. |