CIM2.17.1 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_ResourcePool --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_ResourcePool
NAMECIM_StoragePool

Class Qualifiers

Class CIM_StoragePool Qualifiers
NameTypeValueFrom Class
Versionstring2.15.0CIM_StoragePool
UMLPackagePathstringCIM::Device::StorageServicesCIM_StoragePool
DescriptionstringA 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.CIM_StoragePool
UMLPackagePathstringCIM::Core::ResourceCIM_ResourcePool
DescriptionstringA ResourcePool is a logical entity (with associated controls)provided by the host system for the purpose of allocation and assignment of resources. A given ResourcePool may be used to allocate resources of a specific type. Hierarchies of ResourcePools may be created to provide administrative control over allocations. In the cases where resources are subdivided, multiple resource pools may exist (e.g. nodal boundaries in NUMA-like systems). In systems that support over commitment, pools represent the reservable capacity, not an upper bound or limit on the maximum amount that can be allocated. Admission control during power on may detect and prevent systems from powering due to resource exhaustion. For example, over commitment on a ResourcePool with ResourceType=Memory would require that sufficient space be available in some backing-store, that may be managed through a storage ResourcePool.CIM_ResourcePool
UMLPackagePathstringCIM::Core::CoreElementsCIM_LogicalElement
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
UMLPackagePathstringCIM::Core::CoreElementsCIM_ManagedSystemElement
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
UMLPackagePathstringCIM::Core::CoreElementsCIM_ManagedElement
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
Override
Description
CIM_StoragePool
PoolIDstring Required
Override
Description
MaxLen
ModelCorrespondence
CIM_StoragePool
PrimordialbooleanfalseOverride
Description
CIM_StoragePool
TotalManagedSpaceuint64 Description
Units
ModelCorrespondence
PUnit
CIM_StoragePool
RemainingManagedSpaceuint64 Required
Description
Units
ModelCorrespondence
PUnit
CIM_StoragePool
LowSpaceWarningThresholduint16 Experimental
Description
Units
MinValue
MaxValue
ModelCorrespondence
PUnit
CIM_StoragePool
Usageuint16 Experimental
Description
ValueMap
Values
ModelCorrespondence
CIM_StoragePool
OtherUsageDescriptionstring Experimental
Description
ModelCorrespondence
CIM_StoragePool
ClientSettableUsageuint16[] Experimental
Description
ModelCorrespondence
CIM_StoragePool
Capacityuint64 Description CIM_ResourcePool
Reserveduint64 Description CIM_ResourcePool
ResourceTypeuint16 Description
ValueMap
Values
ModelCorrespondence
CIM_ResourcePool
OtherResourceTypestring Description
ModelCorrespondence
CIM_ResourcePool
ResourceSubTypestring Description
ModelCorrespondence
CIM_ResourcePool
AllocationUnitsstring Description
IsPUnit
CIM_ResourcePool
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
HealthStateuint16 Description
ValueMap
Values
CIM_ManagedSystemElement
PrimaryStatusuint16 Experimental
Description
ValueMap
Values
ModelCorrespondence
CIM_ManagedSystemElement
DetailedStatusuint16 Experimental
Description
ValueMap
Values
ModelCorrespondence
CIM_ManagedSystemElement
OperatingStatusuint16 Experimental
Description
ValueMap
Values
ModelCorrespondence
CIM_ManagedSystemElement
CommunicationStatusuint16 Experimental
Description
ValueMap
Values
CIM_ManagedSystemElement
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement
ElementNamestring Description CIM_ManagedElement

Property Qualifiers

Property InstanceID Qualifiers
NameTypeValueFrom Class
KeybooleantrueCIM_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
RequiredbooleantrueCIM_StoragePool
DescriptionstringA unique name in the context of the System that identifies this pool.CIM_StoragePool
MaxLenuint32256CIM_StoragePool
ModelCorrespondencestringCIM_ResourceAllocationSettingData.PoolIdCIM_StoragePool

Property Primordial Qualifiers
NameTypeValueFrom Class
DescriptionstringIf 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.CIM_StoragePool

Property TotalManagedSpace Qualifiers
NameTypeValueFrom Class
DescriptionstringThe 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.CIM_StoragePool
UnitsstringBytesCIM_StoragePool
ModelCorrespondencestringCIM_StoragePool.RemainingManagedSpaceCIM_StoragePool
PUnitstringbyteCIM_StoragePool

