Device\CIM_SDSLModem.mof.mof (HTML version)

Return to index
CIM_SDSLModem Superclass: CIM_DSLModem
The SDSLModem class represents Modems of the DSL type = SDSL, Symmetric Digital Subscriber Line. Properties will be defined in a future release of the model.
Qualifiers:Version ( "2.6.0" ) UMLPackagePath ( "CIM::Device::Modems" )
Parameters (local in grey)
string VendorID ;
VendorID information is reported through 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 because it is part of the standard output from the Device and is an optimization.
Punit ( "second * 10^-3" )
Units ( "MilliSeconds" )
Deprecated { "No value" }
uint64 MaxQuiesceTime ;
Note: The use of this property has been deprecated. When evaluating the use of Quiesce, it was determined 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 decision will be re-evaluated and repositioned later.
Deprecated description: Maximum time, in milliseconds, that a Device can run in a 'Quiesced' state. The 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 can unquiesce, can be offline, or can take other actions. A value of 0 indicates that a Device can remain quiesced indefinitely.
ArrayType ( "Indexed" )
ModelCorrespondence { "CIM_LogicalDevice.OtherIdentifyingInfo" }
string IdentifyingDescriptions [ ] ;
An array of free-form strings providing explanations and details behind the entries in the OtherIdentifyingInfo array. Note that each entry of this array is related to the entry in OtherIdentifyingInfo that is located at the same index.
ValueMap { "0" , "2" , "3" , "4" }
Values { "Unknown" , "On" , "Off" , "Not Supported" }
Write
Experimental
ModelCorrespondence { "CIM_AlarmDevice.AlarmState" , "CIM_AlarmDevice.AudioIndicatorIsDisabled" , "CIM_AlarmDevice.VisualIndicatorIsDisabled" , "CIM_AlarmDevice.MotionIndicatorIsDisabled" }
uint16 LocationIndicator ;
An integer that reflects the state of an indicator (e.g., LED) that is part of a device. Reading the value gives the current state. Writing the value with 'On'/'Off' turns the indicator on/off, other values may not be written.
MaxLen ( 256 )
Propagated ( "CIM_System.Name" )
Key
string SystemName ;
The System Name of the scoping system.
Punit ( "hour" )
Counter
Units ( "Hours" )
Deprecated { "CIM_PoweredStatisticalData.TotalPowerOnHours" }
uint64 TotalPowerOnHours ;
Note: The use of this method is deprecated.
Deprecated description: The total number of hours that this Device has been powered on.
Deprecated { "CIM_DeviceErrorData.ErrorDescription" }
string ErrorDescription ;
Note: The use of this method is deprecated.
Deprecated description: ErrorDescription is a free-form string that supplies more information about the error recorded in LastErrorCode and information on any corrective actions that can be taken.
ValueMap { "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , "15" , "16" , "17" , "18" , "19" , "20" , "21" }
Values { "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" }
ModelCorrespondence { "CIM_LogicalDevice.Availability" }
uint16 AdditionalAvailability [ ] ;
Additional availability and status of the Device in addition to that specified in the Availability property. The Availability property denotes the primary status and availability of the Device. In some cases, this property 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, the primary Availability of a device might be 'Off line' (value=8) or in a low-power state (AdditionalAvailability value=14), or the Device could be running Diagnostics (AdditionalAvailability value=5, 'In Test').
Deprecated { "CIM_ConfigurationData.ConfigurationInformation" }
uint32SaveProperties()
Note: The use of this method is deprecated. Its function is handled more generally by the ConfigurationData subclass of SettingData.
Deprecated description: Requests that the Device capture its current configuration, setup or state information, or both in a backing store.
The information returned by this method could be used at a later time (using the RestoreProperties method) to return a Device to its present 'condition'. This method might not be supported by all Devices. The method should return 0 if successful, 1 if the request is not supported, and some other value if any other error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' can also be specified in the subclass as a Values array qualifier.
ArrayType ( "Indexed" )
MaxLen ( 256 )
ModelCorrespondence { "CIM_LogicalDevice.IdentifyingDescriptions" }
string OtherIdentifyingInfo [ ] ;
OtherIdentifyingInfo captures data, in addition to DeviceID information, that could be used to identify a LogicalDevice. For example, you could use this property to hold the operating system's user-friendly name for the Device.
Deprecated { "CIM_ConfigurationData.ApplyConfiguration" }
uint32RestoreProperties()
Note: The use of this method is deprecated. Its function is handled more generally by the ConfigurationData subclass of SettingData.
Requests that the Device re-establish its configuration, setup or state information, or both from a backing store. The information would have been captured at an earlier time (using the SaveProperties method). This method might not be supported by all Devices. The method should return 0 if successful, 1 if the request is not supported, and some other value if any other error occurred. In a subclass, the set of possible return codes could be specified using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' can also be specified in the subclass as a Values array qualifier.
Deprecated { "CIM_EnabledLogicalElement.RequestStateChange" }
uint32OnlineDevice(
If TRUE, take the device online. If FALSE, take the device offline.
Qualifiers:IN
boolean Online
)
Note: The use of this method has been deprecated in lieu of the more general RequestStateChange method that directly overlaps with the functionality provided by this method.
Deprecated description: Requests that the LogicalDevice be brought online ('Online' input parameter=TRUE) or taken offline (=FALSE). 'Online' indicates that the Device is ready to accept requests, and is operational and fully functioning. In this case, the Availability property of the Device would be set to a value of 3 ('Running/Full Power'). 'Offline' indicates that a Device is powered on and operational, but is not processing functional requests. In an offline state, a Device might be capable of running diagnostics or generating operational alerts. For example, when the 'Offline' button is pushed on a Printer, the Device is no longer available to process print jobs, but it could be available for diagnostics or maintenance.
If this method is successful, the Availability and AdditionalAvailability properties of the Device should reflect the updated status. If a failure occurs when you try to bring the Device online or offline, it should remain in its current state. The request, if unsuccessful, should not leave the Device in an indeterminate state. When bringing a Device back 'Online' from an 'Offline' mode, the Device should be restored to its last 'Online' state, if at all possible. Only a Device that has an EnabledState or StatusInfo of 'Enabled' and has been configured can be brought online or taken offline.
OnlineDevice should return 0 if successful, 1 if the request is not supported at all, 2 if the request is not supported due to the current state of the Device, and some other value if any other error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' can also be specified in the subclass as a Values array qualifier.
Note that the function of this method overlaps with the RequestedState property. RequestedState was added to the model to maintain a record (for example, a persisted value) of the last state request. Invoking the OnlineDevice method should set the RequestedState property appropriately.
Deprecated { "CIM_DeviceErrorData.LastErrorCode" }
uint32 LastErrorCode ;
Note: The use of this method is deprecated.
Deprecated description: LastErrorCode captures the last error code reported by the LogicalDevice.
Deprecated { "CIM_PowerManagementService.SetPowerState" }
uint32SetPowerState(
The power state to set.
Qualifiers:ValueMap { "1" , "2" , "3" , "4" , "5" , "6" } Values { "Full Power" , "Power Save - Low Power Mode" , "Power Save - Standby" , "Power Save - Other" , "Power Cycle" , "Power Off" } IN
uint16 PowerState
Time indicates when the power state should be set, either as a regular date-time value or as an interval value (where the interval begins when the method invocation is received).
Qualifiers:IN
datetime Time
)
Note: The use of this method has been deprecated. Instead, use the SetPowerState method in the associated PowerManagementService class. Deprecated description: Sets the power state of the Device.
ValueMap { "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , "15" , "16" , "17" , "18" , "19" , "20" , "21" }
Values { "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" }
MappingStrings { "MIF.DMTF|Operational State|006.5" , "MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus" , "MIF.DMTF|Host Device|001.5" }
ModelCorrespondence { "CIM_LogicalDevice.AdditionalAvailability" }
Deprecated { "CIM_AssociatedPowerManagementService.PowerState" , "CIM_ManagedSystemElement.OperationalStatus" , "CIM_EnabledLogicalElement.EnabledState" }
uint16 Availability ;
Note: The use of this property has been deprecated.
Deprecated description: 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). The Power Save states 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; value 14 ('Power Save - Low Power Mode') indicates that the Device is in a power save state but still functioning, and might exhibit degraded performance; value 15 ('Power Save - Standby') indicates 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, but is also in a power save mode.
Deprecated { "CIM_EnabledLogicalElement.RequestStateChange" }
uint32EnableDevice(
If TRUE, enable the device. If FALSE, disable the device.
Qualifiers:IN
boolean Enabled
)
Note: The use of this method has been deprecated in lieu of the more general RequestStateChange method that directly overlaps with the functionality provided by this method.
Deprecated description: Requests that the LogicalDevice be enabled ('Enabled' input parameter=TRUE) or disabled (=FALSE). If successful, the StatusInfo or EnabledState properties of the Device should reflect the desired state (enabled or disabled). Note that this function overlaps with the RequestedState property. RequestedState was added to the model to maintain a record (for example, a persisted value) of the last state request. Invoking the EnableDevice method should set the RequestedState property appropriately.
The return code should be 0 if the request was successfully executed, 1 if the request is not supported, and some other value if an error occurred. In a subclass, the set of possible return codes could be specified by using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' can also be specified in the subclass as a Values array qualifier.
ValueMap { "1" , "2" , "3" , "4" , "5" }
Values { "Other" , "Unknown" , "Enabled" , "Disabled" , "Not Applicable" }
MappingStrings { "MIF.DMTF|Operational State|006.4" }
Deprecated { "CIM_EnabledLogicalElement.EnabledState" }
uint16 StatusInfo ;
Note: The use of this method is deprecated in lieu of a more clearly named property (EnabledState) that is inherited from ManagedSystemElement and that has additional enumerated values.
Deprecated description: The StatusInfo property indicates whether the Logical Device is in an enabled state (value=3), disabled state (value=4), some other state (value=1), or an unknown state (value=2). If this property does not apply to the LogicalDevice, the value 5 ('Not Applicable') should be used. If a Device is ('Enabled')(value=3), it has been powered up and is configured and operational. The Device might or might not be functionally active, depending on whether its Availability (or AdditionalAvailability) indicates that it is ('Running/Full Power')(value=3) or ('Off line') (value=8). In an enabled but offline mode, a Device might be performing out-of-band requests, such as running Diagnostics. If StatusInfo is ('Disabled') (value=4), a Device can only be 'enabled' or powered off. In a personal computer environment, ('Disabled') means that the driver of the device 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 it cannot be communicated with until a driver is loaded, a configuration file is loaded, or some other 'enabling' activity has occurred.
Deprecated { "CIM_PowerManagementCapabilities" }
boolean PowerManagementSupported ;
Note: The use of this property has been deprecated. Instead, the existence of an associated PowerManagementCapabilities class (associated using the ElementCapabilities relationship) indicates that power management is supported. Deprecated description: Boolean that indicates that the Device can use power management.
MaxLen ( 64 )
Key
string DeviceID ;
An address or other identifying information used to uniquely name the LogicalDevice.
MaxLen ( 256 )
Propagated ( "CIM_System.CreationClassName" )
Key
string SystemCreationClassName ;
The CreationClassName of the scoping system.
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" }
Values { "Unknown" , "Not Supported" , "Disabled" , "Enabled" , "Power Saving Modes Entered Automatically" , "Power State Settable" , "Power Cycling Supported" , "Timed Power On Supported" }
Deprecated { "CIM_PowerManagementCapabilities.PowerCapabilities" }
uint16 PowerManagementCapabilities [ ] ;
Note: The use of this property has been deprecated. Instead, use the PowerCapabilites property in an associated PowerManagementCapabilities class. Deprecated description: An enumerated array describing the power management capabilities of the Device.
Punit ( "hour" )
Counter
Units ( "Hours" )
Deprecated { "CIM_PoweredStatisticalData.PowerOnHours" }
uint64 PowerOnHours ;
Note: The use of this method is deprecated.
Deprecated description: The number of consecutive hours that this Device has been powered on since its last power cycle.
Deprecated { "CIM_ManagedSystemElement.OperationalStatus" }
boolean ErrorCleared ;
Note: The use of this method is deprecated.
Deprecated description: ErrorCleared is a Boolean property that indicates that the error reported in LastErrorCode is now cleared.
MaxLen ( 256 )
Key
string CreationClassName ;
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.
Deprecated { "CIM_EnabledLogicalElement.RequestStateChange" }
uint32QuiesceDevice(
If set to TRUE, then cleanly cease all activity. If FALSE, resume activity.
Qualifiers:IN
boolean Quiesce
)
Note: The use of this method has been deprecated in lieu of the more general RequestStateChange method that directly overlaps with the functionality provided by this method.
Deprecated description: Requests that the LogicalDevice cleanly cease all activity ('Quiesce' input parameter=TRUE) or resume activity (=FALSE). For this method to quiesce a Device, that Device should have an Availability (or Additional Availability) of 'Running/Full Power' (value=3) and an EnabledStatus/StatusInfo of 'Enabled'. For example, if quiesced, a Device can then be taken offline for diagnostics, or disabled for power off and hot swap. For the method to 'unquiesce' a Device, that Device should have an Availability (or AdditionalAvailability) of 'Quiesced' (value=21) and an EnabledStatus or StatusInfo of 'Enabled'. In this case, the Device would be returned to an 'Enabled' and 'Running/Full Power' status.
The return code of the method should indicate the success or failure of the quiesce. It should return 0 if successful, 1 if the request is not supported at all, 2 if the request is not supported due to the current state of the Device, and some other value if any other error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' can also be specified in the subclass as a Values array qualifier.
uint32Reset()
Requests a reset of the LogicalDevice. The return value should be 0 if the request was successfully executed, 1 if the request is not supported, and some other value if an error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' can also be specified in the subclass as a Values array qualifier.
datetime TimeOfLastStateChange ;
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.
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "4096" , "4097" , "4098" , "4099" , "4100..32767" , "32768..65535" }
Values { "Completed with No Error" , "Not Supported" , "Unknown or Unspecified Error" , "Cannot complete within Timeout Period" , "Failed" , "Invalid Parameter" , "In Use" , "DMTF Reserved" , "Method Parameters Checked - Job Started" , "Invalid State Transition" , "Use of Timeout Parameter Not Supported" , "Busy" , "Method Reserved" , "Vendor Specific" }
ModelCorrespondence { "CIM_EnabledLogicalElement.RequestedState" }
uint32RequestStateChange(
The state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 ('Completed with No Error'), 3 ('Timeout'), or 4096 (0x1000) ('Job Started'). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values.
Qualifiers:ValueMap { "2" , "3" , "4" , "6" , "7" , "8" , "9" , "10" , "11" , ".." , "32768..65535" } Values { "Enabled" , "Disabled" , "Shut Down" , "Offline" , "Test" , "Defer" , "Quiesce" , "Reboot" , "Reset" , "DMTF Reserved" , "Vendor Reserved" } ModelCorrespondence { "CIM_EnabledLogicalElement.RequestedState" } IN
uint16 RequestedState
Reference to the job (can be null if the task is completed).
Qualifiers:OUT IN ( false )
CIM_ConcreteJob REF Job
A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition.
If this property does not contain 0 or null and the implementation does not support this parameter, a return code of 'Use Of Timeout Parameter Not Supported' must be returned.

Qualifiers:IN
datetime TimeoutPeriod
)
Requests that the state of the element be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the EnabledState and RequestedState of the element will be the same. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten or lost.
If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If 4096 (0x1000) is returned, then the task will take some time to complete, ConcreteJob will be created, and its reference returned in the output parameter Job. Any other return code indicates an error condition.
ValueMap { "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , ".." , "32768..65535" }
Values { "Enabled" , "Disabled" , "Shut Down" , "No Change" , "Offline" , "Test" , "Deferred" , "Quiesce" , "Reboot" , "Reset" , "Not Applicable" , "DMTF Reserved" , "Vendor Reserved" }
ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" }
uint16 RequestedState = 12 ;
RequestedState is an integer enumeration that indicates 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 or disabled states. Note that when EnabledState is set to 5 ('Not Applicable'), then this property has no meaning. By default, the RequestedState of the element is 5 ('No Change'). Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration.
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.

A particular instance of EnabledLogicalElement might not support RequestedStateChange. If this occurs, the value 12 ('Not Applicable') is used.
ValueMap { "2" , "3" , "5" , "6" , "7" , "9" , ".." , "32768..65535" }
Values { "Enabled" , "Disabled" , "Not Applicable" , "Enabled but Offline" , "No Default" , "Quiesce" , "DMTF Reserved" , "Vendor Reserved" }
Write
uint16 EnabledDefault = 2 ;
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).
ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" }
string OtherEnabledState ;
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.
ValueMap { "0" , "1" , "2" , "3" , ".." , "0x8000.." }
Values { "Unknown" , "OK" , "Degraded" , "Error" , "DMTF Reserved" , "Vendor Reserved" }
Experimental
ModelCorrespondence { "CIM_ManagedSystemElement.DetailedStatus" , "CIM_ManagedSystemElement.HealthState" }
uint16 PrimaryStatus ;
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.
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , ".." , "0x8000.." }
Values { "Unknown" , "Not Available" , "In Service" , "Starting" , "Stopping" , "Stopped" , "Aborted" , "Dormant" , "Completed" , "Migrating" , "Emigrating" , "Immigrating" , "Snapshotting" , "Shutting Down" , "In Test" , "DMTF Reserved" , "Vendor Reserved" }
Experimental
ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" }
uint16 OperatingStatus ;
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).
'In Service' 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.
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11..32767" , "32768..65535" }
Values { "Unknown" , "Other" , "Enabled" , "Disabled" , "Shutting Down" , "Not Applicable" , "Enabled but Offline" , "In Test" , "Deferred" , "Quiesce" , "Starting" , "DMTF Reserved" , "Vendor Reserved" }
ModelCorrespondence { "CIM_EnabledLogicalElement.OtherEnabledState" }
uint16 EnabledState = 5 ;
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.
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , ".." , "0x8000.." }
Values { "Not Available" , "No Additional Information" , "Stressed" , "Predictive Failure" , "Non-Recoverable Error" , "Supporting Entity in Error" , "DMTF Reserved" , "Vendor Reserved" }
Experimental
ModelCorrespondence { "CIM_EnabledLogicalElement.PrimaryStatus" , "CIM_ManagedSystemElement.HealthState" }
uint16 DetailedStatus ;
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.
ValueMap { "0" , "1" , "2" , "3" , "4" , ".." , "0x8000.." }
Values { "Unknown" , "Not Available" , "Communication OK" , "Lost Communication" , "No Contact" , "DMTF Reserved" , "Vendor Reserved" }
Experimental
uint16 CommunicationStatus ;
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.
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , "15" , "16" , "17" , "18" , ".." , "0x8000.." }
ArrayType ( "Indexed" )
Values { "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" }
ModelCorrespondence { "CIM_ManagedSystemElement.StatusDescriptions" }
uint16 OperationalStatus [ ] ;
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.
ArrayType ( "Indexed" )
ModelCorrespondence { "CIM_ManagedSystemElement.OperationalStatus" }
string StatusDescriptions [ ] ;
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.
ValueMap { "OK" , "Error" , "Degraded" , "Unknown" , "Pred Fail" , "Starting" , "Stopping" , "Service" , "Stressed" , "NonRecover" , "No Contact" , "Lost Comm" , "Stopped" }
MaxLen ( 10 )
Deprecated { "CIM_ManagedSystemElement.OperationalStatus" }
string Status ;
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.
MappingStrings { "MIF.DMTF|ComponentID|001.5" }
datetime InstallDate ;
A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed.
MaxLen ( 1024 )
string Name ;
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.
ValueMap { "0" , "5" , "10" , "15" , "20" , "25" , "30" , ".." }
Values { "Unknown" , "OK" , "Degraded/Warning" , "Minor failure" , "Major failure" , "Critical failure" , "Non-recoverable error" , "DMTF Reserved" }
uint16 HealthState ;
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.
string ElementName ;
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.
MaxLen ( 64 )
string Caption ;
The Caption property is a short textual description (one- line string) of the object.
string Description ;
The Description property provides a textual description of the object.