Class CIM_BootService
extends CIM_Service

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.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

Class Hierarchy

Direct Known Subclasses

Class Qualifiers

Name	Data Type	Value
Description	string	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.
UMLPackagePath	string	CIM::System::Boot
Version	string	2.19.0

Class Properties

Inherited Properties

Name	Data Type	Class Origin
Caption	string	CIM_ManagedElement
CommunicationStatus	uint16	CIM_ManagedSystemElement
CreationClassName	string	CIM_Service
Description	string	CIM_ManagedElement
DetailedStatus	uint16	CIM_ManagedSystemElement
ElementName	string	CIM_ManagedElement
EnabledDefault	uint16	CIM_EnabledLogicalElement
EnabledState	uint16	CIM_EnabledLogicalElement
HealthState	uint16	CIM_ManagedSystemElement
InstallDate	datetime	CIM_ManagedSystemElement
InstanceID	string	CIM_ManagedElement
Name	string	CIM_Service
OperatingStatus	uint16	CIM_ManagedSystemElement
OtherEnabledState	string	CIM_EnabledLogicalElement
PrimaryOwnerContact	string	CIM_Service
PrimaryOwnerName	string	CIM_Service
PrimaryStatus	uint16	CIM_ManagedSystemElement
RequestedState	uint16	CIM_EnabledLogicalElement
Started	boolean	CIM_Service
StartMode	string	CIM_Service
Status	string	CIM_ManagedSystemElement
SystemCreationClassName	string	CIM_Service
SystemName	string	CIM_Service
TimeOfLastStateChange	datetime	CIM_EnabledLogicalElement
TransitioningToState	uint16	CIM_EnabledLogicalElement
AvailableRequestedStates	uint16[]	CIM_EnabledLogicalElement
OperationalStatus	uint16[]	CIM_ManagedSystemElement
StatusDescriptions	string[]	CIM_ManagedSystemElement

Class Methods

Local Class Methods

CreateBootConfigSetting (uint32)

Method Qualifiers (CreateBootConfigSetting)

Name	Data Type	Value
Description	string	This method creates a new boot configuration by creating a replica of an existing boot configuration. The new boot configuration shall be a duplicate, with the exception of key property values, of the BootConfigSetting, and its associated classes, specified in the StartingBootConfig parameter. If "State Data Supported" is present in the BootServiceCapabilities.BootCapabilitiesSupported property, the new BootConfigSetting shall be associated via ElementSettingData to a 'State' BootConfigSetting, which is associated to the ComputerSystem specified by the ScopingComputerSystem parameter. Otherwise the new BootConfigSetting shall be directly associated via ElementSettingData data to the ComputerSystem.
ValueMap	string	0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535
Values	string	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

Method Parameters (CreateBootConfigSetting)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job spawned if the operation continues after the method returns. (May be null if the task is completed).
		IN	boolean	false
		OUT	boolean	true
NewBootConfig	REF CIM_BootConfigSetting
		Description	string	The BootConfigSetting instance created by the method. This parameter is not returned if the method is run as a Job.
		IN	boolean	false
		OUT	boolean	true
ScopingComputerSystem	REF CIM_ComputerSystem
		Description	string	directly or indirectly associated. If ScopingComputerSystem has a non-NULL value, the scoping system for NewBootConfig is explicitly identified. If ScopingComputerSystem has a value of NULL, the new BootConfigSetting shall be related to the same set of ComputerSystems as is the template configuration.
		IN	boolean	true
StartingBootConfig	REF CIM_BootConfigSetting
		Description	string	An existing BootConfigSetting instance used as a template to replicate. factory default configuration.
		IN	boolean	true
		Required	boolean	true

SetBootConfigRole (uint32)

Method Qualifiers (SetBootConfigRole)

Name	Data Type	Value
Description	string	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.
ValueMap	string	0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535
Values	string	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

