SUMMARY: NESTED | FIELD | | METHOD
DETAIL: FIELD | METHOD

Class IPS_PowerManagementService


Compatible with the following Intel AMT Releases: 11.0 
CIM_ManagedElement
   extended by CIM_ManagedSystemElement
      extended by CIM_LogicalElement
         extended by CIM_EnabledLogicalElement
            extended by CIM_Service
               extended by CIM_PowerManagementService
                  extended by IPS_PowerManagementService


class IPS_PowerManagementService
 extends CIM_PowerManagementService


General Information:
The IPS_PowerManagementService inherits 
CIM_PowerManagementService and adds capability to control OS power 
state

Qualifiers:
-------------
Version=10.0









  
  

    Supported Fields 
      Summary

  

     uint16 
      
    RequestedState 
      
RequestedState is an integer enumeration that indicates the 
      last requested or desired state for the element, irrespective of the 
      mechanism through which it was requested . . .

  

     uint16 
      
    EnabledState 
      
EnabledState is an integer enumeration that indicates the 
      enabled and disabled states of an element . . .

  

     string 
      
    ElementName 
A 
      user-friendly name for the object . . .

  

     string 
      
    SystemCreationClassName Key  
The CreationClassName of the scoping 
      System.

  

     string 
      
    SystemName Key  
The Name of the scoping System.

  

     string 
      
    CreationClassName Key  
CreationClassName indicates the name 
      of the class or the subclass that is used in the creation of an instance . 
      . .

  

     string 
      
    Name Key  
The Name property uniquely identifies the 
      Service and provides an indication of the functionality that is managed . 
      . .

  

     uint16 
      
    OSPowerSavingState 
      
The current operating system power saving state of the 
      associated Managed System Element.




  
  

    Methods Summary

 

     uint32
    RequestOSPowerSavingStateChange(OSPowerSavingState, 
      REF ManagedElement, Time, REF Job, TimeoutPeriod) 
      
RequestOSPowerSavingStateChange defines the desired OS powersaving 
      state of the managed element, and when the element should be put into that 
      state . . .

  

     
    Get(Instance) 
Gets the 
      representation of the instance

  

     
    Pull(EnumerationContext, 
      MaxElements) 
Pulls instances of this class, following an 
      Enumerate operation

  

     
    Enumerate() 
      
Enumerates the instances of this class

  

     
    Release(EnumerationContext) 
      
Releases an enumeration context




  
  

    Field 
Detail


RequestedState 
public uint16 RequestedState



  
General Information:
RequestedState is an integer enumeration 
  that indicates the last requested or desired state for the element, 
  irrespective of the mechanism through which it was requested. 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. 
"Unknown" (0) indicates the 
  last requested state for the element is unknown.
Note that the value "No 
  Change" (5) has been 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) indicates that the element has been requested to 
  transition to the Enabled but Offline EnabledState. 
It should be noted 
  that there are two new values in RequestedState that build on the statuses of 
  EnabledState. These are "Reboot" (10) and "Reset" (11). Reboot refers to doing 
  a "Shut Down" and then moving to an "Enabled" state. Reset indicates that the 
  element is first "Disabled" and then "Enabled". The distinction between 
  requesting "Shut Down" and "Disabled" should also be noted. Shut Down requests 
  an orderly transition to the Disabled state, and might 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 shall be NULL or have the value 12 "Not 
  Applicable".

Qualifiers:
-------------
ValueMap={0, 2, 3, 
  4, 5, 6, 7, 8, 9, 10, 11, 12, .., 32768..65535}
Values={Unknown, Enabled, 
  Disabled, Shut Down, No Change, Offline, Test, Deferred, Quiesce, Reboot, 
  Reset, Not Applicable, DMTF Reserved, Vendor 
  Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.EnabledState}


  

  





EnabledState 
public uint16 EnabledState



  
General Information:
EnabledState is 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. The following text briefly summarizes the various enabled and 
  disabled states: 
Enabled (2) indicates that the element is or could be 
  executing commands, will process any queued commands, and queues new requests. 
  
Disabled (3) indicates that the element will not execute commands and will 
  drop any new requests. 
Shutting Down (4) indicates that the element is in 
  the process of going to a Disabled state. 
Not Applicable (5) indicates the 
  element does not support being enabled or disabled. 
Enabled but Offline 
  (6) indicates that the element might be completing commands, and will drop any 
  new requests. 
Test (7) indicates that the element is in a test state. 
  
Deferred (8) indicates that the element might be completing commands, but 
  will queue any new requests. 
Quiesce (9) indicates that the element is 
  enabled but in a restricted mode.
Starting (10) indicates that the element 
  is in the process of going to an Enabled state. New requests are 
  queued.

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4, 
  5, 6, 7, 8, 9, 10, 11..32767, 32768..65535}
Values={Unknown, Other, 
  Enabled, Disabled, Shutting Down, Not Applicable, Enabled but Offline, In 
  Test, Deferred, Quiesce, Starting, DMTF Reserved, Vendor 
  Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.OtherEnabledState}


  

  





ElementName 
public string ElementName



  
General Information:
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 that 
  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. Note that if there is an associated instance of 
  CIM_EnabledLogicalElementCapabilities, restrictions on this properties may 
  exist as defined in ElementNameMask and MaxElementNameLen properties defined 
  in that class.

