Class bgp:PeerAfEntry (CONCRETE)

Class ID:2612
Class Label: BGP Peer Address Family Entry
Encrypted: false - 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: true, HasHealth: true, HasEventRules: true ]

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.

Naming Rules
RN FORMAT: af-{type}

    [1] PREFIX=af- PROPERTY = type




DN FORMAT: 

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

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

                


Diagram

Super Mo: bgp:Af,
Container Mos: bgp:PeerEntry (deletable:no),


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] 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: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] 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.
 
 
 
 
 
 ├
[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: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.


Contained Hierarchy
[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)


Inheritance
[V] nw:Item Ignore.
 ├
[V] nw:Conn A connection abstraction.
 
 ├
[V] nw:GEp A group endpoint abstraction.
 
 
 ├
[V] nw:CpDom A control plane domain abstraction. This object represents a domain within a control plane instance. For example, a VRF.
 
 
 
 ├
[V] bgp:Af A BGP abstraction for an address family domain.
 
 
 
 
 ├
[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.


Events
                bgp:PeerAfEntry:bgp_PeerAfEntry_afPfxThreshExceeded
bgp:PeerAfEntry:bgp_PeerAfEntry_afPfxThreshClear


Faults
                bgp:PeerAfEntry:afPfxLimitExceeded


Fsms
                


Properties Summary
Defined in: bgp:PeerAfEntry
bgp:NumPaths
          scalar:Uint32
acceptedPaths  (bgp:PeerAfEntry:acceptedPaths)
           Number of accepted paths
scalar:Date firstEorRcvdTs  (bgp:PeerAfEntry:firstEorRcvdTs)
          
bgp:PeerAfFlags
          scalar:Bitmask16
flags  (bgp:PeerAfEntry:flags)
          
scalar:Date lastEorRcvdTs  (bgp:PeerAfEntry:lastEorRcvdTs)
          
bgp:MemConsumed
          scalar:Uint32
memAccPaths  (bgp:PeerAfEntry:memAccPaths)
           Memory consumed by the number of accepted paths
reference:BinRef monPolDn  (bgp:PeerAfEntry:monPolDn)
           The monitoring policy attached to this observable object.
bgp:TblVer
          scalar:Uint32
peerTblVer  (bgp:PeerAfEntry:peerTblVer)
           Peer table version
bgp:PfxFlushed
          scalar:Uint64
pfxFlushed  (bgp:PeerAfEntry:pfxFlushed)
          
bgp:PfxSaved
          scalar:Uint64
pfxSaved  (bgp:PeerAfEntry:pfxSaved)
          
bgp:PfxSent
          scalar:Uint64
pfxSent  (bgp:PeerAfEntry:pfxSent)
          
bgp:TblSt
          scalar:Enum8
tblSt  (bgp:PeerAfEntry:tblSt)
           Table state
bgp:TblVer
          scalar:Uint32
tblVer  (bgp:PeerAfEntry:tblVer)
           Local BGP table version
bgp:AfT
          scalar:Enum8
type  (bgp:PeerAfEntry:type)
           Overrides:bgp:Af:type
           null
Defined in: nw:CpDom
naming:Name
          string:Basic
name  (nw:CpDom:name)
           Overrides:nw:Conn:name
           The name of the object.
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

acceptedPaths

Type: bgp:NumPaths
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Number of accepted paths



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





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.



firstEorRcvdTs

Type: scalar:Date

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



flags

Type: bgp:PeerAfFlags
Primitive Type: scalar:Bitmask16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
soft-recfg 1 Soft reconfiguration Soft reconfiguration
first-eor-rcvd 2 First EOR Received First EOR received
gr-sent 4 Address families advertised to peer Peer sent GR capability for this AF
gr-cap 8 Address families received from peer Peer supports GR capability for this AF
fwdstate-saved 16 Forwarding state preserved by peer Peer has preserved forwarding state for this AF
pfxlimit-exceeded 32 Maximum prefix limit exceeded Peer has exceeded maximum prefix limit for this AF
pfx-threshexceeded 64 Prefix count exceeded warning threshold Prefix count has exceeded warning threshold for this AF
pfx-threshclear 128 Prefix count dropped below clear threshold Prefix count dropped below clear threshold for this AF
DEFAULT 0 --- Peer AF flags





lastEorRcvdTs

Type: scalar:Date

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



memAccPaths

Type: bgp:MemConsumed
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Memory consumed by the number of accepted paths



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.



peerTblVer

Type: bgp:TblVer
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Peer table version



pfxFlushed

Type: bgp:PfxFlushed
Primitive Type: scalar:Uint64

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



pfxSaved

Type: bgp:PfxSaved
Primitive Type: scalar:Uint64

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



pfxSent

Type: bgp:PfxSent
Primitive Type: scalar:Uint64

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



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.



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.






tblSt

Type: bgp:TblSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Table state
Constants
unknown 0 Unknown Unknown
up 1 Up Up
down 2 Down Down
DEFAULT 0 --- Table state





tblVer

Type: bgp:TblVer
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Local BGP table version



type

Type: bgp:AfT
Primitive Type: scalar:Enum8

Overrides:bgp:Af:type
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming Category: TopLevelRegular
    Comments:
null
Constants
ipv4-ucast 1 IPv4 unicast address family ipv4 unicast
vpnv4-ucast 2 Vpnv4 unicast address family vpnv4 unicast
ipv6-ucast 3 IPv6 unicast address family ipv6 unicast
vpnv6-ucast 4 Vpnv6 unicast address family vpnv6 unicast
l2vpn-evpn 5 L2Vpn EVpn address family l2vpn evpn
rtfilter-ucast 6 Route target filter address family rtfilter unicast
DEFAULT ipv4-ucast(1) IPv4 unicast address family ipv4 unicast