BIOS and Boot Management Profile Document Number: DCIM1040 Document Type: Specification Document Status: Published Document Language: E Date: 2010-08-31 Version: 1.0.
THIS PROFILE IS FOR INFORMATIONAL PURPOSES ONLY, AND MAY CONTAIN TYPOGRAPHICAL ERRORS AND TECHBIOSAL INACCURACIES. THE CONTENT IS PROVIDED AS IS, WITHOUT EXPRESS OR IMPLIED WARRANTIES OF ANY KIND. ABSENT A SEPARATE AGREEMENT BETWEEN YOU AND DELL™ WITH REGARD TO FEEDBACK TO DELL ON THIS PROFILE SPECIFICATION, YOU AGREE ANY FEEDBACK YOU PROVIDE TO DELL REGARDING THIS PROFILE SPECIFICATION WILL BE OWNED AND CAN BE FREELY USED BY DELL. © 2010 Dell Inc. All rights reserved.
CONTENTS 1 2 Scope .................................................................................................................................................... 5 Normative References........................................................................................................................... 5 2.1 Approved References ................................................................................................................. 5 2.2 Other References...................................
Figures Figure 1 – BIOS and Boot Management Profile: Class Diagram – BIOS Management ............................... 8 Figure 2 – BIOS and Boot Management Profile: Boot Management ............................................................ 9 Tables Table 1 – Related Profiles ............................................................................................................................. 8 Table 2 – CIM Elements: BIOS and Boot Management Profile .................................................
BIOS and Boot Management Profile 1 Scope The BIOS and Boot Management Profile extends the management capabilities of referencing profiles by adding the capability to represent the configuration of the system BIOS setup and to manage the boot of the system. The system BIOS setup is modeled with multiple attributes that allow configuration of the BIOS. 2 Normative References The following referenced documents are indispensable for the application of this document.
3.1 can used for statements of possibility and capability, whether material, physical, or causal 3.2 cannot used for statements of possibility and capability, whether material, physical, or causal 3.3 conditional indicates requirements to be followed strictly in order to conform to the document when the specified conditions are met 3.4 mandatory indicates requirements to be followed strictly in order to conform to the document and from which no deviation is permitted 3.
3.13 ENUMERATE Refers to WS-MAN ENUMERATE operation as described in Section 8.2 of DSP0226_V1.1 and Section 9.1 of DSP0227_V1.0 3.14 GET Refers to WS-MAN GET operation as defined in Section 7.3 of DSP00226_V1.1 and Section 7.1 of DSP0227_V1.0 4 Symbols and Abbreviated Terms 4.1 CIM Common Information Model 4.2 iDRAC Integrated Dell Remote Access Controller – management controller for blades and monolithic servers 4.
CIM_ComputerSystem shall be the Scoping Class. The instance of DCIM_BIOSService shall be the Central Instance. Table 1 identifies profiles that are related to this profile. Table 1 – Related Profiles 6 Profile Name Organization Version Relationship Profile Registration Profile DMTF 1.0 Mandatory Description The BIOS and Boot Management Profile describes BIOS setup configuration including boot management.
Figure 2 represents the class schema for the boot management feature of the BIOS and Boot Management Profile. For simplicity, the prefix CIM_ has been removed from the names of the classes. Each boot list is represented by a DCIM_BootConfigSetting instance. Each of the boot lists contains the boot devices/sources represented by DCIM_BootSourceSetting, shown underneath their corresponding boot lists in the figure below.
7 Implementation Requirements Requirements and guidelines for propagating and formulating certain properties of the classes are discussed in this section. Methods are listed in section 8. Table 2 shows the instances of CIM Elements for this profile. Instances of the CIM Elements shall be implemented as described in Table 2. Sections 7 (“Implementation Requirements” and “Methods”) may impose additional requirements on these elements.
7.1.1.1 WBEM URIs for WinRM® The class WBEM URI shall be “http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_BIOSEnumeration?__cimnamespace=” The key property shall be the InstanceID. The instance WBEM URI for DCIM_BIOSEnumeration instance shall be: “http://schemas.dell.com/wbem/wscim/1/cimschema/2/DCIM_BIOSEnumeration?__cimnamespace=+InstanceID= BIOS.Setup.1-1:” 7.1.1.
Table 4 – Class: DCIM_BIOSEnumeration Properties Notes Additional Requirements InstanceID Mandatory The property value shall be formed as follows: “BIOS.Setup.1-1:”. AttributeName Mandatory The property value shall be from the “AttributeName” column in Table 5 CurrentValue Mandatory The property value shall be one of the values in the “PossibleValues” column at the corresponding row in Table 5.
MemVolt MemLowPower System Memory Voltage FALSE AutoVolt, Volt15V, Volt13V Memory Low Power Mode FALSE Enabled, Disabled Each processor core supports up to two logical processors. When this field is set to Enabled (the default), the BIOS reports all logical processors. When set to Disabled, the BIOS only reports one logical processor per core. FALSE Enabled, Disabled LogicalProc NOTE: This attribute does not affect the DCIM_CPUView.
Training on Software Prefetch FALSE Enabled, Disabled ProcTurboMode When set to Enabled, the processor can operate in Turbo Mode ProcC1E C1E FALSE Enabled, Disabled FALSE Enabled, Disabled ProcCStates When set to Enabled, the processor can operate in all available Power States FALSE AtaMode, Off EmbSata Allows the Embedded SATA to be set to Off or ATA Mode FALSE Off, Auto SataPortA Select Auto to enable BIOS support for the device FALSE Off, Auto SataPortB Select Auto to enable BIOS s
User Accessible USB Ports FALSE AllOn, OnlyBackPortsOn, AllOff UsbPorts InternalUsb Internal USB Port FALSE On, Off InternalUsb1 Internal USB Port FALSE On, Off InternalUsb2 Internal USB Port FALSE On, Off InternalSdCard Internal SD Card Port Feature Dependant1 On, Off InternalSdCardRedundancy Internal SD Card Redundancy Attribute Value Dependant3 Mirror, Disabled EmbNic1Nic2 Embedded NIC1 and NIC2 FALSE Enabled, DisabledOs Embedded Gb NIC1 FALSE Enabled, EnabledPxe, EnablediScs
FailSafeBaud Failsafe Baud Rate FALSE 115200, 57600, 19200, 9600 ConTermType Remote Terminal Type FALSE Vt100Vt220, Ansi RedirAfterBoot Redirection After Boot FALSE Enabled, Disabled Front-Panel LCD Options FALSE None, UserDefined, ModelNum, Advanced Power Management FALSE OsCtrl, ActivePwrCtrl, Custom, MaxPerf ProcPwrPerf CPU Power and Performance Management Attribute Value Dependant4,5 SysDbpm, MaxPerf, MinPwr, OsDbpm Fan Power and Performance Management Attribute Value Dependant4,6
front panel. FALSE Enabled, Disabled NmiButton This field enables/disables the NMI button on the front panel. FALSE Last, On, Off AcPwrRcvry AC Power Recovery, this field specifies how the system will react after AC power has been restored to the system. It is especially useful for people who turn their systems off with a power strip. When set to Off, the system will stay off after AC is restored. When set to On, the system will turn on after AC is restored.
• “MaxPerf” if PowerMgmt is set to “MaxPerf” NOTE: 6 – The FanPwrPerf shall have value “MinPwr” if PowerMgmt is set to “OsCtrl” or “ActivePwrCtrl”. NOTE: 7 – The MemPwrPerf shall have value “MinPwr” if PowerMgmt is not set to “Custom”. NOTE: 8 – The TpmActivation, TpmClear attributes are settable (IsReadOnly=FALSE), if the TpmSecurity attribute is NOT set to “Off”; otherwise those attributes are read-only (IsReadOnly=TRUE).
Table 7 – Class: DCIM_BIOSString Properties Notes Additional Requirements InstanceID Mandatory The property value shall be formed as follows: BIOS.Setup.1-1:”. AttributeName Mandatory The property value shall be from the “AttributeName” column in Table 8. CurrentValue Mandatory The property value shall match the format described in “Value Expression” column at the corresponding row in Table 8.
schema/2/DCIM_BIOSInteger?__cimnamespace=+InstanceID= BIOS.Setup.1-1:AttributeName (AttributeName comes from Table 5)” 7.1.3.2 Operations The following table details the implemented operations on DCIM_BIOSInteger. Table 9 – DCIM_BIOSInteger - Operations Operation Name Get Enumerate DCIM_BIOSService.SetAttribute() DCIM_BIOSService.SetAttributes() 7.1.3.3 Requirements Mandatory Mandatory Mandatory Mandatory Required Input Instance URI Class URI See section 8.1 See section 8.
Table 11 – DCIM_BIOSInteger Attributes AttributeName AcPwrRcvryUserDelay Version 1.0.
7.2 Boot Management Each of DCIM_BootConfigSetting instances shall represent a boot list, and each boot list can be enabled to be used in the next boot using the algorithm in “Boot State Enablement” column. The following boot lists shall be implemented: Table 12 – Boot Lists Boot Lists IPL/BIOS DCIM_BootConfig Setting.
• The IsNext property set to 1(Is Next) shall represents that the boot list is configured to be used for the next boot. vFlash boot list shall not have this value. • The IsNext property set to 3(Is Next for Single Use) shall represent that the boot list is configured to be used ONLY for the next boot. Only the OneTime boot list may have this value for the IsNext property.
Table 14 – Class: DCIM_BootConfigSetting Properties and Methods Requirement Description InstanceID Mandatory The property value shall be from Table 12 “DCIM_BootConfigSetting.InstanceID” column.
7.2.2.3 Properties The following table details the implemented properties for DCIM_BootSourceSetting. The “Requirements” column shall denote the implementation requirement for the corresponding property. If the column “Property Name” matches the property name, the property either shall have the value denoted in the corresponding column “Additional Requirement”, or shall be implemented according to the requirements in the corresponding column “Additional Requirement”. Version 1.0.
Table 16 – Class: DCIM_BootSourceSetting Properties and Methods Requirement Description InstanceID Mandatory The property value shall have prefix from Table 12 “DCIM_BootSourceSetting.InstanceID” column followed by a unique id representing the boot source. For example: UEFI:Disk.USBFront.21:3156051d1529b8f4f88c99f54b895350 (boot source belongs to UEFI bootlist) IPL:NIC.Slot.42:d0f2c6c736adb8c2238153293a0c026c (boot source belongs to IPL bootlist) BCV:RAID.Integrated.
This section describes the implementation for the DCIM_BIOSService class that represents the BIOS and boot management service. This class shall be instantiated in the Implementation Namespace. The DCIM_LCElementConformsToProfile association(s) shall reference the DCIM_BIOSService instance(s). 7.3.1.1 WBEM URIs for WinRM® The class WBEM URI shall be “http://schemas.dell.
Table 18 – Class: DCIM_BIOSService Properties and Methods Requirement Description SystemCreationClassName Mandatory The property value shall be “DCIM_ComputerSystem”. CreationClassName Mandatory The property value shall be “DCIM_BIOSService”. SystemName Mandatory The property value shall be “DCIM:ComputerSystem”. Name Mandatory The property value shall be “DCIM:BIOSService” ElementName Mandatory The property value shall be “BIOS Service” 7.4 7.4.
7.4.1.3 Properties The following table details the implemented properties for DCIM_LCRegisteredProfile instance representing BIOS and Boot Management Profile implementation. The “Requirements” column shall denote the implementation requirement for the corresponding property.
8 Methods This section details the requirements for supporting intrinsic operations and extrinsic methods for the CIM elements defined by this profile. 8.1 CIM_BIOSService.SetAttribute( ) The SetAttribute( ) method is used to set or change the value of a BIOS attribute. Invocation of the SetAttribute( ) method shall change the value of the attribute’s CurrentValue or attribute’s PendingValue property to the value specified by the AttributeValue parameter if the attribute’s IsReadOnly property is FALSE.
8.2 DCIM_BIOSService.SetAttributes( ) The SetAttributes( ) method is used to set or change the values of a group of attributes. Invocation of the SetAttributes( ) method shall change the values of the attribute’s CurrentValue or PendingValue properties that correspond to the names specified by the AttributeName parameter and the values specified by the AttributeValue parameter if the respective attribute’s IsReadOnly property is FALSE.
1. RebootJobType: when provided in the input parameters, creates a specific reboot job to “PowerCycle” or “Graceful Reboot without forced shutdown” or “Graceful Reboot with forced shutdown”. This parameter only creates the RebootJob and does not schedule it. 2. ScheduledStartTime: When provided in the input parameters, schedules the “configuration job” and the optional “reboot job” at the specified start time. A special value of “TIME_NOW” schedules the job(s) immediately. 3.
8.4 DCIM_BIOSService.DeletePendingConfiguration( ) The DeletePendingConfiguration( ) method is used to cancel the pending values created by the SetAttribute and SetAttributes methods. The DeletePendingConfiguration( ) method cancels the pending configuration changes made before the configuration job is created with CreateTargetedConfigJob(). This method only operates on the pending changes prior to CreateTargetedConfigJob() being called.
Table 29 – ChangeBootSourceState( ) Method: Return Code Values Value Description 0 Completed with no error 1 Not supported 2 Failed 4096 Job Created Table 30 – ChangeBootSourceState( ) Method: Parameters Qualifiers Name Type Description/Values IN, REQ EnabledState String Shall contain the requested state for the boot device. IN, REQ source[] String Shall contain the InstanceID value(s) for DCIM_BootSourceSetting instances to be affected.
Table 31 – ChangeBootOrderByInstanceID( ) Method: Return Code Values Value Description 0 Completed with no error 1 Not supported 2 Failed 4096 Job Created Table 32 – ChangeBootOrderByInstanceID( ) Method: Parameters Qualifiers Name Type Description/Values IN, REQ source[] String Shall contain the InstanceID value(s) for DCIM_BootSourceSetting instances to change the order of. OUT Job CIM_Concrete Job REF Reference to the newly created pending value application job.
RegisteredOrganization = 1 RegisteredVersion = 1.0.0 B) ENUMERATE the CIM_RegisteredProfile class. See section 3.13 for a definition of ENUMERATE . Class URI: http://schemas.dmtf.org/wbem/wscim/1/cimschema/2/CIM_RegisteredProfile?__cimnamespace=root/interop Then query the result for the following properties: RegisteredName = BIOS and Boot Management, OtherRegisteredOrganization = DCIM, RegisteredVersion = 1.0.0 9.
http://schemas.dmtf.org/wbem/wscim/1/cimschema/2/root/dcim/DCIM_BIOSService?SystemCreationClassName=DCIM_ComputerS ystem+CreationClassName=DCIM_BIOSService+SystemName=DCIM:ComputerSystem +Name=DCIM:BIOSService 9.5 E) Examine output parameters per Table 23. F) Apply the pending values (Section 9.
9.8 Get the first boot configuration’s information The URI for getting particular instance information is deterministic (i.e the InstanceID will be unique for each instance) For the first boot configuration in the system, the instance URI will be: http://schemas.dmtf.org/wbem/wscim/1/cimschema/2/DCIM_BootConfigSetting?__cimnamespace=root/dcim+InstanceID=IPL The instance of DCIM_BootConfigSetting that contains the information on the first boot configuration will be returned 9.
B) ENUMERATE the DCIM_BootSourceSetting class as shown in 9.9 and identify the boot source InstanceID. The CurrentEnabledStatus attribute of each instance identifies whether it is enable or disabled C) To invoke the ChangeBootSourceState() method, extract the instance information from A) and B) and construct the input parameters per Table 30 in section 8.5. D) INVOKE ChangeBootSourceState() method Class URI: http://schemas.dmtf.
ANNEX A (informative) Related MOF Files Dell Tech Center MOF Library: http://www.delltechcenter.com/page/DCIM.Library.MOF Related Managed Object Format (MOF) files: DCIM_BootConfigSetting.mof DCIM_BootSourceSetting.mof DCIM_BIOSEnumeration.mof DCIM_BIOSInteger.mof DCIM_BIOSService.mof DCIM_BIOSString.mof DCIM_LCElementConformsToProfile DCIM_LCRegisteredProfile 40 Version 1.0.