Merge "Update CLI reference for python-ceilometerclient 1.4.0"
This commit is contained in:
Jenkins
Gerrit Code Review
commit
414af34914
@ -15,7 +15,7 @@
|
||||
interface (CLI) for the Telemetry API and its extensions.
|
||||
|
||||
This chapter documents <command>ceilometer</command> version
|
||||
<literal>1.3.0</literal>.
|
||||
<literal>1.4.0</literal>.
|
||||
</para>
|
||||
|
||||
<para>For help on a specific <command>ceilometer</command>
|
||||
@ -313,7 +313,7 @@
|
||||
<term><command>sample-show</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Show an sample.
|
||||
Show a sample.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
@ -698,19 +698,19 @@ Create a new alarm based on state of other alarms.
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--alarm-action <Webhook URL> URL</command></term>
|
||||
<term><command>--alarm-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
to invoke when state transitions to alarm.
|
||||
URL to invoke when state transitions to alarm.
|
||||
May be used multiple times. Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--ok-action <Webhook URL> URL</command></term>
|
||||
<term><command>--ok-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
to invoke when state transitions to OK.
|
||||
URL to invoke when state transitions to OK.
|
||||
May be used multiple times. Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
@ -864,19 +864,19 @@ Update an existing alarm based on state of other alarms.
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--alarm-action <Webhook URL> URL</command></term>
|
||||
<term><command>--alarm-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
to invoke when state transitions to alarm.
|
||||
URL to invoke when state transitions to alarm.
|
||||
May be used multiple times. Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--ok-action <Webhook URL> URL</command></term>
|
||||
<term><command>--ok-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
to invoke when state transitions to OK.
|
||||
URL to invoke when state transitions to OK.
|
||||
May be used multiple times. Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
@ -1039,19 +1039,19 @@ Create a new alarm based on computed statistics.
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--alarm-action <Webhook URL> URL</command></term>
|
||||
<term><command>--alarm-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
to invoke when state transitions to alarm.
|
||||
URL to invoke when state transitions to alarm.
|
||||
May be used multiple times. Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--ok-action <Webhook URL> URL</command></term>
|
||||
<term><command>--ok-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
to invoke when state transitions to OK.
|
||||
URL to invoke when state transitions to OK.
|
||||
May be used multiple times. Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
@ -1235,19 +1235,19 @@ Update an existing alarm based on computed statistics.
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--alarm-action <Webhook URL> URL</command></term>
|
||||
<term><command>--alarm-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
to invoke when state transitions to alarm.
|
||||
URL to invoke when state transitions to alarm.
|
||||
May be used multiple times. Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--ok-action <Webhook URL> URL</command></term>
|
||||
<term><command>--ok-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
to invoke when state transitions to OK.
|
||||
URL to invoke when state transitions to OK.
|
||||
May be used multiple times. Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
@ -1429,19 +1429,19 @@ Create a new alarm based on computed statistics.
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--alarm-action <Webhook URL> URL</command></term>
|
||||
<term><command>--alarm-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
to invoke when state transitions to alarm.
|
||||
URL to invoke when state transitions to alarm.
|
||||
May be used multiple times. Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--ok-action <Webhook URL> URL</command></term>
|
||||
<term><command>--ok-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
to invoke when state transitions to OK.
|
||||
URL to invoke when state transitions to OK.
|
||||
May be used multiple times. Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
@ -1643,19 +1643,19 @@ Update an existing alarm based on computed statistics.
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--alarm-action <Webhook URL> URL</command></term>
|
||||
<term><command>--alarm-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
to invoke when state transitions to alarm.
|
||||
URL to invoke when state transitions to alarm.
|
||||
May be used multiple times. Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--ok-action <Webhook URL> URL</command></term>
|
||||
<term><command>--ok-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
to invoke when state transitions to OK.
|
||||
URL to invoke when state transitions to OK.
|
||||
May be used multiple times. Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
@ -1865,19 +1865,19 @@ Create a new alarm based on computed statistics.
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--alarm-action <Webhook URL> URL</command></term>
|
||||
<term><command>--alarm-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
to invoke when state transitions to alarm.
|
||||
URL to invoke when state transitions to alarm.
|
||||
May be used multiple times. Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--ok-action <Webhook URL> URL</command></term>
|
||||
<term><command>--ok-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
to invoke when state transitions to OK.
|
||||
URL to invoke when state transitions to OK.
|
||||
May be used multiple times. Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
@ -2087,19 +2087,19 @@ Update an existing alarm based on computed statistics.
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--alarm-action <Webhook URL> URL</command></term>
|
||||
<term><command>--alarm-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
to invoke when state transitions to alarm.
|
||||
URL to invoke when state transitions to alarm.
|
||||
May be used multiple times. Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--ok-action <Webhook URL> URL</command></term>
|
||||
<term><command>--ok-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
to invoke when state transitions to OK.
|
||||
URL to invoke when state transitions to OK.
|
||||
May be used multiple times. Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
@ -2415,19 +2415,19 @@ Create a new alarm based on computed statistics.
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--alarm-action <Webhook URL> URL</command></term>
|
||||
<term><command>--alarm-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
to invoke when state transitions to alarm.
|
||||
URL to invoke when state transitions to alarm.
|
||||
May be used multiple times. Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--ok-action <Webhook URL> URL</command></term>
|
||||
<term><command>--ok-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
to invoke when state transitions to OK.
|
||||
URL to invoke when state transitions to OK.
|
||||
May be used multiple times. Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
@ -2629,19 +2629,19 @@ Update an existing alarm based on computed statistics.
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--alarm-action <Webhook URL> URL</command></term>
|
||||
<term><command>--alarm-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
to invoke when state transitions to alarm.
|
||||
URL to invoke when state transitions to alarm.
|
||||
May be used multiple times. Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--ok-action <Webhook URL> URL</command></term>
|
||||
<term><command>--ok-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
to invoke when state transitions to OK.
|
||||
URL to invoke when state transitions to OK.
|
||||
May be used multiple times. Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
@ -2990,7 +2990,7 @@ Show the resource.
|
||||
--meter-unit <METER_UNIT> --sample-volume
|
||||
<SAMPLE_VOLUME>
|
||||
[--resource-metadata <RESOURCE_METADATA>]
|
||||
[--timestamp <TIMESTAMP>]</computeroutput></screen>
|
||||
[--timestamp <TIMESTAMP>] [--direct <DIRECT>]</computeroutput></screen>
|
||||
<para>
|
||||
Create a sample.
|
||||
</para> <variablelist wordsize="10">
|
||||
@ -3070,11 +3070,20 @@ Create a sample.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--direct <DIRECT></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Post sample to storage directly. Defaults to
|
||||
False.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="ceilometerclient_subcommand_sample-create-list">
|
||||
<title>ceilometer sample-create-list</title>
|
||||
<screen><computeroutput>usage: ceilometer sample-create-list <SAMPLES_LIST></computeroutput></screen>
|
||||
<screen><computeroutput>usage: ceilometer sample-create-list [--direct <DIRECT>] <SAMPLES_LIST></computeroutput></screen>
|
||||
<para>
|
||||
Create a sample list.
|
||||
</para> <variablelist wordsize="10">
|
||||
@ -3087,6 +3096,17 @@ Create a sample list.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>--direct <DIRECT></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Post samples to storage directly. Defaults to False.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<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>
|
||||
<screen><computeroutput>usage: ceilometer sample-show <SAMPLE_ID></computeroutput></screen>
|
||||
<para>
|
||||
Show an sample.
|
||||
Show a sample.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user