IBMTSSVC_StorageVolume

The IBMTSSVC_StorageVolume class represents a device that is presented by the cluster that can be mapped as a SCSI LUN to host systems on the SAN. A volume is formed by allocating a set of extents from a pool.

Properties

The IBMTSSVC_StorageVolume class extends the CIM_StorageVolume class and has the properties shown in Table 1.

Table 1. IBMTSSVC_StorageVolume properties
Property Type Qualifier Description
Access Uint16   Describes the media.
Code
Semantics
0
Unknown
1
Readable
2
Writeable
3
Read/Write Supported
4
Write Once
AccessGranted Boolean

ModelCorrespondence
(CIM_Controller.
AuthorizationView)

A quick interface to find devices with no AuthorizationSubject association to an AccessControl Information instance, either directly or by use of a controller. If set to true, the device has granted access to a consumer. If set to false, no access has been granted.

Additional
Availability

Uint16[]

Deprecated(CIM_Associated
PowerManagementService.
PowerState CIM_Managed
SystemElement.Operational
Status CIM_EnabledLogical
Element.EnabledState),
ModelCorrespondence
(CIM_LogicalDevice.
Availability)

Additional availability and status of the device, beyond that specified in the Availability property. The Availability property denotes the primary status and availability of the device. In some cases, it is not sufficient to denote the complete status of the device. In those cases, the AdditionalAvailability property can be used to provide further information.
Code
Semantics
1
Other
2
Unknown
3
Running/Full Power
4
Warning
5
In Test
6
Not Applicable
7
Power Off
8
Off Line
9
Off Duty
10
Degraded
11
Not Installed
12
Install Error
13
Power Save - Unknown
14
Power Save - Low Power Mode
15
Power Save - Standby
16
Power Cycle
17
Power Save - Warning
18
Paused
19
Not Ready
20
Not Configured
21
Quiesced
Availability Uint16

Deprecated(CIM_Associated
PowerManagement
Service.PowerState
CIM_ManagedSystem
Element.OperationalStatus
CIM_EnabledLogical
Element.EnabledStatus),
ModelCorrespondence
(CIM_LogicalDevice.
AdditionalAvailability)

The primary availability and status of the device.
Code
Semantics
1
Other
2
Unknown
3
Running/Full Power
4
Warning
5
In Test
6
Not Applicable
7
Power Off
8
Off Line
9
Off Duty
10
Degraded
11
Not Installed
12
Install Error
13
Power Save - Unknown
14
Power Save - Low Power Mode
15
Power Save - Standby
16
Power Cycle
17
Power Save - Warning
18
Paused
19
Not Ready
20
Not Configured
21
Quiesced
BackendVolumeID String Expensive(TRUE) The ID of the underlying BackendVolume. Only valid if Type=Image.

BackendVolume
Name

String Expensive(TRUE) The name of the underlying BackendVolume. Only valid if Type=Image.
BlockSize Uint64 Units(Bytes) The size in bytes of the blocks that form this StorageExtent. If the block size is variable, the maximum block size in bytes must be specified. If the block size is unknown or if a block concept is not valid (for example, for AggregateExtents, Memory, or LogicalDisks), enter a 1.
Caption String MaxLen(15), Write(TRUE), WriteRole(Administrator) A short textual description (one-line string) of the object.
CacheMode Uint16  
Code
Semantics
0
None
1
ReadWrite
CacheState Uint16 Expensive(TRUE) The cache state of the volume.
Code
Semantics
0
Empty
1
Not empty
2
Corrupt
ConsumableBlocks Uint64   The maximum number of blocks, of size BlockSize, that are available for consumption when layering StorageExtents using the BasedOn association. This property is used when this StorageExtent is an Antecedent reference in a BasedOn relationship. For example, a StorageExtent can be composed of 120 blocks. However, the extent itself can use 20 blocks for redundancy data. If another StorageExtent is BasedOn this extent, only 100 blocks are available to it. This information (100 blocks are available for consumption) is indicated in the ConsumableBlocks property.
Controlled Boolean   A quick interface to find devices with no ControlledBy associations to controllers. If set to true, the device is connected to one or more ports by use of controllers. If set to false, the device exists but is not connected to a port.

