summaryrefslogtreecommitdiff
path: root/docs/cli.rst
diff options
context:
space:
mode:
authorRobert Göhler <github@ghlr.de>2024-10-15 07:00:39 +0200
committerGitHub <noreply@github.com>2024-10-15 07:00:39 +0200
commitf3246467c68e51080e5817a18974fe0dfb95fd1f (patch)
tree8e2f402bf33f98c9f07a19bfb207491e078e483c /docs/cli.rst
parentd97233be30d5da36a03c278e1f6f9e1ca302ef7b (diff)
parenta265a2073787767a795b01c09127948e6a72a162 (diff)
downloadvyos-documentation-f3246467c68e51080e5817a18974fe0dfb95fd1f.tar.gz
vyos-documentation-f3246467c68e51080e5817a18974fe0dfb95fd1f.zip
Merge pull request #1558 from jestabro/update-commit-confirm
config-mgmt: T5976: update commit-confirm description for option reload
Diffstat (limited to 'docs/cli.rst')
-rw-r--r--docs/cli.rst24
1 files changed, 15 insertions, 9 deletions
diff --git a/docs/cli.rst b/docs/cli.rst
index 65de0537..7ba34bc4 100644
--- a/docs/cli.rst
+++ b/docs/cli.rst
@@ -662,10 +662,22 @@ different levels in the hierarchy.
.. cfgcmd:: commit-confirm <minutes>
Use this command to temporarily commit your changes and set the
- number of minutes available for validation. ``confirm`` must
- be entered within those minutes, otherwise the system will reboot
- into the previous configuration. The default value is 10 minutes.
+ number of minutes available for confirmation. ``confirm`` must
+ be entered within those minutes, otherwise the system will revert
+ into a previous configuration. The default value is 10 minutes.
+ The definition of 'revert' and 'a previous configuration' depends on
+ the setting:
+
+ .. code-block:: none
+
+ vyos@vyos# set system config-management commit-confirm
+ Possible completions:
+ reload Reload previous configuration if not confirmed
+ reboot Reboot to saved configuration if not confirmed (default)
+
+ Note that 'reload' loads the most recent completed configuration and does
+ not require a reboot.
What if you are doing something dangerous? Suppose you want to setup
a firewall, and you are not sure there are no mistakes that will lock
@@ -684,12 +696,6 @@ different levels in the hierarchy.
vyos@router# confirm
[edit]
-
- .. note:: A reboot because you did not enter ``confirm`` will not
- take you necessarily to the *saved configuration*, but to the
- point before the unfortunate commit.
-
-
.. cfgcmd:: copy
Copy a configuration element.