Chapter 13. Telemetry service 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-event-create

Create a new alarm based on events.

alarm-event-update

Update an existing alarm based on events.

alarm-gnocchi-aggregation-by-metrics-threshold-create

Create a new alarm based on computed statistics.

alarm-gnocchi-aggregation-by-metrics-threshold-update

Update an existing alarm based on computed statistics.

alarm-gnocchi-aggregation-by-resources-threshold-create

Create a new alarm based on computed statistics.

alarm-gnocchi-aggregation-by-resources-threshold-update

Update an existing alarm based on computed statistics.

alarm-gnocchi-resources-threshold-create

Create a new alarm based on computed statistics.

alarm-gnocchi-resources-threshold-update

Update an existing alarm based on computed statistics.

alarm-history

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

capabilities

Print Ceilometer capabilities.

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-create-list

Create a sample list.

sample-list

List the samples (return OldSample objects if -m/--meter is set).

sample-show

Show a sample.

statistics

List the statistics for a meter.

trait-description-list

List trait info for an event type.

trait-list

List all traits with name <trait_name> for Event Type <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>

DEPRECATED, use --os-endpoint instead. 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-project-domain-id <project-domain-id>

Defaults to env[OS_PROJECT_DOMAIN_ID].

--os-project-domain-name <project-domain-name>

Defaults to env[OS_PROJECT_DOMAIN_NAME].

--os-user-id <user-id>

Defaults to env[OS_USER_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].

Optional arguments

--name <NAME>

Name of the alarm (must be unique per tenant). Required.

--project-id <ALARM_PROJECT_ID>

Tenant to associate with alarm (only settable by admin users).

--user-id <ALARM_USER_ID>

User to associate with alarm (only settable by admin users).

--description <DESCRIPTION>

Free text description of the alarm.

--state <STATE>

State of the alarm, one of: ['ok', 'alarm', 'insufficient data']

--severity <SEVERITY>

Severity of the alarm, one of: ['low', 'moderate', 'critical']

--enabled {True|False}

True if alarm evaluation/actioning is enabled.

--alarm-action <Webhook URL>

URL to invoke when state transitions to alarm. May be used multiple times. Defaults to None.

--ok-action <Webhook URL>

URL to invoke when state transitions to OK. May be used multiple times. Defaults to None.

--insufficient-data-action <Webhook URL>

URL to invoke when state transitions to insufficient data. May be used multiple times. Defaults to None.

--time-constraint <Time Constraint>

Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.

--repeat-actions {True|False}

True if actions should be repeatedly notified while alarm remains in target state. Defaults to False.

--alarm_ids <ALARM IDS>

List of alarm IDs. Required.

--operator <OPERATOR>

Operator to compare with, one of: ['and', 'or'].

Positional arguments

<ALARM_ID>

ID of the alarm to update.

Optional arguments

--name <NAME>

Name of the alarm (must be unique per tenant).

--project-id <ALARM_PROJECT_ID>

Tenant to associate with alarm (only settable by admin users).

--user-id <ALARM_USER_ID>

User to associate with alarm (only settable by admin users).

--description <DESCRIPTION>

Free text description of the alarm.

--state <STATE>

State of the alarm, one of: ['ok', 'alarm', 'insufficient data']

--severity <SEVERITY>

Severity of the alarm, one of: ['low', 'moderate', 'critical']

--enabled {True|False}

True if alarm evaluation/actioning is enabled.

--alarm-action <Webhook URL>

URL to invoke when state transitions to alarm. May be used multiple times. Defaults to None.

--ok-action <Webhook URL>

URL to invoke when state transitions to OK. May be used multiple times. Defaults to None.

--insufficient-data-action <Webhook URL>

URL to invoke when state transitions to insufficient data. May be used multiple times. Defaults to None.

--time-constraint <Time Constraint>

Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.

--repeat-actions {True|False}

True if actions should be repeatedly notified while alarm remains in target state. Defaults to False.

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

Positional arguments

<ALARM_ID>

ID of the alarm to delete.

Optional arguments

--name <NAME>

Name of the alarm (must be unique per tenant). Required.

--project-id <ALARM_PROJECT_ID>

Tenant to associate with alarm (only settable by admin users).

--user-id <ALARM_USER_ID>

User to associate with alarm (only settable by admin users).

--description <DESCRIPTION>

