Overview  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail  Naming 

Class storage:VirtualDriveRef (CONCRETE)

Class ID:1989
Encrypted: false - Exportable: true - Persistent: true
Privileges: [admin, ls-compute, ls-config, ls-server, ls-storage]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.120.66

This is a concrete subclass to reference a local deployed LUN (storage:VirtualDrive).

Naming Rules 
RN FORMAT: vdrive-ref-[lunItemName]

    [1] PREFIX=vdrive-ref- PROPERTY = lunItemName




DN FORMAT: 

[0] org-[name]/tier-[name]/ls-[name]/vdrive-ref-[lunItemName]

[1] org-[name]/ls-[name]/vdrive-ref-[lunItemName]


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.
 ├
 		org:Org
 
 		 ├
 		ls:Server Logical Server Definition. Holds and Regulates Specification of: identity connectivity applied to the physical compute node like compute:Blade upon association. Logical Server can serve the following purposes: associatable instance initialization template persistent ...
 
 		 
 		 ├
 		storage:VirtualDriveRef
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
 		org:Org
 
 		 ├
 		ls:Tier Tier
 
 		 
 		 ├
 		ls:Server Logical Server Definition. Holds and Regulates Specification of: identity connectivity applied to the physical compute node like compute:Blade upon association. Logical Server can serve the following purposes: associatable instance initialization template persistent ...
 
 		 
 		 
 		 ├
 		storage:VirtualDriveRef


Contained Hierarchy
storage:VirtualDriveRef
 ├
 		lstorage:DiskGroupConfigDef
 
 		 ├
 		lstorage:DiskGroupQualifier Qualifies the disk group based on certain criteria. The number of drives is a mandatory qualifier
 
 		 ├
 		lstorage:LocalDiskConfigRef Refenence to local disk in DiskGroupQualifier.
 
 		 ├
 		lstorage:VirtualDriveDef Virtual Drive Def
 ├
 		storage:LunResourceSelectionLog Auto disk selection log
Inheritance
storage:ALunRefBase ALunInstRefBase is used for a service profile to reference a local/remote deployed LUN. We can define concrete subclasses for local/remote LUN ref, respectively.
 ├
 		storage:VirtualDriveRef
Events


Faults


Fsms


Properties Summary
Defined in: storage:VirtualDriveRef
naming:Name
          string:Basic 		adminName  (storage:VirtualDriveRef:adminName)
           Overrides:storage:ALunRefBase:adminName
           NO COMMENTS
lstorage:AdminState
          scalar:Enum8 		adminState  (storage:VirtualDriveRef:adminState)
           Overrides:storage:ALunRefBase:adminState
           NO COMMENTS
storage:ConfigState
          scalar:Enum8 		configState  (storage:VirtualDriveRef:configState)
           The config state of virtual drive if deployed, otherwise value of not-applied
scalar:Uint16 diskSelectionOrder  (storage:VirtualDriveRef:diskSelectionOrder)
           decision order
scalar:Date diskSelectionTs  (storage:VirtualDriveRef:diskSelectionTs)
           The following props: diskSelectionTs and diskSelectionOrder are used as debug/helper information for auto-disk-selection lun configuration. These two props indicate the order and time for each lun being processed duing each config transaction. For example, you might have local luns with the following values: 1) ts=1:30:00, order=1 2) ts=1:30:00, order=2 3) ts=1:35:00, order=1 4) ts=1:35:00, order=2 This should be interpreted as being ordered 1, 2, 3, 4. decision timestamp
lstorage:BootDevice
          scalar:Enum8 		isBootable  (storage:VirtualDriveRef:isBootable)
           If the virtual drive is bootable or not
reference:Object lunDn  (storage:VirtualDriveRef:lunDn)
           Overrides:storage:ALunRefBase:lunDn
           NO COMMENTS
naming:Name
          string:Basic 		lunItemName  (storage:VirtualDriveRef:lunItemName)
           Overrides:storage:ALunRefBase:lunItemName
           NO COMMENTS
naming:Name
          string:Basic 		lunName  (storage:VirtualDriveRef:lunName)
           Deploy name which is either generated by DasScsiLn name or from user manual input.
lstorage:Order
          scalar:Uint16 		order  (storage:VirtualDriveRef:order)
           The order of appearance of virtual drive
storage:LunType
          scalar:Enum8 		raidLevel  (storage:VirtualDriveRef:raidLevel)
           NO COMMENTS
storage:Size
          scalar:Uint64 		size  (storage:VirtualDriveRef:size)
           The virtual drive size if deployed, otherwise lun config size
address:UUID uuid  (storage:VirtualDriveRef:uuid)
           LUN universally unique identifier, which is used to identify a SCSI LUN across multiple initiators.
address:UUID vendorUuid  (storage:VirtualDriveRef:vendorUuid)
           LUN universally unique identifier, as assigned by the vendor
Defined in: storage:ALunRefBase
reference:Object lunItemDn  (storage:ALunRefBase:lunItemDn)
           This property references a lstorage:ScsiLun MO defined in storage profile.