Property RemainingManagedSpace Qualifiers
NameTypeValueFrom Class
RequiredbooleantrueCIM_StoragePool
DescriptionstringThe 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.CIM_StoragePool
UnitsstringBytesCIM_StoragePool
ModelCorrespondencestringCIM_StoragePool.TotalManagedSpace
CIM_AllocatedFromStoragePool.SpaceConsumed
CIM_StoragePool
PUnitstringbyteCIM_StoragePool

Property LowSpaceWarningThreshold Qualifiers
NameTypeValueFrom Class
DescriptionstringLowSpaceWarningThreshold 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.CIM_StoragePool
UnitsstringPercentageCIM_StoragePool
MinValuesint640CIM_StoragePool
MaxValuesint64100CIM_StoragePool
ModelCorrespondencestringCIM_StoragePool.RemainingManagedSpaceCIM_StoragePool
PUnitstringpercentCIM_StoragePool

Property Usage Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates 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.CIM_StoragePool
ValueMapstring
[See below.]
CIM_StoragePool
ValuesstringOther
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
CIM_StoragePool
ModelCorrespondencestringCIM_StoragePool.OtherUsageDescriptionCIM_StoragePool

NameValue
1Other
2Unrestricted
3Reserved for ComputerSystem (the block server)
4Reserved as a Delta Replica Container
5Reserved for Migration Services
6Reserved for Local Replication Services
7Reserved for Remote Replication Services
8Reserved for Sparing
..DMTF Reserved
32768..65535Vendor Reserved
Property OtherUsageDescription Qualifiers
NameTypeValueFrom Class
DescriptionstringPopulated when "Usage" has the value of "Other".CIM_StoragePool
ModelCorrespondencestringCIM_StoragePool.UsageCIM_StoragePool

Property ClientSettableUsage Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates which values from the "Usage" valuemap can be manipulated by a client using the method "StorageConfigurationService.RequestUsageChange".CIM_StoragePool
ModelCorrespondencestringCIM_StoragePool.UsageCIM_StoragePool

Property InstanceID Qualifiers
NameTypeValueFrom Class
KeybooleantrueCIM_ResourcePool
DescriptionstringWithin the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. 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 that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement 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 reused to identify different underlying (real-world) elements. If the above "preferred" algorithm is not used, the defining entity must ensure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF-defined instances, the "preferred" algorithm must be used with the <OrgID> set to CIM.CIM_ResourcePool

Property PoolID Qualifiers
NameTypeValueFrom Class
DescriptionstringAn opaque identifier for the pool. This property is used to provide correlation across save and restore of configuration data to underlying persistent storage.CIM_ResourcePool
ModelCorrespondencestringCIM_ResourceAllocationSettingData.PoolIdCIM_ResourcePool

Property Primordial Qualifiers
NameTypeValueFrom Class
DescriptionstringIf true, "Primordial" indicates that this ResourcePool is a base from which resources are drawn and returned in the activity of resource management. Being primordial means that this ResourcePool 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 ResourcePools. If false, "Primordial" indicates that the ResourcePool, a concrete Resource Pool, is subject to resource allocation services functions. This distinction is important because higher-level ResourcePools may be assembled using the Component or ElementAllocatedFromPool associations. Although the higher-level abstractions can be created and deleted, the most basic, (i.e. primordial), hardware-based ResourcePools 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_ResourcePool

Property Capacity Qualifiers
NameTypeValueFrom Class
DescriptionstringThis property represents the maximum amount (in units of AllocationUnits) of reservations that the ResourcePool can support.CIM_ResourcePool

Property Reserved Qualifiers
NameTypeValueFrom Class
DescriptionstringThis property represents the current reservations (in units of AllocationUnits) spread across all active allocations from this pool. In a hierarchical configuration, this represents the sum of all descendant ResourcePool current reservations.CIM_ResourcePool

Property ResourceType Qualifiers
NameTypeValueFrom Class
DescriptionstringThe type of resource this ResourcePool may allocate.CIM_ResourcePool
ValueMapstring
[See below.]
CIM_ResourcePool
ValuesstringOther
Computer System
Processor
Memory
IDE Controller
Parallel SCSI HBA
FC HBA
iSCSI HBA
IB HCA
Ethernet Adapter
Other Network Adapter
I/O Slot
I/O Device
Floppy Drive
CD Drive
DVD drive
Disk Drive
Tape Drive
Storage Extent
Other storage device
Serial port
Parallel port
USB Controller
Graphics controller
IEEE 1394 Controller
Partitionable Unit
Base Partitionable Unit
Power
Cooling Capacity
Ethernet Switch Port
DMTF reserved
Vendor Reserved
CIM_ResourcePool
ModelCorrespondencestringCIM_ResourcePool.OtherResourceType
CIM_ResourcePool.ResourceSubType
CIM_ResourcePool

