BlockServices
Class IBMTSSVC_StorageVolume


CIM_ManagedElement
\_CIM_ManagedSystemElement
  \_CIM_LogicalElement
    \_CIM_EnabledLogicalElement
      \_CIM_LogicalDevice
        \_CIM_StorageExtent
          \_CIM_StorageVolume


Description

A device presented by the Cluster which can be mapped as a SCSILUN to host systems on the SAN. A Volume is formed by allocating a set of Extents from a Pool.

Subclasses


Referenced By

IBMTSSVC_AllocatedFromConcretePool IBMTSSVC_AuxRemoteStorageSynchronized IBMTSSVC_CopyCandidate IBMTSSVC_LocalStorageSynchronized IBMTSSVC_MasterRemoteStorageSynchronized IBMTSSVC_MirrorExtentForVolume IBMTSSVC_StorageConfigurationService IBMTSSVC_StorageVolumeElementSettingData IBMTSSVC_StorageVolumeOnCluster IBMTSSVC_StorageVolumeOnIOGroup IBMTSSVC_SystemVolumeController IBMTSSVC_VolumeBasedOn

Properties

IdTypeRangeDescription
Key
CreationClassName string
Max Length256
CreationClassName indicates the name of the class or the subclass 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.
DeviceID string
Max Length64
The ID of the StorageVolume. A numerical value which is unique for intances of the StorageVolume class only.
SystemCreationClassName string
Max Length256
The scoping System's CreationClassName.
SystemName string
Max Length256
The scoping System's Name Property
Read Only
Access uint16
Unknown0
Readable1
Writeable2
Read/Write Supported3
Write Once4
Access describes whether the media is readable (value=1), writeable (value=2), or both (value=3)."Unknown"(0) and"Write Once"(4) can also be defined.
AccessGranted boolean
This property provides a quick interface for finding Devices with no AuthorizationSubject association to an AccessControlInformation instance; either directly, or via a Controller. True indicates that the Device has granted access to some consumer. False indicates that no access has been granted.
BackendVolumeID string
The ID of the underlying BackendVolume. Only valid if Type="Image"
BackendVolumeName string
The name of the underlying BackendVolume. Only valid if Type="Image"
BlockSize uint64
Size in bytes of the blocks which form this StorageExtent. If variable block size, then the maximum block size in bytes should 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.
CacheMode uint16
None0
ReadWrite1
The volume's cache mode. Can be either0 ("None"), or1 ("Read Write").Not available for SVC Clusters running pre v3.1.0 Firmware.
CacheState uint16
{Emtpy0
Not empty1
Corrupt}2
The volume's cache state. Can be either0 ("Empty"),1 ("Not empty") or2 ("Corrupt")
Cluster string
The identifying information of the cluster on which the storage volume resides.
ConsumableBlocks uint64
The maximum number of blocks, of size BlockSize, which are available for consumption when layering StorageExtents using the BasedOn association. This property only has meaning when this StorageExtent is an Antecedent reference in a BasedOn relationship. For example, a StorageExtent could be composed of 120 blocks. However, the Extent itself may use 20 blocks for redundancy data. If another StorageExtent is BasedOn this Extent, only 100 blocks would be available to it. This information ('100 blocks is available for consumption') is indicated in the ConsumableBlocks property.
Controlled boolean
This property provides a quick interface for finding Devices with no ControlledBy associations to Controllers. True indicates that the Device is connected to one or more Ports (via Controllers). False indicates that the Device exists but is not connected to a port.
CopyCount uint32
The number of copies of this vdisk.Each vdisk must have at least one copy. If it is mirrored it will have two copies.
DataOrganization uint16
Other0
Unknown1
Fixed Block2
Variable Block3
Count Key Data4
Type of data organization used.
DataRedundancy uint16
Number of complete copies of data currently maintained.
DeltaReservation uint8
Current value for Delta reservation. This is a percentage that specifies the amount of space that should be reserved in a replica for caching changes.
Description string
The Description property provides a textual description of the object.
EnabledDefault uint16
Enabled2
Disabled3
Not Applicable5
Enabled but Offline6
No Default7
DMTF Reserved8..32767
Vendor Reserved32768..65535
An enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element. By default, the element is"Enabled"(value=2).
EnabledState uint16
Unknown0
Other1
Enabled2
Disabled3
Shutting Down4
Not Applicable5
Enabled but Offline6
In Test7
Deferred8
Quiesce9
Starting10
DMTF Reserved11..32767
Vendor Reserved32768..65535
EnabledState is an integer enumeration that indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value=4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled and disabled states:Enabled (2) indicates that the element is or could be running commands, will process any queued commands, and queues new requests.Disabled (3) indicates that the element will not run commands and will drop any new requests.Shutting Down (4) indicates that the element is in the process of going to a Disabled state.Not Applicable (5) indicates the element does not support being enabled or disabled.Enabled but Offline (6) indicates that the element might be completing commands, and will drop any new requests.Test (7) indicates that the element is in a test state.Deferred (8) indicates that the element might be completing commands, but will queue any new requests.Quiesce (9) indicates that the element is enabled but in a restricted mode. The behavior of the element is similar to the Enabled state, but it processes only a restricted set of commands. All other requests are queued.Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued.
ExtentStatus uint16
Other0
Unknown1
None/Not Applicable2
Broken3
Data Lost4
Dynamic Reconfig5
Exposed6
Fractionally Exposed7
Partially Exposed8
Protection Disabled9
Readying10
Rebuild11
Recalculate12
Spare in Use13
Verify In Progress14
DMTF Reserved15..32767
Vendor Reserved32768..65535
StorageExtents have additional status information beyond that captured in the OperationalStatus and other properties, inherited from ManagedSystemElement. This additional information (for example,"Protection Disabled", value=9) is captured in the VolumeStatus property.
FCID string
The flash copy ID of the volume. Many implies itis part of more than one relationship.
FCName string
The flash copy name of the volume.
FlashCopyMapCount uint16
The number of Flash Copy Mappings that contain this volume. Not available for SVC Clusters running pre v4.2.0 Firmare.
GroupID string
The ID of the scoping RedundancyGroup.
GroupName string
The name of the scoping RedundancyGroup.
IdentifyingDescriptions string
An array of free-form strings providing explanations and details behind the entries in the OtherIdentifyingInfo array. Note, each entry of this array is related to the entry in OtherIdentifyingInfo that is located at the same index.
IsBasedOnUnderlyingRedundancy boolean
True indicates that the underlying StorageExtent(s) participate in a StorageRedundancyGroup.
IsFormatted boolean
Has the volume been formatted by SAN Volume Controller?
IsSpaceEfficient boolean
Indicates if any MirrorExtent associated with this StorageVolume is Space-Efficient. If the propertyis null then this volume can not be spaceefficient.
Name string
A unique identifier for the Volume. The Page 83 NAA6 type 3 ID.
NameFormat uint16
Unknown0
Other1
VPD83NAA62
VPD83NAA53
VPD83Type24
VPD83Type15
VPD83Type06
SNVM7
NodeWWN8
NAA9
EUI6410
T10VID11
Note - this property originally touched on two concepts that are now separated into this property and NameNamespace. Values 2,3,4,5,6, and 8 are retained for backwards compatibility but are deprecated in lieu of the corresponding values in CIM_StorageVolume.NameNamespace. Format of the Name property. Values are (per SCSI SPC-3):2 = VPD Page 83, NAA IEEE Registered Extended (VPD83NAA6)(DEPRECATED)3 = VPD Page 83, NAA IEEE Registered (VPD83NAA5)(DEPRECATED)4 = VPD Page 83, (VPD83Type2) (DEPRECATED)5 = VPD Page 83,T10 Vendor Identification (VPD83Type1) (DEPRECATED)6 = VPD Page 83, Vendor Specific (VPD83Type0) (DEPRECATED)7 = Serial Number/Vendor/Model (SNVM) SNVM is 3 strings representing the vendor name, product name within the vendor namespace, and the serial number within the model namespace. Strings are delimited with a'+'. Spaces may be included and are significant. The serial number is the text representation of the serial number in hexadecimal upper case. Vendor and Model represent the vendor and model ID from SCSI Inquiry data, the vendor field must be 8 characters wide and theproduct field must be 16 characters wide. For example,'ACME +SUPER DISK +124437458'8 = Node WWN (for single LUN/controller) (NodeWWN)(DEPRECATED)9 = NAA as a generic format. Seehttp://standards.ieee.org/regauth/oui/tutorials/fibrecomp_id.html Formatted as 16 or 32 unseparated uppercase hex characters (2 per binary byte). For example'21000020372D3C73'10 = EUI as a generic format (EUI64) Seehttp://standards.ieee.org/regauth/oui/tutorials/EUI64.htmlFormatted as 16 unseparated uppercase hex characters (2 per binary byte)11 = T10 vendor identifier format as returned by SCSI Inquiry VPD page 83, identifier type 2. See T1- SPC-3 specification. The 8-byte ASCII vendor ID from the T10 registry followed by a vendor specific ASCII identifier; spaces are permitted. For non SCSI volumes,'SNVM'may be the most appropriate choice.
NativeStatus uint16
Offline0
Online1
Degraded2
Formatting3
The volume's native operational status. Can be either 0("Offline"), 1 ("Online"), 2("Degraded"), 3("Formatting")
NoSinglePointOfFailure boolean
Indicates whether or not there exists no single point of failure.
NumberOfBlocks uint64
Total number of logically contiguous blocks, of size Block Size, which 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
Unknown0
Other1
OK2
Degraded3
Stressed4
Predictive Failure5
Error6
Non-Recoverable Error7
Starting8
Stopping9
Stopped10
In Service11
No Contact12
Lost Communication13
Aborted14
Dormant15
Supporting Entity in Error16
Completed17
Power Mode18
DMTF Reserved..
Vendor Reserved0x8000..
The status of the volume. May be either2 ("OK") for"online"or3 ("Degraded") for"degraded"or 10 ("Stopped") for"offline"1 ("Other") for"formatting"
OtherEnabledState string
A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ("Other"). This property must be set to null when EnabledState is any value other than 1.
OtherIdentifyingInfo string
Max Length256
OtherIdentifyingInfo captures additional data, beyond DeviceID information, that could be used to identify a LogicalDevice. One example would be to hold the Operating System's user friendly name for the Device in this property.
OtherNameFormat string
A string describing the format of the Name property when NameFormat includes the value 1,"Other".
PackageRedundancy uint16
How many physical packages can currently fail without data loss. For example, in the storage domain, this might be disk spindles.
PoolID string
The ID of the hosting storage pool.
PoolName string
The name of the pool from which this volume was allocated.
PreferredNode string
The ID of the preferred node.
Primordial boolean
If true,"Primordial"indicates that the containing System does not have the ability to create or delete this operational element. This is important because StorageExtents are assembled into higher-level abstractions using the BasedOn association. Although the higher-level abstractions can be created and deleted, the most basic, (that is. primordial), hardware-based storage entities cannot. They are physically realized as part of the System, or are actually managed by some other System and imported as if they were physically realized. In other words, a Primordial StorageExtent exists in, but is not created by its System and conversely a non-Primordial StorageExtent is created in the context of its System. For StorageVolumes, this property will generally be false. One use of this property is to enable algorithms that aggregate StorageExtent.ConsumableSpace across all, StorageExtents but that also want to distinquish the space that underlies Primordial StoragePools. Since implementations are notrequired to surface all Component StorageExtents of a StoragePool, this information is not accessible in any other way.
Purpose string
A free form string describing the media and/or its use.
RequestedState uint16
Enabled2
Disabled3
Shut Down4
No Change5
Offline6
Test7
Deferred8
Quiesce9
Reboot10
Reset11
Not Applicable12
DMTF Reserved..
Vendor Reserved32768..65535
RequestedState is an integer enumeration that indicates the last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. When EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the RequestedState of the element is 5 ("No Change"). Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration.It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are"Reboot"(10) and"Reset"(11). Reboot refers to doing a"Shut Down"and then moving to an"Enabled"state. Reset indicates that the element is first"Disabled"and then"Enabled". The distinction between requesting"Shut Down"and"Disabled"should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. The Disabled state requests an immediate disabling of the element, such that it will not run or accept any commands or processing requests.This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code.A particular instance of EnabledLogicalElement might not support RequestedStateChange. If this occurs, the value 12 ("Not Applicable") is used.
SCID string
The remote copy ID of the volume.
SCName string
The remote copy name of the volume.
SequentialAccess boolean
Boolean set to TRUE if the Storage is sequentially accessed by a MediaAccessDevice. A TapePartition is an example of a sequentially accessed StorageExtent. StorageVolumes, Disk Partitions and LogicalDisks represent randomly accessed Extents.
StatusDescriptions string
Strings describing the various OperationalStatus array values. For example, if"Stopping"is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Entries in this array are correlated with those at the same array index in OperationalStatus.
SyncRate uint8
If a disk is mirrored, the synchronization rate controls the speed at which the mirrored copies keep themselves in sync. 100 = maximum speed, 0 = no synchronization
Throttle uint64
The maximum bandwidth of the volume.
ThrottleMBS boolean
If true, the units for Throttle are MB/s, otherwise they are IO/s
Type uint32
Sequential0
Striped1
Router2
Image3
Many4
The type of the volume.
UniqueID string
The unique ID of the volume.
UnitDeviceID uint16
The volume's Unit Device Identifier as defined by OpenVMS. Not available for SVC Clusters running pre v4.1.0 Firmware.
Read Write
Caption string
Max Length15
The Caption property is a short textual description (one-line string) of the object.
ElementName string
Max Length15
The volume's user-friendly name.
 
