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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
manpage, user manual, usage: VBoxHeadless
-->
<!--
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="man_vboxheadless" lang="en">
<refentryinfo>
<pubdate>August 2019</pubdate>
<title>VBoxHeadless</title>
</refentryinfo>
<refmeta>
<refentrytitle>VBoxHeadless</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>VBoxHeadless</refname>
<refpurpose>&product-name; remote desktop server</refpurpose>
<refclass>&product-name;</refclass>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis id="synopsis-vboxmanage-vboxheadless">
<command>VBoxHeadless</command>
<arg>--startvm=<group choice="req">
<arg choice="plain"><replaceable>uuid</replaceable></arg>
<arg choice="plain"><replaceable>vmname</replaceable></arg>
</group></arg>
<arg>--vrde=<group choice="plain">
<arg choice="plain">on</arg>
<arg choice="plain">off</arg>
<arg choice="plain">config</arg>
</group></arg>
<arg>--vrdeproperty=<replaceable>prop-name</replaceable>=<arg><replaceable>prop-value</replaceable></arg></arg>
<arg>--settingspw=<replaceable>password</replaceable></arg>
<arg>--settingspwfile=<replaceable>password-file</replaceable></arg>
<arg>--start-paused</arg>
<arg>--capture</arg>
<arg>--width=<replaceable>width</replaceable></arg>
<arg>--height=<replaceable>height</replaceable></arg>
<arg>--bitrate=<replaceable>bit-rate</replaceable></arg>
<arg>--filename=<replaceable>filename</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="man_vboxheadless-description">
<title>Description</title>
<para>
The <command>VBoxHeadless</command> command is an alternate front
end that enables you to remotely manage virtual machines (VMs).
The front end is a CLI rather than the VirtualBox Manager
graphical user interface (GUI).
</para>
<para>
For information about using this command, see
<xref linkend="vboxheadless" />.
</para>
<refsect2 id="man_vboxmanage-vboxheadless-command-options">
<title>Command Options</title>
<variablelist>
<varlistentry>
<term><option>--startvm=<replaceable>uuid</replaceable> | <replaceable>vmname</replaceable></option></term>
<listitem><para>
Specifies the Universally Unique Identifier (UUID) or name
of the VM to start.
</para><para>
Use the <command>VBoxManage list vms</command> command to
obtain VM information.
</para><para>
The short versions of this option is <option>-s</option>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--vrde=on | off | config</option></term>
<listitem><para>
Specifies how to use the VRDP server. The default value is
<literal>config</literal>. Valid values are as follows:
</para><itemizedlist>
<listitem><para>
<literal>on</literal> enables the VRDP server.
</para><screen>VBoxHeadless --startvm=<replaceable>vmname</replaceable> --vrde=on</screen></listitem>
<listitem><para>
<literal>off</literal> disables the VRDP server.
</para><screen>VBoxHeadless --startvm=<replaceable>vmname</replaceable> --vrde=off</screen></listitem>
<listitem><para>
<literal>config</literal> enables the VRDP server
depending on the VM configuration.
</para><screen>VBoxHeadless --startvm=<replaceable>vmname</replaceable> --vrde=config</screen></listitem>
</itemizedlist><para>
The short version of this option is <option>-v</option>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--vrdeproperty=<replaceable>prop-name</replaceable>=[<replaceable>prop-value</replaceable>]</option></term>
<listitem><para>
Specifies a value for one of the following properties:
</para><itemizedlist>
<listitem><para>
The <literal>TCP/Ports</literal> property value is a
comma-separated list of ports to which the VRDE server
can bind. Use a hyphen (<literal>-</literal>) between
two port numbers to specify a range of ports.
</para></listitem>
<listitem><para>
The <literal>TCP/Address</literal> property value is
the interface IP address to which to bind the VRDE
server.
</para></listitem>
</itemizedlist></listitem>
</varlistentry>
<varlistentry>
<term><option>--settingspw=<replaceable>password</replaceable></option></term>
<listitem><para>
Specifies a settings password to access encrypted
settings. If you do not specify the password on the
command line, <command>VBoxHeadless</command> prompts you
for the password.
</para><remark>
This design does not conform to Oracle's security
guidelines. You should not be able to specify a password
on the command line because the password can be seen in a
process listing.
</remark></listitem>
</varlistentry>
<varlistentry>
<term><option>--settingspwfile=<replaceable>password-file</replaceable></option></term>
<listitem><para>
Specifies the file that contains the settings password.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--start-paused</option></term>
<listitem><para>
Starts the specified VM in the paused state.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--capture</option></term>
<listitem><para>
Records the VM screen output to a file. In addition to
this option, you must use the <option>--filename</option>
option to specify the name of the file.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--width=<replaceable>width</replaceable></option></term>
<listitem><para>
Specifies the frame width of the recording in pixels. This
option is associated with the <option>--capture</option>
option.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--height=<replaceable>height</replaceable></option></term>
<listitem><para>
Specifies the frame height of the recording in pixels.
This option is associated with the
<option>--capture</option> option.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--bitrate=<replaceable>bit-rate</replaceable></option></term>
<listitem><para>
Specifies the bit rate of the recording in kilobits per
second. This option is associated with the
<option>--capture</option> option.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--filename=<replaceable>filename</replaceable></option></term>
<listitem><para>
Specifies the name of the file in which to store the
recording. The codec used is based on the file extension
that you choose. You must specify this option if you use
the <option>--capture</option> option.
</para><remark>
Where can we get information about the file extensions
that are supported?
</remark></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1 id="man_vboxheadless-examples">
<title>Examples</title>
<remark role="help-scope" condition="GLOBAL"/>
<para>
The following command starts the <literal>ol7u4</literal> VM:
</para>
<screen>$ VBoxHeadless --startvm "ol7u4"</screen>
<para>
The following command starts the <literal>ol7u6</literal> VM in
the Paused state.
</para>
<screen>$ VBoxHeadless --startvm "ol7u6" --start-paused</screen>
<para>
The following command starts the <literal>ol7u6</literal> VM and
records the session. The recording is saved to the
<filename>ol7u6-recording</filename> WebM file.
</para>
<screen>$ VBoxHeadless --startvm "ol7u6" --capture --filename ol7u6-recording.webm</screen>
</refsect1>
<refsect1 id="man_vboxheadless-see-also">
<title>See Also</title>
<para>
<xref linkend="vboxmanage-list" />,
<xref linkend="vboxmanage-startvm" />
</para>
</refsect1>
</refentry>
|
