Overview  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail 

Class storage:ALunRefBase (ABSTRACT)

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

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.

Naming Rules 


DN FORMAT: 

[0] org-[name]/tier-[name]/ls-[name]/

[1] org-[name]/ls-[name]/


Inheritance
storage:ALunRefBase
 ├
 		storage:VirtualDriveRef This is a concrete subclass to reference a local deployed LUN (storage:VirtualDrive).
Events


Faults


Fsms


Properties Summary
Defined in: storage:ALunRefBase
naming:Name
          string:Basic 		adminName  (storage:ALunRefBase:adminName)
           The user's desired name of the LUN. When the adminName is different than the lunName, this indicates that the LUN should be renamed.
lstorage:AdminState
          scalar:Enum8 		adminState  (storage:ALunRefBase:adminState)
           The admin state of the instance ref. The adminstate can be set to undeployed to release the LUN and can be set to online to deploy it
reference:Object lunDn  (storage:ALunRefBase:lunDn)
           This property references a local/remote deployed LUN.
reference:Object lunItemDn  (storage:ALunRefBase:lunItemDn)
           This property references a lstorage:ScsiLun MO defined in storage profile.
naming:Name
          string:Basic 		lunItemName  (storage:ALunRefBase:lunItemName)
           This is the name of LUN item 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
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "15"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+

Comments:
The user's desired name of the LUN. When the adminName is different than the lunName, this indicates that the LUN should be renamed.

adminState

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

Comments:
The admin state of the instance ref. The adminstate can be set to undeployed to release the LUN and can be set to online to deploy it
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 "offline" means the storage item should be put in an offline mode where it is no longer accessible from the initiator. This can be used for maintenance purpose. When the item is "offline". the data is not discarded and can be accessed immediately after setting the storage item back to "online".
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

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

lunDn

Type: reference:Object
Refers: storage:ALun
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:

Comments:
This property references a local/remote deployed LUN.

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
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: "1"  max: "32"

Comments:
This is the name of LUN item defined in storage profile.

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

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

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.

Overview  Inheritance  Events  Faults  FSMs  Properties Summary  Properties Detail