ElementName
|
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
uniqueness within the NameSpace, the value of InstanceID should be
constructed using the following
preferred algorithm:
<OrgID> : <LocalID>
Where <OrgID> and <LocalID>
are separated by a colon (:), and where <OrgID> must include a
copyrighted, trademarked, or otherwise unique name that is owned by
the business entity that is creating or defining the InstanceID or
that is a registered ID assigned to the business entity by a recognized
global authority. (This requirement 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
should not be reused to identify different underlying (real-world)
elements. If the above
preferred algorithm is not used, the
defining entity must assure that the resulting InstanceID is not reused
across any InstanceIDs produced by this or other providers for the
NameSpace of this instance. 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.
|
TransitioningToState
|
Indicates the target state to which the instance is transitioning.
- 0 = Unknown
- 2 = Enabled
- 3 = Disabled
- 4 = Shut Down
- 5 = No Change — ndicates 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.
|