# Class CIM_StorageVolume
extends CIM_StorageExtent

A StorageVolume is a StorageExtent that is published for use outside of the scoping System. For SCSI storage target devices, StorageVolumes are used to represent target Block devices, (peripheral device type codes 0h (i.e, direct-access), 4h (i.e., write-once), 5h (i.e., CD/DVD), 7h (i.e., optical memory), and Eh (i.e., simplified direct-access).); Stream devices, (peripheral device type codes 1h (i.e., sequential-access) and 3h (i.e., processor).). In these case, StorageVolume.Name will be derived from SCSI volume as documented in StorageExtent.Nameformat and NameNamespace Descriptions. The 'Exported' value from StorageExtent.ExtentStatus[] MUST be in all instances of StorageVolume to maintain the semantic of 'published' described above.

### Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

## Class Hierarchy

CIM_ManagedElement
|
+--CIM_ManagedSystemElement
|
+--CIM_LogicalElement
|
+--CIM_EnabledLogicalElement
|
+--CIM_AllocatedLogicalElement
|
+--CIM_LogicalDevice
|
+--CIM_StorageExtent
|
+--CIM_StorageVolume

## Direct Known Subclasses

CIM_VolumeSet

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | A StorageVolume is a StorageExtent that is published for use outside of the scoping System. For SCSI storage target devices, StorageVolumes are used to represent target Block devices, (peripheral device type codes 0h (i.e, direct-access), 4h (i.e., write-once), 5h (i.e., CD/DVD), 7h (i.e., optical memory), and Eh (i.e., simplified direct-access).); Stream devices, (peripheral device type codes 1h (i.e., sequential-access) and 3h (i.e., processor).). In these case, StorageVolume.Name will be derived from SCSI volume as documented in StorageExtent.Nameformat and NameNamespace Descriptions. The 'Exported' value from StorageExtent.ExtentStatus[] MUST be in all instances of StorageVolume to maintain the semantic of 'published' described above.
UMLPackagePath | string | CIM::Device::StorageExtents
Version | string | 2.45.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
CanDelete | boolean | true
Description | string | Indicates if the volume is able to be deleted by a client application. True means the volume may be deleted by a client application.
CUImage | string |
Description | string | This property is the Node Element Descriptor of the Control Unit Image (this property is required for CKD StorageVolumes).
EmulatedDevice | string |
Description | string | Specifies the specific device (e.g., 3380 or 3390) that is emulated by the volume.
ExtentType | uint16 |
Description | string | The ExtentType property specifies extent type for host access.
ValueMap | string | 1, 2, 3, 4
Values | string | Other, Open, Intermediate, Mainframe
Name | string |
Description | string | A unique identifier for the Volume.
MappingStrings | string | ANSI|T10|SCSI SPC-3|8.6
MaxLen | uint32 | 1024
ModelCorrespondence | string | CIM_StorageVolume.NameFormat
Override | string | Name
NameFormat | uint16 |
Description | string | A subset of StorageExtent name formats apply to StorageVolumes.
ModelCorrespondence | string | CIM_StorageExtent.Name, CIM_StorageExtent.NameNamespace, CIM_StorageExtent.OtherNameFormat
Override | string | NameFormat
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11
Values | string | Unknown, Other, VPD83NAA6, VPD83NAA5, VPD83Type2, VPD83Type1, VPD83Type0, SNVM, NodeWWN, NAA, EUI64, T10VID
NameNamespace | uint16 |
Description | string | A subset of StorageExtent name spaces apply to StorageVolume.
MappingStrings | string | SPC.INCITS-T10| VPD 83, Association 0 | Identifier
ModelCorrespondence | string | CIM_StorageExtent.Name, CIM_StorageExtent.OtherNameNamespace, CIM_StorageExtent.NameFormat
Override | string | NameNamespace
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7
Values | string | Unknown, Other, VPD83Type3, VPD83Type2, VPD83Type1, VPD80, NodeWWN, SNVM
NumExtentsMigrating | uint64 |
Description | string | The number of extents in the process of migrating for this storage volume when the volume relocation is on going.
OtherUsageDescription | string |
Description | string | Populated when "Usage" has the value of "Other".
ModelCorrespondence | string | CIM_StorageVolume.Usage
Override | string | OtherUsageDescription
RelativePerformanceOrder | uint16 |
Description | string | A storage volume can be associated with one or more storage tiers with equal or smaller StorageTier.RelativePerformanceOrder. The smaller the RelativePerformanceOrder, the more "performant" the tier.
ModelCorrespondence | string | CIM_StorageTier.RelativePerformanceOrder
StorageTieringSelection | uint16 | 0
Description | string | Storage tiering examines this property to determine whether to use RelativePerformanceOrder or RelativePerformanceOrderSet for selecting an appropriate storage tier. A value of 0 or null indicates the associated element is not subject to storage tiering.
ModelCorrespondence | string | CIM_StorageVolume.RelativePerformanceOrder, CIM_StorageVolume.RelativePerformanceOrderSet
ValueMap | string | 0, 2, 3, .., 0x8000..
Values | string | Unknown, Use RelativePerformanceOrder, Use RelativePerformanceOrderSet, DMTF Reserved, Vendor Specific
SubsystemID | string |
Description | string | This property is the Subsystem ID if the array or virtualizer supports Subsystem IDs.
ThinlyProvisioned | boolean | false
Description | string | True if the volume is thinly provisioned.
Usage | uint16 |
Description | string | Indicates the intended usage or any restrictions that may have been imposed on the usage of this component. All ValueMap/Values entries are defined in CIM_StorageExtent. To promote interoperability across subclasses, all new entries for this class shall be defined there.
ModelCorrespondence | string | CIM_StorageVolume.OtherUsageDescription
Override | string | Usage
ValueMap | string | 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, .., 32768..65535
Values | string | Other, Unrestricted, Reserved for ComputerSystem (the block server), Reserved by Replication Services, Reserved by Migration Services, Local Replica Source, Remote Replica Source, Local Replica Target, Remote Replica Target, Local Replica Source or Target, Remote Replica Source or Target, Delta Replica Target, Element Component, Reserved to be Unrestricted Pool Contributor, Composite Volume Member, Composite LogicalDisk Member, Reserved for Sparing, In use as Unrestricted Pool Contributor, Reserved to be Delta Replica Pool Contributor, Reserved to be Local Replication Pool Contributor, Reserved to be Remote Replication Pool Contributor, In use as Delta Replica Pool Contributor, In use as Local Replication Pool Contributor, In use as Remote Replication Pool Contributor, DMTF Reserved, Vendor Reserved
ClientSettableUsage | uint16[] |
Description | string | Indicates which values from the "Usage" valuemapcan be manipulated by a client using the method"StorageConfigurationService.RequestUsageChange".
ModelCorrespondence | string | CIM_StorageVolume.Usage
Override | string | ClientSettableUsage
RelativePerformanceOrderSet | uint16[] |
Description | string | A set of RelativePerformanceOrder values. The volume can only be associated with storage tiers that have a RelativePerformanceOrder value included in this set.
ModelCorrespondence | string | CIM_StorageTier.RelativePerformanceOrder

