openstack/openstack-manuals
Code Issues Proposed changes

[cli-ref] Update python-gnocchiclient to 2.8.2

Browse Source 
Change-Id: I69c18ce2c60d9421335701c9932edb99e4296d06
This commit is contained in:
KATO Tomoyuki 2017-01-18 21:24:59 +09:00
parent 3845de3cca
commit ed1f815eba
1 changed files with 64 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

104
doc/cli-reference/source/gnocchi.rst
View File

@ -10,7 +10,7 @@ The gnocchi client is the command-line interface (CLI) for
the A time series storage and resources index service (gnocchi) API and its the A time series storage and resources index service (gnocchi) API and its
extensions. extensions.
This chapter documents :command:`gnocchi` version ``2.7.0``. This chapter documents :command:`gnocchi` version ``2.8.2``.
For help on a specific :command:`gnocchi` command, enter: For help on a specific :command:`gnocchi` command, enter:
@ -94,9 +94,9 @@ gnocchi archive-policy create
usage: gnocchi archive-policy create [-h] usage: gnocchi archive-policy create [-h]
[-f {html,json,shell,table,value,yaml}] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] -d [--print-empty] [--noindent]
<DEFINITION> [-b BACK_WINDOW] [--prefix PREFIX] -d <DEFINITION>
[-m AGGREGATION_METHODS] [-b BACK_WINDOW] [-m AGGREGATION_METHODS]
name name
Create an archive policy Create an archive policy
@ -152,7 +152,7 @@ gnocchi archive-policy list
usage: gnocchi archive-policy list [-h] [-f {csv,html,json,table,value,yaml}] usage: gnocchi archive-policy list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [-c COLUMN] [--max-width <integer>]
[--noindent] [--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--quote {all,minimal,none,nonnumeric}]
List archive policies List archive policies
@ -172,7 +172,8 @@ gnocchi archive-policy show
usage: gnocchi archive-policy show [-h] usage: gnocchi archive-policy show [-h]
[-f {html,json,shell,table,value,yaml}] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] [--print-empty] [--noindent]
[--prefix PREFIX]
name name
Show an archive policy Show an archive policy
@ -197,8 +198,8 @@ gnocchi archive-policy update
usage: gnocchi archive-policy update [-h] usage: gnocchi archive-policy update [-h]
[-f {html,json,shell,table,value,yaml}] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] -d [--print-empty] [--noindent]
<DEFINITION> [--prefix PREFIX] -d <DEFINITION>
name name
Update an archive policy Update an archive policy
@ -228,7 +229,8 @@ gnocchi archive-policy-rule create
usage: gnocchi archive-policy-rule create [-h] usage: gnocchi archive-policy-rule create [-h]
[-f {html,json,shell,table,value,yaml}] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] -a [--print-empty] [--noindent]
[--prefix PREFIX] -a
ARCHIVE_POLICY_NAME -m ARCHIVE_POLICY_NAME -m
METRIC_PATTERN METRIC_PATTERN
name name
@ -282,7 +284,7 @@ gnocchi archive-policy-rule list
usage: gnocchi archive-policy-rule list [-h] usage: gnocchi archive-policy-rule list [-h]
[-f {csv,html,json,table,value,yaml}] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [-c COLUMN] [--max-width <integer>]
[--noindent] [--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--quote {all,minimal,none,nonnumeric}]
List archive policy rules List archive policy rules
@ -302,7 +304,8 @@ gnocchi archive-policy-rule show
usage: gnocchi archive-policy-rule show [-h] usage: gnocchi archive-policy-rule show [-h]
[-f {html,json,shell,table,value,yaml}] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] [--print-empty] [--noindent]
[--prefix PREFIX]
name name
Show an archive policy rule Show an archive policy rule
@ -327,9 +330,9 @@ gnocchi benchmark measures add
usage: gnocchi benchmark measures add [-h] [--resource-id RESOURCE_ID] usage: gnocchi benchmark measures add [-h] [--resource-id RESOURCE_ID]
[-f {html,json,shell,table,value,yaml}] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] [--print-empty] [--noindent]
[--workers WORKERS] --count COUNT [--prefix PREFIX] [--workers WORKERS]
[--batch BATCH] --count COUNT [--batch BATCH]
[--timestamp-start TIMESTAMP_START] [--timestamp-start TIMESTAMP_START]
[--timestamp-end TIMESTAMP_END] [--wait] [--timestamp-end TIMESTAMP_END] [--wait]
metric metric
@ -377,11 +380,13 @@ gnocchi benchmark measures show
usage: gnocchi benchmark measures show [-h] usage: gnocchi benchmark measures show [-h]
[-f {html,json,shell,table,value,yaml}] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] [--print-empty] [--noindent]
[--prefix PREFIX]
[--resource-id RESOURCE_ID] [--resource-id RESOURCE_ID]
[--aggregation AGGREGATION] [--aggregation AGGREGATION]
[--start START] [--stop STOP] [--start START] [--stop STOP]
[--granularity GRANULARITY] [--refresh] [--granularity GRANULARITY] [--refresh]
[--resample RESAMPLE]
[--workers WORKERS] --count COUNT [--workers WORKERS] --count COUNT
metric metric
@ -410,11 +415,14 @@ Do benchmark testing of measurements show
end of the period end of the period
``--granularity GRANULARITY`` ``--granularity GRANULARITY``
granularity to retrieve (in seconds) granularity to retrieve
``--refresh`` ``--refresh``
force aggregation of all known measures force aggregation of all known measures
``--resample RESAMPLE``
granularity to resample time-series to (in seconds)
``--workers WORKERS, -w WORKERS`` ``--workers WORKERS, -w WORKERS``
Number of workers to use Number of workers to use
@ -431,7 +439,8 @@ gnocchi benchmark metric create
usage: gnocchi benchmark metric create [-h] [--resource-id RESOURCE_ID] usage: gnocchi benchmark metric create [-h] [--resource-id RESOURCE_ID]
[-f {html,json,shell,table,value,yaml}] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] [--print-empty] [--noindent]
[--prefix PREFIX]
[--archive-policy-name ARCHIVE_POLICY_NAME] [--archive-policy-name ARCHIVE_POLICY_NAME]
[--workers WORKERS] --count COUNT [--workers WORKERS] --count COUNT
[--keep] [--keep]
@ -468,8 +477,9 @@ gnocchi benchmark metric show
usage: gnocchi benchmark metric show [-h] [--resource-id RESOURCE_ID] usage: gnocchi benchmark metric show [-h] [--resource-id RESOURCE_ID]
[-f {html,json,shell,table,value,yaml}] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] [--print-empty] [--noindent]
[--workers WORKERS] --count COUNT [--prefix PREFIX] [--workers WORKERS]
--count COUNT
metric [metric ...] metric [metric ...]
Do benchmark testing of metric show Do benchmark testing of metric show
@ -502,7 +512,8 @@ gnocchi capabilities list
usage: gnocchi capabilities list [-h] [-f {html,json,shell,table,value,yaml}] usage: gnocchi capabilities list [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] [--print-empty] [--noindent]
[--prefix PREFIX]
List capabilities List capabilities
@ -566,7 +577,7 @@ gnocchi measures batch-resources-metrics
.. code-block:: console .. code-block:: console
usage: gnocchi measures batch-resources-metrics [-h] file usage: gnocchi measures batch-resources-metrics [-h] [--create-metrics] file
**Positional arguments:** **Positional arguments:**
@ -580,6 +591,9 @@ gnocchi measures batch-resources-metrics
``-h, --help`` ``-h, --help``
show this help message and exit show this help message and exit
``--create-metrics``
Create unknown metrics
.. _gnocchi_measures_show: .. _gnocchi_measures_show:
gnocchi measures show gnocchi measures show
@ -588,12 +602,13 @@ gnocchi measures show
.. code-block:: console .. code-block:: console
usage: gnocchi measures show [-h] [-f {csv,html,json,table,value,yaml}] usage: gnocchi measures show [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent] [-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--quote {all,minimal,none,nonnumeric}]
[--resource-id RESOURCE_ID] [--resource-id RESOURCE_ID]
[--aggregation AGGREGATION] [--start START] [--aggregation AGGREGATION] [--start START]
[--stop STOP] [--granularity GRANULARITY] [--stop STOP] [--granularity GRANULARITY]
[--refresh] [--refresh] [--resample RESAMPLE]
metric metric
Get measurements of a metric Get measurements of a metric
@ -621,11 +636,14 @@ Get measurements of a metric
end of the period end of the period
``--granularity GRANULARITY`` ``--granularity GRANULARITY``
granularity to retrieve (in seconds) granularity to retrieve
``--refresh`` ``--refresh``
force aggregation of all known measures force aggregation of all known measures
``--resample RESAMPLE``
granularity to resample time-series to (in seconds)
.. _gnocchi_metric_create: .. _gnocchi_metric_create:
gnocchi metric create gnocchi metric create
@ -635,8 +653,8 @@ gnocchi metric create
usage: gnocchi metric create [-h] [--resource-id RESOURCE_ID] usage: gnocchi metric create [-h] [--resource-id RESOURCE_ID]
[-f {html,json,shell,table,value,yaml}] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent] [-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--print-empty] [--noindent] [--prefix PREFIX]
[--archive-policy-name ARCHIVE_POLICY_NAME] [--archive-policy-name ARCHIVE_POLICY_NAME]
[--unit UNIT] [--unit UNIT]
[METRIC_NAME] [METRIC_NAME]
@ -695,7 +713,8 @@ gnocchi metric list
.. code-block:: console .. code-block:: console
usage: gnocchi metric list [-h] [-f {csv,html,json,table,value,yaml}] usage: gnocchi metric list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent] [-c COLUMN] [--max-width <integer>] [--print-empty]
[--noindent]
[--quote {all,minimal,none,nonnumeric}] [--quote {all,minimal,none,nonnumeric}]
[--limit <LIMIT>] [--marker <MARKER>] [--limit <LIMIT>] [--marker <MARKER>]
[--sort <SORT>] [--sort <SORT>]
@ -726,8 +745,9 @@ gnocchi metric show
.. code-block:: console .. code-block:: console
usage: gnocchi metric show [-h] [-f {html,json,shell,table,value,yaml}] usage: gnocchi metric show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent] [-c COLUMN] [--max-width <integer>] [--print-empty]
[--prefix PREFIX] [--resource-id RESOURCE_ID] [--noindent] [--prefix PREFIX]
[--resource-id RESOURCE_ID]
metric metric
Show a metric Show a metric
@ -754,7 +774,7 @@ gnocchi resource create
usage: gnocchi resource create [-h] [-f {html,json,shell,table,value,yaml}] usage: gnocchi resource create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] [--print-empty] [--noindent] [--prefix PREFIX]
[--type RESOURCE_TYPE] [-a ATTRIBUTE] [--type RESOURCE_TYPE] [-a ATTRIBUTE]
[-m ADD_METRIC] [-n CREATE_METRIC] [-m ADD_METRIC] [-n CREATE_METRIC]
resource_id resource_id
@ -813,7 +833,7 @@ gnocchi resource history
usage: gnocchi resource history [-h] [-f {csv,html,json,table,value,yaml}] usage: gnocchi resource history [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [-c COLUMN] [--max-width <integer>]
[--noindent] [--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--quote {all,minimal,none,nonnumeric}]
[--details] [--limit <LIMIT>] [--details] [--limit <LIMIT>]
[--marker <MARKER>] [--sort <SORT>] [--marker <MARKER>] [--sort <SORT>]
@ -857,7 +877,8 @@ gnocchi resource list
.. code-block:: console .. code-block:: console
usage: gnocchi resource list [-h] [-f {csv,html,json,table,value,yaml}] usage: gnocchi resource list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent] [-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--quote {all,minimal,none,nonnumeric}]
[--details] [--history] [--limit <LIMIT>] [--details] [--history] [--limit <LIMIT>]
[--marker <MARKER>] [--sort <SORT>] [--marker <MARKER>] [--sort <SORT>]
@ -898,8 +919,9 @@ gnocchi resource show
.. code-block:: console .. code-block:: console
usage: gnocchi resource show [-h] [-f {html,json,shell,table,value,yaml}] usage: gnocchi resource show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent] [-c COLUMN] [--max-width <integer>]
[--prefix PREFIX] [--type RESOURCE_TYPE] [--print-empty] [--noindent] [--prefix PREFIX]
[--type RESOURCE_TYPE]
resource_id resource_id
Show a resource Show a resource
@ -926,7 +948,7 @@ gnocchi resource update
usage: gnocchi resource update [-h] [-f {html,json,shell,table,value,yaml}] usage: gnocchi resource update [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] [--print-empty] [--noindent] [--prefix PREFIX]
[--type RESOURCE_TYPE] [-a ATTRIBUTE] [--type RESOURCE_TYPE] [-a ATTRIBUTE]
[-m ADD_METRIC] [-n CREATE_METRIC] [-m ADD_METRIC] [-n CREATE_METRIC]
[-d DELETE_METRIC] [-d DELETE_METRIC]
@ -969,8 +991,8 @@ gnocchi resource-type create
usage: gnocchi resource-type create [-h] usage: gnocchi resource-type create [-h]
[-f {html,json,shell,table,value,yaml}] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] [--print-empty] [--noindent]
[-a ATTRIBUTE] [--prefix PREFIX] [-a ATTRIBUTE]
name name
Create a resource type Create a resource type
@ -1021,7 +1043,7 @@ gnocchi resource-type list
usage: gnocchi resource-type list [-h] [-f {csv,html,json,table,value,yaml}] usage: gnocchi resource-type list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [-c COLUMN] [--max-width <integer>]
[--noindent] [--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--quote {all,minimal,none,nonnumeric}]
List resource types List resource types
@ -1040,7 +1062,8 @@ gnocchi resource-type show
usage: gnocchi resource-type show [-h] [-f {html,json,shell,table,value,yaml}] usage: gnocchi resource-type show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] [--print-empty] [--noindent]
[--prefix PREFIX]
name name
Show a resource type Show a resource type
@ -1063,7 +1086,8 @@ gnocchi status
.. code-block:: console .. code-block:: console
usage: gnocchi status [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN] usage: gnocchi status [-h] [-f {html,json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--print-empty] [--noindent]
[--prefix PREFIX]
Show the status of measurements processing Show the status of measurements processing