VirtualBox

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-cloud.xml@ 98785

Last change on this file since 98785 was 98785, checked in by vboxsync, 21 months ago

bugref:10365. Added VBoxManage CLI documentation for the command 'reset'.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 29.7 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage cloud
4-->
5<!--
6 Copyright (C) 2018-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-cloud" lang="en">
32 <refentryinfo>
33 <pubdate>$Date: 2023-02-28 15:31:44 +0000 (Tue, 28 Feb 2023) $</pubdate>
34 <title>VBoxManage cloud</title>
35 </refentryinfo>
36
37 <refmeta>
38 <refentrytitle>VBoxManage-cloud</refentrytitle>
39 <manvolnum>1</manvolnum>
40 <refmiscinfo class="manual">&product-name;</refmiscinfo>
41 </refmeta>
42
43 <refnamediv>
44 <refname>VBoxManage-cloud</refname>
45 <refpurpose>Manage the cloud entities</refpurpose>
46 <refclass>&product-name;</refclass>
47 </refnamediv>
48
49 <refsynopsisdiv>
50 <!-- Cloud list -->
51 <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
52 <cmdsynopsis id="synopsis-vboxmanage-cloudlist-instances">
53 <command>VBoxManage cloud</command>
54 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
55 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
56 <sbr/>
57 <arg choice="plain">list</arg>
58 <arg choice="plain">instances</arg>
59 <arg>--state=<replaceable>string</replaceable></arg>
60 <arg>--compartment-id=<replaceable>string</replaceable></arg>
61 </cmdsynopsis>
62 <cmdsynopsis id="synopsis-vboxmanage-cloudlist-images">
63 <command>VBoxManage cloud</command>
64 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
65 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
66 <sbr/>
67 <arg choice="plain">list</arg>
68 <arg choice="plain">images</arg>
69 <arg choice="req">--compartment-id=<replaceable>string</replaceable></arg>
70 <arg>--state=<replaceable>string</replaceable></arg>
71 </cmdsynopsis>
72
73 <!-- Cloud instance commands -->
74 <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-create" sepchar=" ">
75 <command moreinfo="none">VBoxManage cloud</command>
76 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
77 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
78 <sbr/>
79 <arg choice="plain">instance</arg>
80 <arg choice="plain">create</arg>
81 <arg choice="req">--domain-name=<replaceable>name</replaceable></arg>
82 <group choice="req">
83 <arg choice="req">--image-id=<replaceable>id</replaceable></arg>
84 <arg choice="req">--boot-volume-id=<replaceable>id</replaceable></arg>
85 </group>
86 <arg choice="req">--display-name=<replaceable>name</replaceable></arg>
87 <arg choice="req">--shape=<replaceable>type</replaceable></arg>
88 <arg choice="req">--subnet=<replaceable>id</replaceable></arg>
89 <arg>--boot-disk-size=<replaceable>size in GB</replaceable></arg>
90 <arg>--publicip=<replaceable>true/false</replaceable></arg>
91 <arg>--privateip=<replaceable>IP address</replaceable></arg>
92 <arg rep="repeat">--public-ssh-key=<replaceable>key string</replaceable></arg>
93 <arg>--launch-mode=<replaceable>NATIVE/EMULATED/PARAVIRTUALIZED</replaceable></arg>
94 <arg>--cloud-init-script-path=<replaceable>path to a script</replaceable></arg>
95 </cmdsynopsis>
96 <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-info" sepchar=" ">
97 <command moreinfo="none">VBoxManage cloud</command>
98 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
99 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
100 <sbr/>
101 <arg choice="plain">instance</arg>
102 <arg choice="plain">info</arg>
103 <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
104 </cmdsynopsis>
105 <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-terminate" sepchar=" ">
106 <command moreinfo="none">VBoxManage cloud</command>
107 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
108 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
109 <sbr/>
110 <arg choice="plain">instance</arg>
111 <arg choice="plain">terminate</arg>
112 <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
113 </cmdsynopsis>
114 <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-start" sepchar=" ">
115 <command moreinfo="none">VBoxManage cloud</command>
116 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
117 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
118 <sbr/>
119 <arg choice="plain">instance</arg>
120 <arg choice="plain">start</arg>
121 <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
122 </cmdsynopsis>
123 <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-pause" sepchar=" ">
124 <command moreinfo="none">VBoxManage cloud</command>
125 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
126 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
127 <sbr/>
128 <arg choice="plain">instance</arg>
129 <arg choice="plain">pause</arg>
130 <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
131 </cmdsynopsis>
132 <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-reset" sepchar=" ">
133 <command moreinfo="none">VBoxManage cloud</command>
134 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
135 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
136 <sbr/>
137 <arg choice="plain">instance</arg>
138 <arg choice="plain">reset</arg>
139 <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
140 </cmdsynopsis>
141
142 <!-- Cloud image commands -->
143 <cmdsynopsis id="synopsis-vboxmanage-cloudimage-create" sepchar=" "> <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
144 <command>VBoxManage cloud</command>
145 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
146 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
147 <sbr/>
148 <arg choice="plain">image</arg>
149 <arg choice="plain">create</arg>
150 <arg choice="req">--display-name=<replaceable>name</replaceable></arg>
151 <arg>--bucket-name=<replaceable>name</replaceable></arg>
152 <arg>--object-name=<replaceable>name</replaceable></arg>
153 <arg>--instance-id=<replaceable>unique id</replaceable></arg>
154 </cmdsynopsis>
155 <cmdsynopsis id="synopsis-vboxmanage-cloudimage-info" sepchar=" ">
156 <command>VBoxManage cloud</command>
157 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
158 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
159 <sbr/>
160 <arg choice="plain">image</arg>
161 <arg choice="plain">info</arg>
162 <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
163 </cmdsynopsis>
164 <cmdsynopsis id="synopsis-vboxmanage-cloudimage-delete" sepchar=" ">
165 <command>VBoxManage cloud</command>
166 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
167 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
168 <sbr/>
169 <arg choice="plain">image</arg>
170 <arg choice="plain">delete</arg>
171 <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
172 </cmdsynopsis>
173 <cmdsynopsis id="synopsis-vboxmanage-cloudimage-import" sepchar=" ">
174 <command>VBoxManage cloud</command>
175 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
176 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
177 <sbr/>
178 <arg choice="plain">image</arg>
179 <arg choice="plain">import</arg>
180 <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
181 <arg>--bucket-name=<replaceable>name</replaceable></arg>
182 <arg>--object-name=<replaceable>name</replaceable></arg>
183 </cmdsynopsis>
184 <cmdsynopsis id="synopsis-vboxmanage-cloudimage-export" sepchar=" ">
185 <command>VBoxManage cloud</command>
186 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
187 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
188 <sbr/>
189 <arg choice="plain">image</arg>
190 <arg choice="plain">export</arg>
191 <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
192 <arg choice="req">--display-name=<replaceable>name</replaceable></arg>
193 <arg>--bucket-name=<replaceable>name</replaceable></arg>
194 <arg>--object-name=<replaceable>name</replaceable></arg>
195 </cmdsynopsis>
196
197 <!-- Cloud network commands -->
198 <cmdsynopsis id="synopsis-vboxmanage-cloud-network-setup"> <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
199 <command>VBoxManage cloud</command>
200 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
201 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
202 <sbr/>
203 <arg choice="plain">network setup</arg>
204 <arg>--gateway-os-name=<replaceable>string</replaceable></arg>
205 <arg>--gateway-os-version=<replaceable>string</replaceable></arg>
206 <arg>--gateway-shape=<replaceable>string</replaceable></arg>
207 <arg>--tunnel-network-name=<replaceable>string</replaceable></arg>
208 <arg>--tunnel-network-range=<replaceable>string</replaceable></arg>
209 <arg>--proxy=<replaceable>string</replaceable></arg>
210 <arg>--compartment-id=<replaceable>string</replaceable></arg>
211 </cmdsynopsis>
212 <cmdsynopsis id="synopsis-vboxmanage-cloud-network-create">
213 <command>VBoxManage cloud</command>
214 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
215 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
216 <sbr/>
217 <arg choice="plain">network create</arg>
218 <arg choice="req">--name=<replaceable>string</replaceable></arg>
219 <arg choice="req">--network-id=<replaceable>string</replaceable></arg>
220 <group>
221 <arg choice="plain">--enable</arg>
222 <arg choice="plain">--disable</arg>
223 </group>
224 </cmdsynopsis>
225 <cmdsynopsis id="synopsis-vboxmanage-cloud-network-update">
226 <command>VBoxManage cloud network update</command>
227 <arg choice="req">--name=<replaceable>string</replaceable></arg>
228 <arg>--network-id=<replaceable>string</replaceable></arg>
229 <group>
230 <arg choice="plain">--enable</arg>
231 <arg choice="plain">--disable</arg>
232 </group>
233 </cmdsynopsis>
234 <cmdsynopsis id="synopsis-vboxmanage-cloud-network-delete">
235 <command>VBoxManage cloud</command>
236 <arg choice="plain">network delete</arg>
237 <arg choice="req">--name=<replaceable>string</replaceable></arg>
238 </cmdsynopsis>
239 <cmdsynopsis id="synopsis-vboxmanage-cloud-network-info">
240 <command>VBoxManage cloud</command>
241 <arg choice="plain">network info</arg>
242 <arg choice="req">--name=<replaceable>string</replaceable></arg>
243 </cmdsynopsis>
244 </refsynopsisdiv>
245
246 <refsect1>
247 <title>Description</title>
248
249 <!-- Cloud commands common options -->
250 <refsect2 id="vboxmanage-cloud-common-options">
251 <title>Common options</title>
252 <remark role="help-scope" condition="GLOBAL"/>
253 <para>The word "cloud" is an umbrella for all commands related to the interconnection with the Cloud.
254 The next common options must be placed between the "cloud" and the following sub-commands:</para>
255 <variablelist>
256 <varlistentry>
257 <term>--provider=<replaceable>name</replaceable></term>
258 <listitem><para>Short cloud provider name.</para></listitem>
259 </varlistentry>
260 <varlistentry>
261 <term>--profile=<replaceable>name</replaceable></term>
262 <listitem><para>Cloud profile name. </para></listitem>
263 </varlistentry>
264 </variablelist>
265 </refsect2>
266
267 <!-- Cloud list commands -->
268 <refsect2 id="vboxmanage-cloudlist-instances">
269 <title>cloud list instances</title>
270 <remark role="help-copy-synopsis"/>
271 <para>
272 Displays the list of the instances for a specified compartment.
273 </para>
274 <variablelist>
275 <varlistentry>
276 <term>--state<replaceable>"running/paused/terminated"</replaceable></term>
277 <listitem>
278 <para>The state of cloud instance. The possible states are "running/paused/terminated" at moment.
279 If the state isn't provided the list of instances with all possible states is returned.
280 </para>
281 </listitem>
282 </varlistentry>
283 <varlistentry>
284 <term><option>--compartment-id</option></term>
285 <listitem>
286 <para>A compartment is the logical container used to organize and isolate cloud resources.
287 The different cloud providers can have the different names for this entity.
288 </para>
289 </listitem>
290 </varlistentry>
291 </variablelist>
292 </refsect2>
293
294 <refsect2 id="vboxmanage-cloudlist-images">
295 <title>cloud list images</title>
296 <remark role="help-copy-synopsis"/>
297 <para>
298 Displays the list of the images for a specified compartment.
299 </para>
300 <variablelist>
301 <varlistentry>
302 <term>--state<replaceable>"available/disabled/deleted"</replaceable></term>
303 <listitem>
304 <para>The state of cloud image. The possible states are "available/disabled/deleted" at moment.
305 If the state isn't provided the list of images with all possible states is returned.
306 </para>
307 </listitem>
308 </varlistentry>
309 <varlistentry>
310 <term><option>--compartment-id</option></term>
311 <listitem>
312 <para>A compartment is the logical container used to organize and isolate cloud resources.
313 The different cloud providers can have the different names for this entity.
314 </para>
315 </listitem>
316 </varlistentry>
317 </variablelist>
318 </refsect2>
319
320 <!-- Cloud instance commands -->
321 <refsect2 id="vboxmanage-cloudinstance-create">
322 <title>cloud instance create</title>
323 <remark role="help-copy-synopsis"/>
324 <para>
325 Creates new instance in the Cloud.
326 There are two standard ways to create an instance in the Cloud:
327 1. Create an instance from an existing custom image.
328 2. Create an instance from an existing bootable volume. This bootable volume shouldn't be attached to any instance.
329 For the 1st approach next parameters are required: image-id, boot-disk-size.
330 For the 2nd approach next parameters are required: boot-volume-id.
331 The rest parameters are common for both cases:
332 display-name, launch-mode, subnet-id, publicIP, privateIP, shape, domain.
333 </para>
334 <variablelist>
335 <varlistentry>
336 <term><option>--domain-name</option></term><listitem><para>Cloud domain where new instance is created.</para></listitem>
337 </varlistentry>
338 <varlistentry>
339 <term><option>--image-id</option></term><listitem><para>Unique identifier which fully identifies a custom image in the Cloud.</para></listitem>
340 </varlistentry>
341 <varlistentry>
342 <term><option>--boot-volume-id</option></term><listitem><para>Unique identifier which fully identifies a boot volume in the Cloud.</para></listitem>
343 </varlistentry>
344 <varlistentry>
345 <term><option>--display-name</option></term><listitem><para>Name for new instance in the Cloud.</para></listitem>
346 </varlistentry>
347 <varlistentry>
348 <term><option>--shape</option></term><listitem><para> The shape of instance, defines the number of CPUs and RAM memory.</para></listitem>
349 </varlistentry>
350 <varlistentry>
351 <term><option>--subnet</option></term><listitem><para> Unique identifier which fully identifies an existing subnet in the Cloud which will be used by the instance.</para></listitem>
352 </varlistentry>
353 <varlistentry>
354 <term><option>--boot-disk-size</option></term><listitem><para> The size of bootable image in GB. Default is 50GB.</para></listitem>
355 </varlistentry>
356 <varlistentry>
357 <term><option>--publicip</option></term><listitem><para>Whether the instance will have a public IP or not.</para></listitem>
358 </varlistentry>
359 <varlistentry>
360 <term><option>--privateip</option></term><listitem><para>Private IP address for the created instance.</para></listitem>
361 </varlistentry>
362 <varlistentry>
363 <term><option>--public-ssh-key</option></term>
364 <listitem>
365 <para>Public SSH key used to connect to the instance via SSH.
366 This parameter may be repeated if you plan to use more than one key as:
367 "--public-ssh-key=firstSSHKey --public-ssh-key=secondSSHKey".
368 </para>
369 </listitem>
370 </varlistentry>
371 <varlistentry>
372 <term><option>--launch-mode</option></term><listitem><para>The most known values here may be EMULATED, NATIVE, PARAVIRTUALIZED. </para></listitem>
373 </varlistentry>
374 <varlistentry>
375 <term><option>--cloud-init-script-path</option></term><listitem><para>Absolute path to the user cloud-init script.</para></listitem>
376 </varlistentry>
377 </variablelist>
378 </refsect2>
379
380 <refsect2 id="vboxmanage-cloudinstance-info">
381 <title>cloud instance info</title>
382 <para>
383 Display information about a cloud instance with a specified id.
384 </para>
385 <variablelist>
386 <varlistentry>
387 <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
388 </varlistentry>
389 </variablelist>
390 </refsect2>
391
392 <refsect2 id="vboxmanage-cloudinstance-terminate">
393 <title>cloud instance termination</title>
394 <para>
395 Delete a cloud instance with a specified id.
396 </para>
397 <variablelist>
398 <varlistentry>
399 <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
400 </varlistentry>
401 </variablelist>
402 </refsect2>
403
404 <refsect2 id="vboxmanage-cloudinstance-start">
405 <title>cloud instance start</title>
406 <para>
407 Start a cloud instance with a specified id.
408 </para>
409 <variablelist>
410 <varlistentry>
411 <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
412 </varlistentry>
413 </variablelist>
414 </refsect2>
415
416 <refsect2 id="vboxmanage-cloudinstance-pause">
417 <title>cloud instance pause</title>
418 <para>
419 Pause a cloud instance with a specified id.
420 </para>
421 <variablelist>
422 <varlistentry>
423 <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
424 </varlistentry>
425 </variablelist>
426 </refsect2>
427
428 <refsect2 id="vboxmanage-cloudinstance-reset">
429 <title>cloud instance reset</title>
430 <para>
431 Force reset a cloud instance with a specified id.
432 </para>
433 <variablelist>
434 <varlistentry>
435 <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
436 </varlistentry>
437 </variablelist>
438 </refsect2>
439
440 <!-- Cloud image commands -->
441 <refsect2 id="vboxmanage-cloudimage-create">
442 <title>cloud image create</title>
443 <remark role="help-copy-synopsis"/>
444 <para>
445 Creates new image in the Cloud.
446 There are two standard ways to create an image in the Cloud:
447 1. Create an image from an object in the Cloud Storage;
448 2. Create an image from an existing cloud instance.
449 For the 1st approach next parameters are required:
450 bucket-name - cloud bucket name where an object is located;
451 object-name - name of object in the bucket;
452 display-name - name for new image in the Cloud.
453 For the 2d approach next parameters are required:
454 instance-id - Id of instance in the Cloud;
455 display-name - name for new image in the Cloud.
456 </para>
457 <variablelist>
458 <varlistentry>
459 <term><option>--display-name</option></term><listitem><para>Name for new image in the Cloud.</para></listitem>
460 </varlistentry>
461 <varlistentry>
462 <term><option>--bucket-name</option></term><listitem><para>Cloud bucket name where an object is located.</para></listitem>
463 </varlistentry>
464 <varlistentry>
465 <term><option>--object-name</option></term><listitem><para>Name of object in the bucket.</para></listitem>
466 </varlistentry>
467 <varlistentry>
468 <term><option>--instance-id</option></term><listitem><para>Unique identifier which fully identifies the instance in the Cloud.</para></listitem>
469 </varlistentry>
470 </variablelist>
471 </refsect2>
472
473 <refsect2 id="vboxmanage-cloudimage-info">
474 <title>cloud image info</title>
475 <remark role="help-copy-synopsis"/>
476 <para>
477 Display information about a cloud image with a specified id.
478 </para>
479 <variablelist>
480 <varlistentry>
481 <term><option>--id</option></term><listitem><para>Unique identifier which fully identifies the image in the Cloud.</para></listitem>
482 </varlistentry>
483 </variablelist>
484 </refsect2>
485
486 <refsect2 id="vboxmanage-cloudimage-delete">
487 <title>cloud image delete</title>
488 <remark role="help-copy-synopsis"/>
489 <para>
490 Delete an image with a specified id from the Cloud.
491 </para>
492 <variablelist>
493 <varlistentry>
494 <term><option>--id</option></term><listitem><para>Unique identifier which fully identifies the image in the Cloud.</para></listitem>
495 </varlistentry>
496 </variablelist>
497 </refsect2>
498
499 <refsect2 id="vboxmanage-cloudimage-import">
500 <title>cloud image import</title>
501 <remark role="help-copy-synopsis"/>
502 <para>
503 Import an image with a specified id from the Cloud to a local host.
504 The result is an object in the local "temp" folder on the local host.
505 Possible approach may have two general steps:
506 1. Create an object from an image in the Cloud Storage;
507 2. Download the object to the local host.
508 So the next parameters may be required:
509 bucket-name - cloud bucket name where the object will be created;
510 object-name - name of object in the bucket. if parameter "object-name" is absent a displayed image name is used.
511 If the first step isn't needed only the parameter "id" is required.
512 </para>
513 <variablelist>
514 <varlistentry>
515 <term><option>--id</option></term><listitem><para>Unique identifier which fully identifies the image in the Cloud.</para></listitem>
516 </varlistentry>
517 <varlistentry>
518 <term><option>--bucket-name</option></term><listitem><para>Cloud bucket name where an object will be created.</para></listitem>
519 </varlistentry>
520 <varlistentry>
521 <term><option>--object-name</option></term>
522 <listitem>
523 <para>
524 Name of created object in the bucket. The downloaded object will have this name.
525 </para>
526 </listitem>
527 </varlistentry>
528 </variablelist>
529 </refsect2>
530
531 <refsect2 id="vboxmanage-cloudimage-export">
532 <title>cloud image export</title>
533 <remark role="help-copy-synopsis"/>
534 <para>
535 Export an existing VBox image with a specified uuid from a local host to the Cloud.
536 The result is new image in the Cloud.
537 Possible approach may have two general steps:
538 1. Upload VBox image to the Cloud Storage;
539 2. Create an image from the uploaded object.
540 So the next parameters may be required:
541 bucket-name -cloud bucket name where the object will be uploaded;
542 object-name - name of object in the bucket. If parameter "object-name" is absent the image id is used;
543 display-name - name for new image in the Cloud.
544 If the first step isn't needed the parameters "id" and "display-name" are required only.
545 </para>
546 <variablelist>
547 <varlistentry>
548 <term><option>--id</option></term><listitem><para>Unique identifier of the image in the VirtualBox.</para></listitem>
549 </varlistentry>
550 <varlistentry>
551 <term><option>--display-name</option></term><listitem><para>Name for new image in the Cloud.</para></listitem>
552 </varlistentry>
553 <varlistentry>
554 <term><option>--bucket-name</option></term><listitem><para>Cloud bucket name where the image (object) will be uploaded.</para></listitem>
555 </varlistentry>
556 <varlistentry>
557 <term><option>--object-name</option></term><listitem><para>Name of object in the bucket.</para></listitem>
558 </varlistentry>
559 </variablelist>
560 </refsect2>
561
562
563 <!-- Cloud network commands -->
564 <refsect2 id="vboxmanage-cloud-network-setup">
565 <title>cloud network setup</title>
566 <remark role="help-copy-synopsis"/>
567 <para>
568 Set up a cloud network environment for the specified cloud profile.
569 </para>
570 <variablelist>
571 <varlistentry>
572 <term><option>--gateway-os-name</option></term><listitem><para>The name of OS to use for a cloud gateway.</para></listitem>
573 </varlistentry>
574 <varlistentry>
575 <term><option>--gateway-os-version</option></term><listitem><para>The version of OS to use for a cloud gateway.</para></listitem>
576 </varlistentry>
577 <varlistentry>
578 <term><option>--gateway-shape</option></term><listitem><para>The instance shape to use for a cloud gateway. </para></listitem>
579 </varlistentry>
580 <varlistentry>
581 <term><option>--tunnel-network-name</option></term><listitem><para>The name of VCN/subnet to use for tunneling.</para></listitem>
582 </varlistentry>
583 <varlistentry>
584 <term><option>--tunnel-network-range</option></term><listitem><para>The IP address range to use for tunneling. </para></listitem>
585 </varlistentry>
586 <varlistentry>
587 <term><option>--proxy</option></term><listitem><para>The proxy URL to be used in local gateway installation.</para></listitem>
588 </varlistentry>
589 <varlistentry>
590 <term><option>--compartment-id</option></term><listitem><para>The compartment to create the tunnel network in.</para></listitem>
591 </varlistentry>
592 </variablelist>
593 </refsect2>
594
595 <refsect2 id="vboxmanage-cloud-network-create">
596 <title>cloud network create</title>
597 <remark role="help-copy-synopsis"/>
598 <para>
599 Create a new cloud network descriptor associated with an existing cloud subnet.
600 </para>
601 <variablelist>
602 <varlistentry>
603 <term><option>--name</option></term><listitem><para>The name to assign to the cloud network descriptor.</para></listitem>
604 </varlistentry>
605 <varlistentry>
606 <term><option>--network-id</option></term><listitem><para>The unique identifier of an existing subnet in the cloud.</para></listitem>
607 </varlistentry>
608 <varlistentry>
609 <term><option>--enable</option>, --disable</term>
610 <listitem><para>Whether to enable the network descriptor or disable it. If not specified,
611 the network will be enabled.</para></listitem>
612 </varlistentry>
613 </variablelist>
614 </refsect2>
615
616 <refsect2 id="vboxmanage-cloud-network-update">
617 <title>cloud network update</title>
618 <remark role="help-copy-synopsis"/>
619 <para>
620 Modify an existing cloud network descriptor.
621 </para>
622 <variablelist>
623 <varlistentry>
624 <term><option>--name</option></term><listitem><para>The name of an existing cloud network descriptor.</para></listitem>
625 </varlistentry>
626 <varlistentry>
627 <term><option>--network-id</option></term><listitem><para>The unique identifier of an existing subnet in the cloud.</para></listitem>
628 </varlistentry>
629 <varlistentry>
630 <term><option>--enable</option>, --disable</term>
631 <listitem><para>Whether to enable the network descriptor or disable it.</para></listitem>
632 </varlistentry>
633 </variablelist>
634 </refsect2>
635
636 <refsect2 id="vboxmanage-cloud-network-delete">
637 <title>cloud network delete</title>
638 <remark role="help-copy-synopsis"/>
639 <para>
640 Delete an existing cloud network descriptor.
641 </para>
642 <variablelist>
643 <varlistentry>
644 <term><option>--name</option></term><listitem><para>The name of an existing cloud network descriptor.</para></listitem>
645 </varlistentry>
646 </variablelist>
647 </refsect2>
648
649 <refsect2 id="vboxmanage-cloud-network-info">
650 <title>cloud network info</title>
651 <remark role="help-copy-synopsis"/>
652 <para>
653 Display information about a cloud network descriptor.
654 </para>
655 <variablelist>
656 <varlistentry>
657 <term><option>--name</option></term><listitem><para>The name of an existing cloud network descriptor.</para></listitem>
658 </varlistentry>
659 </variablelist>
660 </refsect2>
661
662 </refsect1>
663
664</refentry>
665
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