Class CIM_StorageCapabilities
extends CIM_Capabilities

A subclass of Capabilities that defines the Capabilities of a StorageService or StoragePool. For example, an instance of StorageCapabilities could be associated with either a StorageConfigurationService or StoragePool by using ElementCapabilities.

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


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_Capabilities
   |
   +--CIM_StorageCapabilities

Direct Known Subclasses

CIM_StorageTierCapabilities

Class Qualifiers

NameData TypeValue
DescriptionstringA subclass of Capabilities that defines the Capabilities of a StorageService or StoragePool. For example, an instance of StorageCapabilities could be associated with either a StorageConfigurationService or StoragePool by using ElementCapabilities.
UMLPackagePathstringCIM::Device::StorageServices
Versionstring2.31.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
DataRedundancyDefaultuint16
DescriptionstringDataRedundancyDefault describes the default number of complete copies of data that can be maintained. Examples would be RAID 5 where 1 copy is maintained and RAID 1 where 2 or more copies are maintained. Possible values are 1 to n. The bounds for the redundancy (max and min) are defined by DataRedundancyMax and DataRedundancyMin.
MinValuesint641
ModelCorrespondencestringCIM_StorageCapabilities.DataRedundancyMax, CIM_StorageCapabilities.DataRedundancyMin
DataRedundancyMaxuint16
DescriptionstringDataRedundancyMax describes the maximum number of complete copies of data that can be maintained. Examples would be RAID 5 (where 1 copy is maintained) and RAID 1 (where 2 or more copies are maintained). Possible values are 1 to n. The default redundancy is specified using DataRedundancyDefault, while the minimum is defined by DataRedundancyMin.
MinValuesint641
ModelCorrespondencestringCIM_StorageCapabilities.DataRedundancyMin, CIM_StorageCapabilities.DataRedundancyDefault
DataRedundancyMinuint16
DescriptionstringDataRedundancyMin describes the minimum number of complete copies of data that can be maintained. Examples would be RAID 5 where 1 copy is maintained and RAID 1 where 2 or more copies are maintained). Possible values are 1 to n. The default redundancy is specified using DataRedundancyDefault, while the maximum is defined by DataRedundancyMax.
MinValuesint641
ModelCorrespondencestringCIM_StorageCapabilities.DataRedundancyMax, CIM_StorageCapabilities.DataRedundancyDefault
DeltaReservationDefaultuint16
DescriptionstringDelta reservation is a number between 1 (1%) and a 100 (100%) that specifies how much space should be reserved by default in a replica for caching changes. For a complete copy this would be 100%, but it can be lower in some implementations. This parameter sets the default value, while DeletaReservationMax and DeltReservationMin set the upper and lower bounds.
MaxValuesint64100
MinValuesint640
ModelCorrespondencestringCIM_StorageCapabilities.DeltaReservationMax, CIM_StorageCapabilities.DeltaReservationMin
PUnitstringpercent
UnitsstringPercentage
DeltaReservationMaxuint16
DescriptionstringDeltaReservatioMax is a number between 1 (1%) and a 100 (100%) that specifies the maximum amount of space reserved in a replica for caching changes. For a complete copy this would be 100%, but it can be lower in some implementations. This parameter sets the upper limit, while DeltaReservationMin sets the lower limit.
MaxValuesint64100
MinValuesint640
ModelCorrespondencestringCIM_StorageCapabilities.DeltaReservationMin, CIM_StorageCapabilities.DeltaReservationDefault
PUnitstringpercent
UnitsstringPercentage
DeltaReservationMinuint16
DescriptionstringDeltaReservationMin is a number between 1 (1%) and a 100 (100%) that specifies the minimum amount of space that should be reserved in a replica for caching changes. For a complete copy this would be 100%, but it can be lower in some implementations. This parameter sets the lower limit, while DeltaReservationMax sets the upper limit.
MaxValuesint64100
MinValuesint640
ModelCorrespondencestringCIM_StorageCapabilities.DeltaReservationMax, CIM_StorageCapabilities.DeltaReservationDefault
PUnitstringpercent
UnitsstringPercentage
ElementTypeuint16
DescriptionstringEnumeration indicating the type of element to which this StorageCapabilities applies.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8
ValuesstringUnknown, Reserved, Any Type, StorageVolume, StorageExtent, StoragePool, StorageConfigurationService, LogicalDisk, StorageTier
Encryptionuint16
DescriptionstringThis property reflects support of the encryption feature implemented by some disk drives.
Experimentalbooleantrue
ValueMapstring0, 1, 2
ValuesstringUnknown, Not Supported, Supported
ExtentStripeLengthDefaultuint16
DescriptionstringExtent Stripe Length describes the number of underlying StorageExtents across which data is striped in the common striping-based storage organizations. This is also known as the number of 'members' or 'columns'. A NULL value for ExtentStripeLengthDefault indicates that the system does not support configuration of storage by specifying Stripe Length. If Extent Stripe Length is supported, and this Capabilities instance is associated with a pool that was created with a range of QOS then ExtentStripeLengthDefault represents the default value. Other available values(such as min, max, and discrete values) can be determined by using the 'GetSupportedStripeLengths' and 'GetSupportedStripeLengthRange' methods. If Extent Stripe Length is supported and the pool was created with a single specific QOS, representing a Raid group, set, or rank, then this property represents the current/fixed value for the pool, and Extent Stripe Length is not supported in subsequent creation of elements from this pool. Consequently, the 'GetSupportedStripeLength' methods cannot be used, and in a StorageSetting instance used as a goal when creating or modifying a child element of the pool, ExtentStripeLengthGoal, ExtentStripeLengthMin, and ExtentStripeLengthMax MUST be set to NULL.
MinValuesint641
NoSinglePointOfFailureboolean
DescriptionstringIndicates whether or not the associated element supports no single point of failure. Values are: FALSE = does not support no single point of failure, and TRUE = supports no single point of failure.
ModelCorrespondencestringCIM_StorageCapabilities.NoSinglePointOfFailureDefault
NoSinglePointOfFailureDefaultboolean
DescriptionstringIndicates the default value for the NoSinglePointOfFailure property.
ModelCorrespondencestringCIM_StorageCapabilities.NoSinglePointOfFailure
PackageRedundancyDefaultuint16
DescriptionstringPackageRedundancyDefault describes the default number of redundant packages that will be used. For example, in the storage domain, package redundancy describes how many disk spindles can fail without data loss including, at most, one spare. An example would be RAID5 with a spare disk which would have a PackageRedundancy of 2. Possible values are 0 to n. The bounds for redundancy are specified using the properties, PackageRedundancyMax and PackageRedundancyMin.
ModelCorrespondencestringCIM_StorageCapabilities.PackageRedundancyMin, CIM_StorageCapabilities.PackageRedundancyMax
PackageRedundancyMaxuint16
DescriptionstringPackageRedundancyMax describes the maximum number of redundant packages that can be used. For example, in the storage domain, package redundancy describes how many disk spindles can fail without data loss including, at most, one spare. An example would be RAID5 with a spare disk which would have a PackageRedundancy of 2. Possible values are 0 to n. The default redundancy is specified using PackageRedundancyDefault, while the maximum is defined by PackageRedundancyMax.
ModelCorrespondencestringCIM_StorageCapabilities.PackageRedundancyMin, CIM_StorageCapabilities.PackageRedundancyDefault
PackageRedundancyMinuint16
DescriptionstringPackageRedundancyMin describes the minimum number of redundant packages that can be used. For example, in the storage domain, package redundancy describes how many disk spindles can fail without data loss including, at most, one spare. An example would be RAID5 with a spare disk which would have a PackageRedundancy of 2. Possible values are 0 to n. The default redundancy is specified using PackageRedundancyDefault, while the minimum is defined by PackageRedundancyMin.
ModelCorrespondencestringCIM_StorageCapabilities.PackageRedundancyMax, CIM_StorageCapabilities.PackageRedundancyDefault
ParityLayoutDefaultuint16
DescriptionstringParityLayout specifies whether a parity-based storage organization is using rotated or non-rotated parity. If this capabilities instance is associated with a pool that was created with a range of QOS then ParityLayoutDefault represents the default value. Other available values can be determined by using the 'GetSupportedParityLayouts' method. If the pool was created with a single specific QOS, representing a Raid group, set, or rank, then this property represents the current/fixed value for the pool, and ParityLayout is not supported in subsequent creation of elements from this pool. Consequently, the 'GetSupportedParityLayouts' method cannot be used, and the ParityLayoutGoal property in StorageSetting instances used in child element operations on this pool MUST be set to NULL. A NULL value for ParityLayoutDefault indicates that the system does not support configuration of storage by specifying ParityLayout.
ValueMapstring2, 3
ValuesstringNon-Rotated Parity, Rotated Parity
UserDataStripeDepthDefaultuint64
DescriptionstringUser Data Stripe Depth describes the number of bytes forming a strip in common striping-based storage organizations. The strip is defined as the size of the portion of a stripe that lies on one extent. Thus, ExtentStripeLength * UserDataStripeDepth will yield the size of one stripe of user data. A NULL value for UserDataStripeDepthDefault indicates that the system does not support configuration of storage by specifying Stripe Depth. If User Data Stripe Depth is supported, and this Capabilities instance is associated with a pool that was created with a range of QOS then UserDataStripeDepthDefault represents the default value. Other available values(such as min, max, and discrete values) can be determined by using the 'GetSupportedStripeDepths' and 'GetSupportedStripeDepthRange' methods. If User Data Stripe Depth is supported and the pool was created with a single specific QOS, representing a Raid group, set, or rank, then this property represents the current/fixed value for the pool, and User Data Stripe Depth is not supported in subsequent creation of elements from this pool. Consequently, the 'GetSupportedStripeDepth' methods cannot be used, and in a StorageSetting instance used as a goal when creating or modifying a child element of the pool, UserDataStripeDepthGoal, UserDataStripeDepthMin, and UserDataStripeDepthMax MUST be set to NULL.
MinValuesint641
PUnitstringbyte
UnitsstringBytes
AvailableDiskTypeuint16[]
DescriptionstringEnumeration indicating the type of DiskDrives which may be available.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3
ValuesstringUnknown, Other, Hard Disk Drive, Solid State Drive
AvailableFormFactorTypeuint16[]
DescriptionstringEnumeration indicating the types of disk form factors which may be available.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, 6
ValuesstringUnknown, Other, Not Reported, 5.25 inch, 3.5 inch, 2.5 inch, 1.8 inch
AvailablePortTypeuint16[]
DescriptionstringEnumeration indicating the type of disk interfaces which may be available.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5
ValuesstringUnknown, other, SAS, SATA, SAS/SATA, FC
SupportedDataOrganizationsuint16[]
DescriptionstringTypes of volume data organizations supported.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4
ValuesstringOther, Unknown, Fixed Block, Variable Block, Count Key Data

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
DescriptionstringCIM_ManagedElement
ElementNamestringCIM_Capabilities
Generationuint64CIM_ManagedElement
InstanceIDstringCIM_Capabilities

