Reference Guide

The Reference Guide contains the
file:///T|/htdocs/SOFTWARE/smcliins/cli81/en/refgd/index.html[10/19/2012 10:01:19 AM]
CommunicationStatus
0 = Unknown - Indicates the implementation is in general capable of returning this property, but is unable to do so at this time.
1 = 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).
2 = Communication OK - Indicates communication is established with the element, but does not convey any quality of service.
3 = Lost Communication - Indicates that the Managed Element is known to exist and has been contacted successfully in the past, but is currently unreachable.
4 = No Contact - Indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it.
.. = DMTF Reserved
0x8000.. = Vendor Reserved
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.
Description Provides a textual description of the object.
DeviceID An address or other identifying information used to uniquely name the LogicalDevice.
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. By default, the element is "Enabled" (value=2).
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
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
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.
RequestedState
An integer enumeration that indicates the last requested or desired state for the element, irrespective of the mechanism through which it was requested. 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".
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
SystemCreationClassName The CreationClassName of the scoping system.
SystemName The System Name of the scoping system.
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.