# Class CIM_StoragePool
extends CIM_ResourcePool

A StoragePool is a conglomeration of storage capacity for the purpose of assignment and allocation based on service characteristics, such as location, available space or other criteria (for example, cost per megabyte or hardware ownership). A StoragePool 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, StorageVolumes and LogicalDisks may be created from StoragePools. This is indicated by the AllocatedFromStoragePool association. StoragePool is scoped to a system by the HostedStoragePool association.

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

## Class Hierarchy

CIM_ManagedElement
|
+--CIM_ManagedSystemElement
|
+--CIM_LogicalElement
|
+--CIM_ResourcePool
|
+--CIM_StoragePool

## Direct Known Subclasses

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | A StoragePool is a conglomeration of storage capacity for the purpose of assignment and allocation based on service characteristics, such as location, available space or other criteria (for example, cost per megabyte or hardware ownership). A StoragePool 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, StorageVolumes and LogicalDisks may be created from StoragePools. This is indicated by the AllocatedFromStoragePool association. StoragePool is scoped to a system by the HostedStoragePool association.
UMLPackagePath | string | CIM::Device::StorageServices
Version | string | 2.49.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
CapacityInMigratingSource | uint64 |
Description | string | The total capacity of extents in migrating out from this storage pool
Units | string | Bytes
CapacityInMigratingTarget | uint64 |
Description | string | The total capacity of extents in migrating into this storage pool
Units | string | Bytes
ElementsShareSpace | boolean | false
Description | string | If true, it indicates elements allocated from the storage pool are sharing space from the storage pool. For example, multiple snapshots "allocated" from a storage pool, point to the same blocks of the storage pool. As another example, elements utilizing de-duplication technology refer to a shared copy of the data stored in the storage pool.
InstanceID | string |
Description | string | Within 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'.
Key | boolean | true
Override | string | InstanceID
LowSpaceWarningThreshold | uint16 |
Description | string | LowSpaceWarningThreshold simplifies the creation of a pool specific Indication based on RemainingManagedSpace <= (TotalManagedSpace*LowSpaceWarningThreshold)/100. One example client for an Indication based on this property is a delta copy implementation where the pool enables continuous, variable space consumption for the delta storage. Another example client for an Indication based on this property is a provisioning manager implementing a policy for adding storage to a pool when it becomes low.
MaxValue | sint64 | 100
MinValue | sint64 | 0
ModelCorrespondence | string | CIM_StoragePool.RemainingManagedSpace
PUnit | string | percent
Units | string | Percentage
OtherUsageDescription | string |
Description | string | Populated when "Usage" has the value of "Other".
ModelCorrespondence | string | CIM_StoragePool.Usage
PoolID | string |
Description | string | A unique name in the context of the System that identifies this pool.
MaxLen | uint32 | 256
ModelCorrespondence | string | CIM_ResourceAllocationSettingData.PoolId
Override | string | PoolID
Required | boolean | true
Primordial | boolean | false
Description | string | If true, "Primordial" indicates that this StoragePool is the base from which storage capacity is drawn and returned in the activity of storage management. Being primordial means that this StoragePool shall not be created or deleted by consumers of this model. However, other actions, modeled or not, may affect the characteristics or size of primordial StoragePools. If false, "Primordial" indicated that the StoragePool, a concrete Storage Pool, is subject to storage services functions. This distinction 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.
Override | string | Primordial
RemainingManagedSpace | uint64 |
Description | string | The remaining usable capacity after the allocation of StorageVolumes, LogicalDisks, or child Storage Pools. 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 capacity consumed by a particular allocated element.
ModelCorrespondence | string | CIM_StoragePool.TotalManagedSpace, CIM_AllocatedFromStoragePool.SpaceConsumed
PUnit | string | byte
Required | boolean | true
Units | string | Bytes
ReservedSpace | uint64 |
Description | string | The amount of capacity used by the storage pool to store information about the configuration of the storage pool. The space is not included in the TotalManagedSpace of the storage pool.
ModelCorrespondence | string | CIM_StoragePool.TotalManagedSpace
PUnit | string | byte
Units | string | Bytes
SpaceLimit | uint64 |
Description | string | The capacity of the storage allocated to the pool when SpaceLimitDetermination has the value 3 (Quota) or 4 (Limitless) or is set to the value of TotalManagedSpace if SpaceLimitDetermination has the value 2 (Allocated).
PUnit | string | byte
Units | string | Bytes
SpaceLimitDetermination | uint16 |
Description | string | This property is the Subsystem ID if the array or virtualizer supports Subsystem IDs. If they are supported they would be required on volume creation.
ValueMap | string | 2, 3, 4
Values | string | Allocated, Quote, Limitless
ThinProvisionMetaDataSpace | uint64 |
Description | string | The size of metadata consumed by this storage pool. Only defined if the pool is thin provisioned.
PUnit | string | byte
Units | string | Bytes
TotalManagedSpace | uint64 |
Description | string | The total amount of capacity usable for the allocation of StorageVolumes, LogicalDisks, or child Storage Pools. For primordial Storage Pools, this capacity reflects the usable capacity of Disk Drives or LUNs, for example, to the owning storage device or application. For example, in storage array, a primordial Storage Pool's TotalManagedSpace does not include metadata such as the disk label area and absolute disk drive capacity lost in disk formatting. For concrete Storage Pools, the same applies, but the metadata not included in TotalManagedSpace is consumed in virtualization like RAID and concatenation. Concrete Storage Pool may also be simple reserve of capacity. In such a case, no capacity may be lost in formation of the Storage Pool. Conceptually TotalManagedSpace is the sum of all storage known via AssociatedComponentExtent associations to underlying StorageExtents. However, note some of these underlying storage may not be modeled by the instrumentation.
ModelCorrespondence | string | CIM_StoragePool.RemainingManagedSpace
PUnit | string | byte
Units | string | Bytes
Usage | uint16 |
Description | string | Indicates the intended usage or any restrictions that may have been imposed on the usage of this component. For example, a storage pool may be reserved for use by the block server. In that case the Usage of the storage pool is marked as "Reserved for the ComputerSystem". In the case of "Other", see OtherUsageDescription for more information.
ModelCorrespondence | string | CIM_StoragePool.OtherUsageDescription
ValueMap | string | 1, 2, 3, 4, 5, 6, 7, 8, .., 32768..65535
Values | string | Other, Unrestricted, Reserved for ComputerSystem (the block server), Reserved as a Delta Replica Container, Reserved for Migration Services, Reserved for Local Replication Services, Reserved for Remote Replication Services, Reserved for Sparing, DMTF Reserved, Vendor Reserved
ClientSettableUsage | uint16[] |
Description | string | Indicates which values from the "Usage" valuemap can be manipulated by a client using the method "StorageConfigurationService.RequestUsageChange".
ModelCorrespondence | string | CIM_StoragePool.Usage

### Inherited Properties

Name | Data Type
--- | ---
AllocationUnits | string
Capacity | uint64
Caption | string
CommunicationStatus | uint16
ConsumedResourceUnits | string
CurrentlyConsumedResource | uint64
Description | string
DetailedStatus | uint16
ElementName | string
Generation | uint64
HealthState | uint16
InstallDate | datetime
MaxConsumableResource | uint64
Name | string
OperatingStatus | uint16
OtherResourceType | string
PrimaryStatus | uint16
Reserved | uint64
ResourceSubType | string
ResourceType | uint16
Status | string
OperationalStatus | uint16[]
StatusDescriptions | string[]

## Class Methods