Changeset 66173 in vbox for trunk/doc/manual/en_US

Timestamp:

Mar 21, 2017 9:10:39 AM (8 years ago)

Author:

vboxsync

Message:

bugref:8527. Added a paragraph to the user manual about the command "VBoxManage unattended".

File:

• trunk/doc/manual/en_US/user_VBoxManage.xml (modified) (1 diff)

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -2687 +2687 @@
   </sect1>
 
+<sect1 id="vboxmanage-unattended">
+    <title>VBoxManage unattended</title>
+ 
+    <para>The <computeroutput>unattended</computeroutput> subcommand allows you to run unattended
+    guest installation from the command line.
+    User is able to choose passing the settings for unattended installation via:
+      <itemizedlist>
+        <listitem>
+          <para>passing the data via a file with prepared settings using
+          <computeroutput>VBoxManage unattended usefile</computeroutput>
+          </para>
+          <itemizedlist>
+            <listitem>
+              <para><computeroutput>--settingfile
+              &lt;file&gt;</computeroutput>:
+              specifies a file with all settings needed for unattended installation. </para>
+            </listitem>
+          </itemizedlist>
+ 
+          <para>In this case correctness of all settings and data lays upon on the user.</para>
+ 
+        </listitem>
+ 
+        <listitem>
+          <para>the command line using
+          <computeroutput>VBoxManage unattended usedata</computeroutput></para>
+          <para>Command line settings are:</para>
+          <itemizedlist>
+            <listitem>
+              <para><computeroutput>--user
+              &lt;user name&gt;</computeroutput>:
+              specifies a login name for the guest OS. </para>
+            </listitem>
+ 
+            <listitem>
+              <para><computeroutput>--password
+              &lt;password&gt;</computeroutput>:
+              user's password for the logging to the guest OS. </para>
+            </listitem>
+ 
+            <listitem>
+              <para><computeroutput>--key
+              &lt;key&gt;</computeroutput>:
+              product key for validating the installed OS. </para>
+            </listitem>
+ 
+            <listitem>
+              <para><computeroutput>--isopath
+              &lt;OS ISO path&gt;</computeroutput>:
+              CD\DVD disk or ISO image with OS installation data. </para>
+            </listitem>
+ 
+            <listitem>
+               <para><computeroutput>--addisopath
+              &lt;additions ISO path&gt;</computeroutput>:
+              ISO image with Virtualbox additions. Optional. </para>
+            </listitem>
+ 
+            <listitem>
+              <para><computeroutput>--imageindex
+              &lt;number&gt;</computeroutput>:
+              The installation disk can contains the several images of OS (for example 32bits and 64bits systems).
+              At moment used only for Windows OS installation. Optional.
+              </para>
+            </listitem>
+ 
+          </itemizedlist>
+        </listitem>
+      </itemizedlist>
+    </para>
+ 
+    <para>The setting file has a simple structure as "key equal sign value".
+    One key is one line, at moment there are eight settings which supported by the command:
+      <itemizedlist>
+        <listitem>
+          <para><computeroutput>
+          username</computeroutput>:
+           See above description for "--username"</para>
+        </listitem>
+ 
+        <listitem>
+          <para><computeroutput>
+          password</computeroutput>:
+          See above description for "--password"</para>
+        </listitem>
+ 
+        <listitem>
+          <para><computeroutput>
+          key</computeroutput>:
+          See above description for "--key"</para>
+        </listitem>
+ 
+        <listitem>
+          <para><computeroutput>
+          installation_iso</computeroutput>:
+          See above description for "--isopath"</para>
+        </listitem>
+ 
+        <listitem>
+          <para><computeroutput>
+          addition_iso</computeroutput>:
+          See above description for "--addisopath"</para>
+        </listitem>
+ 
+        <listitem>
+          <para><computeroutput>
+          aux_iso</computeroutput>:
+          Auxiliary CD disk which can be used during installation as simple bootable CD with unattended script on it.
+          Generally used for Linux installation.</para>
+        </listitem>
+ 
+        <listitem>
+          <para><computeroutput>
+          aux_floppy</computeroutput>:
+          Auxiliary floppy disk which can be used during installation as source of unattended script used by the installer.
+          Generally used for Windows installation.
+          </para>
+        </listitem>
+ 
+        <listitem>
+          <para><computeroutput>
+          image_index</computeroutput>:
+          See above description for "--imageindex".</para>
+        </listitem>
+      </itemizedlist>
+        <note>
+          <para>The most of parameters are the same parameters as passed via the command line
+          and two of them are related to two items which can be created on the fly during installation (it's auxiliary floppy and CD).
+          </para>
+        </note>
+    </para>
+ 
+    <para>
+    Example "VBoxManage unattended usedata":
+    </para>
+    <para>
+    <computeroutput>
+    VBoxManage unattended 2a524618-dd30-4168-bd53-645d9d72bb25 usedata 
+    --user smith 
+    --password smile 
+    --isopath /path/to/the/distributive/ubuntu-16.04.1-server-amd64.iso 
+    --addisopath /path/to/Virtualbox/additions/VBoxGuestAdditions.iso 
+    </computeroutput>
+    </para>
+
+    <para>
+    Example "VBoxManage unattended usefile":
+    </para>
+    <para><computeroutput>
+    VBoxManage unattended 2a524618-dd30-4168-bd53-645d9d72bb25 usefile 
+    --settingfile /path/to/the/file/unattended_settings.txt 
+    </computeroutput></para>
+
+  </sect1> 
+
   <sect1>
     <title>VBoxManage discardstate</title>