Class bgp:Inst (CONCRETE)

Class ID:2629
Class Label: BGP Instance
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-protocol, admin, fabric-protocol, tenant-ext-protocol, tenant-protocol]
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 per BGP instance information. There is only instance supported in BGP.

Naming Rules
RN FORMAT: inst

    [1] PREFIX=inst


DN FORMAT: 

[0] topology/pod-{id}/node-{id}/sys/bgp/inst

[1] sys/bgp/inst

                


Diagram

Super Mo: l3:ProtInst,
Container Mos: bgp:Entity (deletable:no),
Contained Mos: bgp:Dom, bgp:EncapGroupEvi,


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] 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.


Contained Hierarchy
[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:BDEvi  This object holds Bridge Domain Ethernet VPN instance information
 
 
 ├
[V] bgp:CktEpEvi  This object holds Circuit Endpoint (EPG) Ethernet VPN instance information
 
 
 
 ├
[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:EVpnImetRoute  This object holds the bgp evpn imet route information
 
 
 ├
[V] bgp:EVpnMacIpRoute  This object holds the bgp evpn mac-ip route information
 
 
 ├
[V] bgp:EVpnPfxRoute  This object holds the bgp evpn ip prefix route information
 
 
 ├
[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:Db  BGP databases
 
 
 ├
[V] bgp:DTEp  Tunnel endpoints discovered through bgp
 
 ├
[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: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] ip:RsConsRoot 
 
 
 ├
[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] ip:RsConsRoot 
 
 
 
 ├
[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.
 
 ├
[V] bgp:DomEvi  This object holds Domain Ethernet VPN instance information
 
 
 ├
[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:Gr The per-domain graceful restart information.
 
 
 ├
[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:PathCtrl  This object holds global BGP bestpath knobs at Dom level
 
 ├
[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] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 
 
 
 
 ├
[V] tag:Annotation 
 
 
 
 
 
 ├
[V] tag:Tag 
 
 
 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 
 
 
 ├
[V] bgp:PeerEntryStats The BGP peer statistics operational 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] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 
 
 
 
 ├
[V] tag:Annotation 
 
 
 
 
 
 ├
[V] tag:Tag 
 
 
 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 
 
 
 ├
[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] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 
 
 
 ├
[V] tag:Annotation 
 
 
 
 
 ├
[V] tag:Tag 
 
 
 
 ├
[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] 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] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 
 
 ├
[V] tag:Annotation 
 
 
 
 ├
[V] tag:Tag 
 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[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] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 
 ├
[V] tag:Annotation 
 
 
 ├
[V] tag:Tag 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] bgp:EncapGroupEvi  This object holds EncapGroup Ethernet VPN instance information which carries routes for a Group of Encaps
 
 ├
[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: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:Vni  This object holds VNI information for multi-site routes
 
 
 ├
[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] 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] aaa:RbacAnnotation  RbacAnnotation is used for capturing rbac properties of any apic object Objects can append rbacannotations as Object->RbacAnnotation which is then checked for domain eligibility
 
 ├
[V] tag:Annotation 
 
 ├
[V] tag:Tag 
 ├
[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:CpInst A control plane instance abstraction. This object represents an instance of the protocol. For example, the protocol instance of OSPF or ISIS.
 
 
 
 ├
[V] nw:ProtInst A protocol instance abstraction.
 
 
 
 
 ├
[V] l3:ProtInst A layer 3 protocol instance abstraction.
 
 
 
 
 
 ├
[V] bgp:Inst The per BGP instance information. There is only instance supported in BGP.


Events
                bgp:Inst:bgp_Inst_operErr
bgp:Inst:bgp_Inst_adminStChange


Faults
                bgp:Inst:memAlertCritical


Fsms
                


Properties Summary
Defined in: bgp:Inst
scalar:Date activateTs  (bgp:Inst:activateTs)
           Indicates the BGP domain timestamp of the first peer up.
bgp:AsPathDbSz
          scalar:Uint32
asPathDbSz  (bgp:Inst:asPathDbSz)
           The current size of AS path database.
rtcom:AS
          scalar:Uint32
asn  (bgp:Inst:asn)
           A number that uniquely defines an autonomous system.
bgp:AttribDbSz
          scalar:Uint32
attribDbSz  (bgp:Inst:attribDbSz)
           The current size of attribute database.
scalar:Date createTs  (bgp:Inst:createTs)
           The timestamp when the BGP protocol was created.
nw:InstCtrl
          scalar:Bitmask64
ctrl  (bgp:Inst:ctrl)
           Overrides:nw:CpInst:ctrl
           The control state.
base:Community fabricSoO  (bgp:Inst:fabricSoO)
           Fabric Site of Origin
base:Community mSiteSoO  (bgp:Inst:mSiteSoO)
           Msite Site of Origin
nw:MemAlertLevel
          scalar:Enum8
memAlert  (bgp:Inst:memAlert)
           Memory alert level.
reference:BinRef monPolDn  (bgp:Inst:monPolDn)
           The monitoring policy attached to this observable object.
cap:Quant
          scalar:Uint16
numAsPath  (bgp:Inst:numAsPath)
           The number of autonomous system (AS) path entries learned.
cap:Quant
          scalar:Uint16
numRtAttrib  (bgp:Inst:numRtAttrib)
           The number of route attribute entries learned.
base:Community podSoO  (bgp:Inst:podSoO)
           Pod Site of Origin
snmp:SnmpTrapSt
          scalar:Enum8
snmpTrapSt  (bgp:Inst:snmpTrapSt)
           The administrative port SNMP trap state.
bgp:SpineRoleType
          scalar:Bitmask8
spineRole  (bgp:Inst:spineRole)
           Spine role
nw:AdminSt
          scalar:Enum8
supprRt  (bgp:Inst:supprRt)
           Suppress advertisement of routes that are not yet programmed in hardware
syslog:Level
          scalar:Enum8
syslogLvl  (bgp:Inst:syslogLvl)
           The syslog message level.
bgp:Ver
          scalar:Enum8
ver  (bgp:Inst:ver)
           BGP version.
scalar:Date waitDoneTs  (bgp:Inst:waitDoneTs)
           The timestamp when the BGP protocol came out of wait mode.
Defined in: nw:CpInst
nw:AdminSt
          scalar:Enum8
adminSt  (nw:CpInst:adminSt)
           The administrative state of the object or policy.
naming:Name
          string:Basic
name  (nw:CpInst:name)
           Overrides:nw:Conn:name
           The name of the object.
nw:OperErrQual
          scalar:Bitmask64
operErr  (nw:CpInst:operErr)
          
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:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
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.
Properties Detail

activateTs

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Indicates the BGP domain timestamp of the first peer up.



adminSt

Type: nw:AdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The administrative state of the object or policy.
Constants
enabled 1 Enabled Enabled
disabled 2 Disabled Disabled
DEFAULT enabled(1) Enabled Enabled





asPathDbSz

Type: bgp:AsPathDbSz
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The current size of AS path database.



asn

Type: rtcom:AS
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A number that uniquely defines an autonomous system.



attribDbSz

Type: bgp:AttribDbSz
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The current size of attribute database.



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





createTs

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The timestamp when the BGP protocol was created.



ctrl

Type: nw:InstCtrl
Primitive Type: scalar:Bitmask64

Overrides:nw:CpInst:ctrl
Units: null Encrypted: false Access: implicit Category: TopLevelRegular
    Comments:
The control state.
Constants
stateful-ha 1ull stateful-ha Enable stateful HA
fastExtFallover 64ull Enable fast external fallover Fast external fallover
DEFAULT fastExtFallover(64ull) Enable fast external fallover Fast external fallover





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.



fabricSoO

Type: base:Community

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Fabric Site of Origin



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





mSiteSoO

Type: base:Community

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Msite Site of Origin



memAlert

Type: nw:MemAlertLevel
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Memory alert level.
Constants
normal 0 Normal Normal
minor 1 Minor Minor
major 2 Major Major
critical 3 Critical Criticial
DEFAULT normal(0) Normal Normal





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: create Category: TopLevelRegular
    Comments:
The name of the object.



numAsPath

Type: cap:Quant
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The number of autonomous system (AS) path entries learned.
Constants
defaultValue 0 --- NO COMMENTS





numRtAttrib

Type: cap:Quant
Primitive Type: scalar:Uint16

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The number of route attribute entries learned.
Constants
defaultValue 0 --- NO COMMENTS





operErr

Type: nw:OperErrQual
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
Constants
sock-err 16ull Socket error Socket errors
init-err 1ull Initialization error Initialization errors
mem-err 2ull Memory error Memory errors
proto-err 32ull Protocol error Protocol errors
ipc-err 4ull IPC error IPC errors
feature-unsupported 64ull Feature Unsupported Feature Unsupported
int-err 8ull Internal error Internal errors
DEFAULT 0 --- Operational error qualifier





podSoO

Type: base:Community

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Pod Site of Origin



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.



snmpTrapSt

Type: snmp:SnmpTrapSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The administrative port SNMP trap state.
Constants
disable 1 Disable disabled
enable 1 Enable enabled
DEFAULT enable(1) Enable enabled





spineRole

Type: bgp:SpineRoleType
Primitive Type: scalar:Bitmask8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Spine 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





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.






supprRt

Type: nw:AdminSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Suppress advertisement of routes that are not yet programmed in hardware
Constants
enabled 1 Enabled Enabled
disabled 2 Disabled Disabled
DEFAULT enabled(1) Enabled Enabled





syslogLvl

Type: syslog:Level
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The syslog message level.
Constants
emerg 0 Emergency Emergency
alert 1 Alert Alert
crit 2 Critical Critical
err 3 Error Error
warn 4 Warning Warning
notif 5 Notification Notification
inform 6 Informational Informational
debug 7 Debug Debug
DEFAULT err(3) Error Error





ver

Type: bgp:Ver
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
BGP version.
Constants
v4 4 BGP Version 4 NO COMMENTS
DEFAULT v4(4) BGP Version 4 NO COMMENTS





waitDoneTs

Type: scalar:Date

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The timestamp when the BGP protocol came out of wait mode.