Search

Chapter 19. TDBaaS (Time Series Database as a Service) command-line client

download PDF
The gnocchi client is the command-line interface (CLI) for the A time series storage and resources index service API and its extensions. This chapter documents gnocchi version 2.0.0.
For help on a specific gnocchi command, enter:
$ gnocchi help COMMAND

19.1. gnocchi usage

usage: gnocchi [--version] [-v] [--log-file LOG_FILE] [-q] [-h] [--debug] [--os-region-name <auth-region-name>] [--os-interface <interface>] [--gnocchi-api-version GNOCCHI_API_VERSION] [--insecure] [--os-cacert <ca-certificate>] [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>] [--os-auth-type <name>] [--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 <endpoint>]

19.2. gnocchi optional arguments

--version
show program's version number and exit
-v, --verbose
Increase verbosity of output. Can be repeated.
--log-file LOG_FILE
Specify a file to log output. Disabled by default.
-q, --quiet
Suppress output except warnings and errors.
-h, --help
Show help message and exit.
--debug
Show tracebacks on errors.
--os-region-name <auth-region-name>
Authentication region name (Env: OS_REGION_NAME)
--os-interface <interface>
Select an interface type. Valid interface types: [admin, public, internal]. (Env: OS_INTERFACE)
--gnocchi-api-version GNOCCHI_API_VERSION
Defaults to env[GNOCCHI_API_VERSION] or 1.
--insecure
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.
--os-cacert <ca-certificate>
Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to env[OS_CACERT].
--os-cert <certificate>
Defaults to env[OS_CERT].
--os-key <key>
Defaults to env[OS_KEY].
--timeout <seconds>
Set request timeout (in seconds).
--os-auth-type <name>, --os-auth-plugin <name>
Authentication type to use
--gnocchi-endpoint <endpoint>
Gnocchi endpoint (Env: GNOCCHI_ENDPOINT)

19.3. gnocchi archive-policy create

usage: gnocchi archive-policy create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [-b BACK_WINDOW] [-m AGGREGATION_METHODS] -d <DEFINITION> name
Create an archive policy

Positional arguments

name
name of the archive policy

Optional arguments

-h, --help
show this help message and exit
-b BACK_WINDOW, --back-window BACK_WINDOW
back window of the archive policy
-m AGGREGATION_METHODS, --aggregation-method AGGREGATION_METHODS
aggregation method of the archive policy
-d <DEFINITION>, --definition <DEFINITION>
two attributes (separated by ',') of an archive policy definition with its name and value separated with a ':'

Output formatters

Output formatter options
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
the output format, defaults to table
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>
Maximum display width, 0 to disable

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")
--prefix PREFIX
add a prefix to all variable names

19.4. gnocchi archive-policy delete

usage: gnocchi archive-policy delete [-h] name
Delete an archive policy

Positional arguments

name
Name of the archive policy

Optional arguments

-h, --help
show this help message and exit

19.5. gnocchi archive-policy list

usage: gnocchi archive-policy list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
List archive policies

Optional arguments

-h, --help
show this help message and exit

Output formatters

Output formatter options
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
the output format, defaults to table
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>
Maximum display width, 0 to disable

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}
when to include quotes, defaults to nonnumeric

19.6. gnocchi archive-policy-rule create

usage: gnocchi archive-policy-rule create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] -a ARCHIVE_POLICY_NAME -m METRIC_PATTERN name
Create an archive policy rule

Positional arguments

name
Rule name

Optional arguments

-h, --help
show this help message and exit
-a ARCHIVE_POLICY_NAME, --archive-policy-name ARCHIVE_POLICY_NAME
Archive policy name
-m METRIC_PATTERN, --metric-pattern METRIC_PATTERN
Wildcard of metric name to match

Output formatters

Output formatter options
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
the output format, defaults to table
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>
Maximum display width, 0 to disable

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")
--prefix PREFIX
add a prefix to all variable names

19.7. gnocchi archive-policy-rule delete

usage: gnocchi archive-policy-rule delete [-h] name
Delete an archive policy rule

Positional arguments

name
Name of the archive policy rule

Optional arguments

-h, --help
show this help message and exit

19.8. gnocchi archive-policy-rule list

