Class CIM_PowerManagementService
extends CIM_Service

A class derived from Service that describes power management functionality, hosted on a System. Whether this service might be used to affect the power state of a particular element is defined by the CIM_ServiceAvailable ToElement association.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_Service
   |
   +--CIM_PowerManagementService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringA class derived from Service that describes power management functionality, hosted on a System. Whether this service might be used to affect the power state of a particular element is defined by the CIM_ServiceAvailable ToElement association.
UMLPackagePathstringCIM::Core::PowerMgmt
Versionstring2.19.1

Class Properties

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
NamestringCIM_Service
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_Service
PrimaryOwnerNamestringCIM_Service
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StartedbooleanCIM_Service
StartModestringCIM_Service
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_Service
SystemNamestringCIM_Service
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

SetPowerState (uint32)

Method Qualifiers (SetPowerState)

NameData TypeValue
DeprecatedstringCIM_PowerManagementService.RequestPowerStateChange
DescriptionstringThe CIM_PowerManagementService.RequestPowerStateChange method should be used instead of SetPowerState method, which is deprecated. SetPowerState defines the desired power state of the managed element and when the element should be put into that state. The SetPowerState method has three input parameters, no output parameters, and a result. - PowerState indicates the desired power state. - ManagedElement indicates the element whose state is set. This element should be associated with the service using the ServiceAvailableToElement relationship. - Time indicates when the power state should be set, either as a regular date-time value or as an interval value (where the interval begins when the method invocation is received). Note that when the PowerState parameter is equal to 5, "Power Cycle (Off -Soft)", the Time parameter indicates when the managed element should be powered on again. Power-off is immediate. SetPowerState should return 0 if successful, 1 if the specified State and Time request is not supported for the element, and some other value if any other error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' can also be specified in the subclass as a Values array qualifier.

Method Parameters (SetPowerState)

NameTypeQualifiers
NameData TypeValue
PowerStateuint16
DescriptionstringThe power state for ManagedElement.
INbooleantrue
MappingStringsstringIEEE P1621 | 3.2
ValueMapstring1, 2, 3, 4, 5, 6, 7, 8
ValuesstringOn, Sleep - Light, Sleep -Deep, Vendor Specific, Power Cycle (Off - Soft), Off - Hard, Hibernate (Off - Soft), Off - Soft
Timedatetime
DescriptionstringTime indicates when the power state should be set, either as a regular date-time value or as an interval value (where the interval begins when the method invocation is received.
INbooleantrue
ManagedElement REF CIM_ManagedElement
DescriptionstringManagedElement indicates the element whose state is set.
INbooleantrue

RequestPowerStateChange (uint32)

Method Qualifiers (RequestPowerStateChange)

NameData TypeValue
DescriptionstringRequestPowerStateChange defines the desired power state of the managed element, and when the element should be put into that state. The RequestPowerStateChange method has five input parameters and a result code. - PowerState indicates the desired power state. - ManagedElement indicates the element whose state is set. This element SHOULD be associated to the service using the AssociatedPowerManagementService relationship. - Time indicates when the power state should be set, either as a regular date-time value or as an interval value (where the interval begins when the method invocation is received). - Job is a reference to the job if started. - TimeOutPeriod indicates the maximum amount of time a client is expects the transition to take. See CIM_PowerStateCapabilities for descriptions of PowerState parameter enumerations.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097, 4098, 4099, 4100..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown or Unspecified Error, Cannot complete within Timeout Period, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Invalid State Transition, Use of Timeout Parameter Not Supported, Busy, Method Reserved, Vendor Specific

Method Parameters (RequestPowerStateChange)

NameTypeQualifiers
NameData TypeValue
PowerStateuint16
DescriptionstringThe power state for ManagedElement.
INbooleantrue
ValueMapstring2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16
ValuesstringPower On, Sleep - Light, Sleep - Deep, Power Cycle (Off Soft), Power Off - Hard, Hibernate, Power Off - Soft, Power Cycle (Off Hard), Master Bus Reset, Diagnostic Interrupt (NMI), Power Off - Soft Graceful, Power Off - Hard Graceful, Master Bus Reset Graceful, Power Cycle (Off - Soft Graceful), Power Cycle (Off - Hard Graceful)
Timedatetime
DescriptionstringTime indicates when the power state should be set, either as a regular date-time value or as an interval value (where the interval begins when the method invocation is received.
INbooleantrue
TimeoutPerioddatetime
DescriptionstringA timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation does not support this parameter, a return code of 'Use Of Timeout Parameter Not Supported' must be returned.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (can be null if the task is completed).
INbooleanfalse
OUTbooleantrue
ManagedElement REF CIM_ManagedElement
DescriptionstringManagedElement indicates the element whose state is set.
INbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service