b1a0a0fa66
Most of increased line is the option of --aggregation-method (from 1pct to 99pct are added). Change-Id: I0454039af4ca0639cf99c5a62e2ec21420f99bb8
3757 lines
120 KiB
XML
3757 lines
120 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<chapter xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
|
version="5.0"
|
|
xml:id="ceilometerclient_commands">
|
|
|
|
<!-- This file is automatically generated, do not edit -->
|
|
|
|
<?dbhtml stop-chunking?>
|
|
|
|
<title>Telemetry command-line client</title>
|
|
|
|
<para>The <command>ceilometer</command> client is the command-line
|
|
interface (CLI) for the Telemetry API and its extensions.
|
|
|
|
This chapter documents <command>ceilometer</command> version
|
|
<literal>2.0.0</literal>.
|
|
</para>
|
|
|
|
<para>For help on a specific <command>ceilometer</command>
|
|
command, enter:
|
|
</para>
|
|
<screen><prompt>$</prompt> <userinput><command>ceilometer</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
|
|
|
|
<section xml:id="ceilometerclient_command_usage">
|
|
<title>ceilometer usage</title>
|
|
<screen><computeroutput>usage: ceilometer [--version] [-d] [-v] [--timeout TIMEOUT]
|
|
[--ceilometer-url <CEILOMETER_URL>]
|
|
[--ceilometer-api-version CEILOMETER_API_VERSION]
|
|
[--os-tenant-id <tenant-id>]
|
|
[--os-region-name <region-name>]
|
|
[--os-auth-token <auth-token>]
|
|
[--os-service-type <service-type>]
|
|
[--os-endpoint-type <endpoint-type>] [--os-cacert <cacert>]
|
|
[--os-insecure <insecure>] [--os-cert-file <cert-file>]
|
|
[--os-key-file <key-file>] [--os-cert <cert>]
|
|
[--os-key <key>] [--os-project-name <project-name>]
|
|
[--os-project-id <project-id>]
|
|
[--os-project-domain-id <project-domain-id>]
|
|
[--os-project-domain-name <project-domain-name>]
|
|
[--os-user-id <user-id>]
|
|
[--os-user-domain-id <user-domain-id>]
|
|
[--os-user-domain-name <user-domain-name>]
|
|
[--os-endpoint <endpoint>] [--os-auth-system <auth-system>]
|
|
[--os-username <username>] [--os-password <password>]
|
|
[--os-tenant-name <tenant-name>] [--os-token <token>]
|
|
[--os-auth-url <auth-url>]
|
|
<subcommand> ...</computeroutput></screen>
|
|
<variablelist wordsize="10">
|
|
<title>Subcommands</title>
|
|
<varlistentry>
|
|
<term><command>alarm-combination-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a new alarm based on state of other
|
|
alarms.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>alarm-combination-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update an existing alarm based on state of
|
|
other alarms.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>alarm-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a new alarm (Deprecated). Use alarm-
|
|
threshold-create instead.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>alarm-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete an alarm.
|
|
</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>
|
|
<para>
|
|
Create a new alarm based on computed
|
|
statistics.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>alarm-gnocchi-aggregation-by-metrics-threshold-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update an existing alarm based on computed
|
|
statistics.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>alarm-gnocchi-aggregation-by-resources-threshold-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a new alarm based on computed
|
|
statistics.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>alarm-gnocchi-aggregation-by-resources-threshold-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update an existing alarm based on computed
|
|
statistics.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>alarm-gnocchi-resources-threshold-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a new alarm based on computed
|
|
statistics.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>alarm-gnocchi-resources-threshold-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update an existing alarm based on computed
|
|
statistics.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>alarm-history</command></term>
|
|
<listitem>
|
|
<para>
|
|
Display the change history of an alarm.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>alarm-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List the user's alarms.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>alarm-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show an alarm.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>alarm-state-get</command></term>
|
|
<listitem>
|
|
<para>
|
|
Get the state of an alarm.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>alarm-state-set</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set the state of an alarm.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>alarm-threshold-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a new alarm based on computed
|
|
statistics.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>alarm-threshold-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update an existing alarm based on computed
|
|
statistics.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>alarm-update</command></term>
|
|
<listitem>
|
|
<para>
|
|
Update an existing alarm (Deprecated).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>capabilities</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print Ceilometer capabilities.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>event-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List events.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>event-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show a particular event.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>event-type-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List event types.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>meter-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List the user's meters.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>query-alarm-history</command></term>
|
|
<listitem>
|
|
<para>
|
|
Query Alarm History.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>query-alarms</command></term>
|
|
<listitem>
|
|
<para>
|
|
Query Alarms.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>query-samples</command></term>
|
|
<listitem>
|
|
<para>
|
|
Query samples.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>resource-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List the resources.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>resource-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show the resource.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>sample-create</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a sample.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>sample-create-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a sample list.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>sample-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List the samples (return OldSample objects if
|
|
-m/--meter is set).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>sample-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show a sample.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>statistics</command></term>
|
|
<listitem>
|
|
<para>
|
|
List the statistics for a meter.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>trait-description-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List trait info for an event type.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>trait-list</command></term>
|
|
<listitem>
|
|
<para>
|
|
List all traits with name <trait_name> for
|
|
Event Type <event_type>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>bash-completion</command></term>
|
|
<listitem>
|
|
<para>
|
|
Prints all of the commands and options to
|
|
stdout.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>help</command></term>
|
|
<listitem>
|
|
<para>
|
|
Display help about this program or one of its
|
|
subcommands.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_command_optional">
|
|
<title>ceilometer optional arguments</title>
|
|
<variablelist wordsize="10">
|
|
<varlistentry>
|
|
<term><command>--version</command></term>
|
|
<listitem>
|
|
<para>
|
|
show program's version number and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-d, --debug</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[CEILOMETERCLIENT_DEBUG]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-v, --verbose</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print more verbose output.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--timeout TIMEOUT</command></term>
|
|
<listitem>
|
|
<para>
|
|
Number of seconds to wait for a response.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ceilometer-url <CEILOMETER_URL></command></term>
|
|
<listitem>
|
|
<para>
|
|
<emphasis>DEPRECATED</emphasis>, use --os-endpoint instead.
|
|
Defaults to <code>env[CEILOMETER_URL]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ceilometer-api-version CEILOMETER_API_VERSION</command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[CEILOMETER_API_VERSION]</code> or 2.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-tenant-id <tenant-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_TENANT_ID]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-region-name <region-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_REGION_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-auth-token <auth-token></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_AUTH_TOKEN]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-service-type <service-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_SERVICE_TYPE]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-endpoint-type <endpoint-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_ENDPOINT_TYPE]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-cacert <cacert></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_CACERT]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-insecure <insecure></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_INSECURE]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-cert-file <cert-file></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_CERT_FILE]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-key-file <key-file></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_KEY_FILE]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-cert <cert></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_CERT]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-key <key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_KEY]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-project-name <project-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_PROJECT_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-project-id <project-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_PROJECT_ID]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-project-domain-id <project-domain-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_PROJECT_DOMAIN_ID]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-project-domain-name <project-domain-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_PROJECT_DOMAIN_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-user-id <user-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_USER_ID]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-user-domain-id <user-domain-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_USER_DOMAIN_ID]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-user-domain-name <user-domain-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_USER_DOMAIN_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-endpoint <endpoint></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_ENDPOINT]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-auth-system <auth-system></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_AUTH_SYSTEM]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-username <username></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_USERNAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-password <password></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_PASSWORD]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-tenant-name <tenant-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_TENANT_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-token <token></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_TOKEN]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-auth-url <auth-url></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_AUTH_URL]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_alarm-combination-create">
|
|
<title>ceilometer alarm-combination-create</title>
|
|
<screen><computeroutput>usage: ceilometer alarm-combination-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}]
|
|
--alarm_ids <ALARM IDS>
|
|
[--operator <OPERATOR>]</computeroutput></screen>
|
|
<para>
|
|
Create a new alarm based on state of other alarms.
|
|
</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 (configurable
|
|
by admin users only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user-id <ALARM_USER_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
User to associate with alarm (configurable by
|
|
admin users only).
|
|
</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>--alarm_ids <ALARM IDS></command></term>
|
|
<listitem>
|
|
<para>
|
|
List of alarm IDs. Required.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--operator <OPERATOR></command></term>
|
|
<listitem>
|
|
<para>
|
|
Operator to compare with, one of: ['and',
|
|
'or'].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_alarm-combination-update">
|
|
<title>ceilometer alarm-combination-update</title>
|
|
<screen><computeroutput>usage: ceilometer alarm-combination-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}]
|
|
[--remove-time-constraint <Constraint names>]
|
|
[--alarm_ids <ALARM IDS>]
|
|
[--operator <OPERATOR>]
|
|
[<ALARM_ID>]</computeroutput></screen>
|
|
<para>
|
|
Update an existing alarm based on state of other alarms.
|
|
</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 (configurable
|
|
by admin users only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user-id <ALARM_USER_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
User to associate with alarm (configurable by
|
|
admin users only).
|
|
</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>--remove-time-constraint <Constraint names></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or list of names of the time constraints
|
|
to remove.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--alarm_ids <ALARM IDS></command></term>
|
|
<listitem>
|
|
<para>
|
|
List of alarm IDs.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--operator <OPERATOR></command></term>
|
|
<listitem>
|
|
<para>
|
|
Operator to compare with, one of: ['and',
|
|
'or'].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_alarm-delete">
|
|
<title>ceilometer alarm-delete</title>
|
|
<screen><computeroutput>usage: ceilometer alarm-delete [<ALARM_ID>]</computeroutput></screen>
|
|
<para>
|
|
Delete an alarm.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><ALARM_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the alarm to delete.
|
|
</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 (configurable
|
|
by admin users only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user-id <ALARM_USER_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
User to associate with alarm (configurable by
|
|
admin users only).
|
|
</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 (configurable
|
|
by admin users only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user-id <ALARM_USER_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
User to associate with alarm (configurable by
|
|
admin users only).
|
|
</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">
|
|
<title>ceilometer alarm-gnocchi-aggregation-by-metrics-threshold-create</title>
|
|
<screen><computeroutput>usage: ceilometer alarm-gnocchi-aggregation-by-metrics-threshold-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}]
|
|
[--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">
|
|
<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 (configurable
|
|
by admin users only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user-id <ALARM_USER_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
User to associate with alarm (configurable by
|
|
admin users only).
|
|
</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>--granularity <GRANULARITY></command></term>
|
|
<listitem>
|
|
<para>
|
|
Length of each period (seconds) to evaluate
|
|
over.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--evaluation-periods <COUNT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Number of periods to evaluate over.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--aggregation-method <AGGREATION></command></term>
|
|
<listitem>
|
|
<para>
|
|
Aggregation method to use, one of: ['last',
|
|
'min', 'median', 'sum', 'std', 'first',
|
|
'mean', 'count', 'moving-average', 'max',
|
|
'1pct', '2pct', '3pct', '4pct', '5pct',
|
|
'6pct', '7pct', '8pct', '9pct', '10pct',
|
|
'11pct', '12pct', '13pct', '14pct', '15pct',
|
|
'16pct', '17pct', '18pct', '19pct', '20pct',
|
|
'21pct', '22pct', '23pct', '24pct', '25pct',
|
|
'26pct', '27pct', '28pct', '29pct', '30pct',
|
|
'31pct', '32pct', '33pct', '34pct', '35pct',
|
|
'36pct', '37pct', '38pct', '39pct', '40pct',
|
|
'41pct', '42pct', '43pct', '44pct', '45pct',
|
|
'46pct', '47pct', '48pct', '49pct', '50pct',
|
|
'51pct', '52pct', '53pct', '54pct', '55pct',
|
|
'56pct', '57pct', '58pct', '59pct', '60pct',
|
|
'61pct', '62pct', '63pct', '64pct', '65pct',
|
|
'66pct', '67pct', '68pct', '69pct', '70pct',
|
|
'71pct', '72pct', '73pct', '74pct', '75pct',
|
|
'76pct', '77pct', '78pct', '79pct', '80pct',
|
|
'81pct', '82pct', '83pct', '84pct', '85pct',
|
|
'86pct', '87pct', '88pct', '89pct', '90pct',
|
|
'91pct', '92pct', '93pct', '94pct', '95pct',
|
|
'96pct', '97pct', '98pct', '99pct'].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--comparison-operator <OPERATOR></command></term>
|
|
<listitem>
|
|
<para>
|
|
Operator to compare with, one of: ['lt', 'le',
|
|
'eq', 'ne', 'ge', 'gt'].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--threshold <THRESHOLD></command></term>
|
|
<listitem>
|
|
<para>
|
|
Threshold to evaluate against. Required.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-m <METRICS>, --metrics <METRICS></command></term>
|
|
<listitem>
|
|
<para>
|
|
Metric to evaluate against. Required.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_alarm-gnocchi-aggregation-by-metrics-threshold-update">
|
|
<title>ceilometer alarm-gnocchi-aggregation-by-metrics-threshold-update</title>
|
|
<screen><computeroutput>usage: ceilometer alarm-gnocchi-aggregation-by-metrics-threshold-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}]
|
|
[--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>
|
|
Update an existing alarm based on computed statistics.
|
|
</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 (configurable
|
|
by admin users only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user-id <ALARM_USER_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
User to associate with alarm (configurable by
|
|
admin users only).
|
|
</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>--granularity <GRANULARITY></command></term>
|
|
<listitem>
|
|
<para>
|
|
Length of each period (seconds) to evaluate
|
|
over.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--evaluation-periods <COUNT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Number of periods to evaluate over.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--aggregation-method <AGGREATION></command></term>
|
|
<listitem>
|
|
<para>
|
|
Aggregation method to use, one of: ['last',
|
|
'min', 'median', 'sum', 'std', 'first',
|
|
'mean', 'count', 'moving-average', 'max',
|
|
'1pct', '2pct', '3pct', '4pct', '5pct',
|
|
'6pct', '7pct', '8pct', '9pct', '10pct',
|
|
'11pct', '12pct', '13pct', '14pct', '15pct',
|
|
'16pct', '17pct', '18pct', '19pct', '20pct',
|
|
'21pct', '22pct', '23pct', '24pct', '25pct',
|
|
'26pct', '27pct', '28pct', '29pct', '30pct',
|
|
'31pct', '32pct', '33pct', '34pct', '35pct',
|
|
'36pct', '37pct', '38pct', '39pct', '40pct',
|
|
'41pct', '42pct', '43pct', '44pct', '45pct',
|
|
'46pct', '47pct', '48pct', '49pct', '50pct',
|
|
'51pct', '52pct', '53pct', '54pct', '55pct',
|
|
'56pct', '57pct', '58pct', '59pct', '60pct',
|
|
'61pct', '62pct', '63pct', '64pct', '65pct',
|
|
'66pct', '67pct', '68pct', '69pct', '70pct',
|
|
'71pct', '72pct', '73pct', '74pct', '75pct',
|
|
'76pct', '77pct', '78pct', '79pct', '80pct',
|
|
'81pct', '82pct', '83pct', '84pct', '85pct',
|
|
'86pct', '87pct', '88pct', '89pct', '90pct',
|
|
'91pct', '92pct', '93pct', '94pct', '95pct',
|
|
'96pct', '97pct', '98pct', '99pct'].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--comparison-operator <OPERATOR></command></term>
|
|
<listitem>
|
|
<para>
|
|
Operator to compare with, one of: ['lt', 'le',
|
|
'eq', 'ne', 'ge', 'gt'].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--threshold <THRESHOLD></command></term>
|
|
<listitem>
|
|
<para>
|
|
Threshold to evaluate against.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-m <METRICS>, --metrics <METRICS></command></term>
|
|
<listitem>
|
|
<para>
|
|
Metric to evaluate against.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--remove-time-constraint <Constraint names></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or list of names of the time constraints
|
|
to remove.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_alarm-gnocchi-aggregation-by-resources-threshold-create">
|
|
<title>ceilometer alarm-gnocchi-aggregation-by-resources-threshold-create</title>
|
|
<screen><computeroutput>usage: ceilometer alarm-gnocchi-aggregation-by-resources-threshold-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}]
|
|
[--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">
|
|
<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 (configurable
|
|
by admin users only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user-id <ALARM_USER_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
User to associate with alarm (configurable by
|
|
admin users only).
|
|
</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>--granularity <GRANULARITY></command></term>
|
|
<listitem>
|
|
<para>
|
|
Length of each period (seconds) to evaluate
|
|
over.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--evaluation-periods <COUNT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Number of periods to evaluate over.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--aggregation-method <AGGREATION></command></term>
|
|
<listitem>
|
|
<para>
|
|
Aggregation method to use, one of: ['last',
|
|
'min', 'median', 'sum', 'std', 'first',
|
|
'mean', 'count', 'moving-average', 'max',
|
|
'1pct', '2pct', '3pct', '4pct', '5pct',
|
|
'6pct', '7pct', '8pct', '9pct', '10pct',
|
|
'11pct', '12pct', '13pct', '14pct', '15pct',
|
|
'16pct', '17pct', '18pct', '19pct', '20pct',
|
|
'21pct', '22pct', '23pct', '24pct', '25pct',
|
|
'26pct', '27pct', '28pct', '29pct', '30pct',
|
|
'31pct', '32pct', '33pct', '34pct', '35pct',
|
|
'36pct', '37pct', '38pct', '39pct', '40pct',
|
|
'41pct', '42pct', '43pct', '44pct', '45pct',
|
|
'46pct', '47pct', '48pct', '49pct', '50pct',
|
|
'51pct', '52pct', '53pct', '54pct', '55pct',
|
|
'56pct', '57pct', '58pct', '59pct', '60pct',
|
|
'61pct', '62pct', '63pct', '64pct', '65pct',
|
|
'66pct', '67pct', '68pct', '69pct', '70pct',
|
|
'71pct', '72pct', '73pct', '74pct', '75pct',
|
|
'76pct', '77pct', '78pct', '79pct', '80pct',
|
|
'81pct', '82pct', '83pct', '84pct', '85pct',
|
|
'86pct', '87pct', '88pct', '89pct', '90pct',
|
|
'91pct', '92pct', '93pct', '94pct', '95pct',
|
|
'96pct', '97pct', '98pct', '99pct'].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--comparison-operator <OPERATOR></command></term>
|
|
<listitem>
|
|
<para>
|
|
Operator to compare with, one of: ['lt', 'le',
|
|
'eq', 'ne', 'ge', 'gt'].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--threshold <THRESHOLD></command></term>
|
|
<listitem>
|
|
<para>
|
|
Threshold to evaluate against. Required.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-m <METRIC>, --metric <METRIC></command></term>
|
|
<listitem>
|
|
<para>
|
|
Metric to evaluate against. Required.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--resource-type <RESOURCE_TYPE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Resource_type to evaluate against. Required.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--query <QUERY></command></term>
|
|
<listitem>
|
|
<para>
|
|
Gnocchi resources search query filter
|
|
Required.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_alarm-gnocchi-aggregation-by-resources-threshold-update">
|
|
<title>ceilometer alarm-gnocchi-aggregation-by-resources-threshold-update</title>
|
|
<screen><computeroutput>usage: ceilometer alarm-gnocchi-aggregation-by-resources-threshold-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}]
|
|
[--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>
|
|
<para>
|
|
Update an existing alarm based on computed statistics.
|
|
</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 (configurable
|
|
by admin users only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user-id <ALARM_USER_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
User to associate with alarm (configurable by
|
|
admin users only).
|
|
</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>--granularity <GRANULARITY></command></term>
|
|
<listitem>
|
|
<para>
|
|
Length of each period (seconds) to evaluate
|
|
over.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--evaluation-periods <COUNT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Number of periods to evaluate over.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--aggregation-method <AGGREATION></command></term>
|
|
<listitem>
|
|
<para>
|
|
Aggregation method to use, one of: ['last',
|
|
'min', 'median', 'sum', 'std', 'first',
|
|
'mean', 'count', 'moving-average', 'max',
|
|
'1pct', '2pct', '3pct', '4pct', '5pct',
|
|
'6pct', '7pct', '8pct', '9pct', '10pct',
|
|
'11pct', '12pct', '13pct', '14pct', '15pct',
|
|
'16pct', '17pct', '18pct', '19pct', '20pct',
|
|
'21pct', '22pct', '23pct', '24pct', '25pct',
|
|
'26pct', '27pct', '28pct', '29pct', '30pct',
|
|
'31pct', '32pct', '33pct', '34pct', '35pct',
|
|
'36pct', '37pct', '38pct', '39pct', '40pct',
|
|
'41pct', '42pct', '43pct', '44pct', '45pct',
|
|
'46pct', '47pct', '48pct', '49pct', '50pct',
|
|
'51pct', '52pct', '53pct', '54pct', '55pct',
|
|
'56pct', '57pct', '58pct', '59pct', '60pct',
|
|
'61pct', '62pct', '63pct', '64pct', '65pct',
|
|
'66pct', '67pct', '68pct', '69pct', '70pct',
|
|
'71pct', '72pct', '73pct', '74pct', '75pct',
|
|
'76pct', '77pct', '78pct', '79pct', '80pct',
|
|
'81pct', '82pct', '83pct', '84pct', '85pct',
|
|
'86pct', '87pct', '88pct', '89pct', '90pct',
|
|
'91pct', '92pct', '93pct', '94pct', '95pct',
|
|
'96pct', '97pct', '98pct', '99pct'].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--comparison-operator <OPERATOR></command></term>
|
|
<listitem>
|
|
<para>
|
|
Operator to compare with, one of: ['lt', 'le',
|
|
'eq', 'ne', 'ge', 'gt'].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--threshold <THRESHOLD></command></term>
|
|
<listitem>
|
|
<para>
|
|
Threshold to evaluate against.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-m <METRIC>, --metric <METRIC></command></term>
|
|
<listitem>
|
|
<para>
|
|
Metric to evaluate against.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--resource-type <RESOURCE_TYPE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Resource_type to evaluate against.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--query <QUERY></command></term>
|
|
<listitem>
|
|
<para>
|
|
Gnocchi resources search query filter
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--remove-time-constraint <Constraint names></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or list of names of the time constraints
|
|
to remove.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_alarm-gnocchi-resources-threshold-create">
|
|
<title>ceilometer alarm-gnocchi-resources-threshold-create</title>
|
|
<screen><computeroutput>usage: ceilometer alarm-gnocchi-resources-threshold-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}]
|
|
[--granularity <GRANULARITY>]
|
|
[--evaluation-periods <COUNT>]
|
|
[--aggregation-method <AGGREATION>]
|
|
[--comparison-operator <OPERATOR>]
|
|
--threshold
|
|
<THRESHOLD> -m
|
|
<METRIC>
|
|
--resource-type
|
|
<RESOURCE_TYPE>
|
|
--resource-id
|
|
<RESOURCE_ID></computeroutput></screen>
|
|
<para>
|
|
Create a new alarm based on computed statistics.
|
|
</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 (configurable
|
|
by admin users only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user-id <ALARM_USER_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
User to associate with alarm (configurable by
|
|
admin users only).
|
|
</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>--granularity <GRANULARITY></command></term>
|
|
<listitem>
|
|
<para>
|
|
Length of each period (seconds) to evaluate
|
|
over.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--evaluation-periods <COUNT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Number of periods to evaluate over.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--aggregation-method <AGGREATION></command></term>
|
|
<listitem>
|
|
<para>
|
|
Aggregation method to use, one of: ['last',
|
|
'min', 'median', 'sum', 'std', 'first',
|
|
'mean', 'count', 'moving-average', 'max',
|
|
'1pct', '2pct', '3pct', '4pct', '5pct',
|
|
'6pct', '7pct', '8pct', '9pct', '10pct',
|
|
'11pct', '12pct', '13pct', '14pct', '15pct',
|
|
'16pct', '17pct', '18pct', '19pct', '20pct',
|
|
'21pct', '22pct', '23pct', '24pct', '25pct',
|
|
'26pct', '27pct', '28pct', '29pct', '30pct',
|
|
'31pct', '32pct', '33pct', '34pct', '35pct',
|
|
'36pct', '37pct', '38pct', '39pct', '40pct',
|
|
'41pct', '42pct', '43pct', '44pct', '45pct',
|
|
'46pct', '47pct', '48pct', '49pct', '50pct',
|
|
'51pct', '52pct', '53pct', '54pct', '55pct',
|
|
'56pct', '57pct', '58pct', '59pct', '60pct',
|
|
'61pct', '62pct', '63pct', '64pct', '65pct',
|
|
'66pct', '67pct', '68pct', '69pct', '70pct',
|
|
'71pct', '72pct', '73pct', '74pct', '75pct',
|
|
'76pct', '77pct', '78pct', '79pct', '80pct',
|
|
'81pct', '82pct', '83pct', '84pct', '85pct',
|
|
'86pct', '87pct', '88pct', '89pct', '90pct',
|
|
'91pct', '92pct', '93pct', '94pct', '95pct',
|
|
'96pct', '97pct', '98pct', '99pct'].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--comparison-operator <OPERATOR></command></term>
|
|
<listitem>
|
|
<para>
|
|
Operator to compare with, one of: ['lt', 'le',
|
|
'eq', 'ne', 'ge', 'gt'].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--threshold <THRESHOLD></command></term>
|
|
<listitem>
|
|
<para>
|
|
Threshold to evaluate against. Required.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-m <METRIC>, --metric <METRIC></command></term>
|
|
<listitem>
|
|
<para>
|
|
Metric to evaluate against. Required.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--resource-type <RESOURCE_TYPE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Resource_type to evaluate against. Required.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--resource-id <RESOURCE_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
Resource id to evaluate against Required.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_alarm-gnocchi-resources-threshold-update">
|
|
<title>ceilometer alarm-gnocchi-resources-threshold-update</title>
|
|
<screen><computeroutput>usage: ceilometer alarm-gnocchi-resources-threshold-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}]
|
|
[--granularity <GRANULARITY>]
|
|
[--evaluation-periods <COUNT>]
|
|
[--aggregation-method <AGGREATION>]
|
|
[--comparison-operator <OPERATOR>]
|
|
[--threshold <THRESHOLD>]
|
|
[-m <METRIC>]
|
|
[--resource-type <RESOURCE_TYPE>]
|
|
[--resource-id <RESOURCE_ID>]
|
|
[--remove-time-constraint <Constraint names>]
|
|
[<ALARM_ID>]</computeroutput></screen>
|
|
<para>
|
|
Update an existing alarm based on computed statistics.
|
|
</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 (configurable
|
|
by admin users only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user-id <ALARM_USER_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
User to associate with alarm (configurable by
|
|
admin users only).
|
|
</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>--granularity <GRANULARITY></command></term>
|
|
<listitem>
|
|
<para>
|
|
Length of each period (seconds) to evaluate
|
|
over.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--evaluation-periods <COUNT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Number of periods to evaluate over.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--aggregation-method <AGGREATION></command></term>
|
|
<listitem>
|
|
<para>
|
|
Aggregation method to use, one of: ['last',
|
|
'min', 'median', 'sum', 'std', 'first',
|
|
'mean', 'count', 'moving-average', 'max',
|
|
'1pct', '2pct', '3pct', '4pct', '5pct',
|
|
'6pct', '7pct', '8pct', '9pct', '10pct',
|
|
'11pct', '12pct', '13pct', '14pct', '15pct',
|
|
'16pct', '17pct', '18pct', '19pct', '20pct',
|
|
'21pct', '22pct', '23pct', '24pct', '25pct',
|
|
'26pct', '27pct', '28pct', '29pct', '30pct',
|
|
'31pct', '32pct', '33pct', '34pct', '35pct',
|
|
'36pct', '37pct', '38pct', '39pct', '40pct',
|
|
'41pct', '42pct', '43pct', '44pct', '45pct',
|
|
'46pct', '47pct', '48pct', '49pct', '50pct',
|
|
'51pct', '52pct', '53pct', '54pct', '55pct',
|
|
'56pct', '57pct', '58pct', '59pct', '60pct',
|
|
'61pct', '62pct', '63pct', '64pct', '65pct',
|
|
'66pct', '67pct', '68pct', '69pct', '70pct',
|
|
'71pct', '72pct', '73pct', '74pct', '75pct',
|
|
'76pct', '77pct', '78pct', '79pct', '80pct',
|
|
'81pct', '82pct', '83pct', '84pct', '85pct',
|
|
'86pct', '87pct', '88pct', '89pct', '90pct',
|
|
'91pct', '92pct', '93pct', '94pct', '95pct',
|
|
'96pct', '97pct', '98pct', '99pct'].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--comparison-operator <OPERATOR></command></term>
|
|
<listitem>
|
|
<para>
|
|
Operator to compare with, one of: ['lt', 'le',
|
|
'eq', 'ne', 'ge', 'gt'].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--threshold <THRESHOLD></command></term>
|
|
<listitem>
|
|
<para>
|
|
Threshold to evaluate against.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-m <METRIC>, --metric <METRIC></command></term>
|
|
<listitem>
|
|
<para>
|
|
Metric to evaluate against.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--resource-type <RESOURCE_TYPE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Resource_type to evaluate against.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--resource-id <RESOURCE_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
Resource id to evaluate against
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--remove-time-constraint <Constraint names></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or list of names of the time constraints
|
|
to remove.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_alarm-history">
|
|
<title>ceilometer alarm-history</title>
|
|
<screen><computeroutput>usage: ceilometer alarm-history [-q <QUERY>] [<ALARM_ID>]</computeroutput></screen>
|
|
<para>
|
|
Display the change history of an alarm.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><ALARM_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the alarm for which history is shown.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-q <QUERY>, --query <QUERY></command></term>
|
|
<listitem>
|
|
<para>
|
|
key[op]data_type::value; list. data_type is
|
|
optional, but if supplied must be string,
|
|
integer, float, or boolean.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_alarm-list">
|
|
<title>ceilometer alarm-list</title>
|
|
<screen><computeroutput>usage: ceilometer alarm-list [-q <QUERY>]</computeroutput></screen>
|
|
<para>
|
|
List the user's alarms.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-q <QUERY>, --query <QUERY></command></term>
|
|
<listitem>
|
|
<para>
|
|
key[op]data_type::value; list. data_type is
|
|
optional, but if supplied must be string,
|
|
integer, float, or boolean.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_alarm-show">
|
|
<title>ceilometer alarm-show</title>
|
|
<screen><computeroutput>usage: ceilometer alarm-show [<ALARM_ID>]</computeroutput></screen>
|
|
<para>
|
|
Show an alarm.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><ALARM_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the alarm to show.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_alarm-state-get">
|
|
<title>ceilometer alarm-state-get</title>
|
|
<screen><computeroutput>usage: ceilometer alarm-state-get [<ALARM_ID>]</computeroutput></screen>
|
|
<para>
|
|
Get the state of an alarm.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><ALARM_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the alarm state to show.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_alarm-state-set">
|
|
<title>ceilometer alarm-state-set</title>
|
|
<screen><computeroutput>usage: ceilometer alarm-state-set --state <STATE> [<ALARM_ID>]</computeroutput></screen>
|
|
<para>
|
|
Set the state of an alarm.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><ALARM_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the alarm state to set.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--state <STATE></command></term>
|
|
<listitem>
|
|
<para>
|
|
State of the alarm, one of: ['ok', 'alarm', 'insufficient
|
|
data']. Required.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_alarm-threshold-create">
|
|
<title>ceilometer alarm-threshold-create</title>
|
|
<screen><computeroutput>usage: ceilometer alarm-threshold-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}] -m
|
|
<METRIC> [--period <PERIOD>]
|
|
[--evaluation-periods <COUNT>]
|
|
[--statistic <STATISTIC>]
|
|
[--comparison-operator <OPERATOR>]
|
|
--threshold <THRESHOLD> [-q <QUERY>]</computeroutput></screen>
|
|
<para>
|
|
Create a new alarm based on computed statistics.
|
|
</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 (configurable
|
|
by admin users only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user-id <ALARM_USER_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
User to associate with alarm (configurable by
|
|
admin users only).
|
|
</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>-m <METRIC>, --meter-name <METRIC></command></term>
|
|
<listitem>
|
|
<para>
|
|
Metric to evaluate against. Required.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--period <PERIOD></command></term>
|
|
<listitem>
|
|
<para>
|
|
Length of each period (seconds) to evaluate
|
|
over.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--evaluation-periods <COUNT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Number of periods to evaluate over.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--statistic <STATISTIC></command></term>
|
|
<listitem>
|
|
<para>
|
|
Statistic to evaluate, one of: ['max', 'min',
|
|
'avg', 'sum', 'count'].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--comparison-operator <OPERATOR></command></term>
|
|
<listitem>
|
|
<para>
|
|
Operator to compare with, one of: ['lt', 'le',
|
|
'eq', 'ne', 'ge', 'gt'].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--threshold <THRESHOLD></command></term>
|
|
<listitem>
|
|
<para>
|
|
Threshold to evaluate against. Required.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-q <QUERY>, --query <QUERY></command></term>
|
|
<listitem>
|
|
<para>
|
|
key[op]data_type::value; list. data_type is
|
|
optional, but if supplied must be string,
|
|
integer, float, or boolean.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_alarm-threshold-update">
|
|
<title>ceilometer alarm-threshold-update</title>
|
|
<screen><computeroutput>usage: ceilometer alarm-threshold-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}]
|
|
[--remove-time-constraint <Constraint names>]
|
|
[-m <METRIC>] [--period <PERIOD>]
|
|
[--evaluation-periods <COUNT>]
|
|
[--statistic <STATISTIC>]
|
|
[--comparison-operator <OPERATOR>]
|
|
[--threshold <THRESHOLD>]
|
|
[-q <QUERY>]
|
|
[<ALARM_ID>]</computeroutput></screen>
|
|
<para>
|
|
Update an existing alarm based on computed statistics.
|
|
</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 (configurable
|
|
by admin users only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user-id <ALARM_USER_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
User to associate with alarm (configurable by
|
|
admin users only).
|
|
</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>--remove-time-constraint <Constraint names></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or list of names of the time constraints
|
|
to remove.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-m <METRIC>, --meter-name <METRIC></command></term>
|
|
<listitem>
|
|
<para>
|
|
Metric to evaluate against.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--period <PERIOD></command></term>
|
|
<listitem>
|
|
<para>
|
|
Length of each period (seconds) to evaluate
|
|
over.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--evaluation-periods <COUNT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Number of periods to evaluate over.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--statistic <STATISTIC></command></term>
|
|
<listitem>
|
|
<para>
|
|
Statistic to evaluate, one of: ['max', 'min',
|
|
'avg', 'sum', 'count'].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--comparison-operator <OPERATOR></command></term>
|
|
<listitem>
|
|
<para>
|
|
Operator to compare with, one of: ['lt', 'le',
|
|
'eq', 'ne', 'ge', 'gt'].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--threshold <THRESHOLD></command></term>
|
|
<listitem>
|
|
<para>
|
|
Threshold to evaluate against.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-q <QUERY>, --query <QUERY></command></term>
|
|
<listitem>
|
|
<para>
|
|
key[op]data_type::value; list. data_type is
|
|
optional, but if supplied must be string,
|
|
integer, float, or boolean.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_capabilities">
|
|
<title>ceilometer capabilities</title>
|
|
<screen><computeroutput>usage: ceilometer capabilities</computeroutput></screen>
|
|
<para>
|
|
Print Ceilometer capabilities.
|
|
</para>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_event-list">
|
|
<title>ceilometer event-list</title>
|
|
<screen><computeroutput>usage: ceilometer event-list [-q <QUERY>] [--no-traits] [-l <NUMBER>]</computeroutput></screen>
|
|
<para>
|
|
List events.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-q <QUERY>, --query <QUERY></command></term>
|
|
<listitem>
|
|
<para>
|
|
key[op]data_type::value; list. data_type is
|
|
optional, but if supplied must be string,
|
|
integer, floator datetime.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--no-traits</command></term>
|
|
<listitem>
|
|
<para>
|
|
If specified, traits will not be printed.
|
|
</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">
|
|
<title>ceilometer event-show</title>
|
|
<screen><computeroutput>usage: ceilometer event-show <message_id></computeroutput></screen>
|
|
<para>
|
|
Show a particular event.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><message_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
The ID of the event. Should be a UUID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_event-type-list">
|
|
<title>ceilometer event-type-list</title>
|
|
<screen><computeroutput>usage: ceilometer event-type-list</computeroutput></screen>
|
|
<para>
|
|
List event types.
|
|
</para>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_meter-list">
|
|
<title>ceilometer meter-list</title>
|
|
<screen><computeroutput>usage: ceilometer meter-list [-q <QUERY>] [-l <NUMBER>]</computeroutput></screen>
|
|
<para>
|
|
List the user's meters.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-q <QUERY>, --query <QUERY></command></term>
|
|
<listitem>
|
|
<para>
|
|
key[op]data_type::value; list. data_type is
|
|
optional, but if supplied must be string,
|
|
integer, float, or boolean.
|
|
</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">
|
|
<title>ceilometer query-alarm-history</title>
|
|
<screen><computeroutput>usage: ceilometer query-alarm-history [-f <FILTER>] [-o <ORDERBY>]
|
|
[-l <LIMIT>]</computeroutput></screen>
|
|
<para>
|
|
Query Alarm History.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-f <FILTER>, --filter <FILTER></command></term>
|
|
<listitem>
|
|
<para>
|
|
{complex_op: [{simple_op: {field_name:
|
|
value}}]} The complex_op is one of: ['and',
|
|
'or'], simple_op is one of: ['=', '!=', '<',
|
|
'<=', '>', '>='].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-o <ORDERBY>, --orderby <ORDERBY></command></term>
|
|
<listitem>
|
|
<para>
|
|
[{field_name: direction}, {field_name:
|
|
direction}] The direction is one of: ['asc',
|
|
'desc'].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-l <LIMIT>, --limit <LIMIT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Maximum number of alarm history items to
|
|
return.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_query-alarms">
|
|
<title>ceilometer query-alarms</title>
|
|
<screen><computeroutput>usage: ceilometer query-alarms [-f <FILTER>] [-o <ORDERBY>] [-l <LIMIT>]</computeroutput></screen>
|
|
<para>
|
|
Query Alarms.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-f <FILTER>, --filter <FILTER></command></term>
|
|
<listitem>
|
|
<para>
|
|
{complex_op: [{simple_op: {field_name:
|
|
value}}]} The complex_op is one of: ['and',
|
|
'or'], simple_op is one of: ['=', '!=', '<',
|
|
'<=', '>', '>='].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-o <ORDERBY>, --orderby <ORDERBY></command></term>
|
|
<listitem>
|
|
<para>
|
|
[{field_name: direction}, {field_name:
|
|
direction}] The direction is one of: ['asc',
|
|
'desc'].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-l <LIMIT>, --limit <LIMIT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Maximum number of alarms to return.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_query-samples">
|
|
<title>ceilometer query-samples</title>
|
|
<screen><computeroutput>usage: ceilometer query-samples [-f <FILTER>] [-o <ORDERBY>] [-l <LIMIT>]</computeroutput></screen>
|
|
<para>
|
|
Query samples.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-f <FILTER>, --filter <FILTER></command></term>
|
|
<listitem>
|
|
<para>
|
|
{complex_op: [{simple_op: {field_name:
|
|
value}}]} The complex_op is one of: ['and',
|
|
'or'], simple_op is one of: ['=', '!=', '<',
|
|
'<=', '>', '>='].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-o <ORDERBY>, --orderby <ORDERBY></command></term>
|
|
<listitem>
|
|
<para>
|
|
[{field_name: direction}, {field_name:
|
|
direction}] The direction is one of: ['asc',
|
|
'desc'].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-l <LIMIT>, --limit <LIMIT></command></term>
|
|
<listitem>
|
|
<para>
|
|
Maximum number of samples to return.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_resource-list">
|
|
<title>ceilometer resource-list</title>
|
|
<screen><computeroutput>usage: ceilometer resource-list [-q <QUERY>] [--meter-links] [-l <NUMBER>]</computeroutput></screen>
|
|
<para>
|
|
List the resources.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-q <QUERY>, --query <QUERY></command></term>
|
|
<listitem>
|
|
<para>
|
|
key[op]data_type::value; list. data_type is
|
|
optional, but if supplied must be string,
|
|
integer, float, or boolean.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--meter-links</command></term>
|
|
<listitem>
|
|
<para>
|
|
If specified, meter links will be generated.
|
|
</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">
|
|
<title>ceilometer resource-show</title>
|
|
<screen><computeroutput>usage: ceilometer resource-show <RESOURCE_ID></computeroutput></screen>
|
|
<para>
|
|
Show the resource.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><RESOURCE_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the resource to show.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_sample-create">
|
|
<title>ceilometer sample-create</title>
|
|
<screen><computeroutput>usage: ceilometer sample-create [--project-id <SAMPLE_PROJECT_ID>]
|
|
[--user-id <SAMPLE_USER_ID>] -r <RESOURCE_ID>
|
|
-m <METER_NAME> --meter-type <METER_TYPE>
|
|
--meter-unit <METER_UNIT> --sample-volume
|
|
<SAMPLE_VOLUME>
|
|
[--resource-metadata <RESOURCE_METADATA>]
|
|
[--timestamp <TIMESTAMP>] [--direct <DIRECT>]</computeroutput></screen>
|
|
<para>
|
|
Create a sample.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--project-id <SAMPLE_PROJECT_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
Tenant to associate with sample (configurable
|
|
by admin users only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user-id <SAMPLE_USER_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
User to associate with sample (configurable by
|
|
admin users only).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-r <RESOURCE_ID>, --resource-id <RESOURCE_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the resource. Required.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-m <METER_NAME>, --meter-name <METER_NAME></command></term>
|
|
<listitem>
|
|
<para>
|
|
The meter name. Required.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--meter-type <METER_TYPE></command></term>
|
|
<listitem>
|
|
<para>
|
|
The meter type. Required.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--meter-unit <METER_UNIT></command></term>
|
|
<listitem>
|
|
<para>
|
|
The meter unit. Required.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sample-volume <SAMPLE_VOLUME></command></term>
|
|
<listitem>
|
|
<para>
|
|
The sample volume. Required.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--resource-metadata <RESOURCE_METADATA></command></term>
|
|
<listitem>
|
|
<para>
|
|
Resource metadata. Provided value should be a
|
|
set of key-value pairs e.g. {"key":"value"}.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--timestamp <TIMESTAMP></command></term>
|
|
<listitem>
|
|
<para>
|
|
The sample timestamp.
|
|
</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 [--direct <DIRECT>] <SAMPLES_LIST></computeroutput></screen>
|
|
<para>
|
|
Create a sample list.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><SAMPLES_LIST></command></term>
|
|
<listitem>
|
|
<para>
|
|
Json array with samples to create.
|
|
</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">
|
|
<title>ceilometer sample-list</title>
|
|
<screen><computeroutput>usage: ceilometer sample-list [-q <QUERY>] [-m <NAME>] [-l <NUMBER>]</computeroutput></screen>
|
|
<para>
|
|
List the samples (return OldSample objects if -m/--meter is set).
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-q <QUERY>, --query <QUERY></command></term>
|
|
<listitem>
|
|
<para>
|
|
key[op]data_type::value; list. data_type is
|
|
optional, but if supplied must be string,
|
|
integer, float, or boolean.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-m <NAME>, --meter <NAME></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of meter to show samples for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-l <NUMBER>, --limit <NUMBER></command></term>
|
|
<listitem>
|
|
<para>
|
|
Maximum number of samples to return.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_sample-show">
|
|
<title>ceilometer sample-show</title>
|
|
<screen><computeroutput>usage: ceilometer sample-show <SAMPLE_ID></computeroutput></screen>
|
|
<para>
|
|
Show a sample.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><SAMPLE_ID></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID (aka message ID) of the sample to show.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_statistics">
|
|
<title>ceilometer statistics</title>
|
|
<screen><computeroutput>usage: ceilometer statistics [-q <QUERY>] -m <NAME> [-p <PERIOD>] [-g <FIELD>]
|
|
[-a <FUNC>[<-<PARAM>]]</computeroutput></screen>
|
|
<para>
|
|
List the statistics for a meter.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-q <QUERY>, --query <QUERY></command></term>
|
|
<listitem>
|
|
<para>
|
|
key[op]data_type::value; list. data_type is
|
|
optional, but if supplied must be string,
|
|
integer, float, or boolean.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-m <NAME>, --meter <NAME></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of meter to list statistics for.
|
|
Required.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-p <PERIOD>, --period <PERIOD></command></term>
|
|
<listitem>
|
|
<para>
|
|
Period in seconds over which to group samples.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-g <FIELD>, --groupby <FIELD></command></term>
|
|
<listitem>
|
|
<para>
|
|
Field for group by.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-a <FUNC>[<-<PARAM>], --aggregate <FUNC>[<-<PARAM>]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Function for data aggregation. Available
|
|
aggregates are: count, cardinality, min, max,
|
|
sum, stddev, avg. Defaults to [].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_trait-description-list">
|
|
<title>ceilometer trait-description-list</title>
|
|
<screen><computeroutput>usage: ceilometer trait-description-list -e <EVENT_TYPE></computeroutput></screen>
|
|
<para>
|
|
List trait info for an event type.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-e <EVENT_TYPE>, --event_type <EVENT_TYPE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Type of the event for which traits will be
|
|
shown. Required.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="ceilometerclient_subcommand_trait-list">
|
|
<title>ceilometer trait-list</title>
|
|
<screen><computeroutput>usage: ceilometer trait-list -e <EVENT_TYPE> -t <TRAIT_NAME></computeroutput></screen>
|
|
<para>
|
|
List all traits with name <trait_name> for Event Type <event_type>.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-e <EVENT_TYPE>, --event_type <EVENT_TYPE></command></term>
|
|
<listitem>
|
|
<para>
|
|
Type of the event for which traits will
|
|
listed. Required.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-t <TRAIT_NAME>, --trait_name <TRAIT_NAME></command></term>
|
|
<listitem>
|
|
<para>
|
|
The name of the trait to list. Required.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
</chapter>
|