Class bgp:Entity (CONCRETE)

Class ID:2628
Class Label: BGP Entity
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-l3, admin, fabric-protocol-l3, tenant-ext-protocol-l3, tenant-protocol-l3]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: Fabric
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: false, HasHealth: true, HasEventRules: false ]

RN FORMAT: bgp

    [1] PREFIX=bgp


DN FORMAT: 

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

[1] sys/bgp

                

Diagram

Super Mo: l3:ProtEntity, Container Mos: top:System (deletable:no), Contained Mos: bgp:Inst,

Containers Hierarchies

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

Contained Hierarchy

bgp:Entity The BGP control plane entity information.  ├ bgp:Inst The per BGP instance information. There is only instance supported in BGP.    ├ bgp:Dom The object that represents all the BGP domain (VRF) information.      ├ bgp:BDEvi  This object holds Bridge Domain Ethernet VPN instance information        ├ bgp:CktEpEvi  This object holds Circuit Endpoint (EPG) Ethernet VPN instance information          ├ bgp:RttP The route target policy.            ├ bgp:RtCtrlMapP  Route control map policy for routes imported/exported into an AF. Control is through route maps.              ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.            ├ bgp:RttEntry A list of route targets.            ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.        ├ bgp:EVpnImetRoute  This object holds the bgp evpn imet route information        ├ bgp:EVpnMacIpRoute  This object holds the bgp evpn mac-ip route information        ├ bgp:EVpnPfxRoute  This object holds the bgp evpn ip prefix route information        ├ bgp:RttP The route target policy.          ├ bgp:RtCtrlMapP  Route control map policy for routes imported/exported into an AF. Control is through route maps.            ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.          ├ bgp:RttEntry A list of route targets.          ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.      ├ bgp:Db  BGP databases        ├ bgp:DTEp  Tunnel endpoints discovered through bgp      ├ bgp:DomAf The BGP (VRF) address family information.        ├ 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        ├ 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.        ├ bgp:DampeningCtrl  Route dampening parameters        ├ bgp:DefRtLeakP The default route leak policy.          ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.        ├ bgp:HostLeakP  COOP/L2RIB to BGP host route leak policy. This defines policy to control the distribution of host routes from COOP/L2RIB to BGP          ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.        ├ bgp:InterLeakP A policy that defines distribution of routes from one protocol to another protocol.          ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.        ├ bgp:NextHop The BGP route information for the next hop.          ├ bgp:AttNextHop The attached next hop.        ├ bgp:RibLeakP         ├ 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).          ├ bgp:Path The BGP AS path.            ├ bgp:AsSeg The BGP path AS segment information.              ├ bgp:AsItem The Autonomous System segment items.            ├ bgp:ExtComm An extended community.            ├ bgp:RegComm The regular community.        ├ bgp:RtExpP  Route export policy to control whether to export routes into a different address family. Destination address family is specified in the object. Object may be nested within peer Address family (AF) to subject only those peer's particular AF routes to export. Object can also be under a domain Address family in which case it is applicable to all pe...          ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.        ├ bgp:RtSum  Route Summarization          ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.        ├ bgp:RttP The route target policy.          ├ bgp:RtCtrlMapP  Route control map policy for routes imported/exported into an AF. Control is through route maps.            ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.          ├ bgp:RttEntry A list of route targets.          ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.        ├ bgp:VpnCtrlP  This object holds policy to control vpn af information for a given vrf          ├ bgp:PfxLeakCtrlP  This object holds route control policy for all networks defined by PfxLeakP in that domain            ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.          ├ bgp:PfxLeakP  This objects holds route leak policy for a given network            ├ 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.            ├ ip:Cons Used for maintaining consumers of a static route from an IPRoueDef.              ├ ip:RsConsRoot           ├ bgp:RtP  Route policy holds all route targets and route controls            ├ bgp:RtCtrlMapP  Route control map policy for routes imported/exported into an AF. Control is through route maps.              ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.            ├ bgp:RttEntry A list of route targets.            ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.        ├ bgp: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.          ├ bgp:Path The BGP AS path.            ├ bgp:AsSeg The BGP path AS segment information.              ├ bgp:AsItem The Autonomous System segment items.            ├ bgp:ExtComm An extended community.            ├ bgp:RegComm The regular community.      ├ bgp:DomEvi  This object holds Domain Ethernet VPN instance information        ├ bgp:RttP The route target policy.          ├ bgp:RtCtrlMapP  Route control map policy for routes imported/exported into an AF. Control is through route maps.            ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.          ├ bgp:RttEntry A list of route targets.          ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.      ├ bgp:Gr The per-domain graceful restart information.        ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.      ├ bgp:Peer The BGP information pertaining to a peer.        ├ bgp:LocalAsn The local autonomous system (AS) information pertaining to a peer.        ├ bgp:PeerAf The BGP peer information for a BGP peer address family. Each address family maintains a separate BGP database, which allows you to configure BGP policy on per-address family basis.          ├ bgp:DefRtLeakP The default route leak policy.            ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.          ├ bgp:MaxPfxP The maximum prefix policy specifies the action to be taken when the number of prefixes advertised by the peer crosses a specified maximum limit. This policy is used as a defensive mechanism to protect resources on the router.            ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.          ├ bgp:RtCtrlP The route control policy for routes coming/going to peers. There are few ways to apply this policy.            ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.          ├ bgp:RtExpP  Route export policy to control whether to export routes into a different address family. Destination address family is specified in the object. Object may be nested within peer Address family (AF) to subject only those peer's particular AF routes to export. Object can also be under a domain Address family in which case it is applicable to all pe...            ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.        ├ bgp:PeerEntry The BGP peer status specifies the status of a relationship between BGP speakers. A BGP speaker does not discover another BGP speaker automatically. You must configure the relationships between BGP speakers. A BGP peer is a BGP speaker that has an active TCP connection to another BGP speaker.          ├ bgp:GrSt The per-neighbor graceful restart operational information.          ├ bgp:PeerAfEntry The operational status information for a BGP peer address family. Each address family maintains a separate BGP database, which allows you to configure BGP policy on per-address family basis.            ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.            ├ fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.              ├ 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              ├ tag:Annotation               ├ tag:Tag             ├ health:Inst A base class for a health score instance.(Switch only)          ├ bgp:PeerEntryStats The BGP peer statistics operational information.            ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.            ├ fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.              ├ 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              ├ tag:Annotation               ├ tag:Tag             ├ health:Inst A base class for a health score instance.(Switch only)          ├ bgp:PeerEvents Peer event information.          ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.          ├ fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.            ├ 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            ├ tag:Annotation             ├ tag:Tag           ├ health:Inst A base class for a health score instance.(Switch only)        ├ bgp:PeerFallOver  This object holds fallover information        ├ bgp:PeerIntervals  This object holds configured peer timers information        ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.        ├ 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.          ├ 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          ├ tag:Annotation           ├ tag:Tag         ├ health:Inst A base class for a health score instance.(Switch only)      ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.      ├ fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.        ├ 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        ├ tag:Annotation         ├ tag:Tag       ├ health:Inst A base class for a health score instance.(Switch only)    ├ bgp:EncapGroupEvi  This object holds EncapGroup Ethernet VPN instance information which carries routes for a Group of Encaps      ├ bgp:RtP  Route policy holds all route targets and route controls        ├ bgp:RtCtrlMapP  Route control map policy for routes imported/exported into an AF. Control is through route maps.          ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.        ├ bgp:RttEntry A list of route targets.        ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.      ├ bgp:RttP The route target policy.        ├ bgp:RtCtrlMapP  Route control map policy for routes imported/exported into an AF. Control is through route maps.          ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.        ├ bgp:RttEntry A list of route targets.        ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.      ├ bgp:Vni  This object holds VNI information for multi-site routes        ├ bgp:RtP  Route policy holds all route targets and route controls          ├ bgp:RtCtrlMapP  Route control map policy for routes imported/exported into an AF. Control is through route maps.            ├ fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.          ├ bgp:RttEntry A list of route targets.          ├ 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.    ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.    ├ fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.      ├ 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      ├ tag:Annotation       ├ tag:Tag     ├ health:Inst A base class for a health score instance.(Switch only)  ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.  ├ health:Inst A base class for a health score instance.(Switch only)

Inheritance

nw:Item Ignore.  ├ nw:Conn A connection abstraction.    ├ nw:GEp A group endpoint abstraction.      ├ nw:CpEntity The control plane entity abstraction. This object represents a feature or protocol on the switch. For example, OSPF and VPC features.        ├ l3:ProtEntity A layer 3 protocol entity abstraction.          ├ bgp:Entity The BGP control plane entity information.

adminSt

Type: nw:AdminSt
Primitive Type: scalar:Enum8

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

The administrative state of the object or policy.

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

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

Delete or ignore. For internal use only.

dn

Type: reference:BinRef

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

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

lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

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

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

modTs

Type: mo:TStamp
Primitive Type: scalar:Date

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

The time when this object was last modified.

monPolDn

Type: reference:BinRef

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

The monitoring policy attached to this observable object.

name

Type: naming:Name
Primitive Type: string:Basic

Overrides:nw:Conn:name

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

The name of the object.

operErr

Type: nw:OperErrQual
Primitive Type: scalar:Bitmask64

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

operSt

Type: nw:EntOperSt
Primitive Type: scalar:Enum8

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

The runtime state of the object or policy.

rn

Type: reference:BinRN

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

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

status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32

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

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