vboxmanage: update page; vboxmanage-{controlvm, extpack, list, showvminfo, startvm}: add page (#11667)

* vboxmanage: update page; vboxmanage-{controlvm, extpack, list, showvminfo, startvm}: add page

---------

Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
Co-authored-by: Juri Dispan <juri.dispan@posteo.net>
Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>

pages/common/vboxmanage-controlvm.md

@@ -0,0 +1,36 @@
+# vboxmanage-controlvm
+
+> Change the state and the settings of a currently running virtual machine.
+> More information: <https://www.virtualbox.org/manual/ch08.html#vboxmanage-controlvm>.
+
+- Temporarily stop the execution of a virtual machine:
+
+`VBoxManage controlvm {{uuid|vm_name}} pause`
+
+- Resume the execution of a paused virtual machine:
+
+`VBoxManage controlvm {{uuid|vm_name}} resume`
+
+- Perform a cold reset on the virtual machine:
+
+`VBoxManage controlvm {{uuid|vm_name}} reset`
+
+- Poweroff a virtual machine with the same effect as pulling the power cable of a computer:
+
+`VBoxManage controlvm {{uuid|vm_name}} poweroff`
+
+- Shutdown the virtual machine and save its current state:
+
+`VBoxManage controlvm {{uuid|vm_name}} savestate`
+
+- Send an ACPI (Advanced Configuration and Power Interface) shutdown signal to the virtual machine:
+
+`VBoxManage controlvm {{uuid|vm_name}} acpipowerbutton`
+
+- Send command to reboot itself to the guest OS:
+
+`VBoxManage controlvm {{uuid|vm_name}} reboot`
+
+- Shutdown down the virtual machine without saving its state:
+
+`VBoxManage controlvm {{uuid|vm_name}} shutdown`

pages/common/vboxmanage-extpack.md

@@ -0,0 +1,24 @@
+# vboxmanage-extpack
+
+> Manage extension packs for Oracle VirtualBox.
+> More information: <https://www.virtualbox.org/manual/ch08.html#vboxmanage-extpack>.
+
+- Install extension packs to VirtualBox (Note: you need to remove the existing version of the extension pack before installing a new version.):
+
+`VBoxManage extpack install {{path/to/file.vbox-extpack}}`
+
+- Remove the existing version of the VirtualBox extension pack:
+
+`VBoxManage extpack install --replace`
+
+- Uninstall extension packs from VirtualBox:
+
+`VBoxManage extpack uninstall {{extension_pack_name}}`
+
+- Uninstall extension packs and skip most uninstallation refusals:
+
+`VBoxManage extpack uninstall --force {{extension_pack_name}}`
+
+- Clean up temporary files and directories left by extension packs:
+
+`VBoxManage extpack cleanup`

pages/common/vboxmanage-list.md

@@ -0,0 +1,36 @@
+# vboxmanage-list
+
+> List information about the Oracle VM VirtualBox software and associated service.
+> More information: <https://www.virtualbox.org/manual/ch08.html#vboxmanage-list>.
+
+- List all VirtualBox virtual machines:
+
+`VBoxManage list vms`
+
+- Show DHCP servers available on the host system:
+
+`VBoxManage list dhcpservers`
+
+- Show Oracle VM VirtualBox extension packs currently installed:
+
+`VBoxManage list extpacks`
+
+- Show all virtual machine groups:
+
+`VBoxManage list groups`
+
+- Show virtual disk settings that are currently in use by VirtualBox:
+
+`VBoxManage list hdds`
+
+- Show host-only network interfaces available on host system:
+
+`VBoxManage list hostonlyifs`
+
+- Show the list of currently running virtual machines:
+
+`VBoxManage list runningvms`
+
+- Show host system information:
+
+`VBoxManage list hostinfo`

pages/common/vboxmanage-showvminfo.md

@@ -0,0 +1,28 @@
+# vboxmanage-showvminfo
+
+> Show information about registered virtual machine.
+> More information: <https://www.virtualbox.org/manual/ch08.html#vboxmanage-showvminfo>.
+
+- Show information about a particular virtual machine:
+
+`VBoxManage showvminfo {{vm_name|uuid}}`
+
+- Show more detailed information about a particular virtual machine:
+
+`VBoxManage showvminfo --details {{vm_name|uuid}}`
+
+- Show information in a machine readable format:
+
+`VBoxManage showvminfo --machinereadable {{vm_name|uuid}}`
+
+- Specify password ID if the virtual machine is encrypted:
+
+`VBoxManage showvminfo --password-id {{password_id}} {{vm_name|uuid}}`
+
+- Specify the password file if the virtual machine is encrypted:
+
+`VBoxManage showvminfo --password {{path/to/password_file}} {{vm_name|uuid}}`
+
+- Show the logs of a specific virtual machine:
+
+`VBoxManage showvminfo --log {{vm_name|uuid}}`

pages/common/vboxmanage-startvm.md

@@ -0,0 +1,24 @@
+# vboxmanage-startvm
+
+> Start a virtual machine.
+> More information: <https://www.virtualbox.org/manual/ch08.html#vboxmanage-startvm>.
+
+- Start a virtual machine:
+
+`VBoxManage startvm {{vm_name|uuid}}`
+
+- Start a virtual machine with the specified UI mode:
+
+`VBoxManage startvm {{vm_name|uuid}} --type {{headless|gui|sdl|separate}}`
+
+- Specify a password file to start an encrypted virtual machine:
+
+`VBoxManage startvm {{vm_name|uuid}} --password {{path/to/password_file}}`
+
+- Specify a password ID to start an encrypted virtual machine:
+
+`VBoxManage startvm  {{vm_name|uuid}} --password-id {{password_id}}`
+
+- Start a virtual machine with an environment variable pair name value:
+
+`VBoxManage startvm  {{vm_name|uuid}} --put-env={{name}}={{value}}`

pages/common/vboxmanage.md

@@ -2,32 +2,21 @@
 
 > Command-line interface to VirtualBox.
 > Includes all the functionality of the GUI and more.
+> Some subcommands such as `vboxmanage startvm` have their own usage documentation.
 > More information: <https://www.virtualbox.org/manual/ch08.html#vboxmanage-intro>.
 
-- List all VirtualBox virtual machines:
+- Display version:
 
-`VBoxManage list vms`
+`VBoxManage --version`
 
-- Show information about a particular virtual machine:
+- Display help:
 
-`VBoxManage showvminfo {{name|uuid}}`
+`VBoxManage --help`
 
-- Start a virtual machine:
+- Display help for a VBoxManage subcommand (like `starvm`, `clonevm`, `import`, `export`, etc.):
 
-`VBoxManage startvm {{name|uuid}}`
+`VBoxManage --help {{subcommand}}`
 
-- Start a virtual machine in headless mode:
+- Execute a VboxManage subcommand:
 
-`VBoxManage startvm {{name|uuid}} --type headless`
-
-- Shutdown the virtual machine and save its current state:
-
-`VBoxManage controlvm {{name|uuid}} savestate`
-
-- Shutdown down the virtual machine without saving its state:
-
-`VBoxManage controlvm {{name|uuid}} poweroff`
-
-- Update VBox extension packs:
-
-`VBoxManage extpack install --replace {{VboxExtensionPackFileName}}`
+`VBoxManage {{subcommand}}`