From 94b675581379a062d6555adfa6ac82b87ec9084b Mon Sep 17 00:00:00 2001 From: Mitchell Hashimoto Date: Wed, 7 Oct 2015 23:03:13 -0400 Subject: [PATCH] website/docs: update docs for snapshotting --- website/docs/source/layouts/layout.erb | 1 + website/docs/source/v2/cli/snapshot.html.md | 79 +++++++++++++++++++++ 2 files changed, 80 insertions(+) create mode 100644 website/docs/source/v2/cli/snapshot.html.md diff --git a/website/docs/source/layouts/layout.erb b/website/docs/source/layouts/layout.erb index 4fedc3627..259577d79 100644 --- a/website/docs/source/layouts/layout.erb +++ b/website/docs/source/layouts/layout.erb @@ -108,6 +108,7 @@ >reload >resume >share + >snapshot >ssh >ssh-config >status diff --git a/website/docs/source/v2/cli/snapshot.html.md b/website/docs/source/v2/cli/snapshot.html.md new file mode 100644 index 000000000..42a2dfc68 --- /dev/null +++ b/website/docs/source/v2/cli/snapshot.html.md @@ -0,0 +1,79 @@ +--- +page_title: "vagrant snapshot - Command-Line Interface" +sidebar_current: "cli-snapshot" +--- + +# Snapshot + +**Command: `vagrant snapshot`** + +This is the command used to manage snapshots with the guest machine. +Snapshots record a point-in-time state of a guest machine. You can then +quickly restore to this environment. This lets you experiment and try things +and quickly restore back to a previous state. + +Snapshotting is not supported by every provider. If it isn't supported, +Vagrant will give you an error message. + +The main functionality of this command is exposed via even more subcommands: + +* `push` +* `pop` +* `save` +* `restore` +* `list` +* `delete` + +# Snapshot Push + +**Command: `vagrant snapshot push`** + +This takes a snapshot and pushes it onto the snapshot stack. + +This is a shorthand for `vagrant snapshot save` where you don't need +to specify a name. When you call the inverse `vagrant snapshot pop`, it will +restore the pushed state. + +~> **Warning:** If you are using `push` and `pop`, avoid using `save` + and `restore` which are unsafe to mix. + +# Snapshot Pop + +**Command: `vagrant snapshot pop`** + +This command is the inverse of `vagrant snapshot push`: it will restore +the pushed state. + +# Snapshot Save + +**Command: `vagrant snapshot save NAME`** + +This command saves a new named snapshot. If this command is used, the +`push` and `pop` subcommands cannot be safely used. + +# Snapshot Restore + +**Command: `vagrant snapshot restore NAME`** + +This command restores the named snapshot. + +# Snapshot List + +**Command: `vagrant snapshot list`** + +This command will list all the snapshots taken. + +# Snapshot Delete + +**Command: `vagrant snapshot delete NAME`** + +This command will delete the named snapshot. + +Some providers require all "child" snapshots to be deleted first. Vagrant +itself doesn't track what these children are. If this is the case (such +as with VirtualBox), then you must be sure to delete the snapshots in the +reverse order they were taken. + +This command is typically _much faster_ if the machine is halted prior to +snapshotting. If this isn't an option, or isn't ideal, then the deletion +can also be done online with most providers.