Class hvs:LNode (CONCRETE)

Class ID:103
Class Label: Distributed Virtual Switch
Encrypted: false - Exportable: false - Persistent: true - Configurable: false - Subject to Quota: Disabled
Write Access: [NON CONFIGURABLE]
Read Access: [admin, vmm-connectivity]
Creatable/Deletable: yes (see Container Mos for details)
Semantic Scope: Infra
Semantic Scope Evaluation Rule: Parent
Monitoring Policy Source: Parent
Monitoring Flags : [ IsObservable: true, HasStats: false, HasFaults: true, HasHealth: true, HasEventRules: false ]

The logical node, which represents a virtual switch across hypervisors. For example, when implementing VMWare, this object represents VMware vSphere Distributed Switch (VDS ).

Naming Rules
RN FORMAT: sw-{oid}

    [1] PREFIX=sw- PROPERTY = oid




DN FORMAT: 

[0] comp/prov-{name}/ctrlr-{[domName]}-{name}/sw-{oid}

                


Diagram

Super Mo: hvs:Node,
Container Mos: comp:Ctrlr (deletable:yes),
Contained Mos: hvs:ExtPol, hvs:PvlanCont, hvs:VSpanSessionCont,
Relations From: fv:VNode,
Relations: hvs:RtLNode,


Containers Hierarchies
[V] top:Root  This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
[V] comp:Uni The top level class for all compute related objects.
 
 ├
[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:Ctrlr The operational state of the VM management system controller such as a VMware vCenter, VMware vShield, or Microsoft SCVMM.
 
 
 
 ├
[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 ).


Contained Hierarchy
[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] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] hvs:ExtPol The extended policies, which are common policies for VM interfaces. For example, when implementing VMware, this represents the distributed virtual port group.
 
 ├
[V] comp:EpPConn An object representing the connection information of a VM endpoint. This is used internally by the system.
 
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[V] comp:PrimaryEncapDef 
 
 
 ├
[V] comp:EpPConn An object representing the connection information of a VM endpoint. This is used internally by the system.
 
 
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 
 
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 
 ├
[V] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 ├
[V] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 ├
[V] fvns:EncapBlkDef The encapsulation block definition.
 
 
 ├
[V] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[V] hvs:Encap Contains the encap and multicast address of the ExtPol. If this child encap exists, the ExtPol uses this encap or the encap properties of the ExtPol.
 
 
 ├
[V] fault:Delegate Exposes internal faults to the user. A fault delegate object can be defined on IFC (for example, for an endpoint group) and when the fault is raised (for example, under an endpoint policy on a switch), a fault delegate object is created on IFC under the specified object. A fault delegate object follows the lifecycle of the original fault instance object, being created, modified, or deleted based on the changes of the original fault.
 
 ├
[V] hvs:ResCont 
 
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 
 
 ├
[V] res:Consumer This is generated and used only by internal processes.
 
 
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 
 
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 
 ├
[V] hvs:RsEpPD A source relation to the abstraction for the endpoint group policy description.
 
 ├
[V] hvs:RsExtPol A source relation to the common policies for the interfaces on VMs.
 
 ├
[V] hvs:RsPvlan 
 
 ├
[V] hvs:RsPvlan2 
 
 ├
[V] hvs:RtDlPol A target relation to the extended policies for the interfaces on VMs.
 
 ├
[V] hvs:RtExtPol A target relation to the extended policies for the interfaces on VMs.
 
 ├
[V] hvs:RtMgmtPol A target relation to the extended policies for the interfaces on VMs.
 
 ├
[V] hvs:RtUlPol A target relation to the extended policies for the interfaces on VMs.
 
 ├
[V] res:Consumer This is generated and used only by internal processes.
 
 
 ├
[V] fault:Counts An immutable object that provides the number of critical, major, minor, and warning faults raised on its parent object and its subtree.
 
 
 ├
[V] fault:Inst Contains detailed information of a fault. This object is attached as a child of the object on which the fault condition occurred. One instance object is created for each fault condition of the parent object. A fault instance object is identified by a fault code.
 
 
 ├
[V] health:Inst A base class for a health score instance.(Switch only)
 ├
[V] hvs:PvlanCont  PVLAN Entry Container
 
 ├
[V] hvs:PvlanEntry  PVLAN Entry (primary,secondary)
 
 
 ├
[V] hvs:RsPvlanEntry 
 
 
 ├
[V] hvs:RtPvlan 
 
 
 ├
[V] hvs:RtPvlan2 
 ├
[V] hvs:RtLNode A target relation to the logical node.
 ├
[V] hvs:VSpanSessionCont The Vspan session container.
 
 ├
[V] hvs:VSpanSession Vspan session representing a span session.
 
 
 ├
[V] hvs:VSpanSessionSrc The Vspan session source.


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


Events
                


Faults
                hvs:LNode:operationalIssues


Fsms
                


Properties Summary
Defined in: hvs:LNode
vmm:AFlowTimeOutT
          scalar:Uint32
activeFlowTimeOut  (hvs:LNode:activeFlowTimeOut)
           vmm netflow attributes