NameValue
1Other
2Computer System
3Processor
4Memory
5IDE Controller
6Parallel SCSI HBA
7FC HBA
8iSCSI HBA
9IB HCA
10Ethernet Adapter
11Other Network Adapter
12I/O Slot
13I/O Device
14Floppy Drive
15CD Drive
16DVD drive
17Disk Drive
18Tape Drive
19Storage Extent
20Other storage device
21Serial port
22Parallel port
23USB Controller
24Graphics controller
25IEEE 1394 Controller
26Partitionable Unit
27Base Partitionable Unit
28Power
29Cooling Capacity
30Ethernet Switch Port
..DMTF reserved
0x8000..0xFFFFVendor Reserved
Property OtherResourceType Qualifiers
NameTypeValueFrom Class
DescriptionstringA string that describes the resource type when a well defined value is not available and ResourceType is set to 0 for Other.CIM_ResourcePool
ModelCorrespondencestringCIM_ResourcePool.ResourceTypeCIM_ResourcePool

Property ResourceSubType Qualifiers
NameTypeValueFrom Class
DescriptionstringA string describing an implementation specific sub-type for this pool. For example, this may be used to distinguish different models of the same resource type.CIM_ResourcePool
ModelCorrespondencestringCIM_ResourcePool.ResourceTypeCIM_ResourcePool

Property AllocationUnits Qualifiers
NameTypeValueFrom Class
DescriptionstringThis property specifies the units of allocation used by the Reservation and Limit properties. For example, when ResourceType=Processor, AllocationUnits may be set to hertz*10^6 or percent. When ResourceType=Memory, AllocationUnits may be set to bytes*10^3. The value of this property shall be a legal value of the Programmatic Units qualifier as defined in Appendix C.1 of DSP0004 V2.4 or later.CIM_ResourcePool
IsPUnitbooleantrueCIM_ResourcePool

Property InstallDate Qualifiers
NameTypeValueFrom Class
DescriptionstringA datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed.CIM_ManagedSystemElement
MappingStringsstringMIF.DMTF|ComponentID|001.5CIM_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
MaxLenuint321024CIM_ManagedSystemElement

