diff --git a/website/docs/source/layouts/layout.erb b/website/docs/source/layouts/layout.erb index bcb6fd70b..7c9cdd90e 100644 --- a/website/docs/source/layouts/layout.erb +++ b/website/docs/source/layouts/layout.erb @@ -109,6 +109,7 @@ >box >connect >destroy + >global-status >halt >init >login diff --git a/website/docs/source/v2/cli/global-status.html.md b/website/docs/source/v2/cli/global-status.html.md new file mode 100644 index 000000000..061515f3b --- /dev/null +++ b/website/docs/source/v2/cli/global-status.html.md @@ -0,0 +1,27 @@ +--- +page_title: "vagrant global-status - Command-Line Interface" +sidebar_current: "cli-globalstatus" +--- + +# Global Status + +**Command: `vagrant global-status`** + +This command will tell you the state of all active Vagrant environments +on the system for the currently logged in user. + +This command doesn't actively verify the state of the machines listed, +and is instead based on a cache. Because of this, it is possible to see +stale results (machines say they're running but they're not). For example, +if you restart your computer, Vagrant wouldn't know. To prune the invalid +entries, run global status with the `--prune` flag. + +The IDs in the output that look like `a1b2c3` can be used to control +the Vagrant machine from anywhere on the system. Any Vagrant command +that takes a target machine (such as `up`, `halt`, `destroy`) can be +used with this ID to control it. For example: `vagrant destroy a1b2c3`. + +## Options + +* `--prune` - Prunes invalid entries from the list. This is much more time + consuming than simply listing the entries. diff --git a/website/docs/source/v2/cli/up.html.md b/website/docs/source/v2/cli/up.html.md index 07f8f08ca..fdbbcccbb 100644 --- a/website/docs/source/v2/cli/up.html.md +++ b/website/docs/source/v2/cli/up.html.md @@ -14,7 +14,7 @@ This is the single most important command in Vagrant, since it is how any Vagrant machine is created. Anyone using Vagrant must use this command on a day-to-day basis. -# Options +## Options * `--[no-]destroy-on-error` - Destroy the newly created machine if a fatal, unexpected error occurs. This will only happen on the first `vagrant up`.