diff --git a/doc/source/deploy_install_guides/release/bare_metal/adding-hosts-using-the-host-add-command.rst b/doc/source/deploy_install_guides/release/bare_metal/adding-hosts-using-the-host-add-command.rst index 798c80022..e05c7394c 100644 --- a/doc/source/deploy_install_guides/release/bare_metal/adding-hosts-using-the-host-add-command.rst +++ b/doc/source/deploy_install_guides/release/bare_metal/adding-hosts-using-the-host-add-command.rst @@ -132,17 +132,19 @@ scripting an initial setup. on the serial console port. **** - is the board management controller type. Use bmc. + is the |BMC| type. Use bmc. **** - is the board management controller IP address (used for external + is the |BMC| IP address (used for external access to board management controllers over the |OAM| network) **** - is the username for board management controller access + is the username for |BMC| access. It should have + a maximum of 16 characters and no whitespace. **** - is the password for board management controller access + is the password for |BMC| access. It should have + a maximum of 20 characters and no whitespace. For example: diff --git a/doc/source/deploy_install_guides/release/bare_metal/bulk-host-xml-file-format.rst b/doc/source/deploy_install_guides/release/bare_metal/bulk-host-xml-file-format.rst index c52c2a7d2..e020b8724 100644 --- a/doc/source/deploy_install_guides/release/bare_metal/bulk-host-xml-file-format.rst +++ b/doc/source/deploy_install_guides/release/bare_metal/bulk-host-xml-file-format.rst @@ -42,9 +42,9 @@ valid values, refer to the CLI documentation. +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | bm_type | The board management controller type. | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | bm_username | The username for board management controller authentication. | + | bm_username | The username for board management controller authentication. It should have a maximum of 16 characters and no whitespace. | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | bm_password | The password for board management controller authentication. | + | bm_password | The password for board management controller authentication. It should have a maximum of 20 characters and no whitespace. | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | power_on | An empty element. If present, powers on the host automatically using the specified board management controller. | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/doc/source/node_management/kubernetes/provisioning_bmc/provisioning-bmc-after-adding-a-host.rst b/doc/source/node_management/kubernetes/provisioning_bmc/provisioning-bmc-after-adding-a-host.rst index 6e944e0f8..f617b0a05 100644 --- a/doc/source/node_management/kubernetes/provisioning_bmc/provisioning-bmc-after-adding-a-host.rst +++ b/doc/source/node_management/kubernetes/provisioning_bmc/provisioning-bmc-after-adding-a-host.rst @@ -16,3 +16,16 @@ Provision BMC after Adding a Host .. code-block:: none system host-update bm_ip= bm_username= bm_password= bm_type=[redfish|ipmi|dynamic] + + where + + **** + is the |BMC| IP address. + + **** + is the username for |BMC| access. It should have + a maximum of 16 characters and no whitespace. + + **** + is the password for |BMC| access. It should have + a maximum of 20 characters and no whitespace. diff --git a/doc/source/node_management/kubernetes/provisioning_bmc/provisioning-bmc-when-adding-a-host.rst b/doc/source/node_management/kubernetes/provisioning_bmc/provisioning-bmc-when-adding-a-host.rst index f9db94703..150122b60 100644 --- a/doc/source/node_management/kubernetes/provisioning_bmc/provisioning-bmc-when-adding-a-host.rst +++ b/doc/source/node_management/kubernetes/provisioning_bmc/provisioning-bmc-when-adding-a-host.rst @@ -16,3 +16,22 @@ Provision BMC when Adding a Host .. code-block:: none system host-add -n -p -m -I -U -P -T [redfish|ipmi|dynamic] + + where + + **** + is the host type. + + **** + is the |MAC| address of the port connected to the internal management. + + **** + is the |BMC| IP address. + + **** + is the username for |BMC| access. It should have + a maximum of 16 characters and no whitespace. + + **** + is the password for |BMC| access. It should have + a maximum of 20 characters and no whitespace.