Reference Guide

Dell OpenManage Client Instrumentation Reference Guide
file:///T|/htdocs/SOFTWARE/smcliins/cli80/EN/refgd/index.htm[10/19/2012 9:56:27 AM]
OtherIdentifyingInfo
Captures additional data, beyond System Name information, that could be used to identify a ComputerSystem. One example would be to hold
the Fibre Channel World-Wide Name (WWN) of a node.
Note: If only the Fibre Channel name is available and is unique (able to be used as the System key), then this property would be NULL and the
WWN would become the System key, its data placed in the Name property.
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
7 - Test
8 - Deferred
9 - Quiesce
10 - Reboot - Indicates 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). Offline (6) indicates
that the element has been requested to transition to the Enabled but Offline EnabledState.
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".
TransitioningToState
Indicates the target state to which the instance is transitioning.
Possible values are:
0 - Unknown
2 - Enabled
3 - Disabled
4 - Shut Down
5 - No Change - Indicates that no transition is in progress.
6 - Offline
7 - Test
8 - Defer
9 - Quiesce
10 - Reboot
11 - Reset
12 - Not Applicable - Indicates the implementation does not support representing ongoing transitions
A value other than 5 or 12 identifies the state to which the element is in the process of transitioning.
RequestStateChange (Method)
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.
A return code of 0 shall indicate the state change was successfully initiated.
A return code of 3 shall indicate that the state transition cannot complete within the interval specified by the TimeoutPeriod parameter.
A return code of 4096 (0x1000) shall indicate the state change was successfully initiated, a ConcreteJob has been created, and its reference
returned in the output parameter Job. Any other return code indicates an error condition.
DCIM_RecordLog
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: 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.
EnabledDefault
An enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element.
Possible values are:
2 - Enabled
3 - Disabled
5 - Not Applicable
6 - Enabled but Offline
7 - No Default
9 - Quiesce
.. - DMTF Reserved
32768..65535 - Vendor Reserved
By default, the element is "Enabled" (value=2).
EnabledState
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.
Possible values are:
0 - Unknown
1 - Other
2 - Enabled - Indicates that the element is or could be executing commands, will process any queued commands, and queues new requests.
3 - Disabled - Indicates that the element will not execute commands and will drop any new requests.
4 - Shutting Down - Indicates that the element is in the process of going to a Disabled state.
5 - Not Applicable - Indicates the element does not support being enabled or disabled.