diff options
| -rw-r--r-- | docs/configuration-overview.rst | 99 |
1 files changed, 47 insertions, 52 deletions
diff --git a/docs/configuration-overview.rst b/docs/configuration-overview.rst index 3a1014f0..cb5bf716 100644 --- a/docs/configuration-overview.rst +++ b/docs/configuration-overview.rst @@ -221,7 +221,7 @@ These commands are also relative to the level where they are executed and all re These two commands above are essentially the same, just executed from different levels in the hierarchy. To delete a configuration entry use the `delete` command, this also deletes all sub-levels under the current level you've specified in the `delete` command. -Deleting an entry could also mean to reset it back to its default value if the element is mandatory, in each case it will be removed from the configuration file. +Deleting an entry would also result in the element reverting back to its default value if one exist. .. code-block:: sh @@ -265,51 +265,7 @@ used. exit vyos@vyos:~$ -VyOS automatically maintains backups of previous configurations. To compare -configuration revisions in configuration mode, use the compare command: -.. code-block:: sh - - vyos@vyos# compare [tab] - Possible completions: - <Enter> Compare working & active configurations - saved Compare working & saved configurations - <N> Compare working with revision N - <N> <M> Compare revision N with M - Revisions: - 0 2013-12-17 20:01:37 root by boot-config-loader - 1 2013-12-13 15:59:31 root by boot-config-loader - 2 2013-12-12 21:56:22 vyos by cli - 3 2013-12-12 21:55:11 vyos by cli - 4 2013-12-12 21:27:54 vyos by cli - 5 2013-12-12 21:23:29 vyos by cli - 6 2013-12-12 21:13:59 root by boot-config-loader - 7 2013-12-12 16:25:19 vyos by cli - 8 2013-12-12 15:44:36 vyos by cli - 9 2013-12-12 15:42:07 root by boot-config-loader - 10 2013-12-12 15:42:06 root by init - - [edit] - vyos@vyos# - -You can rollback configuration using the rollback command. This -command will apply the selected revision and trigger a system reboot. - -.. code-block:: sh - - vyos@vyos# compare 1 - [edit system] - >host-name vyos-1 - [edit] - vyos@vyos# rollback 1 - Proceed with reboot? [confirm][y] - Broadcast message from root@vyos-1 (pts/0) (Tue Dec 17 21:07:45 2013): - The system is going down for reboot NOW! - [edit] - vyos@vyos# - -VyOS also supports saving and loading configuration remotely using SCP, FTP, -or TFTP. .. code-block:: sh @@ -332,6 +288,7 @@ When inside configuration mode you are not directly able to execute operational Access to these commands are possible through the use of the `run [command]` command. From this command you will have access to everything accessible from operational mode. + Command completion and syntax help with `?` and `[tab]` will also work. .. code-block:: sh @@ -347,12 +304,10 @@ Command completion and syntax help with `?` and `[tab]` will also work. Configuration archive --------------------- -VyOS has built-in config archiving and versioning that renders tools like rancid, largely unnecessary. - -This feature was available in Vyatta Core since 6.3 +VyOS automatically maintains backups of previous configurations. Local archive and revisions ---------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^ Revisions are stored on disk. You can view them, compare them, and rollback to previous revisions if anything goes wrong. @@ -370,6 +325,32 @@ To view existing revisions, use `show system commit` operational mode command. 6 2015-03-25 00:16:47 by vyos via cli 7 2015-03-24 23:43:45 by root via boot-config-loader +To compare configuration revisions in configuration mode, use the compare command: + +.. code-block:: sh + + vyos@vyos# compare [tab] + Possible completions: + <Enter> Compare working & active configurations + saved Compare working & saved configurations + <N> Compare working with revision N + <N> <M> Compare revision N with M + Revisions: + 0 2013-12-17 20:01:37 root by boot-config-loader + 1 2013-12-13 15:59:31 root by boot-config-loader + 2 2013-12-12 21:56:22 vyos by cli + 3 2013-12-12 21:55:11 vyos by cli + 4 2013-12-12 21:27:54 vyos by cli + 5 2013-12-12 21:23:29 vyos by cli + 6 2013-12-12 21:13:59 root by boot-config-loader + 7 2013-12-12 16:25:19 vyos by cli + 8 2013-12-12 15:44:36 vyos by cli + 9 2013-12-12 15:42:07 root by boot-config-loader + 10 2013-12-12 15:42:06 root by init + + [edit] + vyos@vyos# + You can compare revisions with `compare X Y` command, where X and Y are revision numbers. The output will describe how the configuration X is when compared to Y, indicating with a plus sign (**+**) the additional parts X has when compared to y, and indicating with a minus sign (**-**) the lacking parts x misses when compared to y. .. code-block:: sh @@ -388,15 +369,29 @@ You can compare revisions with `compare X Y` command, where X and Y are revision -} -You can rollback to a previous revision with `rollback X`, where X is a revision number. Your system will reboot and load the config from the archive. +You can rollback configuration using the rollback command. This +command will apply the selected revision and trigger a system reboot. + +.. code-block:: sh + + vyos@vyos# compare 1 + [edit system] + >host-name vyos-1 + [edit] + vyos@vyos# rollback 1 + Proceed with reboot? [confirm][y] + Broadcast message from root@vyos-1 (pts/0) (Tue Dec 17 21:07:45 2013): + The system is going down for reboot NOW! + [edit] + vyos@vyos# Configuring the archive size ----------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ You can specify the number of revisions stored on disk with `set system config-management commit-revisions X`, where X is a number between 0 and 65535. When the number of revisions exceeds that number, the oldest revision is removed. Remote archive --------------- +^^^^^^^^^^^^^^ VyOS can copy the config to a remote location after each commit. TFTP, FTP, and SFTP servers are supported. |