From 3fa38907dfa2066a695d363c21c1dc3efdb73706 Mon Sep 17 00:00:00 2001 From: Christian Berendt Date: Mon, 22 Sep 2014 13:08:49 +0200 Subject: [PATCH] Update for python-ceilometerclient 1.0.11 Regenerate ch_cli_ceilometer_commands.xml with python-ceilometerclient 1.0.11 version release. Change-Id: I83a0af48226871ed9403e14b690b7fda5440aef8 --- .../generated/ch_cli_ceilometer_commands.xml | 945 ++++++++++-------- 1 file changed, 525 insertions(+), 420 deletions(-) diff --git a/doc/cli-reference/generated/ch_cli_ceilometer_commands.xml b/doc/cli-reference/generated/ch_cli_ceilometer_commands.xml index dc3c9e7555..a676026d45 100644 --- a/doc/cli-reference/generated/ch_cli_ceilometer_commands.xml +++ b/doc/cli-reference/generated/ch_cli_ceilometer_commands.xml @@ -10,10 +10,14 @@ Telemetry command-line client - The ceilometer client is the command-line interface - (CLI) for the Telemetry API and its extensions. This chapter documents - ceilometer version 1.0.10. + + The ceilometer client is the command-line + interface (CLI) for the Telemetry API and its extensions. + + This chapter documents ceilometer version + 1.0.11. + For help on a specific ceilometer command, enter: @@ -21,19 +25,24 @@
ceilometer usage - usage: ceilometer [--version] [-d] [-v] [-k] [--cert-file CERT_FILE] - [--key-file KEY_FILE] [--os-cacert <ca-certificate-file>] - [--ca-file OS_CACERT] [--timeout TIMEOUT] - [--os-username OS_USERNAME] [--os-password OS_PASSWORD] - [--os-tenant-id OS_TENANT_ID] - [--os-tenant-name OS_TENANT_NAME] - [--os-auth-url OS_AUTH_URL] - [--os-region-name OS_REGION_NAME] - [--os-auth-token OS_AUTH_TOKEN] + usage: ceilometer [--version] [-d] [-v] [--timeout TIMEOUT] [--ceilometer-url CEILOMETER_URL] [--ceilometer-api-version CEILOMETER_API_VERSION] - [--os-service-type OS_SERVICE_TYPE] - [--os-endpoint-type OS_ENDPOINT_TYPE] + [--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-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> ... Subcommands @@ -41,7 +50,8 @@ alarm-combination-create - Create a new alarm based on state of other alarms. + Create a new alarm based on state of other + alarms. @@ -49,8 +59,8 @@ alarm-combination-update - Update an existing alarm based on state of other - alarms. + Update an existing alarm based on state of + other alarms. @@ -58,8 +68,8 @@ alarm-create - Create a new alarm (Deprecated). Use alarm-threshold- - create instead. + Create a new alarm (Deprecated). Use alarm- + threshold-create instead. @@ -115,7 +125,8 @@ alarm-threshold-create - Create a new alarm based on computed statistics. + Create a new alarm based on computed + statistics. @@ -123,7 +134,8 @@ alarm-threshold-update - Update an existing alarm based on computed statistics. + Update an existing alarm based on computed + statistics. @@ -171,7 +183,7 @@ query-alarm-history - Query Alarm History. + Query Alarm History. @@ -235,7 +247,7 @@ trait-description-list - List trait info for an event type. + List trait info for an event type. @@ -243,8 +255,8 @@ trait-list - List trait all traits with name <trait_name> for Event - Type + List trait all traits with name <trait_name> + for Event Type @@ -252,7 +264,8 @@ bash-completion - Prints all of the commands and options to stdout. + Prints all of the commands and options to + stdout. @@ -294,56 +307,6 @@ - - -k, --insecure - - - Explicitly allow ceilometerclient to perform - "insecure" SSL (https) requests. The server's - certificate will not be verified against any - certificate authorities. This option should be used - with caution. - - - - - --cert-file CERT_FILE - - - Path of certificate file to use in SSL connection. - This file can optionally be prepended with the private - key. - - - - - --key-file KEY_FILE - - - Path of client key to use in SSL connection. This - option is not necessary if your key is prepended to - your cert file. - - - - - --os-cacert <ca-certificate-file> - - - Path of CA TLS certificate(s) used to verifythe remote - server's certificate. Without this option ceilometer - looks for the default system CA certificates. - - - - - --ca-file OS_CACERT - - - DEPRECATED! Use --os-cacert. - - - --timeout TIMEOUT @@ -352,62 +315,6 @@ - - --os-username OS_USERNAME - - - Defaults to env[OS_USERNAME]. - - - - - --os-password OS_PASSWORD - - - Defaults to env[OS_PASSWORD]. - - - - - --os-tenant-id OS_TENANT_ID - - - Defaults to env[OS_TENANT_ID]. - - - - - --os-tenant-name OS_TENANT_NAME - - - Defaults to env[OS_TENANT_NAME]. - - - - - --os-auth-url OS_AUTH_URL - - - Defaults to env[OS_AUTH_URL]. - - - - - --os-region-name OS_REGION_NAME - - - Defaults to env[OS_REGION_NAME]. - - - - - --os-auth-token OS_AUTH_TOKEN - - - Defaults to env[OS_AUTH_TOKEN]. - - - --ceilometer-url CEILOMETER_URL @@ -425,7 +332,31 @@ - --os-service-type OS_SERVICE_TYPE + --os-tenant-id <tenant-id> + + + Defaults to env[OS_TENANT_ID]. + + + + + --os-region-name <region-name> + + + Defaults to env[OS_REGION_NAME]. + + + + + --os-auth-token <auth-token> + + + Defaults to env[OS_AUTH_TOKEN]. + + + + + --os-service-type <service-type> Defaults to env[OS_SERVICE_TYPE]. @@ -433,17 +364,153 @@ - --os-endpoint-type OS_ENDPOINT_TYPE + --os-endpoint-type <endpoint-type> Defaults to env[OS_ENDPOINT_TYPE]. + + --os-cacert <cacert> + + + Defaults to env[OS_CACERT]. + + + + + --os-insecure <insecure> + + + Defaults to env[OS_INSECURE]. + + + + + --os-cert-file <cert-file> + + + Defaults to env[OS_CERT_FILE]. + + + + + --os-key-file <key-file> + + + Defaults to env[OS_KEY_FILE]. + + + + + --os-cert <cert> + + + Defaults to env[OS_CERT]. + + + + + --os-key <key> + + + Defaults to env[OS_KEY]. + + + + + --os-project-name <project-name> + + + Defaults to env[OS_PROJECT_NAME]. + + + + + --os-project-id <project-id> + + + Defaults to env[OS_PROJECT_ID]. + + + + + --os-user-domain-id <user-domain-id> + + + Defaults to env[OS_USER_DOMAIN_ID]. + + + + + --os-user-domain-name <user-domain-name> + + + Defaults to env[OS_USER_DOMAIN_NAME]. + + + + + --os-endpoint <endpoint> + + + Defaults to env[OS_ENDPOINT]. + + + + + --os-auth-system <auth-system> + + + Defaults to env[OS_AUTH_SYSTEM]. + + + + + --os-username <username> + + + Defaults to env[OS_USERNAME]. + + + + + --os-password <password> + + + Defaults to env[OS_PASSWORD]. + + + + + --os-tenant-name <tenant-name> + + + Defaults to env[OS_TENANT_NAME]. + + + + + --os-token <token> + + + Defaults to env[OS_TOKEN]. + + + + + --os-auth-url <auth-url> + + + Defaults to env[OS_AUTH_URL]. + + +
- ceilometer alarm-combination-create command + ceilometer alarm-combination-create usage: ceilometer alarm-combination-create --name <NAME> [--project-id <PROJECT_ID>] [--user-id <USER_ID>] @@ -474,8 +541,8 @@ Create a new alarm based on state of other alarms. --project-id <PROJECT_ID> - Tenant to associate with alarm (only settable by admin - users). + Tenant to associate with alarm (only settable + by admin users). @@ -483,8 +550,8 @@ Create a new alarm based on state of other alarms. --user-id <USER_ID> - User to associate with alarm (only settable by admin - users). + User to associate with alarm (only settable by + admin users). @@ -492,7 +559,7 @@ Create a new alarm based on state of other alarms. --description <DESCRIPTION> - Free text description of the alarm. + Free text description of the alarm. @@ -501,7 +568,7 @@ Create a new alarm based on state of other alarms. State of the alarm, one of: ['ok', 'alarm', - 'insufficient_data'] + 'insufficient data'] @@ -509,25 +576,25 @@ Create a new alarm based on state of other alarms. --enabled {True|False} - True if alarm evaluation/actioning is enabled. + True if alarm evaluation/actioning is enabled. - --alarm-action <Webhook URL> + --alarm-action <Webhook URL> URL - URL to invoke when state transitions to alarm. May be - used multiple times. Defaults to None. + to invoke when state transitions to alarm. + May be used multiple times. Defaults to None. - --ok-action <Webhook URL> + --ok-action <Webhook URL> URL - URL to invoke when state transitions to OK. May be - used multiple times. Defaults to None. + to invoke when state transitions to OK. + May be used multiple times. Defaults to None. @@ -536,7 +603,7 @@ Create a new alarm based on state of other alarms. URL to invoke when state transitions to - insufficient_data. May be used multiple times. + insufficient data. May be used multiple times. Defaults to None. @@ -545,14 +612,15 @@ Create a new alarm based on state of other alarms. --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>;duration=<SECONDS>;[description=<DESCRIPTION>;[t - imezone=<IANA Timezone>]] Defaults to None. + 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. @@ -560,7 +628,7 @@ Create a new alarm based on state of other alarms. --alarm_ids <ALARM IDS> - List of alarm ids. Required. + List of alarm IDs. Required. @@ -568,7 +636,8 @@ Create a new alarm based on state of other alarms. --operator <OPERATOR> - Operator to compare with, one of: ['and', 'or']. + Operator to compare with, one of: ['and', + 'or']. @@ -576,16 +645,17 @@ Create a new alarm based on state of other alarms. --repeat-actions {True|False} - True if actions should be repeatedly notified while - alarm remains in target state. Defaults to False. + True if actions should be repeatedly notified + while alarm remains in target state. Defaults + to False.
- ceilometer alarm-combination-update command - usage: ceilometer alarm-combination-update -a <ALARM_ID> [--name <NAME>] + ceilometer alarm-combination-update + usage: ceilometer alarm-combination-update [--name <NAME>] [--project-id <PROJECT_ID>] [--user-id <USER_ID>] [--description <DESCRIPTION>] @@ -598,19 +668,23 @@ Create a new alarm based on state of other alarms. [--remove-time-constraint <Constraint names>] [--alarm_ids <ALARM IDS>] [--operator <OPERATOR>] - [--repeat-actions {True|False}] + [--repeat-actions {True|False}] + [<ALARM_ID>] Update an existing alarm based on state of other alarms. - Optional arguments + Positional arguments - -a <ALARM_ID>, --alarm_id <ALARM_ID> + <ALARM_ID> - ID of the alarm to update. Required. + ID of the alarm to update. + + + Optional arguments --name <NAME> @@ -623,8 +697,8 @@ Update an existing alarm based on state of other alarms. --project-id <PROJECT_ID> - Tenant to associate with alarm (only settable by admin - users). + Tenant to associate with alarm (only settable + by admin users). @@ -632,8 +706,8 @@ Update an existing alarm based on state of other alarms. --user-id <USER_ID> - User to associate with alarm (only settable by admin - users). + User to associate with alarm (only settable by + admin users). @@ -641,7 +715,7 @@ Update an existing alarm based on state of other alarms. --description <DESCRIPTION> - Free text description of the alarm. + Free text description of the alarm. @@ -650,7 +724,7 @@ Update an existing alarm based on state of other alarms. State of the alarm, one of: ['ok', 'alarm', - 'insufficient_data'] + 'insufficient data'] @@ -658,25 +732,25 @@ Update an existing alarm based on state of other alarms. --enabled {True|False} - True if alarm evaluation/actioning is enabled. + True if alarm evaluation/actioning is enabled. - --alarm-action <Webhook URL> + --alarm-action <Webhook URL> URL - URL to invoke when state transitions to alarm. May be - used multiple times. Defaults to None. + to invoke when state transitions to alarm. + May be used multiple times. Defaults to None. - --ok-action <Webhook URL> + --ok-action <Webhook URL> URL - URL to invoke when state transitions to OK. May be - used multiple times. Defaults to None. + to invoke when state transitions to OK. + May be used multiple times. Defaults to None. @@ -685,7 +759,7 @@ Update an existing alarm based on state of other alarms. URL to invoke when state transitions to - insufficient_data. May be used multiple times. + insufficient data. May be used multiple times. Defaults to None. @@ -694,14 +768,15 @@ Update an existing alarm based on state of other alarms. --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>;duration=<SECONDS>;[description=<DESCRIPTION>;[t - imezone=<IANA Timezone>]] Defaults to None. + 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. @@ -709,8 +784,8 @@ Update an existing alarm based on state of other alarms. --remove-time-constraint <Constraint names> - Name or list of names of the time constraints to - remove. + Name or list of names of the time constraints + to remove. @@ -718,7 +793,7 @@ Update an existing alarm based on state of other alarms. --alarm_ids <ALARM IDS> - List of alarm id. + List of alarm IDs. @@ -726,7 +801,8 @@ Update an existing alarm based on state of other alarms. --operator <OPERATOR> - Operator to compare with, one of: ['and', 'or']. + Operator to compare with, one of: ['and', + 'or']. @@ -734,59 +810,62 @@ Update an existing alarm based on state of other alarms. --repeat-actions {True|False} - True if actions should be repeatedly notified while - alarm remains in target state. + True if actions should be repeatedly notified + while alarm remains in target state.
- ceilometer alarm-delete command - usage: ceilometer alarm-delete -a <ALARM_ID> + ceilometer alarm-delete + usage: ceilometer alarm-delete [<ALARM_ID>] Delete an alarm. - Optional arguments + Positional arguments - -a <ALARM_ID>, --alarm_id <ALARM_ID> + <ALARM_ID> - ID of the alarm to delete. Required. + ID of the alarm to delete.
- ceilometer alarm-history command - usage: ceilometer alarm-history -a <ALARM_ID> [-q <QUERY>] + ceilometer alarm-history + usage: ceilometer alarm-history [-q <QUERY>] [<ALARM_ID>] Display the change history of an alarm. - Optional arguments + Positional arguments - -a <ALARM_ID>, --alarm_id <ALARM_ID> + <ALARM_ID> - ID of the alarm for which history is shown. Required. + ID of the alarm for which history is shown. + + + Optional arguments -q <QUERY>, --query <QUERY> - key[op]data_type::value; list. data_type is optional, - but if supplied must be string, integer, float, or - boolean. + key[op]data_type::value; list. data_type is + optional, but if supplied must be string, + integer, float, or boolean.
- ceilometer alarm-list command + ceilometer alarm-list usage: ceilometer alarm-list [-q <QUERY>] List the user's alarms. @@ -796,76 +875,79 @@ List the user's alarms. -q <QUERY>, --query <QUERY> - key[op]data_type::value; list. data_type is optional, - but if supplied must be string, integer, float, or - boolean. + key[op]data_type::value; list. data_type is + optional, but if supplied must be string, + integer, float, or boolean.
- ceilometer alarm-show command - usage: ceilometer alarm-show -a <ALARM_ID> + ceilometer alarm-show + usage: ceilometer alarm-show [<ALARM_ID>] Show an alarm. - Optional arguments + Positional arguments - -a <ALARM_ID>, --alarm_id <ALARM_ID> + <ALARM_ID> - ID of the alarm to show. Required. + ID of the alarm to show.
- ceilometer alarm-state-get command - usage: ceilometer alarm-state-get -a <ALARM_ID> + ceilometer alarm-state-get + usage: ceilometer alarm-state-get [<ALARM_ID>] Get the state of an alarm. - Optional arguments + Positional arguments - -a <ALARM_ID>, --alarm_id <ALARM_ID> + <ALARM_ID> - ID of the alarm state to show. Required. + ID of the alarm state to show.
- ceilometer alarm-state-set command - usage: ceilometer alarm-state-set -a <ALARM_ID> --state <STATE> + ceilometer alarm-state-set + usage: ceilometer alarm-state-set --state <STATE> [<ALARM_ID>] Set the state of an alarm. - Optional arguments + Positional arguments - -a <ALARM_ID>, --alarm_id <ALARM_ID> + <ALARM_ID> - ID of the alarm state to set. Required. + ID of the alarm state to set. + + + Optional arguments --state <STATE> - State of the alarm, one of: ['ok', 'alarm', - 'insufficient_data']. Required. + State of the alarm, one of: ['ok', 'alarm', 'insufficient + data']. Required.
- ceilometer alarm-threshold-create command + ceilometer alarm-threshold-create usage: ceilometer alarm-threshold-create --name <NAME> [--project-id <PROJECT_ID>] [--user-id <USER_ID>] @@ -899,8 +981,8 @@ Create a new alarm based on computed statistics. --project-id <PROJECT_ID> - Tenant to associate with alarm (only settable by admin - users). + Tenant to associate with alarm (only settable + by admin users). @@ -908,8 +990,8 @@ Create a new alarm based on computed statistics. --user-id <USER_ID> - User to associate with alarm (only settable by admin - users). + User to associate with alarm (only settable by + admin users). @@ -917,7 +999,7 @@ Create a new alarm based on computed statistics. --description <DESCRIPTION> - Free text description of the alarm. + Free text description of the alarm. @@ -926,7 +1008,7 @@ Create a new alarm based on computed statistics. State of the alarm, one of: ['ok', 'alarm', - 'insufficient_data'] + 'insufficient data'] @@ -934,25 +1016,25 @@ Create a new alarm based on computed statistics. --enabled {True|False} - True if alarm evaluation/actioning is enabled. + True if alarm evaluation/actioning is enabled. - --alarm-action <Webhook URL> + --alarm-action <Webhook URL> URL - URL to invoke when state transitions to alarm. May be - used multiple times. Defaults to None. + to invoke when state transitions to alarm. + May be used multiple times. Defaults to None. - --ok-action <Webhook URL> + --ok-action <Webhook URL> URL - URL to invoke when state transitions to OK. May be - used multiple times. Defaults to None. + to invoke when state transitions to OK. + May be used multiple times. Defaults to None. @@ -961,7 +1043,7 @@ Create a new alarm based on computed statistics. URL to invoke when state transitions to - insufficient_data. May be used multiple times. + insufficient data. May be used multiple times. Defaults to None. @@ -970,14 +1052,15 @@ Create a new alarm based on computed statistics. --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>;duration=<SECONDS>;[description=<DESCRIPTION>;[t - imezone=<IANA Timezone>]] Defaults to None. + 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. @@ -993,7 +1076,8 @@ Create a new alarm based on computed statistics. --period <PERIOD> - Length of each period (seconds) to evaluate over. + Length of each period (seconds) to evaluate + over. @@ -1001,7 +1085,7 @@ Create a new alarm based on computed statistics. --evaluation-periods <COUNT> - Number of periods to evaluate over. + Number of periods to evaluate over. @@ -1009,8 +1093,8 @@ Create a new alarm based on computed statistics. --statistic <STATISTIC> - Statistic to evaluate, one of: ['max', 'min', 'avg', - 'sum', 'count']. + Statistic to evaluate, one of: ['max', 'min', + 'avg', 'sum', 'count']. @@ -1018,8 +1102,8 @@ Create a new alarm based on computed statistics. --comparison-operator <OPERATOR> - Operator to compare with, one of: ['lt', 'le', 'eq', - 'ne', 'ge', 'gt']. + Operator to compare with, one of: ['lt', 'le', + 'eq', 'ne', 'ge', 'gt']. @@ -1027,7 +1111,7 @@ Create a new alarm based on computed statistics. --threshold <THRESHOLD> - Threshold to evaluate against. Required. + Threshold to evaluate against. Required. @@ -1035,9 +1119,9 @@ Create a new alarm based on computed statistics. -q <QUERY>, --query <QUERY> - key[op]data_type::value; list. data_type is optional, - but if supplied must be string, integer, float, or - boolean. + key[op]data_type::value; list. data_type is + optional, but if supplied must be string, + integer, float, or boolean. @@ -1045,16 +1129,17 @@ Create a new alarm based on computed statistics. --repeat-actions {True|False} - True if actions should be repeatedly notified while - alarm remains in target state. Defaults to False. + True if actions should be repeatedly notified + while alarm remains in target state. Defaults + to False.
- ceilometer alarm-threshold-update command - usage: ceilometer alarm-threshold-update -a <ALARM_ID> [--name <NAME>] + ceilometer alarm-threshold-update + usage: ceilometer alarm-threshold-update [--name <NAME>] [--project-id <PROJECT_ID>] [--user-id <USER_ID>] [--description <DESCRIPTION>] @@ -1071,19 +1156,23 @@ Create a new alarm based on computed statistics. [--comparison-operator <OPERATOR>] [--threshold <THRESHOLD>] [-q <QUERY>] - [--repeat-actions {True|False}] + [--repeat-actions {True|False}] + [<ALARM_ID>] Update an existing alarm based on computed statistics. - Optional arguments + Positional arguments - -a <ALARM_ID>, --alarm_id <ALARM_ID> + <ALARM_ID> - ID of the alarm to update. Required. + ID of the alarm to update. + + + Optional arguments --name <NAME> @@ -1096,8 +1185,8 @@ Update an existing alarm based on computed statistics. --project-id <PROJECT_ID> - Tenant to associate with alarm (only settable by admin - users). + Tenant to associate with alarm (only settable + by admin users). @@ -1105,8 +1194,8 @@ Update an existing alarm based on computed statistics. --user-id <USER_ID> - User to associate with alarm (only settable by admin - users). + User to associate with alarm (only settable by + admin users). @@ -1114,7 +1203,7 @@ Update an existing alarm based on computed statistics. --description <DESCRIPTION> - Free text description of the alarm. + Free text description of the alarm. @@ -1123,7 +1212,7 @@ Update an existing alarm based on computed statistics. State of the alarm, one of: ['ok', 'alarm', - 'insufficient_data'] + 'insufficient data'] @@ -1131,25 +1220,25 @@ Update an existing alarm based on computed statistics. --enabled {True|False} - True if alarm evaluation/actioning is enabled. + True if alarm evaluation/actioning is enabled. - --alarm-action <Webhook URL> + --alarm-action <Webhook URL> URL - URL to invoke when state transitions to alarm. May be - used multiple times. Defaults to None. + to invoke when state transitions to alarm. + May be used multiple times. Defaults to None. - --ok-action <Webhook URL> + --ok-action <Webhook URL> URL - URL to invoke when state transitions to OK. May be - used multiple times. Defaults to None. + to invoke when state transitions to OK. + May be used multiple times. Defaults to None. @@ -1158,7 +1247,7 @@ Update an existing alarm based on computed statistics. URL to invoke when state transitions to - insufficient_data. May be used multiple times. + insufficient data. May be used multiple times. Defaults to None. @@ -1167,14 +1256,15 @@ Update an existing alarm based on computed statistics. --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>;duration=<SECONDS>;[description=<DESCRIPTION>;[t - imezone=<IANA Timezone>]] Defaults to None. + 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. @@ -1182,8 +1272,8 @@ Update an existing alarm based on computed statistics. --remove-time-constraint <Constraint names> - Name or list of names of the time constraints to - remove. + Name or list of names of the time constraints + to remove. @@ -1199,7 +1289,8 @@ Update an existing alarm based on computed statistics. --period <PERIOD> - Length of each period (seconds) to evaluate over. + Length of each period (seconds) to evaluate + over. @@ -1207,7 +1298,7 @@ Update an existing alarm based on computed statistics. --evaluation-periods <COUNT> - Number of periods to evaluate over. + Number of periods to evaluate over. @@ -1215,8 +1306,8 @@ Update an existing alarm based on computed statistics. --statistic <STATISTIC> - Statistic to evaluate, one of: ['max', 'min', 'avg', - 'sum', 'count']. + Statistic to evaluate, one of: ['max', 'min', + 'avg', 'sum', 'count']. @@ -1224,8 +1315,8 @@ Update an existing alarm based on computed statistics. --comparison-operator <OPERATOR> - Operator to compare with, one of: ['lt', 'le', 'eq', - 'ne', 'ge', 'gt']. + Operator to compare with, one of: ['lt', 'le', + 'eq', 'ne', 'ge', 'gt']. @@ -1233,7 +1324,7 @@ Update an existing alarm based on computed statistics. --threshold <THRESHOLD> - Threshold to evaluate against. + Threshold to evaluate against. @@ -1241,9 +1332,9 @@ Update an existing alarm based on computed statistics. -q <QUERY>, --query <QUERY> - key[op]data_type::value; list. data_type is optional, - but if supplied must be string, integer, float, or - boolean. + key[op]data_type::value; list. data_type is + optional, but if supplied must be string, + integer, float, or boolean. @@ -1251,17 +1342,16 @@ Update an existing alarm based on computed statistics. --repeat-actions {True|False} - True if actions should be repeatedly notified while - alarm remains in target state. + True if actions should be repeatedly notified + while alarm remains in target state.
- ceilometer alarm-update command - usage: ceilometer alarm-update -a <ALARM_ID> [--name <NAME>] - [--project-id <PROJECT_ID>] + ceilometer alarm-update + usage: ceilometer alarm-update [--name <NAME>] [--project-id <PROJECT_ID>] [--user-id <USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--enabled {True|False}] @@ -1276,19 +1366,23 @@ Update an existing alarm based on computed statistics. [--comparison-operator <OPERATOR>] [--threshold <THRESHOLD>] [--matching-metadata <Matching Metadata>] - [--repeat-actions {True|False}] + [--repeat-actions {True|False}] + [<ALARM_ID>] Update an existing alarm (Deprecated). - Optional arguments + Positional arguments - -a <ALARM_ID>, --alarm_id <ALARM_ID> + <ALARM_ID> - ID of the alarm to update. Required. + ID of the alarm to update. + + + Optional arguments --name <NAME> @@ -1301,8 +1395,8 @@ Update an existing alarm (Deprecated). --project-id <PROJECT_ID> - Tenant to associate with alarm (only settable by admin - users). + Tenant to associate with alarm (only settable + by admin users). @@ -1310,8 +1404,8 @@ Update an existing alarm (Deprecated). --user-id <USER_ID> - User to associate with alarm (only settable by admin - users). + User to associate with alarm (only settable by + admin users). @@ -1319,7 +1413,7 @@ Update an existing alarm (Deprecated). --description <DESCRIPTION> - Free text description of the alarm. + Free text description of the alarm. @@ -1328,7 +1422,7 @@ Update an existing alarm (Deprecated). State of the alarm, one of: ['ok', 'alarm', - 'insufficient_data'] + 'insufficient data'] @@ -1336,25 +1430,25 @@ Update an existing alarm (Deprecated). --enabled {True|False} - True if alarm evaluation/actioning is enabled. + True if alarm evaluation/actioning is enabled. - --alarm-action <Webhook URL> + --alarm-action <Webhook URL> URL - URL to invoke when state transitions to alarm. May be - used multiple times. Defaults to None. + to invoke when state transitions to alarm. + May be used multiple times. Defaults to None. - --ok-action <Webhook URL> + --ok-action <Webhook URL> URL - URL to invoke when state transitions to OK. May be - used multiple times. Defaults to None. + to invoke when state transitions to OK. + May be used multiple times. Defaults to None. @@ -1363,7 +1457,7 @@ Update an existing alarm (Deprecated). URL to invoke when state transitions to - insufficient_data. May be used multiple times. + insufficient data. May be used multiple times. Defaults to None. @@ -1372,14 +1466,15 @@ Update an existing alarm (Deprecated). --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>;duration=<SECONDS>;[description=<DESCRIPTION>;[t - imezone=<IANA Timezone>]] Defaults to None. + 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. @@ -1387,8 +1482,8 @@ Update an existing alarm (Deprecated). --remove-time-constraint <Constraint names> - Name or list of names of the time constraints to - remove. + Name or list of names of the time constraints + to remove. @@ -1396,7 +1491,8 @@ Update an existing alarm (Deprecated). --period <PERIOD> - Length of each period (seconds) to evaluate over. + Length of each period (seconds) to evaluate + over. @@ -1404,7 +1500,7 @@ Update an existing alarm (Deprecated). --evaluation-periods <COUNT> - Number of periods to evaluate over. + Number of periods to evaluate over. @@ -1420,8 +1516,8 @@ Update an existing alarm (Deprecated). --statistic <STATISTIC> - Statistic to evaluate, one of: ['max', 'min', 'avg', - 'sum', 'count'] + Statistic to evaluate, one of: ['max', 'min', + 'avg', 'sum', 'count'] @@ -1429,8 +1525,8 @@ Update an existing alarm (Deprecated). --comparison-operator <OPERATOR> - Operator to compare with, one of: ['lt', 'le', 'eq', - 'ne', 'ge', 'gt']. + Operator to compare with, one of: ['lt', 'le', + 'eq', 'ne', 'ge', 'gt']. @@ -1438,7 +1534,7 @@ Update an existing alarm (Deprecated). --threshold <THRESHOLD> - Threshold to evaluate against. + Threshold to evaluate against. @@ -1447,8 +1543,8 @@ Update an existing alarm (Deprecated). A meter should match this resource metadata - (key=value) additionally to the meter_name. Defaults - to None. + (key=value) additionally to the meter_name. + Defaults to None. @@ -1456,15 +1552,15 @@ Update an existing alarm (Deprecated). --repeat-actions {True|False} - True if actions should be repeatedly notified while - alarm remains in target state. + True if actions should be repeatedly notified + while alarm remains in target state.
- ceilometer event-list command + ceilometer event-list usage: ceilometer event-list [-q <QUERY>] List events. @@ -1474,40 +1570,40 @@ List events. -q <QUERY>, --query <QUERY> - key[op]data_type::value; list. data_type is optional, - but if supplied must be string, integer, floator - datetime. + key[op]data_type::value; list. data_type is + optional, but if supplied must be string, + integer, floator datetime.
- ceilometer event-show command - usage: ceilometer event-show -m <message_id> + ceilometer event-show + usage: ceilometer event-show <message_id> Show a particular event. - Optional arguments + Positional arguments - -m <message_id>, --message_id <message_id> + <message_id> - The id of the event. Should be a UUID Required. + The ID of the event. Should be a UUID.
- ceilometer event-type-list command + ceilometer event-type-list usage: ceilometer event-type-list List event types.
- ceilometer meter-list command + ceilometer meter-list usage: ceilometer meter-list [-q <QUERY>] List the user's meters. @@ -1517,16 +1613,16 @@ List the user's meters. -q <QUERY>, --query <QUERY> - key[op]data_type::value; list. data_type is optional, - but if supplied must be string, integer, float, or - boolean. + key[op]data_type::value; list. data_type is + optional, but if supplied must be string, + integer, float, or boolean.
- ceilometer query-alarm-history command + ceilometer query-alarm-history usage: ceilometer query-alarm-history [-f <FILTER>] [-o <ORDERBY>] [-l <LIMIT>] @@ -1537,9 +1633,10 @@ Query Alarm History. -f <FILTER>, --filter <FILTER> - {complex_op: [{simple_op: {field_name: value}}]} The - complex_op is one of: ['and', 'or'], simple_op is one - of: ['=', '!=', '<', '<=', '>', '>=']. + {complex_op: [{simple_op: {field_name: + value}}]} The complex_op is one of: ['and', + 'or'], simple_op is one of: ['=', '!=', '<', + '<=', '>', '>=']. @@ -1547,8 +1644,9 @@ Query Alarm History. -o <ORDERBY>, --orderby <ORDERBY> - [{field_name: direction}, {field_name: direction}] The - direction is one of: ['asc', 'desc']. + [{field_name: direction}, {field_name: + direction}] The direction is one of: ['asc', + 'desc']. @@ -1556,14 +1654,15 @@ Query Alarm History. -l <LIMIT>, --limit <LIMIT> - Maximum number of alarm history items to return. + Maximum number of alarm history items to + return.
- ceilometer query-alarms command + ceilometer query-alarms usage: ceilometer query-alarms [-f <FILTER>] [-o <ORDERBY>] [-l <LIMIT>] Query Alarms. @@ -1573,9 +1672,10 @@ Query Alarms. -f <FILTER>, --filter <FILTER> - {complex_op: [{simple_op: {field_name: value}}]} The - complex_op is one of: ['and', 'or'], simple_op is one - of: ['=', '!=', '<', '<=', '>', '>=']. + {complex_op: [{simple_op: {field_name: + value}}]} The complex_op is one of: ['and', + 'or'], simple_op is one of: ['=', '!=', '<', + '<=', '>', '>=']. @@ -1583,8 +1683,9 @@ Query Alarms. -o <ORDERBY>, --orderby <ORDERBY> - [{field_name: direction}, {field_name: direction}] The - direction is one of: ['asc', 'desc']. + [{field_name: direction}, {field_name: + direction}] The direction is one of: ['asc', + 'desc']. @@ -1592,14 +1693,14 @@ Query Alarms. -l <LIMIT>, --limit <LIMIT> - Maximum number of alarms to return. + Maximum number of alarms to return.
- ceilometer query-samples command + ceilometer query-samples usage: ceilometer query-samples [-f <FILTER>] [-o <ORDERBY>] [-l <LIMIT>] Query samples. @@ -1609,9 +1710,10 @@ Query samples. -f <FILTER>, --filter <FILTER> - {complex_op: [{simple_op: {field_name: value}}]} The - complex_op is one of: ['and', 'or'], simple_op is one - of: ['=', '!=', '<', '<=', '>', '>=']. + {complex_op: [{simple_op: {field_name: + value}}]} The complex_op is one of: ['and', + 'or'], simple_op is one of: ['=', '!=', '<', + '<=', '>', '>=']. @@ -1619,8 +1721,9 @@ Query samples. -o <ORDERBY>, --orderby <ORDERBY> - [{field_name: direction}, {field_name: direction}] The - direction is one of: ['asc', 'desc']. + [{field_name: direction}, {field_name: + direction}] The direction is one of: ['asc', + 'desc']. @@ -1628,14 +1731,14 @@ Query samples. -l <LIMIT>, --limit <LIMIT> - Maximum number of samples to return. + Maximum number of samples to return.
- ceilometer resource-list command + ceilometer resource-list usage: ceilometer resource-list [-q <QUERY>] List the resources. @@ -1645,33 +1748,33 @@ List the resources. -q <QUERY>, --query <QUERY> - key[op]data_type::value; list. data_type is optional, - but if supplied must be string, integer, float, or - boolean. + key[op]data_type::value; list. data_type is + optional, but if supplied must be string, + integer, float, or boolean.
- ceilometer resource-show command - usage: ceilometer resource-show -r <RESOURCE_ID> + ceilometer resource-show + usage: ceilometer resource-show <RESOURCE_ID> Show the resource. - Optional arguments + Positional arguments - -r <RESOURCE_ID>, --resource_id <RESOURCE_ID> + <RESOURCE_ID> - ID of the resource to show. Required. + ID of the resource to show.
- ceilometer sample-create command + ceilometer sample-create usage: ceilometer sample-create [--project-id <PROJECT_ID>] [--user-id <USER_ID>] -r <RESOURCE_ID> -m <METER_NAME> --meter-type <METER_TYPE> @@ -1687,8 +1790,8 @@ Create a sample. --project-id <PROJECT_ID> - Tenant to associate with sample (only settable by - admin users). + Tenant to associate with sample (only settable + by admin users). @@ -1696,8 +1799,8 @@ Create a sample. --user-id <USER_ID> - User to associate with sample (only settable by admin - users). + User to associate with sample (only settable + by admin users). @@ -1721,7 +1824,7 @@ Create a sample. --meter-type <METER_TYPE> - The meter type. Required. + The meter type. Required. @@ -1729,7 +1832,7 @@ Create a sample. --meter-unit <METER_UNIT> - The meter unit. Required. + The meter unit. Required. @@ -1745,7 +1848,8 @@ Create a sample. --resource-metadata <RESOURCE_METADATA> - Resource metadata. + Resource metadata. Provided value should be a + set of key-value pairs e.g. {"key":"value"}. @@ -1753,14 +1857,14 @@ Create a sample. --timestamp <TIMESTAMP> - The sample timestamp. + The sample timestamp.
- ceilometer sample-list command + ceilometer sample-list usage: ceilometer sample-list [-q <QUERY>] -m <NAME> [-l <NUMBER>] List the samples for a meter. @@ -1770,9 +1874,9 @@ List the samples for a meter. -q <QUERY>, --query <QUERY> - key[op]data_type::value; list. data_type is optional, - but if supplied must be string, integer, float, or - boolean. + key[op]data_type::value; list. data_type is + optional, but if supplied must be string, + integer, float, or boolean. @@ -1780,7 +1884,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. Required. @@ -1795,7 +1899,7 @@ List the samples for a meter.
- ceilometer statistics command + ceilometer statistics usage: ceilometer statistics [-q <QUERY>] -m <NAME> [-p <PERIOD>] [-g <FIELD>] [-a <FUNC>[<-<PARAM>]] @@ -1806,9 +1910,9 @@ List the statistics for a meter. -q <QUERY>, --query <QUERY> - key[op]data_type::value; list. data_type is optional, - but if supplied must be string, integer, float, or - boolean. + key[op]data_type::value; list. data_type is + optional, but if supplied must be string, + integer, float, or boolean. @@ -1816,7 +1920,8 @@ List the statistics for a meter. -m <NAME>, --meter <NAME> - Name of meter to show samples for. Required. + Name of meter to list statistics for. + Required. @@ -1840,16 +1945,16 @@ List the statistics for a meter. -a <FUNC>[<-<PARAM>], --aggregate <FUNC>[<-<PARAM>] - Function for data aggregation. Available aggregates - are: count, cardinality, min, max, sum, stddev, avg. - Defaults to []. + Function for data aggregation. Available + aggregates are: count, cardinality, min, max, + sum, stddev, avg. Defaults to [].
- ceilometer trait-description-list command + ceilometer trait-description-list usage: ceilometer trait-description-list -e <EVENT_TYPE> List trait info for an event type. @@ -1859,15 +1964,15 @@ List trait info for an event type. -e <EVENT_TYPE>, --event_type <EVENT_TYPE> - Type of the event for which traits will be shown. - Required. + Type of the event for which traits will be + shown. Required.
- ceilometer trait-list command + 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>. @@ -1877,8 +1982,8 @@ List trait all traits with name <trait_name> for Event Type <event_type -e <EVENT_TYPE>, --event_type <EVENT_TYPE> - Type of the event for which traits will listed. - Required. + Type of the event for which traits will + listed. Required.