diff --git a/doc/source/admin/drivers/ilo.rst b/doc/source/admin/drivers/ilo.rst index 735ff97024..f82ed3ec5f 100644 --- a/doc/source/admin/drivers/ilo.rst +++ b/doc/source/admin/drivers/ilo.rst @@ -1668,7 +1668,7 @@ manual cleaning step can only be initiated when a node is in the ``manageable`` state. Once the manual cleaning is finished, the node will be put in the ``manageable`` state again. A user can follow steps from :ref:`manual_cleaning` to initiate manual cleaning operation on a node. This feature is only supported -for ``ilo5`` based hardware. +for iLO5 based hardware. An example of a manual clean step with ``security_parameters_update`` as the only clean step could be:: @@ -1736,7 +1736,7 @@ Update Minimum Password Length security parameter as manual clean step ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ iLO driver can invoke ``Minimum Password Length`` security parameter update as a manual clean -step. This feature is only supported for ``ilo5`` based hardware. +step. This feature is only supported for iLO5 based hardware. An example of a manual clean step with ``update_minimum_password_length`` as the only clean step could be:: @@ -1758,7 +1758,7 @@ Update Authentication Failure Logging security parameter as manual clean step ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ iLO driver can invoke ``Authentication Failure Logging`` security parameter update as a manual clean -step. This feature is only supported for ``ilo5`` based hardware. +step. This feature is only supported for iLO5 based hardware. An example of a manual clean step with ``Authentication Failure Logging`` as the only clean step could be:: diff --git a/ironic/drivers/modules/ilo/management.py b/ironic/drivers/modules/ilo/management.py index 28fef03bb5..17516b4b82 100644 --- a/ironic/drivers/modules/ilo/management.py +++ b/ironic/drivers/modules/ilo/management.py @@ -108,9 +108,10 @@ _MINIMUM_PASSWORD_LENGTH_UPDATE_ARGSINFO = { }, 'ignore': { 'description': ( - "This argument represents boolean parameter. If set 'True' the " - "security parameters will be ignored. If not specified, default " - "will be 'False'." + "This argument represents boolean parameter. If set 'True' " + "the security parameters will be ignored by iLO while " + "computing the overall iLO security status. If not specified, " + "default will be 'False'." ), 'required': False } @@ -127,9 +128,10 @@ _Auth_Failure_Logging_Threshold_ARGSINFO = { }, 'ignore': { 'description': ( - "This argument represents boolean parameter. If set 'True' the " - "security parameters will be ignored. If not specified, default " - "will be 'False'." + "This argument represents boolean parameter. If set 'True' " + "the security parameters will be ignored by iLO while " + "computing the overall iLO security status. If not specified, " + "default will be 'False'." ), 'required': False } diff --git a/releasenotes/notes/adding-security-param-clean-step-00d5548072a397f2.yaml b/releasenotes/notes/adding-security-param-clean-step-00d5548072a397f2.yaml index 2df38df6e2..5a3b2d0bc3 100644 --- a/releasenotes/notes/adding-security-param-clean-step-00d5548072a397f2.yaml +++ b/releasenotes/notes/adding-security-param-clean-step-00d5548072a397f2.yaml @@ -1,7 +1,7 @@ --- features: - | - Adding new clean steps to ``ilo`` hardware type - + Adding new clean steps to ``ilo`` and ``ilo5`` hardware type - ``security_parameters_update``, ``update_minimum_password_length``, and ``update_auth_failure_logging_threshold`` which allows users to modify ilo system security settings.