Class comp:Entity (ABSTRACT)

Class ID:1264
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: 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 based class representing a compute entity.

Naming Rules


DN FORMAT: 

                


Diagram

Super Mo: naming:NamedIdentifiedObject,
Sub Mos: comp:AEpPD, comp:ClusterInfo, comp:ClusterSubnet, comp:ContE, comp:ContGrp, comp:Ctrlr, comp:DelCont, comp:DelInfo, comp:Deployment, comp:EDMgrProxy, comp:Element, comp:EpPConn, comp:FaultyExtPolCont, comp:FaultyExtPolRef, comp:HvHealthDef, comp:HvNicCont, comp:Inst, comp:Label, comp:LastEventInfo, comp:LastEventInfoList, comp:Locale, comp:LsNodeRef, comp:ManagedNic, comp:MigratingVm, comp:MigratingVmCont, comp:NameIdentEntity, comp:Namespace, comp:NetworkPolicy, comp:NodeCont, comp:Org, comp:OrgUnit, comp:PendDpVerify, comp:PendEp, comp:PendEpCont, comp:PendResEpCont, comp:ReplicaSet, comp:Service, comp:ServicePort, comp:TenantCont, hvs:ContE, hvs:HealthProvider, hvs:HvHealth, hvs:Node, hvs:UsegCont, hvs:UsegContE, opflex:PendIDEp, opflex:PendResIDEpCont, vmm:AEncapAllctr, vmm:AllocEncap,


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: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:IntCustomAggr 
 
 
 
 
 
 
 ├
[V] vmm:UsrAggr User configurable EPG Aggregator Object @@@ This is managed by PolicyMgr
 
 
 
 
 
 
 ├
[V] vmm:UsrCustomAggr 
 
 
 
 ├
