VirtualBox

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

Last change on this file since 91099 was 87075, checked in by vboxsync, 4 years ago

doc/manual: whitespace fixing in man pages

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