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 ]

The BGP information pertaining to a peer.

Naming Rules
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
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] fabric:Topology The root for IFC topology.
 
 ├
[V] fabric:Pod A pod.
 
 
 ├
[V] fabric:Node The root node for the APIC.
 
 
 
 ├
[V] 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...
 
 
 
 
 ├
[V] bgp:Entity The BGP control plane entity information.
 
 
 
 
 
 ├
[V] bgp:Inst The per BGP instance information. There is only instance supported in BGP.
 
 
 
 
 
 
 ├
[V] bgp:Dom The object that represents all the BGP domain (VRF) information.
 
 
 
 
 
 
 
 ├
[V] bgp:Peer The BGP information pertaining to a peer.
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] 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...
 
 ├
[V] bgp:Entity The BGP control plane entity information.
 
 
 ├
[V] bgp:Inst The per BGP instance information. There is only instance supported in BGP.
 
 
 
 ├
[V] bgp:Dom The object that represents all the BGP domain (VRF) information.
 
 
 
 
 ├
[V] bgp:Peer The BGP information pertaining to a peer.


Contained Hierarchy
[V] bgp:Peer The BGP information pertaining to a peer.
 ├
[V] bgp:LocalAsn The local autonomous system (AS) information pertaining to a peer.
 ├
[V] 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.
 
 ├
[V] bgp:DefRtLeakP The default route leak policy.
 
 
 ├
[V] 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.
 
 ├
[V] 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.
 
 
 ├
[V] 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.
 
 ├
[V] bgp:RtCtrlP The route control policy for routes coming/going to peers. There are few ways to apply this policy.
 
 
 ├
[V] 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.
 
 ├
[V] 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...
 
 
 ├
[V] 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.
 ├
[V] 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.
 
 ├
[V] bgp:GrSt The per-neighbor graceful restart operational information.
 
 ├
[V] 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.
 
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 
 ├
[V] 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.
 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[V] bgp:PeerEntryStats The BGP peer statistics operational information.
 
 ├
[V] bgp:PeerEvents Peer event information.
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 ├
[V] 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.
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] bgp:PeerFallOver  This object holds fallover information
 ├
[V] bgp:PeerIntervals  This object holds configured peer timers information
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 ├
[V] health:Inst A base class for a health score instance.(Switch only)


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


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: bgp:Peer
bgp:PfxPeerCounts
          scalar:Uint64
activePfxPeers  (bgp:Peer:activePfxPeers)
          
address:Ip addr  (bgp:Peer:addr)
           Peer address
nw:AdminSt
          scalar:Enum8
adminSt  (bgp:Peer:adminSt)
           Administrative state of the peer.
rtcom:AS
          scalar:Uint32
asn  (bgp:Peer:asn)
           Remote ASN
scalar:Bitmask64 bgpCfgFailedBmp  (bgp:Peer:bgpCfgFailedBmp)
          
scalar:Time bgpCfgFailedTs  (bgp:Peer:bgpCfgFailedTs)
          
scalar:UByte bgpCfgState  (bgp:Peer:bgpCfgState)
          
bgp:PeerControl
          scalar:Bitmask8
ctrl  (bgp:Peer:ctrl)
           The control state.
bgp:PfxPeerCounts
          scalar:Uint64
curPfxPeers  (bgp:Peer:curPfxPeers)
          
bgp:PfxPeerCounts
          scalar:Uint64
maxCurPeers  (bgp:Peer:maxCurPeers)
          
bgp:PfxPeerCounts
          scalar:Uint64
maxPfxPeers  (bgp:Peer:maxPfxPeers)
          
reference:BinRef monPolDn  (bgp:Peer:monPolDn)
           The monitoring policy attached to this observable object.
string:Password password  (bgp:Peer:password)
           Password
bgp:SpineRoleType
          scalar:Bitmask8
peerRole  (bgp:Peer:peerRole)
           Peer role
bgp:PrivateASControl
          scalar:Bitmask8
privateASctrl  (bgp:Peer:privateASctrl)
           remove-private-as controls
nw:IfId
          base:IfIndex
srcIf  (bgp:Peer:srcIf)
           Source interface
bgp:PfxPeerCounts
          scalar:Uint64
totalPfxPeers  (bgp:Peer:totalPfxPeers)
          
bgp:TtlVal
          scalar:Uint16
ttl  (bgp:Peer:ttl)
           Specifies time to live (TTL).
bgp:PeerType
          scalar:Bitmask8
type  (bgp:Peer:type)
           The specific type of the object or component.
Defined in: nw:Ep
naming:Name
          string:Basic
name  (nw:Ep:name)
           Overrides:nw:Conn:name
           The name of the object.
Defined in: mo:Resolvable
mo:Owner
          scalar:Enum8
lcOwn  (mo:Resolvable:lcOwn)
           A value that indicates how this object was created. For internal use only.
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32
childAction  (mo:TopProps:childAction)
           Delete or ignore. For internal use only.
reference:BinRef dn  (mo:TopProps:dn)
           A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
reference:BinRN rn  (mo:TopProps:rn)
           Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
mo:ModificationStatus
          scalar:Bitmask32
status  (mo:TopProps:status)
           The upgrade status. This property is for internal use only.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Properties Detail

activePfxPeers

Type: bgp:PfxPeerCounts
Primitive Type: scalar:Uint64

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



addr

Type: address:Ip

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



adminSt

Type: nw:AdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Administrative state of the peer.
Constants
enabled 1 Enabled Enabled
disabled 2 Disabled Disabled
DEFAULT enabled(1) Enabled Enabled





asn

Type: rtcom:AS
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Remote ASN