Free text description of the alarm.

--state <STATE>

State of the alarm, one of: ['ok', 'alarm', 'insufficient data']

--severity <SEVERITY>

Severity of the alarm, one of: ['low', 'moderate', 'critical']

--enabled {True|False}

True if alarm evaluation/actioning is enabled.

--alarm-action <Webhook URL>

URL to invoke when state transitions to alarm. May be used multiple times. Defaults to None.

--ok-action <Webhook URL>

URL to invoke when state transitions to OK. May be used multiple times. Defaults to None.

--insufficient-data-action <Webhook URL>

URL to invoke when state transitions to insufficient data. May be used multiple times. Defaults to None.

--time-constraint <Time Constraint>

Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.

--repeat-actions {True|False}

True if actions should be repeatedly notified while alarm remains in target state. Defaults to False.

--event-type <EVENT_TYPE>

Event type for event alarm.

-q <QUERY>, --query <QUERY>

key[op]data_type::value; list for filtering events. data_type is optional, but if supplied must be string, integer, float or datetime.

Positional arguments

<ALARM_ID>

ID of the alarm to update.

Optional arguments

--name <NAME>

Name of the alarm (must be unique per tenant).

--project-id <ALARM_PROJECT_ID>

Tenant to associate with alarm (only settable by admin users).

--user-id <ALARM_USER_ID>

User to associate with alarm (only settable by admin users).

--description <DESCRIPTION>

Free text description of the alarm.

--state <STATE>

State of the alarm, one of: ['ok', 'alarm', 'insufficient data']

--severity <SEVERITY>

Severity of the alarm, one of: ['low', 'moderate', 'critical']

--enabled {True|False}

True if alarm evaluation/actioning is enabled.

--alarm-action <Webhook URL>

URL to invoke when state transitions to alarm. May be used multiple times. Defaults to None.

--ok-action <Webhook URL>

URL to invoke when state transitions to OK. May be used multiple times. Defaults to None.

--insufficient-data-action <Webhook URL>

URL to invoke when state transitions to insufficient data. May be used multiple times. Defaults to None.

--time-constraint <Time Constraint>

Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.

--repeat-actions {True|False}

True if actions should be repeatedly notified while alarm remains in target state. Defaults to False.

--event-type <EVENT_TYPE>

Event type for event alarm.

-q <QUERY>, --query <QUERY>

key[op]data_type::value; list for filtering events. data_type is optional, but if supplied must be string, integer, float or datetime.

Optional arguments

--name <NAME>

Name of the alarm (must be unique per tenant). Required.

--project-id <ALARM_PROJECT_ID>

Tenant to associate with alarm (only settable by admin users).

--user-id <ALARM_USER_ID>

User to associate with alarm (only settable by admin users).

--description <DESCRIPTION>

Free text description of the alarm.

--state <STATE>

State of the alarm, one of: ['ok', 'alarm', 'insufficient data']

--severity <SEVERITY>

Severity of the alarm, one of: ['low', 'moderate', 'critical']

--enabled {True|False}

True if alarm evaluation/actioning is enabled.

--alarm-action <Webhook URL>

URL to invoke when state transitions to alarm. May be used multiple times. Defaults to None.

--ok-action <Webhook URL>

URL to invoke when state transitions to OK. May be used multiple times. Defaults to None.

--insufficient-data-action <Webhook URL>

URL to invoke when state transitions to insufficient data. May be used multiple times. Defaults to None.

--time-constraint <Time Constraint>

Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.

--repeat-actions {True|False}

True if actions should be repeatedly notified while alarm remains in target state. Defaults to False.

--granularity <GRANULARITY>

Length of each period (seconds) to evaluate over.

--evaluation-periods <COUNT>

Number of periods to evaluate over.

--aggregation-method <AGGREATION>

Aggregation method to use, one of: ['max', 'min', 'avg', 'sum', 'count'].

--comparison-operator <OPERATOR>

Operator to compare with, one of: ['lt', 'le', 'eq', 'ne', 'ge', 'gt'].

--threshold <THRESHOLD>

Threshold to evaluate against. Required.

-m <METRICS>, --metrics <METRICS>

Metric to evaluate against. Required.

Positional arguments

<ALARM_ID>

ID of the alarm to update.

Optional arguments

--name <NAME>

Name of the alarm (must be unique per tenant).

