Class nw:CpEntity (ABSTRACT)

Class ID:3558
Class Label: Control Plane Entity
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: 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 ]

The control plane entity abstraction. This object represents a feature or protocol on the switch. For example, OSPF and VPC features.

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: nw:GEp,
Sub Mos: ac:Entity, actrl:Entity, aib:Entity, copp:Entity, dpp:Entity, eqptdiag:Entity, ethpm:Entity, fc:Entity, fcoe:Entity, fcpm:Entity, glean:Entity, im:Entity, l1:ProtEntity, l2:ProtEntity, l3:ProtEntity, l3vm:Entity, monitor:Entity, npv:Entity, nw:ProtEntity, pc:Entity, proc:Entity, proc:System, qosm:Entity, rib:Entity, rpm:Entity, satm:Entity, slowdrain:Entity, span:Acct, span:Entity, span:RetryCont, span:RetrySrc, span:RetryTarget, sts:Entity, svccopy:Entity, svcredir:Entity, syslog:Acct, sysmgr:Entity, vlanmgr:Entity, vpc:Entity, vsanmgr:Entity,


Inheritance
[V] nw:Item Ignore.
 ├
[V] nw:Conn A connection abstraction.
 
 ├
[V] nw:GEp A group endpoint abstraction.
 
 
 ├
[V] nw:CpEntity The control plane entity abstraction. This object represents a feature or protocol on the switch. For example, OSPF and VPC features.
 
 
 
 ├
[V] ac:Entity Holds entity information for the atomic counters control plane.
 
 
 
 ├
[V] actrl:Entity The ACTRL control plane entity information.
 
 
 
 ├
[V] aib:Entity This is a top-level placeholder for the Adjacency Information Base (AIB) attributes, if any.
 
 
 
 ├
[V] copp:Entity Represents control plane entity information.
 
 
 
 ├
[V] dpp:Entity  Holds dpp control plane entity information
 
 
 
 ├
[V] eqptdiag:Entity Diag-related entity information
 
 
 
 ├
[V] ethpm:Entity Entity
 
 
 
 ├
[V] fc:Entity  Holds Storage information
 
 
 
 ├
[V] fcoe:Entity  Holds Fcoe-mgr control plane entity information
 
 
 
 ├
[V] fcpm:Entity 
 
 
 
 ├
[V] glean:Entity Control plane entity information for this glean.
 
 
 
 ├
[V] im:Entity A stub to categorize the runtime states of the interface manager module.
 
 
 
 ├
[V] l1:ProtEntity A protocol entity abstraction.
 
 
 
 ├
[V] l2:ProtEntity A protocol entity abstraction.
 
 
 
 
 ├
[V] cdp:Entity Holds cdp control plane entity information
 
 
 
 
 ├
[V] dot1x:Entity  Holds dot1x control plane entity information
 
 
 
 
 ├
[V] lacp:Entity Holds lacp control plane entity information.
 
 
 
 
 ├
[V] lldp:Entity LLDP allows network devices to advertise information about themselves to other devices on the network. This protocol runs over the data-link layer, which allows two systems running different network layer protocols to learn about each other.
 
 
 
 
 ├
[V] macsec:Entity  Holds macsec control plane entity information
 
 
 
 
 ├
[V] mcp:Entity The MisCabling Protocol (MCP) entity information.
 
 
 
 
 ├
[V] poe:Entity  Holds Power over Ethernet control plane entity information
 
 
 
 
 ├
[V] stp:Entity The spanning-tree protocol control plane entity information.
 
 
 
 
 ├
[V] udld:Entity  Holds udld control plane entity information
 
 
 
 ├
[V] l3:ProtEntity A layer 3 protocol entity abstraction.
 
 
 
 
 ├
[V] arp:Entity Represents ARP control plane entity information.
 
 
 
 
 ├
[V] bfd:Entity  Holds bfd control plane entity information
 
 
 
 
 ├
[V] bgp:Entity The BGP control plane entity information.
 
 
 
 
 ├
[V] coop:Entity The COOP control plane entity information.
 
 
 
 
 ├
[V] dhcp:Entity Holds DHCP control plane entity information.
 
 
 
 
 ├
[V] dhcp:Provider The DHCP Server.
 
 
 
 
 ├
[V] dns:Entity The DNS control plane entity information
 
 
 
 
 ├
[V] eigrp:Entity The EIGRP control plane entity information.
 
 
 
 
 ├
[V] fabrgm:Entity  Holds fabric routed multicast group manager entity information
 
 
 
 
 ├
[V] fhs:Entity  Holds FHS control plane entity information
 
 
 
 
 ├
[V] hsrp:Entity  Holds HSRP control plane entity information
 
 
 
 
 ├
[V] icmp:Entity The ICMP control plane information.
 
 
 
 
 
 ├
[V] icmpv4:Entity Internet Control Message Protocol (ICMPv4) control plane entity information.
 
 
 
 
 ├
[V] icmpv6:Entity Per Internet Control Message Protocol (ICMPv6) control plane entity information.
 
 
 
 
 ├
