| 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.alldomusa.eu.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-08-05 07:40:20 +0000 (Sat, 05 Aug 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 |
|
|---|
| 160 | <!-- Cloud image commands -->
|
|---|
| 161 | <cmdsynopsis id="synopsis-vboxmanage-cloud-image-create" sepchar=" "> <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
|---|
| 162 | <command>VBoxManage cloud</command>
|
|---|
| 163 | <arg choice="req">--provider=<replaceable>name</replaceable></arg>
|
|---|
| 164 | <arg choice="req">--profile=<replaceable>name</replaceable></arg>
|
|---|
| 165 | <sbr/>
|
|---|
| 166 | <arg choice="plain">image create</arg>
|
|---|
| 167 | <arg choice="req">--display-name=<replaceable>name</replaceable></arg>
|
|---|
| 168 | <arg>--bucket-name=<replaceable>name</replaceable></arg>
|
|---|
| 169 | <arg>--object-name=<replaceable>name</replaceable></arg>
|
|---|
| 170 | <arg>--instance-id=<replaceable>unique id</replaceable></arg>
|
|---|
| 171 | </cmdsynopsis>
|
|---|
| 172 | <cmdsynopsis id="synopsis-vboxmanage-cloud-image-info" sepchar=" ">
|
|---|
| 173 | <command>VBoxManage cloud</command>
|
|---|
| 174 | <arg choice="req">--provider=<replaceable>name</replaceable></arg>
|
|---|
| 175 | <arg choice="req">--profile=<replaceable>name</replaceable></arg>
|
|---|
| 176 | <sbr/>
|
|---|
| 177 | <arg choice="plain">image info</arg>
|
|---|
| 178 | <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
|
|---|
| 179 | </cmdsynopsis>
|
|---|
| 180 | <cmdsynopsis id="synopsis-vboxmanage-cloud-image-delete" sepchar=" ">
|
|---|
| 181 | <command>VBoxManage cloud</command>
|
|---|
| 182 | <arg choice="req">--provider=<replaceable>name</replaceable></arg>
|
|---|
| 183 | <arg choice="req">--profile=<replaceable>name</replaceable></arg>
|
|---|
| 184 | <sbr/>
|
|---|
| 185 | <arg choice="plain">image delete</arg>
|
|---|
| 186 | <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
|
|---|
| 187 | </cmdsynopsis>
|
|---|
| 188 | <cmdsynopsis id="synopsis-vboxmanage-cloud-image-import" sepchar=" ">
|
|---|
| 189 | <command>VBoxManage cloud</command>
|
|---|
| 190 | <arg choice="req">--provider=<replaceable>name</replaceable></arg>
|
|---|
| 191 | <arg choice="req">--profile=<replaceable>name</replaceable></arg>
|
|---|
| 192 | <sbr/>
|
|---|
| 193 | <arg choice="plain">image import</arg>
|
|---|
| 194 | <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
|
|---|
| 195 | <arg>--bucket-name=<replaceable>name</replaceable></arg>
|
|---|
| 196 | <arg>--object-name=<replaceable>name</replaceable></arg>
|
|---|
| 197 | </cmdsynopsis>
|
|---|
| 198 | <cmdsynopsis id="synopsis-vboxmanage-cloud-image-export" 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 export</arg>
|
|---|
| 204 | <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
|
|---|
| 205 | <arg choice="req">--display-name=<replaceable>name</replaceable></arg>
|
|---|
| 206 | <arg>--bucket-name=<replaceable>name</replaceable></arg>
|
|---|
| 207 | <arg>--object-name=<replaceable>name</replaceable></arg>
|
|---|
| 208 | </cmdsynopsis>
|
|---|
| 209 |
|
|---|
| 210 | <!-- Cloud network commands -->
|
|---|
| 211 | <cmdsynopsis id="synopsis-vboxmanage-cloud-network-setup"> <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
|---|
| 212 | <command>VBoxManage cloud</command>
|
|---|
| 213 | <arg choice="req">--provider=<replaceable>name</replaceable></arg>
|
|---|
| 214 | <arg choice="req">--profile=<replaceable>name</replaceable></arg>
|
|---|
| 215 | <sbr/>
|
|---|
| 216 | <arg choice="plain">network setup</arg>
|
|---|
| 217 | <arg>--gateway-os-name=<replaceable>string</replaceable></arg>
|
|---|
| 218 | <arg>--gateway-os-version=<replaceable>string</replaceable></arg>
|
|---|
| 219 | <arg>--gateway-shape=<replaceable>string</replaceable></arg>
|
|---|
| 220 | <arg>--tunnel-network-name=<replaceable>string</replaceable></arg>
|
|---|
| 221 | <arg>--tunnel-network-range=<replaceable>string</replaceable></arg>
|
|---|
| 222 | <arg>--proxy=<replaceable>string</replaceable></arg>
|
|---|
| 223 | <arg>--compartment-id=<replaceable>string</replaceable></arg>
|
|---|
| 224 | </cmdsynopsis>
|
|---|
| 225 | <cmdsynopsis id="synopsis-vboxmanage-cloud-network-create">
|
|---|
| 226 | <command>VBoxManage cloud</command>
|
|---|
| 227 | <arg choice="req">--provider=<replaceable>name</replaceable></arg>
|
|---|
| 228 | <arg choice="req">--profile=<replaceable>name</replaceable></arg>
|
|---|
| 229 | <sbr/>
|
|---|
| 230 | <arg choice="plain">network create</arg>
|
|---|
| 231 | <arg choice="req">--name=<replaceable>string</replaceable></arg>
|
|---|
| 232 | <arg choice="req">--network-id=<replaceable>string</replaceable></arg>
|
|---|
| 233 | <group>
|
|---|
| 234 | <arg choice="plain">--enable</arg>
|
|---|
| 235 | <arg choice="plain">--disable</arg>
|
|---|
| 236 | </group>
|
|---|
| 237 | </cmdsynopsis>
|
|---|
| 238 | <cmdsynopsis id="synopsis-vboxmanage-cloud-network-update">
|
|---|
| 239 | <command>VBoxManage cloud network update</command>
|
|---|
| 240 | <arg choice="req">--name=<replaceable>string</replaceable></arg>
|
|---|
| 241 | <arg>--network-id=<replaceable>string</replaceable></arg>
|
|---|
| 242 | <group>
|
|---|
| 243 | <arg choice="plain">--enable</arg>
|
|---|
| 244 | <arg choice="plain">--disable</arg>
|
|---|
| 245 | </group>
|
|---|
| 246 | </cmdsynopsis>
|
|---|
| 247 | <cmdsynopsis id="synopsis-vboxmanage-cloud-network-delete">
|
|---|
| 248 | <command>VBoxManage cloud network delete</command>
|
|---|
| 249 | <arg choice="req">--name=<replaceable>string</replaceable></arg>
|
|---|
| 250 | </cmdsynopsis>
|
|---|
| 251 | <cmdsynopsis id="synopsis-vboxmanage-cloud-network-info">
|
|---|
| 252 | <command>VBoxManage cloud >network info</command>
|
|---|
| 253 | <arg choice="req">--name=<replaceable>string</replaceable></arg>
|
|---|
| 254 | </cmdsynopsis>
|
|---|
| 255 | </refsynopsisdiv>
|
|---|
| 256 |
|
|---|
| 257 | <refsect1 id="vboxmanage-cloud-image-description">
|
|---|
| 258 | <title>Description</title>
|
|---|
| 259 |
|
|---|
| 260 | <!-- Cloud commands common options -->
|
|---|
| 261 | <refsect2 id="vboxmanage-cloud-common-options">
|
|---|
| 262 | <title>Common options</title>
|
|---|
| 263 | <remark role="help-scope" condition="GLOBAL"/>
|
|---|
| 264 | <para>The word "cloud" is an umbrella for all commands related to the interconnection with the Cloud.
|
|---|
| 265 | The next common options must be placed between the "cloud" and the following sub-commands:</para>
|
|---|
| 266 | <variablelist>
|
|---|
| 267 | <varlistentry>
|
|---|
| 268 | <term>--provider=<replaceable>name</replaceable></term>
|
|---|
| 269 | <listitem><para>Short cloud provider name.</para></listitem>
|
|---|
| 270 | </varlistentry>
|
|---|
| 271 | <varlistentry>
|
|---|
| 272 | <term>--profile=<replaceable>name</replaceable></term>
|
|---|
| 273 | <listitem><para>Cloud profile name. </para></listitem>
|
|---|
| 274 | </varlistentry>
|
|---|
| 275 | </variablelist>
|
|---|
| 276 | </refsect2>
|
|---|
| 277 |
|
|---|
| 278 | <!-- Cloud list commands -->
|
|---|
| 279 | <refsect2 id="vboxmanage-cloud-list-instances">
|
|---|
| 280 | <title>cloud list instances</title>
|
|---|
| 281 | <remark role="help-copy-synopsis"/>
|
|---|
| 282 | <para>
|
|---|
| 283 | Displays the list of the instances for a specified compartment.
|
|---|
| 284 | </para>
|
|---|
| 285 | <variablelist>
|
|---|
| 286 | <varlistentry>
|
|---|
| 287 | <term>--state<replaceable>"running/paused/terminated"</replaceable></term>
|
|---|
| 288 | <listitem>
|
|---|
| 289 | <para>The state of cloud instance. The possible states are "running/paused/terminated" at moment.
|
|---|
| 290 | If the state isn't provided the list of instances with all possible states is returned.
|
|---|
| 291 | </para>
|
|---|
| 292 | </listitem>
|
|---|
| 293 | </varlistentry>
|
|---|
| 294 | <varlistentry>
|
|---|
| 295 | <term><option>--compartment-id</option></term>
|
|---|
| 296 | <listitem>
|
|---|
| 297 | <para>A compartment is the logical container used to organize and isolate cloud resources.
|
|---|
| 298 | The different cloud providers can have the different names for this entity.
|
|---|
| 299 | </para>
|
|---|
| 300 | </listitem>
|
|---|
| 301 | </varlistentry>
|
|---|
| 302 | </variablelist>
|
|---|
| 303 | </refsect2>
|
|---|
| 304 |
|
|---|
| 305 | <refsect2 id="vboxmanage-cloud-list-images">
|
|---|
| 306 | <title>cloud list images</title>
|
|---|
| 307 | <remark role="help-copy-synopsis"/>
|
|---|
| 308 | <para>
|
|---|
| 309 | Displays the list of the images for a specified compartment.
|
|---|
| 310 | </para>
|
|---|
| 311 | <variablelist>
|
|---|
| 312 | <varlistentry>
|
|---|
| 313 | <term>--state=available|disabled|deleted</term>
|
|---|
| 314 | <listitem>
|
|---|
| 315 | <para>The state of cloud image. The possible states are <literal>available</literal>,
|
|---|
| 316 | <literal>disabled</literal> and <literal>deleted</literal> at moment.
|
|---|
| 317 | If the state isn't provided the list of images with all possible states is returned.
|
|---|
| 318 | </para>
|
|---|
| 319 | </listitem>
|
|---|
| 320 | </varlistentry>
|
|---|
| 321 | <varlistentry>
|
|---|
| 322 | <term><option>--compartment-id</option></term>
|
|---|
| 323 | <listitem>
|
|---|
| 324 | <para>A compartment is the logical container used to organize and isolate cloud resources.
|
|---|
| 325 | The different cloud providers can have the different names for this entity.
|
|---|
| 326 | </para>
|
|---|
| 327 | </listitem>
|
|---|
| 328 | </varlistentry>
|
|---|
| 329 | </variablelist>
|
|---|
| 330 | </refsect2>
|
|---|
| 331 |
|
|---|
| 332 | <refsect2 id="vboxmanage-cloud-list-vnicattachments">
|
|---|
| 333 | <title>cloud list vnic attachments</title>
|
|---|
| 334 | <remark role="help-copy-synopsis"/>
|
|---|
| 335 | <para>
|
|---|
| 336 | Displays the list of the vnic attachments for a specified compartment.
|
|---|
| 337 | </para>
|
|---|
| 338 | <variablelist>
|
|---|
| 339 | <varlistentry>
|
|---|
| 340 | <term>--filter={instanceId|vnicId|domainName}=<replaceable>string</replaceable></term>
|
|---|
| 341 | <listitem>
|
|---|
| 342 | <!-- @todo r=bird: Use more markup. This'll all be put jumbled together into a single paragraph -->
|
|---|
| 343 | <para>Filters are used to narrow down the set of Vnic attachments of interest.
|
|---|
| 344 | This parameter is repeatible.
|
|---|
| 345 | The possible filter types are "instanceId" or "vnicId" or "availabilityDomain" at moment.
|
|---|
| 346 | The form is "type=[value]" and can be repeated.
|
|---|
| 347 | In instance, "--filter instanceId=ocid1.instance.oc1.iad.anuwcl...js6
|
|---|
| 348 | --filter vnicId=ocid1.vnic.oc1.iad.abuwcl...jsm
|
|---|
| 349 | --filter domainName=ergw:US-ASHBURN-AD-2".
|
|---|
| 350 | But in most cases, this is redundant and one filter is enough.
|
|---|
| 351 | If the filter isn't provided the whole list of vnic attachments for a specified compartment is returned.
|
|---|
| 352 | </para>
|
|---|
| 353 | </listitem>
|
|---|
| 354 | </varlistentry>
|
|---|
| 355 | <varlistentry>
|
|---|
| 356 | <term><option>--compartment-id</option></term>
|
|---|
| 357 | <listitem>
|
|---|
| 358 | <para>A compartment is the logical container used to organize and isolate cloud resources.
|
|---|
| 359 | The different cloud providers can have the different names for this entity.
|
|---|
| 360 | </para>
|
|---|
| 361 | </listitem>
|
|---|
| 362 | </varlistentry>
|
|---|
| 363 | </variablelist>
|
|---|
| 364 | </refsect2>
|
|---|
| 365 |
|
|---|
| 366 | <!-- Cloud instance commands -->
|
|---|
| 367 | <refsect2 id="vboxmanage-cloud-instance-create">
|
|---|
| 368 | <title>cloud instance create</title>
|
|---|
| 369 | <remark role="help-copy-synopsis"/>
|
|---|
| 370 | <para>
|
|---|
| 371 | <!-- @todo r=bird: Use more markup. This'll all be put jumbled together into a single paragraph -->
|
|---|
| 372 | Creates new instance in the Cloud.
|
|---|
| 373 | There are two standard ways to create an instance in the Cloud:
|
|---|
| 374 | 1. Create an instance from an existing custom image.
|
|---|
| 375 | 2. Create an instance from an existing bootable volume. This bootable volume shouldn't be attached to any instance.
|
|---|
| 376 | For the 1st approach next parameters are required: image-id, boot-disk-size.
|
|---|
| 377 | For the 2nd approach next parameters are required: boot-volume-id.
|
|---|
| 378 | The rest parameters are common for both cases:
|
|---|
| 379 | display-name, launch-mode, subnet-id, publicIP, privateIP, shape, domain.
|
|---|
| 380 | </para>
|
|---|
| 381 | <variablelist>
|
|---|
| 382 | <varlistentry>
|
|---|
| 383 | <term><option>--domain-name</option></term><listitem><para>Cloud domain where new instance is created.</para></listitem>
|
|---|
| 384 | </varlistentry>
|
|---|
| 385 | <varlistentry>
|
|---|
| 386 | <term><option>--image-id</option></term><listitem><para>Unique identifier which fully identifies a custom image in the Cloud.</para></listitem>
|
|---|
| 387 | </varlistentry>
|
|---|
| 388 | <varlistentry>
|
|---|
| 389 | <term><option>--boot-volume-id</option></term><listitem><para>Unique identifier which fully identifies a boot volume in the Cloud.</para></listitem>
|
|---|
| 390 | </varlistentry>
|
|---|
| 391 | <varlistentry>
|
|---|
| 392 | <term><option>--display-name</option></term><listitem><para>Name for new instance in the Cloud.</para></listitem>
|
|---|
| 393 | </varlistentry>
|
|---|
| 394 | <varlistentry>
|
|---|
| 395 | <term><option>--shape</option></term><listitem><para> The shape of instance, defines the number of CPUs and RAM memory.</para></listitem>
|
|---|
| 396 | </varlistentry>
|
|---|
| 397 | <varlistentry>
|
|---|
| 398 | <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>
|
|---|
| 399 | </varlistentry>
|
|---|
| 400 | <varlistentry>
|
|---|
| 401 | <term><option>--boot-disk-size</option></term><listitem><para> The size of bootable image in GB. Default is 50GB.</para></listitem>
|
|---|
| 402 | </varlistentry>
|
|---|
| 403 | <varlistentry>
|
|---|
| 404 | <term><option>--publicip</option></term><listitem><para>Whether the instance will have a public IP or not.</para></listitem>
|
|---|
| 405 | </varlistentry>
|
|---|
| 406 | <varlistentry>
|
|---|
| 407 | <term><option>--privateip</option></term><listitem><para>Private IP address for the created instance.</para></listitem>
|
|---|
| 408 | </varlistentry>
|
|---|
| 409 | <varlistentry>
|
|---|
| 410 | <term><option>--public-ssh-key</option></term>
|
|---|
| 411 | <listitem>
|
|---|
| 412 | <para>Public SSH key used to connect to the instance via SSH.
|
|---|
| 413 | This parameter may be repeated if you plan to use more than one key as:
|
|---|
| 414 | <!-- @todo r=bird: Markup rather than quoting -->
|
|---|
| 415 | "--public-ssh-key=firstSSHKey --public-ssh-key=secondSSHKey".
|
|---|
| 416 | </para>
|
|---|
| 417 | </listitem>
|
|---|
| 418 | </varlistentry>
|
|---|
| 419 | <varlistentry>
|
|---|
| 420 | <term><option>--launch-mode</option></term><listitem><para>The most known values here may be EMULATED, NATIVE, PARAVIRTUALIZED. </para></listitem>
|
|---|
| 421 | </varlistentry>
|
|---|
| 422 | <varlistentry>
|
|---|
| 423 | <term><option>--cloud-init-script-path</option></term><listitem><para>Absolute path to the user cloud-init script.</para></listitem>
|
|---|
| 424 | </varlistentry>
|
|---|
| 425 | </variablelist>
|
|---|
| 426 | </refsect2>
|
|---|
| 427 |
|
|---|
| 428 | <refsect2 id="vboxmanage-cloud-instance-info">
|
|---|
| 429 | <title>cloud instance info</title>
|
|---|
| 430 | <para>
|
|---|
| 431 | Display information about 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 | <refsect2 id="vboxmanage-cloud-instance-terminate">
|
|---|
| 441 | <title>cloud instance termination</title>
|
|---|
| 442 | <para>
|
|---|
| 443 | Delete a cloud instance with a specified id.
|
|---|
| 444 | </para>
|
|---|
| 445 | <variablelist>
|
|---|
| 446 | <varlistentry>
|
|---|
| 447 | <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
|
|---|
| 448 | </varlistentry>
|
|---|
| 449 | </variablelist>
|
|---|
| 450 | </refsect2>
|
|---|
| 451 |
|
|---|
| 452 | <refsect2 id="vboxmanage-cloud-instance-start">
|
|---|
| 453 | <title>cloud instance start</title>
|
|---|
| 454 | <para>
|
|---|
| 455 | Start a cloud instance with a specified id.
|
|---|
| 456 | </para>
|
|---|
| 457 | <variablelist>
|
|---|
| 458 | <varlistentry>
|
|---|
| 459 | <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
|
|---|
| 460 | </varlistentry>
|
|---|
| 461 | </variablelist>
|
|---|
| 462 | </refsect2>
|
|---|
| 463 |
|
|---|
| 464 | <refsect2 id="vboxmanage-cloud-instance-pause">
|
|---|
| 465 | <title>cloud instance pause</title>
|
|---|
| 466 | <para>
|
|---|
| 467 | Pause a cloud instance with a specified id.
|
|---|
| 468 | </para>
|
|---|
| 469 | <variablelist>
|
|---|
| 470 | <varlistentry>
|
|---|
| 471 | <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
|
|---|
| 472 | </varlistentry>
|
|---|
| 473 | </variablelist>
|
|---|
| 474 | </refsect2>
|
|---|
| 475 |
|
|---|
| 476 | <refsect2 id="vboxmanage-cloud-instance-reset">
|
|---|
| 477 | <title>cloud instance reset</title>
|
|---|
| 478 | <para>
|
|---|
| 479 | Force reset a cloud instance with a specified id.
|
|---|
| 480 | </para>
|
|---|
| 481 | <variablelist>
|
|---|
| 482 | <varlistentry>
|
|---|
| 483 | <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
|
|---|
| 484 | </varlistentry>
|
|---|
| 485 | </variablelist>
|
|---|
| 486 | </refsect2>
|
|---|
| 487 |
|
|---|
| 488 | <refsect2 id="vboxmanage-cloud-instance-clone">
|
|---|
| 489 | <title>cloud instance clone</title>
|
|---|
| 490 | <para>
|
|---|
| 491 | Clone a cloud instance with a specified id. Only works for the instances accessible through VirtualBox.
|
|---|
| 492 | I.e. Not every instance in the cloud may be cloned.
|
|---|
| 493 | </para>
|
|---|
| 494 | <variablelist>
|
|---|
| 495 | <varlistentry>
|
|---|
| 496 | <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
|
|---|
| 497 | </varlistentry>
|
|---|
| 498 | <varlistentry>
|
|---|
| 499 | <term><option>--clone-name</option></term><listitem><para>Name for a clone instance</para></listitem>
|
|---|
| 500 | </varlistentry>
|
|---|
| 501 | </variablelist>
|
|---|
| 502 | </refsect2>
|
|---|
| 503 |
|
|---|
| 504 | <!-- Cloud image commands -->
|
|---|
| 505 | <refsect2 id="vboxmanage-cloud-image-create">
|
|---|
| 506 | <title>cloud image create</title>
|
|---|
| 507 | <remark role="help-copy-synopsis"/>
|
|---|
| 508 | <para>
|
|---|
| 509 | Creates new image in the Cloud.
|
|---|
| 510 | There are two standard ways to create an image in the Cloud:
|
|---|
| 511 | 1. Create an image from an object in the Cloud Storage;
|
|---|
| 512 | 2. Create an image from an existing cloud instance.
|
|---|
| 513 | For the 1st approach next parameters are required:
|
|---|
| 514 | bucket-name - cloud bucket name where an object is located;
|
|---|
| 515 | object-name - name of object in the bucket;
|
|---|
| 516 | display-name - name for new image in the Cloud.
|
|---|
| 517 | For the 2d approach next parameters are required:
|
|---|
| 518 | instance-id - Id of instance in the Cloud;
|
|---|
| 519 | display-name - name for new image in the Cloud.
|
|---|
| 520 | </para>
|
|---|
| 521 | <variablelist>
|
|---|
| 522 | <varlistentry>
|
|---|
| 523 | <term><option>--display-name</option></term><listitem><para>Name for new image in the Cloud.</para></listitem>
|
|---|
| 524 | </varlistentry>
|
|---|
| 525 | <varlistentry>
|
|---|
| 526 | <term><option>--bucket-name</option></term><listitem><para>Cloud bucket name where an object is located.</para></listitem>
|
|---|
| 527 | </varlistentry>
|
|---|
| 528 | <varlistentry>
|
|---|
| 529 | <term><option>--object-name</option></term><listitem><para>Name of object in the bucket.</para></listitem>
|
|---|
| 530 | </varlistentry>
|
|---|
| 531 | <varlistentry>
|
|---|
| 532 | <term><option>--instance-id</option></term><listitem><para>Unique identifier which fully identifies the instance in the Cloud.</para></listitem>
|
|---|
| 533 | </varlistentry>
|
|---|
| 534 | </variablelist>
|
|---|
| 535 | </refsect2>
|
|---|
| 536 |
|
|---|
| 537 | <refsect2 id="vboxmanage-cloud-image-info">
|
|---|
| 538 | <title>cloud image info</title>
|
|---|
| 539 | <remark role="help-copy-synopsis"/>
|
|---|
| 540 | <para>
|
|---|
| 541 | Display information about a cloud image with a specified id.
|
|---|
| 542 | </para>
|
|---|
| 543 | <variablelist>
|
|---|
| 544 | <varlistentry>
|
|---|
| 545 | <term><option>--id</option></term><listitem><para>Unique identifier which fully identifies the image in the Cloud.</para></listitem>
|
|---|
| 546 | </varlistentry>
|
|---|
| 547 | </variablelist>
|
|---|
| 548 | </refsect2>
|
|---|
| 549 |
|
|---|
| 550 | <refsect2 id="vboxmanage-cloud-image-delete">
|
|---|
| 551 | <title>cloud image delete</title>
|
|---|
| 552 | <remark role="help-copy-synopsis"/>
|
|---|
| 553 | <para>
|
|---|
| 554 | Delete an image with a specified id from the Cloud.
|
|---|
| 555 | </para>
|
|---|
| 556 | <variablelist>
|
|---|
| 557 | <varlistentry>
|
|---|
| 558 | <term><option>--id</option></term><listitem><para>Unique identifier which fully identifies the image in the Cloud.</para></listitem>
|
|---|
| 559 | </varlistentry>
|
|---|
| 560 | </variablelist>
|
|---|
| 561 | </refsect2>
|
|---|
| 562 |
|
|---|
| 563 | <refsect2 id="vboxmanage-cloud-image-import">
|
|---|
| 564 | <title>cloud image import</title>
|
|---|
| 565 | <remark role="help-copy-synopsis"/>
|
|---|
| 566 | <para>
|
|---|
| 567 | Import an image with a specified id from the Cloud to a local host.
|
|---|
| 568 | The result is an object in the local "temp" folder on the local host.
|
|---|
| 569 | Possible approach may have two general steps:
|
|---|
| 570 | 1. Create an object from an image in the Cloud Storage;
|
|---|
| 571 | 2. Download the object to the local host.
|
|---|
| 572 | So the next parameters may be required:
|
|---|
| 573 | bucket-name - cloud bucket name where the object will be created;
|
|---|
| 574 | object-name - name of object in the bucket. if parameter "object-name" is absent a displayed image name is used.
|
|---|
| 575 | If the first step isn't needed only the parameter "id" is required.
|
|---|
| 576 | </para>
|
|---|
| 577 | <variablelist>
|
|---|
| 578 | <varlistentry>
|
|---|
| 579 | <term><option>--id</option></term><listitem><para>Unique identifier which fully identifies the image in the Cloud.</para></listitem>
|
|---|
| 580 | </varlistentry>
|
|---|
| 581 | <varlistentry>
|
|---|
| 582 | <term><option>--bucket-name</option></term><listitem><para>Cloud bucket name where an object will be created.</para></listitem>
|
|---|
| 583 | </varlistentry>
|
|---|
| 584 | <varlistentry>
|
|---|
| 585 | <term><option>--object-name</option></term>
|
|---|
| 586 | <listitem>
|
|---|
| 587 | <para>
|
|---|
| 588 | Name of created object in the bucket. The downloaded object will have this name.
|
|---|
| 589 | </para>
|
|---|
| 590 | </listitem>
|
|---|
| 591 | </varlistentry>
|
|---|
| 592 | </variablelist>
|
|---|
| 593 | </refsect2>
|
|---|
| 594 |
|
|---|
| 595 | <refsect2 id="vboxmanage-cloud-image-export">
|
|---|
| 596 | <title>cloud image export</title>
|
|---|
| 597 | <remark role="help-copy-synopsis"/>
|
|---|
| 598 | <para>
|
|---|
| 599 | Export an existing VBox image with a specified uuid from a local host to the Cloud.
|
|---|
| 600 | The result is new image in the Cloud.
|
|---|
| 601 | Possible approach may have two general steps:
|
|---|
| 602 | 1. Upload VBox image to the Cloud Storage;
|
|---|
| 603 | 2. Create an image from the uploaded object.
|
|---|
| 604 | So the next parameters may be required:
|
|---|
| 605 | bucket-name -cloud bucket name where the object will be uploaded;
|
|---|
| 606 | object-name - name of object in the bucket. If parameter "object-name" is absent the image id is used;
|
|---|
| 607 | display-name - name for new image in the Cloud.
|
|---|
| 608 | If the first step isn't needed the parameters "id" and "display-name" are required only.
|
|---|
| 609 | </para>
|
|---|
| 610 | <variablelist>
|
|---|
| 611 | <varlistentry>
|
|---|
| 612 | <term><option>--id</option></term><listitem><para>Unique identifier of the image in the VirtualBox.</para></listitem>
|
|---|
| 613 | </varlistentry>
|
|---|
| 614 | <varlistentry>
|
|---|
| 615 | <term><option>--display-name</option></term><listitem><para>Name for new image in the Cloud.</para></listitem>
|
|---|
| 616 | </varlistentry>
|
|---|
| 617 | <varlistentry>
|
|---|
| 618 | <term><option>--bucket-name</option></term><listitem><para>Cloud bucket name where the image (object) will be uploaded.</para></listitem>
|
|---|
| 619 | </varlistentry>
|
|---|
| 620 | <varlistentry>
|
|---|
| 621 | <term><option>--object-name</option></term><listitem><para>Name of object in the bucket.</para></listitem>
|
|---|
| 622 | </varlistentry>
|
|---|
| 623 | </variablelist>
|
|---|
| 624 | </refsect2>
|
|---|
| 625 |
|
|---|
| 626 |
|
|---|
| 627 | <!-- Cloud network commands -->
|
|---|
| 628 | <refsect2 id="vboxmanage-cloud-network-setup">
|
|---|
| 629 | <title>cloud network setup</title>
|
|---|
| 630 | <remark role="help-copy-synopsis"/>
|
|---|
| 631 | <para>
|
|---|
| 632 | Set up a cloud network environment for the specified cloud profile.
|
|---|
| 633 | </para>
|
|---|
| 634 | <variablelist>
|
|---|
| 635 | <varlistentry>
|
|---|
| 636 | <term><option>--gateway-os-name</option></term><listitem><para>The name of OS to use for a cloud gateway.</para></listitem>
|
|---|
| 637 | </varlistentry>
|
|---|
| 638 | <varlistentry>
|
|---|
| 639 | <term><option>--gateway-os-version</option></term><listitem><para>The version of OS to use for a cloud gateway.</para></listitem>
|
|---|
| 640 | </varlistentry>
|
|---|
| 641 | <varlistentry>
|
|---|
| 642 | <term><option>--gateway-shape</option></term><listitem><para>The instance shape to use for a cloud gateway. </para></listitem>
|
|---|
| 643 | </varlistentry>
|
|---|
| 644 | <varlistentry>
|
|---|
| 645 | <term><option>--tunnel-network-name</option></term><listitem><para>The name of VCN/subnet to use for tunneling.</para></listitem>
|
|---|
| 646 | </varlistentry>
|
|---|
| 647 | <varlistentry>
|
|---|
| 648 | <term><option>--tunnel-network-range</option></term><listitem><para>The IP address range to use for tunneling. </para></listitem>
|
|---|
| 649 | </varlistentry>
|
|---|
| 650 | <varlistentry>
|
|---|
| 651 | <term><option>--proxy</option></term><listitem><para>The proxy URL to be used in local gateway installation.</para></listitem>
|
|---|
| 652 | </varlistentry>
|
|---|
| 653 | <varlistentry>
|
|---|
| 654 | <term><option>--compartment-id</option></term><listitem><para>The compartment to create the tunnel network in.</para></listitem>
|
|---|
| 655 | </varlistentry>
|
|---|
| 656 | </variablelist>
|
|---|
| 657 | </refsect2>
|
|---|
| 658 |
|
|---|
| 659 | <refsect2 id="vboxmanage-cloud-network-create">
|
|---|
| 660 | <title>cloud network create</title>
|
|---|
| 661 | <remark role="help-copy-synopsis"/>
|
|---|
| 662 | <para>
|
|---|
| 663 | Create a new cloud network descriptor associated with an existing cloud subnet.
|
|---|
| 664 | </para>
|
|---|
| 665 | <variablelist>
|
|---|
| 666 | <varlistentry>
|
|---|
| 667 | <term><option>--name</option></term><listitem><para>The name to assign to the cloud network descriptor.</para></listitem>
|
|---|
| 668 | </varlistentry>
|
|---|
| 669 | <varlistentry>
|
|---|
| 670 | <term><option>--network-id</option></term><listitem><para>The unique identifier of an existing subnet in the cloud.</para></listitem>
|
|---|
| 671 | </varlistentry>
|
|---|
| 672 | <varlistentry>
|
|---|
| 673 | <term><option>--enable</option>, --disable</term>
|
|---|
| 674 | <listitem><para>Whether to enable the network descriptor or disable it. If not specified,
|
|---|
| 675 | the network will be enabled.</para></listitem>
|
|---|
| 676 | </varlistentry>
|
|---|
| 677 | </variablelist>
|
|---|
| 678 | </refsect2>
|
|---|
| 679 |
|
|---|
| 680 | <refsect2 id="vboxmanage-cloud-network-update">
|
|---|
| 681 | <title>cloud network update</title>
|
|---|
| 682 | <remark role="help-copy-synopsis"/>
|
|---|
| 683 | <para>
|
|---|
| 684 | Modify an existing cloud network descriptor.
|
|---|
| 685 | </para>
|
|---|
| 686 | <variablelist>
|
|---|
| 687 | <varlistentry>
|
|---|
| 688 | <term><option>--name</option></term><listitem><para>The name of an existing cloud network descriptor.</para></listitem>
|
|---|
| 689 | </varlistentry>
|
|---|
| 690 | <varlistentry>
|
|---|
| 691 | <term><option>--network-id</option></term><listitem><para>The unique identifier of an existing subnet in the cloud.</para></listitem>
|
|---|
| 692 | </varlistentry>
|
|---|
| 693 | <varlistentry>
|
|---|
| 694 | <term><option>--enable</option>, --disable</term>
|
|---|
| 695 | <listitem><para>Whether to enable the network descriptor or disable it.</para></listitem>
|
|---|
| 696 | </varlistentry>
|
|---|
| 697 | </variablelist>
|
|---|
| 698 | </refsect2>
|
|---|
| 699 |
|
|---|
| 700 | <refsect2 id="vboxmanage-cloud-network-delete">
|
|---|
| 701 | <title>cloud network delete</title>
|
|---|
| 702 | <remark role="help-copy-synopsis"/>
|
|---|
| 703 | <para>
|
|---|
| 704 | Delete an existing cloud network descriptor.
|
|---|
| 705 | </para>
|
|---|
| 706 | <variablelist>
|
|---|
| 707 | <varlistentry>
|
|---|
| 708 | <term><option>--name</option></term><listitem><para>The name of an existing cloud network descriptor.</para></listitem>
|
|---|
| 709 | </varlistentry>
|
|---|
| 710 | </variablelist>
|
|---|
| 711 | </refsect2>
|
|---|
| 712 |
|
|---|
| 713 | <refsect2 id="vboxmanage-cloud-network-info">
|
|---|
| 714 | <title>cloud network info</title>
|
|---|
| 715 | <remark role="help-copy-synopsis"/>
|
|---|
| 716 | <para>
|
|---|
| 717 | Display information about a cloud network descriptor.
|
|---|
| 718 | </para>
|
|---|
| 719 | <variablelist>
|
|---|
| 720 | <varlistentry>
|
|---|
| 721 | <term><option>--name</option></term><listitem><para>The name of an existing cloud network descriptor.</para></listitem>
|
|---|
| 722 | </varlistentry>
|
|---|
| 723 | </variablelist>
|
|---|
| 724 | </refsect2>
|
|---|
| 725 |
|
|---|
| 726 | </refsect1>
|
|---|
| 727 |
|
|---|
| 728 | </refentry>
|
|---|
| 729 |
|
|---|
