How to use the command 'virtualboxvm' (with examples)

VirtualBox is a powerful open-source virtualization tool that allows users to run multiple operating systems simultaneously on a single hardware machine. The ‘virtualboxvm’ command is specifically designed for managing VirtualBox virtual machines efficiently from the command line. This command offers a range of options for starting virtual machines, managing their state, and controlling their display and device settings. Below, we delve into various use cases associated with the ‘virtualboxvm’ command, each illustrated with practical examples.

Use case 1: Start a virtual machine

Code:

virtualboxvm --startvm name|uuid

Motivation:

Starting a virtual machine from the command line can be extremely useful for system administrators and advanced users who manage multiple VMs across different environments. It provides a fast and scriptable way to launch a VM without needing to interact with the VirtualBox graphical user interface, enhancing workflow efficiency and automating the boot process.

Explanation:

• --startvm: This flag is used to denote that the command is intended to start a virtual machine. It identifies the beginning of a sequence of arguments that pertain to virtual machine startup.
• name|uuid: This specifies the target virtual machine by its assigned name or universally unique identifier (UUID). Every VM in VirtualBox has a unique identifying name or UUID, which the system uses to locate and start the correct VM.

Example Output:

When executed, the machine specified by either its name or UUID will boot, and you should see the OS booting process in a new virtual machine window. There are no direct command line outputs unless there is an error in starting the VM.

Use case 2: Start a virtual machine in fullscreen mode

Code:

virtualboxvm --startvm name|uuid --fullscreen

Motivation:

Running a virtual machine in fullscreen mode simulates the experience of using a separate, standalone computer, providing an immersive user experience. This is particularly beneficial for running operating systems without distractions from other desktop applications or for utilizing a VM interface that matches your display’s resolution.

Explanation:

• --startvm: Starts the virtual machine. This argument is required to specify the action for the VM.
• name|uuid: Identifies the particular virtual machine to start.
• --fullscreen: This flag indicates that the virtual machine window should occupy the entire screen once the VM is started, ensuring no desktop icons or taskbars interfere with the VM session.

Example Output:

Once executed, you’d notice that the virtual machine window opens and automatically maximizes to fill the entire screen. Functionality mirrors that of a fully separate system, offering an extended interface as if the VM operating system is running directly on the hardware.

Use case 3: Mount the specified DVD image file

Code:

virtualboxvm --startvm name|uuid --dvd path\to\image_file

Motivation:

Mounting a DVD image is common in situations where installations or boot-from-disc operations are required, such as installing an operating system or software from an ISO file. Doing so from the command line enables rapid deployment in environments where you might automate installations.

Explanation:

• --startvm: Command to launch the virtual machine.
• name|uuid: Target identifier for which virtual machine to act upon.
• --dvd: This indicates that a DVD image file should be attached to the virtual machine as a virtual DVD drive.
• path\to\image_file: Specifies the full file path to the intended DVD image, often in ISO format, that’s to be mounted within the VM.

Example Output:

Upon execution, the virtual machine specified will start, with the designated image file mounted as a virtual DVD. This facilitates operations such as booting from the image if it’s a bootable ISO, thereby making installation and configuration tasks more seamless.

Use case 4: Display a command-line window with debug information

Code:

virtualboxvm --startvm name|uuid --debug-command-line

Motivation:

Debugging a virtual machine is crucial in development and testing environments to diagnose issues related to VM performance, compatibility, or application behavior. By starting a VM with a debug command-line window, users can gather necessary logs and information in real-time to troubleshoot systematically.

Explanation:

• --startvm: Initiates the starting sequence for the selected virtual machine.
• name|uuid: Designation for VM activation, specified by name or UUID.
• --debug-command-line: This option opens a separate window showing detailed debug information and output that assists in analyzing the VM’s start-up processes.

Example Output:

The command generates a secondary window detailing ongoing diagnostic data, boot sequences, and any potential errors or warnings, empowering users to identify issues as they occur during the VM’s start procedure.

Use case 5: Start a virtual machine in a paused state

Code:

virtualboxvm --startvm name|uuid --start-paused

Motivation:

Starting a virtual machine in a paused state is useful when preparing a VM for inspection or setup before its full activation. For example, in scenarios requiring precise provisioning or checks where immediate resource allocation might be unnecessary, pausing the VM at startup facilitates controlled execution.

Explanation:

• --startvm: Command flag to specify VM initiation.
• name|uuid: Identifies the specific virtual machine set for startup.
• --start-paused: This command option ensures that upon starting, the VM enters a paused state, rather than running immediately, allowing users to manually start the VM when desired.

Example Output:

After running this command, the virtual machine enters a paused state. The VM will appear started within the VirtualBox interface but will not begin executing procedures until manually resumed, offering a strategic hold for user direction.

Conclusion:

Managing VirtualBox virtual machines from the command line with the ‘virtualboxvm’ command empowers users with powerful automation and control over their virtualization environments. Whether you’re looking to streamline VM startups, run in specific modes, mount image files, debug effectively, or prepare machines in a paused state, these command examples provide versatility and functionality for a wide range of scenarios.