Update CLI reference for python-ceilometerclient 1.5.0
Change-Id: I2ee31d64d4547858bad8cfb9d03435619a2bcf30
This commit is contained in:
@@ -15,7 +15,7 @@
|
||||
interface (CLI) for the Telemetry API and its extensions.
|
||||
|
||||
This chapter documents <command>ceilometer</command> version
|
||||
<literal>1.4.0</literal>.
|
||||
<literal>1.5.0</literal>.
|
||||
</para>
|
||||
|
||||
<para>For help on a specific <command>ceilometer</command>
|
||||
@@ -84,6 +84,22 @@
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>alarm-event-create</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Create a new alarm based on events.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>alarm-event-update</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Update an existing alarm based on events.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>alarm-gnocchi-aggregation-by-metrics-threshold-create</command></term>
|
||||
<listitem>
|
||||
@@ -629,9 +645,9 @@
|
||||
[--ok-action <Webhook URL>]
|
||||
[--insufficient-data-action <Webhook URL>]
|
||||
[--time-constraint <Time Constraint>]
|
||||
[--repeat-actions {True|False}]
|
||||
--alarm_ids <ALARM IDS>
|
||||
[--operator <OPERATOR>]
|
||||
[--repeat-actions {True|False}]</computeroutput></screen>
|
||||
[--operator <OPERATOR>]</computeroutput></screen>
|
||||
<para>
|
||||
Create a new alarm based on state of other alarms.
|
||||
</para> <variablelist wordsize="10">
|
||||
@@ -741,6 +757,16 @@ Create a new alarm based on state of other alarms.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repeat-actions {True|False}</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
True if actions should be repeatedly notified
|
||||
while alarm remains in target state. Defaults
|
||||
to False.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--alarm_ids <ALARM IDS></command></term>
|
||||
<listitem>
|
||||
@@ -758,16 +784,6 @@ Create a new alarm based on state of other alarms.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repeat-actions {True|False}</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
True if actions should be repeatedly notified
|
||||
while alarm remains in target state. Defaults
|
||||
to False.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="ceilometerclient_subcommand_alarm-combination-update">
|
||||
@@ -783,10 +799,10 @@ Create a new alarm based on state of other alarms.
|
||||
[--ok-action <Webhook URL>]
|
||||
[--insufficient-data-action <Webhook URL>]
|
||||
[--time-constraint <Time Constraint>]
|
||||
[--repeat-actions {True|False}]
|
||||
[--remove-time-constraint <Constraint names>]
|
||||
[--alarm_ids <ALARM IDS>]
|
||||
[--operator <OPERATOR>]
|
||||
[--repeat-actions {True|False}]
|
||||
[<ALARM_ID>]</computeroutput></screen>
|
||||
<para>
|
||||
Update an existing alarm based on state of other alarms.
|
||||
@@ -907,6 +923,16 @@ Update an existing alarm based on state of other alarms.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repeat-actions {True|False}</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
True if actions should be repeatedly notified
|
||||
while alarm remains in target state. Defaults
|
||||
to False.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--remove-time-constraint <Constraint names></command></term>
|
||||
<listitem>
|
||||
@@ -933,15 +959,6 @@ Update an existing alarm based on state of other alarms.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repeat-actions {True|False}</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
True if actions should be repeatedly notified
|
||||
while alarm remains in target state.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="ceilometerclient_subcommand_alarm-delete">
|
||||
@@ -959,6 +976,323 @@ Delete an alarm.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="ceilometerclient_subcommand_alarm-event-create">
|
||||
<title>ceilometer alarm-event-create</title>
|
||||
<screen><computeroutput>usage: ceilometer alarm-event-create --name <NAME>
|
||||
[--project-id <ALARM_PROJECT_ID>]
|
||||
[--user-id <ALARM_USER_ID>]
|
||||
[--description <DESCRIPTION>]
|
||||
[--state <STATE>] [--severity <SEVERITY>]
|
||||
[--enabled {True|False}]
|
||||
[--alarm-action <Webhook URL>]
|
||||
[--ok-action <Webhook URL>]
|
||||
[--insufficient-data-action <Webhook URL>]
|
||||
[--time-constraint <Time Constraint>]
|
||||
[--repeat-actions {True|False}]
|
||||
[--event-type <EVENT_TYPE>] [-q <QUERY>]</computeroutput></screen>
|
||||
<para>
|
||||
Create a new alarm based on events.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>--name <NAME></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of the alarm (must be unique per tenant).
|
||||
Required.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--project-id <ALARM_PROJECT_ID></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Tenant to associate with alarm (only settable
|
||||
by admin users).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--user-id <ALARM_USER_ID></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
User to associate with alarm (only settable by
|
||||
admin users).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--description <DESCRIPTION></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Free text description of the alarm.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--state <STATE></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
State of the alarm, one of: ['ok', 'alarm',
|
||||
'insufficient data']
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--severity <SEVERITY></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Severity of the alarm, one of: ['low',
|
||||
'moderate', 'critical']
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--enabled {True|False}</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
True if alarm evaluation/actioning is enabled.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--alarm-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
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></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
URL to invoke when state transitions to OK.
|
||||
May be used multiple times. Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--insufficient-data-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
URL to invoke when state transitions to
|
||||
insufficient data. May be used multiple times.
|
||||
Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--time-constraint <Time Constraint></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Only evaluate the alarm if the time at
|
||||
evaluation is within this time constraint.
|
||||
Start point(s) of the constraint are specified
|
||||
with a cron expression, whereas its duration
|
||||
is given in seconds. Can be specified multiple
|
||||
times for multiple time constraints, format
|
||||
is: name=<CONSTRAINT_NAME>;start=<CRON>;durati
|
||||
on=<SECONDS>;[description=<DESCRIPTION>;[timez
|
||||
one=<IANA Timezone>]] Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repeat-actions {True|False}</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
True if actions should be repeatedly notified
|
||||
while alarm remains in target state. Defaults
|
||||
to False.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--event-type <EVENT_TYPE></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Event type for event alarm.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-q <QUERY>, --query <QUERY></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
key[op]data_type::value; list for filtering
|
||||
events. data_type is optional, but if supplied
|
||||
must be string, integer, float or datetime.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="ceilometerclient_subcommand_alarm-event-update">
|
||||
<title>ceilometer alarm-event-update</title>
|
||||
<screen><computeroutput>usage: ceilometer alarm-event-update [--name <NAME>]
|
||||
[--project-id <ALARM_PROJECT_ID>]
|
||||
[--user-id <ALARM_USER_ID>]
|
||||
[--description <DESCRIPTION>]
|
||||
[--state <STATE>] [--severity <SEVERITY>]
|
||||
[--enabled {True|False}]
|
||||
[--alarm-action <Webhook URL>]
|
||||
[--ok-action <Webhook URL>]
|
||||
[--insufficient-data-action <Webhook URL>]
|
||||
[--time-constraint <Time Constraint>]
|
||||
[--repeat-actions {True|False}]
|
||||
[--event-type <EVENT_TYPE>] [-q <QUERY>]
|
||||
[<ALARM_ID>]</computeroutput></screen>
|
||||
<para>
|
||||
Update an existing alarm based on events.
|
||||
</para> <variablelist wordsize="10">
|
||||
<title>Positional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command><ALARM_ID></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
ID of the alarm to update.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<variablelist wordsize="10">
|
||||
<title>Optional arguments</title>
|
||||
<varlistentry>
|
||||
<term><command>--name <NAME></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Name of the alarm (must be unique per tenant).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--project-id <ALARM_PROJECT_ID></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Tenant to associate with alarm (only settable
|
||||
by admin users).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--user-id <ALARM_USER_ID></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
User to associate with alarm (only settable by
|
||||
admin users).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--description <DESCRIPTION></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Free text description of the alarm.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--state <STATE></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
State of the alarm, one of: ['ok', 'alarm',
|
||||
'insufficient data']
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--severity <SEVERITY></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Severity of the alarm, one of: ['low',
|
||||
'moderate', 'critical']
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--enabled {True|False}</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
True if alarm evaluation/actioning is enabled.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--alarm-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
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></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
URL to invoke when state transitions to OK.
|
||||
May be used multiple times. Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--insufficient-data-action <Webhook URL></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
URL to invoke when state transitions to
|
||||
insufficient data. May be used multiple times.
|
||||
Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--time-constraint <Time Constraint></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Only evaluate the alarm if the time at
|
||||
evaluation is within this time constraint.
|
||||
Start point(s) of the constraint are specified
|
||||
with a cron expression, whereas its duration
|
||||
is given in seconds. Can be specified multiple
|
||||
times for multiple time constraints, format
|
||||
is: name=<CONSTRAINT_NAME>;start=<CRON>;durati
|
||||
on=<SECONDS>;[description=<DESCRIPTION>;[timez
|
||||
one=<IANA Timezone>]] Defaults to None.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repeat-actions {True|False}</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
True if actions should be repeatedly notified
|
||||
while alarm remains in target state. Defaults
|
||||
to False.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--event-type <EVENT_TYPE></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Event type for event alarm.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-q <QUERY>, --query <QUERY></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
key[op]data_type::value; list for filtering
|
||||
events. data_type is optional, but if supplied
|
||||
must be string, integer, float or datetime.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="ceilometerclient_subcommand_alarm-gnocchi-aggregation-by-metrics-threshold-create">
|
||||
@@ -969,10 +1303,10 @@ Delete an alarm.
|
||||
[--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}]
|
||||
[--alarm-action <Webhook URL>] [--ok-action <Webhook URL>]
|
||||
[--insufficient-data-action <Webhook URL>]
|
||||
[--time-constraint <Time Constraint>] [--granularity <GRANULARITY>]
|
||||
[--evaluation-periods <COUNT>] [--aggregation-method <AGGREATION>]
|
||||
[--comparison-operator <OPERATOR>] --threshold <THRESHOLD>
|
||||
[--repeat-actions {True|False}] -m <METRICS></computeroutput></screen>
|
||||
[--time-constraint <Time Constraint>] [--repeat-actions {True|False}]
|
||||
[--granularity <GRANULARITY>] [--evaluation-periods <COUNT>]
|
||||
[--aggregation-method <AGGREATION>] [--comparison-operator <OPERATOR>]
|
||||
--threshold <THRESHOLD> -m <METRICS></computeroutput></screen>
|
||||
<para>
|
||||
Create a new alarm based on computed statistics.
|
||||
</para> <variablelist wordsize="10">
|
||||
@@ -1082,6 +1416,16 @@ Create a new alarm based on computed statistics.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repeat-actions {True|False}</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
True if actions should be repeatedly notified
|
||||
while alarm remains in target state. Defaults
|
||||
to False.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--granularity <GRANULARITY></command></term>
|
||||
<listitem>
|
||||
@@ -1125,16 +1469,6 @@ Create a new alarm based on computed statistics.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repeat-actions {True|False}</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
True if actions should be repeatedly notified
|
||||
while alarm remains in target state. Defaults
|
||||
to False.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-m <METRICS>, --metrics <METRICS></command></term>
|
||||
<listitem>
|
||||
@@ -1153,10 +1487,10 @@ Create a new alarm based on computed statistics.
|
||||
[--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}]
|
||||
[--alarm-action <Webhook URL>] [--ok-action <Webhook URL>]
|
||||
[--insufficient-data-action <Webhook URL>]
|
||||
[--time-constraint <Time Constraint>] [--granularity <GRANULARITY>]
|
||||
[--evaluation-periods <COUNT>] [--aggregation-method <AGGREATION>]
|
||||
[--comparison-operator <OPERATOR>] [--threshold <THRESHOLD>]
|
||||
[--repeat-actions {True|False}] [-m <METRICS>]
|
||||
[--time-constraint <Time Constraint>] [--repeat-actions {True|False}]
|
||||
[--granularity <GRANULARITY>] [--evaluation-periods <COUNT>]
|
||||
[--aggregation-method <AGGREATION>] [--comparison-operator <OPERATOR>]
|
||||
[--threshold <THRESHOLD>] [-m <METRICS>]
|
||||
[--remove-time-constraint <Constraint names>]
|
||||
[<ALARM_ID>]</computeroutput></screen>
|
||||
<para>
|
||||
@@ -1278,6 +1612,16 @@ Update an existing alarm based on computed statistics.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repeat-actions {True|False}</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
True if actions should be repeatedly notified
|
||||
while alarm remains in target state. Defaults
|
||||
to False.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--granularity <GRANULARITY></command></term>
|
||||
<listitem>
|
||||
@@ -1321,16 +1665,6 @@ Update an existing alarm based on computed statistics.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repeat-actions {True|False}</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
True if actions should be repeatedly notified
|
||||
while alarm remains in target state. Defaults
|
||||
to False.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-m <METRICS>, --metrics <METRICS></command></term>
|
||||
<listitem>
|
||||
@@ -1358,11 +1692,11 @@ Update an existing alarm based on computed statistics.
|
||||
[--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}]
|
||||
[--alarm-action <Webhook URL>] [--ok-action <Webhook URL>]
|
||||
[--insufficient-data-action <Webhook URL>]
|
||||
[--time-constraint <Time Constraint>] [--granularity <GRANULARITY>]
|
||||
[--evaluation-periods <COUNT>] [--aggregation-method <AGGREATION>]
|
||||
[--comparison-operator <OPERATOR>] --threshold <THRESHOLD>
|
||||
[--repeat-actions {True|False}] -m <METRIC> --resource-type
|
||||
<RESOURCE_TYPE> --query <QUERY></computeroutput></screen>
|
||||
[--time-constraint <Time Constraint>] [--repeat-actions {True|False}]
|
||||
[--granularity <GRANULARITY>] [--evaluation-periods <COUNT>]
|
||||
[--aggregation-method <AGGREATION>] [--comparison-operator <OPERATOR>]
|
||||
--threshold <THRESHOLD> -m <METRIC> --resource-type <RESOURCE_TYPE>
|
||||
--query <QUERY></computeroutput></screen>
|
||||
<para>
|
||||
Create a new alarm based on computed statistics.
|
||||
</para> <variablelist wordsize="10">
|
||||
@@ -1472,6 +1806,16 @@ Create a new alarm based on computed statistics.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repeat-actions {True|False}</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
True if actions should be repeatedly notified
|
||||
while alarm remains in target state. Defaults
|
||||
to False.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--granularity <GRANULARITY></command></term>
|
||||
<listitem>
|
||||
@@ -1515,16 +1859,6 @@ Create a new alarm based on computed statistics.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repeat-actions {True|False}</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
True if actions should be repeatedly notified
|
||||
while alarm remains in target state. Defaults
|
||||
to False.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-m <METRIC>, --metric <METRIC></command></term>
|
||||
<listitem>
|
||||
@@ -1560,10 +1894,10 @@ Create a new alarm based on computed statistics.
|
||||
[--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}]
|
||||
[--alarm-action <Webhook URL>] [--ok-action <Webhook URL>]
|
||||
[--insufficient-data-action <Webhook URL>]
|
||||
[--time-constraint <Time Constraint>] [--granularity <GRANULARITY>]
|
||||
[--evaluation-periods <COUNT>] [--aggregation-method <AGGREATION>]
|
||||
[--comparison-operator <OPERATOR>] [--threshold <THRESHOLD>]
|
||||
[--repeat-actions {True|False}] [-m <METRIC>]
|
||||
[--time-constraint <Time Constraint>] [--repeat-actions {True|False}]
|
||||
[--granularity <GRANULARITY>] [--evaluation-periods <COUNT>]
|
||||
[--aggregation-method <AGGREATION>] [--comparison-operator <OPERATOR>]
|
||||
[--threshold <THRESHOLD>] [-m <METRIC>]
|
||||
[--resource-type <RESOURCE_TYPE>] [--query <QUERY>]
|
||||
[--remove-time-constraint <Constraint names>]
|
||||
[<ALARM_ID>]</computeroutput></screen>
|
||||
@@ -1686,6 +2020,16 @@ Update an existing alarm based on computed statistics.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repeat-actions {True|False}</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
True if actions should be repeatedly notified
|
||||
while alarm remains in target state. Defaults
|
||||
to False.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--granularity <GRANULARITY></command></term>
|
||||
<listitem>
|
||||
@@ -1729,16 +2073,6 @@ Update an existing alarm based on computed statistics.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repeat-actions {True|False}</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
True if actions should be repeatedly notified
|
||||
while alarm remains in target state. Defaults
|
||||
to False.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-m <METRIC>, --metric <METRIC></command></term>
|
||||
<listitem>
|
||||
@@ -1787,14 +2121,14 @@ Update an existing alarm based on computed statistics.
|
||||
[--ok-action <Webhook URL>]
|
||||
[--insufficient-data-action <Webhook URL>]
|
||||
[--time-constraint <Time Constraint>]
|
||||
[--repeat-actions {True|False}]
|
||||
[--granularity <GRANULARITY>]
|
||||
[--evaluation-periods <COUNT>]
|
||||
[--aggregation-method <AGGREATION>]
|
||||
[--comparison-operator <OPERATOR>]
|
||||
--threshold
|
||||
<THRESHOLD>
|
||||
[--repeat-actions {True|False}]
|
||||
-m <METRIC>
|
||||
<THRESHOLD> -m
|
||||
<METRIC>
|
||||
--resource-type
|
||||
<RESOURCE_TYPE>
|
||||
--resource-id
|
||||
@@ -1908,6 +2242,16 @@ Create a new alarm based on computed statistics.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repeat-actions {True|False}</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
True if actions should be repeatedly notified
|
||||
while alarm remains in target state. Defaults
|
||||
to False.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--granularity <GRANULARITY></command></term>
|
||||
<listitem>
|
||||
@@ -1951,16 +2295,6 @@ Create a new alarm based on computed statistics.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repeat-actions {True|False}</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
True if actions should be repeatedly notified
|
||||
while alarm remains in target state. Defaults
|
||||
to False.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-m <METRIC>, --metric <METRIC></command></term>
|
||||
<listitem>
|
||||
@@ -2000,12 +2334,12 @@ Create a new alarm based on computed statistics.
|
||||
[--ok-action <Webhook URL>]
|
||||
[--insufficient-data-action <Webhook URL>]
|
||||
[--time-constraint <Time Constraint>]
|
||||
[--repeat-actions {True|False}]
|
||||
[--granularity <GRANULARITY>]
|
||||
[--evaluation-periods <COUNT>]
|
||||
[--aggregation-method <AGGREATION>]
|
||||
[--comparison-operator <OPERATOR>]
|
||||
[--threshold <THRESHOLD>]
|
||||
[--repeat-actions {True|False}]
|
||||
[-m <METRIC>]
|
||||
[--resource-type <RESOURCE_TYPE>]
|
||||
[--resource-id <RESOURCE_ID>]
|
||||
@@ -2130,6 +2464,16 @@ Update an existing alarm based on computed statistics.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repeat-actions {True|False}</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
True if actions should be repeatedly notified
|
||||
while alarm remains in target state. Defaults
|
||||
to False.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--granularity <GRANULARITY></command></term>
|
||||
<listitem>
|
||||
@@ -2173,16 +2517,6 @@ Update an existing alarm based on computed statistics.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repeat-actions {True|False}</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
True if actions should be repeatedly notified
|
||||
while alarm remains in target state. Defaults
|
||||
to False.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-m <METRIC>, --metric <METRIC></command></term>
|
||||
<listitem>
|
||||
@@ -2343,12 +2677,12 @@ Set the state of an alarm.
|
||||
[--ok-action <Webhook URL>]
|
||||
[--insufficient-data-action <Webhook URL>]
|
||||
[--time-constraint <Time Constraint>]
|
||||
-m <METRIC> [--period <PERIOD>]
|
||||
[--repeat-actions {True|False}] -m
|
||||
<METRIC> [--period <PERIOD>]
|
||||
[--evaluation-periods <COUNT>]
|
||||
[--statistic <STATISTIC>]
|
||||
[--comparison-operator <OPERATOR>]
|
||||
--threshold <THRESHOLD> [-q <QUERY>]
|
||||
[--repeat-actions {True|False}]</computeroutput></screen>
|
||||
--threshold <THRESHOLD> [-q <QUERY>]</computeroutput></screen>
|
||||
<para>
|
||||
Create a new alarm based on computed statistics.
|
||||
</para> <variablelist wordsize="10">
|
||||
@@ -2458,6 +2792,16 @@ Create a new alarm based on computed statistics.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repeat-actions {True|False}</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
True if actions should be repeatedly notified
|
||||
while alarm remains in target state. Defaults
|
||||
to False.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-m <METRIC>, --meter-name <METRIC></command></term>
|
||||
<listitem>
|
||||
@@ -2519,16 +2863,6 @@ Create a new alarm based on computed statistics.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repeat-actions {True|False}</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
True if actions should be repeatedly notified
|
||||
while alarm remains in target state. Defaults
|
||||
to False.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="ceilometerclient_subcommand_alarm-threshold-update">
|
||||
@@ -2544,6 +2878,7 @@ Create a new alarm based on computed statistics.
|
||||
[--ok-action <Webhook URL>]
|
||||
[--insufficient-data-action <Webhook URL>]
|
||||
[--time-constraint <Time Constraint>]
|
||||
[--repeat-actions {True|False}]
|
||||
[--remove-time-constraint <Constraint names>]
|
||||
[-m <METRIC>] [--period <PERIOD>]
|
||||
[--evaluation-periods <COUNT>]
|
||||
@@ -2551,7 +2886,6 @@ Create a new alarm based on computed statistics.
|
||||
[--comparison-operator <OPERATOR>]
|
||||
[--threshold <THRESHOLD>]
|
||||
[-q <QUERY>]
|
||||
[--repeat-actions {True|False}]
|
||||
[<ALARM_ID>]</computeroutput></screen>
|
||||
<para>
|
||||
Update an existing alarm based on computed statistics.
|
||||
@@ -2672,6 +3006,16 @@ Update an existing alarm based on computed statistics.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repeat-actions {True|False}</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
True if actions should be repeatedly notified
|
||||
while alarm remains in target state. Defaults
|
||||
to False.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--remove-time-constraint <Constraint names></command></term>
|
||||
<listitem>
|
||||
@@ -2742,15 +3086,6 @@ Update an existing alarm based on computed statistics.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>--repeat-actions {True|False}</command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
True if actions should be repeatedly notified
|
||||
while alarm remains in target state.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="ceilometerclient_subcommand_capabilities">
|
||||
@@ -2762,7 +3097,7 @@ Print Ceilometer capabilities.
|
||||
</section>
|
||||
<section xml:id="ceilometerclient_subcommand_event-list">
|
||||
<title>ceilometer event-list</title>
|
||||
<screen><computeroutput>usage: ceilometer event-list [-q <QUERY>] [--no-traits]</computeroutput></screen>
|
||||
<screen><computeroutput>usage: ceilometer event-list [-q <QUERY>] [--no-traits] [-l <NUMBER>]</computeroutput></screen>
|
||||
<para>
|
||||
List events.
|
||||
</para> <variablelist wordsize="10">
|
||||
@@ -2785,6 +3120,14 @@ List events.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-l <NUMBER>, --limit <NUMBER></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Maximum number of events to return.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="ceilometerclient_subcommand_event-show">
|
||||
@@ -2813,7 +3156,7 @@ List event types.
|
||||
</section>
|
||||
<section xml:id="ceilometerclient_subcommand_meter-list">
|
||||
<title>ceilometer meter-list</title>
|
||||
<screen><computeroutput>usage: ceilometer meter-list [-q <QUERY>]</computeroutput></screen>
|
||||
<screen><computeroutput>usage: ceilometer meter-list [-q <QUERY>] [-l <NUMBER>]</computeroutput></screen>
|
||||
<para>
|
||||
List the user's meters.
|
||||
</para> <variablelist wordsize="10">
|
||||
@@ -2828,6 +3171,14 @@ List the user's meters.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-l <NUMBER>, --limit <NUMBER></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Maximum number of meters to return.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="ceilometerclient_subcommand_query-alarm-history">
|
||||
@@ -2948,7 +3299,7 @@ Query samples.
|
||||
</section>
|
||||
<section xml:id="ceilometerclient_subcommand_resource-list">
|
||||
<title>ceilometer resource-list</title>
|
||||
<screen><computeroutput>usage: ceilometer resource-list [-q <QUERY>]</computeroutput></screen>
|
||||
<screen><computeroutput>usage: ceilometer resource-list [-q <QUERY>] [-l <NUMBER>]</computeroutput></screen>
|
||||
<para>
|
||||
List the resources.
|
||||
</para> <variablelist wordsize="10">
|
||||
@@ -2963,6 +3314,14 @@ List the resources.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>-l <NUMBER>, --limit <NUMBER></command></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Maximum number of resources to return.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="ceilometerclient_subcommand_resource-show">
|
||||
|
||||
Reference in New Issue
Block a user