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

Class CIM_BootConfigSetting

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_SettingData
      extended by CIM_BootConfigSetting
Also see:
CIM_BootSourceSetting
class CIM_BootConfigSetting
 extends CIM_SettingData


General Information:
A class derived from SettingData that provides 
the container to arrange all the BootSourceSetting instances in an ordered 
sequence. There can be one or more of the BootConfigSetting instances associated 
to a ComputerSystem. For example, one such BootConfigSetting could be a default 
boot configuration supplied by the manufacturer, a second one could be a 
configuration recommended by the IT Administrator. A third one could be the one 
actually to be used on next system boot.

Product Specific 
Usage:
Releases of Intel AMT through 6.x contain a single instance of 
this class; however, this may change in future versions. To find the existing 
instance in a robust 
manner, enumerate the instances of this class and 
search for the instance where the (key) property InstanceID is equal to 
"Intel(r) AMT: Boot Configuration 0". 

To choose a boot device, use the 
ChangeBootOrder method and pass the EPR of the wanted CIM_BootSourceSetting 
instance (to disable the chosen boot 
option, use an empty parameter). 


Note that some configurations are not allowed (for example, if 
AMT_BootSettingData.UseIDER property is true, no boot device can be chosen). 



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









  
  

    Supported Fields 
      Summary

  

     string 
      
    ElementName 
The 
      user-friendly name for this instance of SettingData . . .

  

     string 
      
    InstanceID Key  
Within the scope of the instantiating Namespace, 
      InstanceID opaquely and uniquely identifies an instance of this class . . 
      .




  
  

    Methods Summary

  

     uint32
    ChangeBootOrder(REF 
      Source, REF Job) 
This method is called to change the boot order 
      within a boot configuration . . .

  

     
    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


ElementName 
public string ElementName



  
General Information:
The user-friendly name for this instance of 
  SettingData. In addition, the user-friendly name can be used as an index 
  property for a search or query. (Note: The name does not have to be unique 
  within a namespace.)

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

Qualifiers:
-------------
Required
Override=ElementName
MaxLen=256


  

  





InstanceID Key 
public string InstanceID



  
General Information:
Within the scope of the instantiating 
  Namespace, InstanceID opaquely and uniquely identifies an instance of this 
  class. To ensure uniqueness within the NameSpace, the value of InstanceID 
  should be constructed using the following "preferred" algorithm: 
  
<OrgID>:<LocalID> 
Where <OrgID> and <LocalID> 
  are separated by a colon (:), and where <OrgID> must include a 
  copyrighted, trademarked, or otherwise unique name that is owned by the 
  business entity that is creating or defining the InstanceID or that is a 
  registered ID assigned to the business entity by a recognized global 
  authority. (This requirement is similar to the <Schema Name>_<Class 
  Name> structure of Schema class names.) In addition, to ensure uniqueness, 
  <OrgID> must not contain a colon (:). When using this algorithm, the 
  first colon to appear in InstanceID must appear between <OrgID> and 
  <LocalID>. 
<LocalID> is chosen by the business entity and 
  should not be reused to identify different underlying (real-world) elements. 
  If the above "preferred" algorithm is not used, the defining entity must 
  assure that the resulting InstanceID is not reused across any InstanceIDs 
  produced by this or other providers for the NameSpace of this instance. 
  
For DMTF-defined instances, the "preferred" algorithm must be used with 
  the <OrgID> set to CIM.

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

Qualifiers:
-------------
Key
Override=InstanceID
MaxLen=256


  

  






  
  

    Method 
Detail


ChangeBootOrder
public uint32 ChangeBootOrder([IN]REF CIM_BootSourceSetting Source[], [OUT]REF CIM_ConcreteJob Job)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_REMOTE_CONTROL_REALM, 
  ADMIN_SECURITY_LOCAL_SYSTEM_REALM. (Both ADMIN_SECURITY_SOLIDER_REALM and ADMIN_SECURITY_REMOTE_CONTROL_REALM are required for Intel One-Click Recovery boot options ForceWinREBoot, ForceUEFILocalPBABoot, ForceUEFIHTTPSBoot, AMTSecureBootControl)

General Information:
This 
  method is called to change the boot order within a boot configuration. An 
  ordered array of BootSourceSetting instances is passed to this method. Each 
  BootSourceSetting instance MUST already be associated with this 
  BootConfigSetting instance via an instance of OrderedComponent. If not, the 
  implementation MUST return a value of "Invalid Parameter" Upon execution of 
  this method, the value of the AssignedSequence property on each instance of 
  OrderedComponent will be updated such that the values are monotonically 
  increasing in correlation with the position of the referenced 
  BootSourceSetting instance in the source input parameter. That is, the first 
  position in the array will have the lowest value for AssignedSequence. The 
  second position will have the second lowest value, and so on. For 
  BootSourceSetting instances which are associated with the BootConfigSetting 
  instance via OrderedComponent and not present in the input array, the 
  AssignedSequence property on the OrderedComponent association will be assigned 
  a value of 0.

Product Specific Usage:
Additional Notes: 
  
1) A boot source cannot be set if some special boot options were set in 
  AMT_BootSettingData (such as UseSOL, UseIDER, ReflashBIOS, BIOSPause, 
  BIOSSetup) 
2) Parameter 'Source' changed in capitalization. Intel AMT 
  Release 5.0 and earlier releases use 2.13.0 MOF version and therefor expect 
  'Source' parameter as 'source'. 
3) Intel AMT Release 7.0: Returns WSMAN 
  Fault = “access denied” if user consent is required but 
  IPS_OptInService.OptInState value is not 'Received' or 'In Session'. An 
  exception to this rule is when the Source parameter is an empty array. 
  



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


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

  

    
Source 
    
General Information:
An ordered array of 
    BootSourceSettings.

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


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