CreationClass
Name

String MaxLen(256) The name of the class or the subclass that is used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.
DataOrganization Uint16   The type of data organization that is used.
Code
Semantics
0
Other
1
Unknown
2
Fixed Block
3
Variable Block
4
Count Key Data
DataRedundancy Uint16

ModelCorrespondence
(CIM_StorageSetting.Data
RedundancyGoal
CIM_StorageSetting.
DataRedundancyMax
CIM_StorageSetting.Data
RedundancyMin)

The number of complete copies of data that are maintained.
DeltaReservation Uint8

MinValue(0), MaxValue(100),
Units(Percentage),
ModelCorrespondence
(CIM_StorageSetting.Delta
ReservationGoal
CIM_StorageSetting.Delta
ReservationMax
CIM_StorageSetting.Delta
ReservationMin)

The current value for Delta reservation.
Description String   A textual description of the object.
DeviceID String MaxLen(64) The ID of the StorageVolume. A numeric value that is only unique for instances of the StorageVolume class.
ElementName String MaxLen(15), Write(TRUE), WriteRole(Administrator) The user-friendly name of the volume.
EnabledDefault Uint16 Write(TRUE) The default or startup configuration for an element's EnabledStatus. By default, the EnabledStatus is 2 (Enabled).
Code
Semantics
2
Enabled
3
Disabled
5
Not Applicable
6
Enabled but Offline
7
No Default
8..32767
DMTF Reserved
32768..65535
Vendor Reserved
EnabledState Uint16

ModelCorrespondence
(CIM_EnabledLogical
Element.OtherEnabledState)

The operational state of the element.
Code
Semantics
0
Unknown
1
Other
2
Enabled
3
Disabled
4
Shutting Down
5
Not Applicable
6
Enabled but Offline
7
In Test
8
Deferred
9
Quiesce
10
Starting
11..32767
DMTF Reserved
32768..65535
Vendor Reserved
If an element is being tested and is neither enabled nor disabled, In Test (7) is used. If this property does not apply to an instance of EnabledLogical Element, Not Applicable (5) is used.
ErrorCleared Boolean

Deprecated(CIM_Managed
SystemElement.Operational

Status)
This property is not supported.
ErrorDescription String

Deprecated(CIM_Device
ErrorData.ErrorDescription)

This property is not supported.
ErrorMethodology String   This property is not supported.
ExtentStatus Uint16[]   StorageExtents have additional status information beyond that captured in the Availability and StatusInfo properties, inherited from the ManagedSystem Element. This additional information is captured in the VolumeStatus property.
Code
Semantics
0
Other
1
Unknown
2
None/Not Applicable
3
Broken
4
Data Lost
5
Dynamic Reconfig
6
Exposed
7
Fractionally Exposed
8
Partially Exposed
9
Protection Disabled
10
Readying
11
Rebuild
12
Recalculate
13
Spare in Use
14
Verify In Progress
15..32767
DMTF Reserved
32768..65535
Vendor Reserved
FCID String   The FlashCopy ID of the volume.
FCName String   The FlashCopy name of the volume.
FlashCopyMapCount Uint16   The number of FlashCopy mappings that contain this volume.
GroupID String   The ID of the scoping RedundancyGroup.
GroupName String   The name of the scoping RedundancyGroup.
Identifying Descriptions String[]

ArrayType(Indexed),
ModelCorrespondence
(CIM_LogicalDevice.Other
IdentifyingInfo)

An array of free-form strings that provides explanations and details behind the entries in the OtherIdentifyingInfo array. Each entry of this array is related to the entry in OtherIdentifyingInfo that is located at the same index.
InstallDate

Date-
time

  This property is not supported.
IsBasedOn Underlying Redundancy Boolean   A value of true indicates that the underlying StorageExtent(s) participate in a StorageRedundancy Group.
IsFormatted Boolean Expensive(TRUE) A value of true indicates that the volume has been formatted by the SAN Volume Controller.
LastErrorCode Uint32