[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:ClusterInfo 
 
 
 ├
[V] comp:ClusterSubnet 
 
 
 ├
[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:HealthPolCont  Health Provider MOs
 
 
 
 ├
[V] comp:HvClusterCont  HvCluster configuration MOs
 
 
 
 ├
[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:InjectedCont 
 
 
 
 ├
[V] vmm:VSwitchPolicyCont  VSwitch Policy Group. Container for the vswitch policies
 
 
 ├
[V] comp:ContGrp 
 
 
 ├
[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:Deployment 
 
 
 ├
[V] comp:EDMgrProxy 
 
 
 ├
[V] comp:Element An abstract base class representing a physical, virtual or logical compute element.
 
 
 
 ├
[V] comp:AHvHealth 
 
 
 
 
 ├
[V] comp:AveHealth 
 
 
 
 
 ├
[V] comp:AveHealthInst 
 
 
 
 
 ├
[V] comp:HvHealth 
 
 
 
 ├
[V] comp:ALabel 
 
 
 
 
 ├
[V] comp:LabelDef 
 
 
 
 
 ├
[V] comp:LabelVal 
 
 
 
 ├
[V] comp:Category  vSphere Tag Category
 
 
 
 ├
[V] comp:Categoryuse  vSphere Tag Category in use
 
 
 
 ├
[V] comp:Cdrom  CDrom obtained from VCenter
 
 
 
 ├
[V] comp:DataStore  DataStore obtained from VCenter
 
 
 
 ├
[V] comp:Folder  Folder
 
 
 
 ├
[V] comp:FolderDef  Folder
 
 
 
 ├
[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:VmFolder  This represents a folder of vms This Mo is deprecated Mo is now represented as comp:Folder under comp:VmFolderCont
 
 
 
 ├
[V] comp:HostResourcePool  Host resource pools under a compute Resource pool
 
 
 
 ├
[V] comp:HvCluster 
 
 
 
 ├
[V] comp:HvClusterDef 
 
 
 
 ├
[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] dot1x:Nic 
 
 
 
 
 ├
[V] poe:Nic 
 
 
 
 ├
[V] comp:ResourcePool  ResourcePool obtained from VCenter
 
 
 
 ├
[V] comp:SvmNicInfo 
 
 
 
 ├
[V] comp:Tag  vSphere Tag
 
 
 
 ├
[V] comp:Taguse  vSphere Tag in use
 
 
 
 ├
[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] comp:HvHealthDef 
 
 
 ├
[V] comp:HvNicCont  HvNic Container
 
 
 ├
[V] comp:Inst  L4-L7 device in the controller
 
 
 ├
[V] comp:Label 
 
 
 ├
[V] comp:LastEventInfo  Holds info about Last Processed Event Key, TimeStamp and MapId
 
 
 ├
[V] comp:LastEventInfoList  Holds info about Last Processed Event Key, TimeStamp and MapId
 
 
 ├
[V] comp:Locale  Represents a fabric node
 
 
 ├
[V] comp:LsNodeRef 
 
 
 ├
[V] comp:ManagedNic 
 
 
 ├
[V] comp:MigratingVm  This is the Ep that is yet to be resolved/verified
 
 
 ├
[V] comp:MigratingVmCont  This is a container to hold Vms that is in the process of cross dataCenter migration within the same VCenter.
 
 
 ├
[V] comp:NameIdentEntity 
 
 
 
 ├
[V] comp:HvClusterRule  Cluster affinity rules, defining VM placement preference [VM Group] Must/Should [not] run on [Host Group]
 
 
 
 ├
[V] comp:HvClusterRuleDef 
 
 
 
 ├
[V] comp:HvGroup 
 
 
 
 ├
[V] comp:HvGroupDef 
 
 
 
 ├
[V] comp:VmGroup 
 
 
 ├
[V] comp:Namespace 
 
 
 ├
[V] comp:NetworkPolicy 
 
 
 ├
[V] comp:NodeCont  Node Container to hold fabric nodes
 
 
 ├
[V] comp:Org 
 
 
 ├
[V] comp:OrgUnit 
 
 
 ├
[V] comp:PendDpVerify  This is a container to hold Eps that need to be verified. We need to verify an Ep when the corresponding EpPConn Mo is deleted due to DELETE_NON_PRESENT.
 
 
 ├
[V] comp:PendEp  This is the Ep that is yet to be resolved/verified
 
 
 ├
[V] comp:PendEpCont  This is a container to hold MOs that need to be verified or resolved. This container contains compPendDpVerify and compPendResEpCont. compPendDpVerify contains compTenantCont, which contains compPendEp. compPendResEpCont contains compPendEp.
 
 
 ├
[V] comp:PendResEpCont  This is a container to hold MOs that need to be resolved.
 
 
 ├
[V] comp:ReplicaSet 
 
 
 ├
[V] comp:Service 
 
 
 ├
[V] comp:ServicePort 
 
 
 ├
[V] comp:TenantCont  This is a container to hold Eps which belong to the same tenant, that need to be verified.
 
 
 ├
[V] hvs:ContE 
 
 
 
 ├
[V] hvs:MbrCont  Container for member MAC/IP
 
 
 
 ├
[V] hvs:MbrMac  Controller Member MAC
 
 
 ├
[V] hvs:HealthProvider  Health Provider MOs
 
 
 ├
[V] hvs:HvHealth 
 
 
 ├
[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] opflex:PendIDEp  This is the IDEp that is yet to be resolved
 
 
 ├
[V] opflex:PendResIDEpCont  This is a container to hold IDEp MO's that have a pending delete
 
 
 ├
[V] vmm:AEncapAllctr  Encap Allocator under vmm Domain
 
 
 
 ├
[V] vmm:EncapAllctr 
 
 
 ├
[V] vmm:AllocEncap  Allocated Encap value


Events
                


Faults
                


Fsms
                


Properties Summary
Defined in: comp:Entity
naming:Descr
          string:Basic
descr  (comp:Entity:descr)
           Additional descriptive information about the object.
naming:Id
          scalar:Uint64
id  (comp:Entity:id)
           Overrides:naming:NamedIdentifiedObject:id
           ID
comp:Issues
          scalar:Bitmask64
issues  (comp:Entity:issues)
           General Issues It captures various issues happened to the Entity.
naming:Name
          string:Basic
name  (comp:Entity:name)
           Overrides:naming:NamedObject:name
           Name
Defined in: naming:NamedObject
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





descr

Type: naming:Descr
Primitive Type: string:Basic

Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "128"
        Allowed Chars:
            Regex: [a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]+
    Comments:
Additional descriptive information about the object.



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

Overrides:naming:NamedIdentifiedObject:id
Units: null Encrypted: false Access: implicit Category: TopLevelRegular
    Comments:
ID



issues

Type: comp:Issues
Primitive Type: scalar:Bitmask64

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
General Issues It captures various issues happened to the Entity.
Constants
none 0x0ull None NO COMMENTS
tagging-cat-fault 0x10000ull Failed to retrieve all Tag Category information NO COMMENTS
ds-update-fault 0x1000ull Failed to update DS(Data Store) property NO COMMENTS
hv-miss-vmknic-fault 0x100ull ESX Host does not have any vmknic NO COMMENTS
vnic-miss-epg-fault 0x10ull VNIC is attached to an invalid DVS Port Group or unable to communicate with vCenter NO COMMENTS
lnode-property-fault 0x1ull Failed to get DVS property NO COMMENTS
prep-iso-file-fault 0x20000ull Failed to prepare or push iso file for service vm deployment. Please check if correct datastore is selected in policy. NO COMMENTS
rp-update-fault 0x2000ull Failed to update RP(Resource Pool) property NO COMMENTS
mgmtnic-miss-dvs-fault 0x200ull VMK Nic is configured with invalid DVS NO COMMENTS
hpnic-miss-epg-fault 0x20ull HpNIC is attached to an invalid uplink DVS Port Group NO COMMENTS
hv-update-fault 0x2ull Failed to update Hv(ESX Host) property NO COMMENTS
vmfolder-update-fault 0x40000ull Failed to update VM(Virtual Machine) Folder property NO COMMENTS
opflex-channels-down-ave 0x4000ull Both the opflex channels are down for AVE. Please check the connections on the host. NO COMMENTS
hv-miss-pnic-fault 0x400ull ESX Host does not have any pnic NO COMMENTS
hv-miss-dvs-fault 0x40ull ESX Host is configured with invalid DVS NO COMMENTS
vm-update-fault 0x4ull Failed to update VM(Virtual Machine) property NO COMMENTS
tagging-tag-fault 0x8000ull Failed to retrieve all Tag information NO COMMENTS
vm-deploy-task-fault 0x800ull deployVm task failed on vcenter NO COMMENTS
hv-disconnect-fault 0x80ull ESX Host is disconnected or not responding NO COMMENTS
vm-miss-hv-fault 0x8ull VM is attached to an invalid Hv(ESX Host) NO COMMENTS
DEFAULT none(0x0ull) None NO COMMENTS





name

Type: naming:Name
Primitive Type: string:Basic

Overrides:naming:NamedObject:name
Units: null Encrypted: false Access: implicit Category: TopLevelRegular
    Comments:
Name



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.