VirtualBox

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-export.xml@ 93707

Last change on this file since 93707 was 93707, checked in by vboxsync, 3 years ago

doc/manual: Some metadata cleanup and a bit of consistency.

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