The ceilometer client is the command-line interface (CLI) for the Telemetry API and its extensions. This chapter documents ceilometer version 1.0.12. For help on a specific ceilometer command, enter: $ ceilometer help COMMAND

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-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> ... alarm-combination-create Create a new alarm based on state of other alarms. alarm-combination-update Update an existing alarm based on state of other alarms. alarm-create Create a new alarm (Deprecated). Use alarm- threshold-create instead. alarm-delete Delete an alarm. alarm-history Display the change history of an alarm. alarm-list List the user's alarms. alarm-show Show an alarm. alarm-state-get Get the state of an alarm. alarm-state-set Set the state of an alarm. alarm-threshold-create Create a new alarm based on computed statistics. alarm-threshold-update Update an existing alarm based on computed statistics. alarm-update Update an existing alarm (Deprecated). event-list List events. event-show Show a particular event. event-type-list List event types. meter-list List the user's meters. query-alarm-history Query Alarm History. query-alarms Query Alarms. query-samples Query samples. resource-list List the resources. resource-show Show the resource. sample-create Create a sample. sample-list List the samples for a meter. statistics List the statistics for a meter. trait-description-list List trait info for an event type. trait-list List trait all traits with name <trait_name> for Event Type bash-completion Prints all of the commands and options to stdout. help Display help about this program or one of its subcommands.

--version show program's version number and exit -d, --debug Defaults to env[CEILOMETERCLIENT_DEBUG]. -v, --verbose Print more verbose output. --timeout TIMEOUT Number of seconds to wait for a response. --ceilometer-url CEILOMETER_URL Defaults to env[CEILOMETER_URL]. --ceilometer-api-version CEILOMETER_API_VERSION Defaults to env[CEILOMETER_API_VERSION] or 2. --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]. --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].

usage: ceilometer alarm-combination-create --name <NAME> [--project-id <PROJECT_ID>] [--user-id <USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--time-constraint <Time Constraint>] --alarm_ids <ALARM IDS> [--operator <OPERATOR>] [--repeat-actions {True|False}] Create a new alarm based on state of other alarms. --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'] --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. --alarm_ids <ALARM IDS> List of alarm IDs. Required. --operator <OPERATOR> Operator to compare with, one of: ['and', 'or']. --repeat-actions {True|False} True if actions should be repeatedly notified while alarm remains in target state. Defaults to False.

usage: ceilometer alarm-combination-update [--name <NAME>] [--project-id <PROJECT_ID>] [--user-id <USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--time-constraint <Time Constraint>] [--remove-time-constraint <Constraint names>] [--alarm_ids <ALARM IDS>] [--operator <OPERATOR>] [--repeat-actions {True|False}] [<ALARM_ID>] Update an existing alarm based on state of other alarms. <ALARM_ID> ID of the alarm to update. --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'] --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. --remove-time-constraint <Constraint names> Name or list of names of the time constraints to remove. --alarm_ids <ALARM IDS> List of alarm IDs. --operator <OPERATOR> Operator to compare with, one of: ['and', 'or']. --repeat-actions {True|False} True if actions should be repeatedly notified while alarm remains in target state.

usage: ceilometer alarm-delete [<ALARM_ID>] Delete an alarm. <ALARM_ID> ID of the alarm to delete.

usage: ceilometer alarm-history [-q <QUERY>] [<ALARM_ID>] Display the change history of an alarm. <ALARM_ID> ID of the alarm for which history is shown. -q <QUERY>, --query <QUERY> key[op]data_type::value; list. data_type is optional, but if supplied must be string, integer, float, or boolean.

usage: ceilometer alarm-list [-q <QUERY>] 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.

usage: ceilometer alarm-show [<ALARM_ID>] Show an alarm. <ALARM_ID> ID of the alarm to show.

usage: ceilometer alarm-state-get [<ALARM_ID>] Get the state of an alarm. <ALARM_ID> ID of the alarm state to show.

usage: ceilometer alarm-state-set --state <STATE> [<ALARM_ID>] Set the state of an alarm. <ALARM_ID> ID of the alarm state to set. --state <STATE> State of the alarm, one of: ['ok', 'alarm', 'insufficient data']. Required.

usage: ceilometer alarm-threshold-create --name <NAME> [--project-id <PROJECT_ID>] [--user-id <USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--time-constraint <Time Constraint>] -m <METRIC> [--period <PERIOD>] [--evaluation-periods <COUNT>] [--statistic <STATISTIC>] [--comparison-operator <OPERATOR>] --threshold <THRESHOLD> [-q <QUERY>] [--repeat-actions {True|False}] Create a new alarm based on computed statistics. --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'] --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. -m <METRIC>, --meter-name <METRIC> Metric to evaluate against. Required. --period <PERIOD> Length of each period (seconds) to evaluate over. --evaluation-periods <COUNT> Number of periods to evaluate over. --statistic <STATISTIC> Statistic to evaluate, 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. -q <QUERY>, --query <QUERY> key[op]data_type::value; list. data_type is optional, but if supplied must be string, integer, float, or boolean. --repeat-actions {True|False} True if actions should be repeatedly notified while alarm remains in target state. Defaults to False.

