Skip to content

Latest commit

 

History

History
159 lines (115 loc) · 7.12 KB

LMI_PowerManagementService.rst

File metadata and controls

159 lines (115 loc) · 7.12 KB

LMI_PowerManagementService

Class reference

Subclass of :ref:`CIM_PowerManagementService <CIM-PowerManagementService>`

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.

Key properties

Local properties

None

Local methods

uint32 RequestPowerStateChange (uint16 PowerState, :ref:`CIM_ManagedElement <CIM-ManagedElement>` ManagedElement, datetime Time, :ref:`CIM_ConcreteJob <CIM-ConcreteJob>` Job, datetime TimeoutPeriod)

RequestPowerStateChange 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.

ValueMap Values
0 Completed with No Error
1 Not Supported
2 Unknown or Unspecified Error
3 Cannot complete within Timeout Period
4 Failed
5 Invalid Parameter
6 In Use
  DMTF Reserved
4096 Method Parameters Checked - Job Started
4097 Invalid State Transition
4098 Use of Timeout Parameter Not Supported
4099 Busy
4100..32767 Method Reserved
32768..65535 Vendor Specific

Parameters

IN uint16 PowerState

The power state for ManagedElement.

ValueMap Values
2 Power On
3 Sleep - Light
4 Sleep - Deep
5 Power Cycle (Off Soft)
6 Power Off - Hard
7 Hibernate
8 Power Off - Soft
9 Power Cycle (Off Hard)
10 Master Bus Reset
11 Diagnostic Interrupt (NMI)
12 Power Off - Soft Graceful
13 Power Off - Hard Graceful
14 Master Bus Reset Graceful
15 Power Cycle (Off - Soft Graceful)
16 Power Cycle (Off - Hard Graceful)
IN :ref:`CIM_ManagedElement <CIM-ManagedElement>` ManagedElement
ManagedElement indicates the element whose state is set.
IN datetime Time
Time parameter is not currently supported.
OUT :ref:`CIM_ConcreteJob <CIM-ConcreteJob>` Job
Reference to the job.
IN datetime TimeoutPeriod
TimeoutPeriod is not currently supported.

Inherited properties

Inherited methods