openstack/openstack-manuals
Code Issues Proposed changes

Merge "Update CLI reference for python-ceilometerclient 1.4.0"

Browse Source
This commit is contained in:
Jenkins 2015-08-25 14:42:26 +00:00 committed by Gerrit Code Review
commit 414af34914
1 changed files with 65 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

110
doc/cli-reference/generated/ch_cli_ceilometer_commands.xml
View File

@ -15,7 +15,7 @@
interface (CLI) for the Telemetry API and its extensions. interface (CLI) for the Telemetry API and its extensions.
This chapter documents <command>ceilometer</command> version This chapter documents <command>ceilometer</command> version
<literal>1.3.0</literal>. <literal>1.4.0</literal>.
</para> </para>
<para>For help on a specific <command>ceilometer</command> <para>For help on a specific <command>ceilometer</command>
@ -313,7 +313,7 @@
<term><command>sample-show</command></term> <term><command>sample-show</command></term>
<listitem> <listitem>
<para> <para>
Show an sample. Show a sample.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -698,19 +698,19 @@ Create a new alarm based on state of other alarms.
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--alarm-action &lt;Webhook URL&gt; URL</command></term> <term><command>--alarm-action &lt;Webhook URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
to invoke when state transitions to alarm. URL to invoke when state transitions to alarm.
May be used multiple times. Defaults to None. May be used multiple times. Defaults to None.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--ok-action &lt;Webhook URL&gt; URL</command></term> <term><command>--ok-action &lt;Webhook URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
to invoke when state transitions to OK. URL to invoke when state transitions to OK.
May be used multiple times. Defaults to None. May be used multiple times. Defaults to None.
</para> </para>
</listitem> </listitem>
@ -864,19 +864,19 @@ Update an existing alarm based on state of other alarms.
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--alarm-action &lt;Webhook URL&gt; URL</command></term> <term><command>--alarm-action &lt;Webhook URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
to invoke when state transitions to alarm. URL to invoke when state transitions to alarm.
May be used multiple times. Defaults to None. May be used multiple times. Defaults to None.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--ok-action &lt;Webhook URL&gt; URL</command></term> <term><command>--ok-action &lt;Webhook URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
to invoke when state transitions to OK. URL to invoke when state transitions to OK.
May be used multiple times. Defaults to None. May be used multiple times. Defaults to None.
</para> </para>
</listitem> </listitem>
@ -1039,19 +1039,19 @@ Create a new alarm based on computed statistics.
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--alarm-action &lt;Webhook URL&gt; URL</command></term> <term><command>--alarm-action &lt;Webhook URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
to invoke when state transitions to alarm. URL to invoke when state transitions to alarm.
May be used multiple times. Defaults to None. May be used multiple times. Defaults to None.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--ok-action &lt;Webhook URL&gt; URL</command></term> <term><command>--ok-action &lt;Webhook URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
to invoke when state transitions to OK. URL to invoke when state transitions to OK.
May be used multiple times. Defaults to None. May be used multiple times. Defaults to None.
</para> </para>
</listitem> </listitem>
@ -1235,19 +1235,19 @@ Update an existing alarm based on computed statistics.
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--alarm-action &lt;Webhook URL&gt; URL</command></term> <term><command>--alarm-action &lt;Webhook URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
to invoke when state transitions to alarm. URL to invoke when state transitions to alarm.
May be used multiple times. Defaults to None. May be used multiple times. Defaults to None.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--ok-action &lt;Webhook URL&gt; URL</command></term> <term><command>--ok-action &lt;Webhook URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
to invoke when state transitions to OK. URL to invoke when state transitions to OK.
May be used multiple times. Defaults to None. May be used multiple times. Defaults to None.
</para> </para>
</listitem> </listitem>
@ -1429,19 +1429,19 @@ Create a new alarm based on computed statistics.
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--alarm-action &lt;Webhook URL&gt; URL</command></term> <term><command>--alarm-action &lt;Webhook URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
to invoke when state transitions to alarm. URL to invoke when state transitions to alarm.
May be used multiple times. Defaults to None. May be used multiple times. Defaults to None.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--ok-action &lt;Webhook URL&gt; URL</command></term> <term><command>--ok-action &lt;Webhook URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
to invoke when state transitions to OK. URL to invoke when state transitions to OK.
May be used multiple times. Defaults to None. May be used multiple times. Defaults to None.
</para> </para>
</listitem> </listitem>
@ -1643,19 +1643,19 @@ Update an existing alarm based on computed statistics.
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--alarm-action &lt;Webhook URL&gt; URL</command></term> <term><command>--alarm-action &lt;Webhook URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
to invoke when state transitions to alarm. URL to invoke when state transitions to alarm.
May be used multiple times. Defaults to None. May be used multiple times. Defaults to None.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--ok-action &lt;Webhook URL&gt; URL</command></term> <term><command>--ok-action &lt;Webhook URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
to invoke when state transitions to OK. URL to invoke when state transitions to OK.
May be used multiple times. Defaults to None. May be used multiple times. Defaults to None.
</para> </para>
</listitem> </listitem>
@ -1865,19 +1865,19 @@ Create a new alarm based on computed statistics.
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--alarm-action &lt;Webhook URL&gt; URL</command></term> <term><command>--alarm-action &lt;Webhook URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
to invoke when state transitions to alarm. URL to invoke when state transitions to alarm.
May be used multiple times. Defaults to None. May be used multiple times. Defaults to None.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--ok-action &lt;Webhook URL&gt; URL</command></term> <term><command>--ok-action &lt;Webhook URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
to invoke when state transitions to OK. URL to invoke when state transitions to OK.
May be used multiple times. Defaults to None. May be used multiple times. Defaults to None.
</para> </para>
</listitem> </listitem>
@ -2087,19 +2087,19 @@ Update an existing alarm based on computed statistics.
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--alarm-action &lt;Webhook URL&gt; URL</command></term> <term><command>--alarm-action &lt;Webhook URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
to invoke when state transitions to alarm. URL to invoke when state transitions to alarm.
May be used multiple times. Defaults to None. May be used multiple times. Defaults to None.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--ok-action &lt;Webhook URL&gt; URL</command></term> <term><command>--ok-action &lt;Webhook URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
to invoke when state transitions to OK. URL to invoke when state transitions to OK.
May be used multiple times. Defaults to None. May be used multiple times. Defaults to None.
</para> </para>
</listitem> </listitem>
@ -2415,19 +2415,19 @@ Create a new alarm based on computed statistics.
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--alarm-action &lt;Webhook URL&gt; URL</command></term> <term><command>--alarm-action &lt;Webhook URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
to invoke when state transitions to alarm. URL to invoke when state transitions to alarm.
May be used multiple times. Defaults to None. May be used multiple times. Defaults to None.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--ok-action &lt;Webhook URL&gt; URL</command></term> <term><command>--ok-action &lt;Webhook URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
to invoke when state transitions to OK. URL to invoke when state transitions to OK.
May be used multiple times. Defaults to None. May be used multiple times. Defaults to None.
</para> </para>
</listitem> </listitem>
@ -2629,19 +2629,19 @@ Update an existing alarm based on computed statistics.
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--alarm-action &lt;Webhook URL&gt; URL</command></term> <term><command>--alarm-action &lt;Webhook URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
to invoke when state transitions to alarm. URL to invoke when state transitions to alarm.
May be used multiple times. Defaults to None. May be used multiple times. Defaults to None.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><command>--ok-action &lt;Webhook URL&gt; URL</command></term> <term><command>--ok-action &lt;Webhook URL&gt;</command></term>
<listitem> <listitem>
<para> <para>
to invoke when state transitions to OK. URL to invoke when state transitions to OK.
May be used multiple times. Defaults to None. May be used multiple times. Defaults to None.
</para> </para>
</listitem> </listitem>
@ -2990,7 +2990,7 @@ Show the resource.
--meter-unit &lt;METER_UNIT&gt; --sample-volume --meter-unit &lt;METER_UNIT&gt; --sample-volume
&lt;SAMPLE_VOLUME&gt; &lt;SAMPLE_VOLUME&gt;
[--resource-metadata &lt;RESOURCE_METADATA&gt;] [--resource-metadata &lt;RESOURCE_METADATA&gt;]
[--timestamp &lt;TIMESTAMP&gt;]</computeroutput></screen> [--timestamp &lt;TIMESTAMP&gt;] [--direct &lt;DIRECT&gt;]</computeroutput></screen>
<para> <para>
Create a sample. Create a sample.
</para> <variablelist wordsize="10"> </para> <variablelist wordsize="10">
@ -3070,11 +3070,20 @@ Create a sample.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><command>--direct &lt;DIRECT&gt;</command></term>
<listitem>
<para>
Post sample to storage directly. Defaults to
False.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</section> </section>
<section xml:id="ceilometerclient_subcommand_sample-create-list"> <section xml:id="ceilometerclient_subcommand_sample-create-list">
<title>ceilometer sample-create-list</title> <title>ceilometer sample-create-list</title>
<screen><computeroutput>usage: ceilometer sample-create-list &lt;SAMPLES_LIST&gt;</computeroutput></screen> <screen><computeroutput>usage: ceilometer sample-create-list [--direct &lt;DIRECT&gt;] &lt;SAMPLES_LIST&gt;</computeroutput></screen>
<para> <para>
Create a sample list. Create a sample list.
</para> <variablelist wordsize="10"> </para> <variablelist wordsize="10">
@ -3087,6 +3096,17 @@ Create a sample list.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--direct &lt;DIRECT&gt;</command></term>
<listitem>
<para>
Post samples to storage directly. Defaults to False.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</section> </section>
<section xml:id="ceilometerclient_subcommand_sample-list"> <section xml:id="ceilometerclient_subcommand_sample-list">
@ -3128,7 +3148,7 @@ List the samples (return OldSample objects if -m/--meter is set).
<title>ceilometer sample-show</title> <title>ceilometer sample-show</title>
<screen><computeroutput>usage: ceilometer sample-show &lt;SAMPLE_ID&gt;</computeroutput></screen> <screen><computeroutput>usage: ceilometer sample-show &lt;SAMPLE_ID&gt;</computeroutput></screen>
<para> <para>
Show an sample. Show a sample.
</para> <variablelist wordsize="10"> </para> <variablelist wordsize="10">
<title>Positional arguments</title> <title>Positional arguments</title>
<varlistentry> <varlistentry>