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

Class CIM_BootService

Used in features: Remote Control
Compatible with the following Intel AMT Releases: 3.0, 3.2, 4.0, 5.0, 5.1, 6.0, 6.1, 6.2, 7.0, 8.0, 8.1, 9.0, 9.5, 10.0, 11.0 
CIM_ManagedElement
   extended by CIM_ManagedSystemElement
      extended by CIM_LogicalElement
         extended by CIM_EnabledLogicalElement
            extended by CIM_Service
               extended by CIM_BootService
Also see:
AMT_BootSettingData
class CIM_BootService
 extends CIM_Service


General Information:
A class derived from Service that provides the 
controls to manage the boot configuration of a managed computer system or 
device. This includes changing the order of the boot devices and affecting 
settings on managed elements during the boot process. This service can also 
affect the load of a specific operating system on the computer system through a 
BootSourceSetting that points to a specific operating system 
image.

Qualifiers:
-------------
Version=2.19.0
UMLPackagePath=CIM::System::Boot









  
  

    Supported Fields 
      Summary

  

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

  

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

  

     string 
      
    SystemName Key  
The Name of the scoping System.

  

     string 
      
    SystemCreationClassName Key  
The CreationClassName of the scoping 
      System.

  

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

  

     uint16[] 
      
    OperationalStatus 
      
Indicates the current statuses of the element . . .

  

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

  

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




  
  

    Methods Summary

  

     uint32
    SetBootConfigRole(REF 
      BootConfigSetting, Role, REF Job) 
This method is called to set 
      the role of the BootConfigSetting that is directly or indirectly 
      associated to one or more ComputerSystems . . .

  

     
    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

	  
	    

     uint32
    RequestStateChange(RequestedState, REF 
      Job, TimeoutPeriod) 
Requests that the state of the element be 
      changed to the value specified in the RequestedState parameter . . 
.

  

	  
	  




  
  

    Field 
Detail


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 6.0 and 
  later releases value is "Intel(r) AMT Boot 
  Service"

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


  

  





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 6.0 
  and later releases value is 
  "CIM_BootService"

Qualifiers:
-------------
Key
MaxLen=20


  

  





SystemName Key 
public string SystemName



  
General Information:
The Name of the scoping 
  System.

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

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


  

  





SystemCreationClassName Key 
public string SystemCreationClassName



  
General Information:
The CreationClassName of the scoping 
  System.

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

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


  

  





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.

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

Qualifiers:
-------------
MaxLen=25


  

  





OperationalStatus 
public uint16[] OperationalStatus



  
General Information:
Indicates the current statuses of the 
  element. Various operational statuses are defined. Many of the enumeration's 
  values are self-explanatory. However, a few are not and are described here in 
  more detail. 
"Stressed" indicates that the element is functioning, but 
  needs attention. Examples of "Stressed" states are overload, overheated, and 
  so on. 
"Predictive Failure" indicates that an element is functioning 
  nominally but predicting a failure in the near future. 
"In Service" 
  describes an element being configured, maintained, cleaned, or otherwise 
  administered. 
"No Contact" indicates that the monitoring system has 
  knowledge of this element, but has never been able to establish communications 
  with it. 
"Lost Communication" indicates that the ManagedSystem Element is 
  known to exist and has been contacted successfully in the past, but is 
  currently unreachable. 
"Stopped" and "Aborted" are similar, although the 
  former implies a clean and orderly stop, while the latter implies an abrupt 
  stop where the state and configuration of the element might need to be 
  updated. 
"Dormant" indicates that the element is inactive or quiesced. 
  
"Supporting Entity in Error" indicates that this element might be "OK" but 
  that another element, on which it is dependent, is in error. An example is a 
  network service or endpoint that cannot function due to lower-layer networking 
  problems. 
"Completed" indicates that the element has completed its 
  operation. This value should be combined with either OK, Error, or Degraded so 
  that a client can tell if the complete operation Completed with OK (passed), 
  Completed with Error (failed), or Completed with Degraded (the operation 
  finished, but it did not complete OK or did not report an error). 
"Power 
  Mode" indicates that the element has additional power model information 
  contained in the Associated PowerManagementService association. 
  
"Relocating" indicates the element is being 
  relocated.
OperationalStatus replaces the Status property on 
  ManagedSystemElement to provide a consistent approach to enumerations, to 
  address implementation needs for an array property, and to provide a migration 
  path from today's environment to the future. This change was not made earlier 
  because it required the deprecated qualifier. Due to the widespread use of the 
  existing Status property in management applications, it is strongly 
  recommended that providers or instrumentation provide both the Status and 
  OperationalStatus properties. Further, the first value of OperationalStatus 
  should contain the primary status for the element. When instrumented, Status 
  (because it is single-valued) should also provide the primary status of the 
  element.

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 
  4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, .., 
  0x8000..}
