Changeset 81093 in vbox for trunk/doc/manual

Timestamp:

Oct 1, 2019 9:59:14 AM (6 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

133700

Message:

bugref:9555. Update SDK reference and user manual.

Location:

trunk/doc/manual/en_US

Files:

• SDKRef.xml (modified) (2 diffs)
• man_VBoxManage-cloudinstance.xml (modified) (3 diffs)

trunk/doc/manual/en_US/SDKRef.xml

@@ -2616 +2616 @@
       <para>
         See the <link linkend="ICloudClient__launchVM">ICloudClient::launchVM</link>.
-        The function launches a new instance in OCI with a previously created custom image as a bootable image in OCI.
+        The function launches a new instance in OCI with a bootable volume previously created from a custom image in OCI or
+        as the source may be used an existing bootable volume which shouldn't be attached to any instance.
+        For launching instance from a custom image use the parameter VirtualSystemDescriptionType::CloudImageId.
+        For launching instance from a bootable volume use the parameter VirtualSystemDescriptionType::CloudBootVolumeId.
+        Only one of them must be presented otherwise the error will occur.
         The final result of this operation is a running instance. The id of created instance is returned
         in the parameter "description" (which is <link linkend="IVirtualSystemDescription">IVirtualSystemDescription</link>)
@@ -2629 +2633 @@
           </listitem>
           <listitem>
-            <para>VirtualSystemDescriptionType::CloudImageId - OCID of custom image used as a bootable image for the instance.</para>
-          </listitem>
-          <listitem>
-            <para> VirtualSystemDescriptionType::CloudBootDiskSize - The size of instance bootable image in GB.</para>
+            <para>
+              Use VirtualSystemDescriptionType::CloudImageId - OCID of custom image used as a bootable image for the instance
+              or
+              VirtualSystemDescriptionType::CloudBootVolumeId - OCID of existing and non-attached bootable volume used as a bootable volume for the instance.
+            </para>
+          </listitem>
+          <listitem>
+            <para>Add VirtualSystemDescriptionType::CloudBootDiskSize - The size of instance bootable volume in GB,
+              If you use VirtualSystemDescriptionType::CloudImageId.</para>
           </listitem>
           <listitem>

trunk/doc/manual/en_US/man_VBoxManage-cloudinstance.xml

@@ -39 +39 @@
       <arg choice="plain" rep="norepeat">create</arg>
       <arg choice="req" rep="norepeat">--domain-name=<replaceable>name</replaceable></arg>
-      <arg choice="req" rep="norepeat">--image-id=<replaceable>unique id</replaceable></arg>
+      <group choice="req">
+          <arg choice="req" rep="norepeat">--image-id=<replaceable>id</replaceable></arg>
+          <arg choice="req" rep="norepeat">--boot-volume-id=<replaceable>id</replaceable></arg>
+      </group>
       <arg choice="req" rep="norepeat">--display-name=<replaceable>name</replaceable></arg>
       <arg choice="req" rep="norepeat">--shape=<replaceable>type</replaceable></arg>
-      <arg choice="req" rep="norepeat">--subnet=<replaceable>unique id</replaceable></arg>
-      <arg choice="req" rep="norepeat">--boot-disk-size=<replaceable>size in GB</replaceable></arg>
+      <arg choice="req" rep="norepeat">--subnet=<replaceable>id</replaceable></arg>
+      <arg rep="norepeat">--boot-disk-size=<replaceable>size in GB</replaceable></arg>
       <arg rep="norepeat">--publicip=<replaceable>true/false</replaceable></arg>
       <arg rep="norepeat">--privateip=<replaceable>IP address</replaceable></arg>
@@ -109 +112 @@
         There are two standard ways to create an instance in the Cloud:
          1. Create an instance from an existing custom image.
-         2. Create an instance from an existing bootable volume.
+         2. Create an instance from an existing bootable volume. This bootable volume shouldn't  be attached to any instance.
         For the 1st approach next parameters are required: image-id and  boot-disk-size.
         For the 2nd approach next parameters are required: boot-volume-id;
@@ -123 +126 @@
         </varlistentry>
         <varlistentry>
+          <term><option>--boot-volume-id</option></term><listitem><para>Unique identifier which fully identifies a boot volume in the Cloud.</para></listitem>
+        </varlistentry>
+        <varlistentry>
           <term><option>--display-name</option></term><listitem><para>Name for new instance in the Cloud.</para></listitem>
         </varlistentry>