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

Class CIM_BootSourceSetting

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


General Information:
A class derived from SettingData that provides 
the information necessary to describe a boot source. This may be optionally 
associated to a bootable logical device, such as a hard disk partition, or a 
network device. The information from this class instance is used by the boot 
manager, such as BIOS/EFI or OS Loader to initiate the boot process, when this 
instance appears in a BootConfigSetting collection.

Product Specific 
Usage:
All BootSourceSetting instances are attached to 
CIM_BootConfigSetting. 
In order to choose one of the boot sources use 
CIM_BootConfigSetting.ChangeBootOrder method with the EPR of the wanted source 
(use empty parameter to clear the boot source setting). 
A boot source can't 
be set if some special boot options were set in AMT_BootSettingData (such as 
UseIDER, ReflashBIOS, BIOSPause, 
BIOSSetup)

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

  

  

     string 
      
    StructuredBootString 
      
A string identifying the boot source using the format 
      "::", in which neither <orgid>, <identifier> or 
      <index> contains a colon (":") . . .

  

  
   

     string 
      
    BIOSBootString 
      
BIOS description of the boot option. UTF8 null-terminated string, relevant only to One-Click Recovery WinRE and PBA (pre-boot application) boot options.

  

  
   

     string 
      
    BootString  
      
BIOS description of the EFI device path. UTF8 null-terminated string, relevant only to One-Click Recovery WinRE and PBA (pre-boot application) boot options

  

  
  

     uint16 
      
	      FailThroughSupported 
      
An enumeration indicating the behavior when the attempt to boot 
      using the boot source fails (no media, timeout) . . 
  .




  
  

    Methods Summary

  

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

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


  

  





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.


  InstanceID of boot source instances that can be returned by CIM_BootSourceSetting enumeration:
 

 



  
  

    
      
Boot source

    
      
Value

    
      
Description

  
  

    
      
Hard drive

    
      
Intel(r) AMT: Force Hard-drive Boot

    
      
Hard-drive boot source

  

    
      
CD/DVD

    
      
Intel(r) AMT: Force CD/DVD Boot

    
      
CD/DVD boot source

  

    
      
PXE

    
      
Intel(r) AMT: Force PXE Boot

    
      
PXE boot source

  

    
      
OCR UEFI HTTPS

    
      
Intel(r) AMT: Force OCR UEFI HTTPS Boot

    
      
Intel One-Click Recovery HTTPS boot source

  

    
      
OCR UEFI Boot Option 1

    
      
Intel(r) AMT: Force OCR UEFI Boot Option 1

    
      
Intel One-Click Recovery PBA/WinRE boot source 1

	  
 

    
      
OCR UEFI Boot Option 2

    
      
Intel(r) AMT: Force OCR UEFI Boot Option 2

    
      
Intel One-Click Recovery PBA/WinRE boot source 2
	 



    
      
OCR UEFI Boot Option 3

    
      
Intel(r) AMT: Force OCR UEFI Boot Option 3

    
      
Intel One-Click Recovery PBA/WinRE boot source 3
	 



    
      
OCR UEFI Boot Option 4

    
      
Intel(r) AMT: Force OCR UEFI Boot Option 4

    
      
Intel One-Click Recovery PBA/WinRE boot source 4
	 



    
      
OCR UEFI Boot Option 5

    
      
Intel(r) AMT: Force OCR UEFI Boot Option 5

    
      
Intel One-Click Recovery PBA/WinRE boot source 5
	 



    
      
OCR UEFI Boot Option 6

    
      
Intel(r) AMT: Force OCR UEFI Boot Option 6

    
      
Intel One-Click Recovery PBA/WinRE boot source 6
	 



    
      
OCR UEFI Boot Option 7

    
      
Intel(r) AMT: Force OCR UEFI Boot Option 7

    
      
Intel One-Click Recovery PBA/WinRE boot source 7
	 



    
      
OCR UEFI Boot Option 8

    
      
Intel(r) AMT: Force OCR UEFI Boot Option 8

    
      
Intel One-Click Recovery PBA/WinRE boot source 8
	 



    
      
OCR UEFI Boot Option 9

    
      
Intel(r) AMT: Force OCR UEFI Boot Option 9

    
      
Intel One-Click Recovery PBA/WinRE boot source 9
	 



    
      