Property OperationalStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates the current statuses of the element. Various operational statuses are defined. Many of the enumeration's values are self-explanatory. However, a few are not and are described here in more detail. "Stressed" indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, and so on. "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 state and configuration of the element might need to be updated. "Dormant" indicates that the element is inactive or quiesced. "Supporting Entity in Error" indicates that this element might 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 that the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error). "Power Mode" indicates that 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 because it required the deprecated qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly recommended that providers or 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 (because 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
ArrayTypestringIndexedCIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptionsCIM_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
ArrayTypestringIndexedCIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatusCIM_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 definition overcomes the limitation of describing status using a single value, when it is really a multi-valued property (for example, an element might be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. 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
MaxLenuint3210CIM_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 HealthState Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely non-functional. The following continuum is defined: "Non-recoverable Error" (30) - The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost. "Critical Failure" (25) - The element is non-functional and recovery might not be possible. "Major Failure" (20) - The element is failing. It is possible that some or all of the functionality of this component is degraded or not working. "Minor Failure" (15) - All functionality is available but some might be degraded. "Degraded/Warning" (10) - The element is in working order and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element might not be operating at optimal performance or it might be reporting recoverable errors. "OK" (5) - The element is fully functional and is operating within normal operational parameters and without error. "Unknown" (0) - The implementation cannot report on HealthState at this time. DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
OK
Degraded/Warning
Minor failure
Major failure
Critical failure
Non-recoverable error
DMTF Reserved
CIM_ManagedSystemElement

NameValue
0Unknown
5OK
10Degraded/Warning
15Minor failure
20Major failure
25Critical failure
30Non-recoverable error
..DMTF Reserved
Property PrimaryStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringPrimaryStatus provides a high level status value, intended to align with Red-Yellow-Green type representation of status. It should be used in conjunction with DetailedStatus to provide high level and detailed health status of the ManagedElement and its subcomponents. PrimaryStatus consists of one of the following values: Unknown, OK, Degraded or Error. "Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time. "OK" indicates the ManagedElement is functioning normally. "Degraded" indicates the ManagedElement is functioning below normal. "Error" indicates the ManagedElement is in an Error condition.CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
OK
Degraded
Error
DMTF Reserved
Vendor Reserved
CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.DetailedStatus
CIM_ManagedSystemElement.HealthState
CIM_ManagedSystemElement

NameValue
0Unknown
1OK
2Degraded
3Error
..DMTF Reserved
0x8000..Vendor Reserved
Property DetailedStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringDetailedStatus compliments PrimaryStatus with additional status detail. It consists of one of the following values: Not Available, No Additional Information, Stressed, Predictive Failure, Error, Non-Recoverable Error, SupportingEntityInError. Detailed status is used to expand upon the PrimaryStatus of the element. A Null return indicates the implementation (provider) does not implement this property. "Not Available" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property). "No Additional Information" indicates that the element is functioning normally as indicated by PrimaryStatus = "OK". "Stressed" indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, and so on. "Predictive Failure" indicates that an element is functioning normally but a failure is predicted in the near future. "Non-Recoverable Error " indicates that this element is in an error condition that requires human intervention. "Supporting Entity in Error" indicates that this element might 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.CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringNot Available
No Additional Information
Stressed
Predictive Failure
Non-Recoverable Error
Supporting Entity in Error
DMTF Reserved
Vendor Reserved
CIM_ManagedSystemElement
ModelCorrespondencestringCIM_EnabledLogicalElement.PrimaryStatus
CIM_ManagedSystemElement.HealthState
CIM_ManagedSystemElement

NameValue
0Not Available
1No Additional Information
2Stressed
3Predictive Failure
4Non-Recoverable Error
5Supporting Entity in Error
..DMTF Reserved
0x8000..Vendor Reserved
Property OperatingStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringOperatingStatus provides a current status value for the operational condition of the element and can be used for providing more detail with respect to the value of EnabledState. It can also provide the transitional states when an element is transitioning from one state to another, such as when an element is transitioning between EnabledState and RequestedState, as well as other transitional conditions.OperatingStatus consists of one of the following values: Unknown, Not Available, In Service, Starting, Stopping, Stopped, Aborted, Dormant, Completed, Migrating, Emmigrating, Immigrating, Snapshotting. Shutting Down, In Test A Null return indicates the implementation (provider) does not implement this property. "Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time. "None" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property). "Servicing" describes an element being configured, maintained, cleaned, or otherwise administered. "Starting" describes an element being initialized. "Stopping" describes an element being brought to an orderly stop. "Stopped" and "Aborted" are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the state and configuration of the element might need to be updated. "Dormant" indicates that the element is inactive or quiesced. "Completed" indicates that the element has completed its operation. This value should be combined with either OK, Error, or Degraded in the PrimaryStatus so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error). "Migrating" element is being moved between host elements. "Immigrating" element is being moved to new host element. "Emigrating" element is being moved away from host element. "Shutting Down" describes an element being brought to an abrupt stop. "In Test" element is performing test functions. "Transitioning" describes an element that is between states, that is, it is not fully available in either its previous state or its next state. This value should be used if other values indicating a transition to a specific state are not applicable."In Service" describes an element that is in service and operational.CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
Not Available
Servicing
Starting
Stopping
Stopped
Aborted
Dormant
Completed
Migrating
Emigrating
Immigrating
Snapshotting
Shutting Down
In Test
Transitioning
In Service
DMTF Reserved
Vendor Reserved
CIM_ManagedSystemElement
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledStateCIM_ManagedSystemElement

NameValue
0Unknown
1Not Available
2Servicing
3Starting
4Stopping
5Stopped
6Aborted
7Dormant
8Completed
9Migrating
10Emigrating
11Immigrating
12Snapshotting
13Shutting Down
14In Test
15Transitioning
16In Service
..DMTF Reserved
0x8000..Vendor Reserved
Property CommunicationStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringCommunicationStatus indicates the ability of the instrumentation to communicate with the underlying ManagedElement. CommunicationStatus consists of one of the following values: Unknown, None, Communication OK, Lost Communication, or No Contact. A Null return indicates the implementation (provider) does not implement this property. "Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time. "Not Available" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property). "Communication OK " indicates communication is established with the element, but does not convey any quality of service. "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 Managed Element is known to exist and has been contacted successfully in the past, but is currently unreachable.CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
Not Available
Communication OK
Lost Communication
No Contact
DMTF Reserved
Vendor Reserved
CIM_ManagedSystemElement