usage: gnocchi archive-policy-rule list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
List archive policy rules

Optional arguments

-h, --help
show this help message and exit

Output formatters

Output formatter options
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
the output format, defaults to table
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>
Maximum display width, 0 to disable

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}
when to include quotes, defaults to nonnumeric

19.9. gnocchi archive-policy-rule show

usage: gnocchi archive-policy-rule show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] name
Show an archive policy rule

Positional arguments

name
Name of the archive policy rule

Optional arguments

-h, --help
show this help message and exit

Output formatters

Output formatter options
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
the output format, defaults to table
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>
Maximum display width, 0 to disable

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")
--prefix PREFIX
add a prefix to all variable names

19.10. gnocchi archive-policy show

usage: gnocchi archive-policy show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] name
Show an archive policy

Positional arguments

name
Name of the archive policy

Optional arguments

-h, --help
show this help message and exit

Output formatters

Output formatter options
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
the output format, defaults to table
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>
Maximum display width, 0 to disable

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")
--prefix PREFIX
add a prefix to all variable names

19.11. gnocchi benchmark measures add

usage: gnocchi benchmark measures add [-h] [--resource-id RESOURCE_ID] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--workers WORKERS] --count COUNT [--batch BATCH] [--timestamp-start TIMESTAMP_START] [--timestamp-end TIMESTAMP_END] metric
Do benchmark testing of adding measurements

Positional arguments

metric
ID or name of the metric

Optional arguments

-h, --help
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource
--workers WORKERS, -w WORKERS
Number of workers to use
--count COUNT, -n COUNT
Number of total measures to send
--batch BATCH, -b BATCH
Number of measures to send in each batch
--timestamp-start TIMESTAMP_START, -s TIMESTAMP_START
First timestamp to use
--timestamp-end TIMESTAMP_END, -e TIMESTAMP_END
Last timestamp to use

Output formatters

Output formatter options
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
the output format, defaults to table
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>
Maximum display width, 0 to disable

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")
--prefix PREFIX
add a prefix to all variable names

19.12. gnocchi benchmark measures show

usage: gnocchi benchmark measures show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--resource-id RESOURCE_ID] [--aggregation AGGREGATION] [--start START] [--stop STOP] [--workers WORKERS] --count COUNT metric
Do benchmark testing of measurements show

Positional arguments

metric
ID or name of the metric

Optional arguments

-h, --help
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource
--aggregation AGGREGATION
aggregation to retrieve
--start START
beginning of the period
--stop STOP
end of the period
--workers WORKERS, -w WORKERS
Number of workers to use
--count COUNT, -n COUNT
Number of total measures to send

Output formatters

Output formatter options
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
the output format, defaults to table
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>
Maximum display width, 0 to disable

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")
--prefix PREFIX
add a prefix to all variable names

19.13. gnocchi benchmark metric create

usage: gnocchi benchmark metric create [-h] [--resource-id RESOURCE_ID] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--archive-policy-name ARCHIVE_POLICY_NAME] [--workers WORKERS] --count COUNT [--keep]
Do benchmark testing of metric creation

Optional arguments

-h, --help
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource
--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME
name of the archive policy
--workers WORKERS, -w WORKERS
Number of workers to use
--count COUNT, -n COUNT
Number of metrics to create
--keep, -k
Keep created metrics

Output formatters

Output formatter options
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
the output format, defaults to table
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>
Maximum display width, 0 to disable

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")
--prefix PREFIX
add a prefix to all variable names

19.14. gnocchi benchmark metric show

usage: gnocchi benchmark metric show [-h] [--resource-id RESOURCE_ID] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--workers WORKERS] --count COUNT metric [metric ...]
Do benchmark testing of metric show

Positional arguments

metric
ID or name of the metrics

Optional arguments

-h, --help
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource
--workers WORKERS, -w WORKERS
Number of workers to use
--count COUNT, -n COUNT
Number of metrics to get

Output formatters

Output formatter options
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
the output format, defaults to table
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>
Maximum display width, 0 to disable

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")
--prefix PREFIX
add a prefix to all variable names

19.15. gnocchi capabilities list

