summaryrefslogtreecommitdiff
path: root/doc/source/admin
diff options
context:
space:
mode:
authornoor_muhammad_dell <noor_muhammad@dellteam.com>2020-03-17 18:41:46 +0500
committernoor_muhammad_dell <noor_muhammad@dellteam.com>2020-04-17 15:41:24 +0500
commitcb86bd3088ff6af575b2357c8880704f11a48d0c (patch)
tree5e6854dd512866e29fd716a3ff1d18c345e4a46f /doc/source/admin
parent940cbbc998e656d3c30a47a41ca97e5e2caec09d (diff)
downloadironic-cb86bd3088ff6af575b2357c8880704f11a48d0c.tar.gz
Implement the bios-interface for idrac-wsman driver
The BIOSInterface implementation for idrac-wsman Hardware Type was missing and VendorInterface methods were used to configure BIOS instead. This was not desired since it exposes a lot of vendor intricacies to the operator and makes the existing mechanism unstable across Ironic releases. This change introduces the implementation of BIOSInterface with the following code changes: 1. update IDRACHardware class with supported_bios_interfaces() method 2. update setup.cfg with an entry for idrac-wsman in bios interfaces 3. Implement the DracWSManBIOS class with appropriate methods 4. Unit tests for the work Change-Id: Ie85e30e2dfdfb1f199ac4d25f165e0cca033a4df Co-authored-by: Richard Pioso <richard.pioso@dell.com> Story: 2007400 Task: 38998
Diffstat (limited to 'doc/source/admin')
-rw-r--r--doc/source/admin/drivers/idrac.rst44
1 files changed, 41 insertions, 3 deletions
diff --git a/doc/source/admin/drivers/idrac.rst b/doc/source/admin/drivers/idrac.rst
index 13e39d05c..e81f4bce2 100644
--- a/doc/source/admin/drivers/idrac.rst
+++ b/doc/source/admin/drivers/idrac.rst
@@ -27,6 +27,7 @@ Ironic Features
The ``idrac`` hardware type supports the following Ironic interfaces:
+* `BIOS Interface`_: BIOS management
* `Inspect Interface`_: Hardware inspection
* Management Interface: Boot device management
* Power Interface: Power management
@@ -51,7 +52,7 @@ configured to use an ``idrac-redfish`` interface implementation, for example::
Enabling
--------
-The iDRAC driver supports WSMAN for the inspect, management, power,
+The iDRAC driver supports WSMAN for the bios, inspect, management, power,
raid, and vendor interfaces. In addition, it supports Redfish for
the inspect, management, and power interfaces. The iDRAC driver
allows you to mix and match WSMAN and Redfish interfaces.
@@ -74,7 +75,7 @@ all using WSMAN, add the following to your ``/etc/ironic/ironic.conf``:
enabled_management_interfaces=idrac-wsman
enabled_power_interfaces=idrac-wsman
-To enable all optional features (inspection, RAID, and vendor passthru)
+To enable all optional features (BIOS, inspection, RAID, and vendor passthru)
using Redfish where it is supported and WSMAN where not, use the
following configuration:
@@ -82,6 +83,7 @@ following configuration:
[DEFAULT]
enabled_hardware_types=idrac
+ enabled_bios_interfaces=idrac-wsman
enabled_inspect_interfaces=idrac-redfish
enabled_management_interfaces=idrac-redfish
enabled_power_interfaces=idrac-redfish
@@ -94,7 +96,7 @@ order:
================ ===================================================
Interface Supported Implementations
================ ===================================================
-``bios`` ``no-bios``
+``bios`` ``idrac-wsman``, ``no-bios``
``boot`` ``ipxe``, ``pxe``
``console`` ``no-console``
``deploy`` ``iscsi``, ``direct``, ``ansible``, ``ramdisk``
@@ -198,6 +200,42 @@ hardware type assuming a mix of Redfish and WSMAN interfaces are used:
for the power interface. The same applies to Redfish. It is currently not
possible to use Redfish for one and WSMAN for the other.
+BIOS Interface
+==============
+
+The BIOS interface implementation for idrac-wsman allows BIOS to be
+configured with the standard clean/deploy step approach.
+
+Example
+-------
+A clean step to enable ``Virtualization`` and ``SRIOV`` in BIOS of an iDRAC
+BMC would be as follows::
+
+ {
+ "target":"clean",
+ "clean_steps": [
+ {
+ "interface": "bios",
+ "step": "apply_configuration",
+ "args": {
+ "settings": [
+ {
+ "name": "ProcVirtualization",
+ "value": "Enabled"
+ },
+ {
+ "name": "SriovGlobalEnable",
+ "value": "Enabled
+ }
+ ]
+ }
+ }
+ ]
+ }
+
+To see all the available BIOS parameters on a node with iDRAC BMC, and also
+for additional details of BIOS configuration, see :doc:`/admin/bios`.
+
Inspect Interface
=================