NameValue
0Unknown
1Not Available
2Communication OK
3Lost Communication
4No Contact
..DMTF Reserved
0x8000..Vendor Reserved
NameValue
0Unknown
1Not Available
2Communication OK
3Lost Communication
4No Contact
..DMTF Reserved
0x8000..Vendor Reserved
NameValue
0Unknown
1Not Available
2Communication OK
3Lost Communication
4No Contact
..DMTF Reserved
0x8000..Vendor Reserved
NameValue
0Unknown
1Not Available
2Communication OK
3Lost Communication
4No Contact
..DMTF Reserved
0x8000..Vendor Reserved
Property Caption Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object.CIM_ManagedElement
MaxLenuint3264CIM_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 the Name property of ManagedSystemElement 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 can 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
GetAvailableExtentsuint32 Description
ValueMap
Values
AvailableExtentsCIM_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

Method GetAvailableExtents Qualifiers
NameTypeValueFrom Class
DescriptionstringThis method can be used to retrieve a list of available Extents that may be used in the creation or modification of a StoragePool, StorageVolume, or LogicalDisk. The GetAvailableExtents method MUST return the Extents from the set of Component Extents of the Pool on which the method is being invoked. The returned Extents are available at the time the method returns. There is no guarantee that the same Extents will be available later. This method MUST return the Extents that are not being used as supporting capacity for any other Pools, Volumes, or LogicalDisks that have been allocated from this Pool. The Extent returned MUST be a component Extent of the Pool or subdivisions of a component Extent, the subdivisions themselves represented as Extents.CIM_StoragePool
ValueMapstring
[See below.]
CIM_StoragePool
ValuesstringCompleted with No Error
Not Supported
Unknown
Timeout
Failed
Invalid Parameter
In Use
DMTF Reserved
Method Reserved
Vendor Specific
CIM_StoragePool

Parameters

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

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

Method GetAvailableExtents Parameters
NameTypeQualifiers
AvailableExtents(null)OUT
Description

Parameter Qualifiers

Parameter ElementType Qualifiers
NameTypeValueFrom Class
INbooleantrueCIM_StoragePool
DescriptionstringThe type of element for which supported sizes are reported for.CIM_StoragePool
ValueMapstring
[See below.]
CIM_StoragePool
ValuesstringStorage Pool
Storage Volume
Logical Disk
CIM_StoragePool
INbooleantrueCIM_StoragePool
OUTbooleantrueCIM_StoragePool
DescriptionstringList of supported sizes for a Volume/Pool creation or modification.CIM_StoragePool
UnitsstringBytesCIM_StoragePool
PUnitstringbyteCIM_StoragePool

Parameter ElementType Qualifiers
NameTypeValueFrom Class
INbooleantrueCIM_StoragePool
DescriptionstringThe type of element for which supported size ranges are reported for.CIM_StoragePool
ValueMapstring
[See below.]
CIM_StoragePool
ValuesstringStorage Pool
Storage Volume
Logical Disk
CIM_StoragePool
INbooleantrueCIM_StoragePool
OUTbooleantrueCIM_StoragePool
DescriptionstringThe minimum size for a volume/pool in bytes.CIM_StoragePool
UnitsstringBytesCIM_StoragePool
PUnitstringbyteCIM_StoragePool
INbooleantrueCIM_StoragePool
OUTbooleantrueCIM_StoragePool
DescriptionstringThe maximum size for a volume/pool in bytes.CIM_StoragePool
UnitsstringBytesCIM_StoragePool
PUnitstringbyteCIM_StoragePool
INbooleantrueCIM_StoragePool
OUTbooleantrueCIM_StoragePool
DescriptionstringA volume/pool size must be a multiple of this value which is specified in bytes.CIM_StoragePool
UnitsstringBytesCIM_StoragePool
PUnitstringbyteCIM_StoragePool

