Class naming:NamedIdentifiedObject (ABSTRACT)

Class ID:34
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled
Write Access: []
Read Access: []
Creatable/Deletable: derived (see Container Mos for details)
Possible Semantic Scopes: EPG, Infra, Fabric,
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

An abstract base class for an object that contains a name and ID.

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: naming:NamedObject,
Sub Mos: comp:APvlanP, comp:Entity, comp:PvlanCont, comp:TagCont, fv:NwEp, fv:VNode, hvs:PvlanCont, hvs:VSpanSession, hvs:VSpanSessionCont, hvs:VSpanSessionSrc, opflex:ACliCmd, opflex:AFaultConfig, opflex:AODevCmd, opflex:EpCPDefRef, opflex:EpCPDevInfo, opflex:EpPDIDEpRef, opflex:EppDevInfo, opflex:IDEpCntr, opflex:IDEpEncapRef, opflex:IDEpEpPDRef, opflex:IDEpRef, opflex:ODev, opflex:ODevCap, opflex:ODevCliCmdCont, opflex:ODevCliCmdReq, opflex:ODevCliCmdResp, opflex:ODevCliCmdSession, opflex:ODevRef, opflex:ONic, opflex:OPNic, opflex:OVm, opflex:Subject, opflex:VtepRef, orchs:Entity, synthetic:ATestObj, synthetic:AnotherTestObj, synthetic:FrameworkTest, synthetic:HierarchyObj, synthetic:Object, synthetic:TestBigObj, synthetic:TestObj, testinfralab:Cont, testinfralab:SnackP,


Inheritance
[V] naming:NamedObject An abstract base class for an object that contains a name.
 ├
[V] naming:NamedIdentifiedObject An abstract base class for an object that contains a name and ID.
 
 ├
[V] comp:APvlanP 
 
 
 ├
[V] comp:PvlanEntry  PVLAN Entry (primary, secondary)
 
 
 ├
[V] hvs:PvlanEntry  PVLAN Entry (primary,secondary)
 
 ├
[V] comp:Entity An abstract based class representing a compute entity.
 
 
 ├
[V] comp:AEpPD An abstraction for the endpoint group policy description. This object is generated and used only by internal process.
 
 
 
 ├
[V] comp:AAppEpPD The abstraction of an endpoint group policy description. This is an internal object used by the system.
 
 
 
 
 ├
[V] comp:EpPD An abstraction for the endpoint group policy description. This object is generated and used only by internal process.
 
 
 
 
 ├
[V] vmm:AEpPD  Abstract class representing VMM EpPD
 
 
 
 
 
 ├
[V] vmm:EpPD An endpoint group in the VMM context. This object translates to port groups and/or virtual wires in vCenter and vShield.
 
 
 
 
 
 ├
[V] vmm:EpgAggr EPG Aggregator Object @@@ This is managed by PolicyMgr
 
 
 
 
 
 
 ├
[V] vmm:IntAggr Internal EPG Aggregator Object @@@ This is managed by PolicyMgr
 
 
 
 
 
 
 ├
[V] vmm:UsrAggr User configurable EPG Aggregator Object @@@ This is managed by PolicyMgr
 
 
 
 ├
[V] infra:AEpPD An abstraction of an endpoint group in an infrastructure context. This object translates to port groups and/or virtual wires in vCenter and vShield.
 
 
 
 
 ├
[V] infra:EpPD The endpoint group policy descriptor for infrastructure policies. For example, endpoint groups under tenant infra. This object is generated and used only by internal processes.
 
 
 
 
 ├
[V] infra:EpPDDef The endpoint group policy descriptor for infrastructure policies. For example, endpoint groups under tenant infra. This object is generated and used only by internal processes.
 
 
 ├
[V] comp:ContE An abstract class for compute related policy objects. This object is generated and used only by internal process.
 
 
 
 ├
[V] comp:CtrctCont 
 
 
 
 ├
[V] comp:Dom An abstract base class for a VM management system domain.
 
 
 
 ├
[V] comp:EpCP 
 
 
 
 ├
[V] comp:PolCont An abstraction of the container for various policies. This object is generated and used only by internal process.
 
 
 
 ├
[V] comp:Prov The VM provider inventory is the inventory of a VM provider such as VMware or Microsoft. The VM provider profile policies determine the VM inventory that is collected.
 
 
 
 ├
