Chapter 11. Telemetry command-line client

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). 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.

-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].

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 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>;duration=<SECONDS>;[description=<DESCRIPTION>;[t imezone=<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.

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 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>;duration=<SECONDS>;[description=<DESCRIPTION>;[t imezone=<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 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.

Optional arguments

-a <ALARM_ID>, --alarm_id <ALARM_ID>

ID of the alarm to delete. Required.

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.

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.

Optional arguments

-a <ALARM_ID>, --alarm_id <ALARM_ID>

ID of the alarm to show. Required.

Optional arguments

-a <ALARM_ID>, --alarm_id <ALARM_ID>

ID of the alarm state to show. Required.

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.

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 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>;duration=<SECONDS>;[description=<DESCRIPTION>;[t imezone=<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.

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 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>;duration=<SECONDS>;[description=<DESCRIPTION>;[t imezone=<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.

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 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>;duration=<SECONDS>;[description=<DESCRIPTION>;[t imezone=<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.

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.

Optional arguments

-m <message_id>, --message_id <message_id>

The id of the event. Should be a UUID Required.

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.

Optional arguments

-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.

Optional arguments

-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.

Optional arguments

-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.

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.

Optional arguments

-r <RESOURCE_ID>, --resource_id <RESOURCE_ID>

ID of the resource to show. Required.

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.

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.

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.

-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 [].

Optional arguments

-e <EVENT_TYPE>, --event_type <EVENT_TYPE>

Type of the event for which traits will be shown. Required.

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.