Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class comp:Host (ABSTRACT)

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

An abstraction of a compute host. The host can be a physical or hypervisor system.

Naming Rules 


DN FORMAT:


Diagram

Super Mo: comp:Element,
Sub Mos: comp:PHost, comp:Vm,
Contained Mos: comp:LabelVal,


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:Element An abstract base class representing a physical, virtual or logical compute element.
 
 		 
 		 
 		 ├
 		[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.


Events


Faults


Fsms


Properties Summary
Defined in: comp:Host
string:Basic os  (comp:Host:os)
          
comp:HostState
          scalar:Enum8 		state  (comp:Host:state)
           null
comp:HostInstType
          scalar:Enum8 		type  (comp:Host:type)
           null
Defined in: comp:Element
comp:Guid
          string:Basic 		guid  (comp:Element:guid)
           Globally Unique Identifier (GUID)
comp:Oid
          string:Basic 		oid  (comp:Element:oid)
           OID
comp:Uuid
          string:Basic 		uuid  (comp:Element:uuid)
           The endpoint UUID.
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.


guid

Type: comp:Guid
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Globally Unique Identifier (GUID)


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-tag-fault 0x1000ull Failed to retrieve all Tag information 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 NO COMMENTS
lnode-property-fault 0x1ull Failed to get DVS property NO COMMENTS
tagging-cat-fault 0x2000ull Failed to retrieve all Tag Category information 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
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
opflex-channels-down-ave 0x800ull Both the opflex channels are down for AVE. Please check the connections on the host. 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


oid

Type: comp:Oid
Primitive Type: string:Basic

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


os

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    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.


state

Type: comp:HostState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
null
Constants
maintenance 0 Maintenance Mode NO COMMENTS
connected 1 Connected NO COMMENTS
noresponse 2 Not Responding NO COMMENTS
disconnected 3 Disconnected NO COMMENTS
poweredOn 4 Powered On NO COMMENTS
poweredOff 5 Powered Off NO COMMENTS
standBy 6 StandBy NO COMMENTS
suspended 7 Suspended NO COMMENTS
unknown 8 Unknown NO COMMENTS
maintReq 9 Maintenance Required NO COMMENTS
DEFAULT disconnected(3) Disconnected NO COMMENTS




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.





type

Type: comp:HostInstType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
null
Constants
unknown 0 Unknown NO COMMENTS
phys 1 Baremetal Host NO COMMENTS
virt 2 Virtual Machine NO COMMENTS
hv 3 Hypervisor Host NO COMMENTS
vmk 4 Hypervisor Kernel NO COMMENTS
ave-ctrl 5 AVE NO COMMENTS
DEFAULT unknown(0) Unknown NO COMMENTS




uuid

Type: comp:Uuid
Primitive Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The endpoint UUID.




Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail