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_LogicalDevice
   |
   +--CIM_StorageExtent
   |
   +--CIM_StorageVolume

Direct Known Subclasses

CIM_VolumeSet

Class Qualifiers

NameData TypeValue
DescriptionstringA 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.
UMLPackagePathstringCIM::Device::StorageExtents
Versionstring2.28.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
CanDeletebooleantrue
DescriptionstringIndicates if the volume is able to be deleted by a client application. True means the volume may be deleted by a client application.
Experimentalbooleantrue
CUImagestring
DescriptionstringThis property is the Node Element Descriptor of the Control Unit Image (this property is required for CKD StorageVolumes).
Experimentalbooleantrue
EmulatedDevicestring
DescriptionstringSpecifies the specific device (e.g., 3380 or 3390) that is emulated by the volume.
Experimentalbooleantrue
Namestring
DescriptionstringA unique identifier for the Volume.
MappingStringsstringANSI|T10|SCSI SPC-3|8.6
MaxLenuint321024
ModelCorrespondencestringCIM_StorageVolume.NameFormat
OverridestringName
NameFormatuint16
DescriptionstringA subset of StorageExtent name formats apply to StorageVolumes.
ModelCorrespondencestringCIM_StorageExtent.Name, CIM_StorageExtent.NameNamespace, CIM_StorageExtent.OtherNameFormat
OverridestringNameFormat
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11
ValuesstringUnknown, Other, VPD83NAA6, VPD83NAA5, VPD83Type2, VPD83Type1, VPD83Type0, SNVM, NodeWWN, NAA, EUI64, T10VID
NameNamespaceuint16
DescriptionstringA subset of StorageExtent name spaces apply to StorageVolume.
MappingStringsstringSPC.INCITS-T10| VPD 83, Association 0 | Identifier
ModelCorrespondencestringCIM_StorageExtent.Name, CIM_StorageExtent.OtherNameNamespace, CIM_StorageExtent.NameFormat
OverridestringNameNamespace
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7
ValuesstringUnknown, Other, VPD83Type3, VPD83Type2, VPD83Type1, VPD80, NodeWWN, SNVM
NumExtentsMigratinguint64
DescriptionstringThe number of extents in the process of migrating for this storage volume when the volume relocation is on going.
Experimentalbooleantrue
OtherUsageDescriptionstring
DescriptionstringPopulated when "Usage" has the value of "Other".
Experimentalbooleantrue
ModelCorrespondencestringCIM_StorageVolume.Usage
OverridestringOtherUsageDescription
RelativePerformanceOrderuint16
DescriptionstringA 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.
Experimentalbooleantrue
ModelCorrespondencestringCIM_StorageTier.RelativePerformanceOrder
StorageTieringSelectionuint160
DescriptionstringStorage 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.
Experimentalbooleantrue
ModelCorrespondencestringCIM_StorageVolume.RelativePerformanceOrder, CIM_StorageVolume.RelativePerformanceOrderSet
ValueMapstring0, 2, 3, .., 0x8000..
ValuesstringUnknown, Use RelativePerformanceOrder, Use RelativePerformanceOrderSet, DMTF Reserved, Vendor Specific
SubsystemIDstring
DescriptionstringThis property is the Subsystem ID if the array or virtualizer supports Subsystem IDs.
Experimentalbooleantrue
ThinlyProvisionedbooleanfalse
DescriptionstringTrue if the volume is thinly provisioned.
Experimentalbooleantrue
Usageuint16
DescriptionstringIndicates 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.
Experimentalbooleantrue
ModelCorrespondencestringCIM_StorageVolume.OtherUsageDescription
OverridestringUsage
ValueMapstring1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, .., 32768..65535
ValuesstringOther, 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 as Pool Contributor, Composite Volume Member, Composite LogicalDisk Member, Reserved for Sparing, DMTF Reserved, Vendor Reserved
ClientSettableUsageuint16[]
DescriptionstringIndicates which values from the "Usage" valuemapcan be manipulated by a client using the method"StorageConfigurationService.RequestUsageChange".
Experimentalbooleantrue
ModelCorrespondencestringCIM_StorageVolume.Usage
OverridestringClientSettableUsage
RelativePerformanceOrderSetuint16[]
DescriptionstringA set of RelativePerformanceOrder values. The volume can only be associated with storage tiers that have a RelativePerformanceOrder value included in this set.
Experimentalbooleantrue
ModelCorrespondencestringCIM_StorageTier.RelativePerformanceOrder

