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

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 system on the computer system through a BootSourceSetting that points to a specific operating system image.
UMLPackagePathstringCIM::System::Boot
Versionstring2.19.0

Class Properties

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LoSIDstringCIM_Service
LoSOrgIDstringCIM_Service
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 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.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535
ValuesstringCompleted 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)

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 if the method is run as a Job.
INbooleanfalse
OUTbooleantrue
ScopingComputerSystem REF CIM_ComputerSystem
Descriptionstringdirectly 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.
INbooleantrue
StartingBootConfig REF CIM_BootConfigSetting
DescriptionstringAn existing BootConfigSetting instance used as a template to replicate. factory default configuration.
INbooleantrue
Requiredbooleantrue

SetBootConfigRole (uint32)

Method Qualifiers (SetBootConfigRole)

NameData TypeValue
DescriptionstringThis 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.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535
ValuesstringCompleted 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)

NameTypeQualifiers
NameData TypeValue
Roleuint16
DescriptionstringThe 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
INbooleantrue
Requiredbooleantrue
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
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

SetBootConfigUsage (uint32)

Method Qualifiers (SetBootConfigUsage)

NameData TypeValue
DescriptionstringThis 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.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535
ValuesstringCompleted 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)

NameTypeQualifiers
NameData TypeValue
Roleuint16
DescriptionstringThe 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.
INbooleantrue
Requiredbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5..32767, 32768..65535
ValuesstringIsNext, IsNextSingleUse, IsDefault, IsNotNext, IsNotDefault, DMTF Reserved, Vendor Specified
BootConfigSetting REF CIM_BootConfigSetting
DescriptionstringAn existing BootConfigSetting instance whose role will be updated.
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
DescriptionstringThe 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.
INbooleantrue

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.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535
ValuesstringCompleted 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)

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. A value of NULL indicates that the ApplyBootConfig is to be applied to each related ComputerSystem.
INbooleantrue
Requiredbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service