Overview  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class vm:Adaptor (ABSTRACT)

Class ID:623
Encrypted: false - Exportable: true - Persistent: true
Privileges: [admin]
SNMP OID:

Network-centric abstraction of VM adaptor exposed to the guest OS.

Naming Rules 


DN FORMAT: 

[0] vmm/computeEp-[uuid]/

[1] vmm/hv-[uuid]/

[2] vmm/vm-[uuid]/


Inheritance
naming:NamedObject
 ├
 		vnic:Connection
 
 		 ├
 		vm:Adaptor
 
 		 
 		 ├
 		vm:Hba Network-centric abstraction of vmhba
 
 		 
 		 ├
 		vm:Nic Network-centric abstraction of vmnic
Events


Faults


Fsms


Properties Summary
Defined in: vm:Adaptor
naming:Name
          string:Basic 		dvsGenPortId  (vm:Adaptor:dvsGenPortId)
           Generic DVS Port ID. Int32 does not work for KVM (mac) & Hyper-V (uuid)
scalar:Uint32 dvsPortId  (vm:Adaptor:dvsPortId)
           DVS Port ID
scalar:Uint32 dvsSwitchId  (vm:Adaptor:dvsSwitchId)
           DVS Switch ID
reference:Object hostIfDn  (vm:Adaptor:hostIfDn)
           reference to the virtual adaptor interface providing a pipe to corresponding DVS
naming:Name
          string:Basic 		name  (vm:Adaptor:name)
           Overrides:vnic:Connection:name | naming:NamedObject:name
           NO COMMENTS
vnic:Owner
          scalar:Enum8 		owner  (vm:Adaptor:owner)
           Overrides:vnic:Connection:owner
           NO COMMENTS
network:SwitchId
          scalar:Enum8 		phSwitchId  (vm:Adaptor:phSwitchId)
           Delete later Physical access switch ID
scalar:Uint32 profileId  (vm:Adaptor:profileId)
           Localized profile id as transmitted on the wire
naming:Name
          string:Basic 		profileName  (vm:Adaptor:profileName)
           Name of the profile applied to this vmadaptor.
scalar:Date statusChangeTs  (vm:Adaptor:statusChangeTs)
           NO COMMENTS
bios:Uuid
          address:UUID 		uuid  (vm:Adaptor:uuid)
           NO COMMENTS
vm:Status
          scalar:Enum8 		vStatus  (vm:Adaptor:vStatus)
           NO COMMENTS
reference:Object vcDn  (vm:Adaptor:vcDn)
           Delete later! reference to the virtual switch interface providing a pipe to corresponding DVS
dcx:VIFId
          scalar:Uint32 		vifId  (vm:Adaptor:vifId)
           Delete later! vif id assigned to the vnic on which this vmadaptor terminates
address:UUID vmndGuid  (vm:Adaptor:vmndGuid)
           NO COMMENTS
naming:Name
          string:Basic 		vmndName  (vm:Adaptor:vmndName)
           NO COMMENTS
reference:Object vnicDn  (vm:Adaptor:vnicDn)
           reference to the vnic object representing configuration of a pipe provided corresponding DVS
Defined in: vnic:Connection
network:SwitchId
          scalar:Enum8 		switchId  (vnic:Connection:switchId)
           NO COMMENTS
vnic:ConnectionType
          scalar:Enum8 		type  (vnic:Connection:type)
           NO COMMENTS
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32 		childAction  (mo:TopProps:childAction)
          
reference:Object dn  (mo:TopProps:dn)
           The Distinguished Name (dn) unambiguously identifies an object in the system.
The dn provides a fully qualified path from the top of the object tree, all the way to the object. It is built as a sequence of relative names separated by the "/" character.
For example:
< ... dn = "sys/chassis-5/blade-2/adaptor-1" />
reference:RN rn  (mo:TopProps:rn)
           The Relative Name (rn) uniquely identifies an object within a given context.
Note that a dn is comprised of a sequence of relative names. For example, the context "sys/chassis-1/blade-1/adaptor-1/host-eth-2" can be thought of as the following expression:
dn = <root object>/{rn}/{rn}/{rn}/{rn}/{rn}.
The rn can then be used to identify the object (for instance, "adaptor-1") within the context:
<... rn ="../" />
mo:InstSaclType
          scalar:Bitmask8 		sacl  (mo:TopProps:sacl)
           The system acl property for each Managed Object. br/> This property is a 8 bit mask and supports the following values :-
a: del
b: mod
c: addchild
d: cascade

By default all Managed Objects have the following permissions
a: del
b: mod
c: addchild
This property is persisted in the db. If this property has a value none
it means, the user has read only permissions on this object.
mo:ModificationStatus
          scalar:Bitmask32 		status  (mo:TopProps:status)
           This property controls the life cycle of a managed object
