1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
2 | <!--
|
---|
3 | manpage, user manual, usage: VBoxManage export
|
---|
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-export" lang="en">
|
---|
32 | <refentryinfo>
|
---|
33 | <pubdate>$Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</pubdate>
|
---|
34 | <title>VBoxManage export</title>
|
---|
35 | </refentryinfo>
|
---|
36 |
|
---|
37 | <refmeta>
|
---|
38 | <refentrytitle>VBoxManage-export</refentrytitle>
|
---|
39 | <manvolnum>1</manvolnum>
|
---|
40 | </refmeta>
|
---|
41 |
|
---|
42 | <refnamediv>
|
---|
43 | <refname>VBoxManage-export</refname>
|
---|
44 | <refpurpose>export one or more virtual machines to a virtual appliance or to a cloud service</refpurpose>
|
---|
45 | <refclass>&product-name;</refclass>
|
---|
46 | </refnamediv>
|
---|
47 |
|
---|
48 | <refsynopsisdiv>
|
---|
49 | <cmdsynopsis id="synopsis-vboxmanage-export-ovf">
|
---|
50 | <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
---|
51 | <command>VBoxManage export</command>
|
---|
52 | <arg choice="req"><replaceable>machines</replaceable></arg>
|
---|
53 | <arg choice="req">--output=<replaceable>name</replaceable></arg>
|
---|
54 | <group>
|
---|
55 | <arg choice="plain">--legacy09</arg>
|
---|
56 | <arg choice="plain">--ovf09</arg>
|
---|
57 | <arg choice="plain">--ovf10</arg>
|
---|
58 | <arg choice="plain">--ovf20</arg>
|
---|
59 | </group>
|
---|
60 | <arg>--manifest</arg>
|
---|
61 | <arg rep="repeat">--options=<group choice="plain"> <!-- group can be repeated with comma separator - hard to do in docbook. -->
|
---|
62 | <arg choice="plain">manifest</arg>
|
---|
63 | <arg choice="plain">iso</arg>
|
---|
64 | <arg choice="plain">nomacs</arg>
|
---|
65 | <arg choice="plain">nomacsbutnat</arg>
|
---|
66 | </group></arg>
|
---|
67 | <arg>--vsys=<replaceable>virtual-system-number</replaceable></arg>
|
---|
68 | <arg>--description=<replaceable>description-info</replaceable></arg>
|
---|
69 | <arg>--eula=<replaceable>license-text</replaceable></arg>
|
---|
70 | <arg>--eulafile=<replaceable>filename</replaceable></arg>
|
---|
71 | <arg>--product=<replaceable>product-name</replaceable></arg>
|
---|
72 | <arg>--producturl=<replaceable>product-URL</replaceable></arg>
|
---|
73 | <arg>--vendor=<replaceable>vendor-name</replaceable></arg>
|
---|
74 | <arg>--vendorurl=<replaceable>vendor-URL</replaceable></arg>
|
---|
75 | <arg>--version=<replaceable>version-info</replaceable></arg>
|
---|
76 | <arg>--vmname=<replaceable>vmname</replaceable></arg>
|
---|
77 | </cmdsynopsis>
|
---|
78 |
|
---|
79 | <cmdsynopsis id="synopsis-vboxmanage-export-cloud">
|
---|
80 | <command>VBoxManage export</command>
|
---|
81 | <arg choice="req"><replaceable>machine</replaceable></arg>
|
---|
82 | <arg choice="req">--output=<replaceable>cloud-service-provider</replaceable></arg>
|
---|
83 | <arg>--opc10</arg>
|
---|
84 | <arg>--vmname=<replaceable>vmname</replaceable></arg>
|
---|
85 | <arg>--cloud=<replaceable>virtual-system-number</replaceable></arg>
|
---|
86 | <arg>--cloudprofile=<replaceable>cloud-profile-name</replaceable></arg>
|
---|
87 | <arg>--cloudshape=<replaceable>cloud-shape-name</replaceable></arg>
|
---|
88 | <arg>--clouddomain=<replaceable>cloud-domain</replaceable></arg>
|
---|
89 | <arg>--clouddisksize=<replaceable>disk-size-in-GB</replaceable></arg>
|
---|
90 | <arg>--cloudbucket=<replaceable>bucket-name</replaceable></arg>
|
---|
91 | <arg>--cloudocivcn=<replaceable>OCI-VCN-ID</replaceable></arg>
|
---|
92 | <arg>--cloudocisubnet=<replaceable>OCI-subnet-ID</replaceable></arg>
|
---|
93 | <arg>--cloudkeepobject=<group choice="plain">
|
---|
94 | <arg choice="plain">true</arg>
|
---|
95 | <arg choice="plain">false</arg>
|
---|
96 | </group></arg>
|
---|
97 | <arg>--cloudlaunchinstance=<group choice="plain">
|
---|
98 | <arg choice="plain">true</arg>
|
---|
99 | <arg choice="plain">false</arg>
|
---|
100 | </group></arg>
|
---|
101 | <arg>--cloudlaunchmode=<group choice="plain">
|
---|
102 | <arg choice="plain">EMULATED</arg>
|
---|
103 | <arg choice="plain">PARAVIRTUALIZED</arg>
|
---|
104 | </group></arg>
|
---|
105 | <arg>--cloudpublicip=<group choice="plain">
|
---|
106 | <arg choice="plain">true</arg>
|
---|
107 | <arg choice="plain">false</arg>
|
---|
108 | </group></arg>
|
---|
109 | </cmdsynopsis>
|
---|
110 | </refsynopsisdiv>
|
---|
111 |
|
---|
112 | <refsect1 id="vboxmanage-export-description">
|
---|
113 | <title>Description</title>
|
---|
114 | <para>
|
---|
115 | The <command>VBoxManage export</command> command enables you to
|
---|
116 | export one or more virtual machines (VMs) from &product-name;. You
|
---|
117 | can export the VM to one of the following:
|
---|
118 | </para>
|
---|
119 | <itemizedlist>
|
---|
120 | <listitem><para>
|
---|
121 | <emphasis role="bold">Virtual appliance in OVF
|
---|
122 | format.</emphasis> Includes the copying of its virtual disk
|
---|
123 | images to compressed VMDK.
|
---|
124 | </para></listitem>
|
---|
125 | <listitem><para>
|
---|
126 | <emphasis role="bold">Cloud service such as &oci;.</emphasis>
|
---|
127 | Exports a single VM.
|
---|
128 | </para></listitem>
|
---|
129 | </itemizedlist>
|
---|
130 | <para>
|
---|
131 | For more information about exporting VMs from &product-name;, see
|
---|
132 | <xref linkend="ovf" />
|
---|
133 | </para>
|
---|
134 | <refsect2 id="vboxmanage-export-ovf">
|
---|
135 | <title>Export a Virtual Machine to an OVF Virtual Appliance</title>
|
---|
136 | <remark role="help-copy-synopsis"/>
|
---|
137 | <para>
|
---|
138 | The <command>VBoxManage export</command> command enables you to
|
---|
139 | export a VM as a virtual appliance in OVF format.
|
---|
140 | </para>
|
---|
141 | <variablelist>
|
---|
142 | <varlistentry>
|
---|
143 | <term><replaceable>machines</replaceable></term>
|
---|
144 | <listitem><para>
|
---|
145 | Specifies a comma-separated list of one or more machines
|
---|
146 | to export to the same OVF file.
|
---|
147 | </para></listitem>
|
---|
148 | </varlistentry>
|
---|
149 | <varlistentry>
|
---|
150 | <term><option>--output=<replaceable>filename</replaceable></option></term>
|
---|
151 | <listitem><para>
|
---|
152 | Specifies the target OVF file. The file can be OVF, OVA,
|
---|
153 | or a ZIP file compressed with the <command>gzip</command>
|
---|
154 | command. Because the directory that contains the target
|
---|
155 | OVF file will also store the exported disk images in the
|
---|
156 | compressed VMDK format, ensure that this directory has
|
---|
157 | sufficient disk space in which to store the images.
|
---|
158 | </para><para>
|
---|
159 | The short form of this option is <option>-o</option>.
|
---|
160 | </para></listitem>
|
---|
161 | </varlistentry>
|
---|
162 | <varlistentry>
|
---|
163 | <term><option>--legacy09</option></term>
|
---|
164 | <listitem><para>
|
---|
165 | Exports in OVF 0.9 legacy mode if the virtualization
|
---|
166 | product is not fully compatible with the OVF 1.0 standard.
|
---|
167 | </para></listitem>
|
---|
168 | </varlistentry>
|
---|
169 | <varlistentry>
|
---|
170 | <term><option>--ovf09</option></term>
|
---|
171 | <listitem><para>
|
---|
172 | Exports in OVF 0.9 format.
|
---|
173 | </para></listitem>
|
---|
174 | </varlistentry>
|
---|
175 | <varlistentry>
|
---|
176 | <term><option>--ovf10</option></term>
|
---|
177 | <listitem><para>
|
---|
178 | Exports in OVF 1.0 format.
|
---|
179 | </para></listitem>
|
---|
180 | </varlistentry>
|
---|
181 | <varlistentry>
|
---|
182 | <term><option>--ovf20</option></term>
|
---|
183 | <listitem><para>
|
---|
184 | Exports in OVF 2.0 format.
|
---|
185 | </para></listitem>
|
---|
186 | </varlistentry>
|
---|
187 | <varlistentry>
|
---|
188 | <term><option>--manifest</option></term>
|
---|
189 | <listitem><para>
|
---|
190 | Creates a manifest of the exported files.
|
---|
191 | </para></listitem>
|
---|
192 | </varlistentry>
|
---|
193 | <varlistentry>
|
---|
194 | <term><option>--options=<replaceable>argument</replaceable>,...</option></term>
|
---|
195 | <listitem><para>
|
---|
196 | Specifies information to control the exact content of the
|
---|
197 | appliance file. Specify one or more comma-separated
|
---|
198 | arguments:
|
---|
199 | </para><variablelist>
|
---|
200 | <varlistentry>
|
---|
201 | <term><literal>manifest</literal></term>
|
---|
202 | <listitem><para>
|
---|
203 | Produces a manifest file that detects corrupted
|
---|
204 | appliances on import.
|
---|
205 | </para></listitem>
|
---|
206 | </varlistentry>
|
---|
207 | <varlistentry>
|
---|
208 | <term><literal>iso</literal></term>
|
---|
209 | <listitem><para>
|
---|
210 | Exports DVD images in an ISO file.
|
---|
211 | </para></listitem>
|
---|
212 | </varlistentry>
|
---|
213 | <varlistentry>
|
---|
214 | <term><literal>nomacs</literal></term>
|
---|
215 | <listitem><para>
|
---|
216 | Excludes all MAC addresses.
|
---|
217 | </para></listitem>
|
---|
218 | </varlistentry>
|
---|
219 | <varlistentry>
|
---|
220 | <term><literal>nomacsbutnat</literal></term>
|
---|
221 | <listitem><para>
|
---|
222 | Excludes all MAC addresses except for those in a NAT
|
---|
223 | network.
|
---|
224 | </para></listitem>
|
---|
225 | </varlistentry>
|
---|
226 | </variablelist></listitem>
|
---|
227 | </varlistentry>
|
---|
228 | <varlistentry>
|
---|
229 | <term><option>--description=<replaceable>description-info</replaceable></option></term>
|
---|
230 | <listitem><para>
|
---|
231 | Specifies a description of the VM.
|
---|
232 | </para></listitem>
|
---|
233 | </varlistentry>
|
---|
234 | <varlistentry>
|
---|
235 | <term><option>--eula=<replaceable>license-text</replaceable></option></term>
|
---|
236 | <listitem><para>
|
---|
237 | Specifies end-user license text.
|
---|
238 | </para></listitem>
|
---|
239 | </varlistentry>
|
---|
240 | <varlistentry>
|
---|
241 | <term><option>--eulafile=<replaceable>filename</replaceable></option></term>
|
---|
242 | <listitem><para>
|
---|
243 | Specifies an end-user license file.
|
---|
244 | </para></listitem>
|
---|
245 | </varlistentry>
|
---|
246 | <varlistentry>
|
---|
247 | <term><option>--product=<replaceable>product-name</replaceable></option></term>
|
---|
248 | <listitem><para>
|
---|
249 | Specifies a product name.
|
---|
250 | </para></listitem>
|
---|
251 | </varlistentry>
|
---|
252 | <varlistentry>
|
---|
253 | <term><option>--producturl=<replaceable>product-URL</replaceable></option></term>
|
---|
254 | <listitem><para>
|
---|
255 | Specifies a product URL.
|
---|
256 | </para></listitem>
|
---|
257 | </varlistentry>
|
---|
258 | <varlistentry>
|
---|
259 | <term><option>--vendor=<replaceable>vendor-name</replaceable></option></term>
|
---|
260 | <listitem><para>
|
---|
261 | Specifies a vendor name.
|
---|
262 | </para></listitem>
|
---|
263 | </varlistentry>
|
---|
264 | <varlistentry>
|
---|
265 | <term><option>--vendorurl=<replaceable>vendor-URL</replaceable></option></term>
|
---|
266 | <listitem><para>
|
---|
267 | Specifies a vendor URL.
|
---|
268 | </para></listitem>
|
---|
269 | </varlistentry>
|
---|
270 | <varlistentry>
|
---|
271 | <term><option>--version=<replaceable>version-info</replaceable></option></term>
|
---|
272 | <listitem><para>
|
---|
273 | Specifies version information.
|
---|
274 | </para></listitem>
|
---|
275 | </varlistentry>
|
---|
276 | <varlistentry>
|
---|
277 | <term><option>--vmname=<replaceable>vmname</replaceable></option></term>
|
---|
278 | <listitem><para>
|
---|
279 | Specifies the name of the exported VM.
|
---|
280 | </para></listitem>
|
---|
281 | </varlistentry>
|
---|
282 | <varlistentry>
|
---|
283 | <term><option>--vsys=<replaceable>virtual-system-number</replaceable></option></term>
|
---|
284 | <listitem><para>
|
---|
285 | Specifies the number of the virtual system.
|
---|
286 | </para></listitem>
|
---|
287 | </varlistentry>
|
---|
288 | </variablelist>
|
---|
289 | </refsect2>
|
---|
290 | <refsect2 id="vboxmanage-export-cloud">
|
---|
291 | <title>Export a Virtual Machine to &oci;</title>
|
---|
292 | <remark role="help-copy-synopsis"/>
|
---|
293 | <para>
|
---|
294 | The <command>VBoxManage export</command> command enables you to
|
---|
295 | export a VM to a cloud service provider such as &oci;. By
|
---|
296 | default, the exported disk image is converted into compressed VMDK
|
---|
297 | format. This minimizes the amount of data to transfer to the cloud
|
---|
298 | service.
|
---|
299 | </para>
|
---|
300 | <para>
|
---|
301 | Some of the following options are configuration settings for the
|
---|
302 | VM instance. As a result, specify an Oracle Cloud Identifier
|
---|
303 | (OCID) for a resource. Use the &oci; Console to view OCIDs.
|
---|
304 | </para>
|
---|
305 | <variablelist>
|
---|
306 | <varlistentry>
|
---|
307 | <term><option>--output=<replaceable>cloud-service-provider</replaceable></option></term>
|
---|
308 | <listitem><para>
|
---|
309 | Specifies the short name of the cloud service provider to
|
---|
310 | which you export the VM. For &oci;, specify
|
---|
311 | <literal>OCI://</literal>.
|
---|
312 | </para><para>
|
---|
313 | The short form of this option is <option>-o</option>.
|
---|
314 | </para></listitem>
|
---|
315 | </varlistentry>
|
---|
316 | <varlistentry>
|
---|
317 | <term><option>--opc10</option></term>
|
---|
318 | <listitem><para>
|
---|
319 | Exports in &oci; format.
|
---|
320 | </para></listitem>
|
---|
321 | </varlistentry>
|
---|
322 | <varlistentry>
|
---|
323 | <term><option>--cloud=<replaceable>number-of-virtual-system</replaceable></option></term>
|
---|
324 | <listitem><para>
|
---|
325 | Specifies a number that identifies the VM to export.
|
---|
326 | Numbering starts at <literal>0</literal> for the first VM.
|
---|
327 | </para></listitem>
|
---|
328 | </varlistentry>
|
---|
329 | <varlistentry>
|
---|
330 | <term><option>--vmname=<replaceable>vmname</replaceable></option></term>
|
---|
331 | <listitem><para>
|
---|
332 | Specifies the name of the exported VM, which is used as
|
---|
333 | the VM instance name in &oci;.
|
---|
334 | </para></listitem>
|
---|
335 | </varlistentry>
|
---|
336 | <varlistentry>
|
---|
337 | <term><option>--cloudprofile=<replaceable>cloud-profile-name</replaceable></option></term>
|
---|
338 | <listitem><para>
|
---|
339 | Specifies the cloud profile to use to connect to the cloud
|
---|
340 | service provider. The cloud profile contains your &oci;
|
---|
341 | account details, such as your user OCID and the
|
---|
342 | fingerprint for your public key.
|
---|
343 | </para><para>
|
---|
344 | To use a cloud profile, you must have the required
|
---|
345 | permissions on &oci;.
|
---|
346 | </para></listitem>
|
---|
347 | </varlistentry>
|
---|
348 | <varlistentry>
|
---|
349 | <term><option>--cloudshape=<replaceable>cloud-shape-name</replaceable></option></term>
|
---|
350 | <listitem><para>
|
---|
351 | Specifies the shape used by the VM instance. The shape
|
---|
352 | defines the number of CPUs and the amount of memory that
|
---|
353 | is allocated to the VM instance. Ensure that the shape is
|
---|
354 | compatible with the exported image.
|
---|
355 | </para></listitem>
|
---|
356 | </varlistentry>
|
---|
357 | <varlistentry>
|
---|
358 | <term><option>--clouddomain=<replaceable>cloud-domain</replaceable></option></term>
|
---|
359 | <listitem><para>
|
---|
360 | Specifies the availability domain to use for the VM
|
---|
361 | instance. Enter the full name of the availability domain.
|
---|
362 | </para></listitem>
|
---|
363 | </varlistentry>
|
---|
364 | <varlistentry>
|
---|
365 | <term><option>--clouddisksize=<replaceable>disk-size-in-GB</replaceable></option></term>
|
---|
366 | <listitem><para>
|
---|
367 | Specifies the amount of disk space, in gigabytes, to use
|
---|
368 | for the exported disk image. Valid values are from 50 GB
|
---|
369 | to 300 GB.
|
---|
370 | </para></listitem>
|
---|
371 | </varlistentry>
|
---|
372 | <varlistentry>
|
---|
373 | <term><option>--cloudbucket=<replaceable>bucket-name</replaceable></option></term>
|
---|
374 | <listitem><para>
|
---|
375 | Specifies the bucket in which to store uploaded files. In
|
---|
376 | &oci;, a bucket is a logical container for storing
|
---|
377 | objects.
|
---|
378 | </para></listitem>
|
---|
379 | </varlistentry>
|
---|
380 | <varlistentry>
|
---|
381 | <term><option>--cloudocivcn=<replaceable>OCI-VCN-ID</replaceable></option></term>
|
---|
382 | <listitem><para>
|
---|
383 | Specifies the OCID of the virtual cloud network (VCN) to
|
---|
384 | use for the VM instance.
|
---|
385 | </para></listitem>
|
---|
386 | </varlistentry>
|
---|
387 | <varlistentry>
|
---|
388 | <term><option>--cloudocisubnet=<replaceable>OCI-subnet-ID</replaceable></option></term>
|
---|
389 | <listitem><para>
|
---|
390 | Specifies the OCID of the VCN subnet to use for the VM
|
---|
391 | instance.
|
---|
392 | </para></listitem>
|
---|
393 | </varlistentry>
|
---|
394 | <varlistentry>
|
---|
395 | <term><option>--cloudkeepobject=true | false</option></term>
|
---|
396 | <listitem><para>
|
---|
397 | Specifies whether to store the exported disk image in
|
---|
398 | Oracle Object Storage.
|
---|
399 | </para></listitem>
|
---|
400 | </varlistentry>
|
---|
401 | <varlistentry>
|
---|
402 | <term><option>--cloudlaunchinstance=true | false</option></term>
|
---|
403 | <listitem><para>
|
---|
404 | Specifies whether to start the VM instance after the
|
---|
405 | export to &oci; completes.
|
---|
406 | </para></listitem>
|
---|
407 | </varlistentry>
|
---|
408 | <varlistentry>
|
---|
409 | <term><option>--cloudlaunchinstance=EMULATED | PARAVIRTUALIZED</option></term>
|
---|
410 | <listitem><para>
|
---|
411 | Specifies the launch mode used for the instance.
|
---|
412 | Paravirtualized mode gives improved performance.
|
---|
413 | </para></listitem>
|
---|
414 | </varlistentry>
|
---|
415 | <varlistentry>
|
---|
416 | <term><option>--cloudpublicip=true | false</option></term>
|
---|
417 | <listitem><para>
|
---|
418 | Specifies whether to enable a public IP address for the VM
|
---|
419 | instance.
|
---|
420 | </para></listitem>
|
---|
421 | </varlistentry>
|
---|
422 | </variablelist>
|
---|
423 | </refsect2>
|
---|
424 | </refsect1>
|
---|
425 |
|
---|
426 | <refsect1 id="vboxmanage-export-examples">
|
---|
427 | <title>Example</title>
|
---|
428 | <remark role="help-scope" condition="GLOBAL"/>
|
---|
429 | <para>
|
---|
430 | The following example shows how to export the
|
---|
431 | <literal>myVM</literal> VM to &oci;. The command's option
|
---|
432 | arguments describe the configuration of the
|
---|
433 | <literal>myVM_Cloud</literal> VM in &oci;.
|
---|
434 | </para>
|
---|
435 | <screen># VBoxManage export myVM --output=OCI:// --cloud=0 --vmname=myVM_Cloud \
|
---|
436 | --cloudprofile="standard user" --cloudbucket=myBucket \
|
---|
437 | --cloudshape=VM.Standard2.1 --clouddomain=US-ASHBURN-AD-1 --clouddisksize=50 \
|
---|
438 | --cloudocivcn=ocid1.vcn.oc1.iad.aaaa... --cloudocisubnet=ocid1.subnet.oc1.iad.aaaa... \
|
---|
439 | --cloudkeepobject=true --cloudlaunchinstance=true --cloudpublicip=true</screen>
|
---|
440 | </refsect1>
|
---|
441 | </refentry>
|
---|