website/docs: global-status

This commit is contained in:
Mitchell Hashimoto 2014-05-01 00:11:19 -07:00
parent 97e2af2374
commit ddc6853a4c
3 changed files with 29 additions and 1 deletions

View File

@ -109,6 +109,7 @@
<li<%= sidebar_current("cli-box") %>><a href="/v2/cli/box.html">box</a></li>
<li<%= sidebar_current("cli-connect") %>><a href="/v2/cli/connect.html">connect</a></li>
<li<%= sidebar_current("cli-destroy") %>><a href="/v2/cli/destroy.html">destroy</a></li>
<li<%= sidebar_current("cli-globalstatus") %>><a href="/v2/cli/global-status.html">global-status</a></li>
<li<%= sidebar_current("cli-halt") %>><a href="/v2/cli/halt.html">halt</a></li>
<li<%= sidebar_current("cli-init") %>><a href="/v2/cli/init.html">init</a></li>
<li<%= sidebar_current("cli-login") %>><a href="/v2/cli/login.html">login</a></li>

View File

@ -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.

View File

@ -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`.