--project-id <ALARM_PROJECT_ID>

Tenant to associate with alarm (only settable by admin users).

--user-id <ALARM_USER_ID>

User to associate with alarm (only settable by admin users).

--description <DESCRIPTION>

Free text description of the alarm.

--state <STATE>

State of the alarm, one of: ['ok', 'alarm', 'insufficient data']

--severity <SEVERITY>

Severity of the alarm, one of: ['low', 'moderate', 'critical']

--enabled {True|False}

True if alarm evaluation/actioning is enabled.

--alarm-action <Webhook URL>

URL to invoke when state transitions to alarm. May be used multiple times. Defaults to None.

--ok-action <Webhook URL>

URL to invoke when state transitions to OK. May be used multiple times. Defaults to None.

--insufficient-data-action <Webhook URL>

URL to invoke when state transitions to insufficient data. May be used multiple times. Defaults to None.

--time-constraint <Time Constraint>

Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.

--repeat-actions {True|False}

True if actions should be repeatedly notified while alarm remains in target state. Defaults to False.

--granularity <GRANULARITY>

Length of each period (seconds) to evaluate over.

--evaluation-periods <COUNT>

Number of periods to evaluate over.

--aggregation-method <AGGREATION>

Aggregation method to use, one of: ['max', 'min', 'avg', 'sum', 'count'].

--comparison-operator <OPERATOR>

Operator to compare with, one of: ['lt', 'le', 'eq', 'ne', 'ge', 'gt'].

--threshold <THRESHOLD>

Threshold to evaluate against.

-m <METRICS>, --metrics <METRICS>

Metric to evaluate against.

--remove-time-constraint <Constraint names>

Name or list of names of the time constraints to remove.

Optional arguments

--name <NAME>

Name of the alarm (must be unique per tenant). Required.

--project-id <ALARM_PROJECT_ID>

Tenant to associate with alarm (only settable by admin users).

--user-id <ALARM_USER_ID>

User to associate with alarm (only settable by admin users).

--description <DESCRIPTION>

Free text description of the alarm.

--state <STATE>

State of the alarm, one of: ['ok', 'alarm', 'insufficient data']

--severity <SEVERITY>

Severity of the alarm, one of: ['low', 'moderate', 'critical']

--enabled {True|False}

True if alarm evaluation/actioning is enabled.

--alarm-action <Webhook URL>

URL to invoke when state transitions to alarm. May be used multiple times. Defaults to None.

--ok-action <Webhook URL>

URL to invoke when state transitions to OK. May be used multiple times. Defaults to None.

--insufficient-data-action <Webhook URL>

URL to invoke when state transitions to insufficient data. May be used multiple times. Defaults to None.

--time-constraint <Time Constraint>

Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.

--repeat-actions {True|False}

True if actions should be repeatedly notified while alarm remains in target state. Defaults to False.

--granularity <GRANULARITY>

Length of each period (seconds) to evaluate over.

--evaluation-periods <COUNT>

Number of periods to evaluate over.

--aggregation-method <AGGREATION>

Aggregation method to use, one of: ['max', 'min', 'avg', 'sum', 'count'].

--comparison-operator <OPERATOR>

Operator to compare with, one of: ['lt', 'le', 'eq', 'ne', 'ge', 'gt'].

--threshold <THRESHOLD>

Threshold to evaluate against. Required.

-m <METRIC>, --metric <METRIC>

Metric to evaluate against. Required.

--resource-type <RESOURCE_TYPE>

Resource_type to evaluate against. Required.

--query <QUERY>

Gnocchi resources search query filter Required.

Positional arguments

<ALARM_ID>

ID of the alarm to update.

Optional arguments

--name <NAME>

Name of the alarm (must be unique per tenant).

--project-id <ALARM_PROJECT_ID>

Tenant to associate with alarm (only settable by admin users).

--user-id <ALARM_USER_ID>

User to associate with alarm (only settable by admin users).

--description <DESCRIPTION>

Free text description of the alarm.

--state <STATE>

State of the alarm, one of: ['ok', 'alarm', 'insufficient data']

--severity <SEVERITY>

Severity of the alarm, one of: ['low', 'moderate', 'critical']

--enabled {True|False}

True if alarm evaluation/actioning is enabled.

--alarm-action <Webhook URL>

URL to invoke when state transitions to alarm. May be used multiple times. Defaults to None.