[V] comp:RFltP 
 
 
 
 ├
[V] comp:ToEPg 
 
 
 
 ├
[V] comp:Uni The top level class for all compute related objects.
 
 
 
 ├
[V] vmm:AccGrpCont A container for capturing all access group policies.
 
 
 
 ├
[V] vmm:AttEntityPCont A container for capturing all access groups.
 
 
 
 ├
[V] vmm:VSwitchPolicyCont  VSwitch Policy Group. Container for the vswitch policies
 
 
 ├
[V] comp:Ctrlr The operational state of the VM management system controller such as a VMware vCenter, VMware vShield, or Microsoft SCVMM.
 
 
 ├
[V] comp:DelCont 
 
 
 ├
[V] comp:DelInfo 
 
 
 ├
[V] comp:Element An abstract base class representing a physical, virtual or logical compute element.
 
 
 
 ├
[V] comp:ALabel 
 
 
 
 
 ├
[V] comp:LabelDef 
 
 
 
 
 ├
[V] comp:LabelVal 
 
 
 
 ├
[V] comp:Category  vSphere Tag Category
 
 
 
 ├
[V] comp:Host An abstraction of a compute host. The host can be a physical or hypervisor system.
 
 
 
 
 ├
[V] comp:PHost An abstraction of a physical host.
 
 
 
 
 
 ├
[V] comp:Hv The compute hypervisor.
 
 
 
 
 
 ├
[V] comp:Phys A physical host or a compute server.
 
 
 
 
 ├
[V] comp:Vm A virtual machine.
 
 
 
 ├
[V] comp:Nic An abstraction of all the network interface cards (NIC) objects.
 
 
 
 
 ├
[V] comp:DNic A discovered network interface card or an endpoint. Note that this is an internal object.
 
 
 
 
 ├
[V] comp:MgmtNic An endpoint or NIC used for management connectivity on the host. For example, vmk interface of a VMware vCenter.
 
 
 
 
 ├
[V] comp:PNic An abstraction of physical network interface card object.
 
 
 
 
 
 ├
[V] comp:HpNic The physical interface information on the hypervisor.
 
 
 
 
 
 ├
[V] comp:PpNic A physical interface on the physical host.
 
 
 
 
 
 ├
[V] comp:VNic The virtual network interface on the VM.
 
 
 
 ├
[V] comp:Tag  vSphere Tag
 
 
 
 ├
[V] vmm:Ctxt This object is generated and used only by internal processes.
 
 
 
 ├
[V] vmm:EventRecord A config object that is not persisted and is used to send messages from a worker thread to a doer.
 
 
 
 ├
[V] vmm:Object The base class of VMM classes.
 
 
 ├
[V] comp:EpPConn An object representing the connection information of a VM endpoint. This is used internally by the system.
 
 
 ├
[V] comp:FaultyExtPolCont 
 
 
 ├
[V] comp:FaultyExtPolRef 
 
 
 ├
[V] hvs:ContE 
 
 
 
 ├
[V] hvs:MbrCont  Container for member MAC/IP
 
 
 
 ├
[V] hvs:MbrMac  Controller Member MAC
 
 
 ├
[V] hvs:Node The abstract class for the switch.
 
 
 
 ├
[V] hvs:LNode The logical node, which represents a virtual switch across hypervisors. For example, when implementing VMWare, this object represents VMware vSphere Distributed Switch (VDS ).
 
 
 
 ├
[V] hvs:VNode Virtual Node representing a switch inside a hypervisor. This corresponds to the Virtual Switch on a hypervisor.
 
 
 ├
[V] hvs:UsegCont  Container for useg entities
 
 
 ├
[V] hvs:UsegContE 
 
 
 
 ├
[V] hvs:IpSet  useg ipset
 
 
 
 ├
[V] hvs:MacSet  useg mac set
 
 
 
 ├
[V] hvs:Rule  useg distributed firewall rule
 
 
 
 ├
[V] hvs:SecGrp  useg security group
 
 
 
 ├
[V] hvs:Svc  useg service
 
 
 
 ├
[V] hvs:SvcGrp  useg service group
 
 
 ├
[V] vmm:AEncapAllctr  Encap Allocator under vmm Domain
 
 
 
 ├
[V] vmm:EncapAllctr 
 
 
 ├
[V] vmm:AllocEncap  Allocated Encap value
 
 ├
