The gnocchi shell utility¶
The gnocchi shell utility interacts with Gnocchi from the command line. It supports the entirety of the Gnocchi API.
Authentication method¶
You’ll need to provide the authentication method and your credentials to gnocchi.
Basic authentication¶
If you’re using Gnocchi with basic authentication, export the following variables in your environment:
export OS_AUTH_TYPE=gnocchi-basic
export GNOCCHI_USER=<youruserid>
export GNOCCHI_ENDPOINT=http://urlofgnocchi
Note
OS_AUTH_TYPE is used globally by all clients supporting Keystone. Provide
--os-auth-plugin
gnocchi-basic to the client instead if other
clients are used in session.
OpenStack Keystone authentication¶
If you’re using Gnocchi with Keystone authentication, export the following variables in your environment with the appropriate values:
export OS_AUTH_TYPE=password
export OS_USERNAME=user
export OS_PASSWORD=pass
export OS_TENANT_NAME=myproject
export OS_AUTH_URL=http://auth.example.com:5000/v2.0
The command line tool will attempt to reauthenticate using your provided
credentials for every request. You can override this behavior by manually
supplying an auth token using --endpoint
and
--os-auth-token
. You can alternatively set these environment
variables:
export GNOCCHI_ENDPOINT=http://gnocchi.example.org:8041
export OS_AUTH_PLUGIN=token
export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155
For more details, check the keystoneauth documentation.
Timestamps¶
By default, timestamps are displayed in local time zone. If you prefer to see timestamps dispalyed in UTC time zones, you can pass the –utc option to the command.
The gnocchi command line interface parses timestamps in the ISO8601 format. If no time zone is specified, timestamps are assumed to be in the local client time zone.
Commands descriptions¶
For help on a specific gnocchi command, enter:
$ gnocchi help COMMAND
gnocchi usage¶
usage: gnocchi-real [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
[--gnocchi-api-version GNOCCHI_API_VERSION] [--insecure]
[--os-cacert <ca-certificate>] [--os-cert <certificate>]
[--os-key <key>] [--timeout <seconds>]
[--os-auth-type <name>] [--user <gnocchi user>]
[--endpoint <gnocchi endpoint>]
gnocchi optional arguments¶
--version
- show program’s version number and exit
-v, --verbose
- Increase verbosity of output. Can be repeated.
-q, --quiet
- Suppress output except warnings and errors.
--log-file LOG_FILE
- Specify a file to log output. Disabled by default.
-h, --help
- Show help message and exit.
--debug
- Show tracebacks on errors.
--gnocchi-api-version GNOCCHI_API_VERSION
- Defaults to
env[GNOCCHI_API_VERSION]
or 1. --os-auth-type <name>, --os-auth-plugin <name>
- Authentication type to use
gnocchi aggregates¶
usage: gnocchi-real aggregates [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--sort-column SORT_COLUMN]
[--resource-type RESOURCE_TYPE] [--start START]
[--stop STOP] [--granularity GRANULARITY]
[--needed-overlap NEEDED_OVERLAP]
[--groupby GROUPBY] [--fill FILL]
operations [search]
Get measurements of aggregated metrics
Positional arguments:
operations
- Operations to apply to time series
search
- A query to filter resource. The syntax is a combination of attribute, operator and value. For example: id=90d58eea-70d7-4294-a49a-170dcdf44c3c would filter resource with a certain id. More complex queries can be built, e.g.: not (flavor_id!=”1” and memory>=24). Use “” to force data to be interpreted as string. Supported operators are: not, and, ∧ or, ∨, >=, <=, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in, like, ≠, ≥, ≤, like, in.
Optional arguments:
-h, --help
- show this help message and exit
--resource-type RESOURCE_TYPE
- Resource type to query
--start START
- beginning of the period
--stop STOP
- end of the period
--granularity GRANULARITY
- granularity to retrieve
--needed-overlap NEEDED_OVERLAP
- percentage of overlap across datapoints
--groupby GROUPBY
- Attribute to use to group resources
--fill FILL
- Value to use when backfilling timestamps with missing values in a subset of series. Value should be a float or ‘null’.
gnocchi archive-policy create¶
usage: gnocchi-real archive-policy create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty]
[--noindent] [--prefix PREFIX] -d
<DEFINITION> [-b BACK_WINDOW]
[-m AGGREGATION_METHODS]
name
Create an archive policy
Positional arguments:
name
- name of the archive policy
Optional arguments:
-h, --help
- show this help message and exit
-d <DEFINITION>, --definition <DEFINITION>
- two attributes (separated by ‘,’) of an archive policy definition with its name and value separated with a ‘:’
-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
gnocchi archive-policy delete¶
usage: gnocchi-real 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
gnocchi archive-policy list¶
usage: gnocchi-real archive-policy list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--sort-column SORT_COLUMN]
List archive policies
Optional arguments:
-h, --help
- show this help message and exit
gnocchi archive-policy show¶
usage: gnocchi-real archive-policy show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty]
[--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
gnocchi archive-policy update¶
usage: gnocchi-real archive-policy update [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty]
[--noindent] [--prefix PREFIX] -d
<DEFINITION>
name
Update an archive policy
Positional arguments:
name
- name of the archive policy
Optional arguments:
-h, --help
- show this help message and exit
-d <DEFINITION>, --definition <DEFINITION>
- two attributes (separated by ‘,’) of an archive policy definition with its name and value separated with a ‘:’
gnocchi archive-policy-rule create¶
usage: gnocchi-real archive-policy-rule create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width] [--print-empty]
[--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
gnocchi archive-policy-rule delete¶
usage: gnocchi-real 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
gnocchi archive-policy-rule list¶
usage: gnocchi-real archive-policy-rule list [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width] [--print-empty]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--sort-column SORT_COLUMN]
List archive policy rules
Optional arguments:
-h, --help
- show this help message and exit
gnocchi archive-policy-rule show¶
usage: gnocchi-real archive-policy-rule show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width] [--print-empty]
[--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
gnocchi archive-policy-rule update¶
usage: gnocchi-real archive-policy-rule update [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width] [--print-empty]
[--noindent] [--prefix PREFIX]
-n NEW_NAME
name
Update an archive policy rule
Positional arguments:
name
- Rule name
Optional arguments:
-h, --help
- show this help message and exit
-n NEW_NAME, --name NEW_NAME
- New rule name
gnocchi benchmark measures add¶
usage: gnocchi-real benchmark measures add [-h] [--resource-id RESOURCE_ID]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty]
[--noindent] [--prefix PREFIX]
[--workers WORKERS] --count COUNT
[--batch BATCH]
[--timestamp-start TIMESTAMP_START]
[--timestamp-end TIMESTAMP_END]
[--wait]
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
--wait
- Wait for all measures to be processed
gnocchi benchmark measures show¶
usage: gnocchi-real benchmark measures show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width] [--print-empty]
[--noindent] [--prefix PREFIX]
[--sort-column SORT_COLUMN]
[--utc]
[--resource-id RESOURCE_ID]
[--aggregation AGGREGATION]
[--start START] [--stop STOP]
[--granularity GRANULARITY]
[--refresh] [--resample RESAMPLE]
[--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
--utc
- Return timestamps as UTC
--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
--granularity GRANULARITY
- granularity to retrieve
--refresh
- force aggregation of all known measures
--resample RESAMPLE
- granularity to resample time-series to (in seconds)
--workers WORKERS, -w WORKERS
- Number of workers to use
--count COUNT, -n COUNT
- Number of total measures to send
gnocchi benchmark metric create¶
usage: gnocchi-real benchmark metric create [-h] [--resource-id RESOURCE_ID]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--fit-width] [--print-empty]
[--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
gnocchi benchmark metric show¶
usage: gnocchi-real benchmark metric show [-h] [--resource-id RESOURCE_ID]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty]
[--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
gnocchi capabilities list¶
usage: gnocchi-real capabilities list [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty]
[--noindent] [--prefix PREFIX]
List capabilities
Optional arguments:
-h, --help
- show this help message and exit
gnocchi measures add¶
usage: gnocchi-real 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 ‘@’
gnocchi measures aggregation¶
usage: gnocchi-real measures aggregation [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--sort-column SORT_COLUMN] [--utc]
-m METRIC [METRIC ...]
[--aggregation AGGREGATION]
[--reaggregation REAGGREGATION]
[--start START] [--stop STOP]
[--granularity GRANULARITY]
[--needed-overlap NEEDED_OVERLAP]
[--query QUERY]
[--resource-type RESOURCE_TYPE]
[--groupby GROUPBY] [--refresh]
[--resample RESAMPLE] [--fill FILL]
Get measurements of aggregated metrics
Optional arguments:
-h, --help
- show this help message and exit
--utc
- Return timestamps as UTC
-m METRIC [METRIC ...], --metric METRIC [METRIC ...]
- metrics IDs or metric name
--aggregation AGGREGATION
- granularity aggregation function to retrieve
--reaggregation REAGGREGATION
- groupby aggregation function to retrieve
--start START
- beginning of the period
--stop STOP
- end of the period
--granularity GRANULARITY
- granularity to retrieve
--needed-overlap NEEDED_OVERLAP
- percent of datapoints in each metrics required
--query QUERY
- A query to filter resource. The syntax is a combination of attribute, operator and value. For example: id=90d58eea-70d7-4294-a49a-170dcdf44c3c would filter resource with a certain id. More complex queries can be built, e.g.: not (flavor_id!=”1” and memory>=24). Use “” to force data to be interpreted as string. Supported operators are: not, and, ∧ or, ∨, >=, <=, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in, like, ≠, ≥, ≤, like, in.
--resource-type RESOURCE_TYPE
- Resource type to query
--groupby GROUPBY
- Attribute to use to group resources
--refresh
- force aggregation of all known measures
--resample RESAMPLE
- granularity to resample time-series to (in seconds)
--fill FILL
- Value to use when backfilling timestamps with missing values in a subset of series. Value should be a float or ‘null’.
gnocchi measures batch-metrics¶
usage: gnocchi-real measures batch-metrics [-h] file
Positional arguments:
file
- File containing measurements to batch or - for stdin (see Gnocchi REST API docs for the format
Optional arguments:
-h, --help
- show this help message and exit
gnocchi measures batch-resources-metrics¶
usage: gnocchi-real measures batch-resources-metrics [-h] [--create-metrics]
file
Positional arguments:
file
- File containing measurements to batch or - for stdin (see Gnocchi REST API docs for the format
Optional arguments:
-h, --help
- show this help message and exit
--create-metrics
- Create unknown metrics
gnocchi measures show¶
usage: gnocchi-real measures show [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--sort-column SORT_COLUMN] [--utc]
[--resource-id RESOURCE_ID]
[--aggregation AGGREGATION] [--start START]
[--stop STOP] [--granularity GRANULARITY]
[--refresh] [--resample RESAMPLE]
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
--utc
- Return timestamps as UTC
--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
--granularity GRANULARITY
- granularity to retrieve
--refresh
- force aggregation of all known measures
--resample RESAMPLE
- granularity to resample time-series to (in seconds)
gnocchi metric create¶
usage: gnocchi-real metric create [-h] [--resource-id RESOURCE_ID]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--prefix PREFIX]
[--archive-policy-name ARCHIVE_POLICY_NAME]
[--unit UNIT]
[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
--unit UNIT, -u UNIT
- unit of the metric
gnocchi metric delete¶
usage: gnocchi-real 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
gnocchi metric list¶
usage: gnocchi-real metric list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--sort-column SORT_COLUMN] [--limit <LIMIT>]
[--marker <MARKER>] [--sort <SORT>]
List metrics
Optional arguments:
-h, --help
- show this help message and exit
--limit <LIMIT>
- Number of metrics 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 metric attribute (example: user_id:desc-nullslast
gnocchi metric show¶
usage: gnocchi-real metric show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--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
gnocchi resource batch delete¶
usage: gnocchi-real resource batch delete [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty]
[--noindent] [--prefix PREFIX]
[--type RESOURCE_TYPE]
query
Delete a batch of resources based on attribute values
Positional arguments:
query
- A query to filter resource. The syntax is a combination of attribute, operator and value. For example: id=90d58eea-70d7-4294-a49a-170dcdf44c3c would filter resource with a certain id. More complex queries can be built, e.g.: not (flavor_id!=”1” and memory>=24). Use “” to force data to be interpreted as string. Supported operators are: not, and, ∧ or, ∨, >=, <=, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in, like, ≠, ≥, ≤, like, in.
Optional arguments:
-h, --help
- show this help message and exit
--type RESOURCE_TYPE, -t RESOURCE_TYPE
- Type of resource
gnocchi resource create¶
usage: gnocchi-real resource create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--prefix PREFIX] [--type RESOURCE_TYPE]
[-a ATTRIBUTE] [-m ADD_METRIC]
[-n CREATE_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 an 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
gnocchi resource delete¶
usage: gnocchi-real 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
gnocchi resource history¶
usage: gnocchi-real resource history [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--sort-column SORT_COLUMN] [--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
gnocchi resource list¶
usage: gnocchi-real resource list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--sort-column SORT_COLUMN] [--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
gnocchi resource search¶
usage: gnocchi-real resource search [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--sort-column SORT_COLUMN] [--details]
[--history] [--limit <LIMIT>]
[--marker <MARKER>] [--sort <SORT>]
[--type RESOURCE_TYPE]
query
Search resources with specified query rules
Positional arguments:
query
- A query to filter resource. The syntax is a combination of attribute, operator and value. For example: id=90d58eea-70d7-4294-a49a-170dcdf44c3c would filter resource with a certain id. More complex queries can be built, e.g.: not (flavor_id!=”1” and memory>=24). Use “” to force data to be interpreted as string. Supported operators are: not, and, ∧ or, ∨, >=, <=, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in, like, ≠, ≥, ≤, like, in.
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
gnocchi resource show¶
usage: gnocchi-real resource show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--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
gnocchi resource update¶
usage: gnocchi-real resource update [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--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 an 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
gnocchi resource-type create¶
usage: gnocchi-real resource-type create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty]
[--noindent] [--prefix PREFIX]
[-a ATTRIBUTE]
name
Create a resource type
Positional arguments:
name
- name of the resource type
Optional arguments:
-h, --help
- show this help message and exit
-a ATTRIBUTE, --attribute ATTRIBUTE
- attribute definition, attribute_name:attribute_type:at tribute_is_required:attribute_type_option_name=attribu te_type_option_value:… For example: display_name:string:true:max_length=255
gnocchi resource-type delete¶
usage: gnocchi-real resource-type delete [-h] name
Delete a resource type
Positional arguments:
name
- name of the resource type
Optional arguments:
-h, --help
- show this help message and exit
gnocchi resource-type list¶
usage: gnocchi-real resource-type list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--sort-column SORT_COLUMN]
List resource types
Optional arguments:
-h, --help
- show this help message and exit
gnocchi resource-type show¶
usage: gnocchi-real resource-type show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty]
[--noindent] [--prefix PREFIX]
name
Show a resource type
Positional arguments:
name
- name of the resource type
Optional arguments:
-h, --help
- show this help message and exit
gnocchi resource-type update¶
usage: gnocchi-real resource-type update [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty]
[--noindent] [--prefix PREFIX]
[-a ATTRIBUTE] [-r REMOVE_ATTRIBUTE]
name
Positional arguments:
name
- name of the resource type
Optional arguments:
-h, --help
- show this help message and exit
-a ATTRIBUTE, --attribute ATTRIBUTE
- attribute definition, attribute_name:attribute_type:at tribute_is_required:attribute_type_option_name=attribu te_type_option_value:… For example: display_name:string:true:max_length=255
-r REMOVE_ATTRIBUTE, --remove-attribute REMOVE_ATTRIBUTE
- attribute name
gnocchi server version¶
usage: gnocchi-real server version [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--prefix PREFIX]
Show the version of Gnocchi server
Optional arguments:
-h, --help
- show this help message and exit
gnocchi status¶
usage: gnocchi-real status [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--fit-width]
[--print-empty] [--noindent] [--prefix PREFIX]
Show the status of measurements processing
Optional arguments:
-h, --help
- show this help message and exit