From 1305cf3525eb44c3de658ff01857238a425359e8 Mon Sep 17 00:00:00 2001 From: Christian Berendt Date: Thu, 26 Feb 2015 13:10:03 +0100 Subject: [PATCH] Update CLI reference for python-ceilometerclient 1.0.13 Change-Id: Ia993c3fcb9aa263bb25ff905ec23d5e8b3cffed0 --- .../generated/ch_cli_ceilometer_commands.xml | 1005 ++++++++++++++++- 1 file changed, 989 insertions(+), 16 deletions(-) diff --git a/doc/cli-reference/generated/ch_cli_ceilometer_commands.xml b/doc/cli-reference/generated/ch_cli_ceilometer_commands.xml index 11b495127c..cdb5126154 100644 --- a/doc/cli-reference/generated/ch_cli_ceilometer_commands.xml +++ b/doc/cli-reference/generated/ch_cli_ceilometer_commands.xml @@ -15,7 +15,7 @@ interface (CLI) for the Telemetry API and its extensions. This chapter documents ceilometer version - 1.0.12. + 1.0.13. For help on a specific ceilometer @@ -26,7 +26,7 @@
ceilometer usage usage: ceilometer [--version] [-d] [-v] [--timeout TIMEOUT] - [--ceilometer-url CEILOMETER_URL] + [--ceilometer-url <CEILOMETER_URL>] [--ceilometer-api-version CEILOMETER_API_VERSION] [--os-tenant-id <tenant-id>] [--os-region-name <region-name>] @@ -81,6 +81,42 @@ + + alarm-gnocchi-metrics-threshold-create + + + Create a new alarm based on computed + statistics. + + + + + alarm-gnocchi-metrics-threshold-update + + + Update an existing alarm based on computed + statistics. + + + + + alarm-gnocchi-resources-threshold-create + + + Create a new alarm based on computed + statistics. + + + + + alarm-gnocchi-resources-threshold-update + + + Update an existing alarm based on computed + statistics. + + + alarm-history @@ -231,7 +267,16 @@ sample-list - List the samples for a meter. + List the samples (return OldSample objects if + -m/--meter is set). + + + + + sample-show + + + Show an sample. @@ -255,8 +300,8 @@ trait-list - List trait all traits with name <trait_name> - for Event Type + List all traits with name <trait_name> for + Event Type <event_type>. @@ -316,9 +361,10 @@ - --ceilometer-url CEILOMETER_URL + --ceilometer-url <CEILOMETER_URL> + DEPRECATED, use --os-endpoint instead. Defaults to env[CEILOMETER_URL]. @@ -516,6 +562,7 @@ [--user-id <USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] + [--severity <SEVERITY>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] @@ -572,6 +619,15 @@ Create a new alarm based on state of other alarms. + + --severity <SEVERITY> + + + Severity of the alarm, one of: ['low', + 'moderate', 'critical'] + + + --enabled {True|False} @@ -615,7 +671,7 @@ Create a new alarm based on state of other alarms. 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 + 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 @@ -660,6 +716,7 @@ Create a new alarm based on state of other alarms. [--user-id <USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] + [--severity <SEVERITY>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] @@ -728,6 +785,15 @@ Update an existing alarm based on state of other alarms. + + --severity <SEVERITY> + + + Severity of the alarm, one of: ['low', + 'moderate', 'critical'] + + + --enabled {True|False} @@ -771,7 +837,7 @@ Update an existing alarm based on state of other alarms. 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 + 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 @@ -832,6 +898,858 @@ Delete an alarm. + +
+
+ ceilometer alarm-gnocchi-metrics-threshold-create + usage: ceilometer alarm-gnocchi-metrics-threshold-create --name <NAME> + [--project-id <PROJECT_ID>] + [--user-id <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>] + [--granularity <GRANULARITY>] + [--evaluation-periods <COUNT>] + [--aggregation-method <AGGREATION>] + [--comparison-operator <OPERATOR>] + --threshold + <THRESHOLD> + [--repeat-actions {True|False}] + -m <METRICS> + +Create a new alarm based on computed statistics. + + Optional arguments + + --name <NAME> + + + Name of the alarm (must be unique per tenant). + Required. + + + + + --project-id <PROJECT_ID> + + + Tenant to associate with alarm (only settable + by admin users). + + + + + --user-id <USER_ID> + + + User to associate with alarm (only settable by + admin users). + + + + + --description <DESCRIPTION> + + + Free text description of the alarm. + + + + + --state <STATE> + + + State of the alarm, one of: ['ok', 'alarm', + 'insufficient data'] + + + + + --severity <SEVERITY> + + + Severity of the alarm, one of: ['low', + 'moderate', 'critical'] + + + + + --enabled {True|False} + + + True if alarm evaluation/actioning is enabled. + + + + + --alarm-action <Webhook URL> URL + + + to invoke when state transitions to alarm. + May be used multiple times. Defaults to None. + + + + + --ok-action <Webhook URL> URL + + + to invoke when state transitions to OK. + May be used multiple times. Defaults to None. + + + + + --insufficient-data-action <Webhook URL> + + + URL to invoke when state transitions to + insufficient data. May be used multiple times. + Defaults to None. + + + + + --time-constraint <Time Constraint> + + + 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. + + + + + --granularity <GRANULARITY> + + + Length of each period (seconds) to evaluate + over. + + + + + --evaluation-periods <COUNT> + + + Number of periods to evaluate over. + + + + + --aggregation-method <AGGREATION> + + + Aggregation method to use, one of: ['max', + 'min', 'avg', 'sum', 'count']. + + + + + --comparison-operator <OPERATOR> + + + Operator to compare with, one of: ['lt', 'le', + 'eq', 'ne', 'ge', 'gt']. + + + + + --threshold <THRESHOLD> + + + Threshold to evaluate against. Required. + + + + + --repeat-actions {True|False} + + + True if actions should be repeatedly notified + while alarm remains in target state. Defaults + to False. + + + + + -m <METRICS>, --metrics <METRICS> + + + Metric to evaluate against. Required. + + + + +
+
+ ceilometer alarm-gnocchi-metrics-threshold-update + usage: ceilometer alarm-gnocchi-metrics-threshold-update [--name <NAME>] + [--project-id <PROJECT_ID>] + [--user-id <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>] + [--granularity <GRANULARITY>] + [--evaluation-periods <COUNT>] + [--aggregation-method <AGGREATION>] + [--comparison-operator <OPERATOR>] + [--threshold <THRESHOLD>] + [--repeat-actions {True|False}] + [-m <METRICS>] + [--remove-time-constraint <Constraint names>] + [<ALARM_ID>] + +Update an existing alarm based on computed statistics. + + Positional arguments + + <ALARM_ID> + + + ID of the alarm to update. + + + + + + Optional arguments + + --name <NAME> + + + Name of the alarm (must be unique per tenant). + + + + + --project-id <PROJECT_ID> + + + Tenant to associate with alarm (only settable + by admin users). + + + + + --user-id <USER_ID> + + + User to associate with alarm (only settable by + admin users). + + + + + --description <DESCRIPTION> + + + Free text description of the alarm. + + + + + --state <STATE> + + + State of the alarm, one of: ['ok', 'alarm', + 'insufficient data'] + + + + + --severity <SEVERITY> + + + Severity of the alarm, one of: ['low', + 'moderate', 'critical'] + + + + + --enabled {True|False} + + + True if alarm evaluation/actioning is enabled. + + + + + --alarm-action <Webhook URL> URL + + + to invoke when state transitions to alarm. + May be used multiple times. Defaults to None. + + + + + --ok-action <Webhook URL> URL + + + to invoke when state transitions to OK. + May be used multiple times. Defaults to None. + + + + + --insufficient-data-action <Webhook URL> + + + URL to invoke when state transitions to + insufficient data. May be used multiple times. + Defaults to None. + + + + + --time-constraint <Time Constraint> + + + 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. + + + + + --granularity <GRANULARITY> + + + Length of each period (seconds) to evaluate + over. + + + + + --evaluation-periods <COUNT> + + + Number of periods to evaluate over. + + + + + --aggregation-method <AGGREATION> + + + Aggregation method to use, one of: ['max', + 'min', 'avg', 'sum', 'count']. + + + + + --comparison-operator <OPERATOR> + + + Operator to compare with, one of: ['lt', 'le', + 'eq', 'ne', 'ge', 'gt']. + + + + + --threshold <THRESHOLD> + + + Threshold to evaluate against. + + + + + --repeat-actions {True|False} + + + True if actions should be repeatedly notified + while alarm remains in target state. Defaults + to False. + + + + + -m <METRICS>, --metrics <METRICS> + + + Metric to evaluate against. + + + + + --remove-time-constraint <Constraint names> + + + Name or list of names of the time constraints + to remove. + + + + +
+
+ ceilometer alarm-gnocchi-resources-threshold-create + usage: ceilometer alarm-gnocchi-resources-threshold-create --name <NAME> + [--project-id <PROJECT_ID>] + [--user-id <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>] + [--granularity <GRANULARITY>] + [--evaluation-periods <COUNT>] + [--aggregation-method <AGGREATION>] + [--comparison-operator <OPERATOR>] + --threshold + <THRESHOLD> + [--repeat-actions {True|False}] + -m <METRIC> + --resource-type + <RESOURCE_TYPE> + --resource-constraint + <RESOURCE_CONSTRAINT> + +Create a new alarm based on computed statistics. + + Optional arguments + + --name <NAME> + + + Name of the alarm (must be unique per tenant). + Required. + + + + + --project-id <PROJECT_ID> + + + Tenant to associate with alarm (only settable + by admin users). + + + + + --user-id <USER_ID> + + + User to associate with alarm (only settable by + admin users). + + + + + --description <DESCRIPTION> + + + Free text description of the alarm. + + + + + --state <STATE> + + + State of the alarm, one of: ['ok', 'alarm', + 'insufficient data'] + + + + + --severity <SEVERITY> + + + Severity of the alarm, one of: ['low', + 'moderate', 'critical'] + + + + + --enabled {True|False} + + + True if alarm evaluation/actioning is enabled. + + + + + --alarm-action <Webhook URL> URL + + + to invoke when state transitions to alarm. + May be used multiple times. Defaults to None. + + + + + --ok-action <Webhook URL> URL + + + to invoke when state transitions to OK. + May be used multiple times. Defaults to None. + + + + + --insufficient-data-action <Webhook URL> + + + URL to invoke when state transitions to + insufficient data. May be used multiple times. + Defaults to None. + + + + + --time-constraint <Time Constraint> + + + 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. + + + + + --granularity <GRANULARITY> + + + Length of each period (seconds) to evaluate + over. + + + + + --evaluation-periods <COUNT> + + + Number of periods to evaluate over. + + + + + --aggregation-method <AGGREATION> + + + Aggregation method to use, one of: ['max', + 'min', 'avg', 'sum', 'count']. + + + + + --comparison-operator <OPERATOR> + + + Operator to compare with, one of: ['lt', 'le', + 'eq', 'ne', 'ge', 'gt']. + + + + + --threshold <THRESHOLD> + + + Threshold to evaluate against. Required. + + + + + --repeat-actions {True|False} + + + True if actions should be repeatedly notified + while alarm remains in target state. Defaults + to False. + + + + + -m <METRIC>, --metric <METRIC> + + + Metric to evaluate against. Required. + + + + + --resource-type <RESOURCE_TYPE> + + + Resource_type to evaluate against. Required. + + + + + --resource-constraint <RESOURCE_CONSTRAINT> + + + Resources to evaluate against or a expression + to select multiple resources. Required. + + + + +
+
+ ceilometer alarm-gnocchi-resources-threshold-update + usage: ceilometer alarm-gnocchi-resources-threshold-update [--name <NAME>] + [--project-id <PROJECT_ID>] + [--user-id <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>] + [--granularity <GRANULARITY>] + [--evaluation-periods <COUNT>] + [--aggregation-method <AGGREATION>] + [--comparison-operator <OPERATOR>] + [--threshold <THRESHOLD>] + [--repeat-actions {True|False}] + [-m <METRIC>] + [--resource-type <RESOURCE_TYPE>] + [--resource-constraint <RESOURCE_CONSTRAINT>] + [--remove-time-constraint <Constraint names>] + [<ALARM_ID>] + +Update an existing alarm based on computed statistics. + + Positional arguments + + <ALARM_ID> + + + ID of the alarm to update. + + + + + + Optional arguments + + --name <NAME> + + + Name of the alarm (must be unique per tenant). + + + + + --project-id <PROJECT_ID> + + + Tenant to associate with alarm (only settable + by admin users). + + + + + --user-id <USER_ID> + + + User to associate with alarm (only settable by + admin users). + + + + + --description <DESCRIPTION> + + + Free text description of the alarm. + + + + + --state <STATE> + + + State of the alarm, one of: ['ok', 'alarm', + 'insufficient data'] + + + + + --severity <SEVERITY> + + + Severity of the alarm, one of: ['low', + 'moderate', 'critical'] + + + + + --enabled {True|False} + + + True if alarm evaluation/actioning is enabled. + + + + + --alarm-action <Webhook URL> URL + + + to invoke when state transitions to alarm. + May be used multiple times. Defaults to None. + + + + + --ok-action <Webhook URL> URL + + + to invoke when state transitions to OK. + May be used multiple times. Defaults to None. + + + + + --insufficient-data-action <Webhook URL> + + + URL to invoke when state transitions to + insufficient data. May be used multiple times. + Defaults to None. + + + + + --time-constraint <Time Constraint> + + + 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. + + + + + --granularity <GRANULARITY> + + + Length of each period (seconds) to evaluate + over. + + + + + --evaluation-periods <COUNT> + + + Number of periods to evaluate over. + + + + + --aggregation-method <AGGREATION> + + + Aggregation method to use, one of: ['max', + 'min', 'avg', 'sum', 'count']. + + + + + --comparison-operator <OPERATOR> + + + Operator to compare with, one of: ['lt', 'le', + 'eq', 'ne', 'ge', 'gt']. + + + + + --threshold <THRESHOLD> + + + Threshold to evaluate against. + + + + + --repeat-actions {True|False} + + + True if actions should be repeatedly notified + while alarm remains in target state. Defaults + to False. + + + + + -m <METRIC>, --metric <METRIC> + + + Metric to evaluate against. + + + + + --resource-type <RESOURCE_TYPE> + + + Resource_type to evaluate against. + + + + + --resource-constraint <RESOURCE_CONSTRAINT> + + + Resources to evaluate against or a expression + to select multiple resources. + + + + + --remove-time-constraint <Constraint names> + + + Name or list of names of the time constraints + to remove. + + +
@@ -953,6 +1871,7 @@ Set the state of an alarm. [--user-id <USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] + [--severity <SEVERITY>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] @@ -1012,6 +1931,15 @@ Create a new alarm based on computed statistics. + + --severity <SEVERITY> + + + Severity of the alarm, one of: ['low', + 'moderate', 'critical'] + + + --enabled {True|False} @@ -1055,7 +1983,7 @@ Create a new alarm based on computed statistics. 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 + 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 @@ -1144,6 +2072,7 @@ Create a new alarm based on computed statistics. [--user-id <USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] + [--severity <SEVERITY>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] @@ -1216,6 +2145,15 @@ Update an existing alarm based on computed statistics. + + --severity <SEVERITY> + + + Severity of the alarm, one of: ['low', + 'moderate', 'critical'] + + + --enabled {True|False} @@ -1259,7 +2197,7 @@ Update an existing alarm based on computed statistics. 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 + 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 @@ -1354,6 +2292,7 @@ Update an existing alarm based on computed statistics. usage: ceilometer alarm-update [--name <NAME>] [--project-id <PROJECT_ID>] [--user-id <USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] + [--severity <SEVERITY>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] @@ -1426,6 +2365,15 @@ Update an existing alarm (Deprecated). + + --severity <SEVERITY> + + + Severity of the alarm, one of: ['low', + 'moderate', 'critical'] + + + --enabled {True|False} @@ -1469,7 +2417,7 @@ Update an existing alarm (Deprecated). 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 + 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 @@ -1561,7 +2509,7 @@ Update an existing alarm (Deprecated).
ceilometer event-list - usage: ceilometer event-list [-q <QUERY>] + usage: ceilometer event-list [-q <QUERY>] [--no-traits] List events. @@ -1576,6 +2524,14 @@ List events. + + --no-traits + + + If specified, traits will not be printed. + + +
@@ -1865,9 +2821,9 @@ Create a sample.
ceilometer sample-list - usage: ceilometer sample-list [-q <QUERY>] -m <NAME> [-l <NUMBER>] + usage: ceilometer sample-list [-q <QUERY>] [-m <NAME>] [-l <NUMBER>] -List the samples for a meter. +List the samples (return OldSample objects if -m/--meter is set). Optional arguments @@ -1884,7 +2840,7 @@ List the samples for a meter. -m <NAME>, --meter <NAME> - Name of meter to show samples for. Required. + Name of meter to show samples for. @@ -1896,6 +2852,23 @@ List the samples for a meter. + +
+
+ ceilometer sample-show + usage: ceilometer sample-show <SAMPLE_ID> + +Show an sample. + + Positional arguments + + <SAMPLE_ID> + + + ID (aka message ID) of the sample to show. + + +
@@ -1975,7 +2948,7 @@ List trait info for an event type. ceilometer trait-list usage: ceilometer trait-list -e <EVENT_TYPE> -t <TRAIT_NAME> -List trait all traits with name <trait_name> for Event Type <event_type>. +List all traits with name <trait_name> for Event Type <event_type>. Optional arguments