usage: ceilometer alarm-threshold-update [--name <NAME>] [--project-id <PROJECT_ID>] [--user-id <USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--time-constraint <Time Constraint>] [--remove-time-constraint <Constraint names>] [-m <METRIC>] [--period <PERIOD>] [--evaluation-periods <COUNT>] [--statistic <STATISTIC>] [--comparison-operator <OPERATOR>] [--threshold <THRESHOLD>] [-q <QUERY>] [--repeat-actions {True|False}] [<ALARM_ID>] Update an existing alarm based on computed statistics. <ALARM_ID> ID of the alarm to update. --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'] --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. --remove-time-constraint <Constraint names> Name or list of names of the time constraints to remove. -m <METRIC>, --meter-name <METRIC> Metric to evaluate against. --period <PERIOD> Length of each period (seconds) to evaluate over. --evaluation-periods <COUNT> Number of periods to evaluate over. --statistic <STATISTIC> Statistic to evaluate, 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. -q <QUERY>, --query <QUERY> key[op]data_type::value; list. data_type is optional, but if supplied must be string, integer, float, or boolean. --repeat-actions {True|False} True if actions should be repeatedly notified while alarm remains in target state.

usage: ceilometer alarm-update [--name <NAME>] [--project-id <PROJECT_ID>] [--user-id <USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--time-constraint <Time Constraint>] [--remove-time-constraint <Constraint names>] [--period <PERIOD>] [--evaluation-periods <COUNT>] [-m <METRIC>] [--statistic <STATISTIC>] [--comparison-operator <OPERATOR>] [--threshold <THRESHOLD>] [--matching-metadata <Matching Metadata>] [--repeat-actions {True|False}] [<ALARM_ID>] Update an existing alarm (Deprecated). <ALARM_ID> ID of the alarm to update. --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'] --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. --remove-time-constraint <Constraint names> Name or list of names of the time constraints to remove. --period <PERIOD> Length of each period (seconds) to evaluate over. --evaluation-periods <COUNT> Number of periods to evaluate over. -m <METRIC>, --meter-name <METRIC> Metric to evaluate against. --statistic <STATISTIC> Statistic to evaluate, 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. --matching-metadata <Matching Metadata> A meter should match this resource metadata (key=value) additionally to the meter_name. Defaults to None. --repeat-actions {True|False} True if actions should be repeatedly notified while alarm remains in target state.

usage: ceilometer event-list [-q <QUERY>] 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.

usage: ceilometer event-show <message_id> Show a particular event. <message_id> The ID of the event. Should be a UUID.

usage: ceilometer event-type-list List event types.

usage: ceilometer meter-list [-q <QUERY>] 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.

usage: ceilometer query-alarm-history [-f <FILTER>] [-o <ORDERBY>] [-l <LIMIT>] 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: ['=', '!=', '<', '<=', '>', '>=']. -o <ORDERBY>, --orderby <ORDERBY> [{field_name: direction}, {field_name: direction}] The direction is one of: ['asc', 'desc']. -l <LIMIT>, --limit <LIMIT> Maximum number of alarm history items to return.

usage: ceilometer query-alarms [-f <FILTER>] [-o <ORDERBY>] [-l <LIMIT>] 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: ['=', '!=', '<', '<=', '>', '>=']. -o <ORDERBY>, --orderby <ORDERBY> [{field_name: direction}, {field_name: direction}] The direction is one of: ['asc', 'desc']. -l <LIMIT>, --limit <LIMIT> Maximum number of alarms to return.

usage: ceilometer query-samples [-f <FILTER>] [-o <ORDERBY>] [-l <LIMIT>] 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: ['=', '!=', '<', '<=', '>', '>=']. -o <ORDERBY>, --orderby <ORDERBY> [{field_name: direction}, {field_name: direction}] The direction is one of: ['asc', 'desc']. -l <LIMIT>, --limit <LIMIT> Maximum number of samples to return.

usage: ceilometer resource-list [-q <QUERY>] 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.

usage: ceilometer resource-show <RESOURCE_ID> Show the resource. <RESOURCE_ID> ID of the resource to show.

usage: ceilometer sample-create [--project-id <PROJECT_ID>] [--user-id <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>] Create a sample. --project-id <PROJECT_ID> Tenant to associate with sample (only settable by admin users). --user-id <USER_ID> User to associate with sample (only settable by admin users). -r <RESOURCE_ID>, --resource-id <RESOURCE_ID> ID of the resource. Required. -m <METER_NAME>, --meter-name <METER_NAME> The meter name. Required. --meter-type <METER_TYPE> The meter type. Required. --meter-unit <METER_UNIT> The meter unit. Required. --sample-volume <SAMPLE_VOLUME> The sample volume. Required. --resource-metadata <RESOURCE_METADATA> Resource metadata. Provided value should be a set of key-value pairs e.g. {"key":"value"}. --timestamp <TIMESTAMP> The sample timestamp.

usage: ceilometer sample-list [-q <QUERY>] -m <NAME> [-l <NUMBER>] 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. -m <NAME>, --meter <NAME> Name of meter to show samples for. Required. -l <NUMBER>, --limit <NUMBER> Maximum number of samples to return.

usage: ceilometer statistics [-q <QUERY>] -m <NAME> [-p <PERIOD>] [-g <FIELD>] [-a <FUNC>[<-<PARAM>]] 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. -m <NAME>, --meter <NAME> Name of meter to list statistics for. Required. -p <PERIOD>, --period <PERIOD> Period in seconds over which to group samples. -g <FIELD>, --groupby <FIELD> Field for group by. -a <FUNC>[<-<PARAM>], --aggregate <FUNC>[<-<PARAM>] Function for data aggregation. Available aggregates are: count, cardinality, min, max, sum, stddev, avg. Defaults to [].

usage: ceilometer trait-description-list -e <EVENT_TYPE> 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.

usage: ceilometer trait-list -e <EVENT_TYPE> -t <TRAIT_NAME> 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. -t <TRAIT_NAME>, --trait_name <TRAIT_NAME> The name of the trait to list. Required.