[V] comp:PvlanCont  PVLAN Entry Container
 
 ├
[V] comp:TagCont  vSphere Tag Container
 
 ├
[V] fv:NwEp Abstract super class.
 
 
 ├
[V] fv:ATp The attachable target point.
 
 
 
 ├
[V] fv:AStCEp The abstract static client endpoint.
 
 
 
 
 ├
[V] fv:StCEp The static endpoint represents a silent client attached to the fabric which will not produce traffic of its own. The configuration of a static endpoint will prevent the client from aging out of relevant addressing tables.
 
 
 
 
 ├
[V] fv:StCEpDef An internal object that represents a static endpoint.
 
 
 
 ├
[V] fv:Ep An endpoint.
 
 
 
 
 ├
[V] fv:AEpDef Abstract representation of an endpoint definition.
 
 
 
 
 
 ├
[V] fv:ATunDef The base class for an internal definition of a tunnel.
 
 
 
 
 
 
 ├
[V] fv:TunDef A tunnel definition.
 
 
 
 
 
 
 ├
[V] fv:TunDefRef A tunnel on the node. This is an internal object.
 
 
 
 
 
 ├
[V] fv:EpDef An endpoint definition.
 
 
 
 
 
 ├
[V] fv:EpDefRef An internal reference to endpoint definitions.
 
 
 
 
 ├
[V] fv:CEp A client endpoint attaching to the network.
 
 
 
 
 ├
[V] fv:DEp A dynamically-learned endpoint on the switch.
 
 
 
 
 ├
[V] fv:PEp Represents a provider endpoint attaching to the network. An example is a DHCP server that receives client requests from the fabric.
 
 
 
 
 
 ├
[V] infra:APEp A base class representing a provider endpoint.
 
 
 
 
 
 
 ├
[V] dhcp:PEp The provider infrastructure endpoint.
 
 
 
 
 ├
[V] fv:VDEp A virtual datacenter endpoint.
 
 
 
 
 ├
[V] fvtopo:Ep The endpoint.
 
 
 
 
 ├
[V] infra:ACEp Client Endpoint represents a client endpoint attaching to the network.
 
 
 
 
 
 ├
[V] dhcp:CEp The client infrastructure endpoint.
 
 
 
 
 ├
[V] opflex:IDEp This is generated and used only by internal processes.
 
 
 
 
 ├
[V] span:ACEpDef 
 
 
 
 
 
 ├
[V] span:CEpDef The VSPAN Cisco endpoint definition.
 
 
 
 
 
 ├
[V] span:CEpDefRef 
 
 ├
[V] fv:VNode An opflex-capable virtual node that is connected to the fabric.
 
 ├
[V] hvs:PvlanCont  PVLAN Entry Container
 
 ├
[V] hvs:VSpanSession Vspan session representing a span session.
 
 ├
[V] hvs:VSpanSessionCont The Vspan session container.
 
 ├
[V] hvs:VSpanSessionSrc The Vspan session source.
 
 ├
[V] opflex:ACliCmd 
 
 
 ├
[V] opflex:CliCmdReq  Concrete class definitions CliCmdReq
 
 
 ├
[V] opflex:CliCmdResp  Concrete class definitions CliCmdResp
 
 ├
[V] opflex:AFaultConfig 
 
 
 ├
[V] opflex:AVleafFaultConfig 
 
 
 
 ├
[V] opflex:AVleafFaultInfo 
 
 
 
 
 ├
[V] opflex:IDEpFaultInfo 
 
 
 
 
 ├
[V] opflex:ODevFaultInfo 
 
 
 
 ├
[V] opflex:VleafFaultConfig  Concrete class definitions
 
 ├
[V] opflex:AODevCmd This is generated and used only by internal processes.
 
 
 ├
[V] opflex:ODevCmdReq This is generated and used only by internal processes.
 
 
 ├
[V] opflex:ODevCmdResp This is generated and used only by internal processes.
 
 ├
[V] opflex:EpCPDefRef  EpCPDefRef
 
 ├
[V] opflex:EpCPDevInfo 
 
 ├
[V] opflex:EpPDIDEpRef  EpPD IDEp ref represents a implicit inband end point ref for the EpPD. This object is owned by the opflex element
 
 ├
[V] opflex:EppDevInfo This is generated and used only by internal processes.
 
 ├
[V] opflex:IDEpCntr This is generated and used only by internal processes.
 
 ├
