| Name | Data Type | Qualifiers |
| Name | Data Type | Value | Scope | Flavors |
| 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 |
| 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 |
| 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 |
| Description | string |
| Description | string | The Description property provides a textual description of the object. | 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 ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties. | None | TRANSLATABLE= true |
| EnabledDefault | uint16 |
| Description | string | An enumerated value indicating an administrator's default/startup configuration for an element's Enabled State. By default, the element is "Enabled" (value=2). | None | TRANSLATABLE= true |
| ValueMap | string | 2, 3, 5, 6, 7, 8..32767, 32768..65535 | None | None |
| Values | string | Enabled, Disabled, Not Applicable, Enabled but Offline, No Default, 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/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/disabled states:
Enabled (2) indicates that the element is/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 doesn't support being enabled/disabled.
Enabled but Offline (6) indicates that the element may 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 may be completing commands, but will queue any new requests.
Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes a restricted set of commands. All other requests are queued.
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 |
| InstallDate | datetime |
| Description | string | A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. | None | TRANSLATABLE= true |
| MappingStrings | string | MIF.DMTF|ComponentID|001.5 | None | None |
| 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 |
| LineAttenuation | uint32 |
| Description | string | Measured difference in the total power transmitted by the peer Modem and the total power received by this Modem. This is measured in tenths of dB. | None | TRANSLATABLE= true |
| Gauge | boolean | true | None | None |
| Units | string | Tenths of Decibels | None | TRANSLATABLE= true |
| LineState | uint32 |
| Description | string | Status indicates the current state of the connection (line). The property holds a bitmap describing the possible conditions. For example,
1) No Defect - There no defects on the line;
2) Loss Of Framing - ATUR failure due to not receiving valid frame;
4) Loss Of Signal - ATUR failure due to not receiving signal;
8) Loss Of Power - ATUR failure due to loss of power;
32) Loss Of Signal Quality - Loss of Signal Quality is declared when the NoiseMargin falls below the minimum NoiseMargin, or the bit-error-rate exceeds 10^-7. | None | TRANSLATABLE= true |
| ValueMap | string | 1, 2, 4, 8, 32 | None | None |
| Values | string | No Defect, Loss Of Framing, Loss Of Signal, Loss Of Power, Loss Of Signal Quality | None | TRANSLATABLE= true |
| MaxDataRate | uint32 |
| Description | string | Indicates the maximum currently attainable data rate for the Modem. This value will be equal or greater than the current line rate. | None | TRANSLATABLE= true |
| Units | string | Bits per Second | 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 | The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property. | None | TRANSLATABLE= true |
| MaxLen | uint32 | 1024 | None | None |
| NoiseMargin | uint32 |
| Description | string | Noise Margin of this Modem with respect to its received signal, in tenths of dB. | None | TRANSLATABLE= true |
| Units | string | Tenths of Decibels | None | TRANSLATABLE= true |
| OtherEnabledState | string |
| Description | string | A string describing the element's enabled/disabled state 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 |
| 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 |
| RequestedState | uint16 |
| Description | string | RequestedState is an integer enumeration indicating the last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled/disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the element's RequestedState is 5 ("No Change"). Refer to the EnabledState's property Description for explanations of the values in the RequestedState enumeration.
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). The former, Reboot, refers to doing a "Shut Down" and then moving to an "Enabled" state. The latter, Reset, indicates that the element is first "Disabled" and then "Enabled". The distinction between requesting "Shut Down" and "Disabled" should also be noted. The former, Shut Down, requests an orderly transition to the Disabled state, and MAY involve removing power, to completely erase any existing state. The latter, 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 may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_EnabledLogicalElement.EnabledState | None | None |
| ValueMap | string | 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, .., 32768..65535 | None | None |
| Values | string | Enabled, Disabled, Shut Down, No Change, Offline, Test, Deferred, Quiesce, Reboot, Reset, DMTF Reserved, Vendor Reserved | 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 overcomes the limitation of describing status via a single value, when it is really a multi-valued property (for example, an element may be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. And, 3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the Deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus. | 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 |
| 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/time when the element's EnabledState 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 |
| TotalOutputPower | uint32 |
| Description | string | Measured total output power (in tenths of dB) transmitted by this Modem. | None | TRANSLATABLE= true |
| Gauge | boolean | true | None | None |
| Units | string | Tenths of Decibels | 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 |
| VendorID | string |
| Description | string | VendorID information is reported via Modem-specific requests. For example, for ADSLModem Devices the VendorID is assigned by T1E1.4 according to T1.413, Appendix D. The correct place in the CIM Schema for this information is in PhysicalElement (the Manufacturer property) for hardware and Product (the Vendor property) if the information is related to Product acquisition. This data is also reported here since it is part of the standard output from the Device, and as an optimization. | 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 |
| 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 |
| OperationalStatus | uint16[] |
| ArrayType | string | Indexed | None | OVERRIDABLE= false
|
| Description | string | Indicates the current status(es) of the element. Various health and operational statuses are defined. Many of the enumeration's values are self- explanatory. However, a few are not and are described in more detail.
"Stressed" indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, etc.
"Predictive Failure" indicates that an element is functioning nominally but predicting a failure in the near future.
"In Service" describes an element being configured, maintained, cleaned, or otherwise administered.
"No Contact" indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it.
"Lost Communication" indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable.
"Stopped" and "Aborted" are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the element's state and configuration may need to be updated.
"Dormant" indicates that the element is inactive or quiesced.
"Supporting Entity in Error" describes that this element may be "OK" but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower layer networking problems.
"Completed" indicates the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded would imply the operation finished, but did not complete OK or report an error.
"Power Mode" indicates the element has additional power model information contained in the Associated PowerManagementService association.
OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today's environment to the future. This change was not made earlier since it required the DEPRECATED qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly RECOMMENDED that providers/instrumentation provide BOTH the Status and OperationalStatus properties. Further, the first value of OperationalStatus SHOULD contain the primary status for the element. When instrumented, Status (since it is single-valued) SHOULD also provide the primary status of the element. | 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 |
| 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 |
| 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 |
| 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 |