# Class CIM_BIOSService
extends CIM_Service

A class derived from Service that provides the controls to manage the system BIOS configuration of a managed computer system or device. This service exposes functionality to retrieve BIOS configuration data or attributes, set BIOS attribute values, and restore a default configuration of attribute values for a given computer system.

### 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_BIOSService

## Direct Known Subclasses

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | A class derived from Service that provides the controls to manage the system BIOS configuration of a managed computer system or device. This service exposes functionality to retrieve BIOS configuration data or attributes, set BIOS attribute values, and restore a default configuration of attribute values for a given computer system.
UMLPackagePath | string | CIM::System::BIOS
Version | string | 2.22.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

#### SetBIOSAttribute (uint32)

#### Method Qualifiers (SetBIOSAttribute)

Name | Data Type | Value
--- | --- | ---

Description

string

This method is called to modify instances of BIOSAttribute associated with this BIOSService.If this method is not supported by the implementation, 1 (Not Supported) shall be returned. If the method is supported, but has not completed due to an unspecified error, 2 (Error) shall be returned. If the method is supported and has completed successfully, 0 (Completed with No Error) shall be returned. The method may return an instance of CIM_Error.

ValueMap | string | 0, 1, 2, .., 32768..65535
Values | string | Completed with No Error, Not Supported, Error, DMTF Reserved, Vendor Reserved

#### Method Parameters (SetBIOSAttribute)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
AttributeName | string
Description | string | A reference to a BIOSAttribute specified by AttributeName of the BIOSAttribute to be modified.
IN | boolean | true
Required | boolean | true
AuthorizationToken | string

Description

string

When required, a token to modify BIOSAttribute values for this computer system. This is usually the BIOS administrator password. If this is a password, the PasswordEncoding parameter shall be used to denote the format of the password string. For example: the CIM_SharedCredential subclass may be utilized. In that case, the CIM_SharedCredential.Secret might be required and if is not specified this method would return 6 Invalid Parameter. The CIM_SharedCredential.Algorithm property might also be specified based on the property CIM_BIOSServiceCapabilities.SupportedPasswordAlgorithms.

EmbeddedInstance | string | CIM_Credential
IN | boolean | true
PasswordEncoding | uint32

Description

string

PasswordEncoding specifies encoding tag used to denote the format the password string is being passed into the BIOS. "kbd" denotes a string in hexadecimal format containing keyboard scan code input. An example of a password structured in this format would be "321539191E1F1F11181320", which is the representation of "my password" in US English keyboard scan codes. "ascii" denotes clear text that shall comply with the ASCII character set. Character encodings from " " (decimal 32) to "~" (decimal 126) are supported. An example would be "my password"."pin" denotes that only numeric input in ASCII text is allowed for the password instance. An example would be "1234".

IN | boolean | true
ValueMap | string | 2, 3, 4, 5, .., 32768..65535
Values | string | ascii, kbd, pin, UTF16, DMTF Reserved, Vendor Reserved
SetResult | uint32
Description | string | Invoking the SetBIOSAttribute may result in a set to CurrentValue property or the PendingValue property. SetResult returns the result of invoking the SetBIOSAttribute method when the method return code is 0 completed with no error.
IN | boolean | false
OUT | boolean | true
ValueMap | string | 2, 3, .., 32768..65535
Values | string | Set CurrentValue property, Set PendingValue property, DMTF Reserved, Vendor Reserved
AttributeValue | string[]
Description | string | A new value to assign to the specified BIOSAttribute. A value of NULL indicates the factory default value for the BIOSAttribute is requested. If this value is valid, it will be applied to the CurrentValue or PendingValue property of the specified BIOSAttribute depending on the system BIOS implementation and any requirements for a system restart.
IN | boolean | true
Required | boolean | true
TargetBIOS | REF CIM_BIOSElement
Description | string | If supplied, TargetBIOS references the scoping instance of CIM_BIOSElement in which the operation is targeted. If TargetBIOS is not supplied, the target of the operation shall be the current instance of CIM_BIOSElement associated to the CIM_ComputerSystem hosting the service.
IN | boolean | true

#### SetBIOSAttributeEmbeddedInstance (uint32)

#### Method Qualifiers (SetBIOSAttributeEmbeddedInstance)

Name | Data Type | Value
--- | --- | ---

Description

string

This method is called to modify instances of BIOSAttribute associated with this BIOSService using an embedded instance If this method is not supported by the implementation, 1 (Not Supported) shall be returned. If the method is supported, but has not completed due to an unspecified error, 2 (Error) shall be returned. If the method is supported and has completed successfully, 0 (Completed with No Error) shall be returned. The method may return an instance of CIM_Error.