[V] opflex:IDEpEncapRef  IDEp Encap ref represents a inband learned end point ref encap on the switch. This object is owned by the opflex element
 
 ├
[V] opflex:IDEpEpPDRef  EpPD ref under the IDEp
 
 ├
[V] opflex:IDEpRef  IDEp ref represents a inband learned end point ref on the switch. This object is owned by the opflex element
 
 ├
[V] opflex:ODev This is generated and used only by internal processes.
 
 ├
[V] opflex:ODevCap This is generated and used only by internal processes.
 
 ├
[V] opflex:ODevCliCmdCont 
 
 ├
[V] opflex:ODevCliCmdReq 
 
 ├
[V] opflex:ODevCliCmdResp 
 
 ├
[V] opflex:ODevCliCmdSession 
 
 ├
[V] opflex:ODevRef  ODev ref represents a refernce to opflex device connected to the switch. This object is owned by the opflex element
 
 ├
[V] opflex:ONic 
 
 ├
[V] opflex:OPNic 
 
 ├
[V] opflex:OVm 
 
 ├
[V] opflex:Subject This is generated and used only by internal processes.
 
 ├
[V] opflex:VtepRef  Vtep ref represents a reference to opflex idep corr. to the vtep connected to the switch. This object is owned by the opflex element
 
 ├
[V] orchs:Entity 
 
 
 ├
[V] orchs:Element  orchs element is an instance of orchestration object that is either instanciated/in-scope or purely hypothetical.
 
 
 
 ├
[V] orchs:Config  This is used to store orchestration specific properties like Microsoft Azure Pack
 
 
 
 ├
[V] orchs:LDevVipAttr 
 
 
 
 ├
[V] orchs:LDevVipCfg  This is used to store orchestration specific properties like Microsoft Azure Pack
 
 
 
 ├
[V] orchs:LdevCont 
 
 
 
 ├
[V] orchs:SvcAlloc 
 
 
 
 ├
[V] orchs:SvcRsrcPool  This is used to store orchestration specific properties like Microsoft Azure Pack
 
 
 
 ├
[V] orchs:SvcsEncap 
 
 
 
 ├
[V] orchs:SvcsIp 
 
 ├
[V] synthetic:ATestObj 
 
 
 ├
[V] synthetic:CTestObj 
 
 
 
 ├
[V] synthetic:IfcCTestObj 
 
 
 
 ├
[V] synthetic:SwCTestObj 
 
 
 ├
[V] synthetic:TLTestObj 
 
 
 
 ├
[V] synthetic:IfcTLTestObj 
 
 
 
 ├
[V] synthetic:SwTLTestObj 
 
 ├
[V] synthetic:AnotherTestObj 
 
 ├
[V] synthetic:FrameworkTest 
 
 ├
[V] synthetic:HierarchyObj 
 
 ├
[V] synthetic:Object 
 
 
 ├
[V] synthetic:AContext 
 
 
 
 ├
[V] synthetic:Context 
 
 
 
 ├
[V] synthetic:Context2 
 
 
 ├
[V] synthetic:Ep 
 
 
 ├
[V] synthetic:EpGroup 
 
 
 ├
[V] synthetic:PropFilterTest 
 
 
 ├
[V] synthetic:RelETest 
 
 
 ├
[V] synthetic:RelNTest 
 
 
 ├
[V] synthetic:RelUnenfTest 
 
 ├
[V] synthetic:TestBigObj 
 
 ├
[V] synthetic:TestObj 
 
 ├
[V] testinfralab:Cont 
 
 ├
[V] testinfralab:SnackP 


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: naming:NamedIdentifiedObject
naming:Id
          scalar:Uint64
id  (naming:NamedIdentifiedObject:id)
           An identifier .
Defined in: naming:NamedObject
naming:Name
          string:Basic
name  (naming:NamedObject:name)
           The name of the object.
naming:NameAlias
          string:Basic
nameAlias  (naming:NamedObject:nameAlias)
           NO COMMENTS
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.



id

Type: naming:Id
Primitive Type: scalar:Uint64

Like: naming:Identified:id
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Comments:
An identifier .



name

Type: naming:Name
Primitive Type: string:Basic

Like: naming:Named:name
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
    Comments:
The name of the object.



nameAlias

Type: naming:NameAlias
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "63"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.-]+
    Comments:
NO COMMENTS



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.