Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 11. Telemetry Service Command-line Client

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

11.1. ceilometer Usage
Copy link

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-project-domain-id <project-domain-id>]
                  [--os-project-domain-name <project-domain-name>]
                  [--os-user-id <user-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> ...
Copy to Clipboard Toggle word wrap

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.

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2026 Red Hat