Values={Unknown, Other, OK, Degraded, Stressed, Predictive 
  Failure, Error, Non-Recoverable Error, Starting, Stopping, Stopped, In 
  Service, No Contact, Lost Communication, Aborted, Dormant, Supporting Entity 
  in Error, Completed, Power Mode, Relocating, DMTF Reserved, Vendor 
  Reserved}
ArrayType=Indexed
ModelCorrespondence={CIM_ManagedSystemElement.StatusDescriptions}


  

  





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.

  Values of 32768 and 32769 (relevant from Intel CSME 15 onwards) indicate whether the Intel® One-Click Recovery feature is enabled (32769) or disabled (32768). In Intel CSME 16 onwards, 32768 and 32769 have additional meaning, and 32771 and 32770 indicate whether Intel RPE is enabled or disabled. See Qualifiers below for details.
 
  
  Default: 32769 (Intel One-Click Recovery enabled, Intel RPE is disabled, and all other boot options are enabled. Note that Intel RPE is relevant from Intel CSME 16 onwards.)
  
  

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4, 
  5, 6, 7, 8, 9, 10, 11..32767, 32768, 32769, 32770, 32771, 32772..65535}
Values={ Unknown, Other, 
  Enabled, Disabled, Shutting Down, Not Applicable, Enabled but Offline, In 
  Test, Deferred, Quiesce, Starting, DMTF Reserved, Intel One-Click Recovery and Intel RPE are disabled and all other boot options are enabled, Intel One-Click Recovery is enabled and Intel RPE is disabled and all other boot options are enabled, Intel RPE is enabled and Intel One-Click Recovery is disabled and all other boot options are enabled, Intel One-Click Recovery and Intel RPE are enabled and all other boot options are enabled, Vendor 
  Reserved }
ModelCorrespondence={CIM_EnabledLogicalElement.OtherEnabledState}


  

  





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

 Values of 32768 and 32769 (relevant from Intel CSME 15 onwards) indicate whether the Intel® One-Click Recovery feature is enabled (32769) or disabled (32768). In Intel CSME 16 onwards, 32768 and 32769 have additional meaning, and 32771 and 32770 indicate whether Intel RPE is enabled or disabled.  See Qualifiers below for details.
  
 Default: 32769 (Intel One-Click Recovery enabled, Intel RPE is disabled, and all other boot options are enabled. Note that Intel RPE is relevant from Intel CSME 16 onwards.)


  
Qualifiers:
-------------
ValueMap={0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 
             11, 12, .., 32768, 32769, 32770, 32771, 32772..65535 }

Values={ Unknown, Enabled, Disabled, Shut Down, No Change, Offline, 
             Test, Deferred, Quiesce, Reboot, Reset, Not Applicable, DMTF Reserved, 
              Disable Intel One-Click Recovery and Intel RPE and enable all other boot options, disable Intel RPE and enable Intel One-Click Recovery and all other boot options, disable Intel One-Click Recovery and enable Intel RPE and all other boot options, 
             Enable all boot options, Vendor Reserved }

ModelCorrespondence={CIM_EnabledLogicalElement.RequestedState}


  

  






  
  

    Method 
Detail


SetBootConfigRole
public uint32 SetBootConfigRole([IN]REF CIM_BootConfigSetting BootConfigSetting, [IN]uint16 Role, [OUT]REF CIM_ConcreteJob Job)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_REMOTE_CONTROL_REALM, 
  ADMIN_SECURITY_LOCAL_SYSTEM_REALM

General Information:
This 
  method is called to set the role of the BootConfigSetting that is directly or 
  indirectly associated to one or more ComputerSystems. The method applies the 
  new role equally to all related ComputerSystems. If a BootConfigSetting can be 
  related to more than one ComputerSystem, but role modification applies to just 
  one of them, the SetBootConfigUsage method shall be used instead.
The 
  method shall update the IsNext or IsDefault property of every 
  ElementSettingData that directly or indirectly associates BootConfigSetting to 
  a ComputerSystem. The method may also update the IsNext or IsDefault property 
  of other ElementSettingDatas that reference the same ComputerSystems to 
  satisfy cardinality constraints.

Product Specific 
  Usage:
Additional Notes: 
1) This method activates the boot setting 
  (which are set in the AMT_BootSettingData class) after the next graceful 
  shutdown or power-change command (using the CIM_PowerManagementService class). 
  The Role parameter must be set to 1 (IsNextSingleUse). 
2) Parameter 'Role' 
  can be set to '32768' to select 'IsNotNext' option. 
3) The EPR of the 
  CIM_BootConfigSetting instance of interest should be used as the first 
  parameter. 
4) Returns WSMAN Fault = “access denied” if user consent is 
  required but IPS_OptInService.OptInState value is not 'Received' or 'In 
  Session'. 
There is an exception to this rule - A fault will not be 
  generated in the following cases: 
