Class vm:Instance (CONCRETE)

Class ID:622
Encrypted: false - Exportable: false - Persistent: true
Privileges: [admin, read-only]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.131.7

Abstraction of a vitual machine instance.


Naming Rules
RN FORMAT: vm-[uuid]

    [1] PREFIX=vm- PROPERTY = uuid




DN FORMAT: 

[0] vmm/vm-[uuid]

                



Containers Hierarchies
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
vm:Ep root of vm instance hierarchy.
 
 ├
vm:Instance


Contained Hierarchy
vm:Instance
 ├
vm:Adaptor Network-centric abstraction of VM adaptor exposed to the guest OS.

Inheritance
naming:NamedObject
 ├
policy:Object
 
 ├
policy:Definition
 
 
 ├
compute:Container
 
 
 
 ├
compute:Logical Logical specification Abstraction of compute item. Serves as a superclass of logical compute items s.a partitions (LPAR, VPAR etc.)
 
 
 
 
 ├
compute:VirtualContainer
 
 
 
 
 
 ├
compute:Virtual Virtual compute. (e.g. LPAR, VPAR)
 
 
 
 
 
 
 ├
vm:ClientContainer Compute resource centric abstraction of a compute container which requests vnics. TODO: The dvsName and dvsDn need to be removed.
 
 
 
 
 
 
 
 ├
vm:Virtual Superclass for vm:Hv & vm:Instance.
 
 
 
 
 
 
 
 
 ├
vm:Instance

Events
                



Faults
                



Fsms
                



Properties Summary
Defined in: vm:Instance
scalar:Uint64 fltAggr  (vm:Instance:fltAggr)
           NO COMMENTS
reference:Object hvDn  (vm:Instance:hvDn)
           Reference to the HyperVisor
bios:Uuid
          address:UUID
hvUuid  (vm:Instance:hvUuid)
           NO COMMENTS
bios:Uuid
          address:UUID
uuid  (vm:Instance:uuid)
           Overrides:compute:Container:uuid
           NO COMMENTS
Defined in: vm:Virtual
vm:HvType
          scalar:Enum8
hvType  (vm:Virtual:hvType)
           Type, whether esx, kvm or hyper-v
Defined in: vm:ClientContainer
vm:InstType
          scalar:Enum8
clInstType  (vm:ClientContainer:clInstType)
           NO COMMENTS
reference:Object dvsDn  (vm:ClientContainer:dvsDn)
           NO COMMENTS
naming:Name
          string:Basic
dvsName  (vm:ClientContainer:dvsName)
           NO COMMENTS
os:OsType
          scalar:Enum8
model  (vm:ClientContainer:model)
           NO COMMENTS
naming:Name
          string:Basic
name  (vm:ClientContainer:name)
           Overrides:policy:Object:name | naming:NamedObject:name
           Keeping the name non-editable
scalar:Date statusChangeTs  (vm:ClientContainer:statusChangeTs)
           NO COMMENTS
vm:Status
          scalar:Enum8
vStatus  (vm:ClientContainer:vStatus)
           NO COMMENTS
vm:OsHvVendor
          scalar:Enum8
vendor  (vm:ClientContainer:vendor)
           NO COMMENTS
Defined in: compute:VirtualContainer
reference:Object lsDn  (compute:VirtualContainer:lsDn)
           Distinguished name refrence to the corresponding profile. This property points to currently assigned logical compute resource.
Defined in: compute:Logical
reference:Object pnDn  (compute:Logical:pnDn)
           Distinguished name refrence to the corresponding compute resource. This property points to currently assigned compute resource. Does not apply to templates.
Defined in: policy:Definition
naming:Descr
          string:Basic
descr  (policy:Definition:descr)
           NO COMMENTS
policy:InternalId
          scalar:Uint32
intId  (policy:Definition:intId)
           NO COMMENTS
scalar:Uint32 policyLevel  (policy:Definition:policyLevel)
           policyLevel is used internally by generic policy server.
policy:PolicyOwner
          scalar:Enum8
policyOwner  (policy:Definition:policyOwner)
           "local" denotes policy created by local policy client, "policy" denotes a policy created by remote policy server.
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

clInstType

Type: vm:InstType
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
vm 0 NO COMMENTS
hv 1 NO COMMENTS
compute-ep 2 NO COMMENTS
DEFAULT vm(0) NO COMMENTS

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: "256"
        Allowed Chars:
            Regex: [a-zA-Z0-9\[\]!#$%()*+,-./:;@ _{|}˜?&]+
Comments:
NO COMMENTS

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" />

dvsDn

Type: reference:Object
Refers: vm:Switch
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS

dvsName

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

fltAggr

Type: scalar:Uint64
Units: null
Encrypted: false
Access: oper
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS

hvDn

Type: reference:Object
Refers: vm:Hv
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
Reference to the HyperVisor

hvType

Type: vm:HvType
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
Type, whether esx, kvm or hyper-v
Constants
unspecified 0 NO COMMENTS
esx 1 NO COMMENTS
kvm 2 NO COMMENTS
hyperv 3 NO COMMENTS
xen 4 NO COMMENTS
DEFAULT esx(1) NO COMMENTS

hvUuid

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

intId

Type: policy:InternalId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
none 0u NO COMMENTS
DEFAULT none(0u) NO COMMENTS

lsDn

Type: reference:Object
Refers: ls:Server
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
Distinguished name refrence to the corresponding profile. This property points to currently assigned logical compute resource.

model

Type: os:OsType
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
unspecified 0 NO COMMENTS
PnuOS 1 NO COMMENTS
Linux 2 NO COMMENTS
Windows 3 NO COMMENTS
Solaris 4 NO COMMENTS
VMWareESX 5 NO COMMENTS
DEFAULT unspecified(0) NO COMMENTS

name

Type: naming:Name
Primitive Type: string:Basic
Overrides:policy:Object:name  |  naming:NamedObject:name
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
Comments:
Keeping the name non-editable

pnDn

Type: reference:Object
Refers: compute:Physical
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
Distinguished name refrence to the corresponding compute resource. This property points to currently assigned compute resource. Does not apply to templates.

policyLevel

Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
policyLevel is used internally by generic policy server.

policyOwner

Type: policy:PolicyOwner
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
"local" denotes policy created by local policy client, "policy" denotes a policy created by remote policy server.
Constants
local 0 NO COMMENTS
policy 1 NO COMMENTS
pending-policy 2 NO COMMENTS
DEFAULT local(0) NO COMMENTS

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

uuid

Type: bios:Uuid
Primitive Type: address:UUID
Overrides:compute:Container:uuid
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
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

vendor

Type: vm:OsHvVendor
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
unspecified 0 NO COMMENTS
vmware 1 NO COMMENTS
redhat 2 NO COMMENTS
microsoft 3 NO COMMENTS
novell 4 NO COMMENTS
oracle 5 NO COMMENTS
citrix 6 NO COMMENTS
DEFAULT unspecified(0) NO COMMENTS