Reference Guide

The Reference Guide contains the
file:///T|/htdocs/SOFTWARE/smcliins/cli81/en/refgd/index.html[10/19/2012 10:01:19 AM]
(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.
6 = Enabled but Offline - Indicates that the element may be completing commands, and will drop any new requests.
7 = In Test - Indicates that the element is in a test state.
8 = Deferred - Indicates that the element may be completing commands, but will queue any new requests.
9 = Quiesce - Indicates that the element is enabled but in a restricted mode.
10 = Starting - Indicates that the element is in the process of going to an Enabled state. New requests are queued.
11..32767 = DMTF Reserved
32768..65535 = Vendor Reserved
HealthState
Indicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents.
DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.
Possible values are:
0 = Unknown - The implementation cannot report on HealthState at this time.
5 = OK - The element is fully functional and is operating within normal operational parameters and without error.
10 = Degraded/Warning - 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 may not be operating at optimal
performance or it may be reporting recoverable errors.
15 = Minor failure - All functionality is available but some may be degraded.
20 = Major failure - The element is failing. It is possible that some or all of the functionality of this component is degraded or not working.
25 = Critical failure - The element is non-functional and recovery may not be possible.
30 = Non-recoverable error - The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost.
.. = DMTF Reserved
InstanceID
Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class.
To ensure the uniqueness within the NameSpace, the value of InstanceID must be constructed using the following 'preferred' algorithm:
<OrgID>:<LocalID>
Where <OrgID> and <LocalID> are separated by a colon ':' and <OrgID> must include a copyrighted, trademarked or otherwise unique name that is owned by the business entity creating/defining the InstanceID, or is a
registered ID that is assigned to the business entity by a recognized global authority (this 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 must not be re-used to identify different underlying (real-world) elements. If the above 'preferred' algorithm is not used, the defining entity must assure that the resultant