Inherited from class CIM_ManagedElement
Caption, Description, ElementName
 
Inherited from class CIM_ManagedSystemElement
HealthState, InstallDate, Name, OperationalStatus, Status, StatusDescriptions
 
Inherited from class CIM_EnabledLogicalElement
EnabledState, OtherEnabledState, RequestedState, TimeOfLastStateChange, EnabledDefault
 
Inherited from class CIM_LogicalDevice
AdditionalAvailability, Availability, ErrorCleared, ErrorDescription, IdentifyingDescriptions, LastErrorCode, MaxQuiesceTime, OtherIdentifyingInfo, PowerManagementCapabilities, PowerManagementSupported, PowerOnHours, StatusInfo, TotalPowerOnHours
 
Inherited from class CIM_StorageExtent
Access, BlockSize, ConsumableBlocks, DataOrganization, DataRedundancy, DeltaReservation, ErrorMethodology, ExtentStatus, IsBasedOnUnderlyingRedundancy, NoSinglePointOfFailure, NumberOfBlocks, PackageRedundancy, Primordial, Purpose, SequentialAccess
 
Inherited from class CIM_StorageVolume
Name, NameFormat, NameNamespace, OtherNameFormat, OtherNameNamespace
 

Method Summary

NameDescription
ResetRequests a reset of the LogicalDevice.
 
Inherited from class CIM_EnabledLogicalElement
RequestStateChange
 
Inherited from class CIM_LogicalDevice
EnableDevice, OnlineDevice, QuiesceDevice, Reset, RestoreProperties, SaveProperties, SetPowerState
 

Method Detail


Reset

Description

Requests a reset of the LogicalDevice. The return value should be 0 if the request was successfully run, 1 if the request is not supported and some other value if an error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are'translated'may also be specified in the subclass as a Values array qualifier.

Parameters

IdTypeRangeDescription
In
none
out
none
Return Codes
none