Class bgp:DomAf (CONCRETE)

Class ID:2606
Class Label: Address Family Domain
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: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

The BGP (VRF) address family information.

Naming Rules
RN FORMAT: af-{type}

    [1] PREFIX=af- PROPERTY = type




DN FORMAT: 

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

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

                


Diagram

Super Mo: bgp:Af,
Container Mos: bgp:Dom (deletable:no),
Contained Mos: bgp:AddlPath, bgp:AdminDist, bgp:DampeningCtrl, bgp:DefRtLeakP, bgp:HostLeakP, bgp:InterLeakP, bgp:NextHop, bgp:RibLeakP, bgp:Route, bgp:RtExpP, bgp:RtSum, bgp:RttP, bgp:VpnCtrlP, bgp:VpnRoute,


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:DomAf The BGP (VRF) address family information.
[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:DomAf The BGP (VRF) address family information.


Contained Hierarchy
[V] bgp:DomAf The BGP (VRF) address family information.
 ├
[V] bgp:AddlPath  BGP Additional Paths feature allows the advertisement of multiple paths through the same peering session for the same prefix without the new paths implicitly replacing any previous paths
 ├
[V] bgp:AdminDist The administrative distance is used by routers to select the best path when there are two or more different routes to the same destination from two different routing protocols.
 ├
[V] bgp:DampeningCtrl  Route dampening parameters
 ├
[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:HostLeakP  COOP/L2RIB to BGP host route leak policy. This defines policy to control the distribution of host routes from COOP/L2RIB to BGP
 
 ├
[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:InterLeakP A policy that defines distribution of routes from one protocol to another protocol.
 
 ├
[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:NextHop The BGP route information for the next hop.
 
 ├
[V] bgp:AttNextHop The attached next hop.
 ├
[V] bgp:RibLeakP 
 ├
[V] bgp:Route The BGP route table for a particular address family (IPv4 unicast and IPv6 unicast), which contains all the routes advertised by peers and also redistributed into BGP from other routing protocols. This route table is per tenant context (per VRF).
 
 ├
[V] bgp:Path The BGP AS path.
 
 
 ├
[V] bgp:AsSeg The BGP path AS segment information.
 
 
 
 ├
[V] bgp:AsItem The Autonomous System segment items.
 
 
 ├
[V] bgp:ExtComm An extended community.
 
 
 ├
[V] bgp:RegComm The regular community.
 ├
[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:RtSum  Route Summarization
 
 ├
[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:RttP The route target policy.
 
 ├
[V] bgp:RtCtrlMapP  Route control map policy for routes imported/exported into an AF. Control is through route maps.
 
 
 ├
[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:RttEntry A list of route targets.
 
 ├
[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:VpnCtrlP  This object holds policy to control vpn af information for a given vrf
 
 ├
[V] bgp:PfxLeakCtrlP  This object holds route control policy for all networks defined by PfxLeakP in that domain
 
 
 ├
[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:PfxLeakP  This objects holds route leak policy for a given network
 
 
 ├
[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] ip:Cons Used for maintaining consumers of a static route from an IPRoueDef.
 
 ├
[V] bgp:RtP  Route policy holds all route targets and route controls
 
 
 ├
[V] bgp:RtCtrlMapP  Route control map policy for routes imported/exported into an AF. Control is through route maps.
 
 
 
 ├
[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:RttEntry A list of route targets.
 
 
 ├
[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:VpnRoute The BGP route table for a VPN address family (VPNv4 unicast and VPNv6 unicast). The VPN address family routes are exchanged within the fabric over MP-BGP sessions between spines and leafs. Routes are advertised from border leafs to non-border leafs with spines acting as route reflectors.
 
 ├
[V] bgp:Path The BGP AS path.
 
 
 ├
[V] bgp:AsSeg The BGP path AS segment information.
 
 
 
 ├
[V] bgp:AsItem The Autonomous System segment items.
 
 
 ├
[V] bgp:ExtComm An extended community.
 
 
 ├
[V] bgp:RegComm The regular community.


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:DomAf The BGP (VRF) address family information.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: bgp:DomAf
scalar:Date bestPathCmpltTs  (bgp:DomAf:bestPathCmpltTs)
           The first best path completed timestamp.
scalar:Date bestPathSigTs  (bgp:DomAf:bestPathSigTs)
           The first best path signalled timestamp.
bgp:NhTimeout
          scalar:Uint16
critNhTimeout  (bgp:DomAf:critNhTimeout)
           The next-hop address tracking delay timer for critical next-hop reachability routes.
bgp:MaxEcmp
          scalar:UByte
maxEcmp  (bgp:DomAf:maxEcmp)
           The maximum number of equal-cost paths for BGP load sharing.
bgp:NhTimeout
          scalar:Uint16
nonCritNhTimeout  (bgp:DomAf:nonCritNhTimeout)
           The next-hop address tracking delay timer for non-critical next-hop reachability routes.
bgp:TblVer
          scalar:Uint32
tblVer  (bgp:DomAf:tblVer)
          
bgp:AfT
          scalar:Enum8
type  (bgp:DomAf:type)
           Overrides:bgp:Af:type
           The domain address family type.
Defined in: nw:CpDom
naming:Name
          string:Basic
name  (nw:CpDom: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

bestPathCmpltTs

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The first best path completed timestamp.



bestPathSigTs

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The first best path signalled timestamp.



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





critNhTimeout

Type: bgp:NhTimeout
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The next-hop address tracking delay timer for critical next-hop reachability routes.
Constants
crit 3000 Next-hop Critical Trigger-delay NO COMMENTS
DEFAULT crit(3000) Next-hop Critical Trigger-delay NO 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





maxEcmp

Type: bgp:MaxEcmp
Primitive Type: scalar:UByte

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The maximum number of equal-cost paths for BGP load sharing.
Constants
defaultValue 16 --- NO 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





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.



nonCritNhTimeout

Type: bgp:NhTimeout
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The next-hop address tracking delay timer for non-critical next-hop reachability routes.
Constants
noncrit 10000 Next-hop Non-critical Trigger-delay NO COMMENTS
DEFAULT noncrit(10000) Next-hop Non-critical Trigger-delay NO 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.






tblVer

Type: bgp:TblVer
Primitive Type: scalar:Uint32

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



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:
The domain address family type.
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