CIM_EnabledLogicalElement class

Represents a logical element that can be enabled and disabled.

Syntax

[Abstract, Version("2.22.0"), UMLPackagePath("CIM::Core::CoreElements"), AMENDMENT]
class CIM_EnabledLogicalElement : CIM_LogicalElement
{
  uint16   EnabledState = 5;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  uint16   AvailableRequestedStates[];
  uint16   TransitioningToState = 12;
};

Members

The CIM_EnabledLogicalElement class has these types of members:

• Methods
• Properties

Methods

The CIM_EnabledLogicalElement class has these methods.

Method	Description
RequestStateChange	Requests that the state of the element be changed to the specified value.

Properties

The CIM_EnabledLogicalElement class has these properties.

AvailableRequestedStates

Data type: uint16 array

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.RequestStateChange", "CIM_EnabledLogicalElementCapabilities.RequestedStatesSupported")

Indicates the possible values for the RequestedState parameter of the RequestStateChange method.

The listed values must be a subset of the values that are contained in the RequestedStatesSupported property of the associated CIM_EnabledLogicalElementCapabilities instance. This property is NULL if the implementation cannot determine the set of possible values for the current state of the element.

Enabled (2)

Disabled (3)

Shut Down (4)

Offline (6)

Test (7)

Defer (8)

Quiesce (9)

Reboot (10)

Reset (11)

DMTF Reserved (..)

EnabledDefault

Data type: uint16

Access type: Read/write

Indicates an administrator's default or startup configuration for the enabled state of an element. The default value Enabled (2).

Enabled (2)

Disabled (3)

Not Applicable (5)

Enabled but Offline (6)

No Default (7)

Quiesce (9)

DMTF Reserved (..)

Vendor Reserved (32768..65535)

EnabledState

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.OtherEnabledState")

Indicates the enabled state of an element. Possible values include the transitions between states. For example, Shutting Down (4) and Starting (10) are transient states between Enabled and Disabled.

Unknown (0)

Other (1)

Enabled (2)

The element is or could be executing commands, will process any queued commands, and queues new requests.

Disabled (3)

the element will not execute commands and will drop any new requests.

Shutting Down (4)

The element is in the process of going to a Disabled state.

Not Applicable (5)

The element does not support being enabled or disabled.

Enabled but Offline (6)

The element might be completing commands, and will drop any new requests.

In Test (7)

The element is in a test state.

Deferred (8)

The element might be completing commands, but will queue any new requests.

Quiesce (9)

That the element is enabled but in a restricted mode.

Starting (10)

The element is in the process of going to an Enabled state. New requests are queued.

DMTF Reserved (11..32767)

Vendor Reserved (32768..65535)

OtherEnabledState

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

Describes the state of the element when the value of the EnabledState property is Other. This property must be set to NULL when EnabledState is not Other.

RequestedState

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

Indicates the last requested state for the element. The current state is indicated by the EnabledState property. This property enables you to compare the last requested and current states.

Note

When the value of the EnabledState property is Not Applicable, this property has no meaning.

Unknown (0)

The last requested state for the element is unknown.

Enabled (2)

Disabled (3)

Requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests.

Shut Down (4)

Requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state.

No Change (5)

Deprecated in lieu 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)

The element has been requested to transition to the Enabled but Offline EnabledState.

Test (7)

Deferred (8)

Quiesce (9)

Reboot (10)

Refers to doing a "Shut Down" and then moving to an "Enabled" state.

Reset (11)

Indicates that the element is first "Disabled" and then "Enabled".

Not Applicable (12)

DMTF Reserved (..)

Vendor Reserved (32768..65535)

TimeOfLastStateChange

Data type: datetime

Access type: Read-only

Indicates when the element last changed state. If the state of the element has not changed and this property is populated, then it must be set to a zero interval value. If a state change was requested, but was rejected or is not yet processed, the property must not be updated.

TransitioningToState

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.RequestStateChange", "CIM_EnabledLogicalElement.RequestedState", "CIM_EnabledLogicalElement.EnabledState")

Indicates the target state to which the instance is changing.

A value of No Change indicates that no transition is in progress. A value of Not Applicable indicates that the implementation does not report ongoing transitions.

Unknown (0)

Enabled (2)

Disabled (3)

Shut Down (4)

No Change (5)

Offline (6)

Test (7)

Defer (8)

Quiesce (9)

Reboot (10)

Reset (11)

Not Applicable (12)

DMTF Reserved (..)

Requirements

Requirement	Value
Minimum supported client	Windows 8
Minimum supported server	Windows Server 2012
Namespace	Root\virtualization\v2
MOF	WindowsVirtualization.V2.mof
DLL	Vmms.exe

See also

CIM_LogicalElement