Parameter AvailableExtents Qualifiers
NameTypeValueFrom Class
OUTbooleantrueCIM_StoragePool
DescriptionstringList of references to available StorageExtents, or subclass instances.CIM_StoragePool

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_HostedStoragePoolCIM_StoragePoolPartComponent
CIM_AssociatedComponentExtentCIM_StoragePoolGroupComponent
CIM_AssociatedRemainingExtentCIM_StoragePoolGroupComponent
CIM_AllocatedFromStoragePoolCIM_StoragePoolAntecedent
CIM_ReplicaPoolForStorageCIM_StoragePoolDependent
CIM_HostedResourcePoolCIM_ResourcePoolPartComponent
CIM_ElementAllocatedFromPoolCIM_ResourcePoolAntecedent
CIM_ResourceAllocationFromPoolCIM_ResourcePoolAntecedent
CIM_LogicalElementPerformsUoWCIM_LogicalElementAntecedent
CIM_ImportedShareRootCIM_LogicalElementAntecedent
CIM_ImportedShareRootCIM_LogicalElementDependent
CIM_ElementAllocatedFromPoolCIM_LogicalElementDependent
CIM_AllocatedFromStoragePoolCIM_LogicalElementDependent
CIM_LogicalElementUnitOfWorkDefCIM_LogicalElementAntecedent
CIM_ResidesOnExtentCIM_LogicalElementDependent
CIM_SharedElementRootCIM_LogicalElementAntecedent
CIM_OperationLogCIM_LogicalElementDependent
CIM_AssociatedMemoryCIM_LogicalElementDependent
CIM_AssociatedCacheMemoryCIM_LogicalElementDependent
CIM_AttachedElementCIM_LogicalElementSystemElement
CIM_AttachedElementCIM_LogicalElementSameElement
CIM_MountedElementCIM_LogicalElementSystemElement
CIM_MountedElementCIM_LogicalElementSameElement
CIM_ImportedShareCIM_LogicalElementSystemElement
CIM_ImportedShareCIM_LogicalElementSameElement
CIM_SharedElementCIM_LogicalElementSystemElement
CIM_DiagnosticResultForMSECIM_ManagedSystemElementSystemElement
CIM_RedundancyComponentCIM_ManagedSystemElementPartComponent
CIM_SystemComponentCIM_ManagedSystemElementPartComponent
CIM_SuppliesPowerCIM_ManagedSystemElementDependent
CIM_UseOfLogCIM_ManagedSystemElementDependent
CIM_UseOfMessageLogCIM_ManagedSystemElementDependent
CIM_DiagnosticTestForMSECIM_ManagedSystemElementDependent
CIM_AssociatedCoolingCIM_ManagedSystemElementDependent
CIM_AssociatedIndicatorLEDCIM_ManagedSystemElementAntecedent
CIM_AssociatedSensorCIM_ManagedSystemElementDependent
CIM_AssociatedBatteryCIM_ManagedSystemElementDependent
CIM_ElementConfigurationCIM_ManagedSystemElementElement
CIM_CollectedMSEsCIM_ManagedSystemElementMember
CIM_ActsAsSpareCIM_ManagedSystemElementSpare
CIM_ElementSettingCIM_ManagedSystemElementElement
CIM_DefaultSettingCIM_ManagedSystemElementElement
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_SettingsDefineStateCIM_ManagedElementManagedElement
CIM_StatisticsCIM_ManagedElementElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement
CIM_AuthorizationRuleAppliesToTargetCIM_ManagedElementManagedElement
CIM_CredentialContextCIM_ManagedElementElementProvidingContext
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_OrderedComponentCIM_ManagedElementGroupComponent
CIM_OrderedComponentCIM_ManagedElementPartComponent
CIM_ProductElementComponentCIM_ManagedElementPartComponent
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_OrderedDependencyCIM_ManagedElementAntecedent
CIM_OrderedDependencyCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementDependent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_IsSpareCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SWRManageableAspectCIM_ManagedElementSystemElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_OrderedMemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_MemberOfStatusCollectionCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_OwningCollectionElementCIM_ManagedElementOwningElement
CIM_AbstractIndicationSubscriptionCIM_ManagedElementFilter
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_DefaultElementCapabilitiesCIM_ManagedElementManagedElement
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_RoleLimitedToTargetCIM_ManagedElementTargetElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_AvailableDiagnosticServiceCIM_ManagedElementUserOfService
CIM_AssociatedPowerManagementServiceCIM_ManagedElementUserOfService
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ManagementSAPCIM_ManagedElementManagedElement