| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 2 | <!--
|
|---|
| 3 | manpage, user manual, usage: VBoxManage import
|
|---|
| 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="vboxmanage-import" lang="en">
|
|---|
| 21 | <refentryinfo>
|
|---|
| 22 | <pubdate>August 2019</pubdate>
|
|---|
| 23 | <title>VBoxManage import</title>
|
|---|
| 24 | </refentryinfo>
|
|---|
| 25 |
|
|---|
| 26 | <refmeta>
|
|---|
| 27 | <refentrytitle>VBoxManage-import</refentrytitle>
|
|---|
| 28 | <manvolnum>1</manvolnum>
|
|---|
| 29 | </refmeta>
|
|---|
| 30 |
|
|---|
| 31 | <refnamediv>
|
|---|
| 32 | <refname>VBoxManage-import</refname>
|
|---|
| 33 | <refpurpose>import a virtual appliance in OVF format and create virtual machines</refpurpose>
|
|---|
| 34 | <refclass>Oracle VM VirtualBox</refclass>
|
|---|
| 35 | </refnamediv>
|
|---|
| 36 |
|
|---|
| 37 | <refsynopsisdiv>
|
|---|
| 38 | <cmdsynopsis id="synopsis-vboxmanage-import">
|
|---|
| 39 | <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
|---|
| 40 | <command>VBoxManage import</command>
|
|---|
| 41 | <group choice="req">
|
|---|
| 42 | <arg choice="plain"><replaceable>ovfname</replaceable></arg>
|
|---|
| 43 | <arg choice="plain"><replaceable>ovaname</replaceable></arg>
|
|---|
| 44 | </group>
|
|---|
| 45 | <arg>--dry-run</arg>
|
|---|
| 46 | <arg>--options=<group choice="plain">
|
|---|
| 47 | <arg choice="plain">keepallmacs</arg>
|
|---|
| 48 | <arg choice="plain">keepnatmacs</arg>
|
|---|
| 49 | <arg choice="plain">keepdisknames</arg>
|
|---|
| 50 | <arg choice="plain">importtovdi</arg>
|
|---|
| 51 | </group></arg>
|
|---|
| 52 | </cmdsynopsis>
|
|---|
| 53 | </refsynopsisdiv>
|
|---|
| 54 |
|
|---|
| 55 | <refsect1>
|
|---|
| 56 | <title>Description</title>
|
|---|
| 57 | <para>
|
|---|
| 58 | The <command>VBoxManage import</command> command imports a virtual
|
|---|
| 59 | appliance in OVF or OVA format by copying virtual disk images and
|
|---|
| 60 | by creating virtual machines (VMs) in &product-name;. See
|
|---|
| 61 | <xref linkend="ovf" />.
|
|---|
| 62 | </para>
|
|---|
| 63 | <para>
|
|---|
| 64 | You must specify the path name of an OVF file or OVA archive to
|
|---|
| 65 | use as input. Also, ensure that any disk images are in the same
|
|---|
| 66 | directory as the OVF file or OVA archive.
|
|---|
| 67 | </para>
|
|---|
| 68 | <para>
|
|---|
| 69 | Note that any options you specify to control the imported virtual
|
|---|
| 70 | appliance or to modify the import parameters rely on the contents
|
|---|
| 71 | of the OVF file.
|
|---|
| 72 | </para>
|
|---|
| 73 | <para>
|
|---|
| 74 | Before you use the import operation to create the VM, perform a
|
|---|
| 75 | dry run to verify the correctness of your configuration.
|
|---|
| 76 | </para>
|
|---|
| 77 | <refsect2>
|
|---|
| 78 | <title>Common Options</title>
|
|---|
| 79 | <variablelist>
|
|---|
| 80 | <varlistentry>
|
|---|
| 81 | <term><replaceable>ovfname</replaceable> | <replaceable>ovaname</replaceable></term>
|
|---|
| 82 | <listitem><para>
|
|---|
| 83 | Specifies the name of the OVF file or OVA archive that
|
|---|
| 84 | describes the appliance.
|
|---|
| 85 | </para></listitem>
|
|---|
| 86 | </varlistentry>
|
|---|
| 87 | <varlistentry>
|
|---|
| 88 | <term><option>--dry-run</option></term>
|
|---|
| 89 | <listitem><para>
|
|---|
| 90 | Performs a dry run of the <command>VBoxManage
|
|---|
| 91 | import</command> command before you perform the actual
|
|---|
| 92 | import operation. A dry run operation does the following:
|
|---|
| 93 | </para><itemizedlist>
|
|---|
| 94 | <listitem><para>
|
|---|
| 95 | Outputs a description of the appliance's contents
|
|---|
| 96 | based on the specified OVF or OVA file.
|
|---|
| 97 | </para></listitem>
|
|---|
| 98 | <listitem><para>
|
|---|
| 99 | Shows how the appliance would be imported into
|
|---|
| 100 | &product-name;. In addition, the output shows any
|
|---|
| 101 | options that you can use to change the import
|
|---|
| 102 | behavior.
|
|---|
| 103 | </para></listitem>
|
|---|
| 104 | </itemizedlist><para>
|
|---|
| 105 | The shortened form of this option is <option>-n</option>.
|
|---|
| 106 | </para></listitem>
|
|---|
| 107 | </varlistentry>
|
|---|
| 108 | <varlistentry>
|
|---|
| 109 | <term><option>--options keepallmacs | keepnatmacs | keepdisknames | importtovdi</option></term>
|
|---|
| 110 | <listitem><para>
|
|---|
| 111 | Enables you to fine tune the import operation.
|
|---|
| 112 | </para><para>
|
|---|
| 113 | Valid arguments are as follows:
|
|---|
| 114 | </para><itemizedlist>
|
|---|
| 115 | <listitem><para>
|
|---|
| 116 | <literal>keepallmacs</literal>: Specifies that the MAC
|
|---|
| 117 | addresses of every virtual network card are left
|
|---|
| 118 | unchanged.
|
|---|
| 119 | </para></listitem>
|
|---|
| 120 | <listitem><para>
|
|---|
| 121 | <literal>keepnatmacs</literal>: Specifies that the MAC
|
|---|
| 122 | addresses of every virtual network card are left
|
|---|
| 123 | unchanged if the network type is NAT.
|
|---|
| 124 | </para></listitem>
|
|---|
| 125 | <listitem><para>
|
|---|
| 126 | <literal>keepdisknames</literal>: Specifies that all
|
|---|
| 127 | new disk images are assigned the same names as the
|
|---|
| 128 | originals.
|
|---|
| 129 | </para></listitem>
|
|---|
| 130 | <listitem><para>
|
|---|
| 131 | <literal>importtovdi</literal>: Specifies that all new
|
|---|
| 132 | disk images are in VDI file format.
|
|---|
| 133 | </para></listitem>
|
|---|
| 134 | </itemizedlist></listitem>
|
|---|
| 135 | </varlistentry>
|
|---|
| 136 | </variablelist>
|
|---|
| 137 | </refsect2>
|
|---|
| 138 | </refsect1>
|
|---|
| 139 |
|
|---|
| 140 | <refsect1>
|
|---|
| 141 | <title>Examples</title>
|
|---|
| 142 | <remark role="help-scope" condition="GLOBAL"/>
|
|---|
| 143 | <para>
|
|---|
| 144 | The following example performs the dry run of an import operation
|
|---|
| 145 | for a sample appliance that contains a Windows 10 guest:
|
|---|
| 146 | </para>
|
|---|
| 147 | <screen>$ VBoxManage import Windows10.ovf --dry-run
|
|---|
| 148 | Interpreting Windows10.ovf...
|
|---|
| 149 | OK.
|
|---|
| 150 | Virtual system 0:
|
|---|
| 151 | 0: Suggested OS type: "Windows10_64"
|
|---|
| 152 | (change with "--vsys 0 --ostype <type>"; use "list ostypes" to list all)
|
|---|
| 153 | 1: Suggested VM name "win10-appliance"
|
|---|
| 154 | (change with "--vsys 0 --vmname <name>")
|
|---|
| 155 | 2: Suggested VM group "/"
|
|---|
| 156 | (change with "--vsys 0 --group <group>")
|
|---|
| 157 | 3: Suggested VM settings file name "/home/user1/VirtualBox VMs/win10-appliance/win10-appliance.vbox"
|
|---|
| 158 | (change with "--vsys 0 --settingsfile <filename>")
|
|---|
| 159 | 4: Suggested VM base folder "/home/user1/VirtualBox VMs"
|
|---|
| 160 | (change with "--vsys 0 --basefolder <path>")
|
|---|
| 161 | 5: End-user license agreement
|
|---|
| 162 | (display with "--vsys 0 --eula show";
|
|---|
| 163 | accept with "--vsys 0 --eula accept")
|
|---|
| 164 | 6: Number of CPUs: 1
|
|---|
| 165 | (change with "--vsys 0 --cpus <n>")
|
|---|
| 166 | 7: Guest memory: 1024 MB (change with "--vsys 0 --memory <MB>")
|
|---|
| 167 | 8: Sound card (appliance expects "ensoniq1371", can change on import)
|
|---|
| 168 | (disable with "--vsys 0 --unit 5 --ignore")
|
|---|
| 169 | 9: USB controller
|
|---|
| 170 | (disable with "--vsys 0 --unit 6 --ignore")
|
|---|
| 171 | 10: Network adapter: orig bridged, config 2, extra type=bridged
|
|---|
| 172 | 11: Floppy
|
|---|
| 173 | (disable with "--vsys 0 --unit 8 --ignore")
|
|---|
| 174 | 12: SCSI controller, type BusLogic
|
|---|
| 175 | (change with "--vsys 0 --unit 9 --scsitype {BusLogic|LsiLogic}";
|
|---|
| 176 | disable with "--vsys 0 --unit 9 --ignore")
|
|---|
| 177 | 13: IDE controller, type PIIX4
|
|---|
| 178 | (disable with "--vsys 0 --unit 10 --ignore")
|
|---|
| 179 | 14: Hard disk image: source image=Windows10.vmdk,
|
|---|
| 180 | target path=/home/user1/disks/Windows10.vmdk, controller=9;channel=0
|
|---|
| 181 | (change controller with "--vsys 0 --unit 11 --controller <id>";
|
|---|
| 182 | disable with "--vsys 0 --unit 11 --ignore")</screen>
|
|---|
| 183 | <para>
|
|---|
| 184 | The dry run output lists and numbers the individual configuration
|
|---|
| 185 | items that are described in the <filename>Windows10.ovf</filename>
|
|---|
| 186 | file. Some of the items include information about how to disable
|
|---|
| 187 | or change the configuration of the item.
|
|---|
| 188 | </para>
|
|---|
| 189 | <para>
|
|---|
| 190 | You can disable many of the items by using the <option>--vsys
|
|---|
| 191 | <replaceable>X</replaceable> --unit <replaceable>Y</replaceable>
|
|---|
| 192 | --ignore</option> options. <replaceable>X</replaceable> is the
|
|---|
| 193 | number of the virtual system. The value is <literal>0</literal>
|
|---|
| 194 | unless the appliance includes several virtual system descriptions.
|
|---|
| 195 | <replaceable>Y</replaceable> is the configuration item number.
|
|---|
| 196 | </para>
|
|---|
| 197 | <para>
|
|---|
| 198 | Item 1 in the example command output specifies the name of the
|
|---|
| 199 | target machine. Items 12 and 13 specify the IDE and SCSI hard disk
|
|---|
| 200 | controllers, respectively.
|
|---|
| 201 | </para>
|
|---|
| 202 | <para>
|
|---|
| 203 | Item 14 indicates the hard disk image and the
|
|---|
| 204 | <option>--controller</option> option specifies the device on which
|
|---|
| 205 | the image resides. The default value is specified in the OVF file.
|
|---|
| 206 | </para>
|
|---|
| 207 | <para>
|
|---|
| 208 | You can combine several items for the same virtual system by
|
|---|
| 209 | specifying the same value for the <option>--vsys</option> option.
|
|---|
| 210 | For example use the following command to import a machine as
|
|---|
| 211 | described in the OVF, exclude the sound card and USB controller
|
|---|
| 212 | and specify that the disk image is connected to the IDE controller
|
|---|
| 213 | instead of the SCSI controller.
|
|---|
| 214 | </para>
|
|---|
| 215 | <screen>$ VBoxManage import Windows10.ovf --vsys 0 --unit 8 --ignore \
|
|---|
| 216 | --unit 9 --ignore --unit 14 --controller 13</screen>
|
|---|
| 217 | </refsect1>
|
|---|
| 218 | </refentry>
|
|---|
