Skip to content

Commit de1f79c

Browse files
committed
Document node rescue mode
1 parent 32c7f30 commit de1f79c

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/source/usage/cli.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -308,6 +308,24 @@ If ``console_enabled`` is ``true``, we can access the serial console using follo
308308
If ``console_enabled`` is ``false`` or ``console_info`` is ``None`` then
309309
the serial console is disabled. Note, there can only be one ipmi connection to the node, meaning only one user may access the console at a time.
310310

311+
Rescue Mode
312+
-----------
313+
314+
A node can be booted in rescue mode, potentially allowing for some form of remediation if some aspect of the node fails. Doing so puts the node
315+
on the rescue network temporarily to allow the rescue image to boot; then the node is returned to its original network configuration. If the node
316+
has an external floating IP attached, you can then access the node by running ``ssh rescue@<floating-ip>`` and using the password specified in
317+
the rescue command. For that reason, please specify a strong password.
318+
319+
Nodes should only be put into rescue mode temporarily. When you are finished, it is *highly* recommended that you unrescue the node for security purposes.
320+
321+
+---------------+-------------------------------------------------------------------------+
322+
| | **Actions** |
323+
+---------------+-------------------------------------------------------------------------+
324+
| Rescue Node | ``openstack baremetal node rescue <node> --rescue-password <password>`` |
325+
+---------------+-------------------------------------------------------------------------+
326+
| Unrescue Node | ``openstack baremetal node unrescue <node>`` |
327+
+---------------+-------------------------------------------------------------------------+
328+
311329

312330
Additional ESI CLI Actions
313331
--------------------------

0 commit comments

Comments
 (0)