openstack/openstack-manuals
Code Issues Proposed changes
9b1e62e9cd
openstack-manuals/doc/cli-reference/generated/ch_cli_gnocchi_commands.xml
Atsushi SAKAI 478428b28f Add gnocchi to common and CLI reference 
Add gnocchi to Chapter 1
   (for CLI Ref)
Add gnocchi to Appendix
   (common part includes CLI Ref/Config Ref)
Add gnocchi CLI Ref XML 2.0.0 (autogenerated)

Ref
Gnocchi  Ceilometer API v3
https://specs.openstack.org/openstack/ceilometer-specs/specs/juno/gnocchi.html

P.S.
some comments are missing periods in autogenerated file.
I post it to gnocchiclient separately.

Change-Id: I548bbadee2c42b3d23d1a5be6403cba6f2a88079
2015-11-11 10:18:58 +09:00

1572 lines
48 KiB
XML
Raw Blame History

<?xml version="1.0" encoding="UTF-8"?>
<chapter 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="gnocchiclient_commands">
<!-- This file is automatically generated, do not edit -->
<?dbhtml stop-chunking?>
<title>A time series storage and resources index service command-line client</title>
<para>The <command>gnocchi</command> client is the command-line
interface (CLI) for the A time series storage and resources index service API and its extensions.
This chapter documents <command>gnocchi</command> version
<literal>2.0.0</literal>.
</para>
<para>For help on a specific <command>gnocchi</command>
command, enter:
</para>
<screen><prompt>$</prompt> <userinput><command>gnocchi</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
<section xml:id="gnocchiclient_command_usage">
<title>gnocchi usage</title>
<screen><computeroutput>usage: gnocchi [--version] [-v] [--log-file LOG_FILE] [-q] [-h] [--debug]
[--os-region-name &lt;auth-region-name&gt;]
[--os-interface &lt;interface&gt;]
[--gnocchi-api-version GNOCCHI_API_VERSION] [--insecure]
[--os-cacert &lt;ca-certificate&gt;] [--os-cert &lt;certificate&gt;]
[--os-key &lt;key&gt;] [--timeout &lt;seconds&gt;] [--os-auth-type &lt;name&gt;]
[--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID]
[--os-domain-name OS_DOMAIN_NAME]
[--os-project-id OS_PROJECT_ID]
[--os-project-name OS_PROJECT_NAME]
[--os-project-domain-id OS_PROJECT_DOMAIN_ID]
[--os-project-domain-name OS_PROJECT_DOMAIN_NAME]
[--os-trust-id OS_TRUST_ID] [--os-user-id OS_USER_ID]
[--os-user-name OS_USERNAME]
[--os-user-domain-id OS_USER_DOMAIN_ID]
[--os-user-domain-name OS_USER_DOMAIN_NAME]
[--os-password OS_PASSWORD] [--gnocchi-endpoint &lt;endpoint&gt;]</computeroutput></screen>
</section>
<section xml:id="gnocchiclient_command_optional">
<title>gnocchi optional arguments</title>
<variablelist wordsize="10">
<varlistentry>
<term><command>--version</command></term>
<listitem>
<para>
show program's version number and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-v, --verbose</command></term>
<listitem>
<para>
Increase verbosity of output. Can be repeated.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--log-file LOG_FILE</command></term>
<listitem>
<para>
Specify a file to log output. Disabled by default.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-q, --quiet</command></term>
<listitem>
<para>
suppress output except warnings and errors
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--debug</command></term>
<listitem>
<para>
show tracebacks on errors
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-region-name &lt;auth-region-name&gt;</command></term>
<listitem>
<para>
Authentication region name (Env: OS_REGION_NAME)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-interface &lt;interface&gt;</command></term>
<listitem>
<para>
Select an interface type. Valid interface types:
[admin, public, internal]. (Env: OS_INTERFACE)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--gnocchi-api-version GNOCCHI_API_VERSION</command></term>
<listitem>
<para>
Defaults to <code>env[GNOCCHI_API_VERSION]</code> or 1.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--insecure</command></term>
<listitem>
<para>
Explicitly allow client to perform "insecure" TLS
(https) requests. The server's certificate will not be
verified against any certificate authorities. This
option should be used with caution.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-cacert &lt;ca-certificate&gt;</command></term>
<listitem>
<para>
Specify a CA bundle file to use in verifying a TLS
(https) server certificate. Defaults to
<code>env[OS_CACERT]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-cert &lt;certificate&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_CERT]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-key &lt;key&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_KEY]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--timeout &lt;seconds&gt;</command></term>
<listitem>
<para>
Set request timeout (in seconds).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-auth-type &lt;name&gt;, --os-auth-plugin &lt;name&gt;</command></term>
<listitem>
<para>
Authentication type to use
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--gnocchi-endpoint &lt;endpoint&gt;</command></term>
<listitem>
<para>
Gnocchi endpoint (Env: GNOCCHI_ENDPOINT)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_archive-policy">
<title>gnocchi archive-policy</title>
<screen><computeroutput>Command "archive-policy" matches:
archive-policy create
archive-policy delete
archive-policy list
archive-policy show
archive-policy-rule create
archive-policy-rule delete
archive-policy-rule list
archive-policy-rule show</computeroutput></screen>
<para>
</para>
</section>
<section xml:id="gnocchiclient_subcommand_archive-policy_create">
<title>gnocchi archive-policy create</title>
<screen><computeroutput>usage: gnocchi archive-policy create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--prefix PREFIX] [-b BACK_WINDOW]
[-m AGGREGATION_METHODS] -d &lt;DEFINITION&gt;
name</computeroutput></screen>
<para>
Create an archive policy
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>name</command></term>
<listitem>
<para>
name of the archive policy
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-b BACK_WINDOW, --back-window BACK_WINDOW</command></term>
<listitem>
<para>
back window of the archive policy
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-m AGGREGATION_METHODS, --aggregation-method AGGREGATION_METHODS</command></term>
<listitem>
<para>
aggregation method of the archive policy
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-d &lt;DEFINITION&gt;, --definition &lt;DEFINITION&gt;</command></term>
<listitem>
<para>
two attributes (separated by ',') of an archive policy
definition with its name and value separated with a
':'
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_archive-policy_delete">
<title>gnocchi archive-policy delete</title>
<screen><computeroutput>usage: gnocchi archive-policy delete [-h] name</computeroutput></screen>
<para>
Delete an archive policy
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>name</command></term>
<listitem>
<para>
Name of the archive policy
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_archive-policy_list">
<title>gnocchi archive-policy list</title>
<screen><computeroutput>usage: gnocchi archive-policy list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
<para>
List archive policies
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_archive-policy_show">
<title>gnocchi archive-policy show</title>
<screen><computeroutput>usage: gnocchi archive-policy show [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--prefix PREFIX]
name</computeroutput></screen>
<para>
Show an archive policy
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>name</command></term>
<listitem>
<para>
Name of the archive policy
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_archive-policy-rule">
<title>gnocchi archive-policy-rule</title>
<screen><computeroutput>Command "archive-policy-rule" matches:
archive-policy-rule create
archive-policy-rule delete
archive-policy-rule list
archive-policy-rule show</computeroutput></screen>
<para>
</para>
</section>
<section xml:id="gnocchiclient_subcommand_archive-policy-rule_create">
<title>gnocchi archive-policy-rule create</title>
<screen><computeroutput>usage: gnocchi archive-policy-rule create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--prefix PREFIX] -a
ARCHIVE_POLICY_NAME -m
METRIC_PATTERN
name</computeroutput></screen>
<para>
Create an archive policy rule
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>name</command></term>
<listitem>
<para>
Rule name
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-a ARCHIVE_POLICY_NAME, --archive-policy-name ARCHIVE_POLICY_NAME</command></term>
<listitem>
<para>
Archive policy name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-m METRIC_PATTERN, --metric-pattern METRIC_PATTERN</command></term>
<listitem>
<para>
Wildcard of metric name to match
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_archive-policy-rule_delete">
<title>gnocchi archive-policy-rule delete</title>
<screen><computeroutput>usage: gnocchi archive-policy-rule delete [-h] name</computeroutput></screen>
<para>
Delete an archive policy rule
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>name</command></term>
<listitem>
<para>
Name of the archive policy rule
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_archive-policy-rule_list">
<title>gnocchi archive-policy-rule list</title>
<screen><computeroutput>usage: gnocchi archive-policy-rule list [-h]
[-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
<para>
List archive policy rules
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_archive-policy-rule_show">
<title>gnocchi archive-policy-rule show</title>
<screen><computeroutput>usage: gnocchi archive-policy-rule show [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--prefix PREFIX]
name</computeroutput></screen>
<para>
Show an archive policy rule
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>name</command></term>
<listitem>
<para>
Name of the archive policy rule
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_benchmark_measures_add">
<title>gnocchi benchmark measures add</title>
<screen><computeroutput>usage: gnocchi benchmark measures add [-h] [--resource-id RESOURCE_ID]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--prefix PREFIX] [--workers WORKERS]
--count COUNT [--batch BATCH]
[--timestamp-start TIMESTAMP_START]
[--timestamp-end TIMESTAMP_END]
metric</computeroutput></screen>
<para>
Do benchmark testing of adding measurements
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>metric</command></term>
<listitem>
<para>
ID or name of the metric
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--resource-id RESOURCE_ID, -r RESOURCE_ID</command></term>
<listitem>
<para>
ID of the resource
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--workers WORKERS, -w WORKERS</command></term>
<listitem>
<para>
Number of workers to use
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--count COUNT, -n COUNT</command></term>
<listitem>
<para>
Number of total measures to send
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--batch BATCH, -b BATCH</command></term>
<listitem>
<para>
Number of measures to send in each batch
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--timestamp-start TIMESTAMP_START, -s TIMESTAMP_START</command></term>
<listitem>
<para>
First timestamp to use
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--timestamp-end TIMESTAMP_END, -e TIMESTAMP_END</command></term>
<listitem>
<para>
Last timestamp to use
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_benchmark_measures_show">
<title>gnocchi benchmark measures show</title>
<screen><computeroutput>usage: gnocchi benchmark measures show [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--prefix PREFIX]
[--resource-id RESOURCE_ID]
[--aggregation AGGREGATION]
[--start START] [--stop STOP]
[--workers WORKERS] --count COUNT
metric</computeroutput></screen>
<para>
Do benchmark testing of measurements show
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>metric</command></term>
<listitem>
<para>
ID or name of the metric
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--resource-id RESOURCE_ID, -r RESOURCE_ID</command></term>
<listitem>
<para>
ID of the resource
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--aggregation AGGREGATION</command></term>
<listitem>
<para>
aggregation to retrieve
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--start START</command></term>
<listitem>
<para>
beginning of the period
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--stop STOP</command></term>
<listitem>
<para>
end of the period
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--workers WORKERS, -w WORKERS</command></term>
<listitem>
<para>
Number of workers to use
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--count COUNT, -n COUNT</command></term>
<listitem>
<para>
Number of total measures to send
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_benchmark_metric_create">
<title>gnocchi benchmark metric create</title>
<screen><computeroutput>usage: gnocchi benchmark metric create [-h] [--resource-id RESOURCE_ID]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--prefix PREFIX]
[--archive-policy-name ARCHIVE_POLICY_NAME]
[--workers WORKERS] --count COUNT
[--keep]</computeroutput></screen>
<para>
Do benchmark testing of metric creation
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--resource-id RESOURCE_ID, -r RESOURCE_ID</command></term>
<listitem>
<para>
ID of the resource
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME</command></term>
<listitem>
<para>
name of the archive policy
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--workers WORKERS, -w WORKERS</command></term>
<listitem>
<para>
Number of workers to use
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--count COUNT, -n COUNT</command></term>
<listitem>
<para>
Number of metrics to create
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--keep, -k</command></term>
<listitem>
<para>
Keep created metrics
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_benchmark_metric_show">
<title>gnocchi benchmark metric show</title>
<screen><computeroutput>usage: gnocchi benchmark metric show [-h] [--resource-id RESOURCE_ID]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--prefix PREFIX] [--workers WORKERS]
--count COUNT
metric [metric ...]</computeroutput></screen>
<para>
Do benchmark testing of metric show
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>metric</command></term>
<listitem>
<para>
ID or name of the metrics
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--resource-id RESOURCE_ID, -r RESOURCE_ID</command></term>
<listitem>
<para>
ID of the resource
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--workers WORKERS, -w WORKERS</command></term>
<listitem>
<para>
Number of workers to use
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--count COUNT, -n COUNT</command></term>
<listitem>
<para>
Number of metrics to get
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_capabilities_list">
<title>gnocchi capabilities list</title>
<screen><computeroutput>usage: gnocchi capabilities list [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--prefix PREFIX]</computeroutput></screen>
<para>
List capabilities
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_measures_add">
<title>gnocchi measures add</title>
<screen><computeroutput>usage: gnocchi measures add [-h] [--resource-id RESOURCE_ID] -m MEASURE metric</computeroutput></screen>
<para>
Add measurements to a metric
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>metric</command></term>
<listitem>
<para>
ID or name of the metric
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--resource-id RESOURCE_ID, -r RESOURCE_ID</command></term>
<listitem>
<para>
ID of the resource
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-m MEASURE, --measure MEASURE</command></term>
<listitem>
<para>
timestamp and value of a measure separated with a '@'
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_measures_aggregation">
<title>gnocchi measures aggregation</title>
<screen><computeroutput>usage: gnocchi measures aggregation [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}] -m
METRIC [METRIC ...]
[--aggregation AGGREGATION]
[--start START] [--stop STOP]
[--needed-overlap NEEDED_OVERLAP]
[--query QUERY]</computeroutput></screen>
<para>
Get measurements of aggregated metrics
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-m METRIC [METRIC ...], --metric METRIC [METRIC ...]</command></term>
<listitem>
<para>
metrics IDs or metric name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--aggregation AGGREGATION</command></term>
<listitem>
<para>
aggregation to retrieve
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--start START</command></term>
<listitem>
<para>
beginning of the period
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--stop STOP</command></term>
<listitem>
<para>
end of the period
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--needed-overlap NEEDED_OVERLAP</command></term>
<listitem>
<para>
percent of datapoints in each metrics required
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--query QUERY</command></term>
<listitem>
<para>
Query
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_measures_show">
<title>gnocchi measures show</title>
<screen><computeroutput>usage: gnocchi measures show [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]
[--resource-id RESOURCE_ID]
[--aggregation AGGREGATION] [--start START]
[--stop STOP]
metric</computeroutput></screen>
<para>
Get measurements of a metric
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>metric</command></term>
<listitem>
<para>
ID or name of the metric
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--resource-id RESOURCE_ID, -r RESOURCE_ID</command></term>
<listitem>
<para>
ID of the resource
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--aggregation AGGREGATION</command></term>
<listitem>
<para>
aggregation to retrieve
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--start START</command></term>
<listitem>
<para>
beginning of the period
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--stop STOP</command></term>
<listitem>
<para>
end of the period
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_metric_create">
<title>gnocchi metric create</title>
<screen><computeroutput>usage: gnocchi metric create [-h] [--resource-id RESOURCE_ID]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--prefix PREFIX]
[--archive-policy-name ARCHIVE_POLICY_NAME]
[METRIC_NAME]</computeroutput></screen>
<para>
Create a metric
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>METRIC_NAME</command></term>
<listitem>
<para>
Name of the metric
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--resource-id RESOURCE_ID, -r RESOURCE_ID</command></term>
<listitem>
<para>
ID of the resource
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME</command></term>
<listitem>
<para>
name of the archive policy
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_metric_delete">
<title>gnocchi metric delete</title>
<screen><computeroutput>usage: gnocchi metric delete [-h] [--resource-id RESOURCE_ID]
metric [metric ...]</computeroutput></screen>
<para>
Delete a metric
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>metric</command></term>
<listitem>
<para>
IDs or names of the metric
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--resource-id RESOURCE_ID, -r RESOURCE_ID</command></term>
<listitem>
<para>
ID of the resource
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_metric_list">
<title>gnocchi metric list</title>
<screen><computeroutput>usage: gnocchi metric list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
<para>
List metrics
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_metric_show">
<title>gnocchi metric show</title>
<screen><computeroutput>usage: gnocchi metric show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--prefix PREFIX] [--resource-id RESOURCE_ID]
metric</computeroutput></screen>
<para>
Show a metric
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>metric</command></term>
<listitem>
<para>
ID or name of the metric
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--resource-id RESOURCE_ID, -r RESOURCE_ID</command></term>
<listitem>
<para>
ID of the resource
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_resource_create">
<title>gnocchi resource create</title>
<screen><computeroutput>usage: gnocchi resource create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--prefix PREFIX] [--type RESOURCE_TYPE]
[-a ATTRIBUTE] [-m ADD_METRIC]
[-n CREATE_METRIC] [-d DELETE_METRIC]
resource_id</computeroutput></screen>
<para>
Create a resource
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>resource_id</command></term>
<listitem>
<para>
ID of the resource
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--type RESOURCE_TYPE, -t RESOURCE_TYPE</command></term>
<listitem>
<para>
Type of resource
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-a ATTRIBUTE, --attribute ATTRIBUTE</command></term>
<listitem>
<para>
name and value of a attribute separated with a ':'
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-m ADD_METRIC, --add-metric ADD_METRIC</command></term>
<listitem>
<para>
name:id of a metric to add
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-n CREATE_METRIC, --create-metric CREATE_METRIC</command></term>
<listitem>
<para>
name:archive_policy_name of a metric to create
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-d DELETE_METRIC, --delete-metric DELETE_METRIC</command></term>
<listitem>
<para>
Name of a metric to delete
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_resource_delete">
<title>gnocchi resource delete</title>
<screen><computeroutput>usage: gnocchi resource delete [-h] resource_id</computeroutput></screen>
<para>
Delete a resource
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>resource_id</command></term>
<listitem>
<para>
ID of the resource
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_resource_history">
<title>gnocchi resource history</title>
<screen><computeroutput>usage: gnocchi resource history [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]
[--details] [--limit &lt;LIMIT&gt;]
[--marker &lt;MARKER&gt;] [--sort &lt;SORT&gt;]
[--type RESOURCE_TYPE]
resource_id</computeroutput></screen>
<para>
Show the history of a resource
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>resource_id</command></term>
<listitem>
<para>
ID of a resource
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--details</command></term>
<listitem>
<para>
Show all attributes of generic resources
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--limit &lt;LIMIT&gt;</command></term>
<listitem>
<para>
Number of resources to return (Default is server
default)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--marker &lt;MARKER&gt;</command></term>
<listitem>
<para>
Last item of the previous listing. Return the next
results after this value
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--sort &lt;SORT&gt;</command></term>
<listitem>
<para>
Sort of resource attribute (example: user_id:desc-
nullslast
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--type RESOURCE_TYPE, -t RESOURCE_TYPE</command></term>
<listitem>
<para>
Type of resource
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_resource_list">
<title>gnocchi resource list</title>
<screen><computeroutput>usage: gnocchi resource list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]
[--details] [--history] [--limit &lt;LIMIT&gt;]
[--marker &lt;MARKER&gt;] [--sort &lt;SORT&gt;]
[--type RESOURCE_TYPE]</computeroutput></screen>
<para>
List resources
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--details</command></term>
<listitem>
<para>
Show all attributes of generic resources
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--history</command></term>
<listitem>
<para>
Show history of the resources
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--limit &lt;LIMIT&gt;</command></term>
<listitem>
<para>
Number of resources to return (Default is server
default)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--marker &lt;MARKER&gt;</command></term>
<listitem>
<para>
Last item of the previous listing. Return the next
results after this value
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--sort &lt;SORT&gt;</command></term>
<listitem>
<para>
Sort of resource attribute (example: user_id:desc-
nullslast
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--type RESOURCE_TYPE, -t RESOURCE_TYPE</command></term>
<listitem>
<para>
Type of resource
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_resource_search">
<title>gnocchi resource search</title>
<screen><computeroutput>usage: gnocchi resource search [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]
[--details] [--history] [--limit &lt;LIMIT&gt;]
[--marker &lt;MARKER&gt;] [--sort &lt;SORT&gt;]
[--type RESOURCE_TYPE] [--query QUERY]</computeroutput></screen>
<para>
Search resources with specified query rules
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--details</command></term>
<listitem>
<para>
Show all attributes of generic resources
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--history</command></term>
<listitem>
<para>
Show history of the resources
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--limit &lt;LIMIT&gt;</command></term>
<listitem>
<para>
Number of resources to return (Default is server
default)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--marker &lt;MARKER&gt;</command></term>
<listitem>
<para>
Last item of the previous listing. Return the next
results after this value
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--sort &lt;SORT&gt;</command></term>
<listitem>
<para>
Sort of resource attribute (example: user_id:desc-
nullslast
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--type RESOURCE_TYPE, -t RESOURCE_TYPE</command></term>
<listitem>
<para>
Type of resource
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--query QUERY</command></term>
<listitem>
<para>
Query
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_resource_show">
<title>gnocchi resource show</title>
<screen><computeroutput>usage: gnocchi resource show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--prefix PREFIX] [--type RESOURCE_TYPE]
resource_id</computeroutput></screen>
<para>
Show a resource
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>resource_id</command></term>
<listitem>
<para>
ID of a resource
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--type RESOURCE_TYPE, -t RESOURCE_TYPE</command></term>
<listitem>
<para>
Type of resource
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_resource_update">
<title>gnocchi resource update</title>
<screen><computeroutput>usage: gnocchi resource update [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--prefix PREFIX] [--type RESOURCE_TYPE]
[-a ATTRIBUTE] [-m ADD_METRIC]
[-n CREATE_METRIC] [-d DELETE_METRIC]
resource_id</computeroutput></screen>
<para>
Update a resource
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>resource_id</command></term>
<listitem>
<para>
ID of the resource
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--type RESOURCE_TYPE, -t RESOURCE_TYPE</command></term>
<listitem>
<para>
Type of resource
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-a ATTRIBUTE, --attribute ATTRIBUTE</command></term>
<listitem>
<para>
name and value of a attribute separated with a ':'
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-m ADD_METRIC, --add-metric ADD_METRIC</command></term>
<listitem>
<para>
name:id of a metric to add
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-n CREATE_METRIC, --create-metric CREATE_METRIC</command></term>
<listitem>
<para>
name:archive_policy_name of a metric to create
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-d DELETE_METRIC, --delete-metric DELETE_METRIC</command></term>
<listitem>
<para>
Name of a metric to delete
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="gnocchiclient_subcommand_status">
<title>gnocchi status</title>
<screen><computeroutput>usage: gnocchi status [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--prefix PREFIX]</computeroutput></screen>
<para>
Show the status of measurements processing
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</chapter>
View Git Blame Copy Permalink