CIM29 Class Declaration
CIM_StoragePool

Table of Contents:
Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary

Class Hierarchy

CIM_StoragePool --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_LogicalElement
NAMECIM_StoragePool

Class Qualifiers

Class CIM_StoragePool Qualifiers
NameTypeValueFrom Class
Versionstring2.8.0 CIM_StoragePool
DescriptionstringA pool of Storage that is managed within the scope of a particular System. StoragePools may consist of component StoragePools or StorageExtents. StorageExtents that belong to the StoragePool have a Component relationship to the StoragePool. StorageExtents/StoragePools that are elements of a pool have their available space aggregated into the pool. StoragePools and StorageVolumes may be created from StoragePools. This is indicated by the AllocatedFromStoragePool association. StoragePool is scoped to a system by the HostedStoragePool association. CIM_StoragePool
DescriptionstringCIM_LogicalElement is a base class for all the components of a System that represent abstract system components, such as Files, Processes, or LogicalDevices. CIM_LogicalElement
DescriptionstringCIM_ManagedSystemElement is the base class for the System Element hierarchy. Any distinguishable component of a System is a candidate for inclusion in this class. Examples of system components include: - software components such as application servers, databases, and applications - operating system components such as files, processes, and threads - device components such as disk drives, controllers, processors, and printers - physical components such as chips and cards. CIM_ManagedSystemElement
DescriptionstringManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema. CIM_ManagedElement

Properties

Properties
NameTypeValueQualifiersClassOrigin
InstanceIDstring Key
Description
CIM_StoragePool
PoolIDstring Required
Description
MaxLen
CIM_StoragePool
Primordialbooleanfalse Description CIM_StoragePool
TotalManagedSpaceuint64 Description
Units
ModelCorrespondence
CIM_StoragePool
RemainingManagedSpaceuint64 Required
Description
Units
ModelCorrespondence
CIM_StoragePool
InstallDatedatetime Description
MappingStrings
CIM_ManagedSystemElement
Namestring Description
MaxLen
CIM_ManagedSystemElement
OperationalStatusuint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
StatusDescriptionsstring[] Description
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
Statusstring Deprecated
Description
ValueMap
MaxLen
CIM_ManagedSystemElement
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement
ElementNamestring Description CIM_ManagedElement

Property Qualifiers

Property InstanceID Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_StoragePool
DescriptionstringWithin the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of InstanceID SHOULD be constructed using the following ’ preferred ’ algorithm: < OrgID > : < LocalID > Where < OrgID > and < LocalID > are separated by a colon ’ : ’ , and where < OrgID > MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority (This is similar to the < Schema Name > _ < Class Name > structure of Schema class names.) In addition, to ensure uniqueness < OrgID > MUST NOT contain a colon ( ’ : ’ ). When using this algorithm, the first colon to appear in InstanceID MUST appear between < OrgID > and < LocalID > . < LocalID > is chosen by the business entity and SHOULD not be re-used to identify different underlying (real-world) elements. If the above ’ preferred ’ algorithm is not used, the defining entity MUST assure that the resultant InstanceID is not re-used across any InstanceIDs produced by this or other providers for this instance ’ s NameSpace. For DMTF defined instances, the ’ preferred ’ algorithm MUST be used with the < OrgID > set to ’ CIM ’ . CIM_StoragePool

Property PoolID Qualifiers
NameTypeValueFrom Class
Requiredbooleantrue CIM_StoragePool
DescriptionstringA unique name in the context of the System that identifies this pool. CIM_StoragePool
MaxLenuint32256 CIM_StoragePool

Property Primordial Qualifiers
NameTypeValueFrom Class
DescriptionstringIf true, " Primordial " indicates that the containing System does not have the ability to create or delete this operational element. This is important because higher-level StoragePools may be assembled using the Component or AllocatedFromStoragePool associations. Although the higher-level abstractions can be created and deleted, the most basic, (i.e. primordial), hardware-based StoragePools 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. CIM_StoragePool

Property TotalManagedSpace Qualifiers
NameTypeValueFrom Class
DescriptionstringThe total amount of raw storage (in bytes) managed by this StoragePool. This includes all of the bytes consumed to create the storage surfaced by this StoragePool, including all of the overhead bytes that are not reflected in the size of the logical storage allocated from this StoragePool. Conceptually TotalManagedSpace reflects all storage known via Component associations to underlying StorageExtents or via AllocatedFromStoragePool associations to underlying StoragePools. However, note that this underlying storage may not be surfaced by the instrumentation. CIM_StoragePool
UnitsstringBytes CIM_StoragePool
ModelCorrespondencestringCIM_StoragePool.RemainingManagedSpace CIM_StoragePool

Property RemainingManagedSpace Qualifiers
NameTypeValueFrom Class
Requiredbooleantrue CIM_StoragePool
DescriptionstringThe remaining amount of raw storage (in bytes) from the TotalManagedSpace of this StoragePool. This property is maintained here to provide efficient access to this information. However, note that it is possible to compute RemainingManagedSpace as (TotalManagedSpace minus the sum of SpaceConsumed from all of the AllocatedFromStoragePool references from this StoragePool). Note that SpaceConsumed remains useful to determine the amount of raw storage consumed by a particular allocated element. CIM_StoragePool
UnitsstringBytes CIM_StoragePool
ModelCorrespondencestringCIM_StoragePool.TotalManagedSpace
CIM_AllocatedFromStoragePool.SpaceConsumed
CIM_StoragePool

Property InstallDate Qualifiers
NameTypeValueFrom Class
DescriptionstringA datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. CIM_ManagedSystemElement
MappingStringsstringMIF.DMTF|ComponentID|001.5 CIM_ManagedSystemElement

Property Name Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property. CIM_ManagedSystemElement
MaxLenuint321024 CIM_ManagedSystemElement

Property OperationalStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates the current status(es) of the element. Various health and operational statuses are defined. Many of the enumeration ’ s values are self- explanatory. However, a few are not and are described in more detail. " Stressed " indicates that the element is functioning, but needs attention. Examples of " Stressed " states are overload, overheated, etc. " Predictive Failure " indicates that an element is functioning nominally but predicting a failure in the near future. " In Service " describes an element being configured, maintained, cleaned, or otherwise administered. " No Contact " indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it. " Lost Communication " indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable. " Stopped " and " Aborted " are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the element ’ s state and configuration may need to be updated. " Dormant " indicates that the element is inactive or quiesced. " Supporting Entity in Error " describes that this element may be " OK " but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower layer networking problems. " Completed " indicates the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded would imply the operation finished, but did not complete OK or report an error. " Power Mode " indicates the element has additional power model information contained in the Associated PowerManagementService association. OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today ’ s environment to the future. This change was not made earlier since it required the DEPRECATED qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly RECOMMENDED that providers/instrumentation provide BOTH the Status and OperationalStatus properties. Further, the first value of OperationalStatus SHOULD contain the primary status for the element. When instrumented, Status (since it is single-valued) SHOULD also provide the primary status of the element. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
Other
OK
Degraded
Stressed
Predictive Failure
Error
Non-Recoverable Error
Starting
Stopping
Stopped
In Service
No Contact
Lost Communication
Aborted
Dormant
Supporting Entity in Error
Completed
Power Mode
DMTF Reserved
Vendor Reserved
CIM_ManagedSystemElement
ArrayTypestringIndexed CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptions CIM_ManagedSystemElement

NameValue
0Unknown
1Other
2OK
3Degraded
4Stressed
5Predictive Failure
6Error
7Non-Recoverable Error
8Starting
9Stopping
10Stopped
11In Service
12No Contact
13Lost Communication
14Aborted
15Dormant
16Supporting Entity in Error
17Completed
18Power Mode
..DMTF Reserved
0x8000..Vendor Reserved
Property StatusDescriptions Qualifiers
NameTypeValueFrom Class
DescriptionstringStrings 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. Note that entries in this array are correlated with those at the same array index in OperationalStatus. CIM_ManagedSystemElement
ArrayTypestringIndexed CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatus CIM_ManagedSystemElement