OCR UEFI Boot Option 10

    
      
Intel(r) AMT: Force OCR UEFI Boot Option 10

    
      
Intel One-Click Recovery PBA/WinRE boot source 10
	 


	  
  
	  
 
 
 
Notes:

Refer to Intel One-Click Recovery for information on the additional fields required to differentiate between the different Intel One-Click Recovery boot source instances.

The PBA, HTTPS and WinRE boot sources are available in Intel One-Click Recovery starting from Intel CSME 15.


 Regarding the OCR boot sources: Intel AMT shows only the boot sources that are supported and enabled by the BIOS. For example, if the BIOS reports only one PBA to Intel AMT, only one PBA boot source is returned.

 
 Diagnostic boot was removed in Release 7.0.




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


  

  





StructuredBootString 
public string StructuredBootString



  
General Information:
A string identifying the boot source using 
  the format "<OrgID>:<identifier>:<index>", in which neither 
  <OrgID>, <identifier> or <index> contains a colon (":"). The 
  value of <OrgID> is a copyrighted, trademarked or otherwise unique name 
  that is owned by the entity defining the <identifier>, or is a 
  registered ID that is assigned to the entity by a recognized global authority. 
  For DMTF defined identifiers, the <OrgID> is set to 'CIM'. The 
  <identifiers> are "Floppy", "Hard-Disk", "CD/DVD", "Network", "PCMCIA", 
  "USB". The value of <index> shall be a non-zero 
  integer.


  
  StructuredBootString in the boot source instances that can be returned by CIM_BootSourceSetting enumeration: 

  CIM:Hard-Disk:1

  CIM:CD/DVD:1

  CIM:Network:1

  Intel(r)AMT:OCR-UEFI-Boot-Option-HTTPS:1

  Intel(r)AMT:OCR-UEFI-Boot-Option:1

  Intel(r)AMT:OCR-UEFI-Boot-Option:2

  Intel(r)AMT:OCR-UEFI-Boot-Option:3

  Intel(r)AMT:OCR-UEFI-Boot-Option:4

  Intel(r)AMT:OCR-UEFI-Boot-Option:5

  Intel(r)AMT:OCR-UEFI-Boot-Option:6

  Intel(r)AMT:OCR-UEFI-Boot-Option:7

  Intel(r)AMT:OCR-UEFI-Boot-Option:8

  Intel(r)AMT:OCR-UEFI-Boot-Option:9

  Intel(r)AMT:OCR-UEFI-Boot-Option:10


  Note:

The PBA, HTTPS and WinRE boot sources are available in Intel One-Click Recovery starting from Intel CSME 15.


 Regarding the OCR boot sources: Intel AMT shows only the boot sources that are supported and enabled by the BIOS. For example, if the BIOS reports only one PBA to Intel AMT, only one PBA boot source is returned. 

 Diagnostic boot was removed in Release 7.0.

 

  Qualifiers:
-------------
MaxLen=256


  

  





BIOSBootString 
public string BIOSBootString



  
General Information:
BIOS description of the boot option. UTF8 null-terminated string, relevant only to One-Click Recovery WinRE and PBA (pre-boot application) boot options.

Qualifiers:
-------------
MaxLen=100 bytes


  

  






BootString 
public string BootString



  
General Information:
BIOS description of the EFI device path. UTF8 null-terminated string, relevant only to One-Click Recovery WinRE and PBA (pre-boot application) boot options.


Qualifiers:
-------------
MaxLen=300 bytes


  

  






FailThroughSupported 
public uint16 FailThroughSupported



  
General Information:
An enumeration indicating the behavior when 
  the attempt to boot using the boot source fails (no media, timeout). The 
  current values in the enumeration are: 
0 = Unknown 
1 = Is Supported 
  
2 = Is Not Supported. 
A value of 1 (Is Supported) indicates that next 
  boot source the boot order is used. A value of 2 (Is Not Supported) indicates 
  that the boot order is terminated and no other boot sources associated to the 
  same CIM_BootConfigSetting are used). The default is 1 (Is 
  Supported)

Product Specific Usage:
In Intel (r) AMT the 
  default value is 2 (Is Not 
  Supported)

Qualifiers:
-------------
ValueMap={0, 1, 
  2}
Values={Unknown, Is Supported, Not Supported}


  

  







  
  

    Method 
Detail


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