1 marek 1.1 // Copyright (c) 2008 DMTF.  All Rights Reserved.
  2              [Version ( "2.19.1" ), 
  3               UMLPackagePath ( "CIM::Core::PowerMgmt" ), 
  4               Description ( 
  5                  "A class derived from Service that describes power management "
  6                  "functionality, hosted on a System. Whether this service might "
  7                  "be used to affect the power state of a particular element is "
  8                  "defined by the CIM_ServiceAvailable ToElement association." )]
  9           class CIM_PowerManagementService : CIM_Service {
 10           
 11           
 12                 [Deprecated { 
 13                     "CIM_PowerManagementService.RequestPowerStateChange" }, 
 14                  Description ( 
 15                     "The CIM_PowerManagementService.RequestPowerStateChange "
 16                     "method should be used instead of SetPowerState method, "
 17                     "which is deprecated. SetPowerState defines the desired "
 18                     "power state of the managed element and when the element "
 19                     "should be put into that state. The SetPowerState method "
 20                     "has three input parameters, no output parameters, and a "
 21                     "result. \n"
 22 marek 1.1           "- PowerState indicates the desired power state. \n"
 23                     "- ManagedElement indicates the element whose state is "
 24                     "set. This element should be associated with the service "
 25                     "using the ServiceAvailableToElement relationship. \n"
 26                     "- Time indicates when the power state should be set, "
 27                     "either as a regular date-time value or as an interval "
 28                     "value (where the interval begins when the method "
 29                     "invocation is received). \n"
 30                     "Note that when the PowerState parameter is equal to 5, "
 31                     "\"Power Cycle (Off -Soft)\", the Time parameter "
 32                     "indicates when the managed element should be powered on "
 33                     "again. Power-off is immediate. \n"
 34                     "SetPowerState should return 0 if successful, 1 if the "
 35                     "specified State and Time request is not supported for "
 36                     "the element, and some other value if any other error "
 37                     "occurred. In a subclass, the set of possible return "
 38                     "codes could be specified, using a ValueMap qualifier on "
 39                     "the method. The strings to which the ValueMap contents "
 40                     "are \'translated\' can also be specified in the subclass "
 41                     "as a Values array qualifier." )]
 42              uint32 SetPowerState(
 43 marek 1.1          [IN, Description ( "The power state for ManagedElement." ), 
 44                     ValueMap { "1", "2", "3", "4", "5", "6", "7", "8" }, 
 45                     Values { "On", "Sleep - Light", "Sleep -Deep", 
 46                        "Vendor Specific", "Power Cycle (Off - Soft)", 
 47                        "Off - Hard", "Hibernate (Off - Soft)", "Off - Soft" }, 
 48                     MappingStrings { "IEEE P1621 | 3.2" }]
 49                 uint16 PowerState, 
 50                    [IN, Description ( 
 51                        "ManagedElement indicates the element whose state is set."
 52                         )]
 53                 CIM_ManagedElement REF ManagedElement, 
 54                    [IN, Description ( 
 55                        "Time indicates when the power state should be set, "
 56                        "either as a regular date-time value or as an "
 57                        "interval value (where the interval begins when the "
 58                        "method invocation is received." )]
 59                 datetime Time);
 60           
 61                 [Description ( 
 62                     "RequestPowerStateChange defines the desired power state "
 63                     "of the managed element, and when the element should be "
 64 marek 1.1           "put into that state. The RequestPowerStateChange method "
 65                     "has five input parameters and a result code. \n"
 66                     "- PowerState indicates the desired power state. \n"
 67                     "- ManagedElement indicates the element whose state is "
 68                     "set. This element SHOULD be associated to the service "
 69                     "using the AssociatedPowerManagementService relationship. \n"
 70                     "- Time indicates when the power state should be set, "
 71                     "either as a regular date-time value or as an interval "
 72                     "value (where the interval begins when the method "
 73                     "invocation is received). \n"
 74                     "- Job is a reference to the job if started. \n"
 75                     "- TimeOutPeriod indicates the maximum amount of time a "
 76                     "client is expects the transition to take. \n"
 77                     "See CIM_PowerStateCapabilities for descriptions of "
 78                     "PowerState parameter enumerations." ), 
 79                  ValueMap { "0", "1", "2", "3", "4", "5", "6", "..", "4096", 
 80                     "4097", "4098", "4099", "4100..32767", "32768..65535" }, 
 81                  Values { "Completed with No Error", "Not Supported", 
 82                     "Unknown or Unspecified Error", 
 83                     "Cannot complete within Timeout Period", "Failed", 
 84                     "Invalid Parameter", "In Use", "DMTF Reserved", 
 85 marek 1.1           "Method Parameters Checked - Job Started", 
 86                     "Invalid State Transition", 
 87                     "Use of Timeout Parameter Not Supported", "Busy", 
 88                     "Method Reserved", "Vendor Specific" }]
 89              uint32 RequestPowerStateChange(
 90                    [IN, Description ( "The power state for ManagedElement." ), 
 91                     ValueMap { "2", "3", "4", "5", "6", "7", "8", "9", 
 92                        "10", "11", "12", "13", "14", "15", "16" }, 
 93                     Values { "Power On", "Sleep - Light", "Sleep - Deep", 
 94                        "Power Cycle (Off Soft)", "Power Off - Hard", 
 95                        "Hibernate", "Power Off - Soft", 
 96                        "Power Cycle (Off Hard)", "Master Bus Reset", 
 97                        "Diagnostic Interrupt (NMI)", 
 98                        "Power Off - Soft Graceful", 
 99                        "Power Off - Hard Graceful", 
100                        "Master Bus Reset Graceful", 
101                        "Power Cycle (Off - Soft Graceful)", 
102                        "Power Cycle (Off - Hard Graceful)" }]
103                 uint16 PowerState, 
104                    [IN, Description ( 
105                        "ManagedElement indicates the element whose state is set."
106 marek 1.1               )]
107                 CIM_ManagedElement REF ManagedElement, 
108                    [IN, Description ( 
109                        "Time indicates when the power state should be set, "
110                        "either as a regular date-time value or as an "
111                        "interval value (where the interval begins when the "
112                        "method invocation is received." )]
113                 datetime Time, 
114                    [IN ( false ), OUT, Description ( 
115                        "Reference to the job (can be null if the task is completed)."
116                         )]
117                 CIM_ConcreteJob REF Job, 
118                    [IN, Description ( 
119                        "A timeout period that specifies the maximum amount "
120                        "of time that the client expects the transition to "
121                        "the new state to take. The interval format must be "
122                        "used to specify the TimeoutPeriod. A value of 0 or "
123                        "a null parameter indicates that the client has no "
124                        "time requirements for the transition. \n"
125                        "If this property does not contain 0 or null and "
126                        "the implementation does not support this "
127 marek 1.1              "parameter, a return code of \'Use Of Timeout "
128                        "Parameter Not Supported\' must be returned." )]
129                 datetime TimeoutPeriod);
130           
131           };