VirtualBox

source: vbox/trunk/doc/manual/en_US/man_VBoxHeadless.xml@ 85683

Last change on this file since 85683 was 82969, checked in by vboxsync, 5 years ago

Copyright year updates - manual ones.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 9.6 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxHeadless
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="man_vboxheadless" lang="en">
21 <refentryinfo>
22 <pubdate>August 2019</pubdate>
23 <title>VBoxHeadless</title>
24 </refentryinfo>
25
26 <refmeta>
27 <refentrytitle>VBoxHeadless</refentrytitle>
28 <manvolnum>1</manvolnum>
29 </refmeta>
30
31 <refnamediv>
32 <refname>VBoxHeadless</refname>
33 <refpurpose>&product-name; remote desktop server</refpurpose>
34 <refclass>Oracle VM VirtualBox</refclass>
35 </refnamediv>
36
37 <refsynopsisdiv>
38 <cmdsynopsis id="synopsis-vboxmanage-vboxheadless">
39 <command>VBoxHeadless</command>
40 <arg>--startvm=<group>
41 <arg choice="plain"><replaceable>uuid</replaceable></arg>
42 <arg choice="plain"><replaceable>vmname</replaceable></arg>
43 </group></arg>
44 <arg>--vrde=<group choice="plain">
45 <arg choice="plain">on</arg>
46 <arg choice="plain">off</arg>
47 <arg choice="plain">config</arg>
48 </group></arg>
49 <arg>--vrdeproperty=<replaceable>prop-name</replaceable>=[<replaceable>prop-value</replaceable>]</arg>
50 <arg>--settingspw=[<replaceable>password</replaceable>]</arg>
51 <arg>--settingspwfile=<replaceable>password-file</replaceable></arg>
52 <arg>--start-paused=<replaceable>vmname</replaceable></arg>
53 <arg>--capture</arg>
54 <arg>--width=<replaceable>width</replaceable></arg>
55 <arg>--height=<replaceable>height</replaceable></arg>
56 <arg>--bitrate=<replaceable>bit-rate</replaceable></arg>
57 <arg>--filename=<replaceable>filename</replaceable></arg>
58 </cmdsynopsis>
59 </refsynopsisdiv>
60
61 <refsect1>
62 <title>Description</title>
63 <para>
64 The <command>VBoxHeadless</command> command is an alternate front
65 end that enables you to remotely manage virtual machines (VMs).
66 The front end is a CLI rather than the VirtualBox Manager
67 graphical user interface (GUI).
68 </para>
69 <para>
70 For information about using this command, see
71 <xref linkend="vboxheadless" />.
72 </para>
73 <refsect2 id="vboxmanage-vboxheadless-command-options">
74 <title>Command Options</title>
75 <variablelist>
76 <varlistentry>
77 <term><option>--startvm=<replaceable>uuid</replaceable> | <replaceable>vmname</replaceable></option></term>
78 <listitem><para>
79 Specifies the Universally Unique Identifier (UUID) or name
80 of the VM to start.
81 </para><para>
82 Use the <command>VBoxManage list vms</command> command to
83 obtain VM information.
84 </para><para>
85 The short versions of this option are <option>-s</option>
86 and <option>-startvm</option>.
87 </para></listitem>
88 </varlistentry>
89 <varlistentry>
90 <term><option>--vrde=on | off | config</option></term>
91 <listitem><para>
92 Specifies how to use the VRDP server. The default value is
93 <literal>config</literal>. Valid values are as follows:
94 </para><itemizedlist>
95 <listitem><para>
96 <literal>on</literal> enables the VRDP server.
97 </para><screen>VBoxHeadless --startvm=<replaceable>vmname</replaceable> --vrde=on</screen></listitem>
98 <listitem><para>
99 <literal>off</literal> disables the VRDP server.
100 </para><screen>VBoxHeadless --startvm=<replaceable>vmname</replaceable> --vrde=off</screen></listitem>
101 <listitem><para>
102 <literal>config</literal> enables the VRDP server
103 depending on the VM configuration.
104 </para><screen>VBoxHeadless --startvm=<replaceable>vmname</replaceable> --vrde=config</screen></listitem>
105 </itemizedlist><para>
106 The short version of this option is <option>-v</option>.
107 </para></listitem>
108 </varlistentry>
109 <varlistentry>
110 <term><option>--vrdeproperty=<replaceable>prop-name</replaceable>=<replaceable>prop-value</replaceable></option></term>
111 <listitem><para>
112 Specifies a value for one of the following properties:
113 </para><itemizedlist>
114 <listitem><para>
115 The <literal>TCP/Ports</literal> property value is a
116 comma-separated list of ports to which the VRDE server
117 can bind. Use a hyphen (<literal>-</literal>) between
118 two port numbers to specify a range of ports.
119 </para></listitem>
120 <listitem><para>
121 The <literal>TCP/Address</literal> property value is
122 the interface IP address to which to bind the VRDE
123 server.
124 </para></listitem>
125 </itemizedlist></listitem>
126 </varlistentry>
127 <varlistentry>
128 <term><option>--settingspw=[<replaceable>password</replaceable>]</option></term>
129 <listitem><para>
130 Specifies a settings password to access encrypted
131 settings. If you do not specify the password on the
132 command line, <command>VBoxHeadless</command> prompts you
133 for the password.
134 </para><remark>
135 This design does not conform to Oracle's security
136 guidelines. You should not be able to specify a password
137 on the command line because the password can be seen in a
138 process listing.
139 </remark></listitem>
140 </varlistentry>
141 <varlistentry>
142 <term><option>--settingspwfile=<replaceable>password-file</replaceable></option></term>
143 <listitem><para>
144 Specifies the file that contains the settings password.
145 </para></listitem>
146 </varlistentry>
147 <varlistentry>
148 <term><option>--start-paused=<replaceable>vmname</replaceable></option></term>
149 <listitem><para>
150 Starts the specified VM in the paused state.
151 </para></listitem>
152 </varlistentry>
153 <varlistentry>
154 <term><option>--capture</option></term>
155 <listitem><para>
156 Records the VM screen output to a file. In addition to
157 this option, you must use the <option>--filename</option>
158 option to specify the name of the file.
159 </para></listitem>
160 </varlistentry>
161 <varlistentry>
162 <term><option>--width=<replaceable>width</replaceable></option></term>
163 <listitem><para>
164 Specifies the frame width of the recording in pixels. This
165 option is associated with the <option>--capture</option>
166 option.
167 </para></listitem>
168 </varlistentry>
169 <varlistentry>
170 <term><option>--height=<replaceable>height</replaceable></option></term>
171 <listitem><para>
172 Specifies the frame height of the recording in pixels.
173 This option is associated with the
174 <option>--capture</option> option.
175 </para></listitem>
176 </varlistentry>
177 <varlistentry>
178 <term><option>--bitrate=<replaceable>bit-rate</replaceable></option></term>
179 <listitem><para>
180 Specifies the bit rate of the recording in kilobits per
181 second. This option is associated with the
182 <option>--capture</option> option.
183 </para></listitem>
184 </varlistentry>
185 <varlistentry>
186 <term><option>--filename=<replaceable>filename</replaceable></option></term>
187 <listitem><para>
188 Specifies the name of the file in which to store the
189 recording. The codec used is based on the file extension
190 that you choose. You must specify this option if you use
191 the <option>--capture</option> option.
192 </para><remark>
193 Where can we get information about the file extensions
194 that are supported?
195 </remark></listitem>
196 </varlistentry>
197 </variablelist>
198 </refsect2>
199 </refsect1>
200
201 <refsect1>
202 <title>Examples</title>
203 <remark role="help-scope" condition="GLOBAL"/>
204 <para>
205 The following command starts the <literal>ol7u4</literal> VM:
206 </para>
207<screen>$ VBoxHeadless --startvm "ol7u4"</screen>
208 <para>
209 The following command starts the <literal>ol7u6</literal> VM in
210 the Paused state.
211 </para>
212<screen>$ VBoxHeadless --startvm "ol7u6" --start-paused</screen>
213 <para>
214 The following command starts the <literal>ol7u6</literal> VM and
215 records the session. The recording is saved to the
216 <filename>ol7u6-recording</filename> WebM file.
217 </para>
218<screen>$ VBoxHeadless --startvm "ol7u6" --capture --filename ol7u6-recording.webm</screen>
219 </refsect1>
220
221 <refsect1>
222 <title>See Also</title>
223 <para>
224 <xref linkend="vboxmanage-list" />,
225 <xref linkend="vboxmanage-startvm" />
226 </para>
227 </refsect1>
228</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