VirtualBox

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-unattended.xml@ 81235

Last change on this file since 81235 was 73276, checked in by vboxsync, 6 years ago

doc/manual: Big build system overhaul, because the use of entities and catalogs eliminates the need to have placeholders in XML which previously needed separate preprocessing. Many cleanups, including replacing almost all pattern rules (since their dependencies had to be too generous) and using defines instead. Also integrated many cleanups for the user manual text (which needs careful review, couldn't check yet if it uses any additional tags which some of our XSLT would ignore).

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