[82044] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
| 2 | <!--
|
---|
| 3 | manpage, user manual, usage: VBoxManage createvm
|
---|
[96300] | 4 | -->
|
---|
| 5 | <!--
|
---|
[98103] | 6 | Copyright (C) 2006-2023 Oracle and/or its affiliates.
|
---|
[82044] | 7 |
|
---|
[96407] | 8 | This file is part of VirtualBox base platform packages, as
|
---|
| 9 | available from https://www.virtualbox.org.
|
---|
| 10 |
|
---|
| 11 | This program is free software; you can redistribute it and/or
|
---|
| 12 | modify it under the terms of the GNU General Public License
|
---|
| 13 | as published by the Free Software Foundation, in version 3 of the
|
---|
| 14 | License.
|
---|
| 15 |
|
---|
| 16 | This program is distributed in the hope that it will be useful, but
|
---|
| 17 | WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
| 18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
---|
| 19 | General Public License for more details.
|
---|
| 20 |
|
---|
| 21 | You should have received a copy of the GNU General Public License
|
---|
| 22 | along with this program; if not, see <https://www.gnu.org/licenses>.
|
---|
| 23 |
|
---|
| 24 | SPDX-License-Identifier: GPL-3.0-only
|
---|
[96300] | 25 | -->
|
---|
[82044] | 26 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 27 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
|
---|
| 28 | <!ENTITY % all.entities SYSTEM "all-entities.ent">
|
---|
| 29 | %all.entities;
|
---|
| 30 | ]>
|
---|
| 31 | <refentry id="vboxmanage-createvm" lang="en">
|
---|
| 32 | <refentryinfo>
|
---|
[89923] | 33 | <pubdate>$Date: 2024-02-19 15:27:46 +0000 (Mon, 19 Feb 2024) $</pubdate>
|
---|
[82044] | 34 | <title>VBoxManage createvm</title>
|
---|
| 35 | </refentryinfo>
|
---|
| 36 |
|
---|
| 37 | <refmeta>
|
---|
| 38 | <refentrytitle>VBoxManage-createvm</refentrytitle>
|
---|
| 39 | <manvolnum>1</manvolnum>
|
---|
| 40 | </refmeta>
|
---|
| 41 |
|
---|
| 42 | <refnamediv>
|
---|
| 43 | <refname>VBoxManage-createvm</refname>
|
---|
| 44 | <refpurpose>create a new virtual machine</refpurpose>
|
---|
[93707] | 45 | <refclass>&product-name;</refclass>
|
---|
[82044] | 46 | </refnamediv>
|
---|
| 47 |
|
---|
| 48 | <refsynopsisdiv>
|
---|
| 49 | <cmdsynopsis id="synopsis-vboxmanage-createvm">
|
---|
| 50 | <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
---|
[82057] | 51 | <command>VBoxManage createvm</command>
|
---|
[82044] | 52 | <arg choice="req">--name=<replaceable>name</replaceable></arg>
|
---|
[101120] | 53 | <arg choice="req">--platform-architecture=<group choice="plain">
|
---|
| 54 | <arg choice="plain">x86</arg>
|
---|
| 55 | <arg choice="plain">arm</arg>
|
---|
| 56 | </group></arg>
|
---|
[82044] | 57 | <arg>--basefolder=<replaceable>basefolder</replaceable></arg>
|
---|
| 58 | <arg>--default</arg>
|
---|
[103447] | 59 | <arg>--groups=<replaceable>group-ID</replaceable><arg rep="repeat">,</arg></arg>
|
---|
[82044] | 60 | <arg>--ostype=<replaceable>ostype</replaceable></arg>
|
---|
| 61 | <arg>--register</arg>
|
---|
| 62 | <arg>--uuid=<replaceable>uuid</replaceable></arg>
|
---|
[99176] | 63 | <arg>--cipher=<replaceable>cipher</replaceable></arg>
|
---|
| 64 | <arg>--password-id=<replaceable>password-id</replaceable></arg>
|
---|
| 65 | <arg>--password=<replaceable>file</replaceable></arg>
|
---|
[82044] | 66 | </cmdsynopsis>
|
---|
| 67 | </refsynopsisdiv>
|
---|
| 68 |
|
---|
[99513] | 69 | <refsect1 id="vboxmanage-createvm-description">
|
---|
[82044] | 70 | <title>Description</title>
|
---|
| 71 | <para>
|
---|
| 72 | The <command>VBoxManage createvm</command> command creates a new
|
---|
| 73 | XML virtual machine (VM) definition file.
|
---|
| 74 | </para>
|
---|
| 75 | <para>
|
---|
| 76 | You must specify the name of the VM by using <option>--name
|
---|
| 77 | <replaceable>name</replaceable></option>. This name is used by
|
---|
| 78 | default as the name of the settings file that has the
|
---|
| 79 | <filename>.vbox</filename> extension and the machine folder, which
|
---|
| 80 | is a subfolder of the <filename>$HOME/VirtualBox VMs</filename>
|
---|
| 81 | directory.
|
---|
| 82 | </para>
|
---|
| 83 | <para>
|
---|
[89923] | 84 | The actual file name may not correspond directly to the VM name
|
---|
| 85 | if it violates the host OS file name requirements (such as using
|
---|
| 86 | the path separator or other reserved characters, they will be
|
---|
| 87 | substituted with a placeholder). If you later rename the VM, the
|
---|
| 88 | file and folder names will be updated to match the new name
|
---|
| 89 | automatically.
|
---|
[82044] | 90 | </para>
|
---|
[101120] | 91 | <para>
|
---|
| 92 | Also, the intended platform architecture for the VM must be specified by
|
---|
| 93 | using <option>--platform-architecture<replaceable>architecture</replaceable>
|
---|
| 94 | </option>.
|
---|
| 95 | </para>
|
---|
[82044] | 96 | </refsect1>
|
---|
| 97 |
|
---|
[99513] | 98 | <refsect1 id="vboxmanage-createvm-common-options">
|
---|
[82044] | 99 | <title>Command Options</title>
|
---|
| 100 | <para>
|
---|
[101120] | 101 | In addition to specifying the name or UUID of the VM and the platform architecture, which is
|
---|
[82044] | 102 | required, you can specify any of the following options:
|
---|
| 103 | </para>
|
---|
| 104 | <variablelist>
|
---|
| 105 | <varlistentry>
|
---|
| 106 | <term><option>--basefolder=<replaceable>basefolder</replaceable></option></term>
|
---|
| 107 | <listitem><para>
|
---|
| 108 | Specifies the name of the folder in which to save the
|
---|
| 109 | machine configuration file for the new VM.
|
---|
| 110 | </para><para>
|
---|
| 111 | Note that the names of the file and the folder do not change
|
---|
| 112 | if you rename the VM.
|
---|
| 113 | </para></listitem>
|
---|
| 114 | </varlistentry>
|
---|
| 115 | <varlistentry>
|
---|
| 116 | <term><option>--default</option></term>
|
---|
| 117 | <listitem><para>
|
---|
| 118 | Applies a default hardware configuration for the specified
|
---|
| 119 | guest OS. By default, the VM is created with minimal
|
---|
| 120 | hardware.
|
---|
| 121 | </para></listitem>
|
---|
| 122 | </varlistentry>
|
---|
| 123 | <varlistentry>
|
---|
[103454] | 124 | <term><option>--groups=<replaceable>group-ID</replaceable>[,...]</option></term>
|
---|
[82044] | 125 | <listitem><para>
|
---|
| 126 | Assigns the VM to the specified groups. If you specify more
|
---|
| 127 | than one group, separate each group name with a comma.
|
---|
| 128 | </para><para>
|
---|
| 129 | Note that each group is identified by a group ID that starts
|
---|
| 130 | with a slash character (<literal>/</literal>) so that groups
|
---|
| 131 | can be nested. By default, a VM is always assigned
|
---|
| 132 | membership to the <literal>/</literal> group.
|
---|
| 133 | </para></listitem>
|
---|
| 134 | </varlistentry>
|
---|
| 135 | <varlistentry>
|
---|
| 136 | <term><option>--ostype=<replaceable>ostype</replaceable></option></term>
|
---|
| 137 | <listitem><para>
|
---|
| 138 | Specifies the guest OS to run in the VM. Run the
|
---|
| 139 | <command>VBoxManage list ostypes</command> command to see
|
---|
| 140 | the available OS types.
|
---|
| 141 | </para></listitem>
|
---|
| 142 | </varlistentry>
|
---|
| 143 | <varlistentry>
|
---|
| 144 | <term><option>--register</option></term>
|
---|
| 145 | <listitem><para>
|
---|
| 146 | Registers the VM with your &product-name; installation. By
|
---|
| 147 | default, the <command>VBoxManage createvm</command> command
|
---|
| 148 | creates only the XML configuration for the VM but does not
|
---|
| 149 | register the VM. If you do not register the VM at creation,
|
---|
| 150 | you can run the <command>VBoxManage registervm</command>
|
---|
| 151 | command after you create the VM.
|
---|
| 152 | </para></listitem>
|
---|
| 153 | </varlistentry>
|
---|
| 154 | <varlistentry>
|
---|
| 155 | <term><option>--uuid=<replaceable>uuid</replaceable></option></term>
|
---|
| 156 | <listitem><para>
|
---|
| 157 | Specifies the Universally Unique Identifier (UUID) of the
|
---|
| 158 | VM. Ensure that this UUID is unique within the
|
---|
| 159 | &product-name; namespace of the host or of its VM group
|
---|
| 160 | memberships if you decide to register the VM. By default,
|
---|
[89923] | 161 | &product-name; provides the UUID.
|
---|
[82044] | 162 | </para></listitem>
|
---|
| 163 | </varlistentry>
|
---|
[94660] | 164 | <varlistentry>
|
---|
[99176] | 165 | <term><option>--cipher=<replaceable>cipher</replaceable></option></term>
|
---|
[94660] | 166 | <listitem><para>
|
---|
| 167 | Specifies the cipher to use for encryption. Valid values are
|
---|
| 168 | <literal>AES-128</literal> or
|
---|
| 169 | <literal>AES-256</literal>.
|
---|
| 170 | </para><para>
|
---|
| 171 | This option enables you to set up encryption on VM.
|
---|
| 172 | </para></listitem>
|
---|
| 173 | </varlistentry>
|
---|
| 174 | <varlistentry>
|
---|
[99176] | 175 | <term><option>--password-id=<replaceable>password-id</replaceable></option></term>
|
---|
[94660] | 176 | <listitem><para>
|
---|
| 177 | Specifies a new password identifier that is used for correct
|
---|
| 178 | identification when supplying multiple passwords for the VM.
|
---|
| 179 | </para><para>
|
---|
| 180 | This option enables you to set up encryption on VM.
|
---|
| 181 | </para></listitem>
|
---|
| 182 | </varlistentry>
|
---|
| 183 | <varlistentry>
|
---|
[99176] | 184 | <term><option>--password=<replaceable>file</replaceable></option></term>
|
---|
[94660] | 185 | <listitem><para>
|
---|
| 186 | Use the <option>--password</option> to supply the encryption
|
---|
| 187 | password of the VM. Either specify the absolute pathname of a
|
---|
| 188 | password file on the host operating system, or <literal>-</literal>
|
---|
| 189 | to prompt you for the password on the command line.
|
---|
| 190 | </para><para>
|
---|
| 191 | This option enables you to set up encryption on VM.
|
---|
| 192 | </para></listitem>
|
---|
| 193 | </varlistentry>
|
---|
[82044] | 194 | </variablelist>
|
---|
| 195 | </refsect1>
|
---|
| 196 |
|
---|
[99513] | 197 | <refsect1 id="vboxmanage-createvm-examples">
|
---|
[82044] | 198 | <title>Examples</title>
|
---|
| 199 | <remark role="help-scope" condition="GLOBAL" />
|
---|
| 200 | <para>
|
---|
| 201 | The following command creates a VM called <literal>vm2</literal>
|
---|
| 202 | where you plan to run a 64-bit version of Oracle Linux.
|
---|
| 203 | </para>
|
---|
| 204 | <screen>$ VBoxManage createvm --name "vm2" --ostype "Oracle_64"</screen>
|
---|
| 205 | <para>
|
---|
| 206 | The following command creates and registers a VM called
|
---|
| 207 | <literal>vm3</literal>.
|
---|
| 208 | </para>
|
---|
| 209 | <screen>$ VBoxManage createvm --name "vm3" --register</screen>
|
---|
| 210 | </refsect1>
|
---|
| 211 |
|
---|
[99513] | 212 | <refsect1 id="vboxmanage-createvm-see-also">
|
---|
[82044] | 213 | <title>See Also</title>
|
---|
| 214 | <para>
|
---|
| 215 | <xref linkend="vboxmanage-list" />,
|
---|
| 216 | <xref linkend="vboxmanage-registervm" />
|
---|
| 217 | </para>
|
---|
| 218 | </refsect1>
|
---|
| 219 | </refentry>
|
---|