1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
manpage, user manual, usage: VBoxManage createvm
Copyright (C) 2006-2020 Oracle Corporation
This file is part of VirtualBox Open Source Edition (OSE), as
available from http://www.virtualbox.org. This file is free software;
you can redistribute it and/or modify it under the terms of the GNU
General Public License (GPL) as published by the Free Software
Foundation, in version 2 as it comes in the "COPYING" file of the
VirtualBox OSE distribution. VirtualBox OSE is distributed in the
hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
<!ENTITY % all.entities SYSTEM "all-entities.ent">
%all.entities;
]>
<refentry id="vboxmanage-createvm" lang="en">
<refentryinfo>
<pubdate>August 2019</pubdate>
<title>VBoxManage createvm</title>
</refentryinfo>
<refmeta>
<refentrytitle>VBoxManage-createvm</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>VBoxManage-createvm</refname>
<refpurpose>create a new virtual machine</refpurpose>
<refclass>Oracle VM VirtualBox</refclass>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis id="synopsis-vboxmanage-createvm">
<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
<command>VBoxManage createvm</command>
<arg choice="req">--name=<replaceable>name</replaceable></arg>
<arg>--basefolder=<replaceable>basefolder</replaceable></arg>
<arg>--default</arg>
<arg>--group=<replaceable>group-ID</replaceable>, ...</arg>
<arg>--ostype=<replaceable>ostype</replaceable></arg>
<arg>--register</arg>
<arg>--uuid=<replaceable>uuid</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
The <command>VBoxManage createvm</command> command creates a new
XML virtual machine (VM) definition file.
</para>
<para>
You must specify the name of the VM by using <option>--name
<replaceable>name</replaceable></option>. This name is used by
default as the name of the settings file that has the
<filename>.vbox</filename> extension and the machine folder, which
is a subfolder of the <filename>$HOME/VirtualBox VMs</filename>
directory.
</para>
<para>
Ensure that the VM name conforms to the host OS file name
requirements. If you later rename the VM, the file and folder
names will be updated to match the new name automatically.
</para>
</refsect1>
<refsect1>
<title>Command Options</title>
<para>
In addition to specifying the name or UUID of the VM, which is
required, you can specify any of the following options:
</para>
<variablelist>
<varlistentry>
<term><option>--basefolder=<replaceable>basefolder</replaceable></option></term>
<listitem><para>
Specifies the name of the folder in which to save the
machine configuration file for the new VM.
</para><para>
Note that the names of the file and the folder do not change
if you rename the VM.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--default</option></term>
<listitem><para>
Applies a default hardware configuration for the specified
guest OS. By default, the VM is created with minimal
hardware.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--group=<replaceable>group-ID</replaceable>, ...</option></term>
<listitem><para>
Assigns the VM to the specified groups. If you specify more
than one group, separate each group name with a comma.
</para><para>
Note that each group is identified by a group ID that starts
with a slash character (<literal>/</literal>) so that groups
can be nested. By default, a VM is always assigned
membership to the <literal>/</literal> group.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--ostype=<replaceable>ostype</replaceable></option></term>
<listitem><para>
Specifies the guest OS to run in the VM. Run the
<command>VBoxManage list ostypes</command> command to see
the available OS types.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--register</option></term>
<listitem><para>
Registers the VM with your &product-name; installation. By
default, the <command>VBoxManage createvm</command> command
creates only the XML configuration for the VM but does not
register the VM. If you do not register the VM at creation,
you can run the <command>VBoxManage registervm</command>
command after you create the VM.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--uuid=<replaceable>uuid</replaceable></option></term>
<listitem><para>
Specifies the Universally Unique Identifier (UUID) of the
VM. Ensure that this UUID is unique within the
&product-name; namespace of the host or of its VM group
memberships if you decide to register the VM. By default,
&product-name; command provides the UUID.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<remark role="help-scope" condition="GLOBAL" />
<para>
The following command creates a VM called <literal>vm2</literal>
where you plan to run a 64-bit version of Oracle Linux.
</para>
<screen>$ VBoxManage createvm --name "vm2" --ostype "Oracle_64"</screen>
<para>
The following command creates and registers a VM called
<literal>vm3</literal>.
</para>
<screen>$ VBoxManage createvm --name "vm3" --register</screen>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<xref linkend="vboxmanage-list" />,
<xref linkend="vboxmanage-registervm" />
</para>
</refsect1>
</refentry>
|
