IndexTree
SubclassesReferenced ByPropertiesMethods

CIM_StoragePool

Superclasses

Subclasses

IBMTSESS_PrimordialStoragePool,IBMTSESS_VolumeSpace

Referenced By

CIM_AllocatedFromStoragePool, CIM_HostedStoragePool

Description

A 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.

Properties

IdTypeRangeDescription
Keys
InstanceIDstring-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: \n<OrgID>:<LocalID> \nWhere <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>. \n<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. \nForDMTFdefined instances, the 'preferred' algorithm MUST be used with the <OrgID> set to 'CIM'.  
Read only
PoolIDstringMax = 256A unique name in the context of the System that identifies this pool.  
Primordialboolean-If 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.  
TotalManagedSpaceuint64-The 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. \nConceptually 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.  
RemainingManagedSpaceuint64-The 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.  
InstallDatedatetime-A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.  
NamestringMax = 1024The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.  
OperationalStatusuint16[ ]Unknown
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
Indicates 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. \n\"Stressed\" indicates that the element is functioning, but needs attention. Examples of \"Stressed\" states are overload, overheated, etc. \n\"Predictive Failure\" indicates that an element is functioning nominally but predicting a failure in the near future. \n\"In Service\" describes an element being configured, maintained, cleaned, or otherwise administered. \n\"No Contact\" indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it. \n\"Lost Communication\" indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable. \n\"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. \n\"Dormant\" indicates that the element is inactive or quiesced. \n\"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. \n\"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. \n\"Power Mode\" indicates the element has additional power model information contained in the Associated PowerManagementService association. \nOperationalStatus 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.  
StatusDescriptionsstring[ ]-Strings 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.  
StatusstringOK
Error
Degraded
Unknown
Pred Fail
Starting
Stopping
Service
Stressed
NonRecover
No Contact
Lost Comm
Stopped
A 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.  
CaptionstringMax = 64The Caption property is a short textual description (one- line string) of the object.  
Descriptionstring-The Description property provides a textual description of the object.  
ElementNamestring-A 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. \nNote 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.  

Method Summary

NameDescription
GetSupportedSizesFor pools that support discrete sizes for volume or pool creation, this method can be used to retrieve a list of supported sizes.
GetSupportedSizeRangeFor pools that that support a range of sizes for volume or pool creation, this method can be used to retrieve the supported range.

Method Detail


GetSupportedSizes

StaticFor 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.

Parameters

IdTypeRangeDescription
In
ElementTypeuint16Storage Pool
Storage Volume
The type of element for which supported sizes are reported for.  
Return CodesId
Method completed OK0
Method not supported1
Use GetSupportedSizeRange instead2

GetSupportedSizeRange

StaticFor 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.

Parameters

IdTypeRangeDescription
In
ElementTypeuint16Storage Pool
Storage Volume
The type of element for which supported size ranges are reported for.  
MinimumVolumeSizeuint64-The minimum size for a volume/pool in bytes.  
MaximumVolumeSizeuint64-The maximum size for a volume/pool in bytes.  
VolumeSizeDivisoruint64-A volume/pool size must be a multiple of this value which is specified in bytes.  
Out
MinimumVolumeSizeuint64-The minimum size for a volume/pool in bytes.  
MaximumVolumeSizeuint64-The maximum size for a volume/pool in bytes.  
VolumeSizeDivisoruint64-A volume/pool size must be a multiple of this value which is specified in bytes.  
Return CodesId
Method completed OK0
Method not supported1
Use GetSupportedSizes instead2