Properties Detail

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
Property Validators:

Comments:
Constants
deleteAll 16384u NO COMMENTS
ignore 4096u NO COMMENTS
deleteNonPresent 8192u NO COMMENTS
DEFAULT 0 This type is used to

dn

Type: reference:Object
Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
Property Validators:

Comments:
The Distinguished Name (dn) unambiguously identifies an object in the system.
The dn provides a fully qualified path from the top of the object tree, all the way to the object. It is built as a sequence of relative names separated by the "/" character.
For example:
< ... dn = "sys/chassis-5/blade-2/adaptor-1" />

dvsGenPortId

Type: naming:Name
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+

Comments:
Generic DVS Port ID. Int32 does not work for KVM (mac) & Hyper-V (uuid)

dvsPortId

Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
DVS Port ID

dvsSwitchId

Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
DVS Switch ID

hostIfDn

Type: reference:Object
Refers: adaptor:HostIf
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
reference to the virtual adaptor interface providing a pipe to corresponding DVS

name

Type: naming:Name
Primitive Type: string:Basic
Overrides:vnic:Connection:name  |  naming:NamedObject:name
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "31"

Comments:
NO COMMENTS

owner

Type: vnic:Owner
Primitive Type: scalar:Enum8
Overrides:vnic:Connection:owner
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
unknown 0 Unknown ownership.
physical 1 Owned by physical.
policy 2 Owned by a policy.
logical 4 Owned by logical.
initiator_policy 7 Owned by a iSCSI Initiator Autoconfig policy.
conn_policy 8 Owned by a LAN Connection policy.
DEFAULT policy(2) Owned by a policy.

phSwitchId

Type: network:SwitchId
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
Delete later Physical access switch ID
Constants
NONE 0 NO COMMENTS
A 1 NO COMMENTS
B 2 NO COMMENTS
DEFAULT A(1) NO COMMENTS

profileId

Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
Localized profile id as transmitted on the wire

profileName

Type: naming:Name
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+

Comments:
Name of the profile applied to this vmadaptor.

rn

Type: reference:RN
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
Property Validators:

Comments:
The Relative Name (rn) uniquely identifies an object within a given context.
Note that a dn is comprised of a sequence of relative names. For example, the context "sys/chassis-1/blade-1/adaptor-1/host-eth-2" can be thought of as the following expression:
dn = <root object>/{rn}/{rn}/{rn}/{rn}/{rn}.
The rn can then be used to identify the object (for instance, "adaptor-1") within the context:
<... rn ="../" />

sacl

Type: mo:InstSaclType
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelSacl
Property Validators:

Comments:
The system acl property for each Managed Object. br/> This property is a 8 bit mask and supports the following values :-
a: del
b: mod
c: addchild
d: cascade

By default all Managed Objects have the following permissions
a: del
b: mod
c: addchild
This property is persisted in the db. If this property has a value none
it means, the user has read only permissions on this object.
Constants
none 0 NO COMMENTS
del 1 NO COMMENTS
mod 2 NO COMMENTS
addchild 4 NO COMMENTS
cascade 8 NO COMMENTS
DEFAULT 0 NO COMMENTS

status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
Property Validators:

Comments:
This property controls the life cycle of a managed object
Constants
removed 16u In a setter method: specifies that an object should be removed.
In the return value of a setter method: indicates that an object has been removed.
created 2u 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 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 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.

statusChangeTs

Type: scalar:Date
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

switchId

Type: network:SwitchId
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
NONE 0 NO COMMENTS
A 1 NO COMMENTS
B 2 NO COMMENTS
DEFAULT A(1) NO COMMENTS

type

Type: vnic:ConnectionType
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
unknown 0 add fcoe
ether 1 NO COMMENTS
fc 4 NO COMMENTS
scsi 8 NO COMMENTS
ipc 16 NO COMMENTS
DEFAULT 0 NO COMMENTS

uuid

Type: bios:Uuid
Primitive Type: address:UUID
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

vStatus

Type: vm:Status
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
unknown 0 NO COMMENTS
online 1 NO COMMENTS
offline 2 NO COMMENTS
DEFAULT unknown(0) NO COMMENTS

vcDn

Type: reference:Object
Refers: dcx:Vc
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
Delete later! reference to the virtual switch interface providing a pipe to corresponding DVS

vifId

Type: dcx:VIFId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
Delete later! vif id assigned to the vnic on which this vmadaptor terminates

vmndGuid

Type: address:UUID
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

vmndName

Type: naming:Name
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+

Comments:
NO COMMENTS

vnicDn

Type: reference:Object
Refers: vnic:Vnic
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
reference to the vnic object representing configuration of a pipe provided corresponding DVS
Overview  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail