Chapter 19. A time series storage and resources index service command-line client

--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.

--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.

--os-auth-type <name>, --os-auth-plugin <name>

Authentication type to use

--endpoint ENDPOINT

Gnocchi endpoint (Env: GNOCCHI_ENDPOINT)

--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-url OS_AUTH_URL

Authentication URL

--os-domain-id OS_DOMAIN_ID

Domain ID to scope to

--os-domain-name OS_DOMAIN_NAME

Domain name to scope to

--os-project-id OS_PROJECT_ID, --os-tenant-id OS_PROJECT_ID

Project ID to scope to

--os-project-name OS_PROJECT_NAME, --os-tenant-name OS_PROJECT_NAME

Project name to scope to

--os-project-domain-id OS_PROJECT_DOMAIN_ID

Domain ID containing project

--os-project-domain-name OS_PROJECT_DOMAIN_NAME

Domain name containing project

--os-trust-id OS_TRUST_ID

Trust ID

--os-default-domain-id OS_DEFAULT_DOMAIN_ID

Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

--os-default-domain-name OS_DEFAULT_DOMAIN_NAME

Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

--os-user-id OS_USER_ID

User id

--os-user-name OS_USERNAME, --os-username OS_USERNAME

Username

--os-user-domain-id OS_USER_DOMAIN_ID

User's domain id

--os-user-domain-name OS_USER_DOMAIN_NAME

User's domain name

--os-password OS_PASSWORD

User's password

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

Positional arguments

name

Name of the archive policy

Optional arguments

-h, --help

show this help message and exit

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

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

Positional arguments

name

Name of the archive policy rule

Optional arguments

-h, --help

show this help message and exit

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

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

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

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

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

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

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

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

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 '@'

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

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

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

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

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

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

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

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

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

Positional arguments

resource_id

ID of the resource

Optional arguments

-h, --help

show this help message and exit

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

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

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

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

--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

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

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

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