1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
2 | <!--
|
---|
3 | manpage, user manual, usage: VBoxManage unattended
|
---|
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-unattended" lang="en">
|
---|
32 | <refentryinfo>
|
---|
33 | <pubdate>$Date: 2023-12-08 12:43:07 +0000 (Fri, 08 Dec 2023) $</pubdate>
|
---|
34 | <title>VBoxManage unattended</title>
|
---|
35 | </refentryinfo>
|
---|
36 |
|
---|
37 | <refmeta>
|
---|
38 | <refentrytitle>VBoxManage-unattended</refentrytitle>
|
---|
39 | <manvolnum>1</manvolnum>
|
---|
40 | </refmeta>
|
---|
41 |
|
---|
42 | <refnamediv>
|
---|
43 | <refname>VBoxManage-unattended</refname>
|
---|
44 | <refpurpose>unattended guest OS installation</refpurpose>
|
---|
45 | <refclass>&product-name;</refclass>
|
---|
46 | </refnamediv>
|
---|
47 |
|
---|
48 | <refsynopsisdiv>
|
---|
49 | <cmdsynopsis id="synopsis-vboxmanage-unattended-detect"> <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
---|
50 | <command>VBoxManage unattended detect</command>
|
---|
51 | <arg choice="req">--iso=<replaceable>install-iso</replaceable></arg>
|
---|
52 | <arg>--machine-readable</arg>
|
---|
53 | </cmdsynopsis>
|
---|
54 | <cmdsynopsis id="synopsis-vboxmanage-unattended-install"> <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
---|
55 | <command>VBoxManage unattended install</command>
|
---|
56 | <group choice="req">
|
---|
57 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
---|
58 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
---|
59 | </group>
|
---|
60 | <arg choice="req">--iso=<replaceable>install-iso</replaceable></arg>
|
---|
61 | <arg>--user=<replaceable>login</replaceable></arg>
|
---|
62 | <arg>--user-password=<replaceable>password</replaceable></arg>
|
---|
63 | <arg>--admin-password=<replaceable>password</replaceable></arg>
|
---|
64 | <arg>--password-file=<replaceable>file</replaceable></arg>
|
---|
65 | <arg>--full-user-name=<replaceable>name</replaceable></arg>
|
---|
66 | <arg>--key=<replaceable>product-key</replaceable></arg>
|
---|
67 | <arg>--install-additions</arg>
|
---|
68 | <arg>--no-install-additions</arg>
|
---|
69 | <arg>--additions-iso=<replaceable>add-iso</replaceable></arg>
|
---|
70 | <arg>--install-txs</arg>
|
---|
71 | <arg>--no-install-txs</arg>
|
---|
72 | <arg>--validation-kit-iso=<replaceable>testing-iso</replaceable></arg>
|
---|
73 | <arg>--locale=<replaceable>ll_CC</replaceable></arg>
|
---|
74 | <arg>--country=<replaceable>CC</replaceable></arg>
|
---|
75 | <arg>--time-zone=<replaceable>tz</replaceable></arg>
|
---|
76 | <arg>--hostname=<replaceable>fqdn</replaceable></arg>
|
---|
77 | <arg>--package-selection-adjustment=<replaceable>keyword</replaceable></arg>
|
---|
78 | <arg>--dry-run</arg>
|
---|
79 | <arg>--auxiliary-base-path=<replaceable>path</replaceable></arg>
|
---|
80 | <arg>--image-index=<replaceable>number</replaceable></arg>
|
---|
81 | <arg>--script-template=<replaceable>file</replaceable></arg>
|
---|
82 | <arg>--post-install-template=<replaceable>file</replaceable></arg>
|
---|
83 | <arg>--post-install-command=<replaceable>command</replaceable></arg>
|
---|
84 | <arg>--extra-install-kernel-parameters=<replaceable>params</replaceable></arg>
|
---|
85 | <arg>--language=<replaceable>lang</replaceable></arg>
|
---|
86 | <arg>--start-vm=<replaceable>session-type</replaceable></arg>
|
---|
87 | </cmdsynopsis>
|
---|
88 | </refsynopsisdiv>
|
---|
89 |
|
---|
90 | <refsect1 id="vboxmanage-unattended-description">
|
---|
91 | <title>Description</title>
|
---|
92 |
|
---|
93 | <refsect2 id="vboxmanage-unattended-detect">
|
---|
94 | <title>unattended detect</title>
|
---|
95 | <remark role="help-copy-synopsis"/>
|
---|
96 | <para>
|
---|
97 | Detects the guest operating system (OS) on the specified installation ISO
|
---|
98 | and displays the result. This can be used as input when creating a VM for
|
---|
99 | the ISO to be installed in.
|
---|
100 | </para>
|
---|
101 | <variablelist>
|
---|
102 | <varlistentry>
|
---|
103 | <term><option>--iso=<replaceable>install-iso</replaceable></option></term>
|
---|
104 | <listitem><para>The installation ISO to run the detection on.</para></listitem>
|
---|
105 | </varlistentry>
|
---|
106 | <varlistentry>
|
---|
107 | <term><option>--machine-readable</option></term>
|
---|
108 | <listitem><para>Produce output that is simpler to parse from a script.</para></listitem>
|
---|
109 | </varlistentry>
|
---|
110 | </variablelist>
|
---|
111 | </refsect2>
|
---|
112 |
|
---|
113 | <refsect2 id="vboxmanage-unattended-install">
|
---|
114 | <title>unattended install</title>
|
---|
115 | <remark role="help-copy-synopsis"/>
|
---|
116 | <para>
|
---|
117 | Reconfigures the specified VM for installation and optionally starts it up.
|
---|
118 | </para>
|
---|
119 | <variablelist>
|
---|
120 | <varlistentry>
|
---|
121 | <term><option><replaceable>uuid</replaceable> | <replaceable>vmname</replaceable></option></term>
|
---|
122 | <listitem><para>Either the UUID or the name (case sensitive) of a VM.</para></listitem>
|
---|
123 | </varlistentry>
|
---|
124 | <varlistentry>
|
---|
125 | <term><option>--iso=<replaceable>install-iso</replaceable></option></term>
|
---|
126 | <listitem><para>The installation ISO to run the detection on.</para></listitem>
|
---|
127 | </varlistentry>
|
---|
128 | <varlistentry>
|
---|
129 | <term><option>--user=<replaceable>login</replaceable></option></term>
|
---|
130 | <listitem><para>The login name. (default: vboxuser)</para></listitem>
|
---|
131 | </varlistentry>
|
---|
132 | <varlistentry>
|
---|
133 | <term><option>--user-password=<replaceable>password</replaceable></option></term>
|
---|
134 | <listitem>
|
---|
135 | <para>The user login password. This is used for the user given by <option>--user</option>
|
---|
136 | (default: changeme)</para></listitem>
|
---|
137 | </varlistentry>
|
---|
138 | <varlistentry>
|
---|
139 | <term><option>--user-password-file=<replaceable>file</replaceable></option></term>
|
---|
140 | <listitem>
|
---|
141 | <para>Alternative to <option>--user-password</option> for providing the user password. Special filename
|
---|
142 | <computeroutput>stdin</computeroutput> can be used to read the password from standard input.</para></listitem>
|
---|
143 | </varlistentry>
|
---|
144 | <varlistentry>
|
---|
145 | <term><option>--admin-password=<replaceable>password</replaceable></option></term>
|
---|
146 | <listitem>
|
---|
147 | <para>The admin / root login password. If not specified, the password from <option>--user-password</option>
|
---|
148 | will be used.</para></listitem>
|
---|
149 | </varlistentry>
|
---|
150 | <varlistentry>
|
---|
151 | <term><option>--admin-password-file=<replaceable>file</replaceable></option></term>
|
---|
152 | <listitem>
|
---|
153 | <para>Alternative to <option>--admin-password</option> for providing the admin / root password. Special filename
|
---|
154 | <computeroutput>stdin</computeroutput> can be used to read the password from standard input.</para></listitem>
|
---|
155 | </varlistentry>
|
---|
156 | <varlistentry>
|
---|
157 | <term><option>--full-user-name=<replaceable>name</replaceable></option></term>
|
---|
158 | <listitem><para>The full user name. (default: --user)</para></listitem>
|
---|
159 | </varlistentry>
|
---|
160 | <varlistentry>
|
---|
161 | <term><option>--key=<replaceable>product-key</replaceable></option></term>
|
---|
162 | <listitem><para>The guest OS product key. Not all guest OSes requires this.</para></listitem>
|
---|
163 | </varlistentry>
|
---|
164 | <varlistentry>
|
---|
165 | <term><option>--install-additions</option>, <option>--no-install-additions</option></term>
|
---|
166 | <listitem><para>Whether to install the VirtualBox guest additions. (default: --no-install-addations)</para></listitem>
|
---|
167 | </varlistentry>
|
---|
168 | <varlistentry>
|
---|
169 | <term><option>--additions-iso=<replaceable>add-iso</replaceable></option></term>
|
---|
170 | <listitem>
|
---|
171 | <para>Path to the VirtualBox guest additions ISO. (default: installed/downloaded GAs)</para></listitem>
|
---|
172 | </varlistentry>
|
---|
173 | <varlistentry>
|
---|
174 | <term><option>--install-txs</option>, <option>--no-install-txs</option></term>
|
---|
175 | <listitem>
|
---|
176 | <para>Whether to install the test execution service (TXS) from the VirtualBox ValidationKit.
|
---|
177 | This is useful when preparing VMs for testing or similar. (default: --no-install-txs)</para></listitem>
|
---|
178 | </varlistentry>
|
---|
179 | <varlistentry>
|
---|
180 | <term><option>--validation-kit-iso=<replaceable>testing-iso</replaceable></option></term>
|
---|
181 | <listitem>
|
---|
182 | <para>Path to the VirtualBox ValidationKit ISO. This is required if <option>--install-txs</option>
|
---|
183 | is specified. </para></listitem>
|
---|
184 | </varlistentry>
|
---|
185 | <varlistentry>
|
---|
186 | <term><option>--locale=<replaceable>ll_CC</replaceable></option></term>
|
---|
187 | <listitem>
|
---|
188 | <para>The base locale specification for the guest, like en_US, de_CH, or nn_NO. (default: host or en_US)</para></listitem>
|
---|
189 | </varlistentry>
|
---|
190 | <varlistentry>
|
---|
191 | <term><option>--country=<replaceable>CC</replaceable></option></term>
|
---|
192 | <listitem><para>The two letter country code if it differs from the specified by <option>--location</option>.</para></listitem>
|
---|
193 | </varlistentry>
|
---|
194 | <varlistentry>
|
---|
195 | <term><option>--time-zone=<replaceable>tz</replaceable></option></term>
|
---|
196 | <listitem><para>The time zone to set up the guest OS with. (default: host time zone or UTC)</para></listitem>
|
---|
197 | </varlistentry>
|
---|
198 | <varlistentry>
|
---|
199 | <term><option>--hostname=<replaceable>fqdn</replaceable></option></term>
|
---|
200 | <listitem>
|
---|
201 | <para>The fully qualified domain name of the guest machine.
|
---|
202 | (default: <replaceable>vmname</replaceable>.myguest.virtualbox.org)</para></listitem>
|
---|
203 | </varlistentry>
|
---|
204 | <varlistentry>
|
---|
205 | <term><option>--package-selection-adjustment=<replaceable>keyword</replaceable></option></term>
|
---|
206 | <listitem>
|
---|
207 | <para>Adjustments to the guest OS packages/components selection. This can be specfied more than once. Currently
|
---|
208 | the only recognized keyword is <computeroutput>minimal</computeroutput> which triggers a minimal installation for
|
---|
209 | some of the guest OSes.</para></listitem>
|
---|
210 | </varlistentry>
|
---|
211 | <varlistentry>
|
---|
212 | <term><option>--dry-run</option></term>
|
---|
213 | <listitem><para>Do not create any files or make any changes to the VM configuration.</para></listitem>
|
---|
214 | </varlistentry>
|
---|
215 | <varlistentry>
|
---|
216 | <term><option>--start-vm=<replaceable>session-type</replaceable></option></term>
|
---|
217 | <listitem>
|
---|
218 | <para>Start the VM using the front end given by <replaceable>session-type</replaceable>. This is the same as
|
---|
219 | the <option>--type</option> option for the <computeroutput>startvm</computeroutput> command, but we have add
|
---|
220 | <computeroutput>none</computeroutput> for indicating that the VM should not be started.
|
---|
221 | (default: <computeroutput>none</computeroutput>)</para></listitem>
|
---|
222 | </varlistentry>
|
---|
223 | </variablelist>
|
---|
224 |
|
---|
225 | <para>Advanced options:</para>
|
---|
226 | <variablelist>
|
---|
227 | <varlistentry>
|
---|
228 | <term><option>--auxiliary-base-path=<replaceable>path</replaceable></option></term>
|
---|
229 | <listitem>
|
---|
230 | <para>The path prefix to the media related files generated for the installation.
|
---|
231 | (default: <replaceable>vm-config-dir</replaceable>/Unattended-<replaceable>vm-uuid</replaceable>-)</para></listitem>
|
---|
232 | </varlistentry>
|
---|
233 | <varlistentry>
|
---|
234 | <term><option>--image-index=<replaceable>number</replaceable></option></term>
|
---|
235 | <listitem><para>Windows installation image index. (default: 1)</para></listitem>
|
---|
236 | </varlistentry>
|
---|
237 | <varlistentry>
|
---|
238 | <term><option>--script-template=<replaceable>file</replaceable></option></term>
|
---|
239 | <listitem><para>The unattended installation script template. (default: IMachine::OSTypeId dependent)</para></listitem>
|
---|
240 | </varlistentry>
|
---|
241 | <varlistentry>
|
---|
242 | <term><option>--post-install-template=<replaceable>file</replaceable></option></term>
|
---|
243 | <listitem><para>The post installation script template. (default: IMachine::OSTypeId dependent)</para></listitem>
|
---|
244 | </varlistentry>
|
---|
245 | <varlistentry>
|
---|
246 | <term><option>--post-install-command=<replaceable>command</replaceable></option></term>
|
---|
247 | <listitem>
|
---|
248 | <para>A single command to run after the installation is completed. The exact format and exactly
|
---|
249 | when this is run is guest OS installer dependent.</para></listitem>
|
---|
250 | </varlistentry>
|
---|
251 | <varlistentry>
|
---|
252 | <term><option>--extra-install-kernel-parameters=<replaceable>params</replaceable></option></term>
|
---|
253 | <listitem>
|
---|
254 | <para>
|
---|
255 | List of extra linux kernel parameters to use during the installation. (default: IMachine::OSTypeId dependent)
|
---|
256 | </para></listitem>
|
---|
257 | </varlistentry>
|
---|
258 | <varlistentry>
|
---|
259 | <term><option>--language=<replaceable>lang</replaceable></option></term>
|
---|
260 | <listitem>
|
---|
261 | <para>
|
---|
262 | Specifies the UI language for a Windows installation. The <replaceable>lang</replaceable> is
|
---|
263 | generally on the form {ll}-{CC}. See detectedOSLanguages results from <command>VBoxManage unattended detect</command>.
|
---|
264 | (default: detectedOSLanguages[0])</para></listitem>
|
---|
265 | </varlistentry>
|
---|
266 |
|
---|
267 | </variablelist>
|
---|
268 | </refsect2>
|
---|
269 |
|
---|
270 | </refsect1>
|
---|
271 | </refentry>
|
---|
272 |
|
---|