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 on the computer system through BootSourceSetting that point to a specific operating system image.

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


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_Service
   |
   +--CIM_BootService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringA 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 on the computer system through BootSourceSetting that point to a specific operating system image.
UMLPackagePathstringCIM::System::Boot
Versionstring2.14.0

Class Properties

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
NamestringCIM_Service
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_Service
PrimaryOwnerNamestringCIM_Service
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StartedbooleanCIM_Service
StartModestringCIM_Service
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_Service
SystemNamestringCIM_Service
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

CreateBootConfigSetting (uint32)

Method Qualifiers (CreateBootConfigSetting)

NameData TypeValue
DescriptionstringThis method is called to build a new instance of BootConfigSetting, and the associated classes. This method also creates the ElementSettingData association between the ComputerSystem and BootConfigSetting. An instance of existing BootConfigSetting can be passed to this method, which allows the instrumentation to clone the instance of BootConfigSetting and associated BootSourceSetting instances. The association instances (orderedComponent) are also instantiated preserving the AssignedSequence. In addition, the SettingData instances and their association to BootConfigSetting and BootSourceSetting are replicated. Dependency relationship between BootSourceSetting and LogicalDevice is also replicated. A NULL reference to this method will result in a default BootConfigSetting tree as defined by the factoryDefault configuration, if one is identified.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown/Unspecified Error, Busy, Invalid Reference, Invalid Parameter, Access Denied, DMTF Reserved, Vendor Specified

Method Parameters (CreateBootConfigSetting)

NameTypeQualifiers
NameData TypeValue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job spawned if the operation continues after the method returns. (May be null if the task is completed).
INbooleanfalse
OUTbooleantrue
NewBootConfig REF CIM_BootConfigSetting
DescriptionstringThe BootConfigSetting instance created by the method. This parameter is not returned when the method is run as a Job.
INbooleanfalse
OUTbooleantrue
ScopingComputerSystem REF CIM_ComputerSystem
DescriptionstringThe CIM_ComputerSystem to which the instance of BootConfigSetting created by the method is associated via an instance of ElementSettingData. When ScopingComputerSystem has a non-NULL value, the scoping system for the NewBootConfig is explicitly identified. When ScopingComputerSystem has a value of NULL and StartingBootConfig has a non-NULL value, the scoping system for the NewBootConfig is the scoping system for the CIM_BootConfigSetting referenced by the StartingBootConfig parameter.
INbooleantrue
StartingBootConfig REF CIM_BootConfigSetting
DescriptionstringAn existing BootConfigSetting instance used as a template to replicate. A value of NULL indicates a factory default configuration.
INbooleantrue

SetBootConfigRole (uint32)

Method Qualifiers (SetBootConfigRole)

NameData TypeValue
DescriptionstringThis method is called to set the role of the BootConfigSetting for the ComputerSystem the BootConfigSetting is associated with. This method sets the property values in the ElementSettingData association between the ComputerSystem and BootConfigSetting. For example, to enable the BootConfigSetting to be used at the next reboot, this method is called with the Role = "IsNext". The implementation must then set the value of IsNext property in the ElementSettingData association instance between the ComputerSystem and the specified BootConfigSetting. It must also clear the IsNext flag in any other ElementSettingData instance between ComputerSystem and other BootConfigSetting instance.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown/Unspecified Error, Busy, Invalid Reference, Invalid Parameter, Access Denied, DMTF Reserved, Vendor Specified

Method Parameters (SetBootConfigRole)

NameTypeQualifiers
NameData TypeValue
Roleuint16
DescriptionstringThe desired Role of the BootConfigSetting.
INbooleantrue
ValueMapstring0, 1, 2, 3..32767, 32768..65535
ValuesstringIsNext, IsNextSingleUse, IsDefault, DMTF Reserved, Vendor Specified
BootConfigSetting REF CIM_BootConfigSetting
DescriptionstringAn existing BootConfigSetting instance whose role will be updated.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job spawned if the operation continues after the method returns. (May be null if the task is completed).
INbooleanfalse
OUTbooleantrue

ApplyBootConfigSetting (uint32)

Method Qualifiers (ApplyBootConfigSetting)

NameData TypeValue
DescriptionstringThis 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.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown/Unspecified Error, Busy, Invalid ReferenceInvalid Parameter, Access Denied, DMTF Reserved, Vendor Specified

Method Parameters (ApplyBootConfigSetting)

NameTypeQualifiers
NameData TypeValue
ApplyBootConfig REF CIM_BootConfigSetting
DescriptionstringReference to an instance of BootConfigSetting which will be applied to the instance of ComputerSystem referenced by the ComputerSystem parameter.
INbooleantrue
Requiredbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job spawned if the operation continues after the method returns. (May be null if the task is completed).
INbooleanfalse
OUTbooleantrue
ScopingComputerSystem REF CIM_ComputerSystem
DescriptionstringReference to an instance of ComputerSystem which will apply the BootConfigSetting referenced by the ApplyBootConfig parameter.
INbooleantrue
Requiredbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service