--ok-action <Webhook URL>

URL to invoke when state transitions to OK. May be used multiple times. Defaults to None.

--insufficient-data-action <Webhook URL>

URL to invoke when state transitions to insufficient data. May be used multiple times. Defaults to None.

--time-constraint <Time Constraint>

Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.

--repeat-actions {True|False}

True if actions should be repeatedly notified while alarm remains in target state. Defaults to False.

--granularity <GRANULARITY>

Length of each period (seconds) to evaluate over.

--evaluation-periods <COUNT>

Number of periods to evaluate over.

--aggregation-method <AGGREATION>

Aggregation method to use, one of: ['max', 'min', 'avg', 'sum', 'count'].

--comparison-operator <OPERATOR>

Operator to compare with, one of: ['lt', 'le', 'eq', 'ne', 'ge', 'gt'].

--threshold <THRESHOLD>

Threshold to evaluate against.

-m <METRIC>, --metric <METRIC>

Metric to evaluate against.

--resource-type <RESOURCE_TYPE>

Resource_type to evaluate against.

--query <QUERY>

Gnocchi resources search query filter

--remove-time-constraint <Constraint names>

Name or list of names of the time constraints to remove.

Optional arguments

--name <NAME>

Name of the alarm (must be unique per tenant). Required.

--project-id <ALARM_PROJECT_ID>

Tenant to associate with alarm (only settable by admin users).

--user-id <ALARM_USER_ID>

User to associate with alarm (only settable by admin users).

--description <DESCRIPTION>

Free text description of the alarm.

--state <STATE>

State of the alarm, one of: ['ok', 'alarm', 'insufficient data']

--severity <SEVERITY>

Severity of the alarm, one of: ['low', 'moderate', 'critical']

--enabled {True|False}

True if alarm evaluation/actioning is enabled.

--alarm-action <Webhook URL>

URL to invoke when state transitions to alarm. May be used multiple times. Defaults to None.

--ok-action <Webhook URL>

URL to invoke when state transitions to OK. May be used multiple times. Defaults to None.

--insufficient-data-action <Webhook URL>

URL to invoke when state transitions to insufficient data. May be used multiple times. Defaults to None.

--time-constraint <Time Constraint>

Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.

--repeat-actions {True|False}

True if actions should be repeatedly notified while alarm remains in target state. Defaults to False.

--granularity <GRANULARITY>

Length of each period (seconds) to evaluate over.

--evaluation-periods <COUNT>

Number of periods to evaluate over.

--aggregation-method <AGGREATION>

Aggregation method to use, one of: ['max', 'min', 'avg', 'sum', 'count'].

--comparison-operator <OPERATOR>

Operator to compare with, one of: ['lt', 'le', 'eq', 'ne', 'ge', 'gt'].

--threshold <THRESHOLD>

Threshold to evaluate against. Required.

-m <METRIC>, --metric <METRIC>

Metric to evaluate against. Required.

--resource-type <RESOURCE_TYPE>

Resource_type to evaluate against. Required.

--resource-id <RESOURCE_ID>

Resource id to evaluate against Required.

Positional arguments

<ALARM_ID>

ID of the alarm to update.

Optional arguments

--name <NAME>

Name of the alarm (must be unique per tenant).

--project-id <ALARM_PROJECT_ID>

Tenant to associate with alarm (only settable by admin users).

--user-id <ALARM_USER_ID>

User to associate with alarm (only settable by admin users).

--description <DESCRIPTION>

Free text description of the alarm.

--state <STATE>

State of the alarm, one of: ['ok', 'alarm', 'insufficient data']

--severity <SEVERITY>

Severity of the alarm, one of: ['low', 'moderate', 'critical']

--enabled {True|False}

True if alarm evaluation/actioning is enabled.

--alarm-action <Webhook URL>

URL to invoke when state transitions to alarm. May be used multiple times. Defaults to None.

--ok-action <Webhook URL>

URL to invoke when state transitions to OK. May be used multiple times. Defaults to None.

--insufficient-data-action <Webhook URL>

URL to invoke when state transitions to insufficient data. May be used multiple times. Defaults to None.

--time-constraint <Time Constraint>

Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.

--repeat-actions {True|False}

True if actions should be repeatedly notified while alarm remains in target state. Defaults to False.

--granularity <GRANULARITY>

