Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary
CIM_StoragePool --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]
Class Declaration Attributes Name Value SUPERCLASS CIM_LogicalElement NAME CIM_StoragePool
Class CIM_StoragePool Qualifiers Name Type Value From Class Version string 2.8.0 CIM_StoragePool Description string 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. CIM_StoragePool Description string CIM_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 Description string CIM_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 Description string ManagedElement 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 Name Type Value Qualifiers ClassOrigin InstanceID string Key
DescriptionCIM_StoragePool PoolID string Required
Description
MaxLenCIM_StoragePool Primordial boolean false Description CIM_StoragePool TotalManagedSpace uint64 Description
Units
ModelCorrespondenceCIM_StoragePool RemainingManagedSpace uint64 Required
Description
Units
ModelCorrespondenceCIM_StoragePool InstallDate datetime Description
MappingStringsCIM_ManagedSystemElement Name string Description
MaxLenCIM_ManagedSystemElement OperationalStatus uint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondenceCIM_ManagedSystemElement StatusDescriptions string[] Description
ArrayType
ModelCorrespondenceCIM_ManagedSystemElement Status string Deprecated
Description
ValueMap
MaxLenCIM_ManagedSystemElement Caption string Description
MaxLenCIM_ManagedElement Description string Description CIM_ManagedElement ElementName string Description CIM_ManagedElement Property Qualifiers
Property InstanceID Qualifiers Name Type Value From Class Key boolean true CIM_StoragePool 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 ’ . CIM_StoragePool
Property PoolID Qualifiers Name Type Value From Class Required boolean true CIM_StoragePool Description string A unique name in the context of the System that identifies this pool. CIM_StoragePool MaxLen uint32 256 CIM_StoragePool
Property Primordial Qualifiers Name Type Value From Class Description string 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. CIM_StoragePool
Property TotalManagedSpace Qualifiers Name Type Value From Class Description string 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. 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 Units string Bytes CIM_StoragePool ModelCorrespondence string CIM_StoragePool.RemainingManagedSpace CIM_StoragePool
Property RemainingManagedSpace Qualifiers Name Type Value From Class Required boolean true CIM_StoragePool Description string 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. CIM_StoragePool Units string Bytes CIM_StoragePool ModelCorrespondence string CIM_StoragePool.TotalManagedSpace
CIM_AllocatedFromStoragePool.SpaceConsumedCIM_StoragePool
Property InstallDate Qualifiers Name Type Value From Class Description string A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. CIM_ManagedSystemElement MappingStrings string MIF.DMTF|ComponentID|001.5 CIM_ManagedSystemElement
Property Name Qualifiers Name Type Value From Class Description string The 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 MaxLen uint32 1024 CIM_ManagedSystemElement
Property OperationalStatus Qualifiers Name Type Value From Class Description string 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. " 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 ValueMap string [See below.] CIM_ManagedSystemElement Values string 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 ReservedCIM_ManagedSystemElement ArrayType string Indexed CIM_ManagedSystemElement ModelCorrespondence string CIM_ManagedSystemElement.StatusDescriptions CIM_ManagedSystemElement
Name Value 0 Unknown 1 Other 2 OK 3 Degraded 4 Stressed 5 Predictive Failure 6 Error 7 Non-Recoverable Error 8 Starting 9 Stopping 10 Stopped 11 In Service 12 No Contact 13 Lost Communication 14 Aborted 15 Dormant 16 Supporting Entity in Error 17 Completed 18 Power Mode .. DMTF Reserved 0x8000.. Vendor Reserved
Property StatusDescriptions Qualifiers Name Type Value From Class Description string 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. CIM_ManagedSystemElement ArrayType string Indexed CIM_ManagedSystemElement ModelCorrespondence string CIM_ManagedSystemElement.OperationalStatus CIM_ManagedSystemElement
Property Status Qualifiers Name Type Value From Class Description string 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. CIM_ManagedSystemElement ValueMap string [See below.] CIM_ManagedSystemElement MaxLen uint32 10 CIM_ManagedSystemElement
Name Value 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 Name Type Value From Class Description string The Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement MaxLen uint32 64 CIM_ManagedElement
Property Description Qualifiers Name Type Value From Class Description string The Description property provides a textual description of the object. CIM_ManagedElement
Property ElementName Qualifiers Name Type Value From Class Description string 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. 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
Name Type Value Qualifiers Parameters ClassOrigin GetSupportedSizes uint32 Description
ValueMap
ValuesElementType
SizesCIM_StoragePool GetSupportedSizeRange uint32 Description
ValueMap
ValuesElementType
MinimumVolumeSize
MaximumVolumeSize
VolumeSizeDivisorCIM_StoragePool Method Qualifiers
Method GetSupportedSizes Qualifiers Name Type Value From Class Description string For 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 ValueMap string [See below.] CIM_StoragePool Values string Method completed OK
Method not supported
Use GetSupportedSizeRange insteadCIM_StoragePool
Method GetSupportedSizeRange Qualifiers Name Type Value From Class Description string For 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 ValueMap string [See below.] CIM_StoragePool Values string Method completed OK
Method not supported
Use GetSupportedSizes insteadCIM_StoragePool Parameters
Method GetSupportedSizes Parameters Name Type Qualifiers ElementType uint16 IN
Description
ValueMap
ValuesSizes uint64 IN
OUT
Description
Units
Method GetSupportedSizeRange Parameters Name Type Qualifiers ElementType uint16 IN
Description
ValueMap
ValuesMinimumVolumeSize uint64 IN
OUT
Description
UnitsMaximumVolumeSize uint64 IN
OUT
Description
UnitsVolumeSizeDivisor uint64 IN
OUT
Description
UnitsParameter Qualifiers
Parameter ElementType Qualifiers Name Type Value From Class IN boolean true CIM_StoragePool Description string The type of element for which supported sizes are reported for. CIM_StoragePool ValueMap string [See below.] CIM_StoragePool Values string Storage Pool
Storage VolumeCIM_StoragePool
Parameter Sizes Qualifiers Name Type Value From Class IN boolean false CIM_StoragePool OUT boolean true CIM_StoragePool Description string List of supported sizes for a Volume/Pool creation or modification. CIM_StoragePool Units string Bytes CIM_StoragePool
Parameter ElementType Qualifiers Name Type Value From Class IN boolean true CIM_StoragePool Description string The type of element for which supported size ranges are reported for. CIM_StoragePool ValueMap string [See below.] CIM_StoragePool Values string Storage Pool
Storage VolumeCIM_StoragePool
Parameter MinimumVolumeSize Qualifiers Name Type Value From Class IN boolean false CIM_StoragePool OUT boolean true CIM_StoragePool Description string The minimum size for a volume/pool in bytes. CIM_StoragePool Units string Bytes CIM_StoragePool
Parameter MaximumVolumeSize Qualifiers Name Type Value From Class IN boolean false CIM_StoragePool OUT boolean true CIM_StoragePool Description string The maximum size for a volume/pool in bytes. CIM_StoragePool Units string Bytes CIM_StoragePool
Parameter VolumeSizeDivisor Qualifiers Name Type Value From Class IN boolean false CIM_StoragePool OUT boolean true CIM_StoragePool Description string A volume/pool size must be a multiple of this value which is specified in bytes. CIM_StoragePool Units string Bytes CIM_StoragePool