VirtualBox

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-createvm.xml@ 90279

Last change on this file since 90279 was 89923, checked in by vboxsync, 3 years ago

doc/man_VBoxManage-*.xml: Made 4 man pages ready for use in the manual. Eliminated some inaccuracies and improved the accuracy of some descriptions. Most was perfectly true over 10 years ago but the functionality today was not covered.

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette