diff --git a/doc/cli-ref-rst/source/ceilometer.rst b/doc/cli-ref-rst/source/ceilometer.rst new file mode 100644 index 0000000000..5f18291b75 --- /dev/null +++ b/doc/cli-ref-rst/source/ceilometer.rst @@ -0,0 +1,2217 @@ +.. ## WARNING ###################################### +.. This file is automatically generated, do not edit +.. ################################################# + +===================================== +Telemetry service command-line client +===================================== + +The ceilometer client is the command-line interface (CLI) for +the Telemetry service API and its extensions. + +This chapter documents :command:`ceilometer` version ``2.1.0``. + +For help on a specific :command:`ceilometer` command, enter: + +.. code-block:: console + + $ ceilometer help COMMAND + +.. _ceilometer_command_usage: + +ceilometer usage +~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: ceilometer [--version] [-d] [-v] [--timeout TIMEOUT] + [--ceilometer-url ] + [--ceilometer-api-version CEILOMETER_API_VERSION] + [--os-tenant-id ] + [--os-region-name ] + [--os-auth-token ] + [--os-service-type ] + [--os-endpoint-type ] [--os-cacert ] + [--os-insecure ] [--os-cert-file ] + [--os-key-file ] [--os-cert ] + [--os-key ] [--os-project-name ] + [--os-project-id ] + [--os-project-domain-id ] + [--os-project-domain-name ] + [--os-user-id ] + [--os-user-domain-id ] + [--os-user-domain-name ] + [--os-endpoint ] [--os-auth-system ] + [--os-username ] [--os-password ] + [--os-tenant-name ] [--os-token ] + [--os-auth-url ] + ... + +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/:option:`--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 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. + +.. _ceilometer_command_options: + +ceilometer optional arguments +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +``--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 `` + **DEPRECATED**, use :option:`--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 `` + Defaults to ``env[OS_TENANT_ID]``. + +``--os-region-name `` + Defaults to ``env[OS_REGION_NAME]``. + +``--os-auth-token `` + Defaults to ``env[OS_AUTH_TOKEN]``. + +``--os-service-type `` + Defaults to ``env[OS_SERVICE_TYPE]``. + +``--os-endpoint-type `` + Defaults to ``env[OS_ENDPOINT_TYPE]``. + +``--os-cacert `` + Defaults to ``env[OS_CACERT]``. + +``--os-insecure `` + Defaults to ``env[OS_INSECURE]``. + +``--os-cert-file `` + Defaults to ``env[OS_CERT_FILE]``. + +``--os-key-file `` + Defaults to ``env[OS_KEY_FILE]``. + +``--os-cert `` + Defaults to ``env[OS_CERT]``. + +``--os-key `` + Defaults to ``env[OS_KEY]``. + +``--os-project-name `` + Defaults to ``env[OS_PROJECT_NAME]``. + +``--os-project-id `` + Defaults to ``env[OS_PROJECT_ID]``. + +``--os-project-domain-id `` + Defaults to ``env[OS_PROJECT_DOMAIN_ID]``. + +``--os-project-domain-name `` + Defaults to ``env[OS_PROJECT_DOMAIN_NAME]``. + +``--os-user-id `` + Defaults to ``env[OS_USER_ID]``. + +``--os-user-domain-id `` + Defaults to ``env[OS_USER_DOMAIN_ID]``. + +``--os-user-domain-name `` + Defaults to ``env[OS_USER_DOMAIN_NAME]``. + +``--os-endpoint `` + Defaults to ``env[OS_ENDPOINT]``. + +``--os-auth-system `` + Defaults to ``env[OS_AUTH_SYSTEM]``. + +``--os-username `` + Defaults to ``env[OS_USERNAME]``. + +``--os-password `` + Defaults to ``env[OS_PASSWORD]``. + +``--os-tenant-name `` + Defaults to ``env[OS_TENANT_NAME]``. + +``--os-token `` + Defaults to ``env[OS_TOKEN]``. + +``--os-auth-url `` + Defaults to ``env[OS_AUTH_URL]``. + +.. _ceilometer_alarm-combination-create: + +ceilometer alarm-combination-create +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + usage: ceilometer alarm-combination-create --name + [--project-id ] + [--user-id ] + [--description ] + [--state ] + [--severity ] + [--enabled {True|False}] + [--alarm-action ] + [--ok-action ] + [--insufficient-data-action ] + [--time-constraint