Changeset 84692 in vbox for trunk/doc/manual
- Timestamp:
- Jun 5, 2020 12:30:31 PM (4 years ago)
- Location:
- trunk/doc/manual
- Files:
-
- 4 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/manual/Config.kmk
r84679 r84692 45 45 man_VBoxManage-cloud.xml \ 46 46 man_VBoxManage-cloudprofile.xml \ 47 man_VBoxManage-cloudlist.xml \48 man_VBoxManage-cloudinstance.xml \49 man_VBoxManage-cloudimage.xml \50 47 man_VBoxManage-signova.xml 51 48 -
trunk/doc/manual/en_US/man_VBoxManage-cloud.xml
r84680 r84692 33 33 34 34 <refsynopsisdiv> 35 <!-- Cloud list commands --> 36 <cmdsynopsis id="synopsis-vboxmanage-cloudlist-instances"> <!-- The 'id' is mandatory and must start with 'synopsis-'. --> 37 <command>VBoxManage cloud</command> 38 <arg choice="req">--provider=<replaceable>name</replaceable></arg> 39 <arg choice="req">--profile=<replaceable>name</replaceable></arg> 40 <arg choice="plain">list</arg> 41 <arg choice="plain">instances</arg> 42 <arg>--state=<replaceable>string</replaceable></arg> 43 <arg>--compartment-id=<replaceable>string</replaceable></arg> 44 </cmdsynopsis> 45 <cmdsynopsis id="synopsis-vboxmanage-cloudlist-images"> 46 <command>VBoxManage cloud</command> 47 <arg choice="req">--provider=<replaceable>name</replaceable></arg> 48 <arg choice="req">--profile=<replaceable>name</replaceable></arg> 49 <arg choice="plain">list</arg> 50 <arg choice="plain">images</arg> 51 <arg choice="req">--compartment-id=<replaceable>string</replaceable></arg> 52 <arg>--state=<replaceable>string</replaceable></arg> 53 </cmdsynopsis> 54 55 <!-- Cloud instance commands --> 56 <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-create" sepchar=" "> 57 <command moreinfo="none">VBoxManage cloud</command> 58 <arg choice="req" rep="norepeat">--provider=<replaceable>name</replaceable></arg> 59 <arg choice="req" rep="norepeat">--profile=<replaceable>name</replaceable></arg> 60 <arg choice="plain" rep="norepeat">instance</arg> 61 <arg choice="plain" rep="norepeat">create</arg> 62 <arg choice="req" rep="norepeat">--domain-name=<replaceable>name</replaceable></arg> 63 <group choice="req"> 64 <arg choice="req" rep="norepeat">--image-id=<replaceable>id</replaceable></arg> 65 <arg choice="req" rep="norepeat">--boot-volume-id=<replaceable>id</replaceable></arg> 66 </group> 67 <arg choice="req" rep="norepeat">--display-name=<replaceable>name</replaceable></arg> 68 <arg choice="req" rep="norepeat">--shape=<replaceable>type</replaceable></arg> 69 <arg choice="req" rep="norepeat">--subnet=<replaceable>id</replaceable></arg> 70 <arg rep="norepeat">--boot-disk-size=<replaceable>size in GB</replaceable></arg> 71 <arg rep="norepeat">--publicip=<replaceable>true/false</replaceable></arg> 72 <arg rep="norepeat">--privateip=<replaceable>IP address</replaceable></arg> 73 <arg rep="repeat">--public-ssh-key=<replaceable>key string</replaceable></arg> 74 <arg rep="norepeat">--launch-mode=<replaceable>NATIVE/EMULATED/PARAVIRTUALIZED</replaceable></arg> 75 </cmdsynopsis> 76 <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-info" sepchar=" "> 77 <command moreinfo="none">VBoxManage cloud</command> 78 <arg choice="req" rep="norepeat">--provider=<replaceable>name</replaceable></arg> 79 <arg choice="req" rep="norepeat">--profile=<replaceable>name</replaceable></arg> 80 <arg choice="plain" rep="norepeat">instance</arg> 81 <arg choice="plain" rep="norepeat">info</arg> 82 <arg choice="req" rep="norepeat">--id=<replaceable>unique id</replaceable></arg> 83 </cmdsynopsis> 84 <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-terminate" sepchar=" "> 85 <command moreinfo="none">VBoxManage cloud</command> 86 <arg choice="req" rep="norepeat">--provider=<replaceable>name</replaceable></arg> 87 <arg choice="req" rep="norepeat">--profile=<replaceable>name</replaceable></arg> 88 <arg choice="plain" rep="norepeat">instance</arg> 89 <arg choice="plain" rep="norepeat">terminate</arg> 90 <arg choice="req" rep="norepeat">--id=<replaceable>unique id</replaceable></arg> 91 </cmdsynopsis> 92 <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-start" sepchar=" "> 93 <command moreinfo="none">VBoxManage cloud</command> 94 <arg choice="req" rep="norepeat">--provider=<replaceable>name</replaceable></arg> 95 <arg choice="req" rep="norepeat">--profile=<replaceable>name</replaceable></arg> 96 <arg choice="plain" rep="norepeat">instance</arg> 97 <arg choice="plain" rep="norepeat">start</arg> 98 <arg choice="req" rep="norepeat">--id=<replaceable>unique id</replaceable></arg> 99 </cmdsynopsis> 100 <cmdsynopsis id="synopsis-vboxmanage-cloudinstance-pause" sepchar=" "> 101 <command moreinfo="none">VBoxManage cloud</command> 102 <arg choice="req" rep="norepeat">--provider=<replaceable>name</replaceable></arg> 103 <arg choice="req" rep="norepeat">--profile=<replaceable>name</replaceable></arg> 104 <arg choice="plain" rep="norepeat">instance</arg> 105 <arg choice="plain" rep="norepeat">pause</arg> 106 <arg choice="req" rep="norepeat">--id=<replaceable>unique id</replaceable></arg> 107 </cmdsynopsis> 108 109 <!-- Cloud image commands --> 110 <cmdsynopsis id="synopsis-vboxmanage-cloudimage-create" sepchar=" "> <!-- The 'id' is mandatory and must start with 'synopsis-'. --> 111 <command>VBoxManage cloud</command> 112 <arg choice="req" rep="norepeat">--provider=<replaceable>name</replaceable></arg> 113 <arg choice="req" rep="norepeat">--profile=<replaceable>name</replaceable></arg> 114 <arg choice="plain" rep="norepeat">image</arg> 115 <arg choice="plain" rep="norepeat">create</arg> 116 <arg choice="req" rep="norepeat">--display-name=<replaceable>name</replaceable></arg> 117 <arg rep="norepeat">--bucket-name=<replaceable>name</replaceable></arg> 118 <arg rep="norepeat">--object-name=<replaceable>name</replaceable></arg> 119 <arg rep="norepeat">--instance-id=<replaceable>unique id</replaceable></arg> 120 </cmdsynopsis> 121 <cmdsynopsis id="synopsis-vboxmanage-cloudimage-info" sepchar=" "> 122 <command>VBoxManage cloud</command> 123 <arg choice="req" rep="norepeat">--provider=<replaceable>name</replaceable></arg> 124 <arg choice="req" rep="norepeat">--profile=<replaceable>name</replaceable></arg> 125 <arg choice="plain" rep="norepeat">image</arg> 126 <arg choice="plain" rep="norepeat">info</arg> 127 <arg choice="req" rep="norepeat">--id=<replaceable>unique id</replaceable></arg> 128 </cmdsynopsis> 129 <cmdsynopsis id="synopsis-vboxmanage-cloudimage-delete" sepchar=" "> 130 <command>VBoxManage cloud</command> 131 <arg choice="req" rep="norepeat">--provider=<replaceable>name</replaceable></arg> 132 <arg choice="req" rep="norepeat">--profile=<replaceable>name</replaceable></arg> 133 <arg choice="plain" rep="norepeat">image</arg> 134 <arg choice="plain" rep="norepeat">delete</arg> 135 <arg choice="req" rep="norepeat">--id=<replaceable>unique id</replaceable></arg> 136 </cmdsynopsis> 137 <cmdsynopsis id="synopsis-vboxmanage-cloudimage-import" sepchar=" "> 138 <command>VBoxManage cloud</command> 139 <arg choice="req" rep="norepeat">--provider=<replaceable>name</replaceable></arg> 140 <arg choice="req" rep="norepeat">--profile=<replaceable>name</replaceable></arg> 141 <arg choice="plain" rep="norepeat">image</arg> 142 <arg choice="plain" rep="norepeat">import</arg> 143 <arg choice="req" rep="norepeat">--id=<replaceable>unique id</replaceable></arg> 144 <arg rep="norepeat">--bucket-name=<replaceable>name</replaceable></arg> 145 <arg rep="norepeat">--object-name=<replaceable>name</replaceable></arg> 146 </cmdsynopsis> 147 <cmdsynopsis id="synopsis-vboxmanage-cloudimage-export" sepchar=" "> 148 <command>VBoxManage cloud</command> 149 <arg choice="req" rep="norepeat">--provider=<replaceable>name</replaceable></arg> 150 <arg choice="req" rep="norepeat">--profile=<replaceable>name</replaceable></arg> 151 <arg choice="plain" rep="norepeat">image</arg> 152 <arg choice="plain" rep="norepeat">export</arg> 153 <arg choice="req" rep="norepeat">--id=<replaceable>unique id</replaceable></arg> 154 <arg choice="req" rep="norepeat">--display-name=<replaceable>name</replaceable></arg> 155 <arg rep="norepeat">--bucket-name=<replaceable>name</replaceable></arg> 156 <arg rep="norepeat">--object-name=<replaceable>name</replaceable></arg> 157 </cmdsynopsis> 158 159 <!-- Cloud network commands --> 35 160 <cmdsynopsis id="synopsis-vboxmanage-cloud-network-setup"> <!-- The 'id' is mandatory and must start with 'synopsis-'. --> 36 161 <command>VBoxManage cloud</command> … … 83 208 <title>Description</title> 84 209 85 <refsect2 id="vboxmanage-cloud-network-common-options"> 210 <!-- Cloud commands common options --> 211 <refsect2 id="vboxmanage-cloud-common-options"> 86 212 <title>Common options</title> 87 213 <remark role="help-scope" condition="GLOBAL"/> 88 <para>The subcommands of <command>cloud</command> implement the standard CRUD operations for a cloud profile.214 <para>The word "cloud" is an umbrella for all commands related to the interconnection with the Cloud. 89 215 The next common options must be placed between the "cloud" and the following sub-commands:</para> 90 216 <variablelist> … … 100 226 </refsect2> 101 227 228 <!-- Cloud list commands --> 229 <refsect2 id="vboxmanage-cloudlist-instances"> 230 <title>cloud list instances</title> 231 <remark role="help-copy-synopsis"/> 232 <para> 233 Displays the list of the instances for a specified compartment. 234 </para> 235 <variablelist> 236 <varlistentry> 237 <term>--state<replaceable>"running/paused/terminated"</replaceable></term> 238 <listitem> 239 <para>The state of cloud instance. The possible states are "running/paused/terminated" at moment. 240 If the state isn't provided the list of instances with all possible states is returned. 241 </para> 242 </listitem> 243 </varlistentry> 244 <varlistentry> 245 <term><option>--compartment-id</option></term> 246 <listitem> 247 <para>A compartment is the logical container used to organize and isolate cloud resources. 248 The different cloud providers can have the different names for this entity. 249 </para> 250 </listitem> 251 </varlistentry> 252 </variablelist> 253 </refsect2> 254 255 <refsect2 id="vboxmanage-cloudlist-images"> 256 <title>cloud list images</title> 257 <remark role="help-copy-synopsis"/> 258 <para> 259 Displays the list of the images for a specified compartment. 260 </para> 261 <variablelist> 262 <varlistentry> 263 <term>--state<replaceable>"available/disabled/deleted"</replaceable></term> 264 <listitem> 265 <para>The state of cloud image. The possible states are "available/disabled/deleted" at moment. 266 If the state isn't provided the list of images with all possible states is returned. 267 </para> 268 </listitem> 269 </varlistentry> 270 <varlistentry> 271 <term><option>--compartment-id</option></term> 272 <listitem> 273 <para>A compartment is the logical container used to organize and isolate cloud resources. 274 The different cloud providers can have the different names for this entity. 275 </para> 276 </listitem> 277 </varlistentry> 278 </variablelist> 279 </refsect2> 280 281 <!-- Cloud instance commands --> 282 <refsect2 id="vboxmanage-cloudinstance-create"> 283 <title>cloud instance create</title> 284 <remark role="help-copy-synopsis"/> 285 <para> 286 Creates new instance in the Cloud. 287 There are two standard ways to create an instance in the Cloud: 288 1. Create an instance from an existing custom image. 289 2. Create an instance from an existing bootable volume. This bootable volume shouldn't be attached to any instance. 290 For the 1st approach next parameters are required: image-id and boot-disk-size. 291 For the 2nd approach next parameters are required: boot-volume-id; 292 The rest parameters are common for both cases: 293 display-name, launch-mode, subnet-id, publicIP, privateIP, shape, domain. 294 </para> 295 <variablelist> 296 <varlistentry> 297 <term><option>--domain-name</option></term><listitem><para>Cloud domain where new instance is created.</para></listitem> 298 </varlistentry> 299 <varlistentry> 300 <term><option>--image-id</option></term><listitem><para>Unique identifier which fully identifies a custom image in the Cloud.</para></listitem> 301 </varlistentry> 302 <varlistentry> 303 <term><option>--boot-volume-id</option></term><listitem><para>Unique identifier which fully identifies a boot volume in the Cloud.</para></listitem> 304 </varlistentry> 305 <varlistentry> 306 <term><option>--display-name</option></term><listitem><para>Name for new instance in the Cloud.</para></listitem> 307 </varlistentry> 308 <varlistentry> 309 <term><option>--shape</option></term><listitem><para> The shape of instance, defines the number of CPUs and RAM memory.</para></listitem> 310 </varlistentry> 311 <varlistentry> 312 <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> 313 </varlistentry> 314 <varlistentry> 315 <term><option>--boot-disk-size</option></term><listitem><para> The size of bootable image in GB. Default is 50GB.</para></listitem> 316 </varlistentry> 317 <varlistentry> 318 <term><option>--publicip</option></term><listitem><para>Whether the instance will have a public IP or not.</para></listitem> 319 </varlistentry> 320 <varlistentry> 321 <term><option>--privateip</option></term><listitem><para>Private IP address for the created instance.</para></listitem> 322 </varlistentry> 323 <varlistentry> 324 <term><option>--public-ssh-key</option></term> 325 <listitem> 326 <para>Public SSH key used to connect to the instance via SSH. 327 This parameter may be repeated if you plan to use more than one key as: 328 "--public-ssh-key=firstSSHKey --public-ssh-key=secondSSHKey". 329 </para> 330 </listitem> 331 </varlistentry> 332 <varlistentry> 333 <term><option>--launch-mode</option></term><listitem><para>The most known values here may be EMULATED, NATIVE, PARAVIRTUALIZED. </para></listitem> 334 </varlistentry> 335 </variablelist> 336 </refsect2> 337 338 <refsect2 id="vboxmanage-cloudinstance-info"> 339 <title>cloud instance info</title> 340 <para> 341 Display information about a cloud instance with a specified id. 342 </para> 343 <variablelist> 344 <varlistentry> 345 <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem> 346 </varlistentry> 347 </variablelist> 348 </refsect2> 349 350 <refsect2 id="vboxmanage-cloudinstance-terminate"> 351 <title>cloud instance termination</title> 352 <para> 353 Delete a cloud instance with a specified id. 354 </para> 355 <variablelist> 356 <varlistentry> 357 <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem> 358 </varlistentry> 359 </variablelist> 360 </refsect2> 361 362 <refsect2 id="vboxmanage-cloudinstance-start"> 363 <title>cloud instance start</title> 364 <para> 365 Start a cloud instance with a specified id. 366 </para> 367 <variablelist> 368 <varlistentry> 369 <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem> 370 </varlistentry> 371 </variablelist> 372 </refsect2> 373 374 <refsect2 id="vboxmanage-cloudinstance-pause"> 375 <title>cloud instance pause</title> 376 <para> 377 Pause a cloud instance with a specified id. 378 </para> 379 <variablelist> 380 <varlistentry> 381 <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem> 382 </varlistentry> 383 </variablelist> 384 </refsect2> 385 386 387 <!-- Cloud image commands --> 388 <refsect2 id="vboxmanage-cloudimage-create"> 389 <title>cloud image create</title> 390 <remark role="help-copy-synopsis"/> 391 <para> 392 Creates new image in the Cloud. 393 There are two standard ways to create an image in the Cloud: 394 1. Create an image from an object in the Cloud Storage; 395 2. Create an image from an existing cloud instance. 396 For the 1st approach next parameters are required: 397 bucket-name - cloud bucket name where an object is located; 398 object-name - name of object in the bucket; 399 display-name - name for new image in the Cloud. 400 For the 2d approach next parameters are required: 401 instance-id - Id of instance in the Cloud; 402 display-name - name for new image in the Cloud. 403 </para> 404 <variablelist> 405 <varlistentry> 406 <term><option>--display-name</option></term><listitem><para>Name for new image in the Cloud.</para></listitem> 407 </varlistentry> 408 <varlistentry> 409 <term><option>--bucket-name</option></term><listitem><para>Cloud bucket name where an object is located.</para></listitem> 410 </varlistentry> 411 <varlistentry> 412 <term><option>--object-name</option></term><listitem><para>Name of object in the bucket.</para></listitem> 413 </varlistentry> 414 <varlistentry> 415 <term><option>--instance-id</option></term><listitem><para>Unique identifier which fully identifies the instance in the Cloud.</para></listitem> 416 </varlistentry> 417 </variablelist> 418 </refsect2> 419 420 <refsect2 id="vboxmanage-cloudimage-info"> 421 <title>cloud image info</title> 422 <remark role="help-copy-synopsis"/> 423 <para> 424 Display information about a cloud image with a specified id. 425 </para> 426 <variablelist> 427 <varlistentry> 428 <term><option>--id</option></term><listitem><para>Unique identifier which fully identifies the image in the Cloud.</para></listitem> 429 </varlistentry> 430 </variablelist> 431 </refsect2> 432 433 <refsect2 id="vboxmanage-cloudimage-delete"> 434 <title>cloud image delete</title> 435 <remark role="help-copy-synopsis"/> 436 <para> 437 Delete an image with a specified id from the Cloud. 438 </para> 439 <variablelist> 440 <varlistentry> 441 <term><option>--id</option></term><listitem><para>Unique identifier which fully identifies the image in the Cloud.</para></listitem> 442 </varlistentry> 443 </variablelist> 444 </refsect2> 445 446 <refsect2 id="vboxmanage-cloudimage-import"> 447 <title>cloud image import</title> 448 <remark role="help-copy-synopsis"/> 449 <para> 450 Import an image with a specified id from the Cloud to a local host. 451 The result is an object in the local "temp" folder on the local host. 452 Possible approach may have two general steps: 453 1. Create an object from an image in the Cloud Storage; 454 2. Download the object to the local host. 455 So the next parameters may be required: 456 bucket-name - cloud bucket name where the object will be created; 457 object-name - name of object in the bucket. if parameter "object-name" is absent a displayed image name is used. 458 If the first step isn't needed only the parameter "id" is required. 459 </para> 460 <variablelist> 461 <varlistentry> 462 <term><option>--id</option></term><listitem><para>Unique identifier which fully identifies the image in the Cloud.</para></listitem> 463 </varlistentry> 464 <varlistentry> 465 <term><option>--bucket-name</option></term><listitem><para>Cloud bucket name where an object will be created.</para></listitem> 466 </varlistentry> 467 <varlistentry> 468 <term><option>--object-name</option></term> 469 <listitem> 470 <para> 471 Name of created object in the bucket. The downloaded object will have this name. 472 </para> 473 </listitem> 474 </varlistentry> 475 </variablelist> 476 </refsect2> 477 478 <refsect2 id="vboxmanage-cloudimage-export"> 479 <title>cloud image export</title> 480 <remark role="help-copy-synopsis"/> 481 <para> 482 Export an existing VBox image with a specified uuid from a local host to the Cloud. 483 The result is new image in the Cloud. 484 Possible approach may have two general steps: 485 1. Upload VBox image to the Cloud Storage; 486 2. Create an image from the uploaded object. 487 So the next parameters may be required: 488 bucket-name -cloud bucket name where the object will be uploaded; 489 object-name - name of object in the bucket. If parameter "object-name" is absent the image id is used; 490 display-name - name for new image in the Cloud. 491 If the first step isn't needed the parameters "id" and "display-name" are required only. 492 </para> 493 <variablelist> 494 <varlistentry> 495 <term><option>--id</option></term><listitem><para>Unique identifier of the image in the VirtualBox.</para></listitem> 496 </varlistentry> 497 <varlistentry> 498 <term><option>--display-name</option></term><listitem><para>Name for new image in the Cloud.</para></listitem> 499 </varlistentry> 500 <varlistentry> 501 <term><option>--bucket-name</option></term><listitem><para>Cloud bucket name where the image (object) will be uploaded.</para></listitem> 502 </varlistentry> 503 <varlistentry> 504 <term><option>--object-name</option></term><listitem><para>Name of object in the bucket.</para></listitem> 505 </varlistentry> 506 </variablelist> 507 </refsect2> 508 509 510 <!-- Cloud network commands --> 102 511 <refsect2 id="vboxmanage-cloud-network-setup"> 103 512 <title>cloud network setup</title> -
trunk/doc/manual/en_US/user_Introduction.xml
r82350 r84692 3749 3749 You can also use the <command>VBoxManage cloud 3750 3750 instance</command> command to create and manage instances on a 3751 cloud service. See <xref linkend="vboxmanage-cloud instance"/>.3751 cloud service. See <xref linkend="vboxmanage-cloud"/>. 3752 3752 </para> 3753 3753 -
trunk/doc/manual/en_US/user_VBoxManage.xml
r84144 r84692 9099 9099 <xi:include href="user_man_VBoxManage-cloudprofile.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 9100 9100 9101 <xi:include href="user_man_VBoxManage-cloudlist.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 9102 9103 <xi:include href="user_man_VBoxManage-cloudinstance.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 9104 9105 <xi:include href="user_man_VBoxManage-cloudimage.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 9101 <xi:include href="user_man_VBoxManage-cloud.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" /> 9106 9102 9107 9103 <xi:include href="user_man_VBoxManage-signova.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
Note:
See TracChangeset
for help on using the changeset viewer.