Class nw:CpDom (ABSTRACT)

Class ID:3570
Class Label: Control Plane Domain
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: [admin]
Creatable/Deletable: no (see Container Mos for details)
Possible Semantic Scopes: Infra, Fabric,
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

A control plane domain abstraction. This object represents a domain within a control plane instance. For example, a VRF.

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: nw:GEp,
Sub Mos: aib:Dom, bfd:Af, bgp:Af, bgp:EviBase, configprofile:Entity, eigrp:Af, hcbgp:Af, isis:Af, isis:Lvl, nw:ProtDom, rib:Dom, segrt:Af, vpc:Dom,


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] aib:Dom The Virtual Routing and Forwarding (VRF).
 
 
 
 ├
[V] bfd:Af  Bfd abstraction for address family domain
 
 
 
 
 ├
[V] bfd:IfAf  This object holds per address family bfd interface information
 
 
 
 
 ├
[V] bfd:InstAf  This objects hold per address family bfd instance information
 
 
 
 
 ├
[V] bfd:MhIfAf  This object holds per address family bfd interface information
 
 
 
 ├
[V] bgp:Af A BGP abstraction for an address family domain.
 
 
 
 
 ├
[V] bgp:DomAf The BGP (VRF) address family information.
 
 
 
 
 ├
[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: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] bgp:VpnCtrlP  This object holds policy to control vpn af information for a given vrf
 
 
 
 ├
[V] bgp:EviBase  This object holds Base Ethernet VPN instance information
 
 
 
 
 ├
[V] bgp:EncapEviBase  This object contains information for an Ethernet VPN instance that is defined for an encap
 
 
 
 
 
 ├