### Inherited Properties

Name | Data Type
--- | ---
Access | uint16
AllocationState | string
Availability | uint16
BlockSize | uint64
Caption | string
CommunicationStatus | uint16
CompressionRate | uint16
CompressionState | uint16
ConsumableBlocks | uint64
CreationClassName | string
DataOrganization | uint16
DataRedundancy | uint16
DeltaReservation | uint8
Description | string
DetailedStatus | uint16
DeviceID | string
ElementName | string
EnabledDefault | uint16
EnabledState | uint16
ErrorCleared | boolean
ErrorDescription | string
ErrorMethodology | string
ExtentInterleaveDepth | uint64
ExtentStripeLength | uint64
Generation | uint64
HealthState | uint16
InstallDate | datetime
InstanceID | string
IsBasedOnUnderlyingRedundancy | boolean
IsComposite | boolean
IsCompressed | boolean
IsConcatenated | boolean
LastErrorCode | uint32
LocationIndicator | uint16
MaxQuiesceTime | uint64
NoSinglePointOfFailure | boolean
NumberOfBlocks | uint64
OperatingStatus | uint16
OtherEnabledState | string
OtherNameFormat | string
OtherNameNamespace | string
PackageRedundancy | uint16
PowerManagementSupported | boolean
PowerOnHours | uint64
PrimaryStatus | uint16
Primordial | boolean
Purpose | string
RequestedState | uint16
SequentialAccess | boolean
Status | string
StatusInfo | uint16
SystemCreationClassName | string
SystemName | string
TimeOfLastStateChange | datetime
TotalPowerOnHours | uint64
TransitioningToState | uint16
AdditionalAvailability | uint16[]
AvailableRequestedStates | uint16[]
ExtentDiscriminator | string[]
ExtentStatus | uint16[]
IdentifyingDescriptions | string[]
OperationalStatus | uint16[]
OtherIdentifyingInfo | string[]
PowerManagementCapabilities | uint16[]
StatusDescriptions | string[]

## Class Methods

### Inherited Class Methods

Name | Return Type
--- | ---
EnableDevice | uint32
OnlineDevice | uint32
QuiesceDevice | uint32
RequestStateChange | uint32
Reset | uint32
RestoreProperties | uint32
SaveProperties | uint32
SetPowerState | uint32