This is a big commit, and I apologize in advance for the future
git-blames all pointing to me. This commit does a few things:
1. Merges the website/docs and website/www repo into a single website repo
to be in line with other HashiCorp projects
2. Updates to use middleman-hashicorp
3. Converts less to scss to be in line with other projects
4. Updates page styles to be in line with other projects
5. Optimizes images
6. Prepare for S3 + Fastly deployment with scripts, etc.
7. Removes blog posts (they have been transferred to hashicorp.com with
redirects in place
8. Updated sitemap generation script for better SEO
9. Fixed many broken links
10. Add description to all fields
84 lines
2.2 KiB
Markdown
84 lines
2.2 KiB
Markdown
---
|
|
layout: "docs"
|
|
page_title: "vagrant snapshot - Command-Line Interface"
|
|
sidebar_current: "cli-snapshot"
|
|
description: |-
|
|
The "vagrant snapshot" command is used to manage snapshots of the guest
|
|
machine.
|
|
---
|
|
|
|
# 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 is not 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 do not 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 does not 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 is not an option, or is not ideal, then the deletion
|
|
can also be done online with most providers.
|