bgpCfgFailedBmp

Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
bgp:PeerlcOwn_failed_flag -9223372036854775808ull --- NO COMMENTS
bgp:PeerpeerRole_failed_flag 16384ull --- NO COMMENTS
bgp:Peerasn_failed_flag 16ull --- NO COMMENTS
bgp:Peername_failed_flag 1ull --- NO COMMENTS
bgp:PeermodTs_failed_flag 2305843009213693952ull --- NO COMMENTS
bgp:Peerctrl_failed_flag 256ull --- NO COMMENTS
bgp:Peerttl_failed_flag 262144ull --- NO COMMENTS
bgp:PeerprivateASctrl_failed_flag 32768ull --- NO COMMENTS
bgp:PeermonPolDn_failed_flag 4096ull --- NO COMMENTS
bgp:Peeraddr_failed_flag 4ull --- NO COMMENTS
bgp:Peertype_failed_flag 524288ull --- NO COMMENTS
bgp:PeersrcIf_failed_flag 65536ull --- NO COMMENTS
bgp:Peerpassword_failed_flag 8192ull --- NO COMMENTS
bgp:PeeradminSt_failed_flag 8ull --- NO COMMENTS
DEFAULT 0 --- NO COMMENTS





bgpCfgFailedTs

Type: scalar:Time

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



bgpCfgState

Type: scalar:UByte

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



childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
    Comments:
Delete or ignore. For internal use only.
Constants
deleteAll 16384u deleteAll NO COMMENTS
ignore 4096u ignore NO COMMENTS
deleteNonPresent 8192u deleteNonPresent NO COMMENTS
DEFAULT 0 --- This type is used to





ctrl

Type: bgp:PeerControl
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The control state.
Constants
bfd 1 BFD Bidirectional Forwarding Detection
dis-conn-check 2 Disable Connected Check Disable checking whether single-hop eBGP peer is directly connected
DEFAULT 0 --- Peer Control





curPfxPeers

Type: bgp:PfxPeerCounts
Primitive Type: scalar:Uint64

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



dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
    Comments:
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
    Comments:
A value that indicates how this object was created. For internal use only.
Constants
local 0 Local NO COMMENTS
policy 1 Policy NO COMMENTS
replica 2 Replica NO COMMENTS
resolveOnBehalf 3 ResolvedOnBehalf NO COMMENTS
implicit 4 Implicit NO COMMENTS
DEFAULT local(0) Local NO COMMENTS





maxCurPeers

Type: bgp:PfxPeerCounts
Primitive Type: scalar:Uint64

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



maxPfxPeers

Type: bgp:PfxPeerCounts
Primitive Type: scalar:Uint64

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



modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The time when this object was last modified.
Constants
never 0ull never NO COMMENTS
DEFAULT never(0ull) never NO COMMENTS





monPolDn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
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
    Comments:
The name of the object.



password

Type: string:Password

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



peerRole

Type: bgp:SpineRoleType
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Peer role
Constants
unspecified 0 Unspecified Unspecified
wan 1 WAN Spine WAN (GOLF) Spine
inter-pod 2 Inter-Pod Spine Inter-Pod (MPOD) Spine
msite-speaker 4 Multi-Site Speaker Multi-Site Speaker
msite-forwarder 8 Multi-Site Forwarder Multi-Site Forwarder
DEFAULT unspecified(0) Unspecified Unspecified





privateASctrl

Type: bgp:PrivateASControl
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
remove-private-as controls
Constants
remove-exclusive 1 Remove private AS Enable removal of private AS exclusively if no public AS exist
remove-all 2 Remove all private AS Remove private AS even if public AS's exist
replace-as 4 Replace private AS with local AS Replace private AS with local AS
defaultValue 0 --- Default is disabled





rn

Type: reference:BinRN

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
    Comments:
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
    Comments:
Source interface



status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
    Comments:
The upgrade status. This property is for internal use only.
Constants
created 2u created In a setter method: specifies that an object should be created. An error is returned if the object already exists.
In the return value of a setter method: indicates that an object has been created.
modified 4u modified In a setter method: specifies that an object should be modified
In the return value of a setter method: indicates that an object has been modified.
deleted 8u deleted In a setter method: specifies that an object should be deleted.
In the return value of a setter method: indicates that an object has been deleted.
DEFAULT 0 --- This type controls the life cycle of objects passed in the XML API.

When used in a setter method (such as configConfMo), the ModificationStatus specifies whether an object should be created, modified, deleted or removed.
In the return value of a setter method, the ModificationStatus indicates the actual operation that was performed. For example, the ModificationStatus is set to "created" if the object was created. The ModificationStatus is not set if the object was neither created, modified, deleted or removed.

When invoking a setter method, the ModificationStatus is optional:
If a setter method such as configConfMo is invoked and the ModificationStatus is not set, the system automatically determines if the object should be created or modified.






totalPfxPeers

Type: bgp:PfxPeerCounts
Primitive Type: scalar:Uint64

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



ttl

Type: bgp:TtlVal
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Specifies time to live (TTL).
Constants
defaultValue 1 --- NO COMMENTS





type

Type: bgp:PeerType
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The specific type of the object or component.
Constants
intra-site 1 Peer for Intra-Site Connectivity Intra Site Peer
wan 2 Peer for WAN Connectivity WAN
local 4 Peer for Local POD Connectivity Local
manual 8 Peer Configured Manually Manual
trusted-cloud 16 Peer for trusted cloud AVS connectivity AVS Cloud
inter-site 32 Peer for Inter-Site Connectivity Inter Site Peer
intra-pod 64 Peer for Intra-POD Connectivity in case of Multi-Site Intra POD Peer
DEFAULT local(4) Peer for Local POD Connectivity Local