Reference Guide

The Reference Guide contains the
file:///T|/htdocs/SOFTWARE/smcliins/cli81/en/refgd/index.html[10/19/2012 10:01:19 AM]
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.
Possible values are:
0 = Unknown - The implementation cannot report on HealthState at this time. DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.
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
.. = DMTF Reserved - The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost.
IRQLevel An integer value that represents the IRQ level used by the serial port.
MaxSpeed The maximum bandwidth of the Port in Bits per Second.
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.
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.
PortType
PortType is defined to force consistent naming of the 'type' property in subclasses and to guarantee unique enum values for all instances of NetworkPort. When set to 1 ("Other"), related property OtherPortType contains a
string description of the type of port. A range of values, DMTF_Reserved, has been defined that allows subclasses to override and define their specific types of ports.
Possible values are:
0 = Unknown
1 = Other
2 = Not Applicable
3..15999 = DMTF Reserved
16192 = Parallel Port
16193 = Serial Port
16194 = Pointing Device
16195 = Keyboard
16196 = Processor
16197 = Memory Device
16198 = USB
16199 = Monitor
16200 = SCSI
16201..65535 = Vendor Reserved
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.