Property Status Qualifiers
NameTypeValueFrom Class
DescriptionstringA string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons: 1) Status is more correctly defined as an array. This overcomes the limitation of describing status via a single value, when it is really a multi-valued property (for example, an element may be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. And, 3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the Deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
MaxLenuint3210 CIM_ManagedSystemElement

NameValue
OK[none]
Error[none]
Degraded[none]
Unknown[none]
Pred Fail[none]
Starting[none]
Stopping[none]
Service[none]
Stressed[none]
NonRecover[none]
No Contact[none]
Lost Comm[none]
Stopped[none]
Property Caption Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement
MaxLenuint3264 CIM_ManagedElement

Property Description Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Description property provides a textual description of the object. CIM_ManagedElement

Property ElementName Qualifiers
NameTypeValueFrom Class
DescriptionstringA user-friendly name for the object. This property allows each instance to define a user-friendly name IN ADDITION TO its key properties/identity data, and description information. Note that ManagedSystemElement ’ s Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties. CIM_ManagedElement

Methods

NameTypeValueQualifiersParametersClassOrigin
GetSupportedSizesuint32 Description
ValueMap
Values
ElementType
Sizes
CIM_StoragePool
GetSupportedSizeRangeuint32 Description
ValueMap
Values
ElementType
MinimumVolumeSize
MaximumVolumeSize
VolumeSizeDivisor
CIM_StoragePool

Method Qualifiers

Method GetSupportedSizes Qualifiers
NameTypeValueFrom Class
DescriptionstringFor pools that support discrete sizes for volume or pool creation, this method can be used to retrieve a list of supported sizes. Note that different pool implementations may support either or both the GetSupportedSizes and GetSupportedSizeRanges methods at different times, depending on Pool configuration. Also note that the advertised sizes may change after the call due to requests from other clients. If the pool currently only supports a range of sizes, then the return value will be set to 1. CIM_StoragePool
ValueMapstring
[See below.]
CIM_StoragePool
ValuesstringMethod completed OK
Method not supported
Use GetSupportedSizeRange instead
CIM_StoragePool

Method GetSupportedSizeRange Qualifiers
NameTypeValueFrom Class
DescriptionstringFor pools that that support a range of sizes for volume or pool creation, this method can be used to retrieve the supported range. Note that different pool implementations may support either or both the GetSupportedSizes and GetSupportedSizeRanges methods at different times, depending on Pool configuration. Also note that the advertised sizes may change after the call due to requests from other clients. If the pool currently only supports discrete sizes, then the return value will be set to 1. CIM_StoragePool
ValueMapstring
[See below.]
CIM_StoragePool
ValuesstringMethod completed OK
Method not supported
Use GetSupportedSizes instead
CIM_StoragePool

Parameters

Method GetSupportedSizes Parameters
NameTypeQualifiers
ElementTypeuint16IN
Description
ValueMap
Values
Sizesuint64IN
OUT
Description
Units

Method GetSupportedSizeRange Parameters
NameTypeQualifiers
ElementTypeuint16IN
Description
ValueMap
Values
MinimumVolumeSizeuint64IN
OUT
Description
Units
MaximumVolumeSizeuint64IN
OUT
Description
Units
VolumeSizeDivisoruint64IN
OUT
Description
Units

Parameter Qualifiers

Parameter ElementType Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_StoragePool
DescriptionstringThe type of element for which supported sizes are reported for. CIM_StoragePool
ValueMapstring
[See below.]
CIM_StoragePool
ValuesstringStorage Pool
Storage Volume
CIM_StoragePool

Parameter Sizes Qualifiers
NameTypeValueFrom Class
INbooleanfalse CIM_StoragePool
OUTbooleantrue CIM_StoragePool
DescriptionstringList of supported sizes for a Volume/Pool creation or modification. CIM_StoragePool
UnitsstringBytes CIM_StoragePool

Parameter ElementType Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_StoragePool
DescriptionstringThe type of element for which supported size ranges are reported for. CIM_StoragePool
ValueMapstring
[See below.]
CIM_StoragePool
ValuesstringStorage Pool
Storage Volume
CIM_StoragePool

Parameter MinimumVolumeSize Qualifiers
NameTypeValueFrom Class
INbooleanfalse CIM_StoragePool
OUTbooleantrue CIM_StoragePool
DescriptionstringThe minimum size for a volume/pool in bytes. CIM_StoragePool
UnitsstringBytes CIM_StoragePool

Parameter MaximumVolumeSize Qualifiers
NameTypeValueFrom Class
INbooleanfalse CIM_StoragePool
OUTbooleantrue CIM_StoragePool
DescriptionstringThe maximum size for a volume/pool in bytes. CIM_StoragePool
UnitsstringBytes CIM_StoragePool

Parameter VolumeSizeDivisor Qualifiers
NameTypeValueFrom Class
INbooleanfalse CIM_StoragePool
OUTbooleantrue CIM_StoragePool
DescriptionstringA volume/pool size must be a multiple of this value which is specified in bytes. CIM_StoragePool
UnitsstringBytes CIM_StoragePool

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_AllocatedFromStoragePoolCIM_StoragePoolAntecedent
CIM_HostedStoragePoolCIM_StoragePoolPartComponent
CIM_ResidesOnExtentCIM_LogicalElementDependent
CIM_OperationLogCIM_LogicalElementDependent
CIM_LogicalElementUnitOfWorkDefCIM_LogicalElementAntecedent
CIM_LogicalElementPerformsUoWCIM_LogicalElementAntecedent
CIM_AllocatedFromStoragePoolCIM_LogicalElementDependent
CIM_AssociatedMemoryCIM_LogicalElementDependent
CIM_DiagnosticTestForMSECIM_ManagedSystemElementDependent
CIM_UseOfLogCIM_ManagedSystemElementDependent
CIM_SystemComponentCIM_ManagedSystemElementPartComponent
CIM_RedundancyComponentCIM_ManagedSystemElementPartComponent
CIM_CollectedMSEsCIM_ManagedSystemElementMember
CIM_ActsAsSpareCIM_ManagedSystemElementSpare
CIM_ElementSettingCIM_ManagedSystemElementElement
CIM_ElementConfigurationCIM_ManagedSystemElementElement
CIM_DiagnosticResultForMSECIM_ManagedSystemElementSystemElement
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_StatisticsCIM_ManagedElementElement
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement