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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
manpage, user manual, usage: VBoxManage startvm
-->
<!--
Copyright (C) 2006-2024 Oracle and/or its affiliates.
This file is part of VirtualBox base platform packages, as
available from https://www.virtualbox.org.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation, in version 3 of the
License.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, see <https://www.gnu.org/licenses>.
SPDX-License-Identifier: GPL-3.0-only
-->
<!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-startvm" lang="en">
<refentryinfo>
<pubdate>$Date: 2024-09-16 16:03:52 +0200 (Mon, 16 Sep 2024) $</pubdate>
<title>VBoxManage startvm</title>
</refentryinfo>
<refmeta>
<refentrytitle>VBoxManage-startvm</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>VBoxManage-startvm</refname>
<refpurpose>start a virtual machine</refpurpose>
<refclass>&product-name;</refclass>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis id="synopsis-vboxmanage-startvm">
<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
<command>VBoxManage startvm</command>
<arg>--putenv=<replaceable>name</replaceable>[=<replaceable>value</replaceable>]</arg>
<arg role="compact">--type=<group choice="req">
<arg choice="plain">gui</arg>
<arg choice="plain">headless</arg>
<arg choice="plain">sdl</arg>
<arg choice="plain">separate</arg>
</group></arg>
<arg>--password=<replaceable>file</replaceable></arg>
<arg>--password-id=<replaceable>password-identifier</replaceable></arg>
<group choice="req" rep="repeat">
<arg choice="plain"><replaceable>uuid</replaceable></arg>
<arg choice="plain"><replaceable>vmname</replaceable></arg>
</group>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="vboxmanage-startvm-description">
<title>Description</title>
<para>
The <command>VBoxManage startvm</command> command starts an
&product-name; virtual machine (VM) that is in the Powered Off or
Saved state.
</para>
<variablelist>
<varlistentry>
<term><option><replaceable>uuid</replaceable> | <replaceable>vmname</replaceable></option></term>
<listitem><para>
Specifies the name or Universally Unique Identifier (UUID)
of the VM.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--putenv=<replaceable>name</replaceable>=<replaceable>value</replaceable></option></term>
<listitem><para>
Assigns a value to an environment variable as a name-value
pair. For example, VBOX_DISABLE_HOST_DISK_CACHE=1.
</para><para>
The short form of this option is <option>-E</option>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--type=gui | headless | sdl | separate</option></term>
<listitem><para>
Specifies the frontend used to start the VM.
</para><para>
You can use the <command>VBoxManage setproperty</command>
command to set a global default value for the frontend.
Alternatively, you can use the <command>VBoxManage
modifyvm</command> command to specify a default frontend
value for a specific VM. If neither a global or per-VM
default value is set and you do not specify the
<option>--type</option> option, then the VM opens in a
window on the host desktop.
</para><para>
The <option>--type</option> option accepts the following
values:
</para><variablelist>
<varlistentry>
<term><literal>gui</literal></term>
<listitem><para>
Starts a VM in a graphical user interface (GUI)
window. This is the default.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>headless</literal></term>
<listitem><para>
Starts a VM for remote display only.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>sdl</literal></term>
<listitem><para>
Starts a VM using the VBoxSDL frontend.
</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>separate</literal></term>
<listitem><para>
Starts a VM with a detachable user interface (UI),
which means that the VM runs headless with the UI in a
separate process.
</para><para>
This is an experimental feature that lacks certain
functionality, such as 3D acceleration.
</para></listitem>
</varlistentry>
</variablelist></listitem>
</varlistentry>
<varlistentry>
<term><option>--password</option></term>
<listitem>
<para>
Use the <option>--password</option> to supply the encryption
password. Either specify the absolute pathname of a password file
on the host operating system, or <literal>-</literal> to prompt
you for the password on the command line.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--password-id</option></term>
<listitem>
<para>
Use the <option>--password-id</option> option to specify the
id the password is supplied for.
</para>
</listitem>
</varlistentry>
</variablelist>
<note>
<para>
If a VM fails to start with a particular frontend and the error
information is inconclusive, consider starting the VM directly
by running the frontend. This workaround might provide
additional error information.
</para>
</note>
</refsect1>
<refsect1 id="vboxmanage-startvm-examples">
<title>Examples</title>
<remark role="help-scope" condition="GLOBAL" />
<para>
The following command starts the <literal>ol7u6</literal> VM:
</para>
<screen>$ VBoxManage startvm ol7u6</screen>
<para>
The following command starts the
<literal>ol7u6-mininstall</literal> VM in headless mode.
</para>
<screen>$ VBoxManage startvm ol7u6-mininstall --type headless</screen>
</refsect1>
<refsect1 id="vboxmanage-startvm-see-also">
<title>See Also</title>
<para>
<!--<xref linkend="vboxmanage-vboxheadless" />-->
<xref linkend="vboxheadless" />,
<xref linkend="vboxmanage-setproperty" />,
<xref linkend="vboxmanage-modifyvm" />.
</para>
</refsect1>
</refentry>
|