Deprecated(CIM_Device
ErrorData.LastErrorCode)

This property is not supported.
MaxQuiesceTime Uint64 Deprecated(No value), Units(MilliSeconds) This property is not supported.
Name String

ModelCorrespondence
(CIM_StorageVolume.
NameFormat), MaxLen(1024)

A unique identifier for the volume.
NameFormat Uint16

ModelCorrespondence
(CIM_StorageVolume.Name
CIM_StorageVolume.
OtherNameFormat),
Experimental(TRUE)

Format of the Name property. For non SCSI volumes, SNVM is the most appropriate choice.
Code
Semantics
0
Unknown
1
Other
2
VPD83NAA6 (VPD Page 83, NAA IEEE Registered Extended)
3
VPD83NAA5 (VPD Page 83, NAA IEEE Registered)
4
VPD83Type2 (VPD Page 83, EIU-64)
5
VPD83Type1 (VPD Page 83, T10 Vendor Identification)
6
VPD83Type0
7
SNVM (Serial Number/ Vendor/ Model. VPD Page 83, Vendor-Specific)
8
NodeWWN (Node WWN, for single LUN or controller)
NameNamespace Uint16

ModelCorrespondence
(CIM_StorageVolume.Name
CIM_StorageVolume.
OtherNameNamespace)

The preferred source for volume names is SCSI vital product data (VPD) Page 83 responses. Page 83 returns a list of identifiers for various device elements. The metadata for each identifier includes an association field, identifiers with association of 0 apply to volumes. Page 83 supports several namespaces specified in the type field in the identifier metadata.
Code
Semantics
0
Unknown
1
Other
2
VPD83Type3n (Page 83, Type 3 NAA. NameFormat should be NAA.)
3
VPD83Type2 (VPD Page 83, Type 2 EUI64. NameFormat EUI.)
4
VPD83Type1 (VPD Page 83, Type 1 T10 Vendor Identification. NameFormat T10.)
5
VPD80 (VPD page 80, Serial number. NameFormat should be Other.)
6
NodeWWN (FC NodeWWN. NameFormat should be NAA or EUI.)
7
SNVM (Serial Number/ Vendor/ Model. NameFormat should be SNVM.)
NativeStatus Uint16   The native operational status of the volume.
Code
Semantics
0
Offline
1
Online
2
Degraded
3
Formatting

NoSinglePoint
OfFailure

Boolean

ModelCorrespondence
(CIM_StorageSetting.No
SinglePointOfFailure)

Indicates if a single point of failure exists.
NumberOfBlocks Uint64   The total number of logically contiguous blocks, of size BlockSize, that form this extent. The total size of the extent can be calculated by multiplying BlockSize by NumberOfBlocks. If the BlockSize is 1, this property is the total size of the extent.
OperationalStatus Uint16[]

ArrayType(Indexed),
ModelCorrespondence
(CIM_ManagedSystem
Element.StatusDescriptions)

The status of the volume.
Code
Semantics
0
Unknown
1
Other
2
OK
3
Degraded
4
Stressed
5
Predictive Failure
6
Error
7
Non-Recoverable Error
8
Starting
9
Stopping
10
Stopped
11
In Service
12
No Contact
13
Lost Communication
14
Aborted
15
Dormant
16
Supporting Entity in Error
17
Completed
18
Power Mode
OtherEnabledState String

ModelCorrespondence
(CIM_EnabledLogical
Element.EnabledState)

The state of the element when the EnabledStatus property is set to 1 (Other). This property must be set to null when EnabledStatus is any value other than 1.
OtherIdentifyinInfo String[]

MaxLen(256),
ArrayType(Indexed),
ModelCorrespondence
(CIM_LogicalDevice.
IdentifyingDescriptions)

Additional data, beyond DeviceID information, that can be used to identify a LogicalDevice. For example, the Operating System's user-friendly name for the device.
OtherNameFormat String

ModelCorrespondence
(CIM_StorageVolume.
NameFormat)

The description of the format of the Name property when NameFormat includes the value 1 (Other).

OtherName
Namespace

String

ModelCorrespondence
(CIM_StorageVolume.
NameNamespace)

The description of the namespace of the Name property when NameNamespace includes the value 1 (Other).
PackageRedundancy Uint16

ModelCorrespondence
(CIM_StorageSetting.
PackageRedundancyGoal
CIM_StorageSetting.
PackageRedundancyMax
CIM_StorageSetting.
PackageRedundancyMin)

The number of disk spindles that can fail without data loss.
PoolID String   The ID of the hosting storage pool.
PoolName String   The name of the pool from which this volume was allocated.
PowerManagement Capabilities Uint16[]

Deprecated(CIM_Power
ManagementCapabilities.
PowerCapabilities)

An enumerated array that describes the power management capabilities of the device. This property is deprecated. Instead, the PowerCapabilites property in an associated PowerManagement Capabilities class must be used.
Code
Semantics
0
Unknown
1
Not Supported
2
Disabled
3
Enabled
4
Power Saving Modes Entered Automatically
5
Power State Settable
6
Power Cycling Supported
7
Timed Power On Supported

PowerManagement
Supported

Boolean

Deprecated(CIM_Power
ManagementCapabilities)

Indicates if the device can be power managed. This property is deprecated. Instead, the existence of an associated PowerManagement Capabilities class (associated using the ElementCapabilities relationhip) indicates that power management is supported.
PowerOnHours Uint64

Deprecated(CIM_Powered
StatisticalData.PowerOnHours),
Units(Hours), Counter(TRUE)

This property is not supported.
PreferredNode String Expensive(TRUE) The ID of the preferred node.
Primordial Boolean   Indicates if the containing system does not have the ability to create or delete this operational element.
Purpose String   The description of the media and its use.
RequestedState Uint16

ModelCorrespondence
(CIM_EnabledLogical
Element.EnabledState)

The state change for the element that must be made at the next opportunity. The SAN Volume Controller does not evaluate this attribute and therefore no action is taken when it changes.
Code
Semantics
2
Enabled
3
Disabled
4
Shut Down
5
No Change
6
Offline
7
Test
8
Deferred
9
Quiesce
10..32767
DMTF Reserved
32768..65535
Vendor Reserved
SCID String   The sync copy ID of the volume.
SCName String   The sync copy name of the volume.
SequentialAccess Boolean   Indicates if storage is sequentially accessed by a MediaAccessDevice. For example, a TapePartition is a sequentially accessed StorageExtent. StorageVolumes, DiskPartitions, and LogicalDisks are random-access extents.
Status String

MaxLen(10), Deprecated(CIM_
ManagedSystemElement.
OperationalStatus)

Deprecated property that is set to unknown. See OperationalStatus for status information.
StatusDescriptions String[]

ArrayType(Indexed),
ModelCorrespondence
(CIM_ManagedSystem
Element.OperationalStatus)

The description of the status that is used when the OperationalStatus property is set to 1 (Other).
StatusInfo Uint16

Deprecated(CIM_Enabled
LogicalElement.Enabled
State)

Deprecated porperty. See CIM_Enabled LogicalElement. EnabledState instead.
Code
Semantics
1
Other
2
Unknown
3
Enabled
4
Disabled
5
Not Applicable

SystemCreation
ClassName

String

Propagated(CIM_System.
CreationClassName),
MaxLen(256)

The CreationClassName of the scoping system.
SystemName String

Propagated(CIM_System.
Name), MaxLen(256)

The IP address of the scoping cluster.
Throttle Uint64 Units(IOs per second), Write(TRUE), WriteRole(Administrator), Expensive(TRUE) The maximum bandwidth of the volume.

TimeOfLast
StateChange

Date-
time

  This property is not supported.

TotalPowerOn
Hours

Uint64

Deprecated(CIM_Powered
StatisticalData.TotalPower
OnHours), Units(Hours),
Counter(TRUE)

This property is not supported.
Type Uint32 Value(Sequential Striped Router Image) The type of volume.
UnitDeviceID Uint16   The unit device identifier of the volume as defined by OpenVMS.
Library | Support | Terms of use | Feedback
© Copyright IBM Corporation 2003, 2009. All Rights Reserved.