Class hcbgp:Dom (CONCRETE)

Class ID:14819
Class Label: Domain
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled - Abstraction Layer: Logical Model - APIC NX Processing: Enabled
Write Access: [NON CONFIGURABLE]
Read Access: [access-protocol, admin, fabric-protocol, tenant-connectivity, tenant-ext-connectivity, tenant-ext-protocol, tenant-protocol]
Creatable/Deletable: no (see Container Mos for details)
Semantic Scope: None
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: false, HasHealth: true, HasEventRules: false ]

RN FORMAT: dom-{name}

    [1] PREFIX=dom- PROPERTY = name




DN FORMAT: 

[0] cprov-{vendor}/provacc-{[name]}/acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/csr-{[name]}/bgp/inst/dom-{name}

[1] acct-{[name]}/region-{[regionName]}/context-{[name]}-addr-{[primaryCidr]}/csr-{[name]}/bgp/inst/dom-{name}

                

Diagram

Super Mo: l3:ProtDom, Container Mos: hcbgp:Inst (deletable:no), Contained Mos: hcbgp:DomAf, hcbgp:Peer,

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.  ├ hcloud:Prov  MOs Cloud Provider    ├ hcloud:ProvAccount  Cloud Provider Account      ├ hcloud:Account  Represents a cloud tenant, i.e. both owner and container of cloud resources. It maps 1:1 to fvTenant. Which means that for each fvTenant an hcloudAccount must be created. Depending on the cloud provider it implies different things, as detailed as follows. AWS: hcloudAccount stores cloud account's credentials or just the accoun...        ├ hcloud:Region  Represents a cloud region managed by CAPIC. Cloud resources will not be deployed in unmanaged regions.          ├ hcloud:Ctx             ├ hcloud:Csr               ├ hcbgp:Entity  Holds bgp control plane entity information                ├ hcbgp:Inst  This objects hold per bgp instance information. There is only instance supported in bgp                  ├ hcbgp:Dom  This objects hold per bgp domain (vrf) 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.  ├ hcloud:Account  Represents a cloud tenant, i.e. both owner and container of cloud resources. It maps 1:1 to fvTenant. Which means that for each fvTenant an hcloudAccount must be created. Depending on the cloud provider it implies different things, as detailed as follows. AWS: hcloudAccount stores cloud account's credentials or just the accoun...    ├ hcloud:Region  Represents a cloud region managed by CAPIC. Cloud resources will not be deployed in unmanaged regions.      ├ hcloud:Ctx         ├ hcloud:Csr           ├ hcbgp:Entity  Holds bgp control plane entity information            ├ hcbgp:Inst  This objects hold per bgp instance information. There is only instance supported in bgp              ├ hcbgp:Dom  This objects hold per bgp domain (vrf) information

Contained Hierarchy

hcbgp:Dom  This objects hold per bgp domain (vrf) 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.  ├ hcbgp:DomAf  This object holds per address family bgp vrf information    ├ hcbgp: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.    ├ hcbgp: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.    ├ hcbgp:VpnCtrlP  This object holds policy to control vpn af information for a given vrf      ├ hcbgp:RtP  Route policy holds all route targets and route controls        ├ 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.        ├ hcbgp:RttEntry  List of route targets  ├ hcbgp:Peer  This object holds bgp information pertaining to a peer    ├ fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.    ├ hcbgp:LocalAsn  This object holds local AS information pertaining to a peer    ├ hcbgp:PeerAf  This object holds per address family bgp peer information      ├ hcbgp:RtCtrlP  Route control policy for routes coming/going to peers. There are few ways to apply this policy, controlling through route maps or prefix lists. If both are specified, the order is implicit. Prefix lists are applied before route maps. The direction specifies whether to apply this policy in the incoming or outgoing direction        ├ 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.    ├ hcbgp:PeerIntervals  This object holds configured peer timers information    ├ hcbgp:PeerOper       ├ 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)    ├ hcbgp:RsBgpPeerTohcl3RoutedIf       ├ 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      ├ 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)      ├ tag:Annotation       ├ tag:Tag     ├ hcbgp:RsBgpPeerTohctunnIf       ├ 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      ├ 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)      ├ tag:Annotation       ├ tag:Tag     ├ hcbgp:RsBgpPeerTolbRoutedIf       ├ 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      ├ 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)      ├ tag:Annotation       ├ tag:Tag     ├ health:Inst A base class for a health score instance.(Switch only)  ├ 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:CpDom A control plane domain abstraction. This object represents a domain within a control plane instance. For example, a VRF.        ├ nw:ProtDom A protocol domain abstraction.          ├ l3:ProtDom A layer 3 protocol domain abstraction.            ├ hcbgp:Dom  This objects hold per bgp domain (vrf) information

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.

holdIntvl

Type: hcbgp:HoldIntvl
Primitive Type: scalar:Uint16

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

The period of time before declaring that the neighbor is down.

kaIntvl

Type: hcbgp:KaIntvl
Primitive Type: scalar:Uint16

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

The period of time between the transmission of keepalive signals.

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.

maxAsLimit

Type: hcbgp:MaxAsLimit
Primitive Type: scalar:Uint16

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

Maximum AS limit, to discard routes that have excessive AS numbers

modTs

Type: mo:TStamp
Primitive Type: scalar:Date

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

The time when this object was last modified.

name

Type: naming:Name
Primitive Type: string:Basic

Overrides:nw:CpDom:name  |  nw:Conn:name

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

The name of the object.

numEstPeers

Type: hcbgp:NumPeers
Primitive Type: scalar:Uint32

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

Number of Established Peers

numPeers

Type: hcbgp:NumPeers
Primitive Type: scalar:Uint32

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

Number of Peers

operSt

Type: hcbgp:DomOperSt
Primitive Type: scalar:Enum8

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

The runtime state of the object or policy.

rd

Type: base:Community

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

The BGP domain route distinguisher.

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.

rtrId

Type: ip:RtrId
Primitive Type: address:IPv4

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

The BGP router ID.

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.

type

Type: hcbgp:DomType
Primitive Type: scalar:Enum8

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

The specific type of the object or component.