[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:DomEvi  This object holds Domain Ethernet VPN instance information
 
 
 
 
 ├
[V] bgp:EncapGroupEvi  This object holds EncapGroup Ethernet VPN instance information which carries routes for a Group of Encaps
 
 
 
 
 ├
[V] bgp:Vni  This object holds VNI information for multi-site routes
 
 
 
 ├
[V] configprofile:Entity  Domain (vrf) information
 
 
 
 ├
[V] eigrp:Af The EIGRP abstraction for an address family domain.
 
 
 
 
 ├
[V] eigrp:DomAf The EIGRP address family domain (VRF) information.
 
 
 
 
 ├
[V] eigrp:IfAf The address family interface.
 
 
 
 ├
[V] hcbgp:Af  Bgp abstraction for address family domain
 
 
 
 
 ├
[V] hcbgp:DomAf  This object holds per address family bgp vrf information
 
 
 
 
 ├
[V] hcbgp:PeerAf  This object holds per address family bgp peer information
 
 
 
 
 ├
[V] hcbgp:VpnCtrlP  This object holds policy to control vpn af information for a given vrf
 
 
 
 ├
[V] isis:Af The IS-IS abstraction for address family domain.
 
 
 
 
 ├
[V] isis:DomAf Per address family IS-IS VRF information.
 
 
 
 ├
[V] isis:Lvl The IS-IS abstraction for the level.
 
 
 
 
 ├
[V] isis:DomLvl The IS-IS Domain level VRF information.
 
 
 
 
 ├
[V] isis:IfLvl The IS-IS interface level properties. These properties control how the IS-IS protocol operates. For example, you can configure the interval for sending the Hello and CSNP packets.
 
 
 
 ├
[V] nw:ProtDom A protocol domain abstraction.
 
 
 
 
 ├
[V] arp:BD  This object holds arp information that is operated at a interface level
 
 
 
 
 ├
[V] glean:BD Layer 2 domain (BD) information for this glean.
 
 
 
 
 ├
[V] igmp:ExtDom  This objects hold per igmp external domain information
 
 
 
 
 ├
[V] ipmcsnoop:Dom  This objects hold per IP Multicast Snooping domain information
 
 
 
 
 
 ├
[V] igmpsnoop:Dom An IGMP snooping domain, which is a bridge domain (BD) in which IGMP snooping is enabled. When an IGMP querier is in the network, it sends periodic IGMP queries that trigger IGMP report messages from hosts that want to receive IP multicast traffic. IGMP snooping listens to these IGMP reports to establish appropriate forwarding
 
 
 
 
 
 ├
[V] mldsnoop:Dom  This objects hold per mld snooping domain information
 
 
 
 
 ├
[V] l2:ProtDom A protocol domain abstraction.
 
 
 
 
 
 ├
[V] stp:Dom A container for spanning-tree protocol domain information.
 
 
 
 
 
 
 ├
[V] stp:MstDom A multiple spanning tree instance.
 
 
 
 
 
 ├
[V] stp:Region A container for multiple spanning-tree or MSTP domain information.
 
 
 
 
 ├
[V] l3:ProtDom A layer 3 protocol domain abstraction.
 
 
 
 
 
 ├
[V] arp:Dom Represents ARP domain (VRF) information.
 
 
 
 
 
 ├
[V] bgp:Dom The object that represents all the BGP domain (VRF) information.
 
 
 
 
 
 ├
[V] cloudsec:Dom  Cloudsec Enabled Domain (infra vrf) Information
 
 
 
 
 
 ├
[V] coop:Dom Per COOP domain (vrf) information.
 
 
 
 
 
 ├
[V] eigrp:Dom The EIGRP domain (VRF) information.
 
 
 
 
 
 ├
[V] fabrgm:Dom  This objects hold per fabrgm domain information
 
 
 
 
 
 ├
[V] glean:Dom Domain (VRF) information for this glean.
 
 
 
 
 
 ├
[V] hcbgp:Dom  This objects hold per bgp domain (vrf) information
 
 
 
 
 
 ├
[V] hcospf:AArea  This object holds ospf information that is operated at the area level
 
 
 
 
 
 
 ├
[V] hcospf:Area  This object holds ospf information that is operated at a interface level
 
 
 
 
 
 ├
[V] hcospf:ADom  This objects hold per ospf domain (vrf) information
 
 
 
 
 
 
 ├
[V] hcospf:Dom  This objects hold per ospf domain (vrf) information
 
 
 
 
 
 ├
[V] hcurib:Dom  This objects hold per bgp domain (vrf) information
 
 
 
 
 
 ├
[V] hsrp:Dom  This object holds per hsrp domain (vrf) information
 
 
 
 
 
 ├
[V] icmp:Dom The per ICMP layer3 domain information.
 
 
 
 
 
 
 ├
[V] icmpv4:Dom Per Internet Control Message Protocol (ICMPv4) layer3 domain (vrf) information.
 
 
 
 
 
 ├
[V] ip:Dom The domain (vrf) information.
 
 
 
 
 
 
 ├
[V] ipv4:Dom The domain (VRF) information.
 
 
 
 
 
 
 ├
[V] ipv6:Dom The domain (VRF) information.
 
 
 
 
 
 ├
[V] ipmc:ADom  This objects hold per IP Multicast domain (VRF) information
 
 
 
 
 
 
 ├
[V] igmp:Dom  This objects hold per igmp domain information
 
 
 
 
 
 
 ├
[V] mld:Dom  This objects hold per mld domain information
 
 
 
 
 
 ├
[V] isis:Dom The IS-IS domain (vrf) information.
 
 
 
 
 
 ├
[V] mrib:Dom  This objects hold per pim domain (vrf) information
 
 
 
 
 
 ├
[V] nd:Dom A neighbor discovery protocol domain.
 
 
 
 
 
 ├
[V] ospf:AArea An abstraction of the OSPF information that is operated on at a interface level.
 
 
 
 
 
 
 ├
[V] ospf:Area The OSPF information that operates at an interface level.
 
 
 
 
 
 
 ├
[V] ospfv3:Area The OSPF information that is operated at an interface level.
 
 
 
 
 
 ├
[V] ospf:ADom An abstraction of an OSPF domain (VRF).
 
 
 
 
 
 
 ├
[V] ospf:Dom The per OSPF domain (vrf) information.
 
 
 
 
 
 
 ├
[V] ospfv3:Dom The OSPF domain (VRF) information.
 
 
 
 
 
 ├
[V] ospf:Af A BGP abstraction for an address family domain.
 
 
 
 
 
 
 ├
[V] ospfv3:AreaAf The per address family OSPFv3 area information.
 
 
 
 
 
 
 ├
[V] ospfv3:DomAf The OSPF address family domain (VRF) information.
 
 
 
 
 
 ├
[V] rtdmc:ADom  This objects hold per routed multicast domain (vrf) information
 
 
 
 
 
 
 ├
[V] pim6:Dom  This objects hold per pim6 domain (vrf) information
 
 
 
 
 
 
 ├
[V] pim:Dom PIM domain (VRF) information.
 
 
 
 
 
 
 ├
[V] rtdmc:AInterVRF  This object holds policy for InterVRF multicast
 
 
 
 
 
 
 
 ├
[V] pim6:InterVRF  This object holds policy for Static RP Entry
 
 
 
 
 
 
 
 ├
[V] pim:InterVRF  This object holds policy for Static RP Entry
 
 
 
 
 
 ├
[V] segrt:Dom  This object holds per domain (vrf) information
 
 
 
 
 ├
[V] mld:ExtDom  This objects hold per mld external domain information
 
 
 
 
 ├
[V] nd:BD  This object holds nd information that is operated at a interface level
 
 
 
 ├
[V] rib:Dom The domain (VRF) information.
 
 
 
 
 ├
[V] uribv4:Dom The domain (VRF) information.
 
 
 
 
 ├
[V] uribv6:Dom  Domain (vrf) information
 
 
 
 ├
[V] segrt:Af  Segment-routing abstraction for address family
 
 
 
 
 ├
[V] segrt:DomAf  This object holds per address family Segment-routing information
 
 
 
 ├
[V] vpc:Dom The vPC domain information. There is only one configurable vPC domain that is in the system.


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: nw:CpDom
naming:Name
          string:Basic
name  (nw:CpDom:name)
           Overrides:nw:Conn:name
           The name of the object.
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32
childAction  (mo:TopProps:childAction)
           Delete or ignore. For internal use only.
reference:BinRef dn  (mo:TopProps:dn)
           A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
reference:BinRN rn  (mo:TopProps:rn)
           Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
mo:ModificationStatus
          scalar:Bitmask32
status  (mo:TopProps:status)
           The upgrade status. This property is for internal use only.
Properties Detail

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
    Comments:
Delete or ignore. For internal use only.
Constants
deleteAll 16384u deleteAll NO COMMENTS
ignore 4096u ignore NO COMMENTS
deleteNonPresent 8192u deleteNonPresent NO COMMENTS
DEFAULT 0 --- This type is used to





dn

Type: reference:BinRef

Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
    Comments:
A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.



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.



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.