VirtualBox

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

Last change on this file since 103068 was 102095, checked in by vboxsync, 12 months ago

Jira:VBP-402. Added OCI telemetry API support in VBoxManage. 2 new commands - 'VBoxManage cloud instance metriclist' and 'VBoxManage cloud instance metricdata' Added help documentation for these commands.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 36.1 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-11-15 10:21:46 +0000 (Wed, 15 Nov 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-cloud-list-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 instances</arg>
58 <arg>--state=<replaceable>string</replaceable></arg>
59 <arg>--compartment-id=<replaceable>string</replaceable></arg>
60 </cmdsynopsis>
61 <cmdsynopsis id="synopsis-vboxmanage-cloud-list-images">
62 <command>VBoxManage cloud</command>
63 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
64 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
65 <sbr/>
66 <arg choice="plain">list images</arg>
67 <arg choice="req">--compartment-id=<replaceable>string</replaceable></arg>
68 <arg>--state=<replaceable>string</replaceable></arg>
69 </cmdsynopsis>
70 <cmdsynopsis id="synopsis-vboxmanage-cloud-list-vnicattachments">
71 <command>VBoxManage cloud</command>
72 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
73 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
74 <sbr/>
75 <arg choice="plain">list vnicattachments</arg>
76 <arg choice="req">--compartment-id=<replaceable>string</replaceable></arg>
77 <arg rep="repeat">--filter=<group choice="plain">
78 <arg choice="plain">instanceId</arg>
79 <arg choice="plain">vnicId</arg>
80 <arg choice="plain">availabilityDomain</arg>
81 </group>=<replaceable>value</replaceable></arg>
82 </cmdsynopsis>
83
84 <!-- Cloud instance commands -->
85 <cmdsynopsis id="synopsis-vboxmanage-cloud-instance-create" sepchar=" ">
86 <command moreinfo="none">VBoxManage cloud</command>
87 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
88 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
89 <sbr/>
90 <arg choice="plain">instance create</arg>
91 <arg choice="req">--domain-name=<replaceable>name</replaceable></arg>
92 <group choice="req">
93 <arg choice="plain">--image-id=<replaceable>id</replaceable></arg>
94 <arg choice="plain">--boot-volume-id=<replaceable>id</replaceable></arg>
95 </group>
96 <arg choice="req">--display-name=<replaceable>name</replaceable></arg>
97 <arg choice="req">--shape=<replaceable>type</replaceable></arg>
98 <arg choice="req">--subnet=<replaceable>id</replaceable></arg>
99 <arg>--boot-disk-size=<replaceable>size in GB</replaceable></arg>
100 <arg>--publicip=<group choice="plain"><arg choice="plain">true</arg><arg choice="plain">false</arg></group></arg>
101 <arg>--privateip=<replaceable>IP address</replaceable></arg>
102 <arg rep="repeat">--public-ssh-key=<replaceable>key string</replaceable></arg>
103 <arg>--launch-mode=<group choice="plain">
104 <arg choice="plain">NATIVE</arg>
105 <arg choice="plain">EMULATED</arg>
106 <arg choice="plain">PARAVIRTUALIZED</arg>
107 </group></arg>
108 <arg>--cloud-init-script-path=<replaceable>path to a script</replaceable></arg>
109 </cmdsynopsis>
110 <cmdsynopsis id="synopsis-vboxmanage-cloud-instance-info" sepchar=" ">
111 <command moreinfo="none">VBoxManage cloud</command>
112 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
113 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
114 <sbr/>
115 <arg choice="plain">instance info</arg>
116 <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
117 </cmdsynopsis>
118 <cmdsynopsis id="synopsis-vboxmanage-cloud-instance-terminate" sepchar=" ">
119 <command moreinfo="none">VBoxManage cloud</command>
120 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
121 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
122 <sbr/>
123 <arg choice="plain">instance terminate</arg>
124 <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
125 </cmdsynopsis>
126 <cmdsynopsis id="synopsis-vboxmanage-cloud-instance-start" sepchar=" ">
127 <command moreinfo="none">VBoxManage cloud</command>
128 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
129 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
130 <sbr/>
131 <arg choice="plain">instance start</arg>
132 <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
133 </cmdsynopsis>
134 <cmdsynopsis id="synopsis-vboxmanage-cloud-instance-pause" sepchar=" ">
135 <command moreinfo="none">VBoxManage cloud</command>
136 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
137 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
138 <sbr/>
139 <arg choice="plain">instance pause</arg>
140 <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
141 </cmdsynopsis>
142 <cmdsynopsis id="synopsis-vboxmanage-cloud-instance-reset" sepchar=" ">
143 <command moreinfo="none">VBoxManage cloud</command>
144 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
145 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
146 <sbr/>
147 <arg choice="plain">instance reset</arg>
148 <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
149 </cmdsynopsis>
150 <cmdsynopsis id="synopsis-vboxmanage-cloud-instance-clone" sepchar=" ">
151 <command moreinfo="none">VBoxManage cloud</command>
152 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
153 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
154 <sbr/>
155 <arg choice="plain">instance clone</arg>
156 <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
157 <arg>--clone-name=<replaceable>name for a clone instance</replaceable></arg>
158 </cmdsynopsis>
159 <cmdsynopsis id="synopsis-vboxmanage-cloud-instance-metriclist" sepchar=" ">
160 <command moreinfo="none">VBoxManage cloud</command>
161 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
162 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
163 <sbr/>
164 <arg choice="plain">instance metriclist</arg>
165 <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
166 </cmdsynopsis>
167 <cmdsynopsis id="synopsis-vboxmanage-cloud-instance-metricdata" sepchar=" ">
168 <command moreinfo="none">VBoxManage cloud</command>
169 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
170 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
171 <sbr/>
172 <arg choice="plain">instance metricdata</arg>
173 <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
174 <arg choice="req">--metric-name=<replaceable>metric name</replaceable></arg>
175 <arg choice="req">--metric-points=<replaceable>number of history metric points</replaceable></arg>
176 </cmdsynopsis>
177
178 <!-- Cloud image commands -->
179 <cmdsynopsis id="synopsis-vboxmanage-cloud-image-create" sepchar=" "> <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
180 <command>VBoxManage cloud</command>
181 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
182 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
183 <sbr/>
184 <arg choice="plain">image create</arg>
185 <arg choice="req">--display-name=<replaceable>name</replaceable></arg>
186 <arg>--bucket-name=<replaceable>name</replaceable></arg>
187 <arg>--object-name=<replaceable>name</replaceable></arg>
188 <arg>--instance-id=<replaceable>unique id</replaceable></arg>
189 </cmdsynopsis>
190 <cmdsynopsis id="synopsis-vboxmanage-cloud-image-info" sepchar=" ">
191 <command>VBoxManage cloud</command>
192 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
193 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
194 <sbr/>
195 <arg choice="plain">image info</arg>
196 <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
197 </cmdsynopsis>
198 <cmdsynopsis id="synopsis-vboxmanage-cloud-image-delete" sepchar=" ">
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">image delete</arg>
204 <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
205 </cmdsynopsis>
206 <cmdsynopsis id="synopsis-vboxmanage-cloud-image-import" sepchar=" ">
207 <command>VBoxManage cloud</command>
208 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
209 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
210 <sbr/>
211 <arg choice="plain">image import</arg>
212 <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
213 <arg>--bucket-name=<replaceable>name</replaceable></arg>
214 <arg>--object-name=<replaceable>name</replaceable></arg>
215 </cmdsynopsis>
216 <cmdsynopsis id="synopsis-vboxmanage-cloud-image-export" sepchar=" ">
217 <command>VBoxManage cloud</command>
218 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
219 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
220 <sbr/>
221 <arg choice="plain">image export</arg>
222 <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
223 <arg choice="req">--display-name=<replaceable>name</replaceable></arg>
224 <arg>--bucket-name=<replaceable>name</replaceable></arg>
225 <arg>--object-name=<replaceable>name</replaceable></arg>
226 </cmdsynopsis>
227
228 <!-- Cloud network commands -->
229 <cmdsynopsis id="synopsis-vboxmanage-cloud-network-setup"> <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
230 <command>VBoxManage cloud</command>
231 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
232 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
233 <sbr/>
234 <arg choice="plain">network setup</arg>
235 <arg>--gateway-os-name=<replaceable>string</replaceable></arg>
236 <arg>--gateway-os-version=<replaceable>string</replaceable></arg>
237 <arg>--gateway-shape=<replaceable>string</replaceable></arg>
238 <arg>--tunnel-network-name=<replaceable>string</replaceable></arg>
239 <arg>--tunnel-network-range=<replaceable>string</replaceable></arg>
240 <arg>--proxy=<replaceable>string</replaceable></arg>
241 <arg>--compartment-id=<replaceable>string</replaceable></arg>
242 </cmdsynopsis>
243 <cmdsynopsis id="synopsis-vboxmanage-cloud-network-create">
244 <command>VBoxManage cloud</command>
245 <arg choice="req">--provider=<replaceable>name</replaceable></arg>
246 <arg choice="req">--profile=<replaceable>name</replaceable></arg>
247 <sbr/>
248 <arg choice="plain">network create</arg>
249 <arg choice="req">--name=<replaceable>string</replaceable></arg>
250 <arg choice="req">--network-id=<replaceable>string</replaceable></arg>
251 <group>
252 <arg choice="plain">--enable</arg>
253 <arg choice="plain">--disable</arg>
254 </group>
255 </cmdsynopsis>
256 <cmdsynopsis id="synopsis-vboxmanage-cloud-network-update">
257 <command>VBoxManage cloud network update</command>
258 <arg choice="req">--name=<replaceable>string</replaceable></arg>
259 <arg>--network-id=<replaceable>string</replaceable></arg>
260 <group>
261 <arg choice="plain">--enable</arg>
262 <arg choice="plain">--disable</arg>
263 </group>
264 </cmdsynopsis>
265 <cmdsynopsis id="synopsis-vboxmanage-cloud-network-delete">
266 <command>VBoxManage cloud network delete</command>
267 <arg choice="req">--name=<replaceable>string</replaceable></arg>
268 </cmdsynopsis>
269 <cmdsynopsis id="synopsis-vboxmanage-cloud-network-info">
270 <command>VBoxManage cloud >network info</command>
271 <arg choice="req">--name=<replaceable>string</replaceable></arg>
272 </cmdsynopsis>
273 </refsynopsisdiv>
274
275 <refsect1 id="vboxmanage-cloud-image-description">
276 <title>Description</title>
277
278 <!-- Cloud commands common options -->
279 <refsect2 id="vboxmanage-cloud-common-options">
280 <title>Common options</title>
281 <remark role="help-scope" condition="GLOBAL"/>
282 <para>The word "cloud" is an umbrella for all commands related to the interconnection with the Cloud.
283 The next common options must be placed between the "cloud" and the following sub-commands:</para>
284 <variablelist>
285 <varlistentry>
286 <term>--provider=<replaceable>name</replaceable></term>
287 <listitem><para>Short cloud provider name.</para></listitem>
288 </varlistentry>
289 <varlistentry>
290 <term>--profile=<replaceable>name</replaceable></term>
291 <listitem><para>Cloud profile name. </para></listitem>
292 </varlistentry>
293 </variablelist>
294 </refsect2>
295
296 <!-- Cloud list commands -->
297 <refsect2 id="vboxmanage-cloud-list-instances">
298 <title>cloud list instances</title>
299 <remark role="help-copy-synopsis"/>
300 <para>
301 Displays the list of the instances for a specified compartment.
302 </para>
303 <variablelist>
304 <varlistentry>
305 <term>--state<replaceable>"running/paused/terminated"</replaceable></term>
306 <listitem>
307 <para>The state of cloud instance. The possible states are "running/paused/terminated" at moment.
308 If the state isn't provided the list of instances with all possible states is returned.
309 </para>
310 </listitem>
311 </varlistentry>
312 <varlistentry>
313 <term><option>--compartment-id</option></term>
314 <listitem>
315 <para>A compartment is the logical container used to organize and isolate cloud resources.
316 The different cloud providers can have the different names for this entity.
317 </para>
318 </listitem>
319 </varlistentry>
320 </variablelist>
321 </refsect2>
322
323 <refsect2 id="vboxmanage-cloud-list-images">
324 <title>cloud list images</title>
325 <remark role="help-copy-synopsis"/>
326 <para>
327 Displays the list of the images for a specified compartment.
328 </para>
329 <variablelist>
330 <varlistentry>
331 <term>--state=available|disabled|deleted</term>
332 <listitem>
333 <para>The state of cloud image. The possible states are <literal>available</literal>,
334 <literal>disabled</literal> and <literal>deleted</literal> at moment.
335 If the state isn't provided the list of images with all possible states is returned.
336 </para>
337 </listitem>
338 </varlistentry>
339 <varlistentry>
340 <term><option>--compartment-id</option></term>
341 <listitem>
342 <para>A compartment is the logical container used to organize and isolate cloud resources.
343 The different cloud providers can have the different names for this entity.
344 </para>
345 </listitem>
346 </varlistentry>
347 </variablelist>
348 </refsect2>
349
350 <refsect2 id="vboxmanage-cloud-list-vnicattachments">
351 <title>cloud list vnic attachments</title>
352 <remark role="help-copy-synopsis"/>
353 <para>
354 Displays the list of the vnic attachments for a specified compartment.
355 </para>
356 <variablelist>
357 <varlistentry>
358 <term>--filter={instanceId|vnicId|domainName}=<replaceable>string</replaceable></term>
359 <listitem>
360<!-- @todo r=bird: Use more markup. This'll all be put jumbled together into a single paragraph -->
361 <para>Filters are used to narrow down the set of Vnic attachments of interest.
362 This parameter is repeatible.
363 The possible filter types are "instanceId" or "vnicId" or "availabilityDomain" at moment.
364 The form is "type=[value]" and can be repeated.
365 In instance, "--filter instanceId=ocid1.instance.oc1.iad.anuwcl...js6
366 --filter vnicId=ocid1.vnic.oc1.iad.abuwcl...jsm
367 --filter domainName=ergw:US-ASHBURN-AD-2".
368 But in most cases, this is redundant and one filter is enough.
369 If the filter isn't provided the whole list of vnic attachments for a specified compartment is returned.
370 </para>
371 </listitem>
372 </varlistentry>
373 <varlistentry>
374 <term><option>--compartment-id</option></term>
375 <listitem>
376 <para>A compartment is the logical container used to organize and isolate cloud resources.
377 The different cloud providers can have the different names for this entity.
378 </para>
379 </listitem>
380 </varlistentry>
381 </variablelist>
382 </refsect2>
383
384 <!-- Cloud instance commands -->
385 <refsect2 id="vboxmanage-cloud-instance-create">
386 <title>cloud instance create</title>
387 <remark role="help-copy-synopsis"/>
388 <para>
389<!-- @todo r=bird: Use more markup. This'll all be put jumbled together into a single paragraph -->
390 Creates new instance in the Cloud.
391 There are two standard ways to create an instance in the Cloud:
392 1. Create an instance from an existing custom image.
393 2. Create an instance from an existing bootable volume. This bootable volume shouldn't be attached to any instance.
394 For the 1st approach next parameters are required: image-id, boot-disk-size.
395 For the 2nd approach next parameters are required: boot-volume-id.
396 The rest parameters are common for both cases:
397 display-name, launch-mode, subnet-id, publicIP, privateIP, shape, domain.
398 </para>
399 <variablelist>
400 <varlistentry>
401 <term><option>--domain-name</option></term><listitem><para>Cloud domain where new instance is created.</para></listitem>
402 </varlistentry>
403 <varlistentry>
404 <term><option>--image-id</option></term><listitem><para>Unique identifier which fully identifies a custom image in the Cloud.</para></listitem>
405 </varlistentry>
406 <varlistentry>
407 <term><option>--boot-volume-id</option></term><listitem><para>Unique identifier which fully identifies a boot volume in the Cloud.</para></listitem>
408 </varlistentry>
409 <varlistentry>
410 <term><option>--display-name</option></term><listitem><para>Name for new instance in the Cloud.</para></listitem>
411 </varlistentry>
412 <varlistentry>
413 <term><option>--shape</option></term><listitem><para> The shape of instance, defines the number of CPUs and RAM memory.</para></listitem>
414 </varlistentry>
415 <varlistentry>
416 <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>
417 </varlistentry>
418 <varlistentry>
419 <term><option>--boot-disk-size</option></term><listitem><para> The size of bootable image in GB. Default is 50GB.</para></listitem>
420 </varlistentry>
421 <varlistentry>
422 <term><option>--publicip</option></term><listitem><para>Whether the instance will have a public IP or not.</para></listitem>
423 </varlistentry>
424 <varlistentry>
425 <term><option>--privateip</option></term><listitem><para>Private IP address for the created instance.</para></listitem>
426 </varlistentry>
427 <varlistentry>
428 <term><option>--public-ssh-key</option></term>
429 <listitem>
430 <para>Public SSH key used to connect to the instance via SSH.
431 This parameter may be repeated if you plan to use more than one key as:
432<!-- @todo r=bird: Markup rather than quoting -->
433 "--public-ssh-key=firstSSHKey --public-ssh-key=secondSSHKey".
434 </para>
435 </listitem>
436 </varlistentry>
437 <varlistentry>
438 <term><option>--launch-mode</option></term><listitem><para>The most known values here may be EMULATED, NATIVE, PARAVIRTUALIZED. </para></listitem>
439 </varlistentry>
440 <varlistentry>
441 <term><option>--cloud-init-script-path</option></term><listitem><para>Absolute path to the user cloud-init script.</para></listitem>
442 </varlistentry>
443 </variablelist>
444 </refsect2>
445
446 <refsect2 id="vboxmanage-cloud-instance-info">
447 <title>cloud instance info</title>
448 <para>
449 Display information about a cloud instance with a specified id.
450 </para>
451 <variablelist>
452 <varlistentry>
453 <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
454 </varlistentry>
455 </variablelist>
456 </refsect2>
457
458 <refsect2 id="vboxmanage-cloud-instance-terminate">
459 <title>cloud instance termination</title>
460 <para>
461 Delete a cloud instance with a specified id.
462 </para>
463 <variablelist>
464 <varlistentry>
465 <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
466 </varlistentry>
467 </variablelist>
468 </refsect2>
469
470 <refsect2 id="vboxmanage-cloud-instance-start">
471 <title>cloud instance start</title>
472 <para>
473 Start a cloud instance with a specified id.
474 </para>
475 <variablelist>
476 <varlistentry>
477 <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
478 </varlistentry>
479 </variablelist>
480 </refsect2>
481
482 <refsect2 id="vboxmanage-cloud-instance-pause">
483 <title>cloud instance pause</title>
484 <para>
485 Pause a cloud instance with a specified id.
486 </para>
487 <variablelist>
488 <varlistentry>
489 <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
490 </varlistentry>
491 </variablelist>
492 </refsect2>
493
494 <refsect2 id="vboxmanage-cloud-instance-reset">
495 <title>cloud instance reset</title>
496 <para>
497 Force reset a cloud instance with a specified id.
498 </para>
499 <variablelist>
500 <varlistentry>
501 <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
502 </varlistentry>
503 </variablelist>
504 </refsect2>
505
506 <refsect2 id="vboxmanage-cloud-instance-clone">
507 <title>cloud instance clone</title>
508 <para>
509 Clone a cloud instance with a specified id. Only works for the instances accessible through VirtualBox.
510 I.e. Not every instance in the cloud may be cloned.
511 </para>
512 <variablelist>
513 <varlistentry>
514 <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
515 </varlistentry>
516 <varlistentry>
517 <term><option>--clone-name</option></term><listitem><para>Name for a clone instance</para></listitem>
518 </varlistentry>
519 </variablelist>
520 </refsect2>
521
522 <refsect2 id="vboxmanage-cloud-instance-metriclist">
523 <title>available list of metrics for cloud instances</title>
524 <remark role="help-copy-synopsis"/>
525 <para>
526 Displays the list of the available metrics for the instance.
527 The returned names must be used with the command "VBoxManage cloud instance metricdata".
528 </para>
529 <variablelist>
530 <varlistentry>
531 <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
532 </varlistentry>
533 </variablelist>
534 </refsect2>
535
536 <refsect2 id="vboxmanage-cloud-instance-metricdata">
537 <title>Displays cloud instance metric data</title>
538 <remark role="help-copy-synopsis"/>
539 <para>
540 Displays the metric data with the resolution 1 minute for the requested cloud instances.
541 The timestamps are returned in the format Rfc2822.
542 </para>
543 <variablelist>
544 <varlistentry>
545 <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
546 </varlistentry>
547 <varlistentry>
548 <term><option>--metric-name</option></term><listitem><para>Metric name</para></listitem>
549 </varlistentry>
550 <varlistentry>
551 <term><option>--metric-points</option></term>
552 <listitem>
553 <para>
554 History metric point numbers start at 1 and can go backwards as long as history exists.
555 Points are counted from the current time to the past. If user only wants the last actual value
556 he passes the value "1". If 2 values need to be returned (last and second to last),
557 the user passes "2", etc.
558 </para>
559 </listitem>
560 </varlistentry>
561 </variablelist>
562 </refsect2>
563
564 <!-- Cloud image commands -->
565 <refsect2 id="vboxmanage-cloud-image-create">
566 <title>cloud image create</title>
567 <remark role="help-copy-synopsis"/>
568 <para>
569 Creates new image in the Cloud.
570 There are two standard ways to create an image in the Cloud:
571 1. Create an image from an object in the Cloud Storage;
572 2. Create an image from an existing cloud instance.
573 For the 1st approach next parameters are required:
574 bucket-name - cloud bucket name where an object is located;
575 object-name - name of object in the bucket;
576 display-name - name for new image in the Cloud.
577 For the 2d approach next parameters are required:
578 instance-id - Id of instance in the Cloud;
579 display-name - name for new image in the Cloud.
580 </para>
581 <variablelist>
582 <varlistentry>
583 <term><option>--display-name</option></term><listitem><para>Name for new image in the Cloud.</para></listitem>
584 </varlistentry>
585 <varlistentry>
586 <term><option>--bucket-name</option></term><listitem><para>Cloud bucket name where an object is located.</para></listitem>
587 </varlistentry>
588 <varlistentry>
589 <term><option>--object-name</option></term><listitem><para>Name of object in the bucket.</para></listitem>
590 </varlistentry>
591 <varlistentry>
592 <term><option>--instance-id</option></term><listitem><para>Unique identifier which fully identifies the instance in the Cloud.</para></listitem>
593 </varlistentry>
594 </variablelist>
595 </refsect2>
596
597 <refsect2 id="vboxmanage-cloud-image-info">
598 <title>cloud image info</title>
599 <remark role="help-copy-synopsis"/>
600 <para>
601 Display information about a cloud image with a specified id.
602 </para>
603 <variablelist>
604 <varlistentry>
605 <term><option>--id</option></term><listitem><para>Unique identifier which fully identifies the image in the Cloud.</para></listitem>
606 </varlistentry>
607 </variablelist>
608 </refsect2>
609
610 <refsect2 id="vboxmanage-cloud-image-delete">
611 <title>cloud image delete</title>
612 <remark role="help-copy-synopsis"/>
613 <para>
614 Delete an image with a specified id from the Cloud.
615 </para>
616 <variablelist>
617 <varlistentry>
618 <term><option>--id</option></term><listitem><para>Unique identifier which fully identifies the image in the Cloud.</para></listitem>
619 </varlistentry>
620 </variablelist>
621 </refsect2>
622
623 <refsect2 id="vboxmanage-cloud-image-import">
624 <title>cloud image import</title>
625 <remark role="help-copy-synopsis"/>
626 <para>
627 Import an image with a specified id from the Cloud to a local host.
628 The result is an object in the local "temp" folder on the local host.
629 Possible approach may have two general steps:
630 1. Create an object from an image in the Cloud Storage;
631 2. Download the object to the local host.
632 So the next parameters may be required:
633 bucket-name - cloud bucket name where the object will be created;
634 object-name - name of object in the bucket. if parameter "object-name" is absent a displayed image name is used.
635 If the first step isn't needed only the parameter "id" is required.
636 </para>
637 <variablelist>
638 <varlistentry>
639 <term><option>--id</option></term><listitem><para>Unique identifier which fully identifies the image in the Cloud.</para></listitem>
640 </varlistentry>
641 <varlistentry>
642 <term><option>--bucket-name</option></term><listitem><para>Cloud bucket name where an object will be created.</para></listitem>
643 </varlistentry>
644 <varlistentry>
645 <term><option>--object-name</option></term>
646 <listitem>
647 <para>
648 Name of created object in the bucket. The downloaded object will have this name.
649 </para>
650 </listitem>
651 </varlistentry>
652 </variablelist>
653 </refsect2>
654
655 <refsect2 id="vboxmanage-cloud-image-export">
656 <title>cloud image export</title>
657 <remark role="help-copy-synopsis"/>
658 <para>
659 Export an existing VBox image with a specified uuid from a local host to the Cloud.
660 The result is new image in the Cloud.
661 Possible approach may have two general steps:
662 1. Upload VBox image to the Cloud Storage;
663 2. Create an image from the uploaded object.
664 So the next parameters may be required:
665 bucket-name -cloud bucket name where the object will be uploaded;
666 object-name - name of object in the bucket. If parameter "object-name" is absent the image id is used;
667 display-name - name for new image in the Cloud.
668 If the first step isn't needed the parameters "id" and "display-name" are required only.
669 </para>
670 <variablelist>
671 <varlistentry>
672 <term><option>--id</option></term><listitem><para>Unique identifier of the image in the VirtualBox.</para></listitem>
673 </varlistentry>
674 <varlistentry>
675 <term><option>--display-name</option></term><listitem><para>Name for new image in the Cloud.</para></listitem>
676 </varlistentry>
677 <varlistentry>
678 <term><option>--bucket-name</option></term><listitem><para>Cloud bucket name where the image (object) will be uploaded.</para></listitem>
679 </varlistentry>
680 <varlistentry>
681 <term><option>--object-name</option></term><listitem><para>Name of object in the bucket.</para></listitem>
682 </varlistentry>
683 </variablelist>
684 </refsect2>
685
686
687 <!-- Cloud network commands -->
688 <refsect2 id="vboxmanage-cloud-network-setup">
689 <title>cloud network setup</title>
690 <remark role="help-copy-synopsis"/>
691 <para>
692 Set up a cloud network environment for the specified cloud profile.
693 </para>
694 <variablelist>
695 <varlistentry>
696 <term><option>--gateway-os-name</option></term><listitem><para>The name of OS to use for a cloud gateway.</para></listitem>
697 </varlistentry>
698 <varlistentry>
699 <term><option>--gateway-os-version</option></term><listitem><para>The version of OS to use for a cloud gateway.</para></listitem>
700 </varlistentry>
701 <varlistentry>
702 <term><option>--gateway-shape</option></term><listitem><para>The instance shape to use for a cloud gateway. </para></listitem>
703 </varlistentry>
704 <varlistentry>
705 <term><option>--tunnel-network-name</option></term><listitem><para>The name of VCN/subnet to use for tunneling.</para></listitem>
706 </varlistentry>
707 <varlistentry>
708 <term><option>--tunnel-network-range</option></term><listitem><para>The IP address range to use for tunneling. </para></listitem>
709 </varlistentry>
710 <varlistentry>
711 <term><option>--proxy</option></term><listitem><para>The proxy URL to be used in local gateway installation.</para></listitem>
712 </varlistentry>
713 <varlistentry>
714 <term><option>--compartment-id</option></term><listitem><para>The compartment to create the tunnel network in.</para></listitem>
715 </varlistentry>
716 </variablelist>
717 </refsect2>
718
719 <refsect2 id="vboxmanage-cloud-network-create">
720 <title>cloud network create</title>
721 <remark role="help-copy-synopsis"/>
722 <para>
723 Create a new cloud network descriptor associated with an existing cloud subnet.
724 </para>
725 <variablelist>
726 <varlistentry>
727 <term><option>--name</option></term><listitem><para>The name to assign to the cloud network descriptor.</para></listitem>
728 </varlistentry>
729 <varlistentry>
730 <term><option>--network-id</option></term><listitem><para>The unique identifier of an existing subnet in the cloud.</para></listitem>
731 </varlistentry>
732 <varlistentry>
733 <term><option>--enable</option>, --disable</term>
734 <listitem><para>Whether to enable the network descriptor or disable it. If not specified,
735 the network will be enabled.</para></listitem>
736 </varlistentry>
737 </variablelist>
738 </refsect2>
739
740 <refsect2 id="vboxmanage-cloud-network-update">
741 <title>cloud network update</title>
742 <remark role="help-copy-synopsis"/>
743 <para>
744 Modify an existing cloud network descriptor.
745 </para>
746 <variablelist>
747 <varlistentry>
748 <term><option>--name</option></term><listitem><para>The name of an existing cloud network descriptor.</para></listitem>
749 </varlistentry>
750 <varlistentry>
751 <term><option>--network-id</option></term><listitem><para>The unique identifier of an existing subnet in the cloud.</para></listitem>
752 </varlistentry>
753 <varlistentry>
754 <term><option>--enable</option>, --disable</term>
755 <listitem><para>Whether to enable the network descriptor or disable it.</para></listitem>
756 </varlistentry>
757 </variablelist>
758 </refsect2>
759
760 <refsect2 id="vboxmanage-cloud-network-delete">
761 <title>cloud network delete</title>
762 <remark role="help-copy-synopsis"/>
763 <para>
764 Delete an existing cloud network descriptor.
765 </para>
766 <variablelist>
767 <varlistentry>
768 <term><option>--name</option></term><listitem><para>The name of an existing cloud network descriptor.</para></listitem>
769 </varlistentry>
770 </variablelist>
771 </refsect2>
772
773 <refsect2 id="vboxmanage-cloud-network-info">
774 <title>cloud network info</title>
775 <remark role="help-copy-synopsis"/>
776 <para>
777 Display information about a cloud network descriptor.
778 </para>
779 <variablelist>
780 <varlistentry>
781 <term><option>--name</option></term><listitem><para>The name of an existing cloud network descriptor.</para></listitem>
782 </varlistentry>
783 </variablelist>
784 </refsect2>
785
786 </refsect1>
787
788</refentry>
789
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