VirtualBox

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-startvm.xml@ 103068

Last change on this file since 103068 was 99513, checked in by vboxsync, 20 months ago

manual,VBoxManage,isomaker/viso: Require all refsect1 and refsect2 elements to have @id attributes in manpages (refentry) to make these predictable and the split up topic files easier to handle for the docs team. Also requires these @id values to start with the refentry @id + '-'. Corrected a few bogus ones. Because 'controlvm' has too many sub-commands, HELP_SCOPE_ IDs will not be generated for 'See Also' and 'Examples' sections. bugref:10302

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 7.3 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage startvm
4-->
5<!--
6 Copyright (C) 2006-2023 Oracle and/or its affiliates.
7
8 This file is part of VirtualBox base platform packages, as
9 available from https://www.virtualbox.org.
10
11 This program is free software; you can redistribute it and/or
12 modify it under the terms of the GNU General Public License
13 as published by the Free Software Foundation, in version 3 of the
14 License.
15
16 This program is distributed in the hope that it will be useful, but
17 WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 General Public License for more details.
20
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, see <https://www.gnu.org/licenses>.
23
24 SPDX-License-Identifier: GPL-3.0-only
25-->
26<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
27 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
28<!ENTITY % all.entities SYSTEM "all-entities.ent">
29%all.entities;
30]>
31<refentry id="vboxmanage-startvm" lang="en">
32 <refentryinfo>
33 <pubdate>$Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</pubdate>
34 <title>VBoxManage startvm</title>
35 </refentryinfo>
36
37 <refmeta>
38 <refentrytitle>VBoxManage-startvm</refentrytitle>
39 <manvolnum>1</manvolnum>
40 </refmeta>
41
42 <refnamediv>
43 <refname>VBoxManage-startvm</refname>
44 <refpurpose>start a virtual machine</refpurpose>
45 <refclass>&product-name;</refclass>
46 </refnamediv>
47
48 <refsynopsisdiv>
49 <cmdsynopsis id="synopsis-vboxmanage-startvm">
50<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
51 <command>VBoxManage startvm</command>
52 <arg>--putenv=<replaceable>name</replaceable>[=<replaceable>value</replaceable>]</arg>
53 <arg role="compact">--type=<group choice="req">
54 <arg choice="plain">gui</arg>
55 <arg choice="plain">headless</arg>
56 <arg choice="plain">sdl</arg>
57 <arg choice="plain">separate</arg>
58 </group></arg>
59 <arg>--password=<replaceable>file</replaceable></arg>
60 <arg>--password-id=<replaceable>password-identifier</replaceable></arg>
61 <group choice="req" rep="repeat">
62 <arg choice="plain"><replaceable>uuid</replaceable></arg>
63 <arg choice="plain"><replaceable>vmname</replaceable></arg>
64 </group>
65 </cmdsynopsis>
66 </refsynopsisdiv>
67
68 <refsect1 id="vboxmanage-startvm-description">
69 <title>Description</title>
70 <para>
71 The <command>VBoxManage startvm</command> command starts an
72 &product-name; virtual machine (VM) that is in the Powered Off or
73 Saved state.
74 </para>
75 <variablelist>
76 <varlistentry>
77 <term><option><replaceable>uuid</replaceable> | <replaceable>vmname</replaceable></option></term>
78 <listitem><para>
79 Specifies the name or Universally Unique Identifier (UUID)
80 of the VM.
81 </para></listitem>
82 </varlistentry>
83 <varlistentry>
84 <term><option>--putenv=<replaceable>name</replaceable>=<replaceable>value</replaceable></option></term>
85 <listitem><para>
86 Assigns a value to an environment variable as a name-value
87 pair. For example, VBOX_DISABLE_HOST_DISK_CACHE=1.
88 </para><para>
89 The short form of this option is <option>-E</option>.
90 </para></listitem>
91 </varlistentry>
92 <varlistentry>
93 <term><option>--type=gui | headless | sdl | separate</option></term>
94 <listitem><para>
95 Specifies the frontend used to start the VM.
96 </para><para>
97 You can use the <command>VBoxManage setproperty</command>
98 command to set a global default value for the frontend.
99 Alternatively, you can use the <command>VBoxManage
100 modifyvm</command> command to specify a default frontend
101 value for a specific VM. If neither a global or per-VM
102 default value is set and you do not specify the
103 <option>--type</option> option, then the VM opens in a
104 window on the host desktop.
105 </para><para>
106 The <option>--type</option> option accepts the following
107 values:
108 </para><variablelist>
109 <varlistentry>
110 <term><literal>gui</literal></term>
111 <listitem><para>
112 Starts a VM in a graphical user interface (GUI)
113 window. This is the default.
114 </para></listitem>
115 </varlistentry>
116 <varlistentry>
117 <term><literal>headless</literal></term>
118 <listitem><para>
119 Starts a VM for remote display only.
120 </para></listitem>
121 </varlistentry>
122 <varlistentry>
123 <term><literal>sdl</literal></term>
124 <listitem><para>
125 Starts a VM using the VBoxSDL frontend.
126 </para></listitem>
127 </varlistentry>
128 <varlistentry>
129 <term><literal>separate</literal></term>
130 <listitem><para>
131 Starts a VM with a detachable user interface (UI),
132 which means that the VM runs headless with the UI in a
133 separate process.
134 </para><para>
135 This is an experimental feature that lacks certain
136 functionality, such as 3D acceleration.
137 </para></listitem>
138 </varlistentry>
139 </variablelist></listitem>
140 </varlistentry>
141 <varlistentry>
142 <term><option>--password</option></term>
143 <listitem>
144 <para>
145 Use the <option>--password</option> to supply the encryption
146 password. Either specify the absolute pathname of a password file
147 on the host operating system, or <literal>-</literal> to prompt
148 you for the password on the command line.
149 </para>
150 </listitem>
151 </varlistentry>
152 <varlistentry>
153 <term><option>--password-id</option></term>
154 <listitem>
155 <para>
156 Use the <option>--password-id</option> option to specify the
157 id the password is supplied for.
158 </para>
159 </listitem>
160 </varlistentry>
161 </variablelist>
162 <note>
163 <para>
164 If a VM fails to start with a particular frontend and the error
165 information is inconclusive, consider starting the VM directly
166 by running the frontend. This workaround might provide
167 additional error information.
168 </para>
169 </note>
170 </refsect1>
171
172 <refsect1 id="vboxmanage-startvm-examples">
173 <title>Examples</title>
174 <remark role="help-scope" condition="GLOBAL" />
175 <para>
176 The following command starts the <literal>ol7u6</literal> VM:
177 </para>
178<screen>$ VBoxManage startvm ol7u6</screen>
179 <para>
180 The following command starts the
181 <literal>ol7u6-mininstall</literal> VM in headless mode.
182 </para>
183<screen>$ VBoxManage startvm ol7u6-mininstall --type headless</screen>
184 </refsect1>
185
186 <refsect1 id="vboxmanage-startvm-see-also">
187 <title>See Also</title>
188 <para>
189<!--<xref linkend="vboxmanage-vboxheadless" />-->
190 <xref linkend="vboxheadless" />,
191 <xref linkend="vboxmanage-setproperty" />,
192 <xref linkend="vboxmanage-modifyvm" />.
193 </para>
194 </refsect1>
195</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