Inherited Properties

NameData TypeClass Origin
Accessuint16CIM_StorageExtent
Availabilityuint16CIM_LogicalDevice
BlockSizeuint64CIM_StorageExtent
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CompressionRateuint16CIM_StorageExtent
CompressionStateuint16CIM_StorageExtent
ConsumableBlocksuint64CIM_StorageExtent
CreationClassNamestringCIM_LogicalDevice
DataOrganizationuint16CIM_StorageExtent
DataRedundancyuint16CIM_StorageExtent
DeltaReservationuint8CIM_StorageExtent
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
DeviceIDstringCIM_LogicalDevice
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
ErrorClearedbooleanCIM_LogicalDevice
ErrorDescriptionstringCIM_LogicalDevice
ErrorMethodologystringCIM_StorageExtent
ExtentInterleaveDepthuint64CIM_StorageExtent
ExtentStripeLengthuint64CIM_StorageExtent
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
IsBasedOnUnderlyingRedundancybooleanCIM_StorageExtent
IsCompositebooleanCIM_StorageExtent
IsCompressedbooleanCIM_StorageExtent
IsConcatenatedbooleanCIM_StorageExtent
LastErrorCodeuint32CIM_LogicalDevice
LocationIndicatoruint16CIM_LogicalDevice
MaxQuiesceTimeuint64CIM_LogicalDevice
NoSinglePointOfFailurebooleanCIM_StorageExtent
NumberOfBlocksuint64CIM_StorageExtent
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
OtherNameFormatstringCIM_StorageExtent
OtherNameNamespacestringCIM_StorageExtent
PackageRedundancyuint16CIM_StorageExtent
PowerManagementSupportedbooleanCIM_LogicalDevice
PowerOnHoursuint64CIM_LogicalDevice
PrimaryStatusuint16CIM_ManagedSystemElement
PrimordialbooleanCIM_StorageExtent
PurposestringCIM_StorageExtent
RequestedStateuint16CIM_EnabledLogicalElement
SequentialAccessbooleanCIM_StorageExtent
StatusstringCIM_ManagedSystemElement
StatusInfouint16CIM_LogicalDevice
SystemCreationClassNamestringCIM_LogicalDevice
SystemNamestringCIM_LogicalDevice
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TotalPowerOnHoursuint64CIM_LogicalDevice
TransitioningToStateuint16CIM_EnabledLogicalElement
AdditionalAvailabilityuint16[]CIM_LogicalDevice
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
ExtentDiscriminatorstring[]CIM_StorageExtent
ExtentStatusuint16[]CIM_StorageExtent
IdentifyingDescriptionsstring[]CIM_LogicalDevice
OperationalStatusuint16[]CIM_ManagedSystemElement
OtherIdentifyingInfostring[]CIM_LogicalDevice
PowerManagementCapabilitiesuint16[]CIM_LogicalDevice
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Inherited Class Methods

NameReturn TypeClass Origin
EnableDeviceuint32CIM_LogicalDevice
OnlineDeviceuint32CIM_LogicalDevice
QuiesceDeviceuint32CIM_LogicalDevice
RequestStateChangeuint32CIM_EnabledLogicalElement
Resetuint32CIM_LogicalDevice
RestorePropertiesuint32CIM_LogicalDevice
SavePropertiesuint32CIM_LogicalDevice
SetPowerStateuint32CIM_LogicalDevice