Class bgp:Peer (CONCRETE)

Class ID:2608
Class Label: BGP Peer
Encrypted: true - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-protocol-l3, admin, fabric-protocol-l3, tenant-ext-protocol-l3, tenant-protocol-l3]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: false, HasHealth: true, HasEventRules: false ]

RN FORMAT: peer-{[addr]}

    [1] PREFIX=peer- PROPERTY = addr




DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/bgp/inst/dom-{name}/peer-{[addr]}

[1] sys/bgp/inst/dom-{name}/peer-{[addr]}

                

Diagram

Super Mo: l3:ProtAdjEp, Container Mos: bgp:Dom (deletable:no), Contained Mos: bgp:LocalAsn, bgp:PeerAf, bgp:PeerEntry, bgp:PeerFallOver, bgp:PeerIntervals,

Containers Hierarchies

top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.  ├ fabric:Topology The root for IFC topology.    ├ fabric:Pod A pod.      ├ fabric:Node The root node for the APIC.        ├ top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...          ├ bgp:Entity The BGP control plane entity information.            ├ bgp:Inst The per BGP instance information. There is only instance supported in BGP.              ├ bgp:Dom The object that represents all the BGP domain (VRF) information.                ├ bgp:Peer The BGP information pertaining to a peer. top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.  ├ top:System The APIC uses a policy model to combine data into a health score. Health scores can be aggregated for a variety of areas such as for the infrastructure, applications, or services. The category health score is calculated using a Lp -Norm formula. The health score penalty equals 100 minus the health score. The health score penalty represents the overall health score penalties of a set of MOs that belong to a given category and are children or direc...    ├ bgp:Entity The BGP control plane entity information.      ├ bgp:Inst The per BGP instance information. There is only instance supported in BGP.        ├ bgp:Dom The object that represents all the BGP domain (VRF) information.          ├ bgp:Peer The BGP information pertaining to a peer.

Contained Hierarchy

bgp:Peer The BGP information pertaining to a peer.  ├ bgp:LocalAsn The local autonomous system (AS) information pertaining to a peer.  ├ bgp:PeerAf The BGP peer information for a BGP peer address family. Each address family maintains a separate BGP database, which allows you to configure BGP policy on per-address family basis.    ├ bgp:DefRtLeakP The default route leak policy.      ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.    ├ bgp:MaxPfxP The maximum prefix policy specifies the action to be taken when the number of prefixes advertised by the peer crosses a specified maximum limit. This policy is used as a defensive mechanism to protect resources on the router.      ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.    ├ bgp:RtCtrlP The route control policy for routes coming/going to peers. There are few ways to apply this policy.      ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.    ├ bgp:RtExpP  Route export policy to control whether to export routes into a different address family. Destination address family is specified in the object. Object may be nested within peer Address family (AF) to subject only those peer's particular AF routes to export. Object can also be under a domain Address family in which case it is applicable to all pe...      ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.  ├ bgp:PeerEntry The BGP peer status specifies the status of a relationship between BGP speakers. A BGP speaker does not discover another BGP speaker automatically. You must configure the relationships between BGP speakers. A BGP peer is a BGP speaker that has an active TCP connection to another BGP speaker.    ├ bgp:GrSt The per-neighbor graceful restart operational information.    ├ bgp:PeerAfEntry The operational status information for a BGP peer address family. Each address family maintains a separate BGP database, which allows you to configure BGP policy on per-address family basis.      ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.      ├ fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.      ├ health:Inst A base class for a health score instance.(Switch only)    ├ bgp:PeerEntryStats The BGP peer statistics operational information.    ├ bgp:PeerEvents Peer event information.    ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.    ├ fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.    ├ health:Inst A base class for a health score instance.(Switch only)  ├ bgp:PeerFallOver  This object holds fallover information  ├ bgp:PeerIntervals  This object holds configured peer timers information  ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.  ├ health:Inst A base class for a health score instance.(Switch only)

Inheritance

nw:Item Ignore.  ├ nw:Conn A connection abstraction.    ├ nw:Ep A static endpoint.      ├ nw:ConnEp A connection endpoint abstraction.        ├ nw:AdjEp The adjacency endpoint. This is the endpoint object that contains information regarding dynamically learned endpoints.          ├ nw:ProtAdjEp A protocol adjacency endpoint abstraction.            ├ l3:ProtAdjEp A layer 3 protocol adjacency abstraction.              ├ bgp:Peer The BGP information pertaining to a peer.

activePfxPeers

Type: bgp:PfxPeerCounts
Primitive Type: scalar:Uint64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular

addr

Type: address:Ip

Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular

Peer address

adminSt

Type: nw:AdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Administrative state of the peer.

asn

Type: rtcom:AS
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Remote ASN

bgpCfgFailedBmp

Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular

bgpCfgFailedTs

Type: scalar:Time

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular

bgpCfgState

Type: scalar:UByte

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction

Delete or ignore. For internal use only.

ctrl

Type: bgp:PeerControl
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The control state.

curPfxPeers

Type: bgp:PfxPeerCounts
Primitive Type: scalar:Uint64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular

dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn

A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.

lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

A value that indicates how this object was created. For internal use only.

maxCurPeers

Type: bgp:PfxPeerCounts
Primitive Type: scalar:Uint64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular

maxPfxPeers

Type: bgp:PfxPeerCounts
Primitive Type: scalar:Uint64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular

modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The time when this object was last modified.

monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The monitoring policy attached to this observable object.

name

Type: naming:Name
Primitive Type: string:Basic

Overrides:nw:Conn:name

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular

The name of the object.

password

Type: string:Password

Units: null
Encrypted: true
Access: implicit
Category: TopLevelRegular

Password

peerRole

Type: bgp:SpineRoleType
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Peer role

privateASctrl

Type: bgp:PrivateASControl
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

remove-private-as controls

rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn

Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.

srcIf

Type: nw:IfId
Primitive Type: base:IfIndex

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Source interface

status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus

The upgrade status. This property is for internal use only.

totalPfxPeers

Type: bgp:PfxPeerCounts
Primitive Type: scalar:Uint64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular

ttl

Type: bgp:TtlVal
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

Specifies time to live (TTL).

type

Type: bgp:PeerType
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular

The specific type of the object or component.