Commands (CLI)

This page lists all the supported Vagrant commands which depend on the UTM provider. Eg. up, suspend, resume, halt.

Adds note to the command which are have some limitations. Eg. snapshot.

The Vagrant commands that do not depend on provider are not listed and will continue to work. Eg. global-status

Table of contents

  1. Box
  2. Destroy
  3. Halt
  4. Package
  5. Port
  6. Provision
  7. Reload
  8. Resume
  9. Snapshot
  10. SSH
  11. SSH Config
  12. Status
  13. Suspend
  14. Up
  15. Upload
  16. Custom Commands
    1. IP Address
    2. Disposable

Box

Command: vagrant box

UTM provider uses .utm file as VM bundle and supports box operations.

Destroy

Command: vagrant destroy [name|id]

utmctl delete

Halt

Command: vagrant halt [name|id]

utmctl stop

Package

Command: vagrant package [name|id]

UTM ‘Share’ / export

Port

Command: vagrant port [name|id]

The port command displays the full list of guest ports mapped to the host machine ports:

Provision

Command: vagrant provision [vm-name]

Runs any configured provisioners against the running Vagrant managed machine

Reload

Command: vagrant reload [name|id]

The equivalent of running a halt followed by an up.

Resume

Command: vagrant resume [name|id]

This resumes a Vagrant managed machine that was previously suspended, perhaps with the suspend command.

utmctl start

Snapshot

Command: vagrant snapshot

Snapshot feature is not available in UTM. The plugin just provides experimental feature using qemu-img

Vagrant UTM provider supports offline snapshots using qemu-img. Hence only VM with single qcow2 file is supported.

SSH

Command: vagrant ssh [name|id] [-- extra_ssh_args]

SSH Config

Command: vagrant ssh-config [name|id]

Status

Command: vagrant status [name|id]

utmctl status

Suspend

Command: vagrant suspend [name|id]

utmctl suspend

Up

Command: vagrant up [name|id]

Import VM (if not created)

utmctl start

Upload

Command: vagrant upload source [destination] [name|id]

Custom Commands

These are the commands not available in vagrant but specific to UTM provider.

IP Address

Command: vagrant ip-address [name|id]

utmctl ip-address

List all IP addresses associated with network interfaces on the guest.

Disposable

Command: vagrant disposable [name|id]

utmctl start --disposable

Start virtual machine in disposable mode, which allows you to run a virtual machine without saving any persistent changes to the drive.

Read about Disposable mode in UTM docs