From 39e8b37e412fbd43fd6872a306635b011987e557 Mon Sep 17 00:00:00 2001 From: Dao Cong Tien Date: Thu, 13 Jul 2017 19:08:57 +0700 Subject: [PATCH] Adds doc for restore_irmc_bios_config clean step Change-Id: I99ef7c98132538917d09a73fd99fb5a3c673c7fb Closes-Bug: #1639688 --- doc/source/admin/drivers/irmc.rst | 33 +++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/doc/source/admin/drivers/irmc.rst b/doc/source/admin/drivers/irmc.rst index eaaa130684..bf6e219c2b 100644 --- a/doc/source/admin/drivers/irmc.rst +++ b/doc/source/admin/drivers/irmc.rst @@ -252,6 +252,39 @@ Node configuration - ``driver_info/irmc_snmp_community`` property overrides ``snmp_community``. - ``driver_info/irmc_snmp_security`` property overrides ``snmp_security``. +Functionalities across drivers +============================== + +.. _irmc_node_cleaning: + +Node Cleaning Support +^^^^^^^^^^^^^^^^^^^^^ +The following iRMC drivers support node cleaning: + +* ``pxe_irmc`` +* ``iscsi_irmc`` +* ``agent_irmc`` + +For more information on node cleaning, see :ref:`cleaning` + +Supported **Automated** Cleaning Operations +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The automated cleaning operations supported are: + +* ``restore_irmc_bios_config``: + Restores BIOS settings on a baremetal node from backup data. If this + clean step is enabled, the BIOS settings of a baremetal node will be + backed up automatically before the deployment. By default, this clean + step is disabled with priority ``0``. Set its priority to a positive + integer to enable it. The recommended value is ``10``. + +Configuration options for the automated cleaning steps are listed under +``[irmc]`` section in ironic.conf :: + + clean_priority_restore_irmc_bios_config = 0 + +For more information on node automated cleaning, see :ref:`automated_cleaning` Supported platforms ===================