equipment:SlotId
          scalar:Uint32 		lunSetDiskSlotId  (storage:ALunRefBase:lunSetDiskSlotId)
           NO COMMENTS
reference:Object refLunSet  (storage:ALunRefBase:refLunSet)
           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

adminName

Type: naming:Name
Primitive Type: string:Basic
Overrides:storage:ALunRefBase:adminName
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "10"

Comments:
NO COMMENTS

adminState

Type: lstorage:AdminState
Primitive Type: scalar:Enum8
Overrides:storage:ALunRefBase:adminState
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
online 1 "online" means the storage item should be configured in the storage sub-system and can be used by the storage initiator. By default, the storage item is automatically configured when the service profile is associated.
offline 2 NO COMMENTS
undeployed 4 Specify the storage item should be configured immediately, even if the service profile is not associated. This value is used to pre-deploy storage items.

When the XML API user sets the value to "deploy", the system triggers an FSM to configure the LUN and then sets the value to "online".
It is not always possible to pre-deploy storage items. For example, local LUNs cannot be configured before service profile association. Specify the storage item should be undeployed. This is used for instance ref's. This allows the user to configure certain properties of the instance ref prior to deployment. It also allows the user to release a deployed LUN

DEFAULT online(1) "online" means the storage item should be configured in the storage sub-system and can be used by the storage initiator. By default, the storage item is automatically configured when the service profile is associated.

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

configState

Type: storage:ConfigState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
The config state of virtual drive if deployed, otherwise value of not-applied
Constants
not-applied 0 NO COMMENTS
applying 1 NO COMMENTS
applied 2 NO COMMENTS
apply-failed 3 NO COMMENTS
orphaned 4 NO COMMENTS
not-in-use 5 NO COMMENTS
N/A 6 NO COMMENTS
unknown 7 NO COMMENTS
DEFAULT not-applied(0) NO COMMENTS

diskSelectionOrder

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

Comments:
decision order

diskSelectionTs

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

Comments:
The following props: diskSelectionTs and diskSelectionOrder are used as debug/helper information for auto-disk-selection lun configuration. These two props indicate the order and time for each lun being processed duing each config transaction. For example, you might have local luns with the following values: 1) ts=1:30:00, order=1 2) ts=1:30:00, order=2 3) ts=1:35:00, order=1 4) ts=1:35:00, order=2 This should be interpreted as being ordered 1, 2, 3, 4. decision timestamp

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

isBootable

Type: lstorage:BootDevice
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
If the virtual drive is bootable or not
Constants
disabled 0 Indicates the SCSI LUN is not configured as a boot device
enabled 1 Indicates the SCSI LUN has been configured as a boot device in the boot policy.
DEFAULT disabled(0) Indicates the SCSI LUN is not configured as a boot device

lunDn

Type: reference:Object
Refers: storage:VirtualDrive
Overrides:storage:ALunRefBase:lunDn
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS

lunItemDn

Type: reference:Object
Refers: lstorage:ScsiLun
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
This property references a lstorage:ScsiLun MO defined in storage profile.

lunItemName

Type: naming:Name
Primitive Type: string:Basic
Overrides:storage:ALunRefBase:lunItemName
Units: null
Encrypted: false
Naming Property -- [NAMING RULES]
Access: naming
Category: TopLevelRegular
Property Validators:
    Range:  min: "1"  max: "32"

Comments:
NO COMMENTS

lunName

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

Comments:
Deploy name which is either generated by DasScsiLn name or from user manual input.

lunSetDiskSlotId

Type: equipment:SlotId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)1l  max: (long)60l

Comments:
NO COMMENTS
Constants
defaultValue 1u NO COMMENTS

order

Type: lstorage:Order
Primitive Type: scalar:Uint16
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: 0  max: 64

Comments:
The order of appearance of virtual drive
Constants
not-applicable 0 NO COMMENTS
DEFAULT not-applicable(0) NO COMMENTS

raidLevel

Type: storage:LunType
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
NO COMMENTS
Constants
unspecified 0 NO COMMENTS
simple 1 NO COMMENTS
mirror 2 NO COMMENTS
stripe 3 NO COMMENTS
raid 4 NO COMMENTS
stripe-parity 5 NO COMMENTS
stripe-dual-parity 6 NO COMMENTS
mirror-stripe 7 NO COMMENTS
stripe-parity-stripe 8 NO COMMENTS
stripe-dual-parity-stripe 9 NO COMMENTS
DEFAULT unspecified(0) NO COMMENTS

refLunSet

Type: reference:Object
Refers: lstorage:LunSetConfig
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
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

size

Type: storage:Size
Primitive Type: scalar:Uint64
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
The virtual drive size if deployed, otherwise lun config size

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.

uuid

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

Comments:
LUN universally unique identifier, which is used to identify a SCSI LUN across multiple initiators.

vendorUuid

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

Comments:
LUN universally unique identifier, as assigned by the vendor
Overview  Containers  Contained  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail  Naming