Class Methods

Local Class Methods

CreateSetting (uint32)

Method Qualifiers (CreateSetting)

NameData TypeValue
DescriptionstringMethod to create and populate a StorageSetting instance from a StorageCapability instance. This removes the need to populate default settings and other settings in the context of each StorageCapabilities (which could be numerous). If the underlying instrumentation supports the StorageSettingWithHints subclass, then an instance of that class will be created instead.
ValueMapstring0, 1, 2, 3, 4, 5, .., 32768..65535
ValuesstringSuccess, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, Vendor Specific

Method Parameters (CreateSetting)

NameTypeQualifiers
NameData TypeValue
SettingTypeuint16
DescriptionstringIf 'Default' is passed for the CreateDefault parameter, the Max, Goal, and Min setting attributes are set to the Default values of the parent StorageCapabilities when the instance is created. If set to 'Goal' the new StorageSetting attributes are set to the related attributes of the parent StorageCapabilities, e.g. Min to Min, Goal to Default, and Max to Max. This method maybe deprecated in lieu of intrinsics once limitations in the CIM Operations are addressed.
INbooleantrue
ValueMapstring2, 3
ValuesstringDefault, Goal
NewSetting REF CIM_StorageSetting
DescriptionstringReference to the created StorageSetting instance.
INbooleanfalse
OUTbooleantrue