ValueMap | string | 0, 1, 2, .., 32768..65535
Values | string | Completed with No Error, Not Supported, Error, DMTF Reserved, Vendor Reserved

#### Method Parameters (SetBIOSAttributeEmbeddedInstance)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
AttributeConfig | string
Description | string | AttributeConfig is the input required to modify the value of a BIOSAttribute. The CIM_BIOSAttribute.AttributeName and the CIM_BIOSAttribute.CurrentValue properties are Required for this operation. If both properties are not specified the service shall return 6 Invalid Parameter.
EmbeddedInstance | string | CIM_BIOSAttribute
IN | boolean | true
Required | boolean | true
AuthorizationToken | string

Description

string

When required, a token to modify BIOSAttribute values for this computer system. This is usually the BIOS administrator password. If this is a password, the PasswordEncoding parameter shall be used to denote the format of the password string. For example: the CIM_SharedCredential subclass may be utilized. In that case, the CIM_SharedCredential.Secret might be required and if is not specified this method would return 6 Invalid Parameter. The CIM_SharedCredential.Algorithm property might also be specified based on the property CIM_BIOSServiceCapabilities.SupportedPasswordAlgorithms.

EmbeddedInstance | string | CIM_Credential
IN | boolean | true
PasswordEncoding | uint32

Description

string

PasswordEncoding specifies encoding tag used to denote the format the password string is being passed into the BIOS. This property is applicable if the AuthorizationToken parameter includes a password. "kbd" denotes a string in hexadecimal format containing keyboard scan code input. An example of a password structured in this format would be "321539191E1F1F11181320", which is the representation of "my password" in US English keyboard scan codes. "ascii" denotes clear text that shall comply with the ASCII character set. Character encodings from " " (decimal 32) to "~" (decimal 126) are supported. An example would be "my password"."pin" denotes that only numeric input in ASCII text is allowed for the password instance. An example would be "1234".

IN | boolean | true
ValueMap | string | 2, 3, 4, 5, .., 32768..65535
Values | string | ascii, kbd, pin, UTF16, DMTF Reserved, Vendor Reserved
SetResult | uint32
Description | string | Invoking the SetBIOSAttributeEmbeddedInstance may result in a set to CurrentValue property or the PendingValue property. SetResult returns the result of invoking the SetBIOSAttributeEmbeddedInstance method when the method return code is 0 completed with no error.
IN | boolean | false
OUT | boolean | true
ValueMap | string | 2, 3, .., 32768..65535
Values | string | Set CurrentValue property, Set PendingValue property, DMTF Reserved, Vendor Reserved
TargetBIOS | REF CIM_BIOSElement
Description | string | If supplied, TargetBIOS references the scoping instance of CIM_BIOSElement in which the operation is targeted. If TargetBIOS is not supplied, the target of the operation shall be the current instance of CIM_BIOSElement associated to the CIM_ComputerSystem hosting the service.
IN | boolean | true

#### ReadRawBIOSData (uint32)

#### Method Qualifiers (ReadRawBIOSData)

Name | Data Type | Value
--- | --- | ---
Description | string | This method provides the ability to perform raw reads of BIOS configuration storage area. The method will return the lesser of the number of bytes specified by the NumberOfBytes parameter and the actual number of bytes available between Offset and the end of the BIOS area, starting at specified by the Offset parameter arereturned in the Data parameter.
ValueMap | string | 0, 1, 2, .., 65536..4294967295
Values | string | Completed with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Vendor Reserved

#### Method Parameters (ReadRawBIOSData)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
NumberOfBytes | uint32
Description | string | On input, specifies the number of bytes to read. On output, specifies the number of bytes read.
IN | boolean | true
OUT | boolean | true
Required | boolean | true
Offset | uint32
Description | string | Specifies initial offset to start reading from.
IN | boolean | true
Required | boolean | true
Data | uint8[]
Description | string | Buffer to contain read data.
IN | boolean | false
OctetString | boolean | true
OUT | boolean | true
TargetBIOS | REF CIM_BIOSElement
Description | string | If supplied, TargetBIOS references the scoping instance of CIM_BIOSElement in which the operation is targeted. If TargetBIOS is not supplied, the target of the operation shall be the current instance of CIM_BIOSElement associated to the CIM_ComputerSystem hosting the service.
IN | boolean | true

#### WriteRawBIOSData (uint32)

#### Method Qualifiers (WriteRawBIOSData)

Name | Data Type | Value
--- | --- | ---

Description

string