string:Basic exporterDstAddr  (hvs:LNode:exporterDstAddr)
           vmm netflow exporter attributes
scalar:Uint32 exporterDstPort  (hvs:LNode:exporterDstPort)
           NO COMMENTS
string:Basic exporterSrcAddr  (hvs:LNode:exporterSrcAddr)
           NO COMMENTS
vmm:IFlowTimeOutT
          scalar:Uint32
idleFlowTimeOut  (hvs:LNode:idleFlowTimeOut)
           NO COMMENTS
scalar:Bool lacpEnable  (hvs:LNode:lacpEnable)
           The LACP operational status on the logical node.
string:Basic lacpMode  (hvs:LNode:lacpMode)
           The LACP operational mode on the logical node.
string:Basic ldpConfigOperation  (hvs:LNode:ldpConfigOperation)
           The link discovery protocol configuration operation status.
string:Basic ldpConfigProtocol  (hvs:LNode:ldpConfigProtocol)
           The link discovery protocol configuration protocol type.
scalar:Uint32 maxMtu  (hvs:LNode:maxMtu)
           The maximum MTU for the logical node.
vmm:Mode
          scalar:Enum8
mode  (hvs:LNode:mode)
           mode of operation
reference:BinRef monPolDn  (hvs:LNode:monPolDn)
          
comp:Oid
          string:Basic
oid  (hvs:LNode:oid)
           Overrides:hvs:Node:oid
           null
vmm:SamplingRateT
          scalar:Uint32
samplingRate  (hvs:LNode:samplingRate)
           NO COMMENTS
hvs:NodeType
          scalar:Enum8
type  (hvs:LNode:type)
           Overrides:hvs:Node:type
           The type of the logical node.
string:Basic vendorConfig  (hvs:LNode:vendorConfig)
           vendor config
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)
          
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.
Defined in: mo:Resolvable
mo:Owner
          scalar:Enum8
lcOwn  (mo:Resolvable:lcOwn)
           A value that indicates how this object was created. For internal use only.
Defined in: mo:Modifiable
mo:TStamp
          scalar:Date
modTs  (mo:Modifiable:modTs)
           The time when this object was last modified.
Properties Detail

activeFlowTimeOut

Type: vmm:AFlowTimeOutT
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
vmm netflow attributes
Constants
defaultValue 60u --- NO COMMENTS





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



exporterDstAddr

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
vmm netflow exporter attributes



exporterDstPort

Type: scalar:Uint32

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



exporterSrcAddr

Type: string:Basic

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



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



idleFlowTimeOut

Type: vmm:IFlowTimeOutT
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
defaultValue 15u --- NO COMMENTS





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





lacpEnable

Type: scalar:Bool

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The LACP operational status on the logical node.
Constants
no false --- NO COMMENTS
yes true --- NO COMMENTS
DEFAULT no(false) --- NO COMMENTS





lacpMode

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The LACP operational mode on the logical node.



lcOwn

Type: mo:Owner
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
A value that indicates how this object was created. For internal use only.
Constants
local 0 Local NO COMMENTS
policy 1 Policy NO COMMENTS
replica 2 Replica NO COMMENTS
resolveOnBehalf 3 ResolvedOnBehalf NO COMMENTS
implicit 4 Implicit NO COMMENTS
DEFAULT local(0) Local NO COMMENTS





ldpConfigOperation

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The link discovery protocol configuration operation status.



ldpConfigProtocol

Type: string:Basic

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The link discovery protocol configuration protocol type.



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





maxMtu

Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The maximum MTU for the logical node.



modTs

Type: mo:TStamp
Primitive Type: scalar:Date

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
The time when this object was last modified.
Constants
never 0ull never NO COMMENTS
DEFAULT never(0ull) never NO COMMENTS





mode

Type: vmm:Mode
Primitive Type: scalar:Enum8

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
mode of operation
Constants
default 0 Distributed Switch NO COMMENTS
n1kv 1 Cisco AVS NO COMMENTS
unknown 2 Unknown NO COMMENTS
ovs 3 Open vSwitch NO COMMENTS
k8s 4 Kubernetes NO COMMENTS
rhev 5 RHEV NO COMMENTS
cf 6 Cloud Foundry NO COMMENTS
openshift 7 OpenShift NO COMMENTS
DEFAULT default(0) Distributed Switch NO COMMENTS





monPolDn

Type: reference:BinRef

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



oid

Type: comp:Oid
Primitive Type: string:Basic

Overrides:hvs:Node:oid
Units: null Encrypted: false Naming Property -- [NAMING RULES] Access: naming 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.



samplingRate

Type: vmm:SamplingRateT
Primitive Type: scalar:Uint32

Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
    Comments:
NO COMMENTS
Constants
defaultValue 0u --- 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: hvs:NodeType
Primitive Type: scalar:Enum8

Overrides:hvs:Node:type
Units: null Encrypted: false Access: implicit Category: TopLevelRegular
    Comments:
The type of the logical node.
Constants
virtual 1 virtual NO COMMENTS
logical 2 logical NO COMMENTS
DEFAULT logical(2) logical NO COMMENTS





vendorConfig

Type: string:Basic

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