GetSupportedStripeLengths (uint32)

Method Qualifiers (GetSupportedStripeLengths)

NameData TypeValue
DescriptionstringFor systems that support discrete ExtentStripeLengths for volume or pool creation, this method can be used to retrieve a list of supported values. Note that different implementations may support either the GetSupportedStripeLengths or the GetSupportedStripeLengthRange method. Also note that the advertised sizes may change after the call due to requests from other clients. If the system only supports a range of sizes, then the return value will be set to 3.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3
ValuesstringMethod completed OK, Method not supported, Choices not available for this Capability, Use GetSupportedStripeLengthRange instead

Method Parameters (GetSupportedStripeLengths)

NameTypeQualifiers
NameData TypeValue
StripeLengthsuint16[]
ArrayTypestringIndexed
DescriptionstringList of supported ExtentStripeLengths for a Volume/Pool creation or modification.
INbooleanfalse
OUTbooleantrue

GetSupportedStripeLengthRange (uint32)

Method Qualifiers (GetSupportedStripeLengthRange)

NameData TypeValue
DescriptionstringFor systems that support a range of ExtentStripeLengths for volume or pool creation, this method can be used to retrieve the supported range. Note that different implementations may support either the GetSupportedExtentLengths or the GetSupportedExtentLengthRange method. Also note that the advertised sizes may change after the call due to requests from other clients. If the system only supports discrete values, then the return value will be set to 3.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3
ValuesstringMethod completed OK, Method not supported, Choices not available for this Capability, Use GetSupportedStripeLengths instead

