- ceilometer usage
- ceilometer optional arguments
- ceilometer alarm-combination-create command
- ceilometer alarm-combination-update command
- ceilometer alarm-delete command
- ceilometer alarm-history command
- ceilometer alarm-list command
- ceilometer alarm-show command
- ceilometer alarm-state-get command
- ceilometer alarm-state-set command
- ceilometer alarm-threshold-create command
- ceilometer alarm-threshold-update command
- ceilometer alarm-update command
- ceilometer event-list command
- ceilometer event-show command
- ceilometer event-type-list command
- ceilometer meter-list command
- ceilometer resource-list command
- ceilometer resource-show command
- ceilometer sample-create command
- ceilometer sample-list command
- ceilometer statistics command
- ceilometer trait-description-list command
- ceilometer trait-list command
The ceilometer client is the command-line interface (CLI) for the OpenStack Telemetry API and its extensions.
For help on a specific ceilometer command, enter:
$ ceilometer help COMMAND
[--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] [--ceilometer-url CEILOMETER_URL] [--ceilometer-api-version CEILOMETER_API_VERSION] [--os-service-type OS_SERVICE_TYPE] [--os-endpoint-type OS_ENDPOINT_TYPE] <subcommand> ...
Subcommands
- 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).
- 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.
- event-list
List events.
- event-show
Show a particular event.
- event-type-list
List event types.
- meter-list
List the user's meters.
- 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
- -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
Number of seconds to wait for a response
- --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
Defaults to
env[CEILOMETER_URL]
- --ceilometer-api-version CEILOMETER_API_VERSION
Defaults to
env[CEILOMETER_API_VERSION]
or 2- --os-service-type OS_SERVICE_TYPE
Defaults to
env[OS_SERVICE_TYPE]
- --os-endpoint-type OS_ENDPOINT_TYPE
Defaults to
env[OS_ENDPOINT_TYPE]
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>] --alarm_ids <ALARM IDS> [--operator <OPERATOR>] [--repeat-actions {True|False}]
Create a new alarm based on state of other alarms.
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']
- --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 unkown. May be used multiple times. Defaults to None.
- --alarm_ids <ALARM IDS>
List of alarm id 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 -a <ALARM_ID> [--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>] [--alarm_ids <ALARM IDS>] [--operator <OPERATOR>] [--repeat-actions {True|False}]
Update an existing alarm based on state of other alarms.
Optional arguments
- -a <ALARM_ID>, --alarm_id <ALARM_ID>
ID of the alarm to update. Required.
- --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 unkown. May be used multiple times. Defaults to None.
- --alarm_ids <ALARM IDS>
List of alarm id
- --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 -a <ALARM_ID>
Delete an alarm.
Optional arguments
- -a <ALARM_ID>, --alarm_id <ALARM_ID>
ID of the alarm to delete. Required.
usage: ceilometer alarm-history -a <ALARM_ID> [-q <QUERY>]
Display the change history of an alarm.
Optional arguments
- -a <ALARM_ID>, --alarm_id <ALARM_ID>
ID of the alarm for which history is shown. 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
usage: ceilometer alarm-list [-q <QUERY>]
List the user's alarms.
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
usage: ceilometer alarm-show -a <ALARM_ID>
Show an alarm.
Optional arguments
- -a <ALARM_ID>, --alarm_id <ALARM_ID>
ID of the alarm to show. Required.
usage: ceilometer alarm-state-get -a <ALARM_ID>
Get the state of an alarm.
Optional arguments
- -a <ALARM_ID>, --alarm_id <ALARM_ID>
ID of the alarm state to show. Required.
usage: ceilometer alarm-state-set -a <ALARM_ID> --state <STATE>
Set the state of an alarm.
Optional arguments
- -a <ALARM_ID>, --alarm_id <ALARM_ID>
ID of the alarm state to set. Required.
- --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>] --meter-name <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.
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']
- --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 unkown. May be used multiple times. Defaults to None.
- --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 -a <ALARM_ID> [--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>] [--meter-name <METRIC>] [--period <PERIOD>] [--evaluation-periods <COUNT>] [--statistic <STATISTIC>] [--comparison-operator <OPERATOR>] [--threshold <THRESHOLD>] [-q <QUERY>] [--repeat-actions {True|False}]
Update an existing alarm based on computed statistics.
Optional arguments
- -a <ALARM_ID>, --alarm_id <ALARM_ID>
ID of the alarm to update. Required.
- --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 unkown. May be used multiple times. Defaults to None.
- --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 -a <ALARM_ID> [--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>] [--period <PERIOD>] [--evaluation-periods <COUNT>] [--meter-name <METRIC>] [--statistic <STATISTIC>] [--comparison-operator <OPERATOR>] [--threshold <THRESHOLD>] [--matching-metadata <Matching Metadata>] [--repeat-actions {True|False}]
Update an existing alarm.
Optional arguments
- -a <ALARM_ID>, --alarm_id <ALARM_ID>
ID of the alarm to update. Required.
- --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 unkown. May be used multiple times. Defaults to None.
- --period <PERIOD>
Length of each period (seconds) to evaluate over
- --evaluation-periods <COUNT>
Number of periods to evaluate over
- --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.
Optional arguments
- -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 -m <message_id>
Show a particular event.
Optional arguments
- -m <message_id>, --message_id <message_id>
The id of the event. Should be a UUID Required.
usage: ceilometer meter-list [-q <QUERY>]
List the user's meters.
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
usage: ceilometer resource-list [-q <QUERY>]
List the resources.
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.
usage: ceilometer resource-show -r <RESOURCE_ID>
Show the resource.
Optional arguments
- -r <RESOURCE_ID>, --resource_id <RESOURCE_ID>
ID of the resource to show. Required.
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.
Optional arguments
- --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
- --timestamp <TIMESTAMP>
the sample timestamp
usage: ceilometer sample-list [-q <QUERY>] -m <NAME> [-l <NUMBER>]
List the samples for a meter.
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
- -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>]
List the statistics for a meter.
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
- -m <NAME>, --meter <NAME>
Name of meter to show samples for. Required.
- -p <PERIOD>, --period <PERIOD>
Period in seconds over which to group samples.
usage: ceilometer trait-description-list -e <EVENT_TYPE>
List trait info for an event type.
Optional arguments
- -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>.
Optional arguments
- -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.