Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class hvs:Node (ABSTRACT)

Class ID:99
Encrypted: false - Exportable: true - Persistent: true - Configurable: true - Subject to Quota: Disabled - Abstraction Layer: Concrete Model - APIC NX Processing: Disabled
Write Access: [admin]
Read Access: [admin]
Creatable/Deletable: derived (see Container Mos for details)
Semantic Scope: Infra
Semantic Scope Evaluation Rule: Subclasses
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: false, HasStats: false, HasFaults: false, HasHealth: false, HasEventRules: false ]

The abstract class for the switch.

Naming Rules 


DN FORMAT:


Diagram

Super Mo: comp:Entity,
Sub Mos: hvs:LNode, hvs:VNode,


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] 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.


Events


Faults


Fsms


Properties Summary
Defined in: hvs:Node
string:Basic configVersion  (hvs:Node:configVersion)
           null
naming:Descr
          string:Basic 		descr  (hvs:Node:descr)
           Overrides:comp:Entity:descr
           Additional descriptive information about the object.
comp:Guid
          string:Basic 		guid  (hvs:Node:guid)
           null
naming:Id
          scalar:Uint64 		id  (hvs:Node:id)
           Overrides:comp:Entity:id | naming:NamedIdentifiedObject:id
           null
hvs:ManagedState
          scalar:Enum8 		managedSt  (hvs:Node:managedSt)
          
comp:Oid
          string:Basic 		oid  (hvs:Node:oid)
           null
hvs:NodeType
          scalar:Enum8 		type  (hvs:Node:type)
           null
Defined in: comp:Entity
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




configVersion

Type: string:Basic

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


descr

Type: naming:Descr
Primitive Type: string:Basic

Overrides:comp:Entity:descr

Paths: 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:
null


id

Type: naming:Id
Primitive Type: scalar:Uint64

Overrides:comp:Entity:id  |  naming:NamedIdentifiedObject:id

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


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




managedSt

Type: hvs:ManagedState
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
Constants
unmanaged 0 unmanaged NO COMMENTS
managed 1 managed NO COMMENTS
DEFAULT unmanaged(0) unmanaged 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:
null


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.





type

Type: hvs:NodeType
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
null
Constants
virtual 1 virtual NO COMMENTS
logical 2 logical NO COMMENTS
DEFAULT virtual(1) virtual NO COMMENTS






Overview  Diagram  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail