Reference Guide

The Reference Guide contains the
file:///T|/htdocs/SOFTWARE/smcliins/cli81/en/refgd/index.html[10/19/2012 10:01:19 AM]
InstanceID is not re-used across any InstanceIDs produced by this or other providers for this instance's NameSpace.
For DMTF defined instances, the 'preferred' algorithm must be used with the <OrgID> set to 'CIM'.
LogState
LogState is an integer enumeration that indicates the current state of a log represented by CIM_Log subclasses. LogState is to be used in conjunction with the EnabledState property to fully describe the current state of the
log.
Possible values are:
0 = Unknown - Indicates the state of the log is unknown.
2 = Normal - Indicates that the log is or could be executing logging commands, will process any queued log entries, and will queue new logging requests.
3 = Erasing - Indicates that the log is being erased.
4 = Not Applicable - Indicates the log does not support representing a log state.
.. = DMTF Reserved
32768..65535 = Vendor Reserved
MaxNumberOfRecords Maximum number of records that can be captured in the Log. If undefined, a value of zero should be specified.
OperationalStatus
Indicates the current statuses of the element. Various operational statuses are defined. Many of the enumeration's values are self-explanatory.
Possible values are:
0 = Unknown
1 = Other
2 = OK
3 = Degraded
4 = Stressed - Indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, and so on.
5 = Predictive Failure - Indicates that an element is functioning nominally but predicting a failure in the near future.
6 = Error
7 = Non-Recoverable Error
8 = Starting
9 = Stopping
10 = Stopped - Implies a clean and orderly stop
11 = In Service - Describes an element being configured, maintained, cleaned, or otherwise administered.
12 = No Contact - Indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it.
13 = Lost Communication - Indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable.
14 = Aborted - Implies an abrupt stop where the state and configuration of the element may need to be updated.
15 = Dormant - Indicates that the element is inactive or quiesced.
16 = Supporting Entity in Error - Indicates 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.
17 = 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).
18 = Power Mode - Indicates that the element has additional power model information contained in the Associated PowerManagementService association.
.. = DMTF Reserved
0x8000.. = Vendor Reserved
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.
OverwritePolicy
OverwritePolicy is an integer enumeration that indicates whether the log, represented by the CIM_Log subclasses, can overwrite its entries.
Possible values are:
0 = Unknown - Indicates the log's overwrite policy is unknown.
2 = Wraps When Full - Indicates that the log overwrites its entries with new entries when the log has reached its maximum capacity.
7 = Never Overwrites - Indicates that the log never overwrites its entries by the new entries
.. = DMTF Reserved
32768..65535 = Vendor Reserved
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.
Possible values are:
0 = Unknown - Indicates the implementation is in general capable of returning this property, but is unable to do so at this time.
1 = OK - Indicates the ManagedElement is functioning normally.
2 = Degraded - Indicates the ManagedElement is functioning below normal.
3 = Error - Indicates the ManagedElement is in an Error condition.
.. = DMTF Reserved
0x8000.. = Vendor Reserved
RequestedState
An integer enumeration that indicates the last requested or desired state for the element, irrespective of the mechanism through which it was requested.
Possible values are:
0 = Unknown - Indicates the last requested state for the element is unknown.
2 = Enabled
3 = Disabled
4 = Shut Down
5 = No Change
6 = Offline - Indicates that the element has been requested to transition to the Enabled but Offline EnabledState.
7 = Test
8 = Deferred
9 = Quiesce
10 = Reboot - Refers to doing a "Shut Down" and then moving to an "Enabled" state.
11 = Reset - Indicates that the element is first "Disabled" and then "Enabled".
12 = Not Applicable
.. = DMTF Reserved
32768..65535 = Vendor Reserved
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.
Note: The value "No Change" (5) has been deprecated instead 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).
There are two new values in RequestedState that build on the statuses of EnabledState. These are "Reboot" (10) and "Reset" (11).
Shut Down requests an orderly transition to the Disabled state, and may 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 is NULL or has the value 12 "Not Applicable".
Indicates the target state to which the instance is transitioning.