6dfd57faf7
Included section 'Metering' in the CLI chapter with some basic commands for listing alarms, meters, statistics etc. Also included the list of commands, optional arguments in the Appendix-Command Reference. Made minor updates according to review comments. Partial-Bug: #1201459 Change-Id: I42b18fea1f8eec2df8d78cb1dd55f4cb03766feb
92 lines
4.5 KiB
XML
92 lines
4.5 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<section xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
|
|
xml:id="ceilometer_client_commands">
|
|
<title>ceilometer commands</title>
|
|
<para>The ceilometer client is the command-line interface for the
|
|
OpenStack Metering API.</para>
|
|
<para>For help on a specific ceilometer command, enter:</para>
|
|
<screen><prompt>$</prompt> <userinput><command>ceilometer</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
|
|
<example>
|
|
<title>Usage</title>
|
|
<screen><computeroutput>ceilometer [--version] [-d] [-v] [-k] [--cert-file CERT_FILE]
|
|
[--key-file KEY_FILE] [--ca-file CA_FILE]
|
|
[--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> ...</computeroutput></screen>
|
|
</example>
|
|
<example>
|
|
<title>Positional arguments</title>
|
|
<screen><computeroutput><subcommand>
|
|
alarm-create Create a new alarm.
|
|
alarm-delete Delete an alarm.
|
|
alarm-list List the user's alarms.
|
|
alarm-show Show an alarm.
|
|
alarm-update Update an existing alarm.
|
|
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 this meters.
|
|
statistics List the statistics for this meter.
|
|
help Display help about this program or one of its
|
|
subcommands.</computeroutput></screen>
|
|
</example>
|
|
|
|
<example>
|
|
<title>Optional arguments</title>
|
|
<screen><computeroutput> -d, --debug Defaults to env[HEATCLIENT_DEBUG]
|
|
--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.
|
|
--ca-file CA_FILE Path of CA SSL certificate(s) used to verify the
|
|
remote server certificate. Without this option
|
|
ceilometer looks for the default system CA
|
|
certificates.
|
|
--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]</computeroutput></screen>
|
|
</example>
|
|
</section>
|