1. Case 1: 
a. IN BootConfigSetting 
  references the Intel AMT “legacy” CIM_BootConfigSetting instance. 
  
(InstanceID equals "Intel(r) AMT: Boot Configuration 0"). 
b. IN Role= 
  IsNextSingleUse (1) 
c. No changes were made to the default boot settings 
  that require user consent at the time of call. See AMT_BootSettingData.Put() 
  and CIM_BootConfigSetting.ChangeBootOrder(). 
2. Case 2: 
a. IN 
  BootConfigSetting references the Intel AMT “legacy” CIM_BootConfigSetting 
  instance. 
(InstanceID equals "Intel(r) AMT: Boot Configuration 0"). 
b. 
  IN Role= IsNotNext (32768). 
This behavior is deprecated and new SW should 
  avoid calling the setBootConfigRole in case User consent is required but not 
  yet granted. 


Qualifiers:
-------------
ValueMap={0, 
  1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535}
Values={Completed 
  with No Error, Not Supported, Unknown/Unspecified Error, Busy, Invalid 
  Reference, Invalid Parameter, Access Denied, DMTF Reserved, Method Parameters 
  Checked - Job Started, Method Reserved, Vendor 
  Specified}


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

  

    
BootConfigSetting 
    
General Information:
An existing BootConfigSetting instance 
    whose role will be 
    updated.

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


    
Role 
    
General Information:
The desired Role of the 
    BootConfigSetting. 
"IsNext" updates the ElementSettingData.IsNext 
    property and indicates that the specified BootConfigSetting is to be used in 
    the future when any of its related ComputerSystems are 
    enabled.
"IsNextSingleUse" updates the ElementSettingData.IsNext 
    property. It is similar to IsNext, except the change applies only to the 
    next time a related ComputerSystem is enabled.
"IsDefault" updates the 
    ElementSettingData.IsDefault property to indicate that the BootConfigSetting 
    is identified as the default boot configuration for any of its related 
    ComputerSystems

Qualifiers:
-------------
Required
IN
ValueMap={0, 
    1, 2, 3..32767, 32768..65535}
Values={IsNext, IsNextSingleUse, IsDefault, 
    DMTF Reserved, Vendor Specified}


    
Job 
    
General Information:
Reference to the job spawned if the 
    operation continues after the method returns. (May be null if the task is 
    completed).

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







Get
public  Get([OUT]CIM_BootService 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






RequestStateChange
public uint32 RequestStateChange([IN]uint16 RequestedState, [OUT]REF CIM_ConcreteJob Job, [IN]datetime TimeoutPeriod)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_ADMINISTRATION_REALM

General 
  Information:
Requests that the state of the element be changed to the 
  value specified in the RequestedState parameter. When the requested state 
  change takes place, the EnabledState and RequestedState of the element will be 
  the same. Invoking the RequestStateChange method multiple times could result 
  in earlier requests being overwritten or lost. 
If 0 is returned, then the 
  task completed successfully and the use of ConcreteJob was not required. If 
  4096 (0x1000) is returned, then the task will take some time to complete, 
  ConcreteJob will be created, and its reference returned in the output 
  parameter Job. Any other return code indicates an error 
  condition.


  Product Specific Usage:

  Additional Notes: 
1) 
  'datetime' format is as 
  defined in DSP0230 'DMTF WS-CIM Mapping Specification'. 
2) Intel AMT does not 
  support the TimeoutPeriod parameter (only value 0 is valid). The state change is performed immediately, before the call is returned.
3) In Intel CSME 15 the 
  supported values in RequestedState are 
  32768-32769. In Intel CSME 16, 32770 and 32771 are also supported.

Qualifiers:
-------------
Override=RequestStateChange
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}
ModelCorrespondence={CIM_EnabledLogicalElement.RequestedState}


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

  

    
RequestedState 
    
General Information:
The state requested for the element. This 
    information will be placed into the RequestedState property of the instance 
    if the return code of the RequestStateChange method is 0 ('Completed with No 
    Error'), 3 ('Timeout'), or 4096 (0x1000) ('Job Started'). Refer to the 
    description of the EnabledState and RequestedState properties for the 
    detailed explanations of the RequestedState 
    values.

Qualifiers:
-------------
IN
ValueMap={2, 3, 
    4, 6, 7, 8, 9, 10, 11, .., 32768, 32769, 32770, 32771, 32772..65535}
Values={Enabled, Disabled, Shut Down, Offline, Test, Defer, 
    Quiesce, Reboot, Reset, DMTF Reserved, disable Intel One-Click Recovery and Intel RPE and enable all other boot options, disable Intel RPE and enable Intel One-Click Recovery and all other boot options, disable Intel One-Click Recovery and enable Intel RPE and all other boot options, enable all boot options, Vendor 
    Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.RequestedState}


    
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








  
  

    SUMMARY: NESTED | FIELD | METHOD
  

  

    DETAIL: FIELD | METHOD



  
  

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