State

Leafs

Children

Enum Classes

class Bgp.Neighbors.Neighbor.State

Bases: Entity

Class Hierarchy: Bgp Neighbors Neighbor State

This class represents state data.

State information relating to the BGP neighbor

peer_group

The peer-group with which this neighbor is associated

type: str

refers to: peer_group_name

config: False

neighbor_address

Address of the BGP peer, either in IPv4 or IPv6

type: union of the below types:

type: str

pattern: ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$

type: str

pattern: ^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:))$

config: False

enabled

Whether the BGP peer is enabled. In cases where the enabled leaf is set to false, the local system should not initiate connections to the neighbor, and should not respond to TCP connections attempts from the neighbor. If the state of the BGP session is ESTABLISHED at the time that this leaf is set to false, the BGP session should be ceased

type: bool

config: False

default value: true

peer_as

AS number of the peer

type: int

range: 0..4294967295

config: False

local_as

The local autonomous system number that is to be used when establishing sessions with the remote peer or peer group, if this differs from the global BGP router autonomous system number

type: int

range: 0..4294967295

config: False

peer_type

Explicitly designate the peer or peer group as internal (iBGP) or external (eBGP)

type: PeerType

config: False

auth_password

Configures an MD5 authentication password for use with neighboring devices

type: str

config: False

remove_private_as

Remove private AS numbers from updates sent to peers - when this leaf is not specified, the AS_PATH attribute should be sent to the peer unchanged

type: one of the below values: PRIVATEASREMOVEALL

config: False

route_flap_damping

Enable route flap damping

type: bool

config: False

default value: false

send_community

Specify which types of community should be sent to the neighbor or group. The default is to not send the community attribute

type: CommunityType

config: False

default value: NONE

description

An optional textual description (intended primarily for use with a peer or group

type: str

config: False

session_state

Operational state of the BGP peer

type: SessionState

config: False

last_established

This timestamp indicates the time that the BGP session last transitioned in or out of the Established state. The value is the timestamp in seconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC). The BGP session uptime can be computed by clients as the difference between this value and the current time in UTC (assuming the session is in the ESTABLISHED state, per the session-state leaf)

type: int

range: 0..18446744073709551615

config: False

established_transitions

Number of transitions to the Established state for the neighbor session. This value is analogous to the bgpPeerFsmEstablishedTransitions object from the standard BGP-4 MIB

type: int

range: 0..18446744073709551615

config: False

supported_capabilities

BGP capabilities negotiated as supported with the peer

type: one of the below values: list of

config: False

messages

Counters for BGP messages sent and received from the neighbor

type: Messages

config: False

queues

Counters related to queued messages associated with the BGP neighbor

type: Queues

config: False

dynamically_configured

When this leaf is set to true, the peer was configured dynamically due to an inbound connection request from a specified source prefix within a dynamic-neighbor-prefix

type: bool

config: False

default value: false