This method provides the ability to perform raw writes of BIOS configuration storage area. The number of bytes specified by the Length parameter will be written from the Data parameter specified by the Offset parameter. If the number of bytes to write as indicated by the NumberOfBytes parameter exceeds the number of bytes from Offset to the end of the BIOS area, the method shall return 2.

ValueMap | string | 0, 1, 2, .., 65536..4294967295
Values | string | Completed with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Vendor Reserved

#### Method Parameters (WriteRawBIOSData)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
AuthorizationToken | string

Description

string

A token required to modify BIOSAttribute values for this computer system. This is usually the BIOS administrator password. For example: the CIM_SharedCredential subclass may be utilized. In that case, the CIM_SharedCredential.Secret might be required and if is not specified this method would return 6 Invalid Parameter. The CIM_SharedCredential.Algorithm property might also be specified based on the propertyCIM_BIOSServiceCapabilities.SupportedPasswordAlgorithms.

EmbeddedInstance | string | CIM_Credential
IN | boolean | true
NumberOfBytes | uint32
Description | string | On input, specifies the number of bytes of data to write. On output, specifies the number of bytes written.
IN | boolean | true
OUT | boolean | true
Required | boolean | true
Offset | uint32
Description | string | Specifies initial offset to start reading from.
IN | boolean | true
Required | boolean | true
PasswordEncoding | uint32

Description

string

PasswordEncoding specifies encoding tag used to denote the format the password string is being passed into the BIOS. This property is applicable if the AuthorizationToken parameter includes a password. "kbd" denotes a string in hexadecimal format containing keyboard scan code input. An example of a password structured in this format would be "321539191E1F1F11181320", which is the representation of "my password" in US English keyboard scan codes. "ascii" denotes clear text that shall comply with the ASCII character set. Character encodings from " " (decimal 32) to "~" (decimal 126) are supported. An example would be "my password"."pin" denotes that only numeric input in ASCII text is allowed for the password instance. An example would be "1234".

IN | boolean | true
ValueMap | string | 2, 3, 4, 5, .., 32768..65535
Values | string | ascii, kbd, pin, UTF16, DMTF Reserved, Vendor Reserved
Data | uint8[]
Description | string | Buffer containing data to write.
IN | boolean | true
OctetString | boolean | true
TargetBIOS | REF CIM_BIOSElement
Description | string | If supplied, TargetBIOS references the scoping instance of CIM_BIOSElement in which the operation is targeted. If TargetBIOS is not supplied, the target of the operation shall be the current instance of CIM_BIOSElement associated to the CIM_ComputerSystem hosting the service.
IN | boolean | true

#### SetBIOSAttributes (uint32)

#### Method Qualifiers (SetBIOSAttributes)

Name | Data Type | Value
--- | --- | ---

Description

string

This method is called to modify a group of BIOSAttribute instances associated with this BIOSService. If the method is not supported by the implementation, 1 (Not Supported) shall be returned. If the method is supported, but has not completed due to an unspecified error, 2 (Error) shall be returned. If the method is supported and has completed successfully, 0 (Completed with No Error) shall be returned; SetResult[] should be inspected to determine if individual BIOS Attribute values have been set. The method may return an instance of CIM_Error.

ValueMap | string | 0, 1, 2, .., 32768..65535
Values | string | Completed with No Error, Not Supported, Error, DMTF Reserved, Vendor Reserved

#### Method Parameters (SetBIOSAttributes)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
AuthorizationToken | string

Description

string

When required, a token to modify BIOSAttribute values for this computer system. This is usually the BIOS administrator password. If this is a password, the PasswordEncoding parameter shall be used to denote the format of the password string. For example: the CIM_SharedCredential subclass may be utilized. In that case, the CIM_SharedCredential.Secret might be required and if is not specified this method would return 6 Invalid Parameter. The CIM_SharedCredential.Algorithm property might also be specified based on the propertyCIM_BIOSServiceCapabilities.SupportedPasswordAlgorithms.

EmbeddedInstance | string | CIM_Credential
IN | boolean | true
CollectionElementName | string

Description

string

If supplied, the ConcreteCollection containing the BIOS Attributes to be modified, as specified by the ConcreteCollection.ElementName property. The value of ConcreteCollection.ElementName supplied for this parameter must be unique within the scope of the instantiating Namespace; if the value is not unique, this parameter shall not be supplied. If BIOS Attributes represented by the AttributeName[] parameter are not members of this collection, the SetResult parameter that corresponds to these BIOS Attributes shall return 5 (No Attempt to Set Value due to Error). If CollectionElementName is not specified, the BIOS Attributes represented by the AttributeName[] parameter can be members of any collection or associated with no collection at all.