Method Parameters (GetSupportedStripeLengthRange)

NameTypeQualifiers
NameData TypeValue
MaximumStripeLengthuint16
DescriptionstringThe maximum ExtentStripeLength for a volume/pool in bytes.
INbooleanfalse
OUTbooleantrue
MinimumStripeLengthuint16
DescriptionstringThe minimum ExtentStripeDepth for a volume/pool in bytes.
INbooleanfalse
OUTbooleantrue
StripeLengthDivisoruint32
DescriptionstringA volume/pool ExtentStripeLength must be a multiple of this value which is specified in bytes.
INbooleanfalse
OUTbooleantrue

GetSupportedParityLayouts (uint32)

Method Qualifiers (GetSupportedParityLayouts)

NameData TypeValue
DescriptionstringFor systems that support Parity-based storage organizations for volume or pool creation, this method can be used to the supported parity layouts.
ValueMapstring0, 1, 2
ValuesstringMethod completed OK, Method not supported, Choice not aavailable for this capability

Method Parameters (GetSupportedParityLayouts)

NameTypeQualifiers
NameData TypeValue
ParityLayoutuint16[]
ArrayTypestringIndexed
DescriptionstringList of supported Parity for a Volume/Pool creation or modification.
INbooleanfalse
OUTbooleantrue
ValueMapstring2, 3
ValuesstringNon-Rotated Parity, Rotated Parity

GetSupportedStripeDepths (uint32)

Method Qualifiers (GetSupportedStripeDepths)

NameData TypeValue
DescriptionstringFor systems that support discrete UserDataStripeDepths for volume or pool creation, this method can be used to retrieve a list of supported values. Note that different implementations may support either the GetSupportedStripeDepths or the GetSupportedStripeDepthRange method. If the system only supports a range of sizes, then the return value will be set to 2.
Experimentalbooleantrue
ValueMapstring0, 1, 2
ValuesstringMethod completed OK, Method not supported, Use GetSupportedStripeDepthRange instead

Method Parameters (GetSupportedStripeDepths)

NameTypeQualifiers
NameData TypeValue
StripeDepthsuint64[]
ArrayTypestringIndexed
DescriptionstringList of supported UserDataStripeDepths for a Volume/Pool creation or modification.
INbooleanfalse
OUTbooleantrue
PUnitstringbyte
UnitsstringBytes

GetSupportedStripeDepthRange (uint32)

Method Qualifiers (GetSupportedStripeDepthRange)

NameData TypeValue
DescriptionstringFor systems that support a range of UserDataStripeDepths for volume or pool creation, this method can be used to retrieve the supported range. Note that different implementations may support either the GetSupportedStripeDepths or the GetSupportedStripeDepthRange method. If the system only supports discrete values, then the return value will be set to 2.
Experimentalbooleantrue
ValueMapstring0, 1, 2
ValuesstringMethod completed OK, Method not supported, Use GetSupportedStripeDepths instead

Method Parameters (GetSupportedStripeDepthRange)

NameTypeQualifiers
NameData TypeValue
MaximumStripeDepthuint64
DescriptionstringThe maximum UserDataStripeDepth for a volume/pool in bytes.
INbooleanfalse
OUTbooleantrue
PUnitstringbyte
UnitsstringBytes
MinimumStripeDepthuint64
DescriptionstringThe minimum UserDataStripeDepth for a volume/pool in bytes.
INbooleanfalse
OUTbooleantrue
PUnitstringbyte
UnitsstringBytes
StripeDepthDivisoruint64
DescriptionstringA volume/pool UserDataStripeDepth must be a multiple of this value which is specified in bytes.
INbooleanfalse
OUTbooleantrue
PUnitstringbyte
UnitsstringBytes

Inherited Class Methods

NameReturn TypeClass Origin
CreateGoalSettingsuint16CIM_Capabilities