usage: gnocchi capabilities list [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX]
List capabilities

Optional arguments

-h, --help
show this help message and exit

Output formatters

Output formatter options
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
the output format, defaults to table
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>
Maximum display width, 0 to disable

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")
--prefix PREFIX
add a prefix to all variable names

19.16. gnocchi measures add

usage: gnocchi measures add [-h] [--resource-id RESOURCE_ID] -m MEASURE metric
Add measurements to a metric

Positional arguments

metric
ID or name of the metric

Optional arguments

-h, --help
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource
-m MEASURE, --measure MEASURE
timestamp and value of a measure separated with a '@'

19.17. gnocchi measures aggregation

usage: gnocchi measures aggregation [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] -m METRIC [METRIC ...] [--aggregation AGGREGATION] [--start START] [--stop STOP] [--needed-overlap NEEDED_OVERLAP] [--query QUERY]
Get measurements of aggregated metrics

Optional arguments

-h, --help
show this help message and exit
-m METRIC [METRIC ...], --metric METRIC [METRIC ...]
metrics IDs or metric name
--aggregation AGGREGATION
aggregation to retrieve
--start START
beginning of the period
--stop STOP
end of the period
--needed-overlap NEEDED_OVERLAP
percent of datapoints in each metrics required
--query QUERY
Query

Output formatters

Output formatter options
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
the output format, defaults to table
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>
Maximum display width, 0 to disable

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}
when to include quotes, defaults to nonnumeric

19.18. gnocchi measures show

usage: gnocchi measures show [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--resource-id RESOURCE_ID] [--aggregation AGGREGATION] [--start START] [--stop STOP] metric
Get measurements of a metric

Positional arguments

metric
ID or name of the metric

Optional arguments

-h, --help
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource
--aggregation AGGREGATION
aggregation to retrieve
--start START
beginning of the period
--stop STOP
end of the period

Output formatters

Output formatter options
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
the output format, defaults to table
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>
Maximum display width, 0 to disable

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}
when to include quotes, defaults to nonnumeric

19.19. gnocchi metric create

usage: gnocchi metric create [-h] [--resource-id RESOURCE_ID] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--archive-policy-name ARCHIVE_POLICY_NAME] [METRIC_NAME]
Create a metric

Positional arguments

METRIC_NAME
Name of the metric

Optional arguments

-h, --help
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource
--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME
name of the archive policy

Output formatters

Output formatter options
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
the output format, defaults to table
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>
Maximum display width, 0 to disable

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")
--prefix PREFIX
add a prefix to all variable names

19.20. gnocchi metric delete

usage: gnocchi metric delete [-h] [--resource-id RESOURCE_ID] metric [metric ...]
Delete a metric

Positional arguments

metric
IDs or names of the metric

Optional arguments

-h, --help
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource

19.21. gnocchi metric list

usage: gnocchi metric list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
List metrics

Optional arguments

-h, --help
show this help message and exit

Output formatters

Output formatter options
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
the output format, defaults to table
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>
Maximum display width, 0 to disable

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}
when to include quotes, defaults to nonnumeric

19.22. gnocchi metric show

usage: gnocchi metric show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--resource-id RESOURCE_ID] metric
Show a metric

Positional arguments

metric
ID or name of the metric

Optional arguments

-h, --help
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource

Output formatters

Output formatter options
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
the output format, defaults to table
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>
Maximum display width, 0 to disable

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")
--prefix PREFIX
add a prefix to all variable names

19.23. gnocchi resource create

usage: gnocchi resource create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--type RESOURCE_TYPE] [-a ATTRIBUTE] [-m ADD_METRIC] [-n CREATE_METRIC] [-d DELETE_METRIC] resource_id
Create a resource

Positional arguments

resource_id
ID of the resource

Optional arguments

-h, --help
show this help message and exit
--type RESOURCE_TYPE, -t RESOURCE_TYPE
Type of resource
-a ATTRIBUTE, --attribute ATTRIBUTE
name and value of a attribute separated with a ':'
-m ADD_METRIC, --add-metric ADD_METRIC
name:id of a metric to add
-n CREATE_METRIC, --create-metric CREATE_METRIC
name:archive_policy_name of a metric to create
-d DELETE_METRIC, --delete-metric DELETE_METRIC
Name of a metric to delete