[V] ip:Entity IP control plane entity information.
 
 
 
 
 ├
[V] ipmc:AEntity  Holds IP Multicast control plane entity information
 
 
 
 
 
 ├
[V] igmp:Entity  Holds igmp control plane entity information
 
 
 
 
 ├
[V] ipmcsnoop:Entity  Holds IP Multicast Snooping control plane entity information
 
 
 
 
 
 ├
[V] igmpsnoop:Entity Holds IGMP control plane entity information.
 
 
 
 
 
 ├
[V] mldsnoop:Entity  Holds mld control plane entity information
 
 
 
 
 ├
[V] ipsec:Entity  Holds IPSec entity information
 
 
 
 
 ├
[V] ipv4:Entity A container for IPV4 control plane entity information.
 
 
 
 
 ├
[V] ipv6:Entity The IPv6 entity information.
 
 
 
 
 ├
[V] isis:Entity IS-IS control plane entity information.
 
 
 
 
 ├
[V] mrib:Entity  Holds MRIB entity information
 
 
 
 
 ├
[V] nd:Entity The neighbor discovery protocol entity information.
 
 
 
 
 ├
[V] ospf:AEntity An abstraction of the OSPF control plane entity information.
 
 
 
 
 
 ├
[V] ospf:Entity The OSPF control plane entity information.
 
 
 
 
 
 ├
[V] ospfv3:Entity The OSPFV3 control plane entity information.
 
 
 
 
 ├
[V] ptp:Entity  Holds PTP entity information
 
 
 
 
 ├
[V] rtdmc:AEntity  Holds routed multicast control plane entity information
 
 
 
 
 
 ├
[V] pim:Entity PIM control plane entity information.
 
 
 
 
 ├
[V] snmp:Entity SNMP control plane entity information.
 
 
 
 ├
[V] l3vm:Entity A container for the L3VM entity information.
 
 
 
 ├
[V] monitor:Entity Span manager control plane entity information.
 
 
 
 ├
[V] npv:Entity  Holds NPV entity information
 
 
 
 ├
[V] nw:ProtEntity A protocol entity abstraction.
 
 
 
 ├
[V] pc:Entity 
 
 
 
 ├
[V] proc:Entity A container of processes in the system. This object holds detailed information about various processes running on the APIC.
 
 
 
 ├
[V] proc:System A container of processes in the system. This object holds detailed information about various processes running on the switch.
 
 
 
 ├
[V] qosm:Entity A policy container for QoS related entity information.
 
 
 
 ├
[V] rib:Entity A container for entity information.
 
 
 
 
 ├
[V] uribv4:Entity A container that holds entity information.
 
 
 
 
 ├
[V] uribv6:Entity  Entity information
 
 
 
 ├
[V] rpm:Entity A container for route processor module control plane entity information.
 
 
 
 ├
[V] satm:Entity The satellite manager entity information.
 
 
 
 ├
[V] slowdrain:Entity  Holds slowdrain control plane entity information
 
 
 
 ├
[V] span:Acct The SPAN global accounting information.
 
 
 
 ├
[V] span:Entity The SPAN manager control plane entity information.
 
 
 
 ├
[V] span:RetryCont Span retry information.
 
 
 
 ├
[V] span:RetrySrc The retry source information.
 
 
 
 ├
[V] span:RetryTarget The retry target information.
 
 
 
 ├
[V] sts:Entity 
 
 
 
 ├
[V] svccopy:Entity  Holds service control plane entity information
 
 
 
 ├
[V] svcredir:Entity  Holds service control plane entity information
 
 
 
 ├
[V] syslog:Acct 
 
 
 
 ├
[V] sysmgr:Entity Contains system manager control plane entity information.
 
 
 
 ├
[V] vlanmgr:Entity A container for VLAN manager entity information.
 
 
 
 ├
[V] vpc:Entity The vPC control plane entity information.
 
 
 
 ├
[V] vsanmgr:Entity  Holds Vsan-mgr control plane entity information


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: nw:CpEntity
nw:AdminSt
          scalar:Enum8
adminSt  (nw:CpEntity:adminSt)
           The administrative state of the object or policy.
naming:Name
          string:Basic
name  (nw:CpEntity:name)
           Overrides:nw:Conn:name
           The name of the object.
nw:OperErrQual
          scalar:Bitmask64
operErr  (nw:CpEntity:operErr)
          
nw:EntOperSt
          scalar:Enum8
operSt  (nw:CpEntity:operSt)
           The runtime state of the object or policy.
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

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





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



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
int-err 8ull Internal error Internal errors
DEFAULT 0 --- Operational error qualifier





operSt

Type: nw:EntOperSt
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
    Comments:
The runtime state of the object or policy.
Constants
unknown 0 unknown Entity state unknown
enabled 1 enabled Entity enabled
disabled 2 disabled Entity disabled
initializing 3 initializing Entity initializing
failed 4 failed Entity enable failed
DEFAULT enabled(1) enabled Entity enabled





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.