Method Parameters (SetBootConfigRole)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
Role	uint16
		Description	string	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
		IN	boolean	true
		Required	boolean	true
		ValueMap	string	0, 1, 2, 3..32767, 32768..65535
		Values	string	IsNext, IsNextSingleUse, IsDefault, DMTF Reserved, Vendor Specified
BootConfigSetting	REF CIM_BootConfigSetting
		Description	string	An existing BootConfigSetting instance whose role will be updated.
		IN	boolean	true
		Required	boolean	true
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job spawned if the operation continues after the method returns. (May be null if the task is completed).
		IN	boolean	false
		OUT	boolean	true

SetBootConfigUsage (uint32)

Method Qualifiers (SetBootConfigUsage)

Name	Data Type	Value
Description	string	This method is called to set the role of the BootConfigSetting for a specific ComputerSystem. The method shall update the IsNext or IsDefault property of the ElementSettingData that directly or indirectly associates ScopingComputerSystem and BootConfigSetting. The method may also update the IsNext or IsDefault property of other ElementSettingDatas that reference ScopingComputerSystem to satisfy cardinality constraints.
ValueMap	string	0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535
Values	string	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

Method Parameters (SetBootConfigUsage)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
Role	uint16
		Description	string	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 ScopingComputerSystem is enabled. "IsNextSingleUse" updates the ElementSettingData.IsNext property. It is similar to IsNext, except the change applies only to the next time the ScopingComputerSystem is enabled. "IsDefault" updates the ElementSettingData.IsDefault property to indicate that the BootConfigSetting is identified as the default boot configuration for ScopingComputerSystem "IsNotNext" removes the IsNext or IsNextSingleUse designation. The ComputerSystem will not be automatically booted the next time it is enabled. "IsDefault" removes the IsDefault designation.
		IN	boolean	true
		Required	boolean	true
		ValueMap	string	0, 1, 2, 3, 4, 5..32767, 32768..65535
		Values	string	IsNext, IsNextSingleUse, IsDefault, IsNotNext, IsNotDefault, DMTF Reserved, Vendor Specified
BootConfigSetting	REF CIM_BootConfigSetting
		Description	string	An existing BootConfigSetting instance whose role will be updated.
		IN	boolean	true
		Required	boolean	true
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job spawned if the operation continues after the method returns. (May be null if the task is completed).
		IN	boolean	false
		OUT	boolean	true
ScopingComputerSystem	REF CIM_ComputerSystem
		Description	string	The ComputerSystem to which the new Role applies. A value of NULL indicates that the Role is to be applied to each ComputerSystem that is directly or indirectly associated to BootConfigSetting.
		IN	boolean	true

ApplyBootConfigSetting (uint32)

Method Qualifiers (ApplyBootConfigSetting)

Name	Data Type	Value
Description	string	This method is called to indicate to the referenced ComputerSystem to apply the referenced BootConfigSetting. This shall cause the referenced ComputerSystem's boot process to start and apply the referenced BootConfigSetting.
ValueMap	string	0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535
Values	string	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

Method Parameters (ApplyBootConfigSetting)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
ApplyBootConfig	REF CIM_BootConfigSetting
		Description	string	Reference to an instance of BootConfigSetting which will be applied to the instance of ComputerSystem referenced by the ComputerSystem parameter.
		IN	boolean	true
		Required	boolean	true
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job spawned if the operation continues after the method returns. (May be null if the task is completed).
		IN	boolean	false
		OUT	boolean	true
ScopingComputerSystem	REF CIM_ComputerSystem
		Description	string	Reference to an instance of ComputerSystem which will apply the BootConfigSetting referenced by the ApplyBootConfig parameter. A value of NULL indicates that the ApplyBootConfig is to be applied to each related ComputerSystem.
		IN	boolean	true
		Required	boolean	true

Inherited Class Methods

Name	Return Type	Class Origin
RequestStateChange	uint32	CIM_EnabledLogicalElement
StartService	uint32	CIM_Service
StopService	uint32	CIM_Service

Class CIM_BootServiceextends CIM_Service

Table of Contents Hierarchy Direct Known Subclasses Class Qualifiers Class Properties Class Methods