Output formatters

Output formatter options
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
the output format, defaults to table
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>
Maximum display width, 0 to disable

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")
--prefix PREFIX
add a prefix to all variable names

19.24. gnocchi resource delete

usage: gnocchi resource delete [-h] resource_id
Delete a resource

Positional arguments

resource_id
ID of the resource

Optional arguments

-h, --help
show this help message and exit

19.25. gnocchi resource history

usage: gnocchi resource history [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--details] [--limit <LIMIT>] [--marker <MARKER>] [--sort <SORT>] [--type RESOURCE_TYPE] resource_id
Show the history of a resource

Positional arguments

resource_id
ID of a resource

Optional arguments

-h, --help
show this help message and exit
--details
Show all attributes of generic resources
--limit <LIMIT>
Number of resources to return (Default is server default)
--marker <MARKER>
Last item of the previous listing. Return the next results after this value
--sort <SORT>
Sort of resource attribute (example: user_id:desc- nullslast
--type RESOURCE_TYPE, -t RESOURCE_TYPE
Type of resource

Output formatters

Output formatter options
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
the output format, defaults to table
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>
Maximum display width, 0 to disable

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}
when to include quotes, defaults to nonnumeric

19.26. gnocchi resource list

usage: gnocchi resource list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--details] [--history] [--limit <LIMIT>] [--marker <MARKER>] [--sort <SORT>] [--type RESOURCE_TYPE]
List resources

Optional arguments

-h, --help
show this help message and exit
--details
Show all attributes of generic resources
--history
Show history of the resources
--limit <LIMIT>
Number of resources to return (Default is server default)
--marker <MARKER>
Last item of the previous listing. Return the next results after this value
--sort <SORT>
Sort of resource attribute (example: user_id:desc- nullslast
--type RESOURCE_TYPE, -t RESOURCE_TYPE
Type of resource

Output formatters

Output formatter options
-f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
the output format, defaults to table
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>
Maximum display width, 0 to disable

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

--quote {all,minimal,none,nonnumeric}
when to include quotes, defaults to nonnumeric

19.28. gnocchi resource show

usage: gnocchi resource show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--type RESOURCE_TYPE] resource_id
Show a resource

Positional arguments

resource_id
ID of a resource

Optional arguments

-h, --help
show this help message and exit
--type RESOURCE_TYPE, -t RESOURCE_TYPE
Type of resource

Output formatters

Output formatter options
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
the output format, defaults to table
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>
Maximum display width, 0 to disable

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")
--prefix PREFIX
add a prefix to all variable names

19.29. gnocchi resource update

usage: gnocchi resource update [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--type RESOURCE_TYPE] [-a ATTRIBUTE] [-m ADD_METRIC] [-n CREATE_METRIC] [-d DELETE_METRIC] resource_id
Update a resource

Positional arguments

resource_id
ID of the resource

Optional arguments

-h, --help
show this help message and exit
--type RESOURCE_TYPE, -t RESOURCE_TYPE
Type of resource
-a ATTRIBUTE, --attribute ATTRIBUTE
name and value of a attribute separated with a ':'
-m ADD_METRIC, --add-metric ADD_METRIC
name:id of a metric to add
-n CREATE_METRIC, --create-metric CREATE_METRIC
name:archive_policy_name of a metric to create
-d DELETE_METRIC, --delete-metric DELETE_METRIC
Name of a metric to delete

Output formatters

Output formatter options
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
the output format, defaults to table
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>
Maximum display width, 0 to disable

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")
--prefix PREFIX
add a prefix to all variable names

19.30. gnocchi status

usage: gnocchi status [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX]
Show the status of measurements processing

Optional arguments

-h, --help
show this help message and exit

Output formatters

Output formatter options
-f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
the output format, defaults to table
-c COLUMN, --column COLUMN
specify the column(s) to include, can be repeated

table formatter:

--max-width <integer>
Maximum display width, 0 to disable

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

a format a UNIX shell can parse (variable="value")
--prefix PREFIX
add a prefix to all variable names
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.

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.

© 2024 Red Hat, Inc.