From 218768cb403abeee48212a2e577f2f0e9757acd9 Mon Sep 17 00:00:00 2001 From: Jacques Hogge <75214556+HOIg3r@users.noreply.github.com> Date: Wed, 29 Nov 2023 22:46:27 +0100 Subject: [PATCH] vboxmanage-*: add page (#11598) * VBoxManage-unregistervm : create & write markdown * VBoxManage-clonevm : create & write markdown * VBoxManage-createvm : create & write markdown * VBoxManage-export : create & write markdown * VBoxManage-import : create & write markdown * VBoxManage-registervm : create & write markdown * VBoxManage-registervm : add Title * VBoxManage-unregistervm : add Title * vboxmamange : correct typo * Update pages/common/vboxmanage-clonevm.md Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com> * vboxmamange-* : rewrite to infinitive tense + change name exemple * vboxmamange-* : change name exemple * vboxmamange-* : add colon + add empty line * Update pages/common/vboxmanage-import.md Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com> * Update pages/common/vboxmanage-import.md Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com> * Update pages/common/vboxmanage-import.md Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com> * Update pages/common/vboxmanage-import.md Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com> * Update pages/common/vboxmanage-import.md Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com> * vboxmanage-createvm : fix typo * vboxmanage-export/import/clonevm : fix typo * Update pages/common/vboxmanage-clonevm.md Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com> * vboxmanage-registervm/createVM/cloneVM : correct password option error + correct typo * VBoxManage-export : correct page * vboxmanage-createvm : correct typo ostype * vboxmanage-* : fix typo * Update vboxmanage-registervm.md --------- Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com> --- pages/common/vboxmanage-clonevm.md | 20 ++++++++++++++ pages/common/vboxmanage-createvm.md | 32 ++++++++++++++++++++++ pages/common/vboxmanage-export.md | 24 +++++++++++++++++ pages/common/vboxmanage-import.md | 36 +++++++++++++++++++++++++ pages/common/vboxmanage-registervm.md | 16 +++++++++++ pages/common/vboxmanage-unregistervm.md | 16 +++++++++++ 6 files changed, 144 insertions(+) create mode 100644 pages/common/vboxmanage-clonevm.md create mode 100644 pages/common/vboxmanage-createvm.md create mode 100644 pages/common/vboxmanage-export.md create mode 100644 pages/common/vboxmanage-import.md create mode 100644 pages/common/vboxmanage-registervm.md create mode 100644 pages/common/vboxmanage-unregistervm.md diff --git a/pages/common/vboxmanage-clonevm.md b/pages/common/vboxmanage-clonevm.md new file mode 100644 index 000000000..7c1f60947 --- /dev/null +++ b/pages/common/vboxmanage-clonevm.md @@ -0,0 +1,20 @@ +# vboxmanage-clonevm + +> Creates a clone of an existing virtual machine (VM). +> More information: . + +- Clone the specified VM: + +`VBoxManage clonevm {{vm_name}}` + +- Specify a new name for the new VM: + +`VBoxManage clonevm {{vm_name}} --name {{new_vm_name}}` + +- Indicate the folder where the new VM configuration is saved: + +`VBoxManage clonevm {{vm_name}} --basefolder {{path/to/directory}}` + +- Store the cloned VM in VirtualBox: + +`VBoxManage clonevm {{vm_name}} --register` diff --git a/pages/common/vboxmanage-createvm.md b/pages/common/vboxmanage-createvm.md new file mode 100644 index 000000000..d038ff632 --- /dev/null +++ b/pages/common/vboxmanage-createvm.md @@ -0,0 +1,32 @@ +# vboxmanage-createvm + +> Create a new virtual machine. +> More information: . + +- Create a new VM with default settings: + +`VBoxManage createvm --name {{vm_name}}` + +- Set the base folder where the VM configuration will be stored: + +`VBoxManage createvm --name {{vm_name}} --basefolder {{path/to/directory}}` + +- Set the guest OS type (one of `VBoxManage list ostypes`) for the imported VM: + +`VBoxManage createvm --name {{vm_name}} --ostype {{ostype}}` + +- Register the created VM in VirtualBox: + +`VBoxManage createvm --name {{vm_name}} --register` + +- Set the VM to the specified groups: + +`VBoxManage createvm --name {{vm_name}} --group {{group1,group2,...}}` + +- Set the Universally Unique Identifier (UUID) of the VM: + +`VBoxManage createvm --name {{vm_name}} --uuid {{uuid}}` + +- Set the cipher to use for encryption: + +`VBoxManage createvm --name {{vm_name}} --cipher {{AES-128|AES-256}}` diff --git a/pages/common/vboxmanage-export.md b/pages/common/vboxmanage-export.md new file mode 100644 index 000000000..a220a1d11 --- /dev/null +++ b/pages/common/vboxmanage-export.md @@ -0,0 +1,24 @@ +# vboxmanage-export + +> Export virtual machines to a virtual appliance (ISO) or a cloud service. +> More information: . + +- Specify the target OVF file: + +`VBoxManage export --output {{path/to/filename.ova}}` + +- Export in OVF 0.9 legacy mode: + +`VBoxManage export --legacy09` + +- Export in OVF (0.9|1.0|2.0) format: + +`VBoxManage export --{{ovf09|ovf10|ovf20}}` + +- Create manifest of the exported files: + +`VBoxManage export --manifest` + +- Specify description to the VM: + +`VBoxManage export --description "{{description-info}}"` diff --git a/pages/common/vboxmanage-import.md b/pages/common/vboxmanage-import.md new file mode 100644 index 000000000..95baf9ce4 --- /dev/null +++ b/pages/common/vboxmanage-import.md @@ -0,0 +1,36 @@ +# vboxmanage-import + +> Imports a virtual machine (VM) previously exported or created. +> More information: . + +- Import a VM from an OVF or OVA file: + +`VBoxManage import {{path/to/file.ovf}}` + +- Set the name of the imported VM: + +`VBoxManage import {{path/to/file.ovf}} --name {{vm_name}}` + +- Indicate the folder where the configuration of the imported VM will be stored: + +`VBoxManage import {{path/to/file.ovf}} --basefolder {{path/to/directory}}` + +- Register the imported VM in VirtualBox: + +`VBoxManage import {{path/to/file.ovf}} --register` + +- Perform a dry run to check the import without actually importing: + +`VBoxManage import {{path/to/file.ovf}} --dry-run` + +- Set the guest OS type (one of `VBoxManage list ostypes`) for the imported VM: + +`VBoxManage import {{path/to/file.ovf}} --ostype={{ostype}}` + +- Set the memory (in megabytes) for the imported VM: + +`VBoxManage import {{path/to/file.ovf}} --memory={{1}}` + +- Set the number of CPUs for the imported VM: + +`VBoxManage import {{path/to/file.ovf}} --cpus={{1}}` diff --git a/pages/common/vboxmanage-registervm.md b/pages/common/vboxmanage-registervm.md new file mode 100644 index 000000000..5ec2f3b09 --- /dev/null +++ b/pages/common/vboxmanage-registervm.md @@ -0,0 +1,16 @@ +# vboxmanage-registervm + +> Register a virtual machine (VM). +> More information: . + +- Register an existing VM: + +`VBoxManage registervm {{path/to/filename.vbox}}` + +- Supply the encryption password file of the VM: + +`VBoxManage registervm {{path/to/filename.vbox}} --password {{path/to/password_file}}` + +- Prompt for the encryption password on the command line: + +`VBoxManage registervm {{path/to/filename.vbox}} --password -` diff --git a/pages/common/vboxmanage-unregistervm.md b/pages/common/vboxmanage-unregistervm.md new file mode 100644 index 000000000..d65287d79 --- /dev/null +++ b/pages/common/vboxmanage-unregistervm.md @@ -0,0 +1,16 @@ +# vboxmanage-unregistervm + +> Unregister a virtual machine (VM). +> More information: . + +- Unregister an existing VM: + +`VBoxManage unregistervm {{uuid|vm_name}}` + +- Delete hard disk image files, all saved state files, VM logs, XML VM machine files: + +`VBoxManage unregistervm {{uuid|vm_name}} --delete` + +- Delete all files from the VM: + +`VBoxManage unregistervm {{uuid|vm_name}} --delete-all`