LinuxCommandLibrary

VBoxManage

Manage VirtualBox virtual machines from command line

SYNOPSIS

VBoxManage is structured around a vast array of subcommands. The general syntax is:

VBoxManage [global-options] subcommand [subcommand-options] [arguments]

Examples of subcommands include list, createvm, modifyvm, startvm, controlvm, snapshot, and many more. Each subcommand has its own specific set of options and arguments.

PARAMETERS

--version
    Displays the VirtualBox version and build information.

--help, -h
    Shows the global help message or help for a specific subcommand if followed by the subcommand name.

--verbose, -v
    Increases the verbosity of the output, showing more detailed information.

--debug
    Enables debug output, useful for troubleshooting internal VirtualBox issues.

--nologo
    Suppresses the display of the VirtualBox logo when the command starts.

--nocolor
    Disables colored output, which can be useful in terminals that don't support it well.

(Subcommand Options)
    Beyond these global options, VBoxManage operates through a large number of subcommands (e.g., list, createvm, modifyvm, startvm, snapshot, storageattach). Each subcommand has its own extensive set of specific options and arguments. To see options for a specific subcommand, use VBoxManage <subcommand> --help.

DESCRIPTION

VBoxManage is the command-line interface (CLI) for Oracle VM VirtualBox. It allows users to control virtually every aspect of VirtualBox, from creating, configuring, starting, and stopping virtual machines to managing network interfaces, storage devices, snapshots, and global settings. It's an indispensable tool for automation, scripting, and headless server environments where a graphical user interface is not available or desired. With its extensive array of subcommands and options, VBoxManage provides granular control over the entire VirtualBox ecosystem, making it a powerful utility for both casual users and system administrators.

CAVEATS

Due to its extensive functionality, VBoxManage can be complex to master, requiring familiarity with numerous subcommands and their specific options. While generally cross-platform, some network or storage operations might have subtle differences or dependencies on the host OS. When running VMs headless, ensure proper resource allocation and network configuration as graphical interaction is not possible.

EXTENSIVE SUBCOMMANDS

VBoxManage's power lies in its modular design, with over 50 distinct subcommands covering every aspect of VM management, from basic operations like starting and stopping VMs to advanced features like managing host-only networks, VRDP servers, and storage controllers. Understanding the specific subcommands for your task is key to effective use.

SCRIPTING AND AUTOMATION

Given its command-line nature, VBoxManage is exceptionally well-suited for scripting and automating virtual machine operations. This is particularly valuable in CI/CD pipelines, development environments, and server provisioning scenarios where repeatable and unattended VM management is required.

HISTORY

Oracle VM VirtualBox, originally developed by Innotek GmbH, was first released in 2007. Sun Microsystems acquired Innotek in 2008, and subsequently, Oracle acquired Sun Microsystems in 2010, continuing the development of VirtualBox. VBoxManage has been a core component of VirtualBox since its early versions, providing the essential command-line interface for managing virtual machines and their environments. Its functionality has continuously expanded with each VirtualBox release to support new features and host/guest operating systems, solidifying its role as a crucial tool for automation and server deployments.

SEE ALSO

VBoxSDL(1), VBoxHeadless(1), virsh(1), qemu-system-x86_64(1), vmware(1)

Copied to clipboard