IN | boolean | true
PasswordEncoding | uint32

Description

string

PasswordEncoding specifies encoding tag used to denote the format the password string is being passed into the BIOS. "kbd" denotes a string in hexadecimal format containing keyboard scan code input. An example of a password structured in this format would be "321539191E1F1F11181320", which is the representation of "my password" in US English keyboard scan codes. "ascii" denotes clear text that shall comply with the ASCII character set. Character encodings from " " (decimal 32) to "~" (decimal 126) are supported. An example would be "my password"."pin" denotes that only numeric input in ASCII text is allowed for the password instance. An example would be "1234".

IN | boolean | true
ValueMap | string | 2, 3, 4, 5, .., 32768..65535
Values | string | ascii, kbd, pin, UTF16, DMTF Reserved, Vendor Reserved
AttributeName | string[]
ArrayType | string | Indexed

Description

string

The BIOS Attribute names representing the BIOS Attributes to be modified, as specified by BIOSAttribute.AttributeName properties. The specified BIOS Attributes must already exist. The values of BIOSAttribute.AttributeName supplied for this parameter must be unique within the scope of the instantiating Namespace. The BIOS Attribute name members of this array must correspond with array members of the values represented by the AttributeValue[] parameter. If more than one value is specified for a particular BIOS Attribute, this parameter shall contain multiple identical array entries describing the BIOS Attribute name that corresponds with each respective BIOS Attribute value specified by the AttributeValue[] parameter.

IN | boolean | true
ModelCorrespondence | string | CIM_BIOSAttribute.AttributeName, CIM_BIOSService.SetBIOSAttributes.AttributeValue
Required | boolean | true
AttributeValue | string[]
ArrayType | string | Indexed

Description

string

New values to assign to the BIOS Attributes specified in the AttributeName[] parameter. The BIOS Attribute value members of this array must correspond with the array members of the names represented by the AttributeName[] parameter. If more than one value is specified for a particular BIOS Attribute, this parameter shall contain an entry for each BIOS Attribute value. A value of NULL indicates the factory default values for the BIOSAttribute is requested. If this value is valid, it will be applied to the CurrentValue or PendingValue property of the specified BIOSAttribute depending on the system BIOS implementation and any requirements for a system restart. The result of applying the values are described in the corresponding array entries of the SetResult[] parameter.

IN | boolean | true
ModelCorrespondence | string | CIM_BIOSAttribute.CurrentValue, CIM_BIOSAttribute.PendingValue, CIM_BIOSService.SetBIOSAttributes.AttributeName, CIM_BIOSService.SetBIOSAttributes.SetResult
Required | boolean | true
SetResult | uint32[]
ArrayType | string | Indexed

Description

string

Invoking SetBIOSAttributes may result in new values for BIOS Attributes specified in the AttributeName[] parameter. SetResult returns the results of invoking this method for each specified attribute value. Each array element of SetResult contains the result of setting the new value that corresponds with each respective BIOS Attribute value specified by the AttributeValue[] parameter. If the BIOSAttribute.CurrentValue property is set to the new value, 2 (Set CurrentValue Property) shall be returned. If the BIOSAttribute.PendingValue property is set to the new value, 3 (Set PendingValue Property) shall be returned. If an unspecified error occurred while setting the value, 4 (Error Setting Value) shall be returned. If there was no attempt to set the value due to a prior unspecified error, 5 (No Attempt to Set Value due to Error) shall be returned. If a previously set value was rolled-back to its original value due to a prior unspecified error, 6 (Value Rolled-Back) shall be returned.

IN | boolean | false
ModelCorrespondence | string | CIM_BIOSAttribute.CurrentValue, CIM_BIOSAttribute.PendingValue, CIM_BIOSService.SetBIOSAttributes.AttributeName, CIM_BIOSService.SetBIOSAttributes.AttributeValue
OUT | boolean | true
ValueMap | string | 2, 3, 4, 5, 6, .., 32768..65535
Values | string | Set CurrentValue Property, Set PendingValue Property, Error Setting Value, No Attempt to Set Value due to Error, Value Rolled-Back, DMTF Reserved, Vendor Reserved
TargetBIOS | REF CIM_BIOSElement
Description | string | If supplied, TargetBIOS references the scoping instance of CIM_BIOSElement in which the operation is targeted. If TargetBIOS is not supplied, the target of the operation shall be the current instance of CIM_BIOSElement associated to the CIM_ComputerSystem hosting the service.
IN | boolean | true

### Inherited Class Methods

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