Name | Data Type | Qualifiers |
Name | Data Type | Value | Scope | Flavors |
Access | uint16 |
Description | string | Access describes whether the media is readable (value=1), writeable (value=2), or both (value=3). "Unknown" (0) and "Write Once" (4) can also be defined. | None | TRANSLATABLE= true |
ValueMap | string | 0, 1, 2, 3, 4 | None | None |
Values | string | Unknown, Readable, Writeable, Read/Write Supported, Write Once | None | TRANSLATABLE= true |
AdditionalAvailability | uint16 |
Description | string | Additional availability and status of the Device, beyond that specified in the Availability property. The Availability property denotes the primary status and availability of the Device. In some cases, this will not be sufficient to denote the complete status of the Device. In those cases, the AdditionalAvailability property can be used to provide further information. For example, a Device's primary Availability may be "Off line" (value=8), but it may also be in a low power state (AdditonalAvailability value=14), or the Device could be running Diagnostics (AdditionalAvailability value=5, "In Test"). | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_LogicalDevice.Availability | None | None |
ValueMap | string | 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21 | None | None |
Values | string | Other, Unknown, Running/Full Power, Warning, In Test, Not Applicable, Power Off, Off Line, Off Duty, Degraded, Not Installed, Install Error, Power Save - Unknown, Power Save - Low Power Mode, Power Save - Standby, Power Cycle, Power Save - Warning, Paused, Not Ready, Not Configured, Quiesced | None | TRANSLATABLE= true |
Availability | uint16 |
Description | string | The primary availability and status of the Device. (Additional status information can be specified using the Additional Availability array property.) For example, the Availability property indicates that the Device is running and has full power (value=3), or is in a warning (4), test (5), degraded (10) or power save state (values 13-15 and 17). Regarding the Power Save states, these are defined as follows: Value 13 ("Power Save - Unknown") indicates that the Device is known to be in a power save mode, but its exact status in this mode is unknown; 14 ("Power Save - Low Power Mode") indicates that the Device is in a power save state but still functioning, and may exhibit degraded performance; 15 ("Power Save - Standby") describes that the Device is not functioning but could be brought to full power 'quickly'; and value 17 ("Power Save - Warning") indicates that the Device is in a warning state, though also in a power save mode. | None | TRANSLATABLE= true |
MappingStrings | string | MIF.DMTF|Operational State|006.5, MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus, MIF.DMTF|Host Device|001.5 | None | None |
ModelCorrespondence | string | CIM_LogicalDevice.AdditionalAvailability | None | None |
ValueMap | string | 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21 | None | None |
Values | string | Other, Unknown, Running/Full Power, Warning, In Test, Not Applicable, Power Off, Off Line, Off Duty, Degraded, Not Installed, Install Error, Power Save - Unknown, Power Save - Low Power Mode, Power Save - Standby, Power Cycle, Power Save - Warning, Paused, Not Ready, Not Configured, Quiesced | None | TRANSLATABLE= true |
AvailableRequestedStates | uint16 |
Description | string | AvailableRequestedStates indicates the possible values for the RequestedState parameter of the method RequestStateChange, used to initiate a state change. The values listed shall be a subset of the values contained in the RequestedStatesSupported property of the associated instance of CIM_EnabledLogicalElementCapabilities where the values selected are a function of the current state of the CIM_EnabledLogicalElement. This property may be non-null if an implementation is able to advertise the set of possible values as a function of the current state. This property shall be null if an implementation is unable to determine the set of possible values as a function of the current state. | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_EnabledLogicalElement.RequestStateChange, CIM_EnabledLogicalElementCapabilities.RequestedStatesSupported | None | None |
ValueMap | string | 2, 3, 4, 6, 7, 8, 9, 10, 11, .. | None | None |
Values | string | Enabled, Disabled, Shut Down, Offline, Test, Defer, Quiesce, Reboot, Reset, DMTF Reserved | None | TRANSLATABLE= true |
BlockSize | uint64 |
Description | string | Size in bytes of the blocks which form this StorageExtent. If variable block size, then the maximum block size in bytes should be specified. If the block size is unknown or if a block concept is not valid (for example, for AggregateExtents, Memory or LogicalDisks), enter a 1. | None | TRANSLATABLE= true |
MappingStrings | string | MIF.DMTF|Host Storage|001.4, MIB.IETF|HOST-RESOURCES-MIB.hrStorageAllocationUnits, MIF.DMTF|Storage Devices|001.5 | None | None |
Units | string | Bytes | None | TRANSLATABLE= true |
Caption | string |
Description | string | The Caption property is a short textual description (one- line string) of the object. | None | TRANSLATABLE= true |
MaxLen | uint32 | 64 | None | None |
CommunicationStatus | uint16 |
Description | string | CommunicationStatus 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. | None | TRANSLATABLE= true |
ValueMap | string | 0, 1, 2, 3, 4, .., 0x8000.. | None | None |
Values | string | Unknown, Not Available, Communication OK, Lost Communication, No Contact, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
ConsumableBlocks | uint64 |
Description | string | The maximum number of blocks, of size BlockSize, which are available for consumption when layering StorageExtents using the BasedOn association. This property only has meaning when this StorageExtent is an Antecedent reference in a BasedOn relationship. For example, a StorageExtent could be composed of 120 blocks. However, the Extent itself may use 20 blocks for redundancy data. If another StorageExtent is BasedOn this Extent, only 100 blocks would be available to it. This information ('100 blocks is available for consumption') is indicated in the ConsumableBlocks property. | None | TRANSLATABLE= true |
CreationClassName | string |
Description | string | CreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified. | None | TRANSLATABLE= true |
Key | boolean | true | None | OVERRIDABLE= false
|
MaxLen | uint32 | 256 | None | None |
DataOrganization | uint16 |
Description | string | Type of data organization used. | None | TRANSLATABLE= true |
ValueMap | string | 0, 1, 2, 3, 4 | None | None |
Values | string | Other, Unknown, Fixed Block, Variable Block, Count Key Data | None | TRANSLATABLE= true |
DataRedundancy | uint16 |
Description | string | Number of complete copies of data currently maintained. | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_StorageSetting.DataRedundancyGoal, CIM_StorageSetting.DataRedundancyMax, CIM_StorageSetting.DataRedundancyMin | None | None |
DeltaReservation | uint8 |
Description | string | Current value for Delta reservation. This is a percentage that specifies the amount of space that should be reserved in a replica for caching changes. | None | TRANSLATABLE= true |
MaxValue | sint64 | 100 | None | None |
MinValue | sint64 | 1 | None | None |
ModelCorrespondence | string | CIM_StorageSetting.DeltaReservationGoal, CIM_StorageSetting.DeltaReservationMax, CIM_StorageSetting.DeltaReservationMin | None | None |
Units | string | Percentage | None | TRANSLATABLE= true |
Description | string |
Description | string | The Description property provides a textual description of the object. | None | TRANSLATABLE= true |
DetailedStatus | uint16 |
Description | string | DetailedStatus 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. | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_EnabledLogicalElement.PrimaryStatus, CIM_ManagedSystemElement.HealthState | None | None |
ValueMap | string | 0, 1, 2, 3, 4, 5, .., 0x8000.. | None | None |
Values | string | Not Available, No Additional Information, Stressed, Predictive Failure, Non-Recoverable Error, Supporting Entity in Error, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
DeviceID | string |
Description | string | An address or other identifying information to uniquely name the LogicalDevice. | None | TRANSLATABLE= true |
Key | boolean | true | None | OVERRIDABLE= false
|
MaxLen | uint32 | 64 | None | None |
ElementName | string |
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 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. Note that if there is an associated instance of CIM_EnabledLogicalElementCapabilities, restrictions on this properties may exist as defined in ElementNameMask and MaxElementNameLen properties defined in that class. | None | TRANSLATABLE= true |
EnabledDefault | uint16 |
Description | string | An enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element. By default, the element is "Enabled" (value=2). | None | TRANSLATABLE= true |
ValueMap | string | 2, 3, 5, 6, 7, 9, .., 32768..65535 | None | None |
Values | string | Enabled, Disabled, Not Applicable, Enabled but Offline, No Default, Quiesce, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
Write | boolean | true | None | None |
EnabledState | uint16 |
Description | string | EnabledState is an integer enumeration that indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value=4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled and disabled states:
Enabled (2) indicates that the element is or could be executing commands, will process any queued commands, and queues new requests.
Disabled (3) indicates that the element will not execute commands and will drop any new requests.
Shutting Down (4) indicates that the element is in the process of going to a Disabled state.
Not Applicable (5) indicates the element does not support being enabled or disabled.
Enabled but Offline (6) indicates that the element might be completing commands, and will drop any new requests.
Test (7) indicates that the element is in a test state.
Deferred (8) indicates that the element might be completing commands, but will queue any new requests.
Quiesce (9) indicates that the element is enabled but in a restricted mode.
Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued. | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_EnabledLogicalElement.OtherEnabledState | None | None |
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11..32767, 32768..65535 | None | None |
Values | string | Unknown, Other, Enabled, Disabled, Shutting Down, Not Applicable, Enabled but Offline, In Test, Deferred, Quiesce, Starting, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
ErrorCleared | boolean |
Deprecated | string | CIM_ManagedSystemElement.OperationalStatus | TOSUBCLASS= false | None |
Description | string | ErrorCleared is a boolean property indicating that the error reported in LastErrorCode is now cleared. | None | TRANSLATABLE= true |
ErrorDescription | string |
Deprecated | string | CIM_DeviceErrorData.ErrorDescription | TOSUBCLASS= false | None |
Description | string | ErrorDescription is a free-form string supplying more information about the error recorded in LastErrorCode, and information on any corrective actions that may be taken. | None | TRANSLATABLE= true |
ErrorMethodology | string |
Description | string | ErrorMethodology is a free-form string describing the type of error detection and correction supported by this StorageExtent. | None | TRANSLATABLE= true |
ExtentStatus | uint16 |
Description | string | StorageExtents have additional status information beyond that captured in the OperationalStatus and other properties, inherited from ManagedSystemElement. This additional information (for example, "Protection Disabled", value=9) is captured in the ExtentStatus property.
'In-Band Access Granted' says that access to data on an extent is granted to some consumer and is only valid when 'Exported' is also set. It is set as a side effect of PrivilegeManagementService.ChangeAccess or equivalent interfaces.
'Imported' indicates that the extent is used in the current system, but known to be managed by some other system. For example, a server imports volumes from a disk array.
'Exported' indicates the extent is meant to be used by some comsumer. A disk array's logical units are exported.
Intermediate composite extents may be neither imported nor exported. | None | TRANSLATABLE= true |
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18..32767, 32768..65535 | None | None |
Values | string | Other, Unknown, None/Not Applicable, Broken, Data Lost, Dynamic Reconfig, Exposed, Fractionally Exposed, Partially Exposed, Protection Disabled, Readying, Rebuild, Recalculate, Spare in Use, Verify In Progress, In-Band Access Granted, Imported, Exported, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
HealthState | uint16 |
Description | string | Indicates 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. | None | TRANSLATABLE= true |
ValueMap | string | 0, 5, 10, 15, 20, 25, 30, .. | None | None |
Values | string | Unknown, OK, Degraded/Warning, Minor failure, Major failure, Critical failure, Non-recoverable error, DMTF Reserved | None | TRANSLATABLE= true |
IdentifyingDescriptions | string |
ArrayType | string | Indexed | None | OVERRIDABLE= false
|
Description | string | An array of free-form strings providing explanations and details behind the entries in the OtherIdentifyingInfo array. Note, each entry of this array is related to the entry in OtherIdentifyingInfo that is located at the same index. | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_LogicalDevice.OtherIdentifyingInfo | None | None |
InstallDate | datetime |
Description | string | A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed. | None | TRANSLATABLE= true |
MappingStrings | string | MIF.DMTF|ComponentID|001.5 | None | None |
InstanceID | string |
Description | string | InstanceID is an optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below.
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 not null and the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance.
If not set to null for DMTF-defined instances, the "preferred" algorithm must be used with the <OrgID> set to CIM. | None | TRANSLATABLE= true |
IsBasedOnUnderlyingRedundancy | boolean |
Description | string | True indicates that the underlying StorageExtent(s) participate in a StorageRedundancyGroup. | None | TRANSLATABLE= true |
LastErrorCode | uint32 |
Deprecated | string | CIM_DeviceErrorData.LastErrorCode | TOSUBCLASS= false | None |
Description | string | LastErrorCode captures the last error code reported by the LogicalDevice. | None | TRANSLATABLE= true |
MaxQuiesceTime | uint64 |
Deprecated | string | No value | TOSUBCLASS= false | None |
Description | string | The MaxQuiesceTime property has been deprecated. When evaluating the use of Quiesce, it was determine that this single property is not adequate for describing when a device will automatically exit a quiescent state. In fact, the most likely scenario for a device to exit a quiescent state was determined to be based on the number of outstanding requests queued rather than on a maximum time. This will be re-evaluated and repositioned later.
Maximum time in milliseconds, that a Device can run in a "Quiesced" state. A Device's state is defined in its Availability and AdditionalAvailability properties, where "Quiesced" is conveyed by the value 21. What occurs at the end of the time limit is device-specific. The Device may unquiesce, may offline or take other action. A value of 0 indicates that a Device can remain quiesced indefinitely. | None | TRANSLATABLE= true |
Units | string | MilliSeconds | None | TRANSLATABLE= true |
Name | string |
Description | string | A unique identifier for the Extent. | None | TRANSLATABLE= true |
MappingStrings | string | SPC.INCITS-T10| VPD 83, Association 0 | Identifier | None | None |
MaxLen | uint32 | 1024 | None | None |
ModelCorrespondence | string | CIM_StorageExtent.NameFormat, CIM_StorageExtent.NameNamespace | None | None |
Override | string | Name | TOSUBCLASS= false | None |
NameFormat | uint16 |
Description | string | The list here applies to all StorageExtent subclasses. Please look at the Description in each subclass for guidelines on the approriate values for that subclass. Note that any of these formats could apply to a CompositeExtent.
Note - this property originally touched on two concepts that are now separated into this property and NameNamespace. Values 2,3,4,5,6, and 8 are retained for backwards compatibility but are deprecated in lieu of the corresponding values in CIM_StorageExtent.NameNamespace.
For example, the preferred source for SCSI virtual (RAID) disk names is from Inquiry VPD page 83 response, type 3 identifiers. These will have NameFormat set to 'NAA' and NameNamespace to 'VPD83Type3'.
Format of the Name property. Values for extents representing SCSI volumes are (per SCSI SPC-3):
2 = VPD Page 83, NAA IEEE Registered Extended (VPD83NAA6)
(DEPRECATED)
3 = VPD Page 83, NAA IEEE Registered (VPD83NAA5)
(DEPRECATED)
4 = VPD Page 83, (VPD83Type2) (DEPRECATED)
5 = VPD Page 83,
T10 Vendor Identification (VPD83Type1) (DEPRECATED)
6 = VPD Page 83, Vendor Specific (VPD83Type0) (DEPRECATED)
7 = Serial Number/Vendor/Model (SNVM) SNVM is 3 strings representing the vendor name, product name within the vendor namespace, and the serial number within the model namespace. Strings are delimited with a '+'. Spaces may be included and are significant. The serial number is the text representation of the serial number in hexadecimal upper case. This represents the vendor and model ID from SCSI Inquiry data; the vendor field MUST be 8 characters wide and the product field MUST be 16 characters wide. For example,
'ACME____+SUPER DISK______+124437458' (_ is a space character)
8 = Node WWN (for single LUN/controller) (NodeWWN)
(DEPRECATED)
9 = NAA as a generic format. See
http://standards.ieee.org/regauth/oui/tutorials/fibrecomp_id.html. Formatted as 16 or 32 unseparated uppercase hex characters (2 per binary byte). For example '21000020372D3C73'
10 = EUI as a generic format (EUI64) See
http://standards.ieee.org/regauth/oui/tutorials/EUI64.html.
Formatted as 16 unseparated uppercase hex characters (2 per binary byte)
11 = T10 vendor identifier format as returned by SCSI Inquiry VPD page 83, identifier type 1. See T10 SPC-3 specification. This is the 8-byte ASCII vendor ID from the T10 registry followed by a vendor specific ASCII identifier; spaces are permitted. For non SCSI volumes, 'SNVM' may be the most appropriate choice. 12 = OS Device Name (for LogicalDisks). See LogicalDisk Name description for details. | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_StorageExtent.Name, CIM_StorageExtent.NameNamespace, CIM_StorageExtent.OtherNameFormat | None | None |
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 | None | None |
Values | string | Unknown, Other, VPD83NAA6, VPD83NAA5, VPD83Type2, VPD83Type1, VPD83Type0, SNVM, NodeWWN, NAA, EUI64, T10VID, OS Device Name | None | TRANSLATABLE= true |
NameNamespace | uint16 |
Description | string | The preferred source SCSI for volume names is SCSI VPD Page 83 responses. Page 83 returns a list of identifiers for various device elements. The metadata for each identifier includes an Association field, identifiers with association of 0 apply to volumes. Page 83 supports several namespaces specified in the Type field in the identifier metadata. See SCSI SPC-3 specification.
2 = VPD Page 83, Type 3 NAA (NameFormat SHOULD be NAA)
3 = VPD Page 83, Type 2 EUI64 (NameFormat EUI)
4 = VPD Page 83, Type 1 T10 Vendor Identification
(NameFormat T10)
Less preferred volume namespaces from other interfaces:
5 = VPD page 80, Serial number (NameFormat SHOULD be Other)
6 = FC NodeWWN (NameFormat SHOULD be NAA or EUI)
7 = Serial Number/Vendor/Model (NameFormat SHOULD be SNVM)
The preferred namespace for LogigicalDisk names is platform specific device namespace; see LogigicalDIsk Description.
8 = OS Device Namespace. | None | TRANSLATABLE= true |
MappingStrings | string | SPC.INCITS-T10| VPD 83, Association 0 | Identifier | None | None |
ModelCorrespondence | string | CIM_StorageExtent.Name, CIM_StorageExtent.OtherNameNamespace, CIM_StorageExtent.NameFormat | None | None |
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8 | None | None |
Values | string | Unknown, Other, VPD83Type3, VPD83Type2, VPD83Type1, VPD80, NodeWWN, SNVM, OS Device Namespace | None | TRANSLATABLE= true |
NoSinglePointOfFailure | boolean |
Description | string | Indicates whether or not there exists no single point of failure. | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_StorageSetting.NoSinglePointOfFailure | None | None |
NumberOfBlocks | uint64 |
Description | string | Total number of logically contiguous blocks, of size Block Size, which form this Extent. The total size of the Extent can be calculated by multiplying BlockSize by NumberOfBlocks. If the BlockSize is 1, this property is the total size of the Extent. | None | TRANSLATABLE= true |
MappingStrings | string | MIF.DMTF|Host Storage|001.5, MIB.IETF|HOST-RESOURCES-MIB.hrStorageSize | None | None |
OperatingStatus | uint16 |
Description | string | OperatingStatus 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. | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_EnabledLogicalElement.EnabledState | None | None |
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, .., 0x8000.. | None | None |
Values | string | Unknown, Not Available, Servicing, Starting, Stopping, Stopped, Aborted, Dormant, Completed, Migrating, Emigrating, Immigrating, Snapshotting, Shutting Down, In Test, Transitioning, In Service, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
OperationalStatus | uint16 |
ArrayType | string | Indexed | None | OVERRIDABLE= false
|
Description | string | Indicates 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. | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_ManagedSystemElement.StatusDescriptions | None | None |
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, .., 0x8000.. | None | None |
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 Reserved | None | TRANSLATABLE= true |
OtherEnabledState | string |
Description | string | A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ("Other"). This property must be set to null when EnabledState is any value other than 1. | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_EnabledLogicalElement.EnabledState | None | None |
OtherIdentifyingInfo | string |
ArrayType | string | Indexed | None | OVERRIDABLE= false
|
Description | string | OtherIdentifyingInfo captures additional data, beyond DeviceID information, that could be used to identify a LogicalDevice. One example would be to hold the Operating System's user friendly name for the Device in this property. | None | TRANSLATABLE= true |
MaxLen | uint32 | 256 | None | None |
ModelCorrespondence | string | CIM_LogicalDevice.IdentifyingDescriptions | None | None |
OtherNameFormat | string |
Description | string | A string describing the format of the Name property when NameFormat includes the value 1, "Other". | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_StorageExtent.NameFormat | None | None |
OtherNameNamespace | string |
Description | string | A string describing the namespace of the Name property when NameNamespace includes the value 1, "Other". | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_StorageExtent.NameNamespace | None | None |
PackageRedundancy | uint16 |
Description | string | How many physical packages can currently fail without data loss. For example, in the storage domain, this might be disk spindles. | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_StorageSetting.PackageRedundancyGoal, CIM_StorageSetting.PackageRedundancyMax, CIM_StorageSetting.PackageRedundancyMin | None | None |
PowerManagementCapabilities | uint16 |
Deprecated | string | CIM_PowerManagementCapabilities.PowerCapabilities | TOSUBCLASS= false | None |
Description | string | An enumerated array describing the power management capabilities of the Device. The use of this property has been deprecated. Instead, the PowerCapabilites property in an associated PowerManagementCapabilities class should be used. | None | TRANSLATABLE= true |
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7 | None | None |
Values | string | Unknown, Not Supported, Disabled, Enabled, Power Saving Modes Entered Automatically, Power State Settable, Power Cycling Supported, Timed Power On Supported | None | TRANSLATABLE= true |
PowerManagementSupported | boolean |
Deprecated | string | CIM_PowerManagementCapabilities | TOSUBCLASS= false | None |
Description | string | Boolean indicating that the Device can be power managed. The use of this property has been deprecated. Instead, the existence of an associated PowerManagementCapabilities class (associated using the ElementCapabilities relationhip) indicates that power management is supported. | None | TRANSLATABLE= true |
PowerOnHours | uint64 |
Counter | boolean | true | None | None |
Description | string | The number of consecutive hours that this Device has been powered, since its last power cycle. | None | TRANSLATABLE= true |
Units | string | Hours | None | TRANSLATABLE= true |
PrimaryStatus | uint16 |
Description | string | PrimaryStatus 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. | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_ManagedSystemElement.DetailedStatus, CIM_ManagedSystemElement.HealthState | None | None |
ValueMap | string | 0, 1, 2, 3, .., 0x8000.. | None | None |
Values | string | Unknown, OK, Degraded, Error, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
Primordial | boolean |
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 StorageExtents are assembled into higher-level abstractions using the BasedOn association. Although the higher-level abstractions can be created and deleted, the most basic, (i.e. primordial), hardware-based storage entities 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. In other words, a Primordial StorageExtent exists in, but is not created by its System and conversely a non-Primordial StorageExtent is created in the context of its System. For StorageVolumes, this property will generally be false. One use of this property is to enable algorithms that aggregate StorageExtent.ConsumableSpace across all, StorageExtents but that also want to distinquish the space that underlies Primordial StoragePools. Since implementations are not required to surface all Component StorageExtents of a StoragePool, this information is not accessible in any other way. | None | TRANSLATABLE= true |
Purpose | string |
Description | string | A free form string describing the media and/or its use. | None | TRANSLATABLE= true |
MappingStrings | string | MIB.IETF|HOST-RESOURCES-MIB.hrStorageDescr | None | None |
RequestedState | uint16 |
Description | string | RequestedState is an integer enumeration that indicates the last requested or desired state for the element, irrespective of the mechanism through which it was requested. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration.
"Unknown" (0) indicates the last requested state for the element is unknown.
Note that the value "No Change" (5) has been deprecated in lieu of indicating the last requested state is "Unknown" (0). If the last requested or desired state is unknown, RequestedState should have the value "Unknown" (0), but may have the value "No Change" (5).Offline (6) indicates that the element has been requested to transition to the Enabled but Offline EnabledState.
It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are "Reboot" (10) and "Reset" (11). Reboot refers to doing a "Shut Down" and then moving to an "Enabled" state. Reset indicates that the element is first "Disabled" and then "Enabled". The distinction between requesting "Shut Down" and "Disabled" should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. The Disabled state requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests.
This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code.
If knowledge of the last RequestedState is not supported for the EnabledLogicalElement, the property shall be NULL or have the value 12 "Not Applicable". | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_EnabledLogicalElement.EnabledState | None | None |
ValueMap | string | 0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, .., 32768..65535 | None | None |
Values | string | Unknown, Enabled, Disabled, Shut Down, No Change, Offline, Test, Deferred, Quiesce, Reboot, Reset, Not Applicable, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
SequentialAccess | boolean |
Description | string | Boolean set to TRUE if the Storage is sequentially accessed by a MediaAccessDevice. A TapePartition is an example of a sequentially accessed StorageExtent. StorageVolumes, Disk Partitions and LogicalDisks represent randomly accessed Extents. | None | TRANSLATABLE= true |
Status | string |
Deprecated | string | CIM_ManagedSystemElement.OperationalStatus | TOSUBCLASS= false | None |
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 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. | None | TRANSLATABLE= true |
MaxLen | uint32 | 10 | None | None |
ValueMap | string | OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed, NonRecover, No Contact, Lost Comm, Stopped | None | None |
StatusDescriptions | string |
ArrayType | string | Indexed | None | OVERRIDABLE= false
|
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. | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_ManagedSystemElement.OperationalStatus | None | None |
StatusInfo | uint16 |
Deprecated | string | CIM_EnabledLogicalElement.EnabledState | TOSUBCLASS= false | None |
Description | string | The StatusInfo property indicates whether the Logical Device is in an enabled (value = 3), disabled (value = 4) or some other (1) or unknown (2) state. If this property does not apply to the LogicalDevice, the value, 5 ("Not Applicable"), should be used. StatusInfo has been deprecated in lieu of a more clearly named property with additional enumerated values (EnabledState), that is inherited from ManagedSystemElement.
If a Device is ("Enabled")(value=3), it has been powered up, and is configured and operational. The Device may or may not be functionally active, depending on whether its Availability (or AdditionalAvailability) indicate that it is ("Running/Full Power")(value=3) or ("Off line") (value=8). In an enabled but offline mode, a Device may be performing out-of-band requests, such as running Diagnostics. If ("Disabled") StatusInfo value=4), a Device can only be "enabled" or powered off. In a personal computer environment, ("Disabled") means that the Device's driver is not available in the stack. In other environments, a Device can be disabled by removing its configuration file. A disabled device is physically present in a System and consuming resources, but can not be communicated with until a load of a driver, a load of a configuration file or some other "enabling" activity has occurred. | None | TRANSLATABLE= true |
MappingStrings | string | MIF.DMTF|Operational State|006.4 | None | None |
ValueMap | string | 1, 2, 3, 4, 5 | None | None |
Values | string | Other, Unknown, Enabled, Disabled, Not Applicable | None | TRANSLATABLE= true |
SystemCreationClassName | string |
Description | string | The scoping System's CreationClassName. | None | TRANSLATABLE= true |
Key | boolean | true | None | OVERRIDABLE= false
|
MaxLen | uint32 | 256 | None | None |
Propagated | string | CIM_System.CreationClassName | None | OVERRIDABLE= false
|
SystemName | string |
Description | string | The scoping System's Name. | None | TRANSLATABLE= true |
Key | boolean | true | None | OVERRIDABLE= false
|
MaxLen | uint32 | 256 | None | None |
Propagated | string | CIM_System.Name | None | OVERRIDABLE= false
|
TimeOfLastStateChange | datetime |
Description | string | The date or time when the EnabledState of the element last changed. If the state of the element has not changed and this property is populated, then it must be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property must not be updated. | None | TRANSLATABLE= true |
TotalPowerOnHours | uint64 |
Counter | boolean | true | None | None |
Description | string | The total number of hours that this Device has been powered. | None | TRANSLATABLE= true |
Units | string | Hours | None | TRANSLATABLE= true |
TransitioningToState | uint16 |
Description | string | TransitioningToState indicates the target state to which the instance is transitioning.
A value of 5 "No Change" shall indicate that no transition is in progress.A value of 12 "Not Applicable" shall indicate the implementation does not support representing ongoing transitions.
A value other than 5 or 12 shall identify the state to which the element is in the process of transitioning. | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_EnabledLogicalElement.RequestStateChange, CIM_EnabledLogicalElement.RequestedState, CIM_EnabledLogicalElement.EnabledState | None | None |
ValueMap | string | 0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, .. | None | None |
Values | string | Unknown, Enabled, Disabled, Shut Down, No Change, Offline, Test, Defer, Quiesce, Reboot, Reset, Not Applicable, DMTF Reserved | None | TRANSLATABLE= true |
Copyright © 2008-2020 VMware, Inc. All rights reserved.