2013-09-03 18:08:28 +00:00
|
|
|
---
|
2016-01-19 18:08:53 +00:00
|
|
|
layout: "docs"
|
2013-09-06 16:50:43 +00:00
|
|
|
page_title: "vagrant halt - Command-Line Interface"
|
2013-09-03 18:08:28 +00:00
|
|
|
sidebar_current: "cli-halt"
|
2016-01-19 18:08:53 +00:00
|
|
|
description: |-
|
|
|
|
The "vagrant halt" command is used to shut down the virtual machine that
|
|
|
|
Vagrant is currently managing.
|
2013-09-03 18:08:28 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
# Halt
|
|
|
|
|
2016-04-12 11:45:10 +00:00
|
|
|
**Command: `vagrant halt [name|id]`**
|
2013-09-03 18:08:28 +00:00
|
|
|
|
|
|
|
This command shuts down the running machine Vagrant is managing.
|
|
|
|
|
|
|
|
Vagrant will first attempt to gracefully shut down the machine by running
|
|
|
|
the guest OS shutdown mechanism. If this fails, or if the `--force` flag is
|
|
|
|
specified, Vagrant will effectively just shut off power to the machine.
|
|
|
|
|
2015-11-26 17:22:23 +00:00
|
|
|
For linux-based guests, Vagrant uses the `shutdown` command to gracefully
|
|
|
|
terminate the machine. Due to the varying nature of operating systems, the
|
|
|
|
`shutdown` command may exist at many different locations in the guest's `$PATH`.
|
|
|
|
It is the guest machine's responsibility to properly populate the `$PATH` with
|
|
|
|
directory containing the `shutdown` command.
|
|
|
|
|
2013-09-03 18:08:28 +00:00
|
|
|
## Options
|
|
|
|
|
2016-01-19 18:08:53 +00:00
|
|
|
* `-f` or `--force` - Do not attempt to gracefully shut down the machine.
|
2013-09-03 18:08:28 +00:00
|
|
|
This effectively pulls the power on the guest machine.
|