Changeset 102095 in vbox for trunk/doc

Timestamp:

Nov 15, 2023 10:21:46 AM (15 months ago)

Author:

vboxsync

Message:

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.

File:

• trunk/doc/manual/en_US/man_VBoxManage-cloud.xml (modified) (2 diffs)

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

@@ -156 +156 @@
        <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
        <arg>--clone-name=<replaceable>name for a clone instance</replaceable></arg>
+     </cmdsynopsis>
+     <cmdsynopsis id="synopsis-vboxmanage-cloud-instance-metriclist" sepchar=" ">
+       <command moreinfo="none">VBoxManage cloud</command>
+       <arg choice="req">--provider=<replaceable>name</replaceable></arg>
+       <arg choice="req">--profile=<replaceable>name</replaceable></arg>
+       <sbr/>
+       <arg choice="plain">instance metriclist</arg>
+       <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
+     </cmdsynopsis>
+     <cmdsynopsis id="synopsis-vboxmanage-cloud-instance-metricdata" sepchar=" ">
+       <command moreinfo="none">VBoxManage cloud</command>
+       <arg choice="req">--provider=<replaceable>name</replaceable></arg>
+       <arg choice="req">--profile=<replaceable>name</replaceable></arg>
+       <sbr/>
+       <arg choice="plain">instance metricdata</arg>
+       <arg choice="req">--id=<replaceable>unique id</replaceable></arg>
+       <arg choice="req">--metric-name=<replaceable>metric name</replaceable></arg>
+       <arg choice="req">--metric-points=<replaceable>number of history metric points</replaceable></arg>
      </cmdsynopsis>
 
@@ -502 +520 @@
     </refsect2>
 
+    <refsect2 id="vboxmanage-cloud-instance-metriclist">
+      <title>available list of metrics for cloud instances</title>
+      <remark role="help-copy-synopsis"/>
+      <para>
+        Displays the list of the available metrics for the instance.
+        The returned names must be used with the command "VBoxManage cloud instance metricdata".
+      </para>
+      <variablelist>
+        <varlistentry>
+          <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
+
+    <refsect2 id="vboxmanage-cloud-instance-metricdata">
+      <title>Displays cloud instance metric data</title>
+      <remark role="help-copy-synopsis"/>
+      <para>
+        Displays the metric data with the resolution 1 minute for the requested cloud instances.
+        The timestamps are returned in the format Rfc2822.
+      </para>
+      <variablelist>
+        <varlistentry>
+          <term><option>--id</option></term><listitem><para>Unique identifier which fully identify the instance in the Cloud.</para></listitem>
+        </varlistentry>
+        <varlistentry>
+            <term><option>--metric-name</option></term><listitem><para>Metric name</para></listitem>
+        </varlistentry>
+        <varlistentry>
+            <term><option>--metric-points</option></term>
+            <listitem>
+                <para>
+                    History metric point numbers start at 1 and can go backwards as long as history exists.
+                    Points are counted from the current time to the past. If user only wants the last actual value
+                    he passes the value "1". If 2 values need to be returned (last and second to last),
+                    the user passes "2", etc.
+                </para>
+            </listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
+
     <!-- Cloud image commands -->
     <refsect2 id="vboxmanage-cloud-image-create">