Red Hat Training

A Red Hat training course is available for Red Hat OpenStack Platform

Command-Line Interface Reference

Red Hat OpenStack Platform 11

Command-line clients for Red Hat OpenStack Platform

OpenStack Documentation Team

Abstract

This guide collects the help content from the OpenStack command-line clients, for reference.

Chapter 1. OpenStack Command-line Clients

1.1. Overview

You can use the OpenStack command-line clients to run simple commands that make API calls. You can run these commands from the command line or in scripts to automate tasks. If you provide OpenStack credentials, you can run these commands on any computer.

Internally, each client command runs cURL commands that embed API requests. The OpenStack APIs are RESTful APIs that use the HTTP protocol, including methods, URIs, media types, and response codes.

These open-source Python clients run on Linux or Mac OS X systems and are easy to learn and use. Each OpenStack service has its own command-line client. On some client commands, you can specify a debug parameter to show the underlying API request for the command. This is a good way to become familiar with the OpenStack API calls.

The following table lists the command-line client for some of the OpenStack services.

Table 1.1. OpenStack services and clients

ServiceClientPackageDescription

Bare Metal

ironic

python-ironicclient

Manage and provision physical machines.

Block Storage

cinder

python-cinderclient

Create and manage volumes.

Compute

nova

python-novaclient

Create and manage images, instances, and flavors.

Director

tripleoclient

python-tripleoclient

Manage a director-based cloud.

Identity

keystone

python-keystoneclient

Create and manage users, tenants, roles, endpoints, and credentials.

Image Service

glance

python-glanceclient

Create and manage images.

Hardware Introspection for Bare Metal

ironic-inspector

openstack-ironic-inspector

An auxiliary service for discovering hardware properties for the Bare Metal service.

Hardware Introspection for Bare Metal

openstack baremetal introspection

python-ironic-inspector-client

A client for the bare metal hardware introspection.

Networking

neutron

python-neutronclient

Configure networks for guest servers. This client was previously called quantum.

Object Storage

swift

python-swiftclient

Gather statistics, list items, update metadata, and upload, download, and delete files stored by the Object Storage service. Gain access to an Object Storage installation for ad hoc processing.

Orchestration

heat

python-heatclient

Launch stacks from templates, view details of running stacks including events and resources, and update and delete stacks.

Telemetry

ceilometer

python-ceilometerclient

Create and collect measurements across OpenStack.

For client installation instructions, see Section 1.2, “Install the OpenStack Command-line Clients”.

1.2. Install the OpenStack Command-line Clients

Install the prerequisite software and the Python package for each OpenStack client.

1.2.1. Install the Prerequisite Software

The following table lists the software that you need to have to run the command-line clients, and provides installation instructions as needed.

Table 1.2. Prerequisite software

PrerequisiteDescription

Python 2.6 or later

Currently, the clients do not support Python 3.

python-setuptools package

python-setuptools is a collection of tools to allow for building, distribution, and installation of Python packages.

1.2.2. Install the Clients

When following the instructions in this section, replace PROJECT with the lowercase name of the client to install, such as nova. Repeat for each client. The valid values include:

  • ceilometer - Telemetry API
  • cinder - Block Storage API and extensions
  • glance - Image Service API
  • heat - Orchestration API
  • keystone - Identity service API and extensions
  • neutron - Networking API
  • nova - Compute API and extensions
  • swift - Object Storage API

The following example shows the command for installing the nova client with yum.

# yum install python-novaclient

1.2.2.1. Installing from Packages

On Red Hat Enterprise Linux, use yum to install the clients:

# yum install python-PROJECTclient

1.2.3. Upgrade or Remove Clients

To upgrade a client, add the --upgrade option to the yum install command:

# yum install --upgrade python-PROJECTclient

To remove the a client, run the yum erase command:

# yum erase python-PROJECTclient

1.2.4. What’s Next

Before you can run client commands, you must create and source the PROJECT-openrc.sh file to set environment variables. See Section 1.4, “Set Environment Variables Using the OpenStack RC File”.

1.3. Discover the Version Number for a Client

Run the following command to discover the version number for a client:

$ PROJECT --version

For example, to see the version number for the nova client, run the following command:

$ nova --version

The version number (3.3.0 in the example) is returned.

3.3.0

1.4. Set Environment Variables Using the OpenStack RC File

To set the required environment variables for the OpenStack command-line clients, you must create an environment file called an OpenStack rc file, or openrc.sh file.If your OpenStack installation provides it, you can download the file from the OpenStack dashboard as an administrative user or any other user. This project-specific environment file contains the credentials that all OpenStack services use.

When you source the file, environment variables are set for your current shell. The variables enable the OpenStack client commands to communicate with the OpenStack services that run in the cloud.

Note

Defining environment variables using an environment file is not a common practice on Microsoft Windows. Environment variables are usually defined in the Advanced tab of the System Properties dialog box.

1.4.1. Download and Source the OpenStack RC File

  1. Log in to the OpenStack dashboard, choose the project for which you want to download the OpenStack RC file, and click btn:[Access & Security].
  2. On the API Access tab, click btn:[Download OpenStack RC File] and save the file. The filename will be of the form PROJECT-openrc.sh where PROJECT is the name of the project for which you downloaded the file.
  3. Copy the PROJECT-openrc.sh file to the computer from which you want to run OpenStack commands.

    For example, copy the file to the computer from which you want to upload an image with a glance client command.

  4. On any shell from which you want to run OpenStack commands, source the PROJECT-openrc.sh file for the respective project.

    In the following example, the demo-openrc.sh file is sourced for the demo project:

    $ source demo-openrc.sh
  5. When you are prompted for an OpenStack password, enter the password for the user who downloaded the PROJECT-openrc.sh file.

1.4.2. Create and Source the OpenStack RC File

Alternatively, you can create the PROJECT-openrc.sh file from scratch, if for some reason you cannot download the file from the dashboard.

  1. In a text editor, create a file named PROJECT-openrc.sh file and add the following authentication information:

    export OS_USERNAME=username
    export OS_PASSWORD=password
    export OS_TENANT_NAME=projectName
    export OS_AUTH_URL=https://identityHost:portNumber/v2.0
    # The following lines can be omitted
    export OS_TENANT_ID=tenantIDString
    export OS_REGION_NAME=regionName

    The following example shows the information for a project called admin, where the OS username is also admin, and the identity host is located at controller.

    export OS_USERNAME=admin
    export OS_PASSWORD=ADMIN_PASS
    export OS_TENANT_NAME=admin
    export OS_AUTH_URL=http://controller:35357/v2.0
  2. On any shell from which you want to run OpenStack commands, source the PROJECT-openrc.sh file for the respective project. In this example, you source the admin-openrc.sh file for the admin project:

    $ source admin-openrc.sh
Note

You are not prompted for the password with this method. The password lives in clear text format in the PROJECT-openrc.sh file. Restrict the permissions on this file to avoid security problems. You can also remove the OS_PASSWORD variable from the file, and use the --password parameter with OpenStack client commands instead.

1.4.3. Override Environment Variable Values

When you run OpenStack client commands, you can override some environment variable settings by using the options that are listed at the end of the help output of the various client commands. For example, you can override the OS_PASSWORD setting in the PROJECT-openrc.sh file by specifying a password on a keystone command, as follows:

$ keystone --os-password PASSWORD service-list

Where PASSWORD is your password.

Chapter 2. Telemetry Alarming service (aodh) command-line client

The aodh client is the command-line interface (CLI) for the Telemetry Alarming service (aodh) API and its extensions.

This chapter documents aodh version 0.9.0.

For help on a specific aodh command, enter:

$ aodh help COMMAND

2.1. aodh usage

usage: aodh [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
            [--os-region-name <auth-region-name>] [--os-interface <interface>]
            [--aodh-api-version AODH_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-default-domain-id OS_DEFAULT_DOMAIN_ID]
            [--os-default-domain-name OS_DEFAULT_DOMAIN_NAME]
            [--os-user-id OS_USER_ID] [--os-username OS_USERNAME]
            [--os-user-domain-id OS_USER_DOMAIN_ID]
            [--os-user-domain-name OS_USER_DOMAIN_NAME]
            [--os-password OS_PASSWORD] [--aodh-endpoint <endpoint>]

2.2. aodh 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.
--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)
--aodh-api-version AODH_API_VERSION
Defaults to env[AODH_API_VERSION] or 2.
--os-auth-type <name>, --os-auth-plugin <name>
Authentication type to use
--aodh-endpoint <endpoint>
Aodh endpoint (Env: AODH_ENDPOINT)

2.2.1. aodh alarm create

usage: aodh alarm create [-h] [-f {html,json,shell,table,value,yaml}]
                         [-c COLUMN] [--max-width <integer>] [--print-empty]
                         [--noindent] [--prefix PREFIX] --name <NAME> -t
                         <TYPE> [--project-id <PROJECT_ID>]
                         [--user-id <USER_ID>] [--description <DESCRIPTION>]
                         [--state <STATE>] [--severity <SEVERITY>]
                         [--enabled {True|False}]
                         [--alarm-action <Webhook URL>]
                         [--ok-action <Webhook URL>]
                         [--insufficient-data-action <Webhook URL>]
                         [--time-constraint <Time Constraint>]
                         [--repeat-actions {True|False}] [--query <QUERY>]
                         [--comparison-operator <OPERATOR>]
                         [--evaluation-periods <EVAL_PERIODS>]
                         [--threshold <THRESHOLD>] [--metric <METRIC>]
                         [-m <METER NAME>] [--period <PERIOD>]
                         [--statistic <STATISTIC>] [--event-type <EVENT_TYPE>]
                         [--granularity <GRANULARITY>]
                         [--aggregation-method <AGGR_METHOD>]
                         [--resource-type <RESOURCE_TYPE>]
                         [--resource-id <RESOURCE_ID>] [--metrics <METRICS>]
                         [--composite-rule <COMPOSITE_RULE>]

Create an alarm

Optional arguments:

-h, --help
show this help message and exit
--name <NAME>
Name of the alarm
-t <TYPE>, --type <TYPE>
Type of alarm, should be one of: threshold, event, composite, gnocchi_resources_threshold, gnocchi_aggregation_by_metrics_threshold, gnocchi_aggregation_by_resources_threshold.
--project-id <PROJECT_ID>
Project to associate with alarm (configurable by admin users only)
--user-id <USER_ID>
User to associate with alarm (configurable by admin users only)
--description <DESCRIPTION>
Free text description of the alarm
--state <STATE>
State of the alarm, one of: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
Severity of the alarm, one of: ['low', 'moderate', 'critical']
--enabled {True|False}
True if alarm evaluation is enabled
--alarm-action <Webhook URL>
URL to invoke when state transitions to alarm. May be used multiple times
--ok-action <Webhook URL>
URL to invoke when state transitions to OK. May be used multiple times
--insufficient-data-action <Webhook URL>
URL to invoke when state transitions to insufficient data. May be used multiple times
--time-constraint <Time Constraint>
Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=< CRON>;duration=<SECONDS>;[description=<DESCRIPTION>;[t imezone=<IANA Timezone>]]
--repeat-actions {True|False}
True if actions should be repeatedly notified while alarm remains in target state

2.2.2. aodh alarm delete

usage: aodh alarm delete [-h] [--name <NAME>] [<ALARM ID or NAME>]

Delete an alarm

Positional arguments:

<ALARM ID or NAME>
ID or name of an alarm.

Optional arguments:

-h, --help
show this help message and exit
--name <NAME>
Name of the alarm

2.2.3. aodh alarm list

usage: aodh alarm list [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN]
                       [--max-width <integer>] [--print-empty] [--noindent]
                       [--quote {all,minimal,none,nonnumeric}]
                       [--query QUERY | --filter <KEY1=VALUE1;KEY2=VALUE2...>]
                       [--limit <LIMIT>] [--marker <MARKER>]
                       [--sort <SORT_KEY:SORT_DIR>]

List alarms

Optional arguments:

-h, --help
show this help message and exit
--query QUERY
Rich query supported by aodh, e.g. project_id!=my-id user_id=foo or user_id=bar
--filter <KEY1=VALUE1;KEY2=VALUE2…​>
Filter parameters to apply on returned alarms.
--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,the supported marker is alarm_id.
--sort <SORT_KEY:SORT_DIR>
Sort of resource attribute, e.g. name:asc

2.2.4. aodh alarm show

usage: aodh alarm show [-h] [-f {html,json,shell,table,value,yaml}]
                       [-c COLUMN] [--max-width <integer>] [--print-empty]
                       [--noindent] [--prefix PREFIX] [--name <NAME>]
                       [<ALARM ID or NAME>]

Show an alarm

Positional arguments:

<ALARM ID or NAME>
ID or name of an alarm.

Optional arguments:

-h, --help
show this help message and exit
--name <NAME>
Name of the alarm

2.2.5. aodh alarm state get

usage: aodh alarm state get [-h] [-f {html,json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>]
                            [--print-empty] [--noindent] [--prefix PREFIX]
                            [--name <NAME>]
                            [<ALARM ID or NAME>]

Get state of an alarm

Positional arguments:

<ALARM ID or NAME>
ID or name of an alarm.

Optional arguments:

-h, --help
show this help message and exit
--name <NAME>
Name of the alarm

2.2.6. aodh alarm state set

usage: aodh alarm state set [-h] [-f {html,json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>]
                            [--print-empty] [--noindent] [--prefix PREFIX]
                            [--name <NAME>] --state <STATE>
                            [<ALARM ID or NAME>]

Set state of an alarm

Positional arguments:

<ALARM ID or NAME>
ID or name of an alarm.

Optional arguments:

-h, --help
show this help message and exit
--name <NAME>
Name of the alarm
--state <STATE>
State of the alarm, one of: ['ok', 'alarm', 'insufficient data']

2.2.7. aodh alarm update

usage: aodh alarm update [-h] [-f {html,json,shell,table,value,yaml}]
                         [-c COLUMN] [--max-width <integer>] [--print-empty]
                         [--noindent] [--prefix PREFIX] [--name <NAME>]
                         [-t <TYPE>] [--project-id <PROJECT_ID>]
                         [--user-id <USER_ID>] [--description <DESCRIPTION>]
                         [--state <STATE>] [--severity <SEVERITY>]
                         [--enabled {True|False}]
                         [--alarm-action <Webhook URL>]
                         [--ok-action <Webhook URL>]
                         [--insufficient-data-action <Webhook URL>]
                         [--time-constraint <Time Constraint>]
                         [--repeat-actions {True|False}] [--query <QUERY>]
                         [--comparison-operator <OPERATOR>]
                         [--evaluation-periods <EVAL_PERIODS>]
                         [--threshold <THRESHOLD>] [--metric <METRIC>]
                         [-m <METER NAME>] [--period <PERIOD>]
                         [--statistic <STATISTIC>] [--event-type <EVENT_TYPE>]
                         [--granularity <GRANULARITY>]
                         [--aggregation-method <AGGR_METHOD>]
                         [--resource-type <RESOURCE_TYPE>]
                         [--resource-id <RESOURCE_ID>] [--metrics <METRICS>]
                         [--composite-rule <COMPOSITE_RULE>]
                         [<ALARM ID or NAME>]

Update an alarm

Positional arguments:

<ALARM ID or NAME>
ID or name of an alarm.

Optional arguments:

-h, --help
show this help message and exit
--name <NAME>
Name of the alarm
-t <TYPE>, --type <TYPE>
Type of alarm, should be one of: threshold, event, composite, gnocchi_resources_threshold, gnocchi_aggregation_by_metrics_threshold, gnocchi_aggregation_by_resources_threshold.
--project-id <PROJECT_ID>
Project to associate with alarm (configurable by admin users only)
--user-id <USER_ID>
User to associate with alarm (configurable by admin users only)
--description <DESCRIPTION>
Free text description of the alarm
--state <STATE>
State of the alarm, one of: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
Severity of the alarm, one of: ['low', 'moderate', 'critical']
--enabled {True|False}
True if alarm evaluation is enabled
--alarm-action <Webhook URL>
URL to invoke when state transitions to alarm. May be used multiple times
--ok-action <Webhook URL>
URL to invoke when state transitions to OK. May be used multiple times
--insufficient-data-action <Webhook URL>
URL to invoke when state transitions to insufficient data. May be used multiple times
--time-constraint <Time Constraint>
Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=< CRON>;duration=<SECONDS>;[description=<DESCRIPTION>;[t imezone=<IANA Timezone>]]
--repeat-actions {True|False}
True if actions should be repeatedly notified while alarm remains in target state

2.2.9. aodh alarm-history show

usage: aodh alarm-history show [-h] [-f {csv,html,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--print-empty] [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--limit <LIMIT>] [--marker <MARKER>]
                               [--sort <SORT_KEY:SORT_DIR>]
                               alarm_id

Show history for an alarm

Positional arguments:

alarm_id
ID of an alarm

Optional arguments:

-h, --help
show this help message and exit
--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,the supported marker is event_id.
--sort <SORT_KEY:SORT_DIR>
Sort of resource attribute. e.g. timestamp:desc

2.2.10. aodh capabilities list

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

List capabilities of alarming service

Optional arguments:

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

Chapter 3. Telemetry Data Collection service (ceilometer) command-line client

The ceilometer client is the command-line interface (CLI) for the Telemetry Data Collection service (ceilometer) API and its extensions.

This chapter documents ceilometer version 2.8.0.

For help on a specific ceilometer command, enter:

$ ceilometer help COMMAND

3.1. ceilometer usage

usage: ceilometer [--version] [-d] [-v] [--timeout TIMEOUT]
                  [--ceilometer-url <CEILOMETER_URL>]
                  [--ceilometer-api-version CEILOMETER_API_VERSION]
                  [--os-tenant-id <tenant-id>]
                  [--os-region-name <region-name>]
                  [--os-auth-token <auth-token>]
                  [--os-service-type <service-type>]
                  [--os-endpoint-type <endpoint-type>] [--os-cacert <cacert>]
                  [--os-insecure <insecure>] [--os-cert-file <cert-file>]
                  [--os-key-file <key-file>] [--os-cert <cert>]
                  [--os-key <key>] [--os-project-name <project-name>]
                  [--os-project-id <project-id>]
                  [--os-project-domain-id <project-domain-id>]
                  [--os-project-domain-name <project-domain-name>]
                  [--os-user-id <user-id>]
                  [--os-user-domain-id <user-domain-id>]
                  [--os-user-domain-name <user-domain-name>]
                  [--os-endpoint <endpoint>] [--os-auth-system <auth-system>]
                  [--os-username <username>] [--os-password <password>]
                  [--os-tenant-name <tenant-name>] [--os-token <token>]
                  [--os-auth-url <auth-url>]
                  <subcommand> ...

Subcommands:

alarm-combination-create
Create a new alarm based on state of other alarms.
alarm-combination-update
Update an existing alarm based on state of other alarms.
alarm-create
Create a new alarm (Deprecated). Use alarm-threshold-create instead.
alarm-delete
Delete an alarm.
alarm-event-create
Create a new alarm based on events.
alarm-event-update
Update an existing alarm based on events.
alarm-gnocchi-aggregation-by-metrics-threshold-create
Create a new alarm based on computed statistics.
alarm-gnocchi-aggregation-by-metrics-threshold-update
Update an existing alarm based on computed statistics.
alarm-gnocchi-aggregation-by-resources-threshold-create
Create a new alarm based on computed statistics.
alarm-gnocchi-aggregation-by-resources-threshold-update
Update an existing alarm based on computed statistics.
alarm-gnocchi-resources-threshold-create
Create a new alarm based on computed statistics.
alarm-gnocchi-resources-threshold-update
Update an existing alarm based on computed statistics.
alarm-history
Display the change history of an alarm.
alarm-list
List the user’s alarms.
alarm-show
Show an alarm.
alarm-state-get
Get the state of an alarm.
alarm-state-set
Set the state of an alarm.
alarm-threshold-create
Create a new alarm based on computed statistics.
alarm-threshold-update
Update an existing alarm based on computed statistics.
alarm-update
Update an existing alarm (Deprecated).
capabilities
Print Ceilometer capabilities.
event-list
List events.
event-show
Show a particular event.
event-type-list
List event types.
meter-list
List the user’s meters.
query-alarm-history
Query Alarm History.
query-alarms
Query Alarms.
query-samples
Query samples.
resource-list
List the resources.
resource-show
Show the resource.
sample-create
Create a sample.
sample-create-list
Create a sample list.
sample-list
List the samples (return OldSample objects if -m/--meter is set).
sample-show
Show a sample.
statistics
List the statistics for a meter.
trait-description-list
List trait info for an event type.
trait-list
List all traits with name <trait_name> for Event Type <event_type>.
bash-completion
Prints all of the commands and options to stdout.
help
Display help about this program or one of its subcommands.

3.2. ceilometer optional arguments

--version
show program’s version number and exit
-d, --debug
Defaults to env[CEILOMETERCLIENT_DEBUG].
-v, --verbose
Print more verbose output.
--timeout TIMEOUT
Number of seconds to wait for a response.
--ceilometer-url <CEILOMETER_URL>
DEPRECATED, use --os-endpoint instead. Defaults to env[CEILOMETER_URL].
--ceilometer-api-version CEILOMETER_API_VERSION
Defaults to env[CEILOMETER_API_VERSION] or 2.
--os-tenant-id <tenant-id>
Defaults to env[OS_TENANT_ID].
--os-region-name <region-name>
Defaults to env[OS_REGION_NAME].
--os-auth-token <auth-token>
Defaults to env[OS_AUTH_TOKEN].
--os-service-type <service-type>
Defaults to env[OS_SERVICE_TYPE].
--os-endpoint-type <endpoint-type>
Defaults to env[OS_ENDPOINT_TYPE].
--os-cacert <cacert>
Defaults to env[OS_CACERT].
--os-insecure <insecure>
Defaults to env[OS_INSECURE].
--os-cert-file <cert-file>
Defaults to env[OS_CERT_FILE].
--os-key-file <key-file>
Defaults to env[OS_KEY_FILE].
--os-cert <cert>
Defaults to env[OS_CERT].
--os-key <key>
Defaults to env[OS_KEY].
--os-project-name <project-name>
Defaults to env[OS_PROJECT_NAME].
--os-project-id <project-id>
Defaults to env[OS_PROJECT_ID].
--os-project-domain-id <project-domain-id>
Defaults to env[OS_PROJECT_DOMAIN_ID].
--os-project-domain-name <project-domain-name>
Defaults to env[OS_PROJECT_DOMAIN_NAME].
--os-user-id <user-id>
Defaults to env[OS_USER_ID].
--os-user-domain-id <user-domain-id>
Defaults to env[OS_USER_DOMAIN_ID].
--os-user-domain-name <user-domain-name>
Defaults to env[OS_USER_DOMAIN_NAME].
--os-endpoint <endpoint>
Defaults to env[OS_ENDPOINT].
--os-auth-system <auth-system>
Defaults to env[OS_AUTH_SYSTEM].
--os-username <username>
Defaults to env[OS_USERNAME].
--os-password <password>
Defaults to env[OS_PASSWORD].
--os-tenant-name <tenant-name>
Defaults to env[OS_TENANT_NAME].
--os-token <token>
Defaults to env[OS_TOKEN].
--os-auth-url <auth-url>
Defaults to env[OS_AUTH_URL].

3.2.1. ceilometer alarm-combination-create

usage: ceilometer alarm-combination-create --name <NAME>
                                           [--project-id <ALARM_PROJECT_ID>]
                                           [--user-id <ALARM_USER_ID>]
                                           [--description <DESCRIPTION>]
                                           [--state <STATE>]
                                           [--severity <SEVERITY>]
                                           [--enabled {True|False}]
                                           [--alarm-action <Webhook URL>]
                                           [--ok-action <Webhook URL>]
                                           [--insufficient-data-action <Webhook URL>]
                                           [--time-constraint <Time Constraint>]
                                           [--repeat-actions {True|False}]
                                           --alarm_ids <ALARM IDS>
                                           [--operator <OPERATOR>]

Create a new alarm based on state of other alarms.

Optional arguments:

--name <NAME>
Name of the alarm (must be unique per tenant). Required.
--project-id <ALARM_PROJECT_ID>
Tenant to associate with alarm (configurable by admin users only).
--user-id <ALARM_USER_ID>
User to associate with alarm (configurable by admin users only).
--description <DESCRIPTION>
Free text description of the alarm.
--state <STATE>
State of the alarm, one of: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
Severity of the alarm, one of: ['low', 'moderate', 'critical']
--enabled {True|False}
True if alarm evaluation/actioning is enabled.
--alarm-action <Webhook URL>
URL to invoke when state transitions to alarm. May be used multiple times. Defaults to None.
--ok-action <Webhook URL>
URL to invoke when state transitions to OK. May be used multiple times. Defaults to None.
--insufficient-data-action <Webhook URL>
URL to invoke when state transitions to insufficient data. May be used multiple times. Defaults to None.
--time-constraint <Time Constraint>
Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.
--repeat-actions {True|False}
True if actions should be repeatedly notified while alarm remains in target state.
--alarm_ids <ALARM IDS>
List of alarm IDs. Required.
--operator <OPERATOR>
Operator to compare with, one of: ['and', 'or'].

3.2.2. ceilometer alarm-combination-update

usage: ceilometer alarm-combination-update [--name <NAME>]
                                           [--project-id <ALARM_PROJECT_ID>]
                                           [--user-id <ALARM_USER_ID>]
                                           [--description <DESCRIPTION>]
                                           [--state <STATE>]
                                           [--severity <SEVERITY>]
                                           [--enabled {True|False}]
                                           [--alarm-action <Webhook URL>]
                                           [--ok-action <Webhook URL>]
                                           [--insufficient-data-action <Webhook URL>]
                                           [--time-constraint <Time Constraint>]
                                           [--repeat-actions {True|False}]
                                           [--remove-time-constraint <Constraint names>]
                                           [--alarm_ids <ALARM IDS>]
                                           [--operator <OPERATOR>]
                                           [<ALARM_ID>]

Update an existing alarm based on state of other alarms.

Positional arguments:

<ALARM_ID>
ID of the alarm to update.

Optional arguments:

--name <NAME>
Name of the alarm (must be unique per tenant).
--project-id <ALARM_PROJECT_ID>
Tenant to associate with alarm (configurable by admin users only).
--user-id <ALARM_USER_ID>
User to associate with alarm (configurable by admin users only).
--description <DESCRIPTION>
Free text description of the alarm.
--state <STATE>
State of the alarm, one of: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
Severity of the alarm, one of: ['low', 'moderate', 'critical']
--enabled {True|False}
True if alarm evaluation/actioning is enabled.
--alarm-action <Webhook URL>
URL to invoke when state transitions to alarm. May be used multiple times. Defaults to None.
--ok-action <Webhook URL>
URL to invoke when state transitions to OK. May be used multiple times. Defaults to None.
--insufficient-data-action <Webhook URL>
URL to invoke when state transitions to insufficient data. May be used multiple times. Defaults to None.
--time-constraint <Time Constraint>
Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.
--repeat-actions {True|False}
True if actions should be repeatedly notified while alarm remains in target state.
--remove-time-constraint <Constraint names>
Name or list of names of the time constraints to remove.
--alarm_ids <ALARM IDS>
List of alarm IDs.
--operator <OPERATOR>
Operator to compare with, one of: ['and', 'or'].

3.2.3. ceilometer alarm-delete

usage: ceilometer alarm-delete [<ALARM_ID>]

Delete an alarm.

Positional arguments:

<ALARM_ID>
ID of the alarm to delete.

3.2.4. ceilometer alarm-event-create

usage: ceilometer alarm-event-create --name <NAME>
                                     [--project-id <ALARM_PROJECT_ID>]
                                     [--user-id <ALARM_USER_ID>]
                                     [--description <DESCRIPTION>]
                                     [--state <STATE>] [--severity <SEVERITY>]
                                     [--enabled {True|False}]
                                     [--alarm-action <Webhook URL>]
                                     [--ok-action <Webhook URL>]
                                     [--insufficient-data-action <Webhook URL>]
                                     [--time-constraint <Time Constraint>]
                                     [--repeat-actions {True|False}]
                                     [--event-type <EVENT_TYPE>] [-q <QUERY>]

Create a new alarm based on events.

Optional arguments:

--name <NAME>
Name of the alarm (must be unique per tenant). Required.
--project-id <ALARM_PROJECT_ID>
Tenant to associate with alarm (configurable by admin users only).
--user-id <ALARM_USER_ID>
User to associate with alarm (configurable by admin users only).
--description <DESCRIPTION>
Free text description of the alarm.
--state <STATE>
State of the alarm, one of: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
Severity of the alarm, one of: ['low', 'moderate', 'critical']
--enabled {True|False}
True if alarm evaluation/actioning is enabled.
--alarm-action <Webhook URL>
URL to invoke when state transitions to alarm. May be used multiple times. Defaults to None.
--ok-action <Webhook URL>
URL to invoke when state transitions to OK. May be used multiple times. Defaults to None.
--insufficient-data-action <Webhook URL>
URL to invoke when state transitions to insufficient data. May be used multiple times. Defaults to None.
--time-constraint <Time Constraint>
Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.
--repeat-actions {True|False}
True if actions should be repeatedly notified while alarm remains in target state.
--event-type <EVENT_TYPE>
Event type for event alarm.
-q <QUERY>, --query <QUERY>
key[op]data_type::value; list for filtering events. data_type is optional, but if supplied must be string, integer, float or datetime.

3.2.5. ceilometer alarm-event-update

usage: ceilometer alarm-event-update [--name <NAME>]
                                     [--project-id <ALARM_PROJECT_ID>]
                                     [--user-id <ALARM_USER_ID>]
                                     [--description <DESCRIPTION>]
                                     [--state <STATE>] [--severity <SEVERITY>]
                                     [--enabled {True|False}]
                                     [--alarm-action <Webhook URL>]
                                     [--ok-action <Webhook URL>]
                                     [--insufficient-data-action <Webhook URL>]
                                     [--time-constraint <Time Constraint>]
                                     [--repeat-actions {True|False}]
                                     [--event-type <EVENT_TYPE>] [-q <QUERY>]
                                     [<ALARM_ID>]

Update an existing alarm based on events.

Positional arguments:

<ALARM_ID>
ID of the alarm to update.

Optional arguments:

--name <NAME>
Name of the alarm (must be unique per tenant).
--project-id <ALARM_PROJECT_ID>
Tenant to associate with alarm (configurable by admin users only).
--user-id <ALARM_USER_ID>
User to associate with alarm (configurable by admin users only).
--description <DESCRIPTION>
Free text description of the alarm.
--state <STATE>
State of the alarm, one of: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
Severity of the alarm, one of: ['low', 'moderate', 'critical']
--enabled {True|False}
True if alarm evaluation/actioning is enabled.
--alarm-action <Webhook URL>
URL to invoke when state transitions to alarm. May be used multiple times. Defaults to None.
--ok-action <Webhook URL>
URL to invoke when state transitions to OK. May be used multiple times. Defaults to None.
--insufficient-data-action <Webhook URL>
URL to invoke when state transitions to insufficient data. May be used multiple times. Defaults to None.
--time-constraint <Time Constraint>
Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.
--repeat-actions {True|False}
True if actions should be repeatedly notified while alarm remains in target state.
--event-type <EVENT_TYPE>
Event type for event alarm.
-q <QUERY>, --query <QUERY>
key[op]data_type::value; list for filtering events. data_type is optional, but if supplied must be string, integer, float or datetime.

3.2.6. ceilometer alarm-gnocchi-aggregation-by-metrics-threshold-create

usage: ceilometer alarm-gnocchi-aggregation-by-metrics-threshold-create
       --name <NAME> [--project-id <ALARM_PROJECT_ID>]
       [--user-id <ALARM_USER_ID>] [--description <DESCRIPTION>]
       [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}]
       [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>]
       [--insufficient-data-action <Webhook URL>]
       [--time-constraint <Time Constraint>] [--repeat-actions {True|False}]
       [--granularity <GRANULARITY>] [--evaluation-periods <COUNT>]
       --aggregation-method <AGGREATION> [--comparison-operator <OPERATOR>]
       --threshold <THRESHOLD> -m <METRICS>

Create a new alarm based on computed statistics.

Optional arguments:

--name <NAME>
Name of the alarm (must be unique per tenant). Required.
--project-id <ALARM_PROJECT_ID>
Tenant to associate with alarm (configurable by admin users only).
--user-id <ALARM_USER_ID>
User to associate with alarm (configurable by admin users only).
--description <DESCRIPTION>
Free text description of the alarm.
--state <STATE>
State of the alarm, one of: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
Severity of the alarm, one of: ['low', 'moderate', 'critical']
--enabled {True|False}
True if alarm evaluation/actioning is enabled.
--alarm-action <Webhook URL>
URL to invoke when state transitions to alarm. May be used multiple times. Defaults to None.
--ok-action <Webhook URL>
URL to invoke when state transitions to OK. May be used multiple times. Defaults to None.
--insufficient-data-action <Webhook URL>
URL to invoke when state transitions to insufficient data. May be used multiple times. Defaults to None.
--time-constraint <Time Constraint>
Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.
--repeat-actions {True|False}
True if actions should be repeatedly notified while alarm remains in target state.
--granularity <GRANULARITY>
Length of each period (seconds) to evaluate over.
--evaluation-periods <COUNT>
Number of periods to evaluate over.
--aggregation-method <AGGREATION>
Aggregation method to use, one of: ['last', 'min', 'median', 'sum', 'std', 'first', 'mean', 'count', 'moving-average', 'max', '1pct', '2pct', '3pct', '4pct', '5pct', '6pct', '7pct', '8pct', '9pct', '10pct', '11pct', '12pct', '13pct', '14pct', '15pct', '16pct', '17pct', '18pct', '19pct', '20pct', '21pct', '22pct', '23pct', '24pct', '25pct', '26pct', '27pct', '28pct', '29pct', '30pct', '31pct', '32pct', '33pct', '34pct', '35pct', '36pct', '37pct', '38pct', '39pct', '40pct', '41pct', '42pct', '43pct', '44pct', '45pct', '46pct', '47pct', '48pct', '49pct', '50pct', '51pct', '52pct', '53pct', '54pct', '55pct', '56pct', '57pct', '58pct', '59pct', '60pct', '61pct', '62pct', '63pct', '64pct', '65pct', '66pct', '67pct', '68pct', '69pct', '70pct', '71pct', '72pct', '73pct', '74pct', '75pct', '76pct', '77pct', '78pct', '79pct', '80pct', '81pct', '82pct', '83pct', '84pct', '85pct', '86pct', '87pct', '88pct', '89pct', '90pct', '91pct', '92pct', '93pct', '94pct', '95pct', '96pct', '97pct', '98pct', '99pct']. Required.
--comparison-operator <OPERATOR>
Operator to compare with, one of: ['lt', 'le', 'eq', 'ne', 'ge', 'gt'].
--threshold <THRESHOLD>
Threshold to evaluate against. Required.
-m <METRICS>, --metrics <METRICS>
Metric to evaluate against. Required.

3.2.7. ceilometer alarm-gnocchi-aggregation-by-metrics-threshold-update

usage: ceilometer alarm-gnocchi-aggregation-by-metrics-threshold-update
       [--name <NAME>] [--project-id <ALARM_PROJECT_ID>]
       [--user-id <ALARM_USER_ID>] [--description <DESCRIPTION>]
       [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}]
       [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>]
       [--insufficient-data-action <Webhook URL>]
       [--time-constraint <Time Constraint>] [--repeat-actions {True|False}]
       [--granularity <GRANULARITY>] [--evaluation-periods <COUNT>]
       [--aggregation-method <AGGREATION>] [--comparison-operator <OPERATOR>]
       [--threshold <THRESHOLD>] [-m <METRICS>]
       [--remove-time-constraint <Constraint names>]
       [<ALARM_ID>]

Update an existing alarm based on computed statistics.

Positional arguments:

<ALARM_ID>
ID of the alarm to update.

Optional arguments:

--name <NAME>
Name of the alarm (must be unique per tenant).
--project-id <ALARM_PROJECT_ID>
Tenant to associate with alarm (configurable by admin users only).
--user-id <ALARM_USER_ID>
User to associate with alarm (configurable by admin users only).
--description <DESCRIPTION>
Free text description of the alarm.
--state <STATE>
State of the alarm, one of: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
Severity of the alarm, one of: ['low', 'moderate', 'critical']
--enabled {True|False}
True if alarm evaluation/actioning is enabled.
--alarm-action <Webhook URL>
URL to invoke when state transitions to alarm. May be used multiple times. Defaults to None.
--ok-action <Webhook URL>
URL to invoke when state transitions to OK. May be used multiple times. Defaults to None.
--insufficient-data-action <Webhook URL>
URL to invoke when state transitions to insufficient data. May be used multiple times. Defaults to None.
--time-constraint <Time Constraint>
Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.
--repeat-actions {True|False}
True if actions should be repeatedly notified while alarm remains in target state.
--granularity <GRANULARITY>
Length of each period (seconds) to evaluate over.
--evaluation-periods <COUNT>
Number of periods to evaluate over.
--aggregation-method <AGGREATION>
Aggregation method to use, one of: ['last', 'min', 'median', 'sum', 'std', 'first', 'mean', 'count', 'moving-average', 'max', '1pct', '2pct', '3pct', '4pct', '5pct', '6pct', '7pct', '8pct', '9pct', '10pct', '11pct', '12pct', '13pct', '14pct', '15pct', '16pct', '17pct', '18pct', '19pct', '20pct', '21pct', '22pct', '23pct', '24pct', '25pct', '26pct', '27pct', '28pct', '29pct', '30pct', '31pct', '32pct', '33pct', '34pct', '35pct', '36pct', '37pct', '38pct', '39pct', '40pct', '41pct', '42pct', '43pct', '44pct', '45pct', '46pct', '47pct', '48pct', '49pct', '50pct', '51pct', '52pct', '53pct', '54pct', '55pct', '56pct', '57pct', '58pct', '59pct', '60pct', '61pct', '62pct', '63pct', '64pct', '65pct', '66pct', '67pct', '68pct', '69pct', '70pct', '71pct', '72pct', '73pct', '74pct', '75pct', '76pct', '77pct', '78pct', '79pct', '80pct', '81pct', '82pct', '83pct', '84pct', '85pct', '86pct', '87pct', '88pct', '89pct', '90pct', '91pct', '92pct', '93pct', '94pct', '95pct', '96pct', '97pct', '98pct', '99pct'].
--comparison-operator <OPERATOR>
Operator to compare with, one of: ['lt', 'le', 'eq', 'ne', 'ge', 'gt'].
--threshold <THRESHOLD>
Threshold to evaluate against.
-m <METRICS>, --metrics <METRICS>
Metric to evaluate against.
--remove-time-constraint <Constraint names>
Name or list of names of the time constraints to remove.

3.2.8. ceilometer alarm-gnocchi-aggregation-by-resources-threshold-create

usage: ceilometer alarm-gnocchi-aggregation-by-resources-threshold-create
       --name <NAME> [--project-id <ALARM_PROJECT_ID>]
       [--user-id <ALARM_USER_ID>] [--description <DESCRIPTION>]
       [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}]
       [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>]
       [--insufficient-data-action <Webhook URL>]
       [--time-constraint <Time Constraint>] [--repeat-actions {True|False}]
       [--granularity <GRANULARITY>] [--evaluation-periods <COUNT>]
       --aggregation-method <AGGREATION> [--comparison-operator <OPERATOR>]
       --threshold <THRESHOLD> -m <METRIC> --resource-type <RESOURCE_TYPE>
       --query <QUERY>

Create a new alarm based on computed statistics.

Optional arguments:

--name <NAME>
Name of the alarm (must be unique per tenant). Required.
--project-id <ALARM_PROJECT_ID>
Tenant to associate with alarm (configurable by admin users only).
--user-id <ALARM_USER_ID>
User to associate with alarm (configurable by admin users only).
--description <DESCRIPTION>
Free text description of the alarm.
--state <STATE>
State of the alarm, one of: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
Severity of the alarm, one of: ['low', 'moderate', 'critical']
--enabled {True|False}
True if alarm evaluation/actioning is enabled.
--alarm-action <Webhook URL>
URL to invoke when state transitions to alarm. May be used multiple times. Defaults to None.
--ok-action <Webhook URL>
URL to invoke when state transitions to OK. May be used multiple times. Defaults to None.
--insufficient-data-action <Webhook URL>
URL to invoke when state transitions to insufficient data. May be used multiple times. Defaults to None.
--time-constraint <Time Constraint>
Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.
--repeat-actions {True|False}
True if actions should be repeatedly notified while alarm remains in target state.
--granularity <GRANULARITY>
Length of each period (seconds) to evaluate over.
--evaluation-periods <COUNT>
Number of periods to evaluate over.
--aggregation-method <AGGREATION>
Aggregation method to use, one of: ['last', 'min', 'median', 'sum', 'std', 'first', 'mean', 'count', 'moving-average', 'max', '1pct', '2pct', '3pct', '4pct', '5pct', '6pct', '7pct', '8pct', '9pct', '10pct', '11pct', '12pct', '13pct', '14pct', '15pct', '16pct', '17pct', '18pct', '19pct', '20pct', '21pct', '22pct', '23pct', '24pct', '25pct', '26pct', '27pct', '28pct', '29pct', '30pct', '31pct', '32pct', '33pct', '34pct', '35pct', '36pct', '37pct', '38pct', '39pct', '40pct', '41pct', '42pct', '43pct', '44pct', '45pct', '46pct', '47pct', '48pct', '49pct', '50pct', '51pct', '52pct', '53pct', '54pct', '55pct', '56pct', '57pct', '58pct', '59pct', '60pct', '61pct', '62pct', '63pct', '64pct', '65pct', '66pct', '67pct', '68pct', '69pct', '70pct', '71pct', '72pct', '73pct', '74pct', '75pct', '76pct', '77pct', '78pct', '79pct', '80pct', '81pct', '82pct', '83pct', '84pct', '85pct', '86pct', '87pct', '88pct', '89pct', '90pct', '91pct', '92pct', '93pct', '94pct', '95pct', '96pct', '97pct', '98pct', '99pct']. Required.
--comparison-operator <OPERATOR>
Operator to compare with, one of: ['lt', 'le', 'eq', 'ne', 'ge', 'gt'].
--threshold <THRESHOLD>
Threshold to evaluate against. Required.
-m <METRIC>, --metric <METRIC>
Metric to evaluate against. Required.
--resource-type <RESOURCE_TYPE>
Resource_type to evaluate against. Required.
--query <QUERY>
Gnocchi resources search query filter Required.

3.2.9. ceilometer alarm-gnocchi-aggregation-by-resources-threshold-update

usage: ceilometer alarm-gnocchi-aggregation-by-resources-threshold-update
       [--name <NAME>] [--project-id <ALARM_PROJECT_ID>]
       [--user-id <ALARM_USER_ID>] [--description <DESCRIPTION>]
       [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}]
       [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>]
       [--insufficient-data-action <Webhook URL>]
       [--time-constraint <Time Constraint>] [--repeat-actions {True|False}]
       [--granularity <GRANULARITY>] [--evaluation-periods <COUNT>]
       [--aggregation-method <AGGREATION>] [--comparison-operator <OPERATOR>]
       [--threshold <THRESHOLD>] [-m <METRIC>]
       [--resource-type <RESOURCE_TYPE>] [--query <QUERY>]
       [--remove-time-constraint <Constraint names>]
       [<ALARM_ID>]

Update an existing alarm based on computed statistics.

Positional arguments:

<ALARM_ID>
ID of the alarm to update.

Optional arguments:

--name <NAME>
Name of the alarm (must be unique per tenant).
--project-id <ALARM_PROJECT_ID>
Tenant to associate with alarm (configurable by admin users only).
--user-id <ALARM_USER_ID>
User to associate with alarm (configurable by admin users only).
--description <DESCRIPTION>
Free text description of the alarm.
--state <STATE>
State of the alarm, one of: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
Severity of the alarm, one of: ['low', 'moderate', 'critical']
--enabled {True|False}
True if alarm evaluation/actioning is enabled.
--alarm-action <Webhook URL>
URL to invoke when state transitions to alarm. May be used multiple times. Defaults to None.
--ok-action <Webhook URL>
URL to invoke when state transitions to OK. May be used multiple times. Defaults to None.
--insufficient-data-action <Webhook URL>
URL to invoke when state transitions to insufficient data. May be used multiple times. Defaults to None.
--time-constraint <Time Constraint>
Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.
--repeat-actions {True|False}
True if actions should be repeatedly notified while alarm remains in target state.
--granularity <GRANULARITY>
Length of each period (seconds) to evaluate over.
--evaluation-periods <COUNT>
Number of periods to evaluate over.
--aggregation-method <AGGREATION>
Aggregation method to use, one of: ['last', 'min', 'median', 'sum', 'std', 'first', 'mean', 'count', 'moving-average', 'max', '1pct', '2pct', '3pct', '4pct', '5pct', '6pct', '7pct', '8pct', '9pct', '10pct', '11pct', '12pct', '13pct', '14pct', '15pct', '16pct', '17pct', '18pct', '19pct', '20pct', '21pct', '22pct', '23pct', '24pct', '25pct', '26pct', '27pct', '28pct', '29pct', '30pct', '31pct', '32pct', '33pct', '34pct', '35pct', '36pct', '37pct', '38pct', '39pct', '40pct', '41pct', '42pct', '43pct', '44pct', '45pct', '46pct', '47pct', '48pct', '49pct', '50pct', '51pct', '52pct', '53pct', '54pct', '55pct', '56pct', '57pct', '58pct', '59pct', '60pct', '61pct', '62pct', '63pct', '64pct', '65pct', '66pct', '67pct', '68pct', '69pct', '70pct', '71pct', '72pct', '73pct', '74pct', '75pct', '76pct', '77pct', '78pct', '79pct', '80pct', '81pct', '82pct', '83pct', '84pct', '85pct', '86pct', '87pct', '88pct', '89pct', '90pct', '91pct', '92pct', '93pct', '94pct', '95pct', '96pct', '97pct', '98pct', '99pct'].
--comparison-operator <OPERATOR>
Operator to compare with, one of: ['lt', 'le', 'eq', 'ne', 'ge', 'gt'].
--threshold <THRESHOLD>
Threshold to evaluate against.
-m <METRIC>, --metric <METRIC>
Metric to evaluate against.
--resource-type <RESOURCE_TYPE>
Resource_type to evaluate against.
--query <QUERY>
Gnocchi resources search query filter
--remove-time-constraint <Constraint names>
Name or list of names of the time constraints to remove.

3.2.10. ceilometer alarm-gnocchi-resources-threshold-create

usage: ceilometer alarm-gnocchi-resources-threshold-create --name <NAME>
                                                           [--project-id <ALARM_PROJECT_ID>]
                                                           [--user-id <ALARM_USER_ID>]
                                                           [--description <DESCRIPTION>]
                                                           [--state <STATE>]
                                                           [--severity <SEVERITY>]
                                                           [--enabled {True|False}]
                                                           [--alarm-action <Webhook URL>]
                                                           [--ok-action <Webhook URL>]
                                                           [--insufficient-data-action <Webhook URL>]
                                                           [--time-constraint <Time Constraint>]
                                                           [--repeat-actions {True|False}]
                                                           [--granularity <GRANULARITY>]
                                                           [--evaluation-periods <COUNT>]
                                                           --aggregation-method
                                                           <AGGREATION>
                                                           [--comparison-operator <OPERATOR>]
                                                           --threshold
                                                           <THRESHOLD> -m
                                                           <METRIC>
                                                           --resource-type
                                                           <RESOURCE_TYPE>
                                                           --resource-id
                                                           <RESOURCE_ID>

Create a new alarm based on computed statistics.

Optional arguments:

--name <NAME>
Name of the alarm (must be unique per tenant). Required.
--project-id <ALARM_PROJECT_ID>
Tenant to associate with alarm (configurable by admin users only).
--user-id <ALARM_USER_ID>
User to associate with alarm (configurable by admin users only).
--description <DESCRIPTION>
Free text description of the alarm.
--state <STATE>
State of the alarm, one of: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
Severity of the alarm, one of: ['low', 'moderate', 'critical']
--enabled {True|False}
True if alarm evaluation/actioning is enabled.
--alarm-action <Webhook URL>
URL to invoke when state transitions to alarm. May be used multiple times. Defaults to None.
--ok-action <Webhook URL>
URL to invoke when state transitions to OK. May be used multiple times. Defaults to None.
--insufficient-data-action <Webhook URL>
URL to invoke when state transitions to insufficient data. May be used multiple times. Defaults to None.
--time-constraint <Time Constraint>
Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.
--repeat-actions {True|False}
True if actions should be repeatedly notified while alarm remains in target state.
--granularity <GRANULARITY>
Length of each period (seconds) to evaluate over.
--evaluation-periods <COUNT>
Number of periods to evaluate over.
--aggregation-method <AGGREATION>
Aggregation method to use, one of: ['last', 'min', 'median', 'sum', 'std', 'first', 'mean', 'count', 'moving-average', 'max', '1pct', '2pct', '3pct', '4pct', '5pct', '6pct', '7pct', '8pct', '9pct', '10pct', '11pct', '12pct', '13pct', '14pct', '15pct', '16pct', '17pct', '18pct', '19pct', '20pct', '21pct', '22pct', '23pct', '24pct', '25pct', '26pct', '27pct', '28pct', '29pct', '30pct', '31pct', '32pct', '33pct', '34pct', '35pct', '36pct', '37pct', '38pct', '39pct', '40pct', '41pct', '42pct', '43pct', '44pct', '45pct', '46pct', '47pct', '48pct', '49pct', '50pct', '51pct', '52pct', '53pct', '54pct', '55pct', '56pct', '57pct', '58pct', '59pct', '60pct', '61pct', '62pct', '63pct', '64pct', '65pct', '66pct', '67pct', '68pct', '69pct', '70pct', '71pct', '72pct', '73pct', '74pct', '75pct', '76pct', '77pct', '78pct', '79pct', '80pct', '81pct', '82pct', '83pct', '84pct', '85pct', '86pct', '87pct', '88pct', '89pct', '90pct', '91pct', '92pct', '93pct', '94pct', '95pct', '96pct', '97pct', '98pct', '99pct']. Required.
--comparison-operator <OPERATOR>
Operator to compare with, one of: ['lt', 'le', 'eq', 'ne', 'ge', 'gt'].
--threshold <THRESHOLD>
Threshold to evaluate against. Required.
-m <METRIC>, --metric <METRIC>
Metric to evaluate against. Required.
--resource-type <RESOURCE_TYPE>
Resource_type to evaluate against. Required.
--resource-id <RESOURCE_ID>
Resource id to evaluate against Required.

3.2.11. ceilometer alarm-gnocchi-resources-threshold-update

usage: ceilometer alarm-gnocchi-resources-threshold-update [--name <NAME>]
                                                           [--project-id <ALARM_PROJECT_ID>]
                                                           [--user-id <ALARM_USER_ID>]
                                                           [--description <DESCRIPTION>]
                                                           [--state <STATE>]
                                                           [--severity <SEVERITY>]
                                                           [--enabled {True|False}]
                                                           [--alarm-action <Webhook URL>]
                                                           [--ok-action <Webhook URL>]
                                                           [--insufficient-data-action <Webhook URL>]
                                                           [--time-constraint <Time Constraint>]
                                                           [--repeat-actions {True|False}]
                                                           [--granularity <GRANULARITY>]
                                                           [--evaluation-periods <COUNT>]
                                                           [--aggregation-method <AGGREATION>]
                                                           [--comparison-operator <OPERATOR>]
                                                           [--threshold <THRESHOLD>]
                                                           [-m <METRIC>]
                                                           [--resource-type <RESOURCE_TYPE>]
                                                           [--resource-id <RESOURCE_ID>]
                                                           [--remove-time-constraint <Constraint names>]
                                                           [<ALARM_ID>]

Update an existing alarm based on computed statistics.

Positional arguments:

<ALARM_ID>
ID of the alarm to update.

Optional arguments:

--name <NAME>
Name of the alarm (must be unique per tenant).
--project-id <ALARM_PROJECT_ID>
Tenant to associate with alarm (configurable by admin users only).
--user-id <ALARM_USER_ID>
User to associate with alarm (configurable by admin users only).
--description <DESCRIPTION>
Free text description of the alarm.
--state <STATE>
State of the alarm, one of: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
Severity of the alarm, one of: ['low', 'moderate', 'critical']
--enabled {True|False}
True if alarm evaluation/actioning is enabled.
--alarm-action <Webhook URL>
URL to invoke when state transitions to alarm. May be used multiple times. Defaults to None.
--ok-action <Webhook URL>
URL to invoke when state transitions to OK. May be used multiple times. Defaults to None.
--insufficient-data-action <Webhook URL>
URL to invoke when state transitions to insufficient data. May be used multiple times. Defaults to None.
--time-constraint <Time Constraint>
Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.
--repeat-actions {True|False}
True if actions should be repeatedly notified while alarm remains in target state.
--granularity <GRANULARITY>
Length of each period (seconds) to evaluate over.
--evaluation-periods <COUNT>
Number of periods to evaluate over.
--aggregation-method <AGGREATION>
Aggregation method to use, one of: ['last', 'min', 'median', 'sum', 'std', 'first', 'mean', 'count', 'moving-average', 'max', '1pct', '2pct', '3pct', '4pct', '5pct', '6pct', '7pct', '8pct', '9pct', '10pct', '11pct', '12pct', '13pct', '14pct', '15pct', '16pct', '17pct', '18pct', '19pct', '20pct', '21pct', '22pct', '23pct', '24pct', '25pct', '26pct', '27pct', '28pct', '29pct', '30pct', '31pct', '32pct', '33pct', '34pct', '35pct', '36pct', '37pct', '38pct', '39pct', '40pct', '41pct', '42pct', '43pct', '44pct', '45pct', '46pct', '47pct', '48pct', '49pct', '50pct', '51pct', '52pct', '53pct', '54pct', '55pct', '56pct', '57pct', '58pct', '59pct', '60pct', '61pct', '62pct', '63pct', '64pct', '65pct', '66pct', '67pct', '68pct', '69pct', '70pct', '71pct', '72pct', '73pct', '74pct', '75pct', '76pct', '77pct', '78pct', '79pct', '80pct', '81pct', '82pct', '83pct', '84pct', '85pct', '86pct', '87pct', '88pct', '89pct', '90pct', '91pct', '92pct', '93pct', '94pct', '95pct', '96pct', '97pct', '98pct', '99pct'].
--comparison-operator <OPERATOR>
Operator to compare with, one of: ['lt', 'le', 'eq', 'ne', 'ge', 'gt'].
--threshold <THRESHOLD>
Threshold to evaluate against.
-m <METRIC>, --metric <METRIC>
Metric to evaluate against.
--resource-type <RESOURCE_TYPE>
Resource_type to evaluate against.
--resource-id <RESOURCE_ID>
Resource id to evaluate against
--remove-time-constraint <Constraint names>
Name or list of names of the time constraints to remove.

3.2.12. ceilometer alarm-history

usage: ceilometer alarm-history [-q <QUERY>] [<ALARM_ID>]

Display the change history of an alarm.

Positional arguments:

<ALARM_ID>
ID of the alarm for which history is shown.

Optional arguments:

-q <QUERY>, --query <QUERY>
key[op]data_type::value; list. data_type is optional, but if supplied must be string, integer, float, or boolean.

3.2.13. ceilometer alarm-list

usage: ceilometer alarm-list [-q <QUERY>]

List the user’s alarms.

Optional arguments:

-q <QUERY>, --query <QUERY>
key[op]data_type::value; list. data_type is optional, but if supplied must be string, integer, float, or boolean.

3.2.14. ceilometer alarm-show

usage: ceilometer alarm-show [<ALARM_ID>]

Show an alarm.

Positional arguments:

<ALARM_ID>
ID of the alarm to show.

3.2.15. ceilometer alarm-state-get

usage: ceilometer alarm-state-get [<ALARM_ID>]

Get the state of an alarm.

Positional arguments:

<ALARM_ID>
ID of the alarm state to show.

3.2.16. ceilometer alarm-state-set

usage: ceilometer alarm-state-set --state <STATE> [<ALARM_ID>]

Set the state of an alarm.

Positional arguments:

<ALARM_ID>
ID of the alarm state to set.

Optional arguments:

--state <STATE>
State of the alarm, one of: ['ok', 'alarm', 'insufficient data']. Required.

3.2.17. ceilometer alarm-threshold-create

usage: ceilometer alarm-threshold-create --name <NAME>
                                         [--project-id <ALARM_PROJECT_ID>]
                                         [--user-id <ALARM_USER_ID>]
                                         [--description <DESCRIPTION>]
                                         [--state <STATE>]
                                         [--severity <SEVERITY>]
                                         [--enabled {True|False}]
                                         [--alarm-action <Webhook URL>]
                                         [--ok-action <Webhook URL>]
                                         [--insufficient-data-action <Webhook URL>]
                                         [--time-constraint <Time Constraint>]
                                         [--repeat-actions {True|False}] -m
                                         <METRIC> [--period <PERIOD>]
                                         [--evaluation-periods <COUNT>]
                                         [--statistic <STATISTIC>]
                                         [--comparison-operator <OPERATOR>]
                                         --threshold <THRESHOLD> [-q <QUERY>]

Create a new alarm based on computed statistics.

Optional arguments:

--name <NAME>
Name of the alarm (must be unique per tenant). Required.
--project-id <ALARM_PROJECT_ID>
Tenant to associate with alarm (configurable by admin users only).
--user-id <ALARM_USER_ID>
User to associate with alarm (configurable by admin users only).
--description <DESCRIPTION>
Free text description of the alarm.
--state <STATE>
State of the alarm, one of: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
Severity of the alarm, one of: ['low', 'moderate', 'critical']
--enabled {True|False}
True if alarm evaluation/actioning is enabled.
--alarm-action <Webhook URL>
URL to invoke when state transitions to alarm. May be used multiple times. Defaults to None.
--ok-action <Webhook URL>
URL to invoke when state transitions to OK. May be used multiple times. Defaults to None.
--insufficient-data-action <Webhook URL>
URL to invoke when state transitions to insufficient data. May be used multiple times. Defaults to None.
--time-constraint <Time Constraint>
Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.
--repeat-actions {True|False}
True if actions should be repeatedly notified while alarm remains in target state.
-m <METRIC>, --meter-name <METRIC>
Metric to evaluate against. Required.
--period <PERIOD>
Length of each period (seconds) to evaluate over.
--evaluation-periods <COUNT>
Number of periods to evaluate over.
--statistic <STATISTIC>
Statistic to evaluate, one of: ['max', 'min', 'avg', 'sum', 'count'].
--comparison-operator <OPERATOR>
Operator to compare with, one of: ['lt', 'le', 'eq', 'ne', 'ge', 'gt'].
--threshold <THRESHOLD>
Threshold to evaluate against. Required.
-q <QUERY>, --query <QUERY>
key[op]data_type::value; list. data_type is optional, but if supplied must be string, integer, float, or boolean.

3.2.18. ceilometer alarm-threshold-update

usage: ceilometer alarm-threshold-update [--name <NAME>]
                                         [--project-id <ALARM_PROJECT_ID>]
                                         [--user-id <ALARM_USER_ID>]
                                         [--description <DESCRIPTION>]
                                         [--state <STATE>]
                                         [--severity <SEVERITY>]
                                         [--enabled {True|False}]
                                         [--alarm-action <Webhook URL>]
                                         [--ok-action <Webhook URL>]
                                         [--insufficient-data-action <Webhook URL>]
                                         [--time-constraint <Time Constraint>]
                                         [--repeat-actions {True|False}]
                                         [--remove-time-constraint <Constraint names>]
                                         [-m <METRIC>] [--period <PERIOD>]
                                         [--evaluation-periods <COUNT>]
                                         [--statistic <STATISTIC>]
                                         [--comparison-operator <OPERATOR>]
                                         [--threshold <THRESHOLD>]
                                         [-q <QUERY>]
                                         [<ALARM_ID>]

Update an existing alarm based on computed statistics.

Positional arguments:

<ALARM_ID>
ID of the alarm to update.

Optional arguments:

--name <NAME>
Name of the alarm (must be unique per tenant).
--project-id <ALARM_PROJECT_ID>
Tenant to associate with alarm (configurable by admin users only).
--user-id <ALARM_USER_ID>
User to associate with alarm (configurable by admin users only).
--description <DESCRIPTION>
Free text description of the alarm.
--state <STATE>
State of the alarm, one of: ['ok', 'alarm', 'insufficient data']
--severity <SEVERITY>
Severity of the alarm, one of: ['low', 'moderate', 'critical']
--enabled {True|False}
True if alarm evaluation/actioning is enabled.
--alarm-action <Webhook URL>
URL to invoke when state transitions to alarm. May be used multiple times. Defaults to None.
--ok-action <Webhook URL>
URL to invoke when state transitions to OK. May be used multiple times. Defaults to None.
--insufficient-data-action <Webhook URL>
URL to invoke when state transitions to insufficient data. May be used multiple times. Defaults to None.
--time-constraint <Time Constraint>
Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds. Can be specified multiple times for multiple time constraints, format is: name=<CONSTRAINT_NAME>;start=<CRON>;durati on=<SECONDS>;[description=<DESCRIPTION>;[timez one=<IANA Timezone>]] Defaults to None.
--repeat-actions {True|False}
True if actions should be repeatedly notified while alarm remains in target state.
--remove-time-constraint <Constraint names>
Name or list of names of the time constraints to remove.
-m <METRIC>, --meter-name <METRIC>
Metric to evaluate against.
--period <PERIOD>
Length of each period (seconds) to evaluate over.
--evaluation-periods <COUNT>
Number of periods to evaluate over.
--statistic <STATISTIC>
Statistic to evaluate, one of: ['max', 'min', 'avg', 'sum', 'count'].
--comparison-operator <OPERATOR>
Operator to compare with, one of: ['lt', 'le', 'eq', 'ne', 'ge', 'gt'].
--threshold <THRESHOLD>
Threshold to evaluate against.
-q <QUERY>, --query <QUERY>
key[op]data_type::value; list. data_type is optional, but if supplied must be string, integer, float, or boolean.

3.2.19. ceilometer capabilities

usage: ceilometer capabilities

Print Ceilometer capabilities.

3.2.20. ceilometer event-list

usage: ceilometer event-list [-q <QUERY>] [--no-traits] [-l <NUMBER>]

List events.

Optional arguments:

-q <QUERY>, --query <QUERY>
key[op]data_type::value; list. data_type is optional, but if supplied must be string, integer, float or datetime.
--no-traits
If specified, traits will not be printed.
-l <NUMBER>, --limit <NUMBER>
Maximum number of events to return. API server limits result to <default_api_return_limit> rows if no limit provided. Option is configured in ceilometer.conf [api] group

3.2.21. ceilometer event-show

usage: ceilometer event-show <message_id>

Show a particular event.

Positional arguments:

<message_id>
The ID of the event. Should be a UUID.

3.2.22. ceilometer event-type-list

usage: ceilometer event-type-list

List event types.

3.2.23. ceilometer meter-list

usage: ceilometer meter-list [-q <QUERY>] [-l <NUMBER>]
                             [--unique {True|False}]

List the user’s meters.

Optional arguments:

-q <QUERY>, --query <QUERY>
key[op]data_type::value; list. data_type is optional, but if supplied must be string, integer, float, or boolean.
-l <NUMBER>, --limit <NUMBER>
Maximum number of meters to return. API server limits result to <default_api_return_limit> rows if no limit provided. Option is configured in ceilometer.conf [api] group
--unique {True|False}
Retrieves unique list of meters.

3.2.24. ceilometer query-alarm-history

usage: ceilometer query-alarm-history [-f <FILTER>] [-o <ORDERBY>]
                                      [-l <LIMIT>]

Query Alarm History.

Optional arguments:

-f <FILTER>, --filter <FILTER>
{complex_op: [{simple_op: {field_name: value}}]} The complex_op is one of: ['and', 'or'], simple_op is one of: ['=', '!=', '<', '⇐', '>', '>='].
-o <ORDERBY>, --orderby <ORDERBY>
[{field_name: direction}, {field_name: direction}] The direction is one of: ['asc', 'desc'].
-l <LIMIT>, --limit <LIMIT>
Maximum number of alarm history items to return. API server limits result to <default_api_return_limit> rows if no limit provided. Option is configured in ceilometer.conf [api] group

3.2.25. ceilometer query-alarms

usage: ceilometer query-alarms [-f <FILTER>] [-o <ORDERBY>] [-l <LIMIT>]

Query Alarms.

Optional arguments:

-f <FILTER>, --filter <FILTER>
{complex_op: [{simple_op: {field_name: value}}]} The complex_op is one of: ['and', 'or'], simple_op is one of: ['=', '!=', '<', '⇐', '>', '>='].
-o <ORDERBY>, --orderby <ORDERBY>
[{field_name: direction}, {field_name: direction}] The direction is one of: ['asc', 'desc'].
-l <LIMIT>, --limit <LIMIT>
Maximum number of alarms to return. API server limits result to <default_api_return_limit> rows if no limit provided. Option is configured in ceilometer.conf [api] group

3.2.26. ceilometer query-samples

usage: ceilometer query-samples [-f <FILTER>] [-o <ORDERBY>] [-l <LIMIT>]

Query samples.

Optional arguments:

-f <FILTER>, --filter <FILTER>
{complex_op: [{simple_op: {field_name: value}}]} The complex_op is one of: ['and', 'or'], simple_op is one of: ['=', '!=', '<', '⇐', '>', '>='].
-o <ORDERBY>, --orderby <ORDERBY>
[{field_name: direction}, {field_name: direction}] The direction is one of: ['asc', 'desc'].
-l <LIMIT>, --limit <LIMIT>
Maximum number of samples to return. API server limits result to <default_api_return_limit> rows if no limit provided. Option is configured in ceilometer.conf [api] group

3.2.27. ceilometer resource-list

usage: ceilometer resource-list [-q <QUERY>] [-l <NUMBER>]

List the resources.

Optional arguments:

-q <QUERY>, --query <QUERY>
key[op]data_type::value; list. data_type is optional, but if supplied must be string, integer, float, or boolean.
-l <NUMBER>, --limit <NUMBER>
Maximum number of resources to return. API server limits result to <default_api_return_limit> rows if no limit provided. Option is configured in ceilometer.conf [api] group

3.2.28. ceilometer resource-show

usage: ceilometer resource-show <RESOURCE_ID>

Show the resource.

Positional arguments:

<RESOURCE_ID>
ID of the resource to show.

3.2.29. ceilometer sample-create

usage: ceilometer sample-create [--project-id <SAMPLE_PROJECT_ID>]
                                [--user-id <SAMPLE_USER_ID>] -r <RESOURCE_ID>
                                -m <METER_NAME> --meter-type <METER_TYPE>
                                --meter-unit <METER_UNIT> --sample-volume
                                <SAMPLE_VOLUME>
                                [--resource-metadata <RESOURCE_METADATA>]
                                [--timestamp <TIMESTAMP>] [--direct <DIRECT>]

Create a sample.

Optional arguments:

--project-id <SAMPLE_PROJECT_ID>
Tenant to associate with sample (configurable by admin users only).
--user-id <SAMPLE_USER_ID>
User to associate with sample (configurable by admin users only).
-r <RESOURCE_ID>, --resource-id <RESOURCE_ID>
ID of the resource. Required.
-m <METER_NAME>, --meter-name <METER_NAME>
The meter name. Required.
--meter-type <METER_TYPE>
The meter type. Required.
--meter-unit <METER_UNIT>
The meter unit. Required.
--sample-volume <SAMPLE_VOLUME>
The sample volume. Required.
--resource-metadata <RESOURCE_METADATA>
Resource metadata. Provided value should be a set of key-value pairs e.g. {"key":"value"}.
--timestamp <TIMESTAMP>
The sample timestamp.
--direct <DIRECT>
Post sample to storage directly. Defaults to False.

3.2.30. ceilometer sample-create-list

usage: ceilometer sample-create-list [--direct <DIRECT>] <SAMPLES_LIST>

Create a sample list.

Positional arguments:

<SAMPLES_LIST>
Json array with samples to create.

Optional arguments:

--direct <DIRECT>
Post samples to storage directly. Defaults to False.

3.2.31. ceilometer sample-list

usage: ceilometer sample-list [-q <QUERY>] [-m <NAME>] [-l <NUMBER>]

List the samples (return OldSample objects if -m/--meter is set).

Optional arguments:

-q <QUERY>, --query <QUERY>
key[op]data_type::value; list. data_type is optional, but if supplied must be string, integer, float, or boolean.
-m <NAME>, --meter <NAME>
Name of meter to show samples for.
-l <NUMBER>, --limit <NUMBER>
Maximum number of samples to return. API server limits result to <default_api_return_limit> rows if no limit provided. Option is configured in ceilometer.conf [api] group

3.2.32. ceilometer sample-show

usage: ceilometer sample-show <SAMPLE_ID>

Show a sample.

Positional arguments:

<SAMPLE_ID>
ID (aka message ID) of the sample to show.

3.2.33. ceilometer statistics

usage: ceilometer statistics [-q <QUERY>] -m <NAME> [-p <PERIOD>] [-g <FIELD>]
                             [-a <FUNC>[<-<PARAM>]]

List the statistics for a meter.

Optional arguments:

-q <QUERY>, --query <QUERY>
key[op]data_type::value; list. data_type is optional, but if supplied must be string, integer, float, or boolean.
-m <NAME>, --meter <NAME>
Name of meter to list statistics for. Required.
-p <PERIOD>, --period <PERIOD>
Period in seconds over which to group samples.
-g <FIELD>, --groupby <FIELD>
Field for group by.
-a <FUNC>[←<PARAM>], --aggregate <FUNC>[←<PARAM>]
Function for data aggregation. Available aggregates are: count, cardinality, min, max, sum, stddev, avg. Defaults to [].

3.2.34. ceilometer trait-description-list

usage: ceilometer trait-description-list -e <EVENT_TYPE>

List trait info for an event type.

Optional arguments:

-e <EVENT_TYPE>, --event_type <EVENT_TYPE>
Type of the event for which traits will be shown. Required.

3.2.35. ceilometer trait-list

usage: ceilometer trait-list -e <EVENT_TYPE> -t <TRAIT_NAME>

List all traits with name <trait_name> for Event Type <event_type>.

Optional arguments:

-e <EVENT_TYPE>, --event_type <EVENT_TYPE>
Type of the event for which traits will listed. Required.
-t <TRAIT_NAME>, --trait_name <TRAIT_NAME>
The name of the trait to list. Required.

Chapter 4. Block Storage service (cinder) command-line client

The cinder client is the command-line interface (CLI) for the Block Storage service (cinder) API and its extensions.

This chapter documents cinder version 2.0.1.

For help on a specific cinder command, enter:

$ cinder help COMMAND

4.1. cinder usage

usage: cinder [--version] [-d] [--os-auth-system <auth-system>]
              [--service-type <service-type>] [--service-name <service-name>]
              [--volume-service-name <volume-service-name>]
              [--os-endpoint-type <os-endpoint-type>]
              [--endpoint-type <endpoint-type>]
              [--os-volume-api-version <volume-api-ver>]
              [--bypass-url <bypass-url>] [--retries <retries>]
              [--profile HMAC_KEY] [--os-auth-strategy <auth-strategy>]
              [--os-username <auth-user-name>] [--os-password <auth-password>]
              [--os-tenant-name <auth-tenant-name>]
              [--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>]
              [--os-user-id <auth-user-id>]
              [--os-user-domain-id <auth-user-domain-id>]
              [--os-user-domain-name <auth-user-domain-name>]
              [--os-project-id <auth-project-id>]
              [--os-project-name <auth-project-name>]
              [--os-project-domain-id <auth-project-domain-id>]
              [--os-project-domain-name <auth-project-domain-name>]
              [--os-region-name <region-name>] [--os-token <token>]
              [--os-url <url>] [--insecure] [--os-cacert <ca-certificate>]
              [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>]
              <subcommand> ...

Subcommands:

absolute-limits
Lists absolute limits for a user.
api-version
Display the server API version information. (Supported by API versions 3.0 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
attachment-create
Create an attachment for a cinder volume. (Supported by API versions 3.27 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
attachment-delete
Delete an attachment for a cinder volume. (Supported by API versions 3.27 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
attachment-list

Lists all attachments. (Supported by API versions 3.27

  • 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
attachment-show
Show detailed information for attachment. (Supported by API versions 3.27 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
attachment-update
Update an attachment for a cinder volume. (Supported by API versions 3.27 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
availability-zone-list
Lists all availability zones.
backup-create
Creates a volume backup.
backup-delete
Removes one or more backups.
backup-export
Export backup metadata record.
backup-import
Import backup metadata record.
backup-list
Lists all backups.
backup-reset-state
Explicitly updates the backup state.
backup-restore
Restores a backup.
backup-show
Shows backup details.
backup-update
Renames a backup. (Supported by API versions 3.9 -3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
cgsnapshot-create
Creates a cgsnapshot.
cgsnapshot-delete
Removes one or more cgsnapshots.
cgsnapshot-list
Lists all cgsnapshots.
cgsnapshot-show
Shows cgsnapshot details.
cluster-disable
Disables clustered services. (Supported by API versions 3.7 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
cluster-enable
Enables clustered services. (Supported by API versions 3.7 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
cluster-list
Lists clustered services with optional filtering. (Supported by API versions 3.7 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
cluster-show
Show detailed information on a clustered service. (Supported by API versions 3.7 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
consisgroup-create
Creates a consistency group.
consisgroup-create-from-src
Creates a consistency group from a cgsnapshot or a source CG.
consisgroup-delete
Removes one or more consistency groups.
consisgroup-list
Lists all consistency groups.
consisgroup-show
Shows details of a consistency group.
consisgroup-update
Updates a consistency group.
create
Creates a volume.
credentials
Shows user credentials returned from auth.
delete
Removes one or more volumes.
encryption-type-create
Creates encryption type for a volume type. Admin only.
encryption-type-delete
Deletes encryption type for a volume type. Admin only.
encryption-type-list
Shows encryption type details for volume types. Admin only.
encryption-type-show
Shows encryption type details for a volume type. Admin only.
encryption-type-update
Update encryption type information for a volume type (Admin Only).
endpoints
Discovers endpoints registered by authentication service.
extend
Attempts to extend size of an existing volume.
extra-specs-list
Lists current volume types and extra specs.
failover-host
Failover a replicating cinder-volume host.
force-delete
Attempts force-delete of volume, regardless of state.
freeze-host
Freeze and disable the specified cinder-volume host.
get-capabilities
Show backend volume stats and properties. Admin only.
get-pools
Show pool information for backends. Admin only.
group-create
Creates a group. (Supported by API versions 3.13 -3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
group-create-from-src
Creates a group from a group snapshot or a source group. (Supported by API versions 3.14 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
group-delete
Removes one or more groups. (Supported by API versions 3.13 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
group-list
Lists all groups. (Supported by API versions 3.13 -3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
group-show
Shows details of a group. (Supported by API versions 3.13 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
group-snapshot-create
Creates a group snapshot. (Supported by API versions 3.14 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
group-snapshot-delete
Removes one or more group snapshots. (Supported by API versions 3.14 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
group-snapshot-list
Lists all group snapshots. (Supported by API versions 3.14 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
group-snapshot-show
Shows group snapshot details. (Supported by API versions 3.14 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
group-specs-list
Lists current group types and specs. (Supported by API versions 3.11 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
group-type-create

Creates a group type. (Supported by API versions 3.11

  • 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
group-type-default
List the default group type. (Supported by API versions 3.11 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
group-type-delete
Deletes group type or types. (Supported by API versions 3.11 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
group-type-key
Sets or unsets group_spec for a group type. (Supported by API versions 3.11 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
group-type-list
Lists available 'group types'. (Admin only will see private types) (Supported by API versions 3.11 -3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
group-type-show
Show group type details. (Supported by API versions 3.11 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
group-type-update
Updates group type name, description, and/or is_public. (Supported by API versions 3.11 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
group-update
Updates a group. (Supported by API versions 3.13 -3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
image-metadata
Sets or deletes volume image metadata.
image-metadata-show
Shows volume image metadata.
list
Lists all volumes.
manage
Manage an existing volume.
manageable-list
Lists all manageable volumes. (Supported by API versions 3.8 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
message-delete
Removes one or more messages. (Supported by API versions 3.3 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
message-list
Lists all messages. (Supported by API versions 3.3 -3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
message-show

Shows message details. (Supported by API versions 3.3

  • 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
metadata
Sets or deletes volume metadata.
metadata-show
Shows volume metadata.
metadata-update-all
Updates volume metadata.
migrate
Migrates volume to a new host.
qos-associate
Associates qos specs with specified volume type.
qos-create
Creates a qos specs.
qos-delete
Deletes a specified qos specs.
qos-disassociate
Disassociates qos specs from specified volume type.
qos-disassociate-all
Disassociates qos specs from all its associations.
qos-get-association
Lists all associations for specified qos specs.
qos-key
Sets or unsets specifications for a qos spec.
qos-list
Lists qos specs.
qos-show
Shows qos specs details.
quota-class-show
Lists quotas for a quota class.
quota-class-update
Updates quotas for a quota class.
quota-defaults
Lists default quotas for a tenant.
quota-delete
Delete the quotas for a tenant.
quota-show
Lists quotas for a tenant.
quota-update
Updates quotas for a tenant.
quota-usage
Lists quota usage for a tenant.
rate-limits
Lists rate limits for a user.
readonly-mode-update
Updates volume read-only access-mode flag.
rename
Renames a volume.
replication-promote
Promote a secondary volume to primary for a relationship.
replication-reenable
Sync the secondary volume with primary for a relationship.
reset-state
Explicitly updates the volume state in the Cinder database.
retype
Changes the volume type for a volume.
service-disable
Disables the service.
service-enable
Enables the service.
service-list
Lists all services. Filter by host and service binary. (Supported by API versions 3.0 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
set-bootable
Update bootable status of a volume.
show
Shows volume details.
snapshot-create
Creates a snapshot.
snapshot-delete
Removes one or more snapshots.
snapshot-list
Lists all snapshots.
snapshot-manage
Manage an existing snapshot.
snapshot-manageable-list
Lists all manageable snapshots. (Supported by API versions 3.8 - 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
snapshot-metadata
Sets or deletes snapshot metadata.
snapshot-metadata-show
Shows snapshot metadata.
snapshot-metadata-update-all
Updates snapshot metadata.
snapshot-rename
Renames a snapshot.
snapshot-reset-state
Explicitly updates the snapshot state.
snapshot-show
Shows snapshot details.
snapshot-unmanage
Stop managing a snapshot.
thaw-host
Thaw and enable the specified cinder-volume host.
transfer-accept
Accepts a volume transfer.
transfer-create
Creates a volume transfer.
transfer-delete
Undoes a transfer.
transfer-list
Lists all transfers.
transfer-show
Shows transfer details.
type-access-add
Adds volume type access for the given project.
type-access-list
Print access information about the given volume type.
type-access-remove
Removes volume type access for the given project.
type-create
Creates a volume type.
type-default
List the default volume type.
type-delete
Deletes volume type or types.
type-key
Sets or unsets extra_spec for a volume type.
type-list
Lists available 'volume types'.
type-show
Show volume type details.
type-update
Updates volume type name, description, and/or is_public.
unmanage
Stop managing a volume.
upload-to-image
Uploads volume to Image Service as an image.
version-list

List all API versions. (Supported by API versions 3.0

  • 3.latest) [hint: use '--os-volume-api-version' flag to show help message for proper version]
bash-completion
Prints arguments for bash_completion.
help
Shows help about this program or one of its subcommands.

list-extensions

4.2. cinder optional arguments

--version
show program’s version number and exit
-d, --debug
Shows debugging output.
--os-auth-system <auth-system>
Defaults to env[OS_AUTH_SYSTEM].
--service-type <service-type>
Service type. For most actions, default is volume.
--service-name <service-name>
Service name. Default= env[CINDER_SERVICE_NAME].
--volume-service-name <volume-service-name>
Volume service name. Default= env[CINDER_VOLUME_SERVICE_NAME].
--os-endpoint-type <os-endpoint-type>
Endpoint type, which is publicURL or internalURL. Default= env[OS_ENDPOINT_TYPE] or nova env[CINDER_ENDPOINT_TYPE] or publicURL.
--endpoint-type <endpoint-type>
DEPRECATED! Use --os-endpoint-type.
--os-volume-api-version <volume-api-ver>
Block Storage API version. Accepts X, X.Y (where X is major and Y is minor part).Default= env[OS_VOLUME_API_VERSION].
--bypass-url <bypass-url>
Use this API endpoint instead of the Service Catalog. Defaults to env[CINDERCLIENT_BYPASS_URL].
--retries <retries>
Number of retries.
--profile HMAC_KEY
HMAC key to use for encrypting context data for performance profiling of operation. This key needs to match the one configured on the cinder api server. Without key the profiling will not be triggered even if osprofiler is enabled on server side.
--os-auth-strategy <auth-strategy>
Authentication strategy (Env: OS_AUTH_STRATEGY, default keystone). For now, any other value will disable the authentication.
--os-username <auth-user-name>
OpenStack user name. Default= env[OS_USERNAME].
--os-password <auth-password>
Password for OpenStack user. Default= env[OS_PASSWORD].
--os-tenant-name <auth-tenant-name>
Tenant name. Default= env[OS_TENANT_NAME].
--os-tenant-id <auth-tenant-id>
ID for the tenant. Default= env[OS_TENANT_ID].
--os-auth-url <auth-url>
URL for the authentication service. Default= env[OS_AUTH_URL].
--os-user-id <auth-user-id>
Authentication user ID (Env: OS_USER_ID).
--os-user-domain-id <auth-user-domain-id>
OpenStack user domain ID. Defaults to env[OS_USER_DOMAIN_ID].
--os-user-domain-name <auth-user-domain-name>
OpenStack user domain name. Defaults to env[OS_USER_DOMAIN_NAME].
--os-project-id <auth-project-id>
Another way to specify tenant ID. This option is mutually exclusive with --os-tenant-id. Defaults to env[OS_PROJECT_ID].
--os-project-name <auth-project-name>
Another way to specify tenant name. This option is mutually exclusive with --os-tenant-name. Defaults to env[OS_PROJECT_NAME].
--os-project-domain-id <auth-project-domain-id>
Defaults to env[OS_PROJECT_DOMAIN_ID].
--os-project-domain-name <auth-project-domain-name>
Defaults to env[OS_PROJECT_DOMAIN_NAME].
--os-region-name <region-name>
Region name. Default= env[OS_REGION_NAME].
--os-token <token>
Defaults to env[OS_TOKEN].
--os-url <url>
Defaults to env[OS_URL].

4.2.1. cinder absolute-limits

usage: cinder absolute-limits [<tenant_id>]

Lists absolute limits for a user.

Positional arguments:

<tenant_id>
Display information for a single tenant (Admin only).

4.2.2. cinder api-version

usage: cinder api-version

Display the server API version information.

4.2.3. cinder attachment-create

usage: cinder attachment-create [--instance <instance>] [--connect <connect>]
                                [--initiator <initiator>] [--ip <ip>]
                                [--host <host>] [--platform <platform>]
                                [--ostype <ostype>] [--multipath <multipath>]
                                [--mountpoint <mountpoint>]
                                <volume>

Create an attachment for a cinder volume.

Positional arguments:

<volume>
Name or ID of volume or volumes to attach.

Optional arguments:

--instance <instance>
UUID of Instance attaching to. Default=None.
--connect <connect>
Make an active connection using provided connector info (True or False).
--initiator <initiator>
iqn of the initiator attaching to. Default=None.
--ip <ip>
ip of the system attaching to. Default=None.
--host <host>
Name of the host attaching to. Default=None.
--platform <platform>
Platform type. Default=x86_64.
--ostype <ostype>
OS type. Default=linux2.
--multipath <multipath>
OS type. Default=False.
--mountpoint <mountpoint>
Mountpoint volume will be attached at. Default=None.

4.2.4. cinder attachment-delete

usage: cinder attachment-delete <attachment> [<attachment> ...]

Delete an attachment for a cinder volume.

Positional arguments:

<attachment>
ID of attachment or attachments to delete.

4.2.5. cinder attachment-list

usage: cinder attachment-list [--all-tenants [<0|1>]]
                              [--volume-id <volume-id>] [--status <status>]
                              [--marker <marker>] [--limit <limit>]
                              [--sort <key>[:<direction>]]
                              [--tenant [<tenant>]]

Lists all attachments.

Optional arguments:

--all-tenants [<0|1>]
Shows details for all tenants. Admin only.
--volume-id <volume-id>
Filters results by a volume ID. Default=None.
--status <status>
Filters results by a status. Default=None.
--marker <marker>
Begin returning attachments that appear later in attachment list than that represented by this id. Default=None.
--limit <limit>
Maximum number of attachemnts to return. Default=None.
--sort <key>[:<direction>]
Comma-separated list of sort keys and directions in the form of <key>[:<asc|desc>]. Valid keys: id, status, size, availability_zone, name, bootable, created_at, reference. Default=None.
--tenant [<tenant>]
Display information from single tenant (Admin only).

4.2.6. cinder attachment-show

usage: cinder attachment-show <attachment>

Show detailed information for attachment.

Positional arguments:

<attachment>
ID of attachment.

4.2.7. cinder attachment-update

usage: cinder attachment-update [--initiator <initiator>] [--ip <ip>]
                                [--host <host>] [--platform <platform>]
                                [--ostype <ostype>] [--multipath <multipath>]
                                [--mountpoint <mountpoint>]
                                <attachment>

Update an attachment for a cinder volume. This call is designed to be more of an attachment completion than anything else. It expects the value of a connector object to notify the driver that the volume is going to be connected and where it’s being connected to.

Positional arguments:

<attachment>
ID of attachment.

Optional arguments:

--initiator <initiator>
iqn of the initiator attaching to. Default=None.
--ip <ip>
ip of the system attaching to. Default=None.
--host <host>
Name of the host attaching to. Default=None.
--platform <platform>
Platform type. Default=x86_64.
--ostype <ostype>
OS type. Default=linux2.
--multipath <multipath>
OS type. Default=False.
--mountpoint <mountpoint>
Mountpoint volume will be attached at. Default=None.

4.2.8. cinder availability-zone-list

usage: cinder availability-zone-list

Lists all availability zones.

4.2.9. cinder backup-create

usage: cinder backup-create [--container <container>] [--name <name>]
                            [--description <description>] [--incremental]
                            [--force] [--snapshot-id <snapshot-id>]
                            <volume>

Creates a volume backup.

Positional arguments:

<volume>
Name or ID of volume to backup.

Optional arguments:

--container <container>
Backup container name. Default=None.
--name <name>
Backup name. Default=None.
--description <description>
Backup description. Default=None.
--incremental
Incremental backup. Default=False.
--force
Allows or disallows backup of a volume when the volume is attached to an instance. If set to True, backs up the volume whether its status is "available" or "in-use". The backup of an "in-use" volume means your data is crash consistent. Default=False.
--snapshot-id <snapshot-id>
ID of snapshot to backup. Default=None.

4.2.10. cinder backup-delete

usage: cinder backup-delete [--force] <backup> [<backup> ...]

Removes one or more backups.

Positional arguments:

<backup>
Name or ID of backup(s) to delete.

Optional arguments:

--force
Allows deleting backup of a volume when its status is other than "available" or "error". Default=False.

4.2.11. cinder backup-export

usage: cinder backup-export <backup>

Export backup metadata record.

Positional arguments:

<backup>
ID of the backup to export.

4.2.12. cinder backup-import

usage: cinder backup-import <backup_service> <backup_url>

Import backup metadata record.

Positional arguments:

<backup_service>
Backup service to use for importing the backup.
<backup_url>
Backup URL for importing the backup metadata.

4.2.13. cinder backup-list

usage: cinder backup-list [--all-tenants [<all_tenants>]] [--name <name>]
                          [--status <status>] [--volume-id <volume-id>]
                          [--marker <marker>] [--limit <limit>]
                          [--sort <key>[:<direction>]]

Lists all backups.

Optional arguments:

--all-tenants [<all_tenants>]
Shows details for all tenants. Admin only.
--name <name>
Filters results by a name. Default=None.
--status <status>
Filters results by a status. Default=None.
--volume-id <volume-id>
Filters results by a volume ID. Default=None.
--marker <marker>
Begin returning backups that appear later in the backup list than that represented by this id. Default=None.
--limit <limit>
Maximum number of backups to return. Default=None.
--sort <key>[:<direction>]
Comma-separated list of sort keys and directions in the form of <key>[:<asc|desc>]. Valid keys: id, status, size, availability_zone, name, bootable, created_at, reference. Default=None.

4.2.14. cinder backup-reset-state

usage: cinder backup-reset-state [--state <state>] <backup> [<backup> ...]

Explicitly updates the backup state.

Positional arguments:

<backup>
Name or ID of the backup to modify.

Optional arguments:

--state <state>
The state to assign to the backup. Valid values are "available", "error". Default=available.

4.2.15. cinder backup-restore

usage: cinder backup-restore [--volume <volume>] [--name <name>] <backup>

Restores a backup.

Positional arguments:

<backup>
Name or ID of backup to restore.

Optional arguments:

--volume <volume>
Name or ID of existing volume to which to restore. This is mutually exclusive with --name and takes priority. Default=None.
--name <name>
Use the name for new volume creation to restore. This is mutually exclusive with --volume (or the deprecated --volume-id) and --volume (or --volume-id) takes priority. Default=None.

4.2.16. cinder backup-show

usage: cinder backup-show <backup>

Shows backup details.

Positional arguments:

<backup>
Name or ID of backup.

4.2.17. cinder backup-update

usage: cinder backup-update [--name [<name>]] [--description <description>]
                            <backup>

Renames a backup.

Positional arguments:

<backup>
Name or ID of backup to rename.

Optional arguments:

--name [<name>]
New name for backup.
--description <description>
Backup description. Default=None.

4.2.18. cinder cgsnapshot-create

usage: cinder cgsnapshot-create [--name <name>] [--description <description>]
                                <consistencygroup>

Creates a cgsnapshot.

Positional arguments:

<consistencygroup>
Name or ID of a consistency group.

Optional arguments:

--name <name>
Cgsnapshot name. Default=None.
--description <description>
Cgsnapshot description. Default=None.

4.2.19. cinder cgsnapshot-delete

usage: cinder cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]

Removes one or more cgsnapshots.

Positional arguments:

<cgsnapshot>
Name or ID of one or more cgsnapshots to be deleted.

4.2.20. cinder cgsnapshot-list

usage: cinder cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>]
                              [--consistencygroup-id <consistencygroup_id>]

Lists all cgsnapshots.

Optional arguments:

--all-tenants [<0|1>]
Shows details for all tenants. Admin only.
--status <status>
Filters results by a status. Default=None.
--consistencygroup-id <consistencygroup_id>
Filters results by a consistency group ID. Default=None.

4.2.21. cinder cgsnapshot-show

usage: cinder cgsnapshot-show <cgsnapshot>

Shows cgsnapshot details.

Positional arguments:

<cgsnapshot>
Name or ID of cgsnapshot.

4.2.22. cinder cluster-disable

usage: cinder cluster-disable [--reason <reason>] [<binary>] <cluster-name>

Disables clustered services.

Positional arguments:

<binary>
Binary to filter by. Default: cinder-volume.
<cluster-name>
Name of the clustered services to update.

Optional arguments:

--reason <reason>
Reason for disabling clustered service.

4.2.23. cinder cluster-enable

usage: cinder cluster-enable [<binary>] <cluster-name>

Enables clustered services.

Positional arguments:

<binary>
Binary to filter by. Default: cinder-volume.
<cluster-name>
Name of the clustered services to update.

4.2.24. cinder cluster-list

usage: cinder cluster-list [--name <name>] [--binary <binary>]
                           [--is-up <True|true|False|false>]
                           [--disabled <True|true|False|false>]
                           [--num-hosts <num-hosts>]
                           [--num-down-hosts <num-down-hosts>] [--detailed]

Lists clustered services with optional filtering.

Optional arguments:

--name <name>
Filter by cluster name, without backend will list all clustered services from the same cluster. Default=None.
--binary <binary>
Cluster binary. Default=None.
--is-up <True|true|False|false>
Filter by up/dow status. Default=None.
--disabled <True|true|False|false>
Filter by disabled status. Default=None.
--num-hosts <num-hosts>
Filter by number of hosts in the cluster.
--num-down-hosts <num-down-hosts>
Filter by number of hosts that are down.
--detailed
Get detailed clustered service information (Default=False).

4.2.25. cinder cluster-show

usage: cinder cluster-show [<binary>] <cluster-name>

Show detailed information on a clustered service.

Positional arguments:

<binary>
Binary to filter by. Default: cinder-volume.
<cluster-name>
Name of the clustered service to show.

4.2.26. cinder consisgroup-create

usage: cinder consisgroup-create [--name <name>] [--description <description>]
                                 [--availability-zone <availability-zone>]
                                 <volume-types>

Creates a consistency group.

Positional arguments:

<volume-types>
Volume types.

Optional arguments:

--name <name>
Name of a consistency group.
--description <description>
Description of a consistency group. Default=None.
--availability-zone <availability-zone>
Availability zone for volume. Default=None.

4.2.27. cinder consisgroup-create-from-src

usage: cinder consisgroup-create-from-src [--cgsnapshot <cgsnapshot>]
                                          [--source-cg <source-cg>]
                                          [--name <name>]
                                          [--description <description>]

Creates a consistency group from a cgsnapshot or a source CG.

Optional arguments:

--cgsnapshot <cgsnapshot>
Name or ID of a cgsnapshot. Default=None.
--source-cg <source-cg>
Name or ID of a source CG. Default=None.
--name <name>
Name of a consistency group. Default=None.
--description <description>
Description of a consistency group. Default=None.

4.2.28. cinder consisgroup-delete

usage: cinder consisgroup-delete [--force]
                                 <consistencygroup> [<consistencygroup> ...]

Removes one or more consistency groups.

Positional arguments:

<consistencygroup>
Name or ID of one or more consistency groups to be deleted.

Optional arguments:

--force
Allows or disallows consistency groups to be deleted. If the consistency group is empty, it can be deleted without the force flag. If the consistency group is not empty, the force flag is required for it to be deleted.

4.2.29. cinder consisgroup-list

usage: cinder consisgroup-list [--all-tenants [<0|1>]]

Lists all consistency groups.

Optional arguments:

--all-tenants [<0|1>]
Shows details for all tenants. Admin only.

4.2.30. cinder consisgroup-show

usage: cinder consisgroup-show <consistencygroup>

Shows details of a consistency group.

Positional arguments:

<consistencygroup>
Name or ID of a consistency group.

4.2.31. cinder consisgroup-update

usage: cinder consisgroup-update [--name <name>] [--description <description>]
                                 [--add-volumes <uuid1,uuid2,......>]
                                 [--remove-volumes <uuid3,uuid4,......>]
                                 <consistencygroup>

Updates a consistency group.

Positional arguments:

<consistencygroup>
Name or ID of a consistency group.

Optional arguments:

--name <name>
New name for consistency group. Default=None.
--description <description>
New description for consistency group. Default=None.
--add-volumes <uuid1,uuid2,…​…​>
UUID of one or more volumes to be added to the consistency group, separated by commas. Default=None.
--remove-volumes <uuid3,uuid4,…​…​>
UUID of one or more volumes to be removed from the consistency group, separated by commas. Default=None.

4.2.32. cinder create

usage: cinder create [--consisgroup-id <consistencygroup-id>]
                     [--group-id <group-id>] [--snapshot-id <snapshot-id>]
                     [--source-volid <source-volid>]
                     [--source-replica <source-replica>]
                     [--image-id <image-id>] [--image <image>] [--name <name>]
                     [--description <description>]
                     [--volume-type <volume-type>]
                     [--availability-zone <availability-zone>]
                     [--metadata [<key=value> [<key=value> ...]]]
                     [--hint <key=value>] [--allow-multiattach]
                     [<size>]

Creates a volume.

Positional arguments:

<size>
Size of volume, in GiBs. (Required unless snapshot-id /source-volid is specified).

Optional arguments:

--consisgroup-id <consistencygroup-id>
ID of a consistency group where the new volume belongs to. Default=None.
--group-id <group-id>
ID of a group where the new volume belongs to. Default=None. (Supported by API version 3.13 and later)
--snapshot-id <snapshot-id>
Creates volume from snapshot ID. Default=None.
--source-volid <source-volid>
Creates volume from volume ID. Default=None.
--source-replica <source-replica>
Creates volume from replicated volume ID. Default=None.
--image-id <image-id>
Creates volume from image ID. Default=None.
--image <image>
Creates a volume from image (ID or name). Default=None.
--name <name>
Volume name. Default=None.
--description <description>
Volume description. Default=None.
--volume-type <volume-type>
Volume type. Default=None.
--availability-zone <availability-zone>
Availability zone for volume. Default=None.
--metadata [<key=value> [<key=value> …​]]
Metadata key and value pairs. Default=None.
--hint <key=value>
Scheduler hint, like in nova.
--allow-multiattach
Allow volume to be attached more than once. Default=False

4.2.33. cinder credentials

usage: cinder credentials

Shows user credentials returned from auth.

4.2.34. cinder delete

usage: cinder delete [--cascade] <volume> [<volume> ...]

Removes one or more volumes.

Positional arguments:

<volume>
Name or ID of volume or volumes to delete.

Optional arguments:

--cascade
Remove any snapshots along with volume. Default=False.

4.2.35. cinder encryption-type-create

usage: cinder encryption-type-create [--cipher <cipher>]
                                     [--key_size <key_size>]
                                     [--control_location <control_location>]
                                     <volume_type> <provider>

Creates encryption type for a volume type. Admin only.

Positional arguments:

<volume_type>
Name or ID of volume type.
<provider>
The class that provides encryption support. For example, LuksEncryptor.

Optional arguments:

--cipher <cipher>
The encryption algorithm or mode. For example, aes-xts-plain64. Default=None.
--key_size <key_size>

Size of encryption key, in bits. For example, 128 or

  1. Default=None.
--control_location <control_location>
Notional service where encryption is performed. Valid values are "front-end" or "back-end." For example, front-end=Nova. Default is "front-end."

4.2.36. cinder encryption-type-delete

usage: cinder encryption-type-delete <volume_type>

Deletes encryption type for a volume type. Admin only.

Positional arguments:

<volume_type>
Name or ID of volume type.

4.2.37. cinder encryption-type-list

usage: cinder encryption-type-list

Shows encryption type details for volume types. Admin only.

4.2.38. cinder encryption-type-show

usage: cinder encryption-type-show <volume_type>

Shows encryption type details for a volume type. Admin only.

Positional arguments:

<volume_type>
Name or ID of volume type.

4.2.39. cinder encryption-type-update

usage: cinder encryption-type-update [--provider <provider>]
                                     [--cipher [<cipher>]]
                                     [--key-size [<key-size>]]
                                     [--control-location <control-location>]
                                     <volume-type>

Update encryption type information for a volume type (Admin Only).

Positional arguments:

<volume-type>
Name or ID of the volume type

Optional arguments:

--provider <provider>
Class providing encryption support (e.g. LuksEncryptor) (Optional)
--cipher [<cipher>]
Encryption algorithm/mode to use (e.g., aes-xts-plain64). Provide parameter without value to set to provider default. (Optional)
--key-size [<key-size>]
Size of the encryption key, in bits (e.g., 128, 256). Provide parameter without value to set to provider default. (Optional)
--control-location <control-location>
Notional service where encryption is performed (e.g., front-end=Nova). Values: 'front-end', 'back-end' (Optional)

4.2.40. cinder endpoints

usage: cinder endpoints

Discovers endpoints registered by authentication service.

4.2.41. cinder extend

usage: cinder extend <volume> <new_size>

Attempts to extend size of an existing volume.

Positional arguments:

<volume>
Name or ID of volume to extend.
<new_size>
New size of volume, in GiBs.

4.2.42. cinder extra-specs-list

usage: cinder extra-specs-list

Lists current volume types and extra specs.

4.2.43. cinder failover-host

usage: cinder failover-host [--backend_id <backend-id>] <hostname>

Failover a replicating cinder-volume host.

Positional arguments:

<hostname>
Host name.

Optional arguments:

--backend_id <backend-id>
ID of backend to failover to (Default=None)

4.2.44. cinder force-delete

usage: cinder force-delete <volume> [<volume> ...]

Attempts force-delete of volume, regardless of state.

Positional arguments:

<volume>
Name or ID of volume or volumes to delete.

4.2.45. cinder freeze-host

usage: cinder freeze-host <hostname>

Freeze and disable the specified cinder-volume host.

Positional arguments:

<hostname>
Host name.

4.2.46. cinder get-capabilities

usage: cinder get-capabilities <host>

Show backend volume stats and properties. Admin only.

Positional arguments:

<host>
Cinder host to show backend volume stats and properties; takes the form: host@backend-name

4.2.47. cinder get-pools

usage: cinder get-pools [--detail]

Show pool information for backends. Admin only.

Optional arguments:

--detail
Show detailed information about pools.

4.2.48. cinder group-create

usage: cinder group-create [--name <name>] [--description <description>]
                           [--availability-zone <availability-zone>]
                           <group-type> <volume-types>

Creates a group.

Positional arguments:

<group-type>
Group type.
<volume-types>
Comma-separated list of volume types.

Optional arguments:

--name <name>
Name of a group.
--description <description>
Description of a group. Default=None.
--availability-zone <availability-zone>
Availability zone for group. Default=None.

4.2.49. cinder group-create-from-src

usage: cinder group-create-from-src [--group-snapshot <group-snapshot>]
                                    [--source-group <source-group>]
                                    [--name <name>]
                                    [--description <description>]

Creates a group from a group snapshot or a source group.

Optional arguments:

--group-snapshot <group-snapshot>
Name or ID of a group snapshot. Default=None.
--source-group <source-group>
Name or ID of a source group. Default=None.
--name <name>
Name of a group. Default=None.
--description <description>
Description of a group. Default=None.

4.2.50. cinder group-delete

usage: cinder group-delete [--delete-volumes] <group> [<group> ...]

Removes one or more groups.

Positional arguments:

<group>
Name or ID of one or more groups to be deleted.

Optional arguments:

--delete-volumes
Allows or disallows groups to be deleted if they are not empty. If the group is empty, it can be deleted without the delete-volumes flag. If the group is not empty, the delete-volumes flag is required for it to be deleted. If True, all volumes in the group will also be deleted.

4.2.51. cinder group-list

usage: cinder group-list [--all-tenants [<0|1>]]

Lists all groups.

Optional arguments:

--all-tenants [<0|1>]
Shows details for all tenants. Admin only.

4.2.52. cinder group-show

usage: cinder group-show <group>

Shows details of a group.

Positional arguments:

<group>
Name or ID of a group.

4.2.53. cinder group-snapshot-create

usage: cinder group-snapshot-create [--name <name>]
                                    [--description <description>]
                                    <group>

Creates a group snapshot.

Positional arguments:

<group>
Name or ID of a group.

Optional arguments:

--name <name>
Group snapshot name. Default=None.
--description <description>
Group snapshot description. Default=None.

4.2.54. cinder group-snapshot-delete

usage: cinder group-snapshot-delete <group_snapshot> [<group_snapshot> ...]

Removes one or more group snapshots.

Positional arguments:

<group_snapshot>
Name or ID of one or more group snapshots to be deleted.

4.2.55. cinder group-snapshot-list

usage: cinder group-snapshot-list [--all-tenants [<0|1>]] [--status <status>]
                                  [--group-id <group_id>]

Lists all group snapshots.

Optional arguments:

--all-tenants [<0|1>]
Shows details for all tenants. Admin only.
--status <status>
Filters results by a status. Default=None.
--group-id <group_id>
Filters results by a group ID. Default=None.

4.2.56. cinder group-snapshot-show

usage: cinder group-snapshot-show <group_snapshot>

Shows group snapshot details.

Positional arguments:

<group_snapshot>
Name or ID of group snapshot.

4.2.57. cinder group-specs-list

usage: cinder group-specs-list

Lists current group types and specs.

4.2.58. cinder group-type-create

usage: cinder group-type-create [--description <description>]
                                [--is-public <is-public>]
                                <name>

Creates a group type.

Positional arguments:

<name>
Name of new group type.

Optional arguments:

--description <description>
Description of new group type.
--is-public <is-public>
Make type accessible to the public (default true).

4.2.59. cinder group-type-default

usage: cinder group-type-default

List the default group type.

4.2.60. cinder group-type-delete

usage: cinder group-type-delete <group_type> [<group_type> ...]

Deletes group type or types.

Positional arguments:

<group_type>
Name or ID of group type or types to delete.

4.2.61. cinder group-type-key

usage: cinder group-type-key <gtype> <action> <key=value> [<key=value> ...]

Sets or unsets group_spec for a group type.

Positional arguments:

<gtype>
Name or ID of group type.
<action>
The action. Valid values are "set" or "unset."
<key=value>
The group specs key and value pair to set or unset. For unset, specify only the key.

4.2.62. cinder group-type-list

usage: cinder group-type-list

Lists available 'group types'. (Admin only will see private types)

4.2.63. cinder group-type-show

usage: cinder group-type-show <group_type>

Show group type details.

Positional arguments:

<group_type>
Name or ID of the group type.

4.2.64. cinder group-type-update

usage: cinder group-type-update [--name <name>] [--description <description>]
                                [--is-public <is-public>]
                                <id>

Updates group type name, description, and/or is_public.

Positional arguments:

<id>
ID of the group type.

Optional arguments:

--name <name>
Name of the group type.
--description <description>
Description of the group type.
--is-public <is-public>
Make type accessible to the public or not.

4.2.65. cinder group-update

usage: cinder group-update [--name <name>] [--description <description>]
                           [--add-volumes <uuid1,uuid2,......>]
                           [--remove-volumes <uuid3,uuid4,......>]
                           <group>

Updates a group.

Positional arguments:

<group>
Name or ID of a group.

Optional arguments:

--name <name>
New name for group. Default=None.
--description <description>
New description for group. Default=None.
--add-volumes <uuid1,uuid2,…​…​>
UUID of one or more volumes to be added to the group, separated by commas. Default=None.
--remove-volumes <uuid3,uuid4,…​…​>
UUID of one or more volumes to be removed from the group, separated by commas. Default=None.

4.2.66. cinder image-metadata

usage: cinder image-metadata <volume> <action> <key=value> [<key=value> ...]

Sets or deletes volume image metadata.

Positional arguments:

<volume>
Name or ID of volume for which to update metadata.
<action>
The action. Valid values are 'set' or 'unset.'
<key=value>
Metadata key and value pair to set or unset. For unset, specify only the key.

4.2.67. cinder image-metadata-show

usage: cinder image-metadata-show <volume>

Shows volume image metadata.

Positional arguments:

<volume>
ID of volume.

4.2.68. cinder list

usage: cinder list [--group_id <group_id>] [--all-tenants [<0|1>]]
                   [--name <name>] [--status <status>]
                   [--bootable [<True|true|False|false>]]
                   [--migration_status <migration_status>]
                   [--metadata [<key=value> [<key=value> ...]]]
                   [--image_metadata [<key=value> [<key=value> ...]]]
                   [--marker <marker>] [--limit <limit>] [--fields <fields>]
                   [--sort <key>[:<direction>]] [--tenant [<tenant>]]

Lists all volumes.

Optional arguments:

--group_id <group_id>
Filters results by a group_id. Default=None. (Supported by API version 3.10 and later)
--all-tenants [<0|1>]
Shows details for all tenants. Admin only.
--name <name>
Filters results by a name. Default=None.
--status <status>
Filters results by a status. Default=None.
--bootable [<True|true|False|false>]
Filters results by bootable status. Default=None.
--migration_status <migration_status>
Filters results by a migration status. Default=None. Admin only.
--metadata [<key=value> [<key=value> …​]]
Filters results by a metadata key and value pair. Default=None.
--image_metadata [<key=value> [<key=value> …​]]
Filters results by a image metadata key and value pair. Require volume api version >=3.4. Default=None. (Supported by API version 3.4 and later)
--marker <marker>
Begin returning volumes that appear later in the volume list than that represented by this volume id. Default=None.
--limit <limit>
Maximum number of volumes to return. Default=None.
--fields <fields>
Comma-separated list of fields to display. Use the show command to see which fields are available. Unavailable/non-existent fields will be ignored. Default=None.
--sort <key>[:<direction>]
Comma-separated list of sort keys and directions in the form of <key>[:<asc|desc>]. Valid keys: id, status, size, availability_zone, name, bootable, created_at, reference. Default=None.
--tenant [<tenant>]
Display information from single tenant (Admin only).

4.2.69. cinder list-extensions

usage: cinder list-extensions

4.2.70. cinder manage

usage: cinder manage [--id-type <id-type>] [--name <name>]
                     [--description <description>]
                     [--volume-type <volume-type>]
                     [--availability-zone <availability-zone>]
                     [--metadata [<key=value> [<key=value> ...]]] [--bootable]
                     <host> <identifier>

Manage an existing volume.

Positional arguments:

<host>
Cinder host on which the existing volume resides; takes the form: host@backend-name#pool
<identifier>
Name or other Identifier for existing volume

Optional arguments:

--id-type <id-type>
Type of backend device identifier provided, typically source-name or source-id (Default=source-name)
--name <name>
Volume name (Default=None)
--description <description>
Volume description (Default=None)
--volume-type <volume-type>
Volume type (Default=None)
--availability-zone <availability-zone>
Availability zone for volume (Default=None)
--metadata [<key=value> [<key=value> …​]]
Metadata key=value pairs (Default=None)
--bootable
Specifies that the newly created volume should be marked as bootable

4.2.71. cinder manageable-list

usage: cinder manageable-list [--detailed <detailed>] [--marker <marker>]
                              [--limit <limit>] [--offset <offset>]
                              [--sort <key>[:<direction>]]
                              <host>

Lists all manageable volumes.

Positional arguments:

<host>
Cinder host on which to list manageable volumes; takes the form: host@backend-name#pool

Optional arguments:

--detailed <detailed>
Returned detailed information (default true).
--marker <marker>
Begin returning volumes that appear later in the volume list than that represented by this volume id. Default=None.
--limit <limit>
Maximum number of volumes to return. Default=None.
--offset <offset>
Number of volumes to skip after marker. Default=None.
--sort <key>[:<direction>]
Comma-separated list of sort keys and directions in the form of <key>[:<asc|desc>]. Valid keys: size, reference. Default=None.

4.2.72. cinder message-delete

usage: cinder message-delete <message> [<message> ...]

Removes one or more messages.

Positional arguments:

<message>
ID of one or more message to be deleted.

4.2.73. cinder message-list

usage: cinder message-list [--marker <marker>] [--limit <limit>]
                           [--sort <key>[:<direction>]]
                           [--resource_uuid <resource_uuid>]
                           [--resource_type <type>] [--event_id <id>]
                           [--request_id <request_id>] [--level <level>]

Lists all messages.

Optional arguments:

--marker <marker>
Begin returning message that appear later in the message list than that represented by this id. Default=None. (Supported by API version 3.5 and later)
--limit <limit>
Maximum number of messages to return. Default=None. (Supported by API version 3.5 and later)
--sort <key>[:<direction>]
Comma-separated list of sort keys and directions in the form of <key>[:<asc|desc>]. Valid keys: id, status, size, availability_zone, name, bootable, created_at, reference. Default=None. (Supported by API version 3.5 and later)
--resource_uuid <resource_uuid>
Filters results by a resource uuid. Default=None.
--resource_type <type>
Filters results by a resource type. Default=None.
--event_id <id>
Filters results by event id. Default=None.
--request_id <request_id>
Filters results by request id. Default=None.
--level <level>
Filters results by the message level. Default=None.

4.2.74. cinder message-show

usage: cinder message-show <message>

Shows message details.

Positional arguments:

<message>
ID of message.

4.2.75. cinder metadata

usage: cinder metadata <volume> <action> <key=value> [<key=value> ...]

Sets or deletes volume metadata.

Positional arguments:

<volume>
Name or ID of volume for which to update metadata.
<action>
The action. Valid values are "set" or "unset."
<key=value>
Metadata key and value pair to set or unset. For unset, specify only the key(s): <key key> (Supported by API version 3.15 and later)

4.2.76. cinder metadata-show

usage: cinder metadata-show <volume>

Shows volume metadata.

Positional arguments:

<volume>
ID of volume.

4.2.77. cinder metadata-update-all

usage: cinder metadata-update-all <volume> <key=value> [<key=value> ...]

Updates volume metadata.

Positional arguments:

<volume>
ID of volume for which to update metadata.
<key=value>
Metadata key and value pair or pairs to update.

4.2.78. cinder migrate

usage: cinder migrate [--force-host-copy [<True|False>]]
                      [--lock-volume [<True|False>]]
                      <volume> <host>

Migrates volume to a new host.

Positional arguments:

<volume>
ID of volume to migrate.
<host>
Destination host. Takes the form: host@backend-name#pool

Optional arguments:

--force-host-copy [<True|False>]
Enables or disables generic host-based force-migration, which bypasses driver optimizations. Default=False.
--lock-volume [<True|False>]
Enables or disables the termination of volume migration caused by other commands. This option applies to the available volume. True means it locks the volume state and does not allow the migration to be aborted. The volume status will be in maintenance during the migration. False means it allows the volume migration to be aborted. The volume status is still in the original status. Default=False.

4.2.79. cinder qos-associate

usage: cinder qos-associate <qos_specs> <volume_type_id>

Associates qos specs with specified volume type.

Positional arguments:

<qos_specs>
ID of QoS specifications.
<volume_type_id>
ID of volume type with which to associate QoS specifications.

4.2.80. cinder qos-create

usage: cinder qos-create <name> <key=value> [<key=value> ...]

Creates a qos specs.

Positional arguments:

<name>
Name of new QoS specifications.
<key=value>
QoS specifications.

4.2.81. cinder qos-delete

usage: cinder qos-delete [--force [<True|False>]] <qos_specs>

Deletes a specified qos specs.

Positional arguments:

<qos_specs>
ID of QoS specifications to delete.

Optional arguments:

--force [<True|False>]
Enables or disables deletion of in-use QoS specifications. Default=False.

4.2.82. cinder qos-disassociate

usage: cinder qos-disassociate <qos_specs> <volume_type_id>

Disassociates qos specs from specified volume type.

Positional arguments:

<qos_specs>
ID of QoS specifications.
<volume_type_id>
ID of volume type with which to associate QoS specifications.

4.2.83. cinder qos-disassociate-all

usage: cinder qos-disassociate-all <qos_specs>

Disassociates qos specs from all its associations.

Positional arguments:

<qos_specs>
ID of QoS specifications on which to operate.

4.2.84. cinder qos-get-association

usage: cinder qos-get-association <qos_specs>

Lists all associations for specified qos specs.

Positional arguments:

<qos_specs>
ID of QoS specifications.

4.2.85. cinder qos-key

usage: cinder qos-key <qos_specs> <action> key=value [key=value ...]

Sets or unsets specifications for a qos spec.

Positional arguments:

<qos_specs>
ID of QoS specifications.
<action>
The action. Valid values are "set" or "unset."
key=value
Metadata key and value pair to set or unset. For unset, specify only the key.

4.2.86. cinder qos-list

usage: cinder qos-list

Lists qos specs.

4.2.87. cinder qos-show

usage: cinder qos-show <qos_specs>

Shows qos specs details.

Positional arguments:

<qos_specs>
ID of QoS specifications to show.

4.2.88. cinder quota-class-show

usage: cinder quota-class-show <class>

Lists quotas for a quota class.

Positional arguments:

<class>
Name of quota class for which to list quotas.

4.2.89. cinder quota-class-update

usage: cinder quota-class-update [--volumes <volumes>]
                                 [--snapshots <snapshots>]
                                 [--gigabytes <gigabytes>]
                                 [--volume-type <volume_type_name>]
                                 <class_name>

Updates quotas for a quota class.

Positional arguments:

<class_name>
Name of quota class for which to set quotas.

Optional arguments:

--volumes <volumes>
The new "volumes" quota value. Default=None.
--snapshots <snapshots>
The new "snapshots" quota value. Default=None.
--gigabytes <gigabytes>
The new "gigabytes" quota value. Default=None.
--volume-type <volume_type_name>
Volume type. Default=None.

4.2.90. cinder quota-defaults

usage: cinder quota-defaults <tenant_id>

Lists default quotas for a tenant.

Positional arguments:

<tenant_id>
ID of tenant for which to list quota defaults.

4.2.91. cinder quota-delete

usage: cinder quota-delete <tenant_id>

Delete the quotas for a tenant.

Positional arguments:

<tenant_id>
UUID of tenant to delete the quotas for.

4.2.92. cinder quota-show

usage: cinder quota-show <tenant_id>

Lists quotas for a tenant.

Positional arguments:

<tenant_id>
ID of tenant for which to list quotas.

4.2.93. cinder quota-update

usage: cinder quota-update [--volumes <volumes>] [--snapshots <snapshots>]
                           [--gigabytes <gigabytes>] [--backups <backups>]
                           [--backup-gigabytes <backup_gigabytes>]
                           [--consistencygroups <consistencygroups>]
                           [--groups <groups>]
                           [--volume-type <volume_type_name>]
                           [--per-volume-gigabytes <per_volume_gigabytes>]
                           <tenant_id>

Updates quotas for a tenant.

Positional arguments:

<tenant_id>
ID of tenant for which to set quotas.

Optional arguments:

--volumes <volumes>
The new "volumes" quota value. Default=None.
--snapshots <snapshots>
The new "snapshots" quota value. Default=None.
--gigabytes <gigabytes>
The new "gigabytes" quota value. Default=None.
--backups <backups>
The new "backups" quota value. Default=None.
--backup-gigabytes <backup_gigabytes>
The new "backup_gigabytes" quota value. Default=None.
--consistencygroups <consistencygroups>
The new "consistencygroups" quota value. Default=None.
--groups <groups>
The new "groups" quota value. Default=None. (Supported by API version 3.13 and later)
--volume-type <volume_type_name>
Volume type. Default=None.
--per-volume-gigabytes <per_volume_gigabytes>
Set max volume size limit. Default=None.

4.2.94. cinder quota-usage

usage: cinder quota-usage <tenant_id>

Lists quota usage for a tenant.

Positional arguments:

<tenant_id>
ID of tenant for which to list quota usage.

4.2.95. cinder rate-limits

usage: cinder rate-limits [<tenant_id>]

Lists rate limits for a user.

Positional arguments:

<tenant_id>
Display information for a single tenant (Admin only).

4.2.96. cinder readonly-mode-update

usage: cinder readonly-mode-update <volume> <True|true|False|false>

Updates volume read-only access-mode flag.

Positional arguments:

<volume>
ID of volume to update.
<True|true|False|false>
Enables or disables update of volume to read-only access mode.

4.2.97. cinder rename

usage: cinder rename [--description <description>] <volume> [<name>]

Renames a volume.

Positional arguments:

<volume>
Name or ID of volume to rename.
<name>
New name for volume.

Optional arguments:

--description <description>
Volume description. Default=None.

4.2.98. cinder replication-promote

usage: cinder replication-promote <volume>

Promote a secondary volume to primary for a relationship.

Positional arguments:

<volume>
Name or ID of the volume to promote. The volume should have the replica volume created with source-replica argument.

4.2.99. cinder replication-reenable

usage: cinder replication-reenable <volume>

Sync the secondary volume with primary for a relationship.

Positional arguments:

<volume>
Name or ID of the volume to reenable replication. The replication-status of the volume should be inactive.

4.2.100. cinder reset-state

usage: cinder reset-state [--state <state>] [--attach-status <attach-status>]
                          [--reset-migration-status]
                          <volume> [<volume> ...]

Explicitly updates the volume state in the Cinder database. Note that this does not affect whether the volume is actually attached to the Nova compute host or instance and can result in an unusable volume. Being a database change only, this has no impact on the true state of the volume and may not match the actual state. This can render a volume unusable in the case of change to the 'available' state.

Positional arguments:

<volume>
Name or ID of volume to modify.

Optional arguments:

--state <state>
The state to assign to the volume. Valid values are "available", "error", "creating", "deleting", "in-use", "attaching", "detaching", "error_deleting" and "maintenance". NOTE: This command simply changes the state of the Volume in the DataBase with no regard to actual status, exercise caution when using. Default=None, that means the state is unchanged.
--attach-status <attach-status>
The attach status to assign to the volume in the DataBase, with no regard to the actual status. Valid values are "attached" and "detached". Default=None, that means the status is unchanged.
--reset-migration-status
Clears the migration status of the volume in the DataBase that indicates the volume is source or destination of volume migration, with no regard to the actual status.

4.2.101. cinder retype

usage: cinder retype [--migration-policy <never|on-demand>]
                     <volume> <volume-type>

Changes the volume type for a volume.

Positional arguments:

<volume>
Name or ID of volume for which to modify type.
<volume-type>
New volume type.

Optional arguments:

--migration-policy <never|on-demand>
Migration policy during retype of volume.

4.2.102. cinder service-disable

usage: cinder service-disable [--reason <reason>] <hostname> <binary>

Disables the service.

Positional arguments:

<hostname>
Host name.
<binary>
Service binary.

Optional arguments:

--reason <reason>
Reason for disabling service.

4.2.103. cinder service-enable

usage: cinder service-enable <hostname> <binary>

Enables the service.

Positional arguments:

<hostname>
Host name.
<binary>
Service binary.

4.2.104. cinder service-list

usage: cinder service-list [--host <hostname>] [--binary <binary>]
                           [--withreplication [<True|False>]]

Lists all services. Filter by host and service binary.

Optional arguments:

--host <hostname>
Host name. Default=None.
--binary <binary>
Service binary. Default=None.
--withreplication [<True|False>]
Enables or disables display of Replication info for c-vol services. Default=False. (Supported by API version 3.7 and later)

4.2.105. cinder set-bootable

usage: cinder set-bootable <volume> <True|true|False|false>

Update bootable status of a volume.

Positional arguments:

<volume>
ID of the volume to update.
<True|true|False|false>
Flag to indicate whether volume is bootable.

4.2.106. cinder show

usage: cinder show <volume>

Shows volume details.

Positional arguments:

<volume>
Name or ID of volume.

4.2.107. cinder snapshot-create

usage: cinder snapshot-create [--force [<True|False>]] [--name <name>]
                              [--description <description>]
                              [--metadata [<key=value> [<key=value> ...]]]
                              <volume>

Creates a snapshot.

Positional arguments:

<volume>
Name or ID of volume to snapshot.

Optional arguments:

--force [<True|False>]
Allows or disallows snapshot of a volume when the volume is attached to an instance. If set to True, ignores the current status of the volume when attempting to snapshot it rather than forcing it to be available. Default=False.
--name <name>
Snapshot name. Default=None.
--description <description>
Snapshot description. Default=None.
--metadata [<key=value> [<key=value> …​]]
Snapshot metadata key and value pairs. Default=None.

4.2.108. cinder snapshot-delete

usage: cinder snapshot-delete [--force] <snapshot> [<snapshot> ...]

Removes one or more snapshots.

Positional arguments:

<snapshot>
Name or ID of the snapshot(s) to delete.

Optional arguments:

--force
Allows deleting snapshot of a volume when its status is other than "available" or "error". Default=False.

4.2.109. cinder snapshot-list

usage: cinder snapshot-list [--all-tenants [<0|1>]] [--name <name>]
                            [--status <status>] [--volume-id <volume-id>]
                            [--marker <marker>] [--limit <limit>]
                            [--sort <key>[:<direction>]] [--tenant [<tenant>]]
                            [--metadata [<key=value> [<key=value> ...]]]

Lists all snapshots.

Optional arguments:

--all-tenants [<0|1>]
Shows details for all tenants. Admin only.
--name <name>
Filters results by a name. Default=None.
--status <status>
Filters results by a status. Default=None.
--volume-id <volume-id>
Filters results by a volume ID. Default=None.
--marker <marker>
Begin returning snapshots that appear later in the snapshot list than that represented by this id. Default=None.
--limit <limit>
Maximum number of snapshots to return. Default=None.
--sort <key>[:<direction>]
Comma-separated list of sort keys and directions in the form of <key>[:<asc|desc>]. Valid keys: id, status, size, availability_zone, name, bootable, created_at, reference. Default=None.
--tenant [<tenant>]
Display information from single tenant (Admin only).
--metadata [<key=value> [<key=value> …​]]
Filters results by a metadata key and value pair. Require volume api version >=3.22. Default=None. (Supported by API version 3.22 and later)

4.2.110. cinder snapshot-manage

usage: cinder snapshot-manage [--id-type <id-type>] [--name <name>]
                              [--description <description>]
                              [--metadata [<key=value> [<key=value> ...]]]
                              <volume> <identifier>

Manage an existing snapshot.

Positional arguments:

<volume>
Cinder volume already exists in volume backend
<identifier>
Name or other Identifier for existing snapshot

Optional arguments:

--id-type <id-type>
Type of backend device identifier provided, typically source-name or source-id (Default=source-name)
--name <name>
Snapshot name (Default=None)
--description <description>
Snapshot description (Default=None)
--metadata [<key=value> [<key=value> …​]]
Metadata key=value pairs (Default=None)

4.2.111. cinder snapshot-manageable-list

usage: cinder snapshot-manageable-list [--detailed <detailed>]
                                       [--marker <marker>] [--limit <limit>]
                                       [--offset <offset>]
                                       [--sort <key>[:<direction>]]
                                       <host>

Lists all manageable snapshots.

Positional arguments:

<host>
Cinder host on which to list manageable snapshots; takes the form: host@backend-name#pool

Optional arguments:

--detailed <detailed>
Returned detailed information (default true).
--marker <marker>
Begin returning volumes that appear later in the volume list than that represented by this volume id. Default=None.
--limit <limit>
Maximum number of volumes to return. Default=None.
--offset <offset>
Number of volumes to skip after marker. Default=None.
--sort <key>[:<direction>]
Comma-separated list of sort keys and directions in the form of <key>[:<asc|desc>]. Valid keys: size, reference. Default=None.

4.2.112. cinder snapshot-metadata

usage: cinder snapshot-metadata <snapshot> <action> <key=value>
                                [<key=value> ...]

Sets or deletes snapshot metadata.

Positional arguments:

<snapshot>
ID of snapshot for which to update metadata.
<action>
The action. Valid values are "set" or "unset."
<key=value>
Metadata key and value pair to set or unset. For unset, specify only the key.

4.2.113. cinder snapshot-metadata-show

usage: cinder snapshot-metadata-show <snapshot>

Shows snapshot metadata.

Positional arguments:

<snapshot>
ID of snapshot.

4.2.114. cinder snapshot-metadata-update-all

usage: cinder snapshot-metadata-update-all <snapshot> <key=value>
                                           [<key=value> ...]

Updates snapshot metadata.

Positional arguments:

<snapshot>
ID of snapshot for which to update metadata.
<key=value>
Metadata key and value pair to update.

4.2.115. cinder snapshot-rename

usage: cinder snapshot-rename [--description <description>]
                              <snapshot> [<name>]

Renames a snapshot.

Positional arguments:

<snapshot>
Name or ID of snapshot.
<name>
New name for snapshot.

Optional arguments:

--description <description>
Snapshot description. Default=None.

4.2.116. cinder snapshot-reset-state

usage: cinder snapshot-reset-state [--state <state>]
                                   <snapshot> [<snapshot> ...]

Explicitly updates the snapshot state.

Positional arguments:

<snapshot>
Name or ID of snapshot to modify.

Optional arguments:

--state <state>
The state to assign to the snapshot. Valid values are "available", "error", "creating", "deleting", and "error_deleting". NOTE: This command simply changes the state of the Snapshot in the DataBase with no regard to actual status, exercise caution when using. Default=available.

4.2.117. cinder snapshot-show

usage: cinder snapshot-show <snapshot>

Shows snapshot details.

Positional arguments:

<snapshot>
Name or ID of snapshot.

4.2.118. cinder snapshot-unmanage

usage: cinder snapshot-unmanage <snapshot>

Stop managing a snapshot.

Positional arguments:

<snapshot>
Name or ID of the snapshot to unmanage.

4.2.119. cinder thaw-host

usage: cinder thaw-host <hostname>

Thaw and enable the specified cinder-volume host.

Positional arguments:

<hostname>
Host name.

4.2.120. cinder transfer-accept

usage: cinder transfer-accept <transfer> <auth_key>

Accepts a volume transfer.

Positional arguments:

<transfer>
ID of transfer to accept.
<auth_key>
Authentication key of transfer to accept.

4.2.121. cinder transfer-create

usage: cinder transfer-create [--name <name>] <volume>

Creates a volume transfer.

Positional arguments:

<volume>
Name or ID of volume to transfer.

Optional arguments:

--name <name>
Transfer name. Default=None.

4.2.122. cinder transfer-delete

usage: cinder transfer-delete <transfer>

Undoes a transfer.

Positional arguments:

<transfer>
Name or ID of transfer to delete.

4.2.123. cinder transfer-list

usage: cinder transfer-list [--all-tenants [<0|1>]]

Lists all transfers.

Optional arguments:

--all-tenants [<0|1>]
Shows details for all tenants. Admin only.

4.2.124. cinder transfer-show

usage: cinder transfer-show <transfer>

Shows transfer details.

Positional arguments:

<transfer>
Name or ID of transfer to accept.

4.2.125. cinder type-access-add

usage: cinder type-access-add --volume-type <volume_type> --project-id
                              <project_id>

Adds volume type access for the given project.

Optional arguments:

--volume-type <volume_type>
Volume type name or ID to add access for the given project.
--project-id <project_id>
Project ID to add volume type access for.

4.2.126. cinder type-access-list

usage: cinder type-access-list --volume-type <volume_type>

Print access information about the given volume type.

Optional arguments:

--volume-type <volume_type>
Filter results by volume type name or ID.

4.2.127. cinder type-access-remove

usage: cinder type-access-remove --volume-type <volume_type> --project-id
                                 <project_id>

Removes volume type access for the given project.

Optional arguments:

--volume-type <volume_type>
Volume type name or ID to remove access for the given project.
--project-id <project_id>
Project ID to remove volume type access for.

4.2.128. cinder type-create

usage: cinder type-create [--description <description>]
                          [--is-public <is-public>]
                          <name>

Creates a volume type.

Positional arguments:

<name>
Name of new volume type.

Optional arguments:

--description <description>
Description of new volume type.
--is-public <is-public>
Make type accessible to the public (default true).

4.2.129. cinder type-default

usage: cinder type-default

List the default volume type.

4.2.130. cinder type-delete

usage: cinder type-delete <vol_type> [<vol_type> ...]

Deletes volume type or types.

Positional arguments:

<vol_type>
Name or ID of volume type or types to delete.

4.2.131. cinder type-key

usage: cinder type-key <vtype> <action> <key=value> [<key=value> ...]

Sets or unsets extra_spec for a volume type.

Positional arguments:

<vtype>
Name or ID of volume type.
<action>
The action. Valid values are "set" or "unset."
<key=value>
The extra specs key and value pair to set or unset. For unset, specify only the key.

4.2.132. cinder type-list

usage: cinder type-list

Lists available 'volume types'. (Only admin and tenant users will see private types)

4.2.133. cinder type-show

usage: cinder type-show <volume_type>

Show volume type details.

Positional arguments:

<volume_type>
Name or ID of the volume type.

4.2.134. cinder type-update

usage: cinder type-update [--name <name>] [--description <description>]
                          [--is-public <is-public>]
                          <id>

Updates volume type name, description, and/or is_public.

Positional arguments:

<id>
ID of the volume type.

Optional arguments:

--name <name>
Name of the volume type.
--description <description>
Description of the volume type.
--is-public <is-public>
Make type accessible to the public or not.

4.2.135. cinder unmanage

usage: cinder unmanage <volume>

Stop managing a volume.

Positional arguments:

<volume>
Name or ID of the volume to unmanage.

4.2.136. cinder upload-to-image

usage: cinder upload-to-image [--force [<True|False>]]
                              [--container-format <container-format>]
                              [--disk-format <disk-format>]
                              [--visibility <public|private>]
                              [--protected <True|False>]
                              <volume> <image-name>

Uploads volume to Image Service as an image.

Positional arguments:

<volume>
Name or ID of volume to snapshot.
<image-name>
The new image name.

Optional arguments:

--force [<True|False>]
Enables or disables upload of a volume that is attached to an instance. Default=False. This option may not be supported by your cloud.
--container-format <container-format>
Container format type. Default is bare.
--disk-format <disk-format>
Disk format type. Default is raw.
--visibility <public|private>
Set image visibility to either public or private. Default=private. (Supported by API version 3.1 and later)
--protected <True|False>
Prevents image from being deleted. Default=False. (Supported by API version 3.1 and later)

4.2.137. cinder version-list

usage: cinder version-list

List all API versions.

Chapter 5. Image service (glance) command-line client

The glance client is the command-line interface (CLI) for the Image service (glance) API and its extensions.

This chapter documents glance version 2.6.0.

Note

The Image service property keys are documented in the Instances and Images Guide

For help on a specific glance command, enter:

$ glance help COMMAND

5.1. glance usage

usage: glance [--version] [-d] [-v] [--get-schema] [--no-ssl-compression] [-f]
              [--os-image-url OS_IMAGE_URL]
              [--os-image-api-version OS_IMAGE_API_VERSION]
              [--profile HMAC_KEY] [--key-file OS_KEY] [--ca-file OS_CACERT]
              [--cert-file OS_CERT] [--os-region-name OS_REGION_NAME]
              [--os-auth-token OS_AUTH_TOKEN]
              [--os-service-type OS_SERVICE_TYPE]
              [--os-endpoint-type OS_ENDPOINT_TYPE] [--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-default-domain-id OS_DEFAULT_DOMAIN_ID]
              [--os-default-domain-name OS_DEFAULT_DOMAIN_NAME]
              [--os-user-id OS_USER_ID] [--os-username OS_USERNAME]
              [--os-user-domain-id OS_USER_DOMAIN_ID]
              [--os-user-domain-name OS_USER_DOMAIN_NAME]
              [--os-password OS_PASSWORD]
              <subcommand> ...

5.2. glance optional arguments

--version
show program’s version number and exit
-d, --debug
Defaults to env[GLANCECLIENT_DEBUG].
-v, --verbose
Print more verbose output.
--get-schema
Ignores cached copy and forces retrieval of schema that generates portions of the help text. Ignored with API version 1.
--no-ssl-compression
DEPRECATED! This option is deprecated and not used anymore. SSL compression should be disabled by default by the system SSL library.
-f, --force
Prevent select actions from requesting user confirmation.
--os-image-url OS_IMAGE_URL
Defaults to env[OS_IMAGE_URL]. If the provided image url contains a version number and --os-image-api-version is omitted the version of the URL will be picked as the image api version to use.
--os-image-api-version OS_IMAGE_API_VERSION
Defaults to env[OS_IMAGE_API_VERSION] or 2.
--profile HMAC_KEY
HMAC key to use for encrypting context data for performance profiling of operation. This key should be the value of HMAC key configured in osprofiler middleware in glance, it is specified in paste configuration file at /etc/glance/api-paste.ini and /etc/glance/registry-paste.ini. Without key the profiling will not be triggered even if osprofiler is enabled on server side.
--key-file OS_KEY
DEPRECATED! Use --os-key.
--ca-file OS_CACERT
DEPRECATED! Use --os-cacert.
--cert-file OS_CERT
DEPRECATED! Use --os-cert.
--os-region-name OS_REGION_NAME
Defaults to env[OS_REGION_NAME].
--os-auth-token OS_AUTH_TOKEN
Defaults to env[OS_AUTH_TOKEN].
--os-service-type OS_SERVICE_TYPE
Defaults to env[OS_SERVICE_TYPE].
--os-endpoint-type OS_ENDPOINT_TYPE
Defaults to env[OS_ENDPOINT_TYPE].
--os-auth-type <name>, --os-auth-plugin <name>
Authentication type to use

5.2.1. glance explain

usage: glance explain <MODEL>

Describe a specific model.

Positional arguments:

<MODEL>
Name of model to describe.

5.2.2. glance image-create

usage: glance image-create [--architecture <ARCHITECTURE>]
                           [--protected [True|False]] [--name <NAME>]
                           [--instance-uuid <INSTANCE_UUID>]
                           [--min-disk <MIN_DISK>] [--visibility <VISIBILITY>]
                           [--kernel-id <KERNEL_ID>]
                           [--tags <TAGS> [<TAGS> ...]]
                           [--os-version <OS_VERSION>]
                           [--disk-format <DISK_FORMAT>]
                           [--os-distro <OS_DISTRO>] [--id <ID>]
                           [--owner <OWNER>] [--ramdisk-id <RAMDISK_ID>]
                           [--min-ram <MIN_RAM>]
                           [--container-format <CONTAINER_FORMAT>]
                           [--property <key=value>] [--file <FILE>]
                           [--progress]

Create a new image.

Optional arguments:

--architecture <ARCHITECTURE>
Operating system architecture.
--protected [True|False]
If true, image will not be deletable.
--name <NAME>
Descriptive name for the image
--instance-uuid <INSTANCE_UUID>
Metadata which can be used to record which instance this image is associated with. (Informational only, does not create an instance snapshot.)
--min-disk <MIN_DISK>
Amount of disk space (in GB) required to boot image.
--visibility <VISIBILITY>
Scope of image accessibility Valid values: public, private, community, shared
--kernel-id <KERNEL_ID>
ID of image stored in Glance that should be used as the kernel when booting an AMI-style image.
--tags <TAGS> [<TAGS> …​]
List of strings related to the image
--os-version <OS_VERSION>
Operating system version as specified by the distributor
--disk-format <DISK_FORMAT>
Format of the disk Valid values: None, ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso, ploop
--os-distro <OS_DISTRO>
Common name of operating system distribution.
--id <ID>
An identifier for the image
--owner <OWNER>
Owner of the image
--ramdisk-id <RAMDISK_ID>
ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image.
--min-ram <MIN_RAM>
Amount of ram (in MB) required to boot image.
--container-format <CONTAINER_FORMAT>
Format of the container Valid values: None, ami, ari, aki, bare, ovf, ova, docker
--property <key=value>
Arbitrary property to associate with image. May be used multiple times.
--file <FILE>
Local file that contains disk image to be uploaded during creation. Alternatively, the image data can be passed to the client via stdin.
--progress
Show upload progress bar.

5.2.3. glance image-deactivate

usage: glance image-deactivate <IMAGE_ID>

Deactivate specified image.

Positional arguments:

<IMAGE_ID>
ID of image to deactivate.

5.2.4. glance image-delete

usage: glance image-delete <IMAGE_ID> [<IMAGE_ID> ...]

Delete specified image.

Positional arguments:

<IMAGE_ID>
ID of image(s) to delete.

5.2.5. glance image-download

usage: glance image-download [--file <FILE>] [--progress] <IMAGE_ID>

Download a specific image.

Positional arguments:

<IMAGE_ID>
ID of image to download.

Optional arguments:

--file <FILE>
Local file to save downloaded image data to. If this is not specified and there is no redirection the image data will not be saved.
--progress
Show download progress bar.

5.2.6. glance image-list

usage: glance image-list [--limit <LIMIT>] [--page-size <SIZE>]
                         [--visibility <VISIBILITY>]
                         [--member-status <MEMBER_STATUS>] [--owner <OWNER>]
                         [--property-filter <KEY=VALUE>]
                         [--checksum <CHECKSUM>] [--tag <TAG>]
                         [--sort-key {name,status,container_format,disk_format,size,id,created_at,updated_at}]
                         [--sort-dir {asc,desc}] [--sort <key>[:<direction>]]

List images you can access.

Optional arguments:

--limit <LIMIT>
Maximum number of images to get.
--page-size <SIZE>
Number of images to request in each paginated request.
--visibility <VISIBILITY>
The visibility of the images to display.
--member-status <MEMBER_STATUS>
The status of images to display.
--owner <OWNER>
Display images owned by <OWNER>.
--property-filter <KEY=VALUE>
Filter images by a user-defined image property.
--checksum <CHECKSUM>
Displays images that match the checksum.
--tag <TAG>
Filter images by a user-defined tag.
--sort-key {name,status,container_format,disk_format,size,id,created_at,updated_at}
Sort image list by specified fields. May be used multiple times.
--sort-dir {asc,desc}
Sort image list in specified directions.
--sort <key>[:<direction>]
Comma-separated list of sort keys and directions in the form of <key>[:<asc|desc>]. Valid keys: name, status, container_format, disk_format, size, id, created_at, updated_at. OPTIONAL.

5.2.7. glance image-reactivate

usage: glance image-reactivate <IMAGE_ID>

Reactivate specified image.

Positional arguments:

<IMAGE_ID>
ID of image to reactivate.

5.2.8. glance image-show

usage: glance image-show [--human-readable] [--max-column-width <integer>]
                         <IMAGE_ID>

Describe a specific image.

Positional arguments:

<IMAGE_ID>
ID of image to describe.

Optional arguments:

--human-readable
Print image size in a human-friendly format.
--max-column-width <integer>
The max column width of the printed table.

5.2.9. glance image-tag-delete

usage: glance image-tag-delete <IMAGE_ID> <TAG_VALUE>

Delete the tag associated with the given image.

Positional arguments:

<IMAGE_ID>
ID of the image from which to delete tag.
<TAG_VALUE>
Value of the tag.

5.2.10. glance image-tag-update

usage: glance image-tag-update <IMAGE_ID> <TAG_VALUE>

Update an image with the given tag.

Positional arguments:

<IMAGE_ID>
Image to be updated with the given tag.
<TAG_VALUE>
Value of the tag.

5.2.11. glance image-update

usage: glance image-update [--architecture <ARCHITECTURE>]
                           [--protected [True|False]] [--name <NAME>]
                           [--instance-uuid <INSTANCE_UUID>]
                           [--min-disk <MIN_DISK>] [--visibility <VISIBILITY>]
                           [--kernel-id <KERNEL_ID>]
                           [--os-version <OS_VERSION>]
                           [--disk-format <DISK_FORMAT>]
                           [--os-distro <OS_DISTRO>] [--owner <OWNER>]
                           [--ramdisk-id <RAMDISK_ID>] [--min-ram <MIN_RAM>]
                           [--container-format <CONTAINER_FORMAT>]
                           [--property <key=value>] [--remove-property key]
                           <IMAGE_ID>

Update an existing image.

Positional arguments:

<IMAGE_ID>
ID of image to update.

Optional arguments:

--architecture <ARCHITECTURE>
Operating system architecture.
--protected [True|False]
If true, image will not be deletable.
--name <NAME>
Descriptive name for the image
--instance-uuid <INSTANCE_UUID>
Metadata which can be used to record which instance this image is associated with. (Informational only, does not create an instance snapshot.)
--min-disk <MIN_DISK>
Amount of disk space (in GB) required to boot image.
--visibility <VISIBILITY>
Scope of image accessibility Valid values: public, private, community, shared
--kernel-id <KERNEL_ID>
ID of image stored in Glance that should be used as the kernel when booting an AMI-style image.
--os-version <OS_VERSION>
Operating system version as specified by the distributor
--disk-format <DISK_FORMAT>
Format of the disk Valid values: None, ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso, ploop
--os-distro <OS_DISTRO>
Common name of operating system distribution.
--owner <OWNER>
Owner of the image
--ramdisk-id <RAMDISK_ID>
ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image.
--min-ram <MIN_RAM>
Amount of ram (in MB) required to boot image.
--container-format <CONTAINER_FORMAT>
Format of the container Valid values: None, ami, ari, aki, bare, ovf, ova, docker
--property <key=value>
Arbitrary property to associate with image. May be used multiple times.
--remove-property
key Name of arbitrary property to remove from the image.

5.2.12. glance image-upload

usage: glance image-upload [--file <FILE>] [--size <IMAGE_SIZE>] [--progress]
                           <IMAGE_ID>

Upload data for a specific image.

Positional arguments:

<IMAGE_ID>
ID of image to upload data to.

Optional arguments:

--file <FILE>
Local file that contains disk image to be uploaded. Alternatively, images can be passed to the client via stdin.
--size <IMAGE_SIZE>
Size in bytes of image to be uploaded. Default is to get size from provided data object but this is supported in case where size cannot be inferred.
--progress
Show upload progress bar.

5.2.13. glance location-add

usage: glance location-add --url <URL> [--metadata <STRING>] <IMAGE_ID>

Add a location (and related metadata) to an image.

Positional arguments:

<IMAGE_ID>
ID of image to which the location is to be added.

Optional arguments:

--url <URL>
URL of location to add.
--metadata <STRING>
Metadata associated with the location. Must be a valid JSON object (default: {})

5.2.14. glance location-delete

usage: glance location-delete --url <URL> <IMAGE_ID>

Remove locations (and related metadata) from an image.

Positional arguments:

<IMAGE_ID>
ID of image whose locations are to be removed.

Optional arguments:

--url <URL>
URL of location to remove. May be used multiple times.

5.2.15. glance location-update

usage: glance location-update --url <URL> [--metadata <STRING>] <IMAGE_ID>

Update metadata of an image’s location.

Positional arguments:

<IMAGE_ID>
ID of image whose location is to be updated.

Optional arguments:

--url <URL>
URL of location to update.
--metadata <STRING>
Metadata associated with the location. Must be a valid JSON object (default: {})

5.2.16. glance md-namespace-create

usage: glance md-namespace-create [--schema <SCHEMA>]
                                  [--created-at <CREATED_AT>]
                                  [--resource-type-associations <RESOURCE_TYPE_ASSOCIATIONS> [<RESOURCE_TYPE_ASSOCIATIONS> ...]]
                                  [--protected [True|False]] [--self <SELF>]
                                  [--display-name <DISPLAY_NAME>]
                                  [--owner <OWNER>]
                                  [--visibility <VISIBILITY>]
                                  [--updated-at <UPDATED_AT>]
                                  [--description <DESCRIPTION>]
                                  <NAMESPACE>

Create a new metadata definitions namespace.

Positional arguments:

<NAMESPACE>
Name of the namespace.

Optional arguments:

--schema <SCHEMA>

--created-at <CREATED_AT>
Date and time of namespace creation.

--resource-type-associations <RESOURCE_TYPE_ASSOCIATIONS> […​]

--protected [True|False]
If true, namespace will not be deletable.

--self <SELF>

--display-name <DISPLAY_NAME>
The user friendly name for the namespace. Used by UI if available.
--owner <OWNER>
Owner of the namespace.
--visibility <VISIBILITY>
Scope of namespace accessibility. Valid values: public, private
--updated-at <UPDATED_AT>
Date and time of the last namespace modification.
--description <DESCRIPTION>
Provides a user friendly description of the namespace.

5.2.17. glance md-namespace-delete

usage: glance md-namespace-delete <NAMESPACE>

Delete specified metadata definitions namespace with its contents.

Positional arguments:

<NAMESPACE>
Name of namespace to delete.

5.2.18. glance md-namespace-import

usage: glance md-namespace-import [--file <FILEPATH>]

Import a metadata definitions namespace from file or standard input.

Optional arguments:

--file <FILEPATH>
Path to file with namespace schema to import. Alternatively, namespaces schema can be passed to the client via stdin.

5.2.19. glance md-namespace-list

usage: glance md-namespace-list [--resource-types <RESOURCE_TYPES>]
                                [--visibility <VISIBILITY>]
                                [--page-size <SIZE>]

List metadata definitions namespaces.

Optional arguments:

--resource-types <RESOURCE_TYPES>
Resource type to filter namespaces.
--visibility <VISIBILITY>
Visibility parameter to filter namespaces.
--page-size <SIZE>
Number of namespaces to request in each paginated request.

5.2.20. glance md-namespace-objects-delete

usage: glance md-namespace-objects-delete <NAMESPACE>

Delete all metadata definitions objects inside a specific namespace.

Positional arguments:

<NAMESPACE>
Name of namespace.

5.2.21. glance md-namespace-properties-delete

usage: glance md-namespace-properties-delete <NAMESPACE>

Delete all metadata definitions property inside a specific namespace.

Positional arguments:

<NAMESPACE>
Name of namespace.

5.2.22. glance md-namespace-resource-type-list

usage: glance md-namespace-resource-type-list <NAMESPACE>

List resource types associated to specific namespace.

Positional arguments:

<NAMESPACE>
Name of namespace.

5.2.23. glance md-namespace-show

usage: glance md-namespace-show [--resource-type <RESOURCE_TYPE>]
                                [--max-column-width <integer>]
                                <NAMESPACE>

Describe a specific metadata definitions namespace. Lists also the namespace properties, objects and resource type associations.

Positional arguments:

<NAMESPACE>
Name of namespace to describe.

Optional arguments:

--resource-type <RESOURCE_TYPE>
Applies prefix of given resource type associated to a namespace to all properties of a namespace.
--max-column-width <integer>
The max column width of the printed table.

5.2.24. glance md-namespace-tags-delete

usage: glance md-namespace-tags-delete <NAMESPACE>

Delete all metadata definitions tags inside a specific namespace.

Positional arguments:

<NAMESPACE>
Name of namespace.

5.2.25. glance md-namespace-update

usage: glance md-namespace-update [--created-at <CREATED_AT>]
                                  [--protected [True|False]]
                                  [--namespace <NAMESPACE>] [--self <SELF>]
                                  [--display-name <DISPLAY_NAME>]
                                  [--owner <OWNER>]
                                  [--visibility <VISIBILITY>]
                                  [--updated-at <UPDATED_AT>]
                                  [--description <DESCRIPTION>]
                                  <NAMESPACE>

Update an existing metadata definitions namespace.

Positional arguments:

<NAMESPACE>
Name of namespace to update.

Optional arguments:

--created-at <CREATED_AT>
Date and time of namespace creation.
--protected [True|False]
If true, namespace will not be deletable.
--namespace <NAMESPACE>
The unique namespace text.

--self <SELF>

--display-name <DISPLAY_NAME>
The user friendly name for the namespace. Used by UI if available.
--owner <OWNER>
Owner of the namespace.
--visibility <VISIBILITY>
Scope of namespace accessibility. Valid values: public, private
--updated-at <UPDATED_AT>
Date and time of the last namespace modification.
--description <DESCRIPTION>
Provides a user friendly description of the namespace.

5.2.26. glance md-object-create

usage: glance md-object-create --name <NAME> --schema <SCHEMA> <NAMESPACE>

Create a new metadata definitions object inside a namespace.

Positional arguments:

<NAMESPACE>
Name of namespace the object will belong.

Optional arguments:

--name <NAME>
Internal name of an object.
--schema <SCHEMA>
Valid JSON schema of an object.

5.2.27. glance md-object-delete

usage: glance md-object-delete <NAMESPACE> <OBJECT>

Delete a specific metadata definitions object inside a namespace.

Positional arguments:

<NAMESPACE>
Name of namespace the object belongs.
<OBJECT>
Name of an object.

5.2.28. glance md-object-list

usage: glance md-object-list <NAMESPACE>

List metadata definitions objects inside a specific namespace.

Positional arguments:

<NAMESPACE>
Name of namespace.

5.2.29. glance md-object-property-show

usage: glance md-object-property-show [--max-column-width <integer>]
                                      <NAMESPACE> <OBJECT> <PROPERTY>

Describe a specific metadata definitions property inside an object.

Positional arguments:

<NAMESPACE>
Name of namespace the object belongs.
<OBJECT>
Name of an object.
<PROPERTY>
Name of a property.

Optional arguments:

--max-column-width <integer>
The max column width of the printed table.

5.2.30. glance md-object-show

usage: glance md-object-show [--max-column-width <integer>]
                             <NAMESPACE> <OBJECT>

Describe a specific metadata definitions object inside a namespace.

Positional arguments:

<NAMESPACE>
Name of namespace the object belongs.
<OBJECT>
Name of an object.

Optional arguments:

--max-column-width <integer>
The max column width of the printed table.

5.2.31. glance md-object-update

usage: glance md-object-update [--name <NAME>] [--schema <SCHEMA>]
                               <NAMESPACE> <OBJECT>

Update metadata definitions object inside a namespace.

Positional arguments:

<NAMESPACE>
Name of namespace the object belongs.
<OBJECT>
Name of an object.

Optional arguments:

--name <NAME>
New name of an object.
--schema <SCHEMA>
Valid JSON schema of an object.

5.2.32. glance md-property-create

usage: glance md-property-create --name <NAME> --title <TITLE> --schema
                                 <SCHEMA>
                                 <NAMESPACE>

Create a new metadata definitions property inside a namespace.

Positional arguments:

<NAMESPACE>
Name of namespace the property will belong.

Optional arguments:

--name <NAME>
Internal name of a property.
--title <TITLE>
Property name displayed to the user.
--schema <SCHEMA>
Valid JSON schema of a property.

5.2.33. glance md-property-delete

usage: glance md-property-delete <NAMESPACE> <PROPERTY>

Delete a specific metadata definitions property inside a namespace.

Positional arguments:

<NAMESPACE>
Name of namespace the property belongs.
<PROPERTY>
Name of a property.

5.2.34. glance md-property-list

usage: glance md-property-list <NAMESPACE>

List metadata definitions properties inside a specific namespace.

Positional arguments:

<NAMESPACE>
Name of namespace.

5.2.35. glance md-property-show

usage: glance md-property-show [--max-column-width <integer>]
                               <NAMESPACE> <PROPERTY>

Describe a specific metadata definitions property inside a namespace.

Positional arguments:

<NAMESPACE>
Name of namespace the property belongs.
<PROPERTY>
Name of a property.

Optional arguments:

--max-column-width <integer>
The max column width of the printed table.

5.2.36. glance md-property-update

usage: glance md-property-update [--name <NAME>] [--title <TITLE>]
                                 [--schema <SCHEMA>]
                                 <NAMESPACE> <PROPERTY>

Update metadata definitions property inside a namespace.

Positional arguments:

<NAMESPACE>
Name of namespace the property belongs.
<PROPERTY>
Name of a property.

Optional arguments:

--name <NAME>
New name of a property.
--title <TITLE>
Property name displayed to the user.
--schema <SCHEMA>
Valid JSON schema of a property.

5.2.37. glance md-resource-type-associate

usage: glance md-resource-type-associate [--updated-at <UPDATED_AT>]
                                         [--name <NAME>]
                                         [--properties-target <PROPERTIES_TARGET>]
                                         [--prefix <PREFIX>]
                                         [--created-at <CREATED_AT>]
                                         <NAMESPACE>

Associate resource type with a metadata definitions namespace.

Positional arguments:

<NAMESPACE>
Name of namespace.

Optional arguments:

--updated-at <UPDATED_AT>
Date and time of the last resource type association modification.
--name <NAME>
Resource type names should be aligned with Heat resource types whenever possible.
--properties-target <PROPERTIES_TARGET>
Some resource types allow more than one key / value pair per instance. For example, Cinder allows user and image metadata on volumes. Only the image properties metadata is evaluated by Nova (scheduling or drivers). This property allows a namespace target to remove the ambiguity.
--prefix <PREFIX>
Specifies the prefix to use for the given resource type. Any properties in the namespace should be prefixed with this prefix when being applied to the specified resource type. Must include prefix separator (e.g. a colon :).
--created-at <CREATED_AT>
Date and time of resource type association.

5.2.38. glance md-resource-type-deassociate

usage: glance md-resource-type-deassociate <NAMESPACE> <RESOURCE_TYPE>

Deassociate resource type with a metadata definitions namespace.

Positional arguments:

<NAMESPACE>
Name of namespace.
<RESOURCE_TYPE>
Name of resource type.

5.2.39. glance md-resource-type-list

usage: glance md-resource-type-list

List available resource type names.

5.2.40. glance md-tag-create

usage: glance md-tag-create --name <NAME> <NAMESPACE>

Add a new metadata definitions tag inside a namespace.

Positional arguments:

<NAMESPACE>
Name of the namespace the tag will belong to.

Optional arguments:

--name <NAME>
The name of the new tag to add.

5.2.41. glance md-tag-create-multiple

usage: glance md-tag-create-multiple --names <NAMES> [--delim <DELIM>]
                                     <NAMESPACE>

Create new metadata definitions tags inside a namespace.

Positional arguments:

<NAMESPACE>
Name of the namespace the tags will belong to.

Optional arguments:

--names <NAMES>
A comma separated list of tag names.
--delim <DELIM>
The delimiter used to separate the names (if none is provided then the default is a comma).

5.2.42. glance md-tag-delete

usage: glance md-tag-delete <NAMESPACE> <TAG>

Delete a specific metadata definitions tag inside a namespace.

Positional arguments:

<NAMESPACE>
Name of the namespace to which the tag belongs.
<TAG>
Name of the tag.

5.2.43. glance md-tag-list

usage: glance md-tag-list <NAMESPACE>

List metadata definitions tags inside a specific namespace.

Positional arguments:

<NAMESPACE>
Name of namespace.

5.2.44. glance md-tag-show

usage: glance md-tag-show <NAMESPACE> <TAG>

Describe a specific metadata definitions tag inside a namespace.

Positional arguments:

<NAMESPACE>
Name of the namespace to which the tag belongs.
<TAG>
Name of the tag.

5.2.45. glance md-tag-update

usage: glance md-tag-update --name <NAME> <NAMESPACE> <TAG>

Rename a metadata definitions tag inside a namespace.

Positional arguments:

<NAMESPACE>
Name of the namespace to which the tag belongs.
<TAG>
Name of the old tag.

Optional arguments:

--name <NAME>
New name of the new tag.

5.2.46. glance member-create

usage: glance member-create <IMAGE_ID> <MEMBER_ID>

Create member for a given image.

Positional arguments:

<IMAGE_ID>
Image with which to create member.
<MEMBER_ID>
Tenant to add as member.

5.2.47. glance member-delete

usage: glance member-delete <IMAGE_ID> <MEMBER_ID>

Delete image member.

Positional arguments:

<IMAGE_ID>
Image from which to remove member.
<MEMBER_ID>
Tenant to remove as member.

5.2.48. glance member-list

usage: glance member-list --image-id <IMAGE_ID>

Describe sharing permissions by image.

Optional arguments:

--image-id <IMAGE_ID>
Image to display members of.

5.2.49. glance member-update

usage: glance member-update <IMAGE_ID> <MEMBER_ID> <MEMBER_STATUS>

Update the status of a member for a given image.

Positional arguments:

<IMAGE_ID>
Image from which to update member.
<MEMBER_ID>
Tenant to update.
<MEMBER_STATUS>
Updated status of member. Valid Values: accepted, rejected, pending

5.2.50. glance task-create

usage: glance task-create [--type <TYPE>] [--input <STRING>]

Create a new task.

Optional arguments:

--type <TYPE>
Type of Task. Please refer to Glance schema or documentation to see which tasks are supported.
--input <STRING>
Parameters of the task to be launched

5.2.51. glance task-list

usage: glance task-list [--sort-key {id,type,status}] [--sort-dir {asc,desc}]
                        [--page-size <SIZE>] [--type <TYPE>]
                        [--status <STATUS>]

List tasks you can access.

Optional arguments:

--sort-key {id,type,status}
Sort task list by specified field.
--sort-dir {asc,desc}
Sort task list in specified direction.
--page-size <SIZE>
Number of tasks to request in each paginated request.
--type <TYPE>
Filter tasks to those that have this type.
--status <STATUS>
Filter tasks to those that have this status.

5.2.52. glance task-show

usage: glance task-show <TASK_ID>

Describe a specific task.

Positional arguments:

<TASK_ID>
ID of task to describe.

Chapter 6. A time series storage and resources index service (gnocchi) command-line client

The gnocchi client is the command-line interface (CLI) for the A time series storage and resources index service (gnocchi) API and its extensions.

This chapter documents gnocchi version 3.1.1.

For help on a specific gnocchi command, enter:

$ gnocchi help COMMAND

6.1. gnocchi usage

usage: gnocchi [--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>]

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

6.2.1. gnocchi archive-policy create

usage: gnocchi archive-policy create [-h]
                                     [-f {html,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--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

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

6.2.3. gnocchi archive-policy list

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

List archive policies

Optional arguments:

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

6.2.4. gnocchi archive-policy show

usage: gnocchi archive-policy show [-h]
                                   [-f {html,json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--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

6.2.5. gnocchi archive-policy update

usage: gnocchi archive-policy update [-h]
                                     [-f {html,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--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 ':'

6.2.6. gnocchi archive-policy-rule create

usage: gnocchi archive-policy-rule create [-h]
                                          [-f {html,json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--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

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

6.2.8. gnocchi archive-policy-rule list

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

List archive policy rules

Optional arguments:

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

6.2.9. gnocchi archive-policy-rule show

usage: gnocchi archive-policy-rule show [-h]
                                        [-f {html,json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--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

6.2.10. gnocchi benchmark measures add

usage: gnocchi benchmark measures add [-h] [--resource-id RESOURCE_ID]
                                      [-f {html,json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--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

6.2.11. gnocchi benchmark measures show

usage: gnocchi benchmark measures show [-h]
                                       [-f {html,json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--print-empty] [--noindent]
                                       [--prefix PREFIX]
                                       [--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
--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

6.2.12. gnocchi benchmark metric create

usage: gnocchi benchmark metric create [-h] [--resource-id RESOURCE_ID]
                                       [-f {html,json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--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

6.2.13. gnocchi benchmark metric show

usage: gnocchi benchmark metric show [-h] [--resource-id RESOURCE_ID]
                                     [-f {html,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--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

6.2.14. gnocchi capabilities list

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

List capabilities

Optional arguments:

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

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

6.2.16. gnocchi measures aggregation

usage: gnocchi measures aggregation [-h] [-f {csv,html,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--print-empty] [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}] -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
-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'.

6.2.17. gnocchi measures batch-metrics

usage: gnocchi 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

6.2.18. gnocchi measures batch-resources-metrics

usage: gnocchi 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

6.2.19. gnocchi measures show

usage: gnocchi measures show [-h] [-f {csv,html,json,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>]
                             [--print-empty] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--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
--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)

6.2.20. gnocchi metric create

usage: gnocchi metric create [-h] [--resource-id RESOURCE_ID]
                             [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>]
                             [--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

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

6.2.22. gnocchi metric list

usage: gnocchi metric list [-h] [-f {csv,html,json,table,value,yaml}]
                           [-c COLUMN] [--max-width <integer>] [--print-empty]
                           [--noindent]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--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

6.2.23. gnocchi metric show

usage: gnocchi metric show [-h] [-f {html,json,shell,table,value,yaml}]
                           [-c COLUMN] [--max-width <integer>] [--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

6.2.24. gnocchi resource batch delete

usage: gnocchi resource batch delete [-h]
                                     [-f {html,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--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

6.2.25. gnocchi resource create

usage: gnocchi resource create [-h] [-f {html,json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--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

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

6.2.27. gnocchi resource history

usage: gnocchi resource history [-h] [-f {csv,html,json,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--print-empty] [--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

6.2.28. gnocchi resource list

usage: gnocchi resource list [-h] [-f {csv,html,json,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>]
                             [--print-empty] [--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

6.2.29. gnocchi resource show

usage: gnocchi resource show [-h] [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>]
                             [--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

6.2.30. gnocchi resource update

usage: gnocchi resource update [-h] [-f {html,json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--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

6.2.31. gnocchi resource-type create

usage: gnocchi resource-type create [-h]
                                    [-f {html,json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--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

6.2.32. gnocchi resource-type delete

usage: gnocchi 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

6.2.33. gnocchi resource-type list

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

List resource types

Optional arguments:

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

6.2.34. gnocchi resource-type show

usage: gnocchi resource-type show [-h] [-f {html,json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--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

6.2.35. gnocchi resource-type update

usage: gnocchi resource-type update [-h]
                                    [-f {html,json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--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

6.2.36. gnocchi status

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

Show the status of measurements processing

Optional arguments:

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

Chapter 7. Orchestration service (heat) command-line client

Warning

The heat CLI is deprecated in favor of python-openstackclient.

The heat client is the command-line interface (CLI) for the Orchestration service (heat) API and its extensions.

This chapter documents heat version 1.8.0.

For help on a specific heat command, enter:

$ heat help COMMAND

7.1. heat usage

usage: heat [--version] [-d] [-v] [--api-timeout API_TIMEOUT]
            [--os-no-client-auth] [--heat-url HEAT_URL]
            [--heat-api-version HEAT_API_VERSION] [--include-password] [-k]
            [--os-cert OS_CERT] [--cert-file OS_CERT] [--os-key OS_KEY]
            [--key-file OS_KEY] [--os-cacert <ca-certificate-file>]
            [--ca-file OS_CACERT] [--os-username OS_USERNAME]
            [--os-user-id OS_USER_ID] [--os-user-domain-id OS_USER_DOMAIN_ID]
            [--os-user-domain-name OS_USER_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-password OS_PASSWORD] [--os-tenant-id OS_TENANT_ID]
            [--os-tenant-name OS_TENANT_NAME] [--os-auth-url OS_AUTH_URL]
            [--os-region-name OS_REGION_NAME] [--os-auth-token OS_AUTH_TOKEN]
            [--os-service-type OS_SERVICE_TYPE]
            [--os-endpoint-type OS_ENDPOINT_TYPE] [--profile HMAC_KEY]
            <subcommand> ...

Subcommands:

action-check
Check that stack resources are in expected states.
action-resume
Resume the stack.
action-suspend
Suspend the stack.
build-info
Retrieve build information.
config-create
Create a software configuration.
config-delete
Delete the software configuration(s).
config-list
List software configs.
config-show
View details of a software configuration.
deployment-create
Create a software deployment.
deployment-delete
Delete the software deployment(s).
deployment-list
List software deployments.
deployment-metadata-show
Get deployment configuration metadata for the specified server.
deployment-output-show
Show a specific deployment output.
deployment-show
Show the details of a software deployment.
event
DEPRECATED!
event-list
List events for a stack.
event-show
Describe the event.
hook-clear
Clear hooks on a given stack.
hook-poll
List resources with pending hook for a stack.
output-list
Show available outputs.
output-show
Show a specific stack output.
resource-list
Show list of resources belonging to a stack.
resource-mark-unhealthy
Set resource’s health.
resource-metadata
List resource metadata.
resource-show
Describe the resource.
resource-signal
Send a signal to a resource.
resource-template
DEPRECATED!
resource-type-list
List the available resource types.
resource-type-show
Show the resource type.
resource-type-template
Generate a template based on a resource type.
service-list
List the Heat engines.
snapshot-delete
Delete a snapshot of a stack.
snapshot-list
List the snapshots of a stack.
snapshot-show
Show a snapshot of a stack.
stack-abandon
Abandon the stack.
stack-adopt
Adopt a stack.
stack-cancel-update
Cancel currently running update of the stack.
stack-create
Create the stack.
stack-delete
Delete the stack(s).
stack-list
List the user’s stacks.
stack-preview
Preview the stack.
stack-restore
Restore a snapshot of a stack.
stack-show
Describe the stack.
stack-snapshot
Make a snapshot of a stack.
stack-update
Update the stack.
template-function-list
List the available functions.
template-show
Get the template for the specified stack.
template-validate
Validate a template with parameters.
template-version-list
List the available template versions.
bash-completion
Prints all of the commands and options to stdout.
help
Display help about this program or one of its subcommands.

7.2. heat optional arguments

--version
Shows the client version and exits.
-d, --debug
Defaults to env[HEATCLIENT_DEBUG].
-v, --verbose
Print more verbose output.
--api-timeout API_TIMEOUT
Number of seconds to wait for an API response, defaults to system socket timeout
--os-no-client-auth
Do not contact keystone for a token. Defaults to env[OS_NO_CLIENT_AUTH].
--heat-url HEAT_URL
Defaults to env[HEAT_URL].
--heat-api-version HEAT_API_VERSION
Defaults to env[HEAT_API_VERSION] or 1.
--include-password
Send os-username and os-password to heat.
-k, --insecure
Explicitly allow heatclient to perform "insecure SSL" (https) requests. The server’s certificate will not be verified against any certificate authorities. This option should be used with caution.
--os-cert OS_CERT
Path of certificate file to use in SSL connection. This file can optionally be prepended with the private key.
--cert-file OS_CERT
DEPRECATED! Use --os-cert.
--os-key OS_KEY
Path of client key to use in SSL connection. This option is not necessary if your key is prepended to your cert file.
--key-file OS_KEY
DEPRECATED! Use --os-key.
--os-cacert <ca-certificate-file>
Path of CA TLS certificate(s) used to verify the remote server’s certificate. Without this option glance looks for the default system CA certificates.
--ca-file OS_CACERT
DEPRECATED! Use --os-cacert.
--os-username OS_USERNAME
Defaults to env[OS_USERNAME].
--os-user-id OS_USER_ID
Defaults to env[OS_USER_ID].
--os-user-domain-id OS_USER_DOMAIN_ID
Defaults to env[OS_USER_DOMAIN_ID].
--os-user-domain-name OS_USER_DOMAIN_NAME
Defaults to env[OS_USER_DOMAIN_NAME].
--os-project-id OS_PROJECT_ID
Another way to specify tenant ID. This option is mutually exclusive with --os-tenant-id. Defaults to env[OS_PROJECT_ID].
--os-project-name OS_PROJECT_NAME
Another way to specify tenant name. This option is mutually exclusive with --os-tenant-name. Defaults to env[OS_PROJECT_NAME].
--os-project-domain-id OS_PROJECT_DOMAIN_ID
Defaults to env[OS_PROJECT_DOMAIN_ID].
--os-project-domain-name OS_PROJECT_DOMAIN_NAME
Defaults to env[OS_PROJECT_DOMAIN_NAME].
--os-password OS_PASSWORD
Defaults to env[OS_PASSWORD].
--os-tenant-id OS_TENANT_ID
Defaults to env[OS_TENANT_ID].
--os-tenant-name OS_TENANT_NAME
Defaults to env[OS_TENANT_NAME].
--os-auth-url OS_AUTH_URL
Defaults to env[OS_AUTH_URL].
--os-region-name OS_REGION_NAME
Defaults to env[OS_REGION_NAME].
--os-auth-token OS_AUTH_TOKEN
Defaults to env[OS_AUTH_TOKEN].
--os-service-type OS_SERVICE_TYPE
Defaults to env[OS_SERVICE_TYPE].
--os-endpoint-type OS_ENDPOINT_TYPE
Defaults to env[OS_ENDPOINT_TYPE].
--profile HMAC_KEY
HMAC key to use for encrypting context data for performance profiling of operation. This key should be the value of HMAC key configured in osprofiler middleware in heat, it is specified in the paste configuration (/etc/heat/api-paste.ini). Without the key, profiling will not be triggered even if osprofiler is enabled on server side.

7.2.1. heat action-check

usage: heat action-check <NAME or ID>

Check that stack resources are in expected states.

Positional arguments:

<NAME or ID>
Name or ID of stack to check.

7.2.2. heat action-resume

usage: heat action-resume <NAME or ID>

Resume the stack.

Positional arguments:

<NAME or ID>
Name or ID of stack to resume.

7.2.3. heat action-suspend

usage: heat action-suspend <NAME or ID>

Suspend the stack.

Positional arguments:

<NAME or ID>
Name or ID of stack to suspend.

7.2.4. heat build-info

usage: heat build-info

Retrieve build information.

7.2.5. heat config-create

usage: heat config-create [-f <FILE or URL>] [-c <FILE or URL>]
                          [-g <GROUP_NAME>]
                          <CONFIG_NAME>

Create a software configuration.

Positional arguments:

<CONFIG_NAME>
Name of the configuration to create.

Optional arguments:

-f <FILE or URL>, --definition-file <FILE or URL>
Path to JSON/YAML containing map defining <inputs>, <outputs>, and <options>.
-c <FILE or URL>, --config-file <FILE or URL>
Path to configuration script/data.
-g <GROUP_NAME>, --group <GROUP_NAME>
Group name of configuration tool expected by the config.

7.2.6. heat config-delete

usage: heat config-delete <ID> [<ID> ...]

Delete the software configuration(s).

Positional arguments:

<ID>
ID of the configuration(s) to delete.

7.2.7. heat config-list

usage: heat config-list [-l <LIMIT>] [-m <ID>]

List software configs.

Optional arguments:

-l <LIMIT>, --limit <LIMIT>
Limit the number of configs returned.
-m <ID>, --marker <ID>
Return configs that appear after the given config ID.

7.2.8. heat config-show

usage: heat config-show [-c] <ID>

View details of a software configuration.

Positional arguments:

<ID>
ID of the config.

Optional arguments:

-c, --config-only
Only display the value of the <config> property.

7.2.9. heat deployment-create

usage: heat deployment-create [-i <KEY=VALUE>] [-a <ACTION>] [-c <CONFIG>] -s
                              <SERVER> [-t <TRANSPORT>]
                              [--container <CONTAINER_NAME>]
                              [--timeout <TIMEOUT>]
                              <DEPLOY_NAME>

Create a software deployment.

Positional arguments:

<DEPLOY_NAME>
Name of the derived config associated with this deployment. This is used to apply a sort order to the list of configurations currently deployed to the server.

Optional arguments:

-i <KEY=VALUE>, --input-value <KEY=VALUE>
Input value to set on the deployment. This can be specified multiple times.
-a <ACTION>, --action <ACTION>
Name of action for this deployment. Can be a custom action, or one of: CREATE, UPDATE, DELETE, SUSPEND, RESUME
-c <CONFIG>, --config <CONFIG>
ID of the configuration to deploy.
-s <SERVER>, --server <SERVER>
ID of the server being deployed to.
-t <TRANSPORT>, --signal-transport <TRANSPORT>
How the server should signal to heat with the deployment output values. TEMP_URL_SIGNAL will create a Swift TempURL to be signaled via HTTP PUT. NO_SIGNAL will result in the resource going to the COMPLETE state without waiting for any signal.
--container <CONTAINER_NAME>
Optional name of container to store TEMP_URL_SIGNAL objects in. If not specified a container will be created with a name derived from the DEPLOY_NAME
--timeout <TIMEOUT>
Deployment timeout in minutes.

7.2.10. heat deployment-delete

usage: heat deployment-delete <ID> [<ID> ...]

Delete the software deployment(s).

Positional arguments:

<ID>
ID of the deployment(s) to delete.

7.2.11. heat deployment-list

usage: heat deployment-list [-s <SERVER>]

List software deployments.

Optional arguments:

-s <SERVER>, --server <SERVER>
ID of the server to fetch deployments for.

7.2.12. heat deployment-metadata-show

usage: heat deployment-metadata-show <ID>

Get deployment configuration metadata for the specified server.

Positional arguments:

<ID>
ID of the server to fetch deployments for.

7.2.13. heat deployment-output-show

usage: heat deployment-output-show [-a] [-F <FORMAT>] <ID> [<OUTPUT NAME>]

Show a specific deployment output.

Positional arguments:

<ID>
ID deployment to show the output for.
<OUTPUT NAME>
Name of an output to display.

Optional arguments:

-a, --all
Display all deployment outputs.
-F <FORMAT>, --format <FORMAT>
The output value format, one of: raw, json

7.2.14. heat deployment-show

usage: heat deployment-show <ID>

Show the details of a software deployment.

Positional arguments:

<ID>
ID of the deployment.

7.2.15. heat event-list

usage: heat event-list [-r <RESOURCE>] [-f <KEY1=VALUE1;KEY2=VALUE2...>]
                       [-l <LIMIT>] [-m <ID>] [-n <DEPTH>] [-F <FORMAT>]
                       <NAME or ID>

List events for a stack.

Positional arguments:

<NAME or ID>
Name or ID of stack to show the events for.

Optional arguments:

-r <RESOURCE>, --resource <RESOURCE>
Name of the resource to filter events by.
-f <KEY1=VALUE1;KEY2=VALUE2…​>, --filters <KEY1=VALUE1;KEY2=VALUE2…​>
Filter parameters to apply on returned events. This can be specified multiple times, or once with parameters separated by a semicolon.
-l <LIMIT>, --limit <LIMIT>
Limit the number of events returned.
-m <ID>, --marker <ID>
Only return events that appear after the given event ID.
-n <DEPTH>, --nested-depth <DEPTH>
Depth of nested stacks from which to display events. Note this cannot be specified with --resource.
-F <FORMAT>, --format <FORMAT>
The output value format, one of: log, table

7.2.16. heat event-show

usage: heat event-show <NAME or ID> <RESOURCE> <EVENT>

Describe the event.

Positional arguments:

<NAME or ID>
Name or ID of stack to show the events for.
<RESOURCE>
Name of the resource the event belongs to.
<EVENT>
ID of event to display details for.

7.2.17. heat hook-clear

usage: heat hook-clear [--pre-create] [--pre-update] [--pre-delete]
                       <NAME or ID> <RESOURCE> [<RESOURCE> ...]

Clear hooks on a given stack.

Positional arguments:

<NAME or ID>
Name or ID of the stack these resources belong to.
<RESOURCE>
Resource names with hooks to clear. Resources in nested stacks can be set using slash as a separator: nested_stack/another/my_resource. You can use wildcards to match multiple stacks or resources: nested_stack/an*/*_resource

Optional arguments:

--pre-create
Clear the pre-create hooks (optional)
--pre-update
Clear the pre-update hooks (optional)
--pre-delete
Clear the pre-delete hooks (optional)

7.2.18. heat hook-poll

usage: heat hook-poll [-n <DEPTH>] <NAME or ID>

List resources with pending hook for a stack.

Positional arguments:

<NAME or ID>
Name or ID of stack to show the pending hooks for.

Optional arguments:

-n <DEPTH>, --nested-depth <DEPTH>
Depth of nested stacks from which to display hooks.

7.2.19. heat output-list

usage: heat output-list <NAME or ID>

Show available outputs.

Positional arguments:

<NAME or ID>
Name or ID of stack to query.

7.2.20. heat output-show

usage: heat output-show [-F <FORMAT>] [-a] [--with-detail]
                        <NAME or ID> [<OUTPUT NAME>]

Show a specific stack output.

Positional arguments:

<NAME or ID>
Name or ID of stack to query.
<OUTPUT NAME>
Name of an output to display.

Optional arguments:

-F <FORMAT>, --format <FORMAT>
The output value format, one of: json, raw.
-a, --all
Display all stack outputs.
--with-detail
Enable detail information presented, like key and description.

7.2.21. heat resource-list

usage: heat resource-list [-n <DEPTH>] [--with-detail] [-f <KEY=VALUE>]
                          <NAME or ID>

Show list of resources belonging to a stack.

Positional arguments:

<NAME or ID>
Name or ID of stack to show the resources for.

Optional arguments:

-n <DEPTH>, --nested-depth <DEPTH>
Depth of nested stacks from which to display resources.
--with-detail
Enable detail information presented for each resource in resources list.
-f <KEY=VALUE>, --filter <KEY=VALUE>
Filter parameters to apply on returned resources based on their name, status, type, action, id and physical_resource_id. This can be specified multiple times.

7.2.22. heat resource-mark-unhealthy

usage: heat resource-mark-unhealthy [--reset] <NAME or ID> <RESOURCE> [reason]

Set resource’s health.

Positional arguments:

<NAME or ID>
Name or ID of stack the resource belongs to.
<RESOURCE>
Name or physical ID of the resource.
reason
Reason for state change.

Optional arguments:

--reset
Set the resource as healthy.

7.2.23. heat resource-metadata

usage: heat resource-metadata <NAME or ID> <RESOURCE>

List resource metadata.

Positional arguments:

<NAME or ID>
Name or ID of stack to show the resource metadata for.
<RESOURCE>
Name of the resource to show the metadata for.

7.2.24. heat resource-show

usage: heat resource-show [-a <ATTRIBUTE>] <NAME or ID> <RESOURCE>

Describe the resource.

Positional arguments:

<NAME or ID>
Name or ID of stack to show the resource for.
<RESOURCE>
Name of the resource to show the details for.

Optional arguments:

-a <ATTRIBUTE>, --with-attr <ATTRIBUTE>
Attribute to show, it can be specified multiple times.

7.2.25. heat resource-signal

usage: heat resource-signal [-D <DATA>] [-f <FILE>] <NAME or ID> <RESOURCE>

Send a signal to a resource.

Positional arguments:

<NAME or ID>
Name or ID of stack the resource belongs to.
<RESOURCE>
Name of the resource to signal.

Optional arguments:

-D <DATA>, --data <DATA>
JSON Data to send to the signal handler.
-f <FILE>, --data-file <FILE>
File containing JSON data to send to the signal handler.

7.2.26. heat resource-type-list

usage: heat resource-type-list [-f <KEY1=VALUE1;KEY2=VALUE2...>]

List the available resource types.

Optional arguments:

-f <KEY1=VALUE1;KEY2=VALUE2…​>, --filters <KEY1=VALUE1;KEY2=VALUE2…​>
Filter parameters to apply on returned resource types. This can be specified multiple times, or once with parameters separated by a semicolon. It can be any of name, version and support_status

7.2.27. heat resource-type-show

usage: heat resource-type-show <RESOURCE_TYPE>

Show the resource type.

Positional arguments:

<RESOURCE_TYPE>
Resource type to get the details for.

7.2.28. heat resource-type-template

usage: heat resource-type-template [-t <TEMPLATE_TYPE>] [-F <FORMAT>]
                                   <RESOURCE_TYPE>

Generate a template based on a resource type.

Positional arguments:

<RESOURCE_TYPE>
Resource type to generate a template for.

Optional arguments:

-t <TEMPLATE_TYPE>, --template-type <TEMPLATE_TYPE>
Template type to generate, hot or cfn.
-F <FORMAT>, --format <FORMAT>
The template output format, one of: yaml, json.

7.2.29. heat service-list

usage: heat service-list

List the Heat engines.

7.2.30. heat snapshot-delete

usage: heat snapshot-delete <NAME or ID> <SNAPSHOT>

Delete a snapshot of a stack.

Positional arguments:

<NAME or ID>
Name or ID of the stack containing the snapshot.
<SNAPSHOT>
The ID of the snapshot to delete.

7.2.31. heat snapshot-list

usage: heat snapshot-list <NAME or ID>

List the snapshots of a stack.

Positional arguments:

<NAME or ID>
Name or ID of the stack containing the snapshots.

7.2.32. heat snapshot-show

usage: heat snapshot-show <NAME or ID> <SNAPSHOT>

Show a snapshot of a stack.

Positional arguments:

<NAME or ID>
Name or ID of the stack containing the snapshot.
<SNAPSHOT>
The ID of the snapshot to show.

7.2.33. heat stack-abandon

usage: heat stack-abandon [-O <FILE>] <NAME or ID>

Abandon the stack. This will delete the record of the stack from Heat, but will not delete any of the underlying resources. Prints an adoptable JSON representation of the stack to stdout or a file on success.

Positional arguments:

<NAME or ID>
Name or ID of stack to abandon.

Optional arguments:

-O <FILE>, --output-file <FILE>
file to output abandon result. If the option is specified, the result will be output into <FILE>.

7.2.34. heat stack-adopt

usage: heat stack-adopt [-e <FILE or URL>] [-c <TIMEOUT>] [-t <TIMEOUT>]
                        [-a <FILE or URL>] [-r]
                        [-P <KEY1=VALUE1;KEY2=VALUE2...>]
                        <STACK_NAME>

Adopt a stack.

Positional arguments:

<STACK_NAME>
Name of the stack to adopt.

Optional arguments:

-e <FILE or URL>, --environment-file <FILE or URL>
Path to the environment, it can be specified multiple times.
-c <TIMEOUT>, --create-timeout <TIMEOUT>
Stack creation timeout in minutes. DEPRECATED use --timeout instead.
-t <TIMEOUT>, --timeout <TIMEOUT>
Stack creation timeout in minutes.
-a <FILE or URL>, --adopt-file <FILE or URL>
Path to adopt stack data file.
-r, --enable-rollback
Enable rollback on create/update failure.
-P <KEY1=VALUE1;KEY2=VALUE2…​>, --parameters <KEY1=VALUE1;KEY2=VALUE2…​>
Parameter values used to create the stack. This can be specified multiple times, or once with parameters separated by a semicolon.

7.2.35. heat stack-cancel-update

usage: heat stack-cancel-update <NAME or ID>

Cancel currently running update of the stack.

Positional arguments:

<NAME or ID>
Name or ID of stack to cancel update for.

7.2.36. heat stack-create

usage: heat stack-create [-f <FILE>] [-e <FILE or URL>]
                         [--pre-create <RESOURCE>] [-u <URL>] [-o <URL>]
                         [-c <TIMEOUT>] [-t <TIMEOUT>] [-r]
                         [-P <KEY1=VALUE1;KEY2=VALUE2...>] [-Pf <KEY=FILE>]
                         [--poll [SECONDS]] [--tags <TAG1,TAG2>]
                         <STACK_NAME>

Create the stack.

Positional arguments:

<STACK_NAME>
Name of the stack to create.

Optional arguments:

-f <FILE>, --template-file <FILE>
Path to the template.
-e <FILE or URL>, --environment-file <FILE or URL>
Path to the environment, it can be specified multiple times.
--pre-create <RESOURCE>
Name of a resource to set a pre-create hook to. Resources in nested stacks can be set using slash as a separator: nested_stack/another/my_resource. You can use wildcards to match multiple stacks or resources: nested_stack/an*/*_resource. This can be specified multiple times
-u <URL>, --template-url <URL>
URL of template.
-o <URL>, --template-object <URL>
URL to retrieve template object (e.g. from swift).
-c <TIMEOUT>, --create-timeout <TIMEOUT>
Stack creation timeout in minutes. DEPRECATED use --timeout instead.
-t <TIMEOUT>, --timeout <TIMEOUT>
Stack creation timeout in minutes.
-r, --enable-rollback
Enable rollback on create/update failure.
-P <KEY1=VALUE1;KEY2=VALUE2…​>, --parameters <KEY1=VALUE1;KEY2=VALUE2…​>
Parameter values used to create the stack. This can be specified multiple times, or once with parameters separated by a semicolon.
-Pf <KEY=FILE>, --parameter-file <KEY=FILE>
Parameter values from file used to create the stack. This can be specified multiple times. Parameter value would be the content of the file
--poll [SECONDS]
Poll and report events until stack completes. Optional poll interval in seconds can be provided as argument, default 5.
--tags <TAG1,TAG2>
A list of tags to associate with the stack.

7.2.37. heat stack-delete

usage: heat stack-delete [-y] <NAME or ID> [<NAME or ID> ...]

Delete the stack(s).

Positional arguments:

<NAME or ID>
Name or ID of stack(s) to delete.

Optional arguments:

-y, --yes
Skip yes/no prompt (assume yes).

7.2.38. heat stack-list

usage: heat stack-list [-s] [-n] [-a] [-f <KEY1=VALUE1;KEY2=VALUE2...>]
                       [-t <TAG1,TAG2...>] [--tags-any <TAG1,TAG2...>]
                       [--not-tags <TAG1,TAG2...>]
                       [--not-tags-any <TAG1,TAG2...>] [-l <LIMIT>] [-m <ID>]
                       [-k <KEY1;KEY2...>] [-d [asc|desc]] [-g] [-o]

List the user’s stacks.

Optional arguments:

-s, --show-deleted
Include soft-deleted stacks in the stack listing.
-n, --show-nested
Include nested stacks in the stack listing.
-a, --show-hidden
Include hidden stacks in the stack listing.
-f <KEY1=VALUE1;KEY2=VALUE2…​>, --filters <KEY1=VALUE1;KEY2=VALUE2…​>
Filter parameters to apply on returned stacks. This can be specified multiple times, or once with parameters separated by a semicolon.
-t <TAG1,TAG2…​>, --tags <TAG1,TAG2…​>
Show stacks containing these tags. If multiple tags are passed, they will be combined using the AND boolean expression.
--tags-any <TAG1,TAG2…​>
Show stacks containing these tags, If multiple tags are passed, they will be combined using the OR boolean expression.
--not-tags <TAG1,TAG2…​>
Show stacks not containing these tags, If multiple tags are passed, they will be combined using the AND boolean expression.
--not-tags-any <TAG1,TAG2…​>
Show stacks not containing these tags, If multiple tags are passed, they will be combined using the OR boolean expression.
-l <LIMIT>, --limit <LIMIT>
Limit the number of stacks returned.
-m <ID>, --marker <ID>
Only return stacks that appear after the given stack ID.
-k <KEY1;KEY2…​>, --sort-keys <KEY1;KEY2…​>
List of keys for sorting the returned stacks. This can be specified multiple times or once with keys separated by semicolons. Valid sorting keys include "stack_name", "stack_status", "creation_time" and "updated_time".
-d [asc|desc], --sort-dir [asc|desc]
Sorting direction (either "asc" or "desc") for the sorting keys.
-g, --global-tenant
Display stacks from all tenants. Operation only authorized for users who match the policy in heat’s policy.json.
-o, --show-owner
Display stack owner information. This is automatically enabled when using --global-tenant.

7.2.39. heat stack-preview

usage: heat stack-preview [-f <FILE>] [-e <FILE or URL>] [-u <URL>] [-o <URL>]
                          [-t <TIMEOUT>] [-r]
                          [-P <KEY1=VALUE1;KEY2=VALUE2...>] [-Pf <KEY=FILE>]
                          [--tags <TAG1,TAG2>]
                          <STACK_NAME>

Preview the stack.

Positional arguments:

<STACK_NAME>
Name of the stack to preview.

Optional arguments:

-f <FILE>, --template-file <FILE>
Path to the template.
-e <FILE or URL>, --environment-file <FILE or URL>
Path to the environment, it can be specified multiple times.
-u <URL>, --template-url <URL>
URL of template.
-o <URL>, --template-object <URL>
URL to retrieve template object (e.g. from swift)
-t <TIMEOUT>, --timeout <TIMEOUT>
Stack creation timeout in minutes. This is only used during validation in preview.
-r, --enable-rollback
Enable rollback on failure. This option is not used during preview and exists only for symmetry with stack-create.
-P <KEY1=VALUE1;KEY2=VALUE2…​>, --parameters <KEY1=VALUE1;KEY2=VALUE2…​>
Parameter values used to preview the stack. This can be specified multiple times, or once with parameters separated by semicolon.
-Pf <KEY=FILE>, --parameter-file <KEY=FILE>
Parameter values from file used to create the stack. This can be specified multiple times. Parameter value would be the content of the file
--tags <TAG1,TAG2>
A list of tags to associate with the stack.

7.2.40. heat stack-restore

usage: heat stack-restore <NAME or ID> <SNAPSHOT>

Restore a snapshot of a stack.

Positional arguments:

<NAME or ID>
Name or ID of the stack containing the snapshot.
<SNAPSHOT>
The ID of the snapshot to restore.

7.2.41. heat stack-show

usage: heat stack-show [--no-resolve-outputs] <NAME or ID>

Describe the stack.

Positional arguments:

<NAME or ID>
Name or ID of stack to describe.

Optional arguments:

--no-resolve-outputs
Do not resolve outputs of the stack.

7.2.42. heat stack-snapshot

usage: heat stack-snapshot [-n <NAME>] <NAME or ID>

Make a snapshot of a stack.

Positional arguments:

<NAME or ID>
Name or ID of stack to snapshot.

Optional arguments:

-n <NAME>, --name <NAME>
If specified, the name given to the snapshot.

7.2.43. heat stack-update

usage: heat stack-update [-f <FILE>] [-e <FILE or URL>]
                         [--pre-update <RESOURCE>] [-u <URL>] [-o <URL>]
                         [-t <TIMEOUT>] [-r] [--rollback <VALUE>] [-y] [-n]
                         [-P <KEY1=VALUE1;KEY2=VALUE2...>] [-Pf <KEY=FILE>]
                         [-x] [-c <PARAMETER>] [--tags <TAG1,TAG2>]
                         <NAME or ID>

Update the stack.

Positional arguments:

<NAME or ID>
Name or ID of stack to update.

Optional arguments:

-f <FILE>, --template-file <FILE>
Path to the template.
-e <FILE or URL>, --environment-file <FILE or URL>
Path to the environment, it can be specified multiple times.
--pre-update <RESOURCE>
Name of a resource to set a pre-update hook to. Resources in nested stacks can be set using slash as a separator: nested_stack/another/my_resource. You can use wildcards to match multiple stacks or resources: nested_stack/an*/*_resource. This can be specified multiple times
-u <URL>, --template-url <URL>
URL of template.
-o <URL>, --template-object <URL>
URL to retrieve template object (e.g. from swift).
-t <TIMEOUT>, --timeout <TIMEOUT>
Stack update timeout in minutes.
-r, --enable-rollback
DEPRECATED! Use --rollback argument instead. Enable rollback on stack update failure. NOTE: default behavior is now to use the rollback value of existing stack.
--rollback <VALUE>
Set rollback on update failure. Values ('1', 't', 'true', 'on', 'y', 'yes') set rollback to enabled. Values ('0', 'f', 'false', 'off', 'n', 'no') set rollback to disabled. Default is to use the value of existing stack to be updated.
-y, --dry-run
Do not actually perform the stack update, but show what would be changed
-n, --show-nested
Show nested stacks when performing --dry-run
-P <KEY1=VALUE1;KEY2=VALUE2…​>, --parameters <KEY1=VALUE1;KEY2=VALUE2…​>
Parameter values used to create the stack. This can be specified multiple times, or once with parameters separated by a semicolon.
-Pf <KEY=FILE>, --parameter-file <KEY=FILE>
Parameter values from file used to create the stack. This can be specified multiple times. Parameter value would be the content of the file
-x, --existing
Re-use the template, parameters and environment of the current stack. If the template argument is omitted then the existing template is used. If no --environment-file is specified then the existing environment is used. Parameters specified in --parameters will patch over the existing values in the current stack. Parameters omitted will keep the existing values.
-c <PARAMETER>, --clear-parameter <PARAMETER>
Remove the parameters from the set of parameters of current stack for the stack-update. The default value in the template will be used. This can be specified multiple times.
--tags <TAG1,TAG2>
An updated list of tags to associate with the stack.

7.2.44. heat template-function-list

usage: heat template-function-list <TEMPLATE_VERSION>

List the available functions.

Positional arguments:

<TEMPLATE_VERSION>
Template version to get the functions for.

7.2.45. heat template-show

usage: heat template-show <NAME or ID>

Get the template for the specified stack.

Positional arguments:

<NAME or ID>
Name or ID of stack to get the template for.

7.2.46. heat template-validate

usage: heat template-validate [-u <URL>] [-f <FILE>] [-e <FILE or URL>]
                              [-o <URL>] [-n]
                              [-P <KEY1=VALUE1;KEY2=VALUE2...>]
                              [-I <ERR1,ERR2...>]

Validate a template with parameters.

Optional arguments:

-u <URL>, --template-url <URL>
URL of template.
-f <FILE>, --template-file <FILE>
Path to the template.
-e <FILE or URL>, --environment-file <FILE or URL>
Path to the environment, it can be specified multiple times.
-o <URL>, --template-object <URL>
URL to retrieve template object (e.g. from swift).
-n, --show-nested
Resolve parameters from nested templates as well.
-P <KEY1=VALUE1;KEY2=VALUE2…​>, --parameters <KEY1=VALUE1;KEY2=VALUE2…​>
Parameter values for the template. This can be specified multiple times, or once with parameters separated by a semicolon.
-I <ERR1,ERR2…​>, --ignore-errors <ERR1,ERR2…​>
List of heat errors to ignore.

7.2.47. heat template-version-list

usage: heat template-version-list

List the available template versions.

Chapter 8. Bare Metal service (ironic) command-line client

The ironic client is the command-line interface (CLI) for the Bare Metal service (ironic) API and its extensions.

This chapter documents ironic version 1.11.1.

For help on a specific ironic command, enter:

$ ironic help COMMAND

8.1. ironic usage

usage: ironic [--insecure] [--os-cacert <ca-certificate>]
              [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>]
              [--version] [--debug] [--json] [-v] [--cert-file OS_CERT]
              [--key-file OS_KEY] [--ca-file OS_CACERT]
              [--os-username OS_USERNAME] [--os-password OS_PASSWORD]
              [--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME]
              [--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME]
              [--os-auth-token OS_AUTH_TOKEN] [--ironic-url IRONIC_URL]
              [--ironic-api-version IRONIC_API_VERSION]
              [--os-service-type OS_SERVICE_TYPE] [--os-endpoint IRONIC_URL]
              [--os-endpoint-type OS_ENDPOINT_TYPE]
              [--os-user-domain-id OS_USER_DOMAIN_ID]
              [--os-user-domain-name OS_USER_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]
              [--max-retries MAX_RETRIES] [--retry-interval RETRY_INTERVAL]
              <subcommand> ...

Subcommands:

chassis-create
Create a new chassis.
chassis-delete
Delete a chassis.
chassis-list
List the chassis.
chassis-node-list
List the nodes contained in a chassis.
chassis-show
Show detailed information about a chassis.
chassis-update
Update information about a chassis.
node-create
Register a new node with the Ironic service.
node-delete
Unregister node(s) from the Ironic service.
node-get-boot-device
Get the current boot device for a node.
node-get-console
Get the connection information for a node’s console, if enabled.
node-get-supported-boot-devices
Get the supported boot devices for a node.
node-get-vendor-passthru-methods
Get the vendor passthru methods for a node.
node-inject-nmi
Inject NMI to a node.
node-list
List the nodes which are registered with the Ironic service.
node-port-list
List the ports associated with a node.
node-set-boot-device
Set the boot device for a node.
node-set-console-mode
Enable or disable serial console access for a node.
node-set-maintenance
Enable or disable maintenance mode for a node.
node-set-power-state
Power a node on or off or reboot.
node-set-provision-state
Initiate a provisioning state change for a node.
node-set-target-raid-config
Set target RAID config on a node.
node-show
Show detailed information about a node.
node-show-states
Show information about the node’s states.
node-update
Update information about a registered node.
node-validate
Validate a node’s driver interfaces.
node-vendor-passthru
Call a vendor-passthru extension for a node.
node-vif-attach
Attach VIF to a given node.
node-vif-detach
Detach VIF from a given node.
node-vif-list
List VIFs for a given node.
port-create
Create a new port.
port-delete
Delete a port.
port-list
List the ports.
port-show
Show detailed information about a port.
port-update
Update information about a port.
portgroup-create
Create a new portgroup.
portgroup-delete
Delete a portgroup.
portgroup-list
List the portgroups.
portgroup-port-list
List the ports associated with a portgroup.
portgroup-show
Show detailed information about a portgroup.
portgroup-update
Update information about a portgroup.
driver-get-vendor-passthru-methods
Get the vendor passthru methods for a driver.
driver-list
List the enabled drivers.
driver-properties
Get properties of a driver.
driver-raid-logical-disk-properties
Get RAID logical disk properties for a driver.
driver-show
Show information about a driver.
driver-vendor-passthru
Call a vendor-passthru extension for a driver.
create
Create baremetal resources (chassis, nodes, port groups and ports).
bash-completion
Prints all of the commands and options for bash-completion.
help
Display help about this program or one of its subcommands.

8.2. ironic optional arguments

--version
show program’s version number and exit
--debug
Defaults to env[IRONICCLIENT_DEBUG]
--json
Print JSON response without formatting.
-v, --verbose
Print more verbose output
--cert-file OS_CERT
DEPRECATED! Use --os-cert.
--key-file OS_KEY
DEPRECATED! Use --os-key.
--ca-file OS_CACERT
DEPRECATED! Use --os-cacert.
--os-username OS_USERNAME
Defaults to env[OS_USERNAME]
--os-password OS_PASSWORD
Defaults to env[OS_PASSWORD]
--os-tenant-id OS_TENANT_ID
Defaults to env[OS_TENANT_ID]
--os-tenant-name OS_TENANT_NAME
Defaults to env[OS_TENANT_NAME]
--os-auth-url OS_AUTH_URL
Defaults to env[OS_AUTH_URL]
--os-region-name OS_REGION_NAME
Defaults to env[OS_REGION_NAME]
--os-auth-token OS_AUTH_TOKEN
Defaults to env[OS_AUTH_TOKEN]
--ironic-url IRONIC_URL
Defaults to env[IRONIC_URL]
--ironic-api-version IRONIC_API_VERSION
Accepts 1.x (where "x" is microversion) or "latest", Defaults to env[IRONIC_API_VERSION] or 1
--os-service-type OS_SERVICE_TYPE
Defaults to env[OS_SERVICE_TYPE] or "baremetal"
--os-endpoint IRONIC_URL
Specify an endpoint to use instead of retrieving one from the service catalog (via authentication). Defaults to env[OS_SERVICE_ENDPOINT].
--os-endpoint-type OS_ENDPOINT_TYPE
Defaults to env[OS_ENDPOINT_TYPE] or "publicURL"
--os-user-domain-id OS_USER_DOMAIN_ID
Defaults to env[OS_USER_DOMAIN_ID].
--os-user-domain-name OS_USER_DOMAIN_NAME
Defaults to env[OS_USER_DOMAIN_NAME].
--os-project-id OS_PROJECT_ID
Another way to specify tenant ID. This option is mutually exclusive with --os-tenant-id. Defaults to env[OS_PROJECT_ID].
--os-project-name OS_PROJECT_NAME
Another way to specify tenant name. This option is mutually exclusive with --os-tenant-name. Defaults to env[OS_PROJECT_NAME].
--os-project-domain-id OS_PROJECT_DOMAIN_ID
Defaults to env[OS_PROJECT_DOMAIN_ID].
--os-project-domain-name OS_PROJECT_DOMAIN_NAME
Defaults to env[OS_PROJECT_DOMAIN_NAME].
--max-retries MAX_RETRIES
Maximum number of retries in case of conflict error (HTTP 409). Defaults to env[IRONIC_MAX_RETRIES] or 5. Use 0 to disable retrying.
--retry-interval RETRY_INTERVAL
Amount of time (in seconds) between retries in case of conflict error (HTTP 409). Defaults to env[IRONIC_RETRY_INTERVAL] or 2.

8.2.1. ironic chassis-create

usage: ironic chassis-create [-d <description>] [-e <key=value>] [-u <uuid>]

Create a new chassis.

Optional arguments:

-d <description>, --description <description>
Description of the chassis.
-e <key=value>, --extra <key=value>
Record arbitrary key/value metadata. Can be specified multiple times.
-u <uuid>, --uuid <uuid>
UUID of the chassis.

8.2.2. ironic chassis-delete

usage: ironic chassis-delete <chassis> [<chassis> ...]

Delete a chassis.

Positional arguments:

<chassis>
UUID of the chassis.

8.2.3. ironic chassis-list

usage: ironic chassis-list [--detail] [--limit <limit>] [--marker <chassis>]
                           [--sort-key <field>] [--sort-dir <direction>]
                           [--fields <field> [<field> ...]]

List the chassis.

Optional arguments:

--detail
Show detailed information about the chassis.
--limit <limit>
Maximum number of chassis to return per request, 0 for no limit. Default is the maximum number used by the Ironic API Service.
--marker <chassis>
Chassis UUID (for example, of the last chassis in the list from a previous request). Returns the list of chassis after this UUID.
--sort-key <field>
Chassis field that will be used for sorting.
--sort-dir <direction>
Sort direction: "asc" (the default) or "desc".
--fields <field> [<field> …​]
One or more chassis fields. Only these fields will be fetched from the server. Can not be used when '--detail' is specified.

8.2.4. ironic chassis-node-list

usage: ironic chassis-node-list [--detail] [--limit <limit>] [--marker <node>]
                                [--sort-key <field>] [--sort-dir <direction>]
                                [--fields <field> [<field> ...]]
                                [--maintenance <boolean>]
                                [--associated <boolean>]
                                [--provision-state <provision-state>]
                                <chassis>

List the nodes contained in a chassis.

Positional arguments:

<chassis>
UUID of the chassis.

Optional arguments:

--detail
Show detailed information about the nodes.
--limit <limit>
Maximum number of nodes to return per request, 0 for no limit. Default is the maximum number used by the Ironic API Service.
--marker <node>
Node UUID (for example, of the last node in the list from a previous request). Returns the list of nodes after this UUID.
--sort-key <field>
Node field that will be used for sorting.
--sort-dir <direction>
Sort direction: "asc" (the default) or "desc".
--fields <field> [<field> …​]
One or more node fields. Only these fields will be fetched from the server. Can not be used when '--detail' is specified.
--maintenance <boolean>
List nodes in maintenance mode: 'true' or 'false'.
--associated <boolean>
List nodes by instance association: 'true' or 'false'.
--provision-state <provision-state>
List nodes in specified provision state.

8.2.5. ironic chassis-show

usage: ironic chassis-show [--fields <field> [<field> ...]] <chassis>

Show detailed information about a chassis.

Positional arguments:

<chassis>
UUID of the chassis.

Optional arguments:

--fields <field> [<field> …​]
One or more chassis fields. Only these fields will be fetched from the server.

8.2.6. ironic chassis-update

usage: ironic chassis-update <chassis> <op> <path=value> [<path=value> ...]

Update information about a chassis.

Positional arguments:

<chassis>
UUID of the chassis.
<op>
Operation: 'add', 'replace', or 'remove'.
<path=value>
Attribute to add, replace, or remove. Can be specified multiple times. For 'remove', only <path> is necessary.

8.2.7. ironic create

usage: ironic create <file> [<file> ...]

Create baremetal resources (chassis, nodes, port groups and ports). The resources may be described in one or more JSON or YAML files. If any file cannot be validated, no resources are created. An attempt is made to create all the resources; those that could not be created are skipped (with a corresponding error message).

Positional arguments:

<file>
File (.yaml or .json) containing descriptions of the resources to create. Can be specified multiple times.

8.2.8. ironic driver-get-vendor-passthru-methods

usage: ironic driver-get-vendor-passthru-methods <driver>

Get the vendor passthru methods for a driver.

Positional arguments:

<driver>
Name of the driver.

8.2.9. ironic driver-list

usage: ironic driver-list

List the enabled drivers.

8.2.10. ironic driver-properties

usage: ironic driver-properties [--wrap <integer>] <driver>

Get properties of a driver.

Positional arguments:

<driver>
Name of the driver.

Optional arguments:

--wrap <integer>
Wrap the output to a specified length. Positive number can realize wrap functionality. 0 is default for disabled.

8.2.11. ironic driver-raid-logical-disk-properties

usage: ironic driver-raid-logical-disk-properties [--wrap <integer>] <driver>

Get RAID logical disk properties for a driver.

Positional arguments:

<driver>
Name of the driver.

Optional arguments:

--wrap <integer>
Wrap the output to a specified length. Positive number can realize wrap functionality. 0 is default for disabled.

8.2.12. ironic driver-show

usage: ironic driver-show <driver>

Show information about a driver.

Positional arguments:

<driver>
Name of the driver.

8.2.13. ironic driver-vendor-passthru

usage: ironic driver-vendor-passthru [--http-method <http-method>]
                                     <driver> <method>
                                     [<arg=value> [<arg=value> ...]]

Call a vendor-passthru extension for a driver.

Positional arguments:

<driver>
Name of the driver.
<method>
Vendor-passthru method to be called.
<arg=value>
Argument to be passed to the vendor-passthru method. Can be specified multiple times.

Optional arguments:

--http-method <http-method>
The HTTP method to use in the request. Valid HTTP methods are: POST, PUT, GET, DELETE, PATCH. Defaults to 'POST'.

8.2.14. ironic node-create

usage: ironic node-create [-c <chassis>] -d <driver> [-i <key=value>]
                          [-p <key=value>] [-e <key=value>] [-u <uuid>]
                          [-n <name>]
                          [--network-interface <network_interface>]
                          [--resource-class <resource_class>]

Register a new node with the Ironic service.

Optional arguments:

-c <chassis>, --chassis <chassis>
UUID of the chassis that this node belongs to.
-i <key=value>, --driver-info <key=value>
Key/value pair used by the driver, such as out-of-band management credentials. Can be specified multiple times.
-p <key=value>, --properties <key=value>
Key/value pair describing the physical characteristics of the node. This is exported to Nova and used by the scheduler. Can be specified multiple times.
-e <key=value>, --extra <key=value>
Record arbitrary key/value metadata. Can be specified multiple times.
-u <uuid>, --uuid <uuid>
Unique UUID for the node.
-n <name>, --name <name>
Unique name for the node.
--network-interface <network_interface>
Network interface used for switching node to cleaning/provisioning networks.
--resource-class <resource_class>
Resource class for classifying or grouping nodes. Used, for example, to classify nodes in Nova’s placement engine.

Required arguments:

-d <driver>, --driver <driver>
Driver used to control the node.

8.2.15. ironic node-delete

usage: ironic node-delete <node> [<node> ...]

Unregister node(s) from the Ironic service. Returns errors for any nodes that could not be unregistered.

Positional arguments:

<node>
Name or UUID of the node.

8.2.16. ironic node-get-boot-device

usage: ironic node-get-boot-device <node>

Get the current boot device for a node.

Positional arguments:

<node>
Name or UUID of the node.

8.2.17. ironic node-get-console

usage: ironic node-get-console <node>

Get the connection information for a node’s console, if enabled.

Positional arguments:

<node>
Name or UUID of the node.

8.2.18. ironic node-get-supported-boot-devices

usage: ironic node-get-supported-boot-devices <node>

Get the supported boot devices for a node.

Positional arguments:

<node>
Name or UUID of the node.

8.2.19. ironic node-get-vendor-passthru-methods

usage: ironic node-get-vendor-passthru-methods <node>

Get the vendor passthru methods for a node.

Positional arguments:

<node>
Name or UUID of the node.

8.2.20. ironic node-inject-nmi

usage: ironic node-inject-nmi <node>

Inject NMI to a node.

Positional arguments:

<node>
Name or UUID of the node.

8.2.21. ironic node-list

usage: ironic node-list [--limit <limit>] [--marker <node>]
                        [--sort-key <field>] [--sort-dir <direction>]
                        [--maintenance <boolean>] [--associated <boolean>]
                        [--provision-state <provision-state>]
                        [--driver <driver>] [--detail]
                        [--fields <field> [<field> ...]]
                        [--resource-class <resource class>]

List the nodes which are registered with the Ironic service.

Optional arguments:

--limit <limit>
Maximum number of nodes to return per request, 0 for no limit. Default is the maximum number used by the Ironic API Service.
--marker <node>
Node UUID (for example, of the last node in the list from a previous request). Returns the list of nodes after this UUID.
--sort-key <field>
Node field that will be used for sorting.
--sort-dir <direction>
Sort direction: "asc" (the default) or "desc".
--maintenance <boolean>
List nodes in maintenance mode: 'true' or 'false'.
--associated <boolean>
List nodes by instance association: 'true' or 'false'.
--provision-state <provision-state>
List nodes in specified provision state.
--driver <driver>
List nodes using specified driver.
--detail
Show detailed information about the nodes.
--fields <field> [<field> …​]
One or more node fields. Only these fields will be fetched from the server. Can not be used when '--detail' is specified.
--resource-class <resource class>
List nodes using specified resource class.

8.2.22. ironic node-port-list

usage: ironic node-port-list [--detail] [--limit <limit>] [--marker <port>]
                             [--sort-key <field>] [--sort-dir <direction>]
                             [--fields <field> [<field> ...]]
                             <node>

List the ports associated with a node.

Positional arguments:

<node>
Name or UUID of the node.

Optional arguments:

--detail
Show detailed information about the ports.
--limit <limit>
Maximum number of ports to return per request, 0 for no limit. Default is the maximum number used by the Ironic API Service.
--marker <port>
Port UUID (for example, of the last port in the list from a previous request). Returns the list of ports after this UUID.
--sort-key <field>
Port field that will be used for sorting.
--sort-dir <direction>
Sort direction: "asc" (the default) or "desc".
--fields <field> [<field> …​]
One or more port fields. Only these fields will be fetched from the server. Can not be used when '--detail' is specified.

8.2.23. ironic node-set-boot-device

usage: ironic node-set-boot-device [--persistent] <node> <boot-device>

Set the boot device for a node.

Positional arguments:

<node>
Name or UUID of the node.
<boot-device>
One of pxe, disk, cdrom, bios, safe.

Optional arguments:

--persistent
Make changes persistent for all future boots.

8.2.24. ironic node-set-console-mode

usage: ironic node-set-console-mode <node> <enabled>

Enable or disable serial console access for a node.

Positional arguments:

<node>
Name or UUID of the node.
<enabled>
Enable or disable console access for a node: 'true' or 'false'.

8.2.25. ironic node-set-maintenance

usage: ironic node-set-maintenance [--reason <reason>]
                                   <node> <maintenance-mode>

Enable or disable maintenance mode for a node.

Positional arguments:

<node>
Name or UUID of the node.
<maintenance-mode>
'true' or 'false'; 'on' or 'off'.

Optional arguments:

--reason <reason>
Reason for setting maintenance mode to 'true' or 'on'; not valid when setting to 'false' or 'off'.

8.2.26. ironic node-set-power-state

usage: ironic node-set-power-state [--soft] [--power-timeout <power-timeout>]
                                   <node> <power-state>

Power a node on or off or reboot.

Positional arguments:

<node>
Name or UUID of the node.
<power-state>
'on', 'off', or 'reboot'.

Optional arguments:

--soft
Gracefully change the power state. Only valid for 'off' and 'reboot' power states.
--power-timeout <power-timeout>
Timeout (in seconds, positive integer) to wait for the target power state before erroring out.

8.2.27. ironic node-set-provision-state

usage: ironic node-set-provision-state [--config-drive <config-drive>]
                                       [--clean-steps <clean-steps>]
                                       [--wait [WAIT_TIMEOUT]]
                                       <node> <provision-state>

Initiate a provisioning state change for a node.

Positional arguments:

<node>
Name or UUID of the node.
<provision-state>
Supported states: deleted, provide, clean, manage, active, rebuild, inspect, abort, adopt.

Optional arguments:

--config-drive <config-drive>
A gzipped, base64-encoded configuration drive string OR the path to the configuration drive file OR the path to a directory containing the config drive files. In case it’s a directory, a config drive will be generated from it. This argument is only valid when setting provision-state to 'active'.
--clean-steps <clean-steps>
The clean steps in JSON format. May be the path to a file containing the clean steps; OR '-', with the clean steps being read from standard input; OR a string. The value should be a list of clean-step dictionaries; each dictionary should have keys 'interface' and 'step', and optional key 'args'. This argument must be specified (and is only valid) when setting provision-state to 'clean'.
--wait [WAIT_TIMEOUT]
Wait for a node to reach the expected state. Not supported for 'abort'. Optionally takes a timeout in seconds. The default value is 0, meaning no timeout. Fails if the node reaches an unexpected stable state, a failure state or a state with last_error set.

8.2.28. ironic node-set-target-raid-config

usage: ironic node-set-target-raid-config <node> <target-raid-config>

Set target RAID config on a node.

Positional arguments:

<node>
Name or UUID of the node.
<target-raid-config>
A file containing JSON data of the desired RAID configuration. Use '-' to read the contents from standard input. It also accepts the valid json string as input if file/standard input are not used for providing input. The input can be an empty dictionary too which unsets the node.target_raid_config on the node.

8.2.29. ironic node-show

usage: ironic node-show [--instance] [--fields <field> [<field> ...]] <id>

Show detailed information about a node.

Positional arguments:

<id>
Name or UUID of the node (or instance UUID if --instance is specified).

Optional arguments:

--instance <id>
is an instance UUID.
--fields <field> [<field> …​]
One or more node fields. Only these fields will be fetched from the server.

8.2.30. ironic node-show-states

usage: ironic node-show-states <node>

Show information about the node’s states.

Positional arguments:

<node>
Name or UUID of the node.

8.2.31. ironic node-update

usage: ironic node-update <node> <op> <path=value> [<path=value> ...]

Update information about a registered node.

Positional arguments:

<node>
Name or UUID of the node.
<op>
Operation: 'add', 'replace', or 'remove'.
<path=value>
Attribute to add, replace, or remove. Can be specified multiple times. For 'remove', only <path> is necessary. For nested attributes, separate the components with slashes, eg 'driver_info/deploy_kernel=uuid'.

8.2.32. ironic node-validate

usage: ironic node-validate <node>

Validate a node’s driver interfaces.

Positional arguments:

<node>
Name or UUID of the node.

8.2.33. ironic node-vendor-passthru

usage: ironic node-vendor-passthru [--http-method <http-method>]
                                   <node> <method>
                                   [<arg=value> [<arg=value> ...]]

Call a vendor-passthru extension for a node.

Positional arguments:

<node>
Name or UUID of the node.
<method>
Vendor-passthru method to be called.
<arg=value>
Argument to be passed to the vendor-passthru method. Can be specified multiple times.

Optional arguments:

--http-method <http-method>
The HTTP method to use in the request. Valid HTTP methods are: POST, PUT, GET, DELETE, PATCH. Defaults to 'POST'.

8.2.34. ironic node-vif-attach

usage: ironic node-vif-attach [--vif-info <key=value>] <node> <vif-id>

Attach VIF to a given node.

Positional arguments:

<node>
Name or UUID of the node.
<vif-id>
Name or UUID of the VIF to attach to node.

Optional arguments:

--vif-info <key=value>
Record arbitrary key/value metadata. Can be specified multiple times. The mandatory 'id' parameter cannot be specified as a key.

8.2.35. ironic node-vif-detach

usage: ironic node-vif-detach <node> <vif-id>

Detach VIF from a given node.

Positional arguments:

<node>
Name or UUID of the node.
<vif-id>
Name or UUID of the VIF to detach from node.

8.2.36. ironic node-vif-list

usage: ironic node-vif-list <node>

List VIFs for a given node.

Positional arguments:

<node>
Name or UUID of the node.

8.2.37. ironic port-create

usage: ironic port-create -a <address> -n <node> [-l <key=value>]
                          [--portgroup <portgroup>] [--pxe-enabled <boolean>]
                          [-e <key=value>] [-u <uuid>]

Create a new port.

Optional arguments:

-l <key=value>, --local-link-connection <key=value>
Key/value metadata describing Local link connection information. Valid keys are switch_info, switch_id, port_id.Can be specified multiple times.
--portgroup <portgroup>
UUID of the portgroup that this port belongs to.
--pxe-enabled <boolean>
Indicates whether this Port should be used when PXE booting this Node.
-e <key=value>, --extra <key=value>
Record arbitrary key/value metadata. Can be specified multiple times.
-u <uuid>, --uuid <uuid>
UUID of the port.

Required arguments:

-a <address>, --address <address>
MAC address for this port.
-n <node>, --node <node>, --node_uuid <node>
UUID of the node that this port belongs to.

8.2.38. ironic port-delete

usage: ironic port-delete <port> [<port> ...]

Delete a port.

Positional arguments:

<port>
UUID of the port.

8.2.39. ironic port-list

usage: ironic port-list [--detail] [--address <mac-address>] [--limit <limit>]
                        [--marker <port>] [--sort-key <field>]
                        [--sort-dir <direction>]
                        [--fields <field> [<field> ...]]

List the ports.

Optional arguments:

--detail
Show detailed information about ports.
--address <mac-address>
Only show information for the port with this MAC address.
--limit <limit>
Maximum number of ports to return per request, 0 for no limit. Default is the maximum number used by the Ironic API Service.
--marker <port>
Port UUID (for example, of the last port in the list from a previous request). Returns the list of ports after this UUID.
--sort-key <field>
Port field that will be used for sorting.
--sort-dir <direction>
Sort direction: "asc" (the default) or "desc".
--fields <field> [<field> …​]
One or more port fields. Only these fields will be fetched from the server. Can not be used when '--detail' is specified.

8.2.40. ironic port-show

usage: ironic port-show [--address] [--fields <field> [<field> ...]] <id>

Show detailed information about a port.

Positional arguments:

<id>
UUID of the port (or MAC address if --address is specified).

Optional arguments:

--address <id>
is the MAC address (instead of the UUID) of the port.
--fields <field> [<field> …​]
One or more port fields. Only these fields will be fetched from the server.

8.2.41. ironic port-update

usage: ironic port-update <port> <op> <path=value> [<path=value> ...]

Update information about a port.

Positional arguments:

<port>
UUID of the port.
<op>
Operation: 'add', 'replace', or 'remove'.
<path=value>
Attribute to add, replace, or remove. Can be specified multiple times. For 'remove', only <path> is necessary.

8.2.42. ironic portgroup-create

usage: ironic portgroup-create [-a <address>] -n <node> [--name <name>]
                               [-e <key=value>]
                               [--standalone-ports-supported <boolean>]
                               [-u <uuid>] [-m <mode>] [-p <key=value>]

Create a new portgroup.

Optional arguments:

-a <address>, --address <address>
MAC address for this portgroup.
--name <name>
Name for the portgroup.
-e <key=value>, --extra <key=value>
Record arbitrary key/value metadata. Can be specified multiple times.
--standalone-ports-supported <boolean>
Specifies whether ports from this portgroup can be used in stand alone mode.
-u <uuid>, --uuid <uuid>
UUID of the portgroup.
-m <mode>, --mode <mode>
Portgroup mode. For possible values, refer to Kernel documentation.
-p <key=value>, --properties <key=value>
Record key/value properties related to this portgroup’s configuration.

Required arguments:

-n <node>, --node <node>
UUID of the node that this portgroup belongs to.

8.2.43. ironic portgroup-delete

usage: ironic portgroup-delete <portgroup> [<portgroup> ...]

Delete a portgroup.

Positional arguments:

<portgroup>
UUID or Name of the portgroup.

8.2.44. ironic portgroup-list

usage: ironic portgroup-list [--detail] [-n <node>] [-a <mac-address>]
                             [--limit <limit>] [--marker <portgroup>]
                             [--sort-key <field>] [--sort-dir <direction>]
                             [--fields <field> [<field> ...]]

List the portgroups.

Optional arguments:

--detail
Show detailed information about portgroups.
-n <node>, --node <node>
UUID of the node that this portgroup belongs to.
-a <mac-address>, --address <mac-address>
Only show information for the portgroup with this MAC address.
--limit <limit>
Maximum number of portgroups to return per request, 0 for no limit. Default is the maximum number used by the Ironic API Service.
--marker <portgroup>
Portgroup UUID (for example, of the last portgroup in the list from a previous request). Returns the list of portgroups after this UUID.
--sort-key <field>
Portgroup field that will be used for sorting.
--sort-dir <direction>
Sort direction: "asc" (the default) or "desc".
--fields <field> [<field> …​]
One or more portgroup fields. Only these fields will be fetched from the server. Can not be used when '--detail' is specified.

8.2.45. ironic portgroup-port-list

usage: ironic portgroup-port-list [--detail] [--limit <limit>]
                                  [--marker <port>] [--sort-key <field>]
                                  [--sort-dir <direction>]
                                  [--fields <field> [<field> ...]]
                                  <portgroup>

List the ports associated with a portgroup.

Positional arguments:

<portgroup>
Name or UUID of the portgroup.

Optional arguments:

--detail
Show detailed information about the ports.
--limit <limit>
Maximum number of ports to return per request, 0 for no limit. Default is the maximum number used by the Ironic API Service.
--marker <port>
Port UUID (for example, of the last port in the list from a previous request). Returns the list of ports after this UUID.
--sort-key <field>
Port field that will be used for sorting.
--sort-dir <direction>
Sort direction: "asc" (the default) or "desc".
--fields <field> [<field> …​]
One or more port fields. Only these fields will be fetched from the server. Can not be used when '--detail' is specified.

8.2.46. ironic portgroup-show

usage: ironic portgroup-show [--address] [--fields <field> [<field> ...]] <id>

Show detailed information about a portgroup.

Positional arguments:

<id>
Name or UUID of the portgroup (or MAC address if --address is specified).

Optional arguments:

--address <id>
is the MAC address (instead of the UUID) of the portgroup.
--fields <field> [<field> …​]
One or more portgroup fields. Only these fields will be fetched from the server.

8.2.47. ironic portgroup-update

usage: ironic portgroup-update <portgroup> <op> <path=value>
                               [<path=value> ...]

Update information about a portgroup.

Positional arguments:

<portgroup>
UUID or Name of the portgroup.
<op>
Operation: 'add', 'replace', or 'remove'.
<path=value>
Attribute to add, replace, or remove. Can be specified multiple times. For 'remove', only <path> is necessary.

Chapter 9. Shared File Systems service (manila) command-line client

The manila client is the command-line interface (CLI) for the Shared File Systems service (manila) API and its extensions.

This chapter documents manila version 1.14.0.

For help on a specific manila command, enter:

$ manila help COMMAND

9.1. manila usage

usage: manila [--version] [-d] [--os-cache] [--os-reset-cache]
              [--os-user-id <auth-user-id>] [--os-username <auth-user-name>]
              [--os-password <auth-password>]
              [--os-tenant-name <auth-tenant-name>]
              [--os-project-name <auth-project-name>]
              [--os-tenant-id <auth-tenant-id>]
              [--os-project-id <auth-project-id>]
              [--os-user-domain-id <auth-user-domain-id>]
              [--os-user-domain-name <auth-user-domain-name>]
              [--os-project-domain-id <auth-project-domain-id>]
              [--os-project-domain-name <auth-project-domain-name>]
              [--os-auth-url <auth-url>] [--os-region-name <region-name>]
              [--os-token <token>] [--bypass-url <bypass-url>]
              [--service-type <service-type>] [--service-name <service-name>]
              [--share-service-name <share-service-name>]
              [--endpoint-type <endpoint-type>]
              [--os-share-api-version <share-api-ver>]
              [--os-cacert <ca-certificate>] [--retries <retries>]
              [--os-cert <certificate>]
              <subcommand> ...

Subcommands:

absolute-limits
Print a list of absolute limits for a user.
access-allow
Allow access to the share.
access-deny
Deny access to a share.
access-list
Show access list for share.
api-version
Display the API version information.
availability-zone-list
List all availability zones.
create
Creates a new share (NFS, CIFS, CephFS, GlusterFS or HDFS).
credentials
Show user credentials returned from auth.
delete
Remove one or more shares.
endpoints
Discover endpoints that get returned from the authenticate services.
extend
Increases the size of an existing share.
extra-specs-list
Print a list of current 'share types and extra specs' (Admin Only).
force-delete
Attempt force-delete of share, regardless of state (Admin only).
list
List NAS shares with filters.
manage
Manage share not handled by Manila (Admin only).
metadata
Set or delete metadata on a share.
metadata-show
Show metadata of given share.
metadata-update-all
Update all metadata of a share.
migration-cancel
Cancels migration of a given share when copying (Admin only, Experimental).
migration-complete
Completes migration for a given share (Admin only, Experimental).
migration-get-progress
Gets migration progress of a given share when copying (Admin only, Experimental).
migration-start
Migrates share to a new host (Admin only, Experimental).
pool-list
List all backend storage pools known to the scheduler (Admin only).
quota-class-show
List the quotas for a quota class.
quota-class-update
Update the quotas for a quota class (Admin only).
quota-defaults
List the default quotas for a tenant.
quota-delete
Delete quota for a tenant/user. The quota will revert back to default (Admin only).
quota-show
List the quotas for a tenant/user.
quota-update
Update the quotas for a tenant/user (Admin only).
rate-limits
Print a list of rate limits for a user.
reset-state
Explicitly update the state of a share (Admin only).
reset-task-state
Explicitly update the task state of a share (Admin only, Experimental).
revert-to-snapshot
Revert a share to the specified snapshot.
security-service-create
Create security service used by tenant.
security-service-delete
Delete one or more security services.
security-service-list
Get a list of security services.
security-service-show
Show security service.
security-service-update
Update security service.
service-disable
Disables 'manila-share' or 'manila-scheduler' services (Admin only).
service-enable
Enables 'manila-share' or 'manila-scheduler' services (Admin only).
service-list
List all services (Admin only).
share-export-location-list
List export locations of a given share.
share-export-location-show
Show export location of the share.
share-group-create
Creates a new share group (Experimental).
share-group-delete
Remove one or more share groups (Experimental).
share-group-list
List share groups with filters (Experimental).
share-group-reset-state
Explicitly update the state of a share group (Admin only, Experimental).
share-group-show
Show details about a share group (Experimental).
share-group-snapshot-create
Creates a new share group snapshot (Experimental).
share-group-snapshot-delete
Remove one or more share group snapshots (Experimental).
share-group-snapshot-list
List share group snapshots with filters (Experimental).
share-group-snapshot-list-members
List members of a share group snapshot (Experimental).
share-group-snapshot-reset-state
Explicitly update the state of a share group snapshot (Admin only, Experimental).
share-group-snapshot-show
Show details about a share group snapshot (Experimental).
share-group-snapshot-update
Update a share group snapshot (Experimental).
share-group-type-access-add
Adds share group type access for the given project (Admin only).
share-group-type-access-list
Print access information about a share group type (Admin only).
share-group-type-access-remove
Removes share group type access for the given project (Admin only).
share-group-type-create
Create a new share group type (Admin only).
share-group-type-delete
Delete a specific share group type (Admin only).
share-group-type-key
Set or unset group_spec for a share group type (Admin only).
share-group-type-list
Print a list of available 'share group types'.
share-group-type-specs-list
Print a list of 'share group types specs' (Admin Only).
share-group-update
Update a share group (Experimental).
share-instance-export-location-list
List export locations of a given share instance.
share-instance-export-location-show
Show export location for the share instance.
share-instance-force-delete
Force-delete the share instance, regardless of state (Admin only).
share-instance-list
List share instances (Admin only).
share-instance-reset-state
Explicitly update the state of a share instance (Admin only).
share-instance-show
Show details about a share instance (Admin only).
share-network-create
Create description for network used by the tenant.
share-network-delete
Delete one or more share networks.
share-network-list
Get a list of network info.
share-network-security-service-add
Associate security service with share network.
share-network-security-service-list
Get list of security services associated with a given share network.
share-network-security-service-remove
Dissociate security service from share network.
share-network-show
Get a description for network used by the tenant.
share-network-update
Update share network data.
share-replica-create
Create a share replica (Experimental).
share-replica-delete
Remove one or more share replicas (Experimental).
share-replica-list
List share replicas (Experimental).
share-replica-promote
Promote specified replica to 'active' replica_state (Experimental).
share-replica-reset-replica-state
Explicitly update the 'replica_state' of a share replica (Experimental).
share-replica-reset-state
Explicitly update the 'status' of a share replica (Experimental).
share-replica-resync
Attempt to update the share replica with its 'active' mirror (Experimental).
share-replica-show
Show details about a replica (Experimental).
share-server-delete
Delete one or more share servers (Admin only).
share-server-details
Show share server details (Admin only).
share-server-list
List all share servers (Admin only).
share-server-show
Show share server info (Admin only).
show
Show details about a NAS share.
shrink
Decreases the size of an existing share.
snapshot-access-allow
Allow read only access to a snapshot.
snapshot-access-deny
Deny access to a snapshot.
snapshot-access-list
Show access list for a snapshot.
snapshot-create
Add a new snapshot.
snapshot-delete
Remove one or more snapshots.
snapshot-export-location-list
List export locations of a given snapshot.
snapshot-export-location-show
Show export location of the share snapshot.
snapshot-force-delete
Attempt force-deletion of one or more snapshots. Regardless of the state (Admin only).
snapshot-instance-export-location-list
List export locations of a given snapshot instance.
snapshot-instance-export-location-show
Show export location of the share instance snapshot.
snapshot-instance-list
List share snapshot instances.
snapshot-instance-reset-state
Explicitly update the state of a share snapshot instance.
snapshot-instance-show
Show details about a share snapshot instance.
snapshot-list
List all the snapshots.
snapshot-manage
Manage share snapshot not handled by Manila (Admin only).
snapshot-rename
Rename a snapshot.
snapshot-reset-state
Explicitly update the state of a snapshot (Admin only).
snapshot-show
Show details about a snapshot.
snapshot-unmanage
Unmanage one or more share snapshots (Admin only).
type-access-add
Adds share type access for the given project (Admin only).
type-access-list
Print access information about the given share type (Admin only).
type-access-remove
Removes share type access for the given project (Admin only).
type-create
Create a new share type (Admin only).
type-delete
Delete one or more specific share types (Admin only).
type-key
Set or unset extra_spec for a share type (Admin only).
type-list
Print a list of available 'share types'.
unmanage
Unmanage share (Admin only).
update
Rename a share.
bash-completion
Print arguments for bash_completion. Prints all of the commands and options to stdout so that the manila.bash_completion script doesn’t have to hard code them.
help
Display help about this program or one of its subcommands.
list-extensions
List all the os-api extensions that are available.

9.2. manila optional arguments

--version
show program’s version number and exit
-d, --debug
Print debugging output.
--os-cache
Use the auth token cache. Defaults to env[OS_CACHE].
--os-reset-cache
Delete cached password and auth token.
--os-user-id <auth-user-id>
Defaults to env [OS_USER_ID].
--os-username <auth-user-name>
Defaults to env[OS_USERNAME].
--os-password <auth-password>
Defaults to env[OS_PASSWORD].
--os-tenant-name <auth-tenant-name>
Defaults to env[OS_TENANT_NAME].
--os-project-name <auth-project-name>
Another way to specify tenant name. This option is mutually exclusive with --os-tenant-name. Defaults to env[OS_PROJECT_NAME].
--os-tenant-id <auth-tenant-id>
Defaults to env[OS_TENANT_ID].
--os-project-id <auth-project-id>
Another way to specify tenant ID. This option is mutually exclusive with --os-tenant-id. Defaults to env[OS_PROJECT_ID].
--os-user-domain-id <auth-user-domain-id>
OpenStack user domain ID. Defaults to env[OS_USER_DOMAIN_ID].
--os-user-domain-name <auth-user-domain-name>
OpenStack user domain name. Defaults to env[OS_USER_DOMAIN_NAME].
--os-project-domain-id <auth-project-domain-id>
Defaults to env[OS_PROJECT_DOMAIN_ID].
--os-project-domain-name <auth-project-domain-name>
Defaults to env[OS_PROJECT_DOMAIN_NAME].
--os-auth-url <auth-url>
Defaults to env[OS_AUTH_URL].
--os-region-name <region-name>
Defaults to env[OS_REGION_NAME].
--os-token <token>
Defaults to env[OS_TOKEN].
--bypass-url <bypass-url>
Use this API endpoint instead of the Service Catalog. Defaults to env[OS_MANILA_BYPASS_URL].
--service-type <service-type>
Defaults to compute for most actions.
--service-name <service-name>
Defaults to env[OS_MANILA_SERVICE_NAME].
--share-service-name <share-service-name>
Defaults to env[OS_MANILA_SHARE_SERVICE_NAME].
--endpoint-type <endpoint-type>
Defaults to env[OS_MANILA_ENDPOINT_TYPE] or publicURL.
--os-share-api-version <share-api-ver>
Accepts 1.x to override default to env[OS_SHARE_API_VERSION].
--os-cacert <ca-certificate>
Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to env[OS_CACERT].
--retries <retries>
Number of retries.
--os-cert <certificate>
Defaults to env[OS_CERT].

9.2.1. manila absolute-limits

usage: manila absolute-limits

Print a list of absolute limits for a user.

9.2.2. manila access-allow

usage: manila access-allow [--access-level <access_level>]
                           <share> <access_type> <access_to>

Allow access to the share.

Positional arguments:

<share>
Name or ID of the NAS share to modify.
<access_type>
Access rule type (only "ip", "user"(user or group), "cert" or "cephx" are supported).
<access_to>
Value that defines access.

Optional arguments:

--access-level <access_level>, --access_level <access_level>
Share access level ("rw" and "ro" access levels are supported). Defaults to rw.

9.2.3. manila access-deny

usage: manila access-deny <share> <id>

Deny access to a share.

Positional arguments:

<share>
Name or ID of the NAS share to modify.
<id>
ID of the access rule to be deleted.

9.2.4. manila access-list

usage: manila access-list [--columns <columns>] <share>

Show access list for share.

Positional arguments:

<share>
Name or ID of the share.

Optional arguments:

--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "access_type,access_to"

9.2.5. manila api-version

usage: manila api-version

Display the API version information.

9.2.6. manila availability-zone-list

usage: manila availability-zone-list [--columns <columns>]

List all availability zones.

Optional arguments:

--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id,name"

9.2.7. manila create

usage: manila create [--snapshot-id <snapshot-id>] [--name <name>]
                     [--metadata [<key=value> [<key=value> ...]]]
                     [--share-network <network-info>]
                     [--description <description>] [--share-type <share-type>]
                     [--public] [--availability-zone <availability-zone>]
                     [--share-group <share-group>]
                     <share_protocol> <size>

Creates a new share (NFS, CIFS, CephFS, GlusterFS or HDFS).

Positional arguments:

<share_protocol>
Share protocol (NFS, CIFS, CephFS, GlusterFS or HDFS).
<size>
Share size in GiB.

Optional arguments:

--snapshot-id <snapshot-id>, --snapshot_id <snapshot-id>
Optional snapshot ID to create the share from. (Default=None)
--name <name>
Optional share name. (Default=None)
--metadata [<key=value> [<key=value> …​]]
Metadata key=value pairs (Optional, Default=None).
--share-network <network-info>, --share_network <network-info>
Optional network info ID or name.
--description <description>
Optional share description. (Default=None)
--share-type <share-type>, --share_type <share-type>, --volume-type <share-type>, --volume_type <share-type>
Optional share type. Use of optional volume type is deprecated(Default=None)
--public
Level of visibility for share. Defines whether other tenants are able to see it or not.
--availability-zone <availability-zone>, --availability_zone <availability-zone>, --az <availability-zone>
Availability zone in which share should be created.
--share-group <share-group>, --share_group <share-group>, --group <share-group>
Optional share group name or ID in which to create the share (Experimental, Default=None).

9.2.8. manila credentials

usage: manila credentials

Show user credentials returned from auth.

9.2.9. manila delete

usage: manila delete [--share-group <share-group>] <share> [<share> ...]

Remove one or more shares.

Positional arguments:

<share>
Name or ID of the share(s).

Optional arguments:

--share-group <share-group>, --share_group <share-group>, --group <share-group>
Optional share group name or ID which contains the share (Experimental, Default=None).

9.2.10. manila endpoints

usage: manila endpoints

Discover endpoints that get returned from the authenticate services.

9.2.11. manila extend

usage: manila extend <share> <new_size>

Increases the size of an existing share.

Positional arguments:

<share>
Name or ID of share to extend.
<new_size>
New size of share, in GiBs.

9.2.12. manila extra-specs-list

usage: manila extra-specs-list [--columns <columns>]

Print a list of current 'share types and extra specs' (Admin Only).

Optional arguments:

--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id,name"

9.2.13. manila force-delete

usage: manila force-delete <share> [<share> ...]

Attempt force-delete of share, regardless of state (Admin only).

Positional arguments:

<share>
Name or ID of the share(s) to force delete.

9.2.14. manila list

usage: manila list [--all-tenants [<0|1>]] [--name <name>] [--status <status>]
                   [--share-server-id <share_server_id>]
                   [--metadata [<key=value> [<key=value> ...]]]
                   [--extra-specs [<key=value> [<key=value> ...]]]
                   [--share-type <share_type>] [--limit <limit>]
                   [--offset <offset>] [--sort-key <sort_key>]
                   [--sort-dir <sort_dir>] [--snapshot <snapshot>]
                   [--host <host>] [--share-network <share_network>]
                   [--project-id <project_id>] [--public]
                   [--share-group <share_group>] [--columns <columns>]

List NAS shares with filters.

Optional arguments:

--all-tenants [<0|1>]
Display information from all tenants (Admin only).
--name <name>
Filter results by name.
--status <status>
Filter results by status.
--share-server-id <share_server_id>, --share-server_id <share_server_id>, --share_server-id <share_server_id>, --share_server_id <share_server_id>
Filter results by share server ID (Admin only).
--metadata [<key=value> [<key=value> …​]]
Filters results by a metadata key and value. OPTIONAL: Default=None
--extra-specs [<key=value> [<key=value> …​]], --extra_specs [<key=value> [<key=value> …​]]
Filters results by a extra specs key and value of share type that was used for share creation. OPTIONAL: Default=None
--share-type <share_type>, --volume-type <share_type>, --share_type <share_type>, --share-type-id <share_type>, --volume-type-id <share_type>, --share-type_id <share_type>, --share_type-id <share_type>, --share_type_id <share_type>, --volume_type <share_type>, --volume_type_id <share_type>
Filter results by a share type id or name that was used for share creation.
--limit <limit>
Maximum number of shares to return. OPTIONAL: Default=None.
--offset <offset>
Set offset to define start point of share listing. OPTIONAL: Default=None.
--sort-key <sort_key>, --sort_key <sort_key>
Key to be sorted, available keys are ('id', 'status', 'size', 'host', 'share_proto', 'export_location', 'availability_zone', 'user_id', 'project_id', 'created_at', 'updated_at', 'display_name', 'name', 'share_type_id', 'share_type', 'share_network_id', 'share_network', 'snapshot_id', 'snapshot'). OPTIONAL: Default=None.
--sort-dir <sort_dir>, --sort_dir <sort_dir>
Sort direction, available values are ('asc', 'desc'). OPTIONAL: Default=None.
--snapshot <snapshot>
Filer results by snapshot name or id, that was used for share.
--host <host>
Filter results by host.
--share-network <share_network>, --share_network <share_network>
Filter results by share-network name or id.
--project-id <project_id>, --project_id <project_id>
Filter results by project id. Useful with set key '--all-tenants'.
--public
Add public shares from all tenants to result.
--share-group <share_group>, --share_group <share_group>, --group <share_group>
Filter results by share group name or ID (Experimental, Default=None).
--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "export_location,is public"

9.2.15. manila list-extensions

usage: manila list-extensions

List all the os-api extensions that are available.

9.2.16. manila manage

usage: manila manage [--name <name>] [--description <description>]
                     [--share_type <share-type>]
                     [--driver_options [<key=value> [<key=value> ...]]]
                     [--public]
                     <service_host> <protocol> <export_path>

Manage share not handled by Manila (Admin only).

Positional arguments:

<service_host>
manage-share service host: some.host@driver#pool
<protocol>
Protocol of the share to manage, such as NFS or CIFS.
<export_path>
Share export path, NFS share such as: 10.0.0.1:/example_path, CIFS share such as: \\10.0.0.1\example_cifs_share

Optional arguments:

--name <name>
Optional share name. (Default=None)
--description <description>
Optional share description. (Default=None)
--share_type <share-type>, --share-type <share-type>
Optional share type assigned to share. (Default=None)
--driver_options [<key=value> [<key=value> …​]], --driver-options [<key=value> [<key=value> …​]]
Driver option key=value pairs (Optional, Default=None).
--public
Level of visibility for share. Defines whether other tenants are able to see it or not. Available only for microversion >= 2.8

9.2.17. manila metadata

usage: manila metadata <share> <action> <key=value> [<key=value> ...]

Set or delete metadata on a share.

Positional arguments:

<share>
Name or ID of the share to update metadata on.
<action>
Actions: 'set' or 'unset'.
<key=value>
Metadata to set or unset (key is only necessary on unset).

9.2.18. manila metadata-show

usage: manila metadata-show <share>

Show metadata of given share.

Positional arguments:

<share>
Name or ID of the share.

9.2.19. manila metadata-update-all

usage: manila metadata-update-all <share> <key=value> [<key=value> ...]

Update all metadata of a share.

Positional arguments:

<share>
Name or ID of the share to update metadata on.
<key=value>
Metadata entry or entries to update.

9.2.20. manila migration-cancel

usage: manila migration-cancel <share>

Cancels migration of a given share when copying (Admin only, Experimental).

Positional arguments:

<share>
Name or ID of share to cancel migration.

9.2.21. manila migration-complete

usage: manila migration-complete <share>

Completes migration for a given share (Admin only, Experimental).

Positional arguments:

<share>
Name or ID of share to complete migration.

9.2.22. manila migration-get-progress

usage: manila migration-get-progress <share>

Gets migration progress of a given share when copying (Admin only, Experimental).

Positional arguments:

<share>
Name or ID of the share to get share migration progress information.

9.2.23. manila migration-start

usage: manila migration-start [--force_host_assisted_migration <True|False>]
                              --preserve-metadata <True|False>
                              --preserve-snapshots <True|False> --writable
                              <True|False> --nondisruptive <True|False>
                              [--new_share_network <new_share_network>]
                              [--new_share_type <new_share_type>]
                              <share> <host@backend#pool>

Migrates share to a new host (Admin only, Experimental).

Positional arguments:

<share>
Name or ID of share to migrate.
<host@backend#pool>
Destination host where share will be migrated to. Use the format 'host@backend#pool'.

Optional arguments:

--force_host_assisted_migration <True|False>, --force-host-assisted-migration <True|False>
Enforces the use of the host-assisted migration approach, which bypasses driver optimizations. Default=False.
--preserve-metadata <True|False>, --preserve_metadata <True|False>
Enforces migration to preserve all file metadata when moving its contents. If set to True, host-assisted migration will not be attempted.
--preserve-snapshots <True|False>, --preserve_snapshots <True|False>
Enforces migration of the share snapshots to the destination. If set to True, host-assisted migration will not be attempted.
--writable <True|False>
Enforces migration to keep the share writable while contents are being moved. If set to True, host-assisted migration will not be attempted.
--nondisruptive <True|False>
Enforces migration to be nondisruptive. If set to True, host-assisted migration will not be attempted.
--new_share_network <new_share_network>, --new-share-network <new_share_network>
Specify the new share network for the share. Do not specify this parameter if the migrating share has to be retained within its current share network.
--new_share_type <new_share_type>, --new-share-type <new_share_type>
Specify the new share type for the share. Do not specify this parameter if the migrating share has to be retained with its current share type.

9.2.24. manila pool-list

usage: manila pool-list [--host <host>] [--backend <backend>] [--pool <pool>]
                        [--columns <columns>] [--detail]
                        [--share-type <share_type>]

List all backend storage pools known to the scheduler (Admin only).

Optional arguments:

--host <host>
Filter results by host name. Regular expressions are supported.
--backend <backend>
Filter results by backend name. Regular expressions are supported.
--pool <pool>
Filter results by pool name. Regular expressions are supported.
--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "name,host"
--detail, --detailed
Show detailed information about pools. (Default=False)
--share-type <share_type>, --share_type <share_type>, --share-type-id <share_type>, --share_type_id <share_type>
Filter results by share type name or ID. (Default=None)Available only for microversion >= 2.23

9.2.25. manila quota-class-show

usage: manila quota-class-show <class>

List the quotas for a quota class.

Positional arguments:

<class>
Name of quota class to list the quotas for.

9.2.26. manila quota-class-update

usage: manila quota-class-update [--shares <shares>] [--snapshots <snapshots>]
                                 [--gigabytes <gigabytes>]
                                 [--snapshot-gigabytes <snapshot_gigabytes>]
                                 [--share-networks <share-networks>]
                                 <class-name>

Update the quotas for a quota class (Admin only).

Positional arguments:

<class-name>
Name of quota class to set the quotas for.

Optional arguments:

--shares <shares>
New value for the "shares" quota.
--snapshots <snapshots>
New value for the "snapshots" quota.
--gigabytes <gigabytes>
New value for the "gigabytes" quota.
--snapshot-gigabytes <snapshot_gigabytes>, --snapshot_gigabytes <snapshot_gigabytes>
New value for the "snapshot_gigabytes" quota.
--share-networks <share-networks>, --share_networks <share-networks>
New value for the "share_networks" quota.

9.2.27. manila quota-defaults

usage: manila quota-defaults [--tenant <tenant-id>]

List the default quotas for a tenant.

Optional arguments:

--tenant <tenant-id>
ID of tenant to list the default quotas for.

9.2.28. manila quota-delete

usage: manila quota-delete [--tenant <tenant-id>] [--user <user-id>]

Delete quota for a tenant/user. The quota will revert back to default (Admin only).

Optional arguments:

--tenant <tenant-id>
ID of tenant to delete quota for.
--user <user-id>
ID of user to delete quota for.

9.2.29. manila quota-show

usage: manila quota-show [--tenant <tenant-id>] [--user <user-id>] [--detail]

List the quotas for a tenant/user.

Optional arguments:

--tenant <tenant-id>
ID of tenant to list the quotas for.
--user <user-id>
ID of user to list the quotas for.
--detail
Optional flag to indicate whether to show quota in detail. Default false, available only for microversion >= 2.25.

9.2.30. manila quota-update

usage: manila quota-update [--user <user-id>] [--shares <shares>]
                           [--snapshots <snapshots>] [--gigabytes <gigabytes>]
                           [--snapshot-gigabytes <snapshot_gigabytes>]
                           [--share-networks <share-networks>] [--force]
                           <tenant_id>

Update the quotas for a tenant/user (Admin only).

Positional arguments:

<tenant_id>
UUID of tenant to set the quotas for.

Optional arguments:

--user <user-id>
ID of user to set the quotas for.
--shares <shares>
New value for the "shares" quota.
--snapshots <snapshots>
New value for the "snapshots" quota.
--gigabytes <gigabytes>
New value for the "gigabytes" quota.
--snapshot-gigabytes <snapshot_gigabytes>, --snapshot_gigabytes <snapshot_gigabytes>
New value for the "snapshot_gigabytes" quota.
--share-networks <share-networks>, --share_networks <share-networks>
New value for the "share_networks" quota.
--force
Whether force update the quota even if the already used and reserved exceeds the new quota.

9.2.31. manila rate-limits

usage: manila rate-limits [--columns <columns>]

Print a list of rate limits for a user.

Optional arguments:

--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "verb,uri,value"

9.2.32. manila reset-state

usage: manila reset-state [--state <state>] <share>

Explicitly update the state of a share (Admin only).

Positional arguments:

<share>
Name or ID of the share to modify.

Optional arguments:

--state <state>
Indicate which state to assign the share. Options include available, error, creating, deleting, error_deleting. If no state is provided, available will be used.

9.2.33. manila reset-task-state

usage: manila reset-task-state [--task-state <task_state>] <share>

Explicitly update the task state of a share (Admin only, Experimental).

Positional arguments:

<share>
Name or ID of the share to modify.

Optional arguments:

--task-state <task_state>, --task_state <task_state>, --state <task_state>
Indicate which task state to assign the share. Options include migration_starting, migration_in_progress, migration_completing, migration_success, migration_error, migration_cancelled, migration_driver_in_progress, migration_driver_phase1_done, data_copying_starting, data_copying_in_progress, data_copying_completing, data_copying_completed, data_copying_cancelled, data_copying_error. If no value is provided, None will be used.

9.2.34. manila revert-to-snapshot

usage: manila revert-to-snapshot <snapshot>

Revert a share to the specified snapshot.

Positional arguments:

<snapshot>
Name or ID of the snapshot to restore. The snapshot must be the most recent one known to manila.

9.2.35. manila security-service-create

usage: manila security-service-create [--dns-ip <dns_ip>] [--server <server>]
                                      [--domain <domain>] [--user <user>]
                                      [--password <password>] [--name <name>]
                                      [--description <description>]
                                      <type>

Create security service used by tenant.

Positional arguments:

<type>
Security service type: 'ldap', 'kerberos' or 'active_directory'.

Optional arguments:

--dns-ip <dns_ip>
DNS IP address used inside tenant’s network.
--server <server>
Security service IP address or hostname.
--domain <domain>
Security service domain.
--user <user>
Security service user or group used by tenant.
--password <password>
Password used by user.
--name <name>
Security service name.
--description <description>
Security service description.

9.2.36. manila security-service-delete

usage: manila security-service-delete <security-service>
                                      [<security-service> ...]

Delete one or more security services.

Positional arguments:

<security-service>
Name or ID of the security service(s) to delete

9.2.37. manila security-service-list

usage: manila security-service-list [--all-tenants [<0|1>]]
                                    [--share-network <share_network>]
                                    [--status <status>] [--name <name>]
                                    [--type <type>] [--user <user>]
                                    [--dns-ip <dns_ip>] [--server <server>]
                                    [--domain <domain>] [--detailed [<0|1>]]
                                    [--offset <offset>] [--limit <limit>]
                                    [--columns <columns>]

Get a list of security services.

Optional arguments:

--all-tenants [<0|1>]
Display information from all tenants (Admin only).
--share-network <share_network>, --share_network <share_network>
Filter results by share network id or name.
--status <status>
Filter results by status.
--name <name>
Filter results by name.
--type <type>
Filter results by type.
--user <user>
Filter results by user or group used by tenant.
--dns-ip <dns_ip>, --dns_ip <dns_ip>
Filter results by DNS IP address used inside tenant’s network.
--server <server>
Filter results by security service IP address or hostname.
--domain <domain>
Filter results by domain.
--detailed [<0|1>]
Show detailed information about filtered security services.
--offset <offset>
Start position of security services listing.
--limit <limit>
Number of security services to return per request.
--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "name,type"

9.2.38. manila security-service-show

usage: manila security-service-show <security-service>

Show security service.

Positional arguments:

<security-service>
Security service name or ID to show.

9.2.39. manila security-service-update

usage: manila security-service-update [--dns-ip <dns-ip>] [--server <server>]
                                      [--domain <domain>] [--user <user>]
                                      [--password <password>] [--name <name>]
                                      [--description <description>]
                                      <security-service>

Update security service.

Positional arguments:

<security-service>
Security service name or ID to update.

Optional arguments:

--dns-ip <dns-ip>
DNS IP address used inside tenant’s network.
--server <server>
Security service IP address or hostname.
--domain <domain>
Security service domain.
--user <user>
Security service user or group used by tenant.
--password <password>
Password used by user.
--name <name>
Security service name.
--description <description>
Security service description.

9.2.40. manila service-disable

usage: manila service-disable <hostname> <binary>

Disables 'manila-share' or 'manila-scheduler' services (Admin only).

Positional arguments:

<hostname>
Host name as 'example_host@example_backend'.
<binary>
Service binary, could be 'manila-share' or 'manila-scheduler'.

9.2.41. manila service-enable

usage: manila service-enable <hostname> <binary>

Enables 'manila-share' or 'manila-scheduler' services (Admin only).

Positional arguments:

<hostname>
Host name as 'example_host@example_backend'.
<binary>
Service binary, could be 'manila-share' or 'manila-scheduler'.

9.2.42. manila service-list

usage: manila service-list [--host <hostname>] [--binary <binary>]
                           [--status <status>] [--state <state>]
                           [--zone <zone>] [--columns <columns>]

List all services (Admin only).

Optional arguments:

--host <hostname>
Name of host.
--binary <binary>
Service binary.
--status <status>
Filter results by status.
--state <state>
Filter results by state.
--zone <zone>
Availability zone.
--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id,host"

9.2.43. manila share-export-location-list

usage: manila share-export-location-list [--columns <columns>] <share>

List export locations of a given share.

Positional arguments:

<share>
Name or ID of the share.

Optional arguments:

--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id,host,status"

9.2.44. manila share-export-location-show

usage: manila share-export-location-show <share> <export_location>

Show export location of the share.

Positional arguments:

<share>
Name or ID of the share.
<export_location>
ID of the share export location.

9.2.45. manila share-group-create

usage: manila share-group-create [--name <name>] [--description <description>]
                                 [--share-types <share_types>]
                                 [--share-group-type <share_group_type>]
                                 [--share-network <share_network>]
                                 [--source-share-group-snapshot <source_share_group_snapshot>]
                                 [--availability-zone <availability-zone>]

Creates a new share group (Experimental).

Optional arguments:

--name <name>
Optional share group name. (Default=None)
--description <description>
Optional share group description. (Default=None)
--share-types <share_types>, --share_types <share_types>
Comma-separated list of share types. (Default=None)
--share-group-type <share_group_type>, --share_group_type <share_group_type>, --type <share_group_type>
Share group type name or ID of the share group to be created. (Default=None)
--share-network <share_network>, --share_network <share_network>
Specify share network name or id.
--source-share-group-snapshot <source_share_group_snapshot>, --source_share_group_snapshot <source_share_group_snapshot>
Optional share group snapshot name or ID to create the share group from. (Default=None)
--availability-zone <availability-zone>, --availability_zone <availability-zone>, --az <availability-zone>
Optional availability zone in which group should be created. (Default=None

9.2.46. manila share-group-delete

usage: manila share-group-delete [--force] <share_group> [<share_group> ...]

Remove one or more share groups (Experimental).

Positional arguments:

<share_group>
Name or ID of the share_group(s).

Optional arguments:

--force
Attempt to force delete the share group (Default=False) (Admin only).

9.2.47. manila share-group-list

usage: manila share-group-list [--all-tenants [<0|1>]] [--name <name>]
                               [--status <status>]
                               [--share-server-id <share_server_id>]
                               [--share-group-type <share_group_type>]
                               [--snapshot <snapshot>] [--host <host>]
                               [--share-network <share_network>]
                               [--project-id <project_id>] [--limit <limit>]
                               [--offset <offset>] [--sort-key <sort_key>]
                               [--sort-dir <sort_dir>] [--columns <columns>]

List share groups with filters (Experimental).

Optional arguments:

--all-tenants [<0|1>]
Display information from all tenants (Admin only).
--name <name>
Filter results by name.
--status <status>
Filter results by status.
--share-server-id <share_server_id>, --share-server_id <share_server_id>, --share_server-id <share_server_id>, --share_server_id <share_server_id>
Filter results by share server ID (Admin only).
--share-group-type <share_group_type>, --share-group-type-id <share_group_type>, --share_group_type <share_group_type>, --share_group_type_id <share_group_type>
Filter results by a share group type ID or name that was used for share group creation.
--snapshot <snapshot>
Filter results by share group snapshot name or ID that was used to create the share group.
--host <host>
Filter results by host.
--share-network <share_network>, --share_network <share_network>
Filter results by share-network name or ID.
--project-id <project_id>, --project_id <project_id>
Filter results by project ID. Useful with set key '--all-tenants'.
--limit <limit>
Maximum number of share groups to return. (Default=None)
--offset <offset>
Start position of share group listing.
--sort-key <sort_key>, --sort_key <sort_key>
Key to be sorted, available keys are ('id', 'name', 'status', 'host', 'user_id', 'project_id', 'created_at', 'availability_zone', 'share_network', 'share_network_id', 'share_group_type', 'share_group_type_id', 'source_share_group_snapshot_id'). Default=None.
--sort-dir <sort_dir>, --sort_dir <sort_dir>
Sort direction, available values are ('asc', 'desc'). OPTIONAL: Default=None.
--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id,name"

9.2.48. manila share-group-reset-state

usage: manila share-group-reset-state [--state <state>] <share_group>

Explicitly update the state of a share group (Admin only, Experimental).

Positional arguments:

<share_group>
Name or ID of the share group to modify.

Optional arguments:

--state <state>
Indicate which state to assign the share group. Options include available, error, creating, deleting, error_deleting. If no state is provided, available will be used.

9.2.49. manila share-group-show

usage: manila share-group-show <share_group>

Show details about a share group (Experimental).

Positional arguments:

<share_group>
Name or ID of the share group.

9.2.50. manila share-group-snapshot-create

usage: manila share-group-snapshot-create [--name <name>]
                                          [--description <description>]
                                          <share_group>

Creates a new share group snapshot (Experimental).

Positional arguments:

<share_group>
Name or ID of the share group.

Optional arguments:

--name <name>
Optional share group snapshot name. (Default=None)
--description <description>
Optional share group snapshot description. (Default=None)

9.2.51. manila share-group-snapshot-delete

usage: manila share-group-snapshot-delete [--force]
                                          <share_group_snapshot>
                                          [<share_group_snapshot> ...]

Remove one or more share group snapshots (Experimental).

Positional arguments:

<share_group_snapshot>
Name or ID of the share group snapshot(s) to delete.

Optional arguments:

--force
Attempt to force delete the share group snapshot(s) (Default=False) (Admin only).

9.2.52. manila share-group-snapshot-list

usage: manila share-group-snapshot-list [--all-tenants [<0|1>]]
                                        [--name <name>] [--status <status>]
                                        [--share-group-id <share_group_id>]
                                        [--limit <limit>] [--offset <offset>]
                                        [--sort-key <sort_key>]
                                        [--sort-dir <sort_dir>]
                                        [--detailed DETAILED]
                                        [--columns <columns>]

List share group snapshots with filters (Experimental).

Optional arguments:

--all-tenants [<0|1>]
Display information from all tenants (Admin only).
--name <name>
Filter results by name.
--status <status>
Filter results by status.
--share-group-id <share_group_id>, --share_group_id <share_group_id>
Filter results by share group ID.
--limit <limit>
Maximum number of share group snapshots to return.(Default=None)
--offset <offset>
Start position of share group snapshot listing.
--sort-key <sort_key>, --sort_key <sort_key>
Key to be sorted, available keys are ('id', 'name', 'status', 'host', 'user_id', 'project_id', 'created_at', 'share_group_id'). Default=None.
--sort-dir <sort_dir>, --sort_dir <sort_dir>
Sort direction, available values are ('asc', 'desc'). OPTIONAL: Default=None.
--detailed DETAILED
Show detailed information about share group snapshots.
--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id,name"

9.2.53. manila share-group-snapshot-list-members

usage: manila share-group-snapshot-list-members [--columns <columns>]
                                                <share_group_snapshot>

List members of a share group snapshot (Experimental).

Positional arguments:

<share_group_snapshot>
Name or ID of the share group snapshot.

Optional arguments:

--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id,name"

9.2.54. manila share-group-snapshot-reset-state

usage: manila share-group-snapshot-reset-state [--state <state>]
                                               <share_group_snapshot>

Explicitly update the state of a share group snapshot (Admin only, Experimental).

Positional arguments:

<share_group_snapshot>
Name or ID of the share group snapshot.

Optional arguments:

--state <state>
Indicate which state to assign the share group snapshot. Options include available, error, creating, deleting, error_deleting. If no state is provided, available will be used.

9.2.55. manila share-group-snapshot-show

usage: manila share-group-snapshot-show <share_group_snapshot>

Show details about a share group snapshot (Experimental).

Positional arguments:

<share_group_snapshot>
Name or ID of the share group snapshot.

9.2.56. manila share-group-snapshot-update

usage: manila share-group-snapshot-update [--name <name>]
                                          [--description <description>]
                                          <share_group_snapshot>

Update a share group snapshot (Experimental).

Positional arguments:

<share_group_snapshot>
Name or ID of the share group snapshot to update.

Optional arguments:

--name <name>
Optional new name for the share group snapshot. (Default=None
--description <description>
Optional share group snapshot description. (Default=None)

9.2.57. manila share-group-type-access-add

usage: manila share-group-type-access-add <share_group_type> <project_id>

Adds share group type access for the given project (Admin only).

Positional arguments:

<share_group_type>
Share group type name or ID to add access for the given project.
<project_id>
Project ID to add share group type access for.

9.2.58. manila share-group-type-access-list

usage: manila share-group-type-access-list <share_group_type>

Print access information about a share group type (Admin only).

Positional arguments:

<share_group_type>
Filter results by share group type name or ID.

9.2.59. manila share-group-type-access-remove

usage: manila share-group-type-access-remove <share_group_type> <project_id>

Removes share group type access for the given project (Admin only).

Positional arguments:

<share_group_type>
Share group type name or ID to remove access for the given project.
<project_id>
Project ID to remove share group type access for.

9.2.60. manila share-group-type-create

usage: manila share-group-type-create [--is_public <is_public>]
                                      <name> <share_types>

Create a new share group type (Admin only).

Positional arguments:

<name>
Name of the new share group type.
<share_types>
Comma-separated list of share type names or IDs.

Optional arguments:

--is_public <is_public>, --is-public <is_public>
Make type accessible to the public (default true).

9.2.61. manila share-group-type-delete

usage: manila share-group-type-delete <id>

Delete a specific share group type (Admin only).

Positional arguments:

<id>
Name or ID of the share group type to delete.

9.2.62. manila share-group-type-key

usage: manila share-group-type-key <share_group_type> <action>
                                   [<key=value> [<key=value> ...]]

Set or unset group_spec for a share group type (Admin only).

Positional arguments:

<share_group_type>
Name or ID of the share group type.
<action>
Actions: 'set' or 'unset'.
<key=value>
Group specs to set or unset (key is only necessary on unset).

9.2.63. manila share-group-type-list

usage: manila share-group-type-list [--all] [--columns <columns>]

Print a list of available 'share group types'.

Optional arguments:

--all
Display all share group types (Admin only).
--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id,name"

9.2.64. manila share-group-type-specs-list

usage: manila share-group-type-specs-list [--columns <columns>]

Print a list of 'share group types specs' (Admin Only).

Optional arguments:

--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id,name"

9.2.65. manila share-group-update

usage: manila share-group-update [--name <name>] [--description <description>]
                                 <share_group>

Update a share group (Experimental).

Positional arguments:

<share_group>
Name or ID of the share group to update.

Optional arguments:

--name <name>
Optional new name for the share group. (Default=None)
--description <description>
Optional share group description. (Default=None)

9.2.66. manila share-instance-export-location-list

usage: manila share-instance-export-location-list [--columns <columns>]
                                                  <instance>

List export locations of a given share instance.

Positional arguments:

<instance>
Name or ID of the share instance.

Optional arguments:

--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id,host,status"

9.2.67. manila share-instance-export-location-show

usage: manila share-instance-export-location-show <instance> <export_location>

Show export location for the share instance.

Positional arguments:

<instance>
Name or ID of the share instance.
<export_location>
ID of the share instance export location.

9.2.68. manila share-instance-force-delete

usage: manila share-instance-force-delete <instance> [<instance> ...]

Force-delete the share instance, regardless of state (Admin only).

Positional arguments:

<instance>
Name or ID of the instance(s) to force delete.

9.2.69. manila share-instance-list

usage: manila share-instance-list [--share-id <share_id>]
                                  [--columns <columns>]

List share instances (Admin only).

Optional arguments:

--share-id <share_id>, --share_id <share_id>
Filter results by share ID.
--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id,host,status"

9.2.70. manila share-instance-reset-state

usage: manila share-instance-reset-state [--state <state>] <instance>

Explicitly update the state of a share instance (Admin only).

Positional arguments:

<instance>
Name or ID of the share instance to modify.

Optional arguments:

--state <state>
Indicate which state to assign the instance. Options include available, error, creating, deleting, error_deleting, migrating,migrating_to. If no state is provided, available will be used.

9.2.71. manila share-instance-show

usage: manila share-instance-show <instance>

Show details about a share instance (Admin only).

Positional arguments:

<instance>
Name or ID of the share instance.

9.2.72. manila share-network-create

usage: manila share-network-create [--neutron-net-id <neutron-net-id>]
                                   [--neutron-subnet-id <neutron-subnet-id>]
                                   [--name <name>]
                                   [--description <description>]

Create description for network used by the tenant.

Optional arguments:

--neutron-net-id <neutron-net-id>, --neutron-net_id <neutron-net-id>, --neutron_net_id <neutron-net-id>, --neutron_net-id <neutron-net-id>
Neutron network ID. Used to set up network for share servers.
--neutron-subnet-id <neutron-subnet-id>, --neutron-subnet_id <neutron-subnet-id>, --neutron_subnet_id <neutron-subnet-id>, --neutron_subnet-id <neutron-subnet-id>
Neutron subnet ID. Used to set up network for share servers. This subnet should belong to specified neutron network.
--name <name>
Share network name.
--description <description>
Share network description.

9.2.73. manila share-network-delete

usage: manila share-network-delete <share-network> [<share-network> ...]

Delete one or more share networks.

Positional arguments:

<share-network>
Name or ID of share network(s) to be deleted.

9.2.74. manila share-network-list

usage: manila share-network-list [--all-tenants [<0|1>]]
                                 [--project-id <project_id>] [--name <name>]
                                 [--created-since <created_since>]
                                 [--created-before <created_before>]
                                 [--security-service <security_service>]
                                 [--neutron-net-id <neutron_net_id>]
                                 [--neutron-subnet-id <neutron_subnet_id>]
                                 [--network-type <network_type>]
                                 [--segmentation-id <segmentation_id>]
                                 [--cidr <cidr>] [--ip-version <ip_version>]
                                 [--offset <offset>] [--limit <limit>]
                                 [--columns <columns>]

Get a list of network info.

Optional arguments:

--all-tenants [<0|1>]
Display information from all tenants (Admin only).
--project-id <project_id>, --project_id <project_id>
Filter results by project ID.
--name <name>
Filter results by name.
--created-since <created_since>, --created_since <created_since>
Return only share networks created since given date. The date is in the format 'yyyy-mm-dd'.
--created-before <created_before>, --created_before <created_before>
Return only share networks created until given date. The date is in the format 'yyyy-mm-dd'.
--security-service <security_service>, --security_service <security_service>
Filter results by attached security service.
--neutron-net-id <neutron_net_id>, --neutron_net_id <neutron_net_id>, --neutron_net-id <neutron_net_id>, --neutron-net_id <neutron_net_id>
Filter results by neutron net ID.
--neutron-subnet-id <neutron_subnet_id>, --neutron_subnet_id <neutron_subnet_id>, --neutron-subnet_id <neutron_subnet_id>, --neutron_subnet-id <neutron_subnet_id>
Filter results by neutron subnet ID.
--network-type <network_type>, --network_type <network_type>
Filter results by network type.
--segmentation-id <segmentation_id>, --segmentation_id <segmentation_id>
Filter results by segmentation ID.
--cidr <cidr>
Filter results by CIDR.
--ip-version <ip_version>, --ip_version <ip_version>
Filter results by IP version.
--offset <offset>
Start position of share networks listing.
--limit <limit>
Number of share networks to return per request.
--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id"

9.2.75. manila share-network-security-service-add

usage: manila share-network-security-service-add <share-network>
                                                 <security-service>

Associate security service with share network.

Positional arguments:

<share-network>
Share network name or ID.
<security-service>
Security service name or ID to associate with.

9.2.76. manila share-network-security-service-list

usage: manila share-network-security-service-list [--columns <columns>]
                                                  <share-network>

Get list of security services associated with a given share network.

Positional arguments:

<share-network>
Share network name or ID.

Optional arguments:

--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id,name"

9.2.77. manila share-network-security-service-remove

usage: manila share-network-security-service-remove <share-network>
                                                    <security-service>

Dissociate security service from share network.

Positional arguments:

<share-network>
Share network name or ID.
<security-service>
Security service name or ID to dissociate.

9.2.78. manila share-network-show

usage: manila share-network-show <share-network>

Get a description for network used by the tenant.

Positional arguments:

<share-network>
Name or ID of the share network to show.

9.2.79. manila share-network-update

usage: manila share-network-update [--neutron-net-id <neutron-net-id>]
                                   [--neutron-subnet-id <neutron-subnet-id>]
                                   [--name <name>]
                                   [--description <description>]
                                   <share-network>

Update share network data.

Positional arguments:

<share-network>
Name or ID of share network to update.

Optional arguments:

--neutron-net-id <neutron-net-id>, --neutron-net_id <neutron-net-id>, --neutron_net_id <neutron-net-id>, --neutron_net-id <neutron-net-id>
Neutron network ID. Used to set up network for share servers. This option is deprecated and will be rejected in newer releases of OpenStack Manila.
--neutron-subnet-id <neutron-subnet-id>, --neutron-subnet_id <neutron-subnet-id>, --neutron_subnet_id <neutron-subnet-id>, --neutron_subnet-id <neutron-subnet-id>
Neutron subnet ID. Used to set up network for share servers. This subnet should belong to specified neutron network.
--name <name>
Share network name.
--description <description>
Share network description.

9.2.80. manila share-replica-create

usage: manila share-replica-create [--availability-zone <availability-zone>]
                                   [--share-network <network-info>]
                                   <share>

Create a share replica (Experimental).

Positional arguments:

<share>
Name or ID of the share to replicate.

Optional arguments:

--availability-zone <availability-zone>, --availability_zone <availability-zone>, --az <availability-zone>
Optional Availability zone in which replica should be created.
--share-network <network-info>, --share_network <network-info>
Optional network info ID or name.

9.2.81. manila share-replica-delete

usage: manila share-replica-delete [--force] <replica> [<replica> ...]

Remove one or more share replicas (Experimental).

Positional arguments:

<replica>
ID of the share replica.

Optional arguments:

--force
Attempt to force deletion of a replica on its backend. Using this option will purge the replica from Manila even if it is not cleaned up on the backend. Defaults to False.

9.2.82. manila share-replica-list

usage: manila share-replica-list [--share-id <share_id>] [--columns <columns>]

List share replicas (Experimental).

Optional arguments:

--share-id <share_id>, --share_id <share_id>, --si <share_id>
List replicas belonging to share.
--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "replica_state,id"

9.2.83. manila share-replica-promote

usage: manila share-replica-promote <replica>

Promote specified replica to 'active' replica_state (Experimental).

Positional arguments:

<replica>
ID of the share replica.

9.2.84. manila share-replica-reset-replica-state

usage: manila share-replica-reset-replica-state
                                                [--replica-state <replica_state>]
                                                <replica>

Explicitly update the 'replica_state' of a share replica (Experimental).

Positional arguments:

<replica>
ID of the share replica to modify.

Optional arguments:

--replica-state <replica_state>, --replica_state <replica_state>, --state <replica_state>
Indicate which replica_state to assign the replica. Options include in_sync, out_of_sync, active, error. If no state is provided, out_of_sync will be used.

9.2.85. manila share-replica-reset-state

usage: manila share-replica-reset-state [--state <state>] <replica>

Explicitly update the 'status' of a share replica (Experimental).

Positional arguments:

<replica>
ID of the share replica to modify.

Optional arguments:

--state <state>
Indicate which state to assign the replica. Options include available, error, creating, deleting, error_deleting. If no state is provided, available will be used.

9.2.86. manila share-replica-resync

usage: manila share-replica-resync <replica>

Attempt to update the share replica with its 'active' mirror (Experimental).

Positional arguments:

<replica>
ID of the share replica to resync.

9.2.87. manila share-replica-show

usage: manila share-replica-show <replica>

Show details about a replica (Experimental).

Positional arguments:

<replica>
ID of the share replica.

9.2.88. manila share-server-delete

usage: manila share-server-delete <id> [<id> ...]

Delete one or more share servers (Admin only).

Positional arguments:

<id>
ID of the share server(s) to delete.

9.2.89. manila share-server-details

usage: manila share-server-details <id>

Show share server details (Admin only).

Positional arguments:

<id>
ID of share server.

9.2.90. manila share-server-list

usage: manila share-server-list [--host <hostname>] [--status <status>]
                                [--share-network <share_network>]
                                [--project-id <project_id>]
                                [--columns <columns>]

List all share servers (Admin only).

Optional arguments:

--host <hostname>
Filter results by name of host.
--status <status>
Filter results by status.
--share-network <share_network>
Filter results by share network.
--project-id <project_id>
Filter results by project ID.
--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id,host,status"

9.2.91. manila share-server-show

usage: manila share-server-show <id>

Show share server info (Admin only).

Positional arguments:

<id>
ID of share server.

9.2.92. manila show

usage: manila show <share>

Show details about a NAS share.

Positional arguments:

<share>
Name or ID of the NAS share.

9.2.93. manila shrink

usage: manila shrink <share> <new_size>

Decreases the size of an existing share.

Positional arguments:

<share>
Name or ID of share to shrink.
<new_size>
New size of share, in GiBs.

9.2.94. manila snapshot-access-allow

usage: manila snapshot-access-allow <snapshot> <access_type> <access_to>

Allow read only access to a snapshot.

Positional arguments:

<snapshot>
Name or ID of the share snapshot to allow access to.
<access_type>
Access rule type (only "ip", "user"(user or group), "cert" or "cephx" are supported).
<access_to>
Value that defines access.

9.2.95. manila snapshot-access-deny

usage: manila snapshot-access-deny <snapshot> <id> [<id> ...]

Deny access to a snapshot.

Positional arguments:

<snapshot>
Name or ID of the share snapshot to deny access to.
<id>
ID(s) of the access rule(s) to be deleted.

9.2.96. manila snapshot-access-list

usage: manila snapshot-access-list [--columns <columns>] <snapshot>

Show access list for a snapshot.

Positional arguments:

<snapshot>
Name or ID of the share snapshot to list access of.

Optional arguments:

--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "access_type,access_to"

9.2.97. manila snapshot-create

usage: manila snapshot-create [--force <True|False>] [--name <name>]
                              [--description <description>]
                              <share>

Add a new snapshot.

Positional arguments:

<share>
Name or ID of the share to snapshot.

Optional arguments:

--force <True|False>
Optional flag to indicate whether to snapshot a share even if it’s busy. (Default=False)
--name <name>
Optional snapshot name. (Default=None)
--description <description>
Optional snapshot description. (Default=None)

9.2.98. manila snapshot-delete

usage: manila snapshot-delete <snapshot> [<snapshot> ...]

Remove one or more snapshots.

Positional arguments:

<snapshot>
Name or ID of the snapshot(s) to delete.

9.2.99. manila snapshot-export-location-list

usage: manila snapshot-export-location-list [--columns <columns>] <snapshot>

List export locations of a given snapshot.

Positional arguments:

<snapshot>
Name or ID of the snapshot.

Optional arguments:

--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id,path"

9.2.100. manila snapshot-export-location-show

usage: manila snapshot-export-location-show <snapshot> <export_location>

Show export location of the share snapshot.

Positional arguments:

<snapshot>
Name or ID of the snapshot.
<export_location>
ID of the share snapshot export location.

9.2.101. manila snapshot-force-delete

usage: manila snapshot-force-delete <snapshot> [<snapshot> ...]

Attempt force-deletion of one or more snapshots. Regardless of the state (Admin only).

Positional arguments:

<snapshot>
Name or ID of the snapshot(s) to force delete.

9.2.102. manila snapshot-instance-export-location-list

usage: manila snapshot-instance-export-location-list [--columns <columns>]
                                                     <instance>

List export locations of a given snapshot instance.

Positional arguments:

<instance>
Name or ID of the snapshot instance.

Optional arguments:

--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id,path,is_admin_only"

9.2.103. manila snapshot-instance-export-location-show

usage: manila snapshot-instance-export-location-show <snapshot_instance>
                                                     <export_location>

Show export location of the share instance snapshot.

Positional arguments:

<snapshot_instance>
ID of the share snapshot instance.
<export_location>
ID of the share snapshot instance export location.

9.2.104. manila snapshot-instance-list

usage: manila snapshot-instance-list [--snapshot <snapshot>]
                                     [--columns <columns>]
                                     [--detailed <detailed>]

List share snapshot instances.

Optional arguments:

--snapshot <snapshot>
Filter results by share snapshot ID.
--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id"
--detailed <detailed>
Show detailed information about snapshot instances. (Default=False)

9.2.105. manila snapshot-instance-reset-state

usage: manila snapshot-instance-reset-state [--state <state>]
                                            <snapshot_instance>

Explicitly update the state of a share snapshot instance.

Positional arguments:

<snapshot_instance>
ID of the snapshot instance to modify.

Optional arguments:

--state <state>
Indicate which state to assign the snapshot instance. Options include available, error, creating, deleting, error_deleting. If no state is provided, available will be used.

9.2.106. manila snapshot-instance-show

usage: manila snapshot-instance-show <snapshot_instance>

Show details about a share snapshot instance.

Positional arguments:

<snapshot_instance>
ID of the share snapshot instance.

9.2.107. manila snapshot-list

usage: manila snapshot-list [--all-tenants [<0|1>]] [--name <name>]
                            [--status <status>] [--share-id <share_id>]
                            [--usage [any|used|unused]] [--limit <limit>]
                            [--offset <offset>] [--sort-key <sort_key>]
                            [--sort-dir <sort_dir>] [--columns <columns>]

List all the snapshots.

Optional arguments:

--all-tenants [<0|1>]
Display information from all tenants (Admin only).
--name <name>
Filter results by name.
--status <status>
Filter results by status.
--share-id <share_id>, --share_id <share_id>
Filter results by source share ID.
--usage [any|used|unused]
Either filter or not snapshots by its usage. OPTIONAL: Default=any.
--limit <limit>
Maximum number of share snapshots to return. OPTIONAL: Default=None.
--offset <offset>
Set offset to define start point of share snapshots listing. OPTIONAL: Default=None.
--sort-key <sort_key>, --sort_key <sort_key>
Key to be sorted, available keys are ('id', 'status', 'size', 'share_id', 'user_id', 'project_id', 'progress', 'name', 'display_name'). Default=None.
--sort-dir <sort_dir>, --sort_dir <sort_dir>
Sort direction, available values are ('asc', 'desc'). OPTIONAL: Default=None.
--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id,name"

9.2.108. manila snapshot-manage

usage: manila snapshot-manage [--name <name>] [--description <description>]
                              [--driver_options [<key=value> [<key=value> ...]]]
                              <share> <provider_location>

Manage share snapshot not handled by Manila (Admin only).

Positional arguments:

<share>
Name or ID of the share.
<provider_location>
Provider location of the snapshot on the backend.

Optional arguments:

--name <name>
Optional snapshot name (Default=None).
--description <description>
Optional snapshot description (Default=None).
--driver_options [<key=value> [<key=value> …​]], --driver-options [<key=value> [<key=value> …​]]
Optional driver options as key=value pairs (Default=None).

9.2.109. manila snapshot-rename

usage: manila snapshot-rename [--description <description>]
                              <snapshot> [<name>]

Rename a snapshot.

Positional arguments:

<snapshot>
Name or ID of the snapshot to rename.
<name>
New name for the snapshot.

Optional arguments:

--description <description>
Optional snapshot description. (Default=None)

9.2.110. manila snapshot-reset-state

usage: manila snapshot-reset-state [--state <state>] <snapshot>

Explicitly update the state of a snapshot (Admin only).

Positional arguments:

<snapshot>
Name or ID of the snapshot to modify.

Optional arguments:

--state <state>
Indicate which state to assign the snapshot. Options include available, error, creating, deleting, error_deleting. If no state is provided, available will be used.

9.2.111. manila snapshot-show

usage: manila snapshot-show <snapshot>

Show details about a snapshot.

Positional arguments:

<snapshot>
Name or ID of the snapshot.

9.2.112. manila snapshot-unmanage

usage: manila snapshot-unmanage <snapshot> [<snapshot> ...]

Unmanage one or more share snapshots (Admin only).

Positional arguments:

<snapshot>
Name or ID of the snapshot(s).

9.2.113. manila type-access-add

usage: manila type-access-add <share_type> <project_id>

Adds share type access for the given project (Admin only).

Positional arguments:

<share_type>
Share type name or ID to add access for the given project.
<project_id>
Project ID to add share type access for.

9.2.114. manila type-access-list

usage: manila type-access-list <share_type>

Print access information about the given share type (Admin only).

Positional arguments:

<share_type>
Filter results by share type name or ID.

9.2.115. manila type-access-remove

usage: manila type-access-remove <share_type> <project_id>

Removes share type access for the given project (Admin only).

Positional arguments: