mirror of
https://github.com/hashicorp/vagrant.git
synced 2026-05-28 04:36:05 -04:00
38 lines
1.6 KiB
Text
38 lines
1.6 KiB
Text
---
|
|
layout: docs
|
|
page_title: vagrant halt - Command-Line Interface
|
|
description: |-
|
|
The "vagrant halt" command is used to shut down the virtual machine that
|
|
Vagrant is currently managing.
|
|
---
|
|
|
|
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
|
|
> [!IMPORTANT]
|
|
> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com.
|
|
⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
|
|
|
|
# Halt
|
|
|
|
**Command: `vagrant halt [name|id]`**
|
|
|
|
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.
|
|
|
|
For Linux-based guests, Vagrant will:
|
|
|
|
1. Attempt to detect and use Systemd to execute `systemctl poweroff`; but otherwise,
|
|
2. Fallback to using the `shutdown` command to gracefully
|
|
terminate the machine.
|
|
|
|
Due to the varying nature of operating systems, these executables 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.
|
|
|
|
## Options
|
|
|
|
- `-f` or `--force` - Do not attempt to gracefully shut down the machine.
|
|
This effectively pulls the power on the guest machine.
|