Qualifiers:
-------------
MaxLen=37


  

  





SystemCreationClassName Key 
public string SystemCreationClassName



  
General Information:
The CreationClassName of the scoping 
  System.

Product Specific Usage:
In Intel AMT Release 10.0 and 
  later releases value is 
  "CIM_ComputerSystem"

Qualifiers:
-------------
Key
MaxLen=20
Propagated=CIM_System.CreationClassName


  

  





SystemName Key 
public string SystemName



  
General Information:
The Name of the scoping 
  System.

Product Specific Usage:
In Intel AMT Release 10.0 and 
  later releases value is "Intel(r) 
  AMT"

Qualifiers:
-------------
Key
MaxLen=16
Propagated=CIM_System.Name


  

  





CreationClassName Key 
public string CreationClassName



  
General Information:
CreationClassName indicates the name of the 
  class or the subclass that is used in the creation of an instance. When used 
  with the other key properties of this class, this property allows all 
  instances of this class and its subclasses to be uniquely 
  identified.

Product Specific Usage:
In Intel AMT Release 10.0 
  and later releases value is 
  "IPS_PowerManagementService"

Qualifiers:
-------------
Key
MaxLen=30


  

  





Name Key 
public string Name



  
General Information:
The Name property uniquely identifies the 
  Service and provides an indication of the functionality that is managed. This 
  functionality is described in more detail in the Description property of the 
  object.

Product Specific Usage:
In Intel AMT Release 10.0 and 
  later releases value is "Intel(r) AMT Power Management 
  Service"

Qualifiers:
-------------
Key
Override=Name
MaxLen=45


  

  





OSPowerSavingState 
public uint16 OSPowerSavingState



  
General Information:
The current operating system power saving 
  state of the associated Managed System 
  Element.

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 
  .., 0x7FFF..0xFFFF}
Values={Unknown, Unsupported, Full Power, OS power 
  saving, DMTF Reserved, Vendor 
  Specific}
ModelCorrespondence={CIM_PowerManagementCapabilities.OSPowerSavingStateSupported, 
  CIM_AssociatedPowerManagementService.PowerState}


  

  






  
  

    Method 
Detail




RequestOSPowerSavingStateChange
public uint32 RequestOSPowerSavingStateChange([IN]uint16 OSPowerSavingState, [IN]REF CIM_ManagedElement ManagedElement, [IN]datetime Time, [OUT]REF CIM_ConcreteJob Job, [IN]datetime TimeoutPeriod)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_REMOTE_CONTROL_REALM, 
  ADMIN_SECURITY_AGENT_PRESENCE_REMOTE_REALM

General 
  Information:
RequestOSPowerSavingStateChange defines the desired OS 
  powersaving state of the managed element, and when the element should be put 
  into that state. The RequestOSPowerSavingStateChange method has xxx input 
  parameters and a result code. 
- OSPowerSavingState indicates the desired 
  OS power saving state. 
- ManagedElement indicates the element whose OS 
  state is set. This element SHOULD be associated to the service using the 
  AssociatedPowerManagementService relationship. 
- Time indicates when the 
  OS power saving 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 expects the transition to take. 
  


Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4, 5, 
  6, .., 4096, 4097, 4098, 4099, 4100..32767, 32768..65535}
Values={Completed 
  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}


Parameters:
--------------

  

    
OSPowerSavingState 
    
General Information:
The OS power saving state for 
    ManagedElement.

Qualifiers:
-------------
IN
ValueMap={2, 
    3, .., 0x7FFF..0xFFFF}
Values={Full Power, OS power saving, DMTF 
    Reserved, Vendor Specific}


    
ManagedElement 
    
General Information:
ManagedElement indicates the element 
    whose state is set.

Qualifiers:
-------------
IN


    
Time 
    
General Information:
Time indicates when the OS power saving 
    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.

Qualifiers:
-------------
IN


    
Job 
    
General Information:
Reference to the job (can be null if the 
    task is 
    completed).

Qualifiers:
-------------
IN=false
OUT


    
TimeoutPeriod 
    
General Information:
A 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.

Qualifiers:
-------------
IN







Get
public  Get([OUT]IPS_PowerManagementService Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_REMOTE_CONTROL_REALM, 
  ADMIN_SECURITY_GENERAL_INFO_REALM

General Information:
Gets 
  the representation of the instance





Pull
public  Pull([IN]String EnumerationContext, [IN]String MaxElements)



  
Permission Information:
All users permitted to use method, only 
  instances to whom the user has permissions will be returned

General 
  Information:
Pulls instances of this class, following an Enumerate 
  operation





Enumerate
public  Enumerate()



  
Permission Information:
All users permitted to use 
  method

General Information:
Enumerates the instances of this 
  class





Release
public  Release([IN]String EnumerationContext)



  
Permission Information:
All users permitted to use 
  method

General Information:
Releases an enumeration 
  context






  
  

    SUMMARY: NESTED | FIELD | METHOD
  

  

    DETAIL: FIELD | METHOD



  
  

    
      
Copyright © 2006-2022, Intel 
      Corporation. All rights 
reserved.