Length of each period (seconds) to evaluate over.

--evaluation-periods <COUNT>

Number of periods to evaluate over.

--aggregation-method <AGGREATION>

Aggregation method to use, one of: ['max', 'min', 'avg', 'sum', 'count'].

--comparison-operator <OPERATOR>

Operator to compare with, one of: ['lt', 'le', 'eq', 'ne', 'ge', 'gt'].

--threshold <THRESHOLD>

Threshold to evaluate against.

-m <METRIC>, --metric <METRIC>

Metric to evaluate against.

--resource-type <RESOURCE_TYPE>

Resource_type to evaluate against.

--resource-id <RESOURCE_ID>

Resource id to evaluate against

--remove-time-constraint <Constraint names>

Name or list of names of the time constraints to remove.

Positional arguments

<ALARM_ID>

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.

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.

Positional arguments

<ALARM_ID>

ID of the alarm to show.

Positional arguments

<ALARM_ID>

ID of the alarm state to show.

Positional arguments

<ALARM_ID>

ID of the alarm state to set.

Optional arguments

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

Tenant to associate with alarm (only settable by admin users).

--user-id <ALARM_USER_ID>

User to associate with alarm (only settable by admin users).

--description <DESCRIPTION>

Free text description of the alarm.

--state <STATE>

State of the alarm, one of: ['ok', 'alarm', 'insufficient data']

--severity <SEVERITY>

Severity of the alarm, one of: ['low', 'moderate', 'critical']

--enabled {True|False}

True if alarm evaluation/actioning is enabled.

--alarm-action <Webhook URL>

URL to invoke when state transitions to alarm. May be used multiple times. Defaults to None.

--ok-action <Webhook URL>

URL to invoke when state transitions to OK. May be used multiple times. Defaults to None.

--insufficient-data-action <Webhook URL>

URL to invoke when state transitions to insufficient data. May be used multiple times. Defaults to None.

--time-constraint <Time Constraint>

Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.

--repeat-actions {True|False}

True if actions should be repeatedly notified while alarm remains in target state. Defaults to False.

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

Positional arguments

<ALARM_ID>

ID of the alarm to update.

Optional arguments

--name <NAME>

Name of the alarm (must be unique per tenant).

--project-id <ALARM_PROJECT_ID>

Tenant to associate with alarm (only settable by admin users).

--user-id <ALARM_USER_ID>

User to associate with alarm (only settable by admin users).

--description <DESCRIPTION>

Free text description of the alarm.

--state <STATE>

State of the alarm, one of: ['ok', 'alarm', 'insufficient data']

--severity <SEVERITY>

Severity of the alarm, one of: ['low', 'moderate', 'critical']

--enabled {True|False}

True if alarm evaluation/actioning is enabled.

--alarm-action <Webhook URL>

URL to invoke when state transitions to alarm. May be used multiple times. Defaults to None.

--ok-action <Webhook URL>

URL to invoke when state transitions to OK. May be used multiple times. Defaults to None.

--insufficient-data-action <Webhook URL>

URL to invoke when state transitions to insufficient data. May be used multiple times. Defaults to None.

--time-constraint <Time Constraint>

Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.

--repeat-actions {True|False}

True if actions should be repeatedly notified while alarm remains in target state. Defaults to False.

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

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.

--no-traits

If specified, traits will not be printed.

-l <NUMBER>, --limit <NUMBER>

Maximum number of events to return.

Positional arguments

<message_id>

The ID of the event. Should be a UUID.

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.

-l <NUMBER>, --limit <NUMBER>

Maximum number of meters 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 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.

-l <NUMBER>, --limit <NUMBER>

Maximum number of resources to return.

Positional arguments

<RESOURCE_ID>

ID of the resource to show.

Optional arguments

--project-id <SAMPLE_PROJECT_ID>

Tenant to associate with sample (only settable by admin users).

--user-id <SAMPLE_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.

--direct <DIRECT>

Post sample to storage directly. Defaults to False.

Positional arguments

<SAMPLES_LIST>

Json array with samples to create.

Optional arguments

--direct <DIRECT>

Post samples to storage directly. Defaults to False.

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.

-l <NUMBER>, --limit <NUMBER>

Maximum number of samples to return.

Positional arguments

<SAMPLE_ID>

ID (aka message ID) of the sample to show.

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

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.