红帽全球峰会此内容没有您所选择的语言版本。
Command-Line Interface Reference
Command-line clients for Red Hat OpenStack Platform
Abstract
Chapter 1. OpenStack Command-line Clients
1.1. Overview
| Service | Client | Package | Description |
|---|---|---|---|
| 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. |
1.2. Install the OpenStack Command-line Clients
1.2.1. Install the Prerequisite Software
| Prerequisite | Description |
|---|---|
|
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
ceilometer- Telemetry APIcinder- Block Storage API and extensionsglance- Image Service APIheat- Orchestration APIkeystone- Identity service API and extensionsneutron- Networking APInova- Compute API and extensionsswift- Object Storage API
yum install python-novaclient
# yum install python-novaclient1.2.2.1. Installing from Packages
yum install python-PROJECTclient
# yum install python-PROJECTclient1.2.3. Upgrade or Remove Clients
--upgrade option to the yum install command:
yum install --upgrade python-PROJECTclient
# yum install --upgrade python-PROJECTclientyum erase python-PROJECTclient
# yum erase python-PROJECTclient1.2.4. What's Next
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
PROJECT --version
$ PROJECT --versionnova --version
$ nova --version3.3.0
3.3.0openrc.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.
1.4.1. Download and Source the OpenStack RC File
- Log in to the OpenStack dashboard, choose the project for which you want to download the OpenStack RC file, and click .
- On the API Access tab, click and save the file. The filename will be of the form
PROJECT-openrc.shwhere PROJECT is the name of the project for which you downloaded the file. - Copy the
PROJECT-openrc.shfile 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. - On any shell from which you want to run OpenStack commands, source the
PROJECT-openrc.shfile for the respective project.In the following example, thedemo-openrc.shfile is sourced for the demo project:source demo-openrc.sh
$ source demo-openrc.shCopy to Clipboard Copied! Toggle word wrap Toggle overflow - When you are prompted for an OpenStack password, enter the password for the user who downloaded the
PROJECT-openrc.shfile.
1.4.2. Create and Source the OpenStack RC File
PROJECT-openrc.sh file from scratch, if for some reason you cannot download the file from the dashboard.
- In a text editor, create a file named
PROJECT-openrc.shfile and add the following authentication information:Copy to Clipboard Copied! Toggle word wrap Toggle overflow The following example shows the information for a project calledadmin, where the OS username is alsoadmin, and the identity host is located atcontroller.export OS_USERNAME=admin export OS_PASSWORD=ADMIN_PASS export OS_PROJECT_NAME=admin export OS_AUTH_URL=http://controller:35357/v2.0
export OS_USERNAME=admin export OS_PASSWORD=ADMIN_PASS export OS_PROJECT_NAME=admin export OS_AUTH_URL=http://controller:35357/v2.0Copy to Clipboard Copied! Toggle word wrap Toggle overflow - On any shell from which you want to run OpenStack commands, source the
PROJECT-openrc.shfile for the respective project. In this example, you source theadmin-openrc.shfile for the admin project:source admin-openrc.sh
$ source admin-openrc.shCopy to Clipboard Copied! Toggle word wrap Toggle overflow
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
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
$ keystone --os-password PASSWORD service-listChapter 2. OpenStack Command-line Client
3.2.0.
openstack help COMMAND
$ openstack help COMMAND2.1. openstack Usage
2.2. openstack 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-cloud <cloud-config-name>
Cloud name in clouds.yaml (Env: OS_CLOUD)
- --os-region-name <auth-region-name>
Authentication region name (Env: OS_REGION_NAME)
- --os-cacert <ca-bundle-file>
CA certificate bundle file (Env: OS_CACERT)
- --os-cert <certificate-file>
Client certificate bundle file (Env: OS_CERT)
- --os-key <key-file>
Client certificate key file (Env: OS_KEY)
- --verify
Verify server certificate (default)
- --insecure
Disable server certificate verification
- --os-default-domain <auth-domain>
Default domain ID, default=default. (Env:
OS_DEFAULT_DOMAIN)
- --os-interface <interface>
Select an interface type. Valid interface types:
[admin, public, internal]. (Env: OS_INTERFACE)
- --timing
Print API call timing info
- --os-beta-command
Enable beta commands which are subject to change
- --os-profile
hmac-key
HMAC key for encrypting profiling context data
- --os-compute-api-version <compute-api-version>
Compute API version, default=2 (Env:
OS_COMPUTE_API_VERSION)
- --os-network-api-version <network-api-version>
Network API version, default=2.0 (Env:
OS_NETWORK_API_VERSION)
- --os-image-api-version <image-api-version>
Image API version, default=2 (Env:
OS_IMAGE_API_VERSION)
- --os-volume-api-version <volume-api-version>
Volume API version, default=2 (Env:
OS_VOLUME_API_VERSION)
- --os-identity-api-version <identity-api-version>
Identity API version, default=3 (Env:
OS_IDENTITY_API_VERSION)
- --os-object-api-version <object-api-version>
Object API version, default=1 (Env:
OS_OBJECT_API_VERSION)
- --os-metrics-api-version <metrics-api-version>
Metrics API version, default=1 (Env:
OS_METRICS_API_VERSION)
- --os-data-processing-api-version <data-processing-api-version>
Data processing API version, default=1.1 (Env:
OS_DATA_PROCESSING_API_VERSION)
- --os-data-processing-url OS_DATA_PROCESSING_URL
Data processing API URL, (Env:
OS_DATA_PROCESSING_API_URL)
- --os-orchestration-api-version <orchestration-api-version>
Orchestration API version, default=1 (Env:
OS_ORCHESTRATION_API_VERSION)
- --os-dns-api-version <dns-api-version>
DNS API version, default=2 (Env: OS_DNS_API_VERSION)
- --os-alarming-api-version <alarming-api-version>
Queues API version, default=2 (Env:
OS_ALARMING_API_VERSION)
- --os-key-manager-api-version <key-manager-api-version>
Barbican API version, default=1 (Env:
OS_KEY_MANAGER_API_VERSION)
- --os-application-catalog-api-version <application-catalog-api-version>
Application catalog API version,
default=1(Env:OS_APPLICATION_CATALOG_API_VERSION)
- --murano-url MURANO_URL
Defaults toenv[MURANO_URL].
- --inspector-api-version INSPECTOR_API_VERSION
inspector API version, only 1 is supported now (env:
INSPECTOR_VERSION).
- --inspector-url INSPECTOR_URL
inspector URL, defaults to localhost (env:
INSPECTOR_URL).
- --os-container-infra-api-version <container-infra-api-version>
Container-Infra API version, default=1 (Env:
OS_CONTAINER_INFRA_API_VERSION)
- --os-queues-api-version <queues-api-version>
Queues API version, default=2 (Env:
OS_QUEUES_API_VERSION)
- --os-baremetal-api-version <baremetal-api-version>
Baremetal API version, default=1.6 (Env:
OS_BAREMETAL_API_VERSION)
- --os-workflow-api-version <workflow-api-version>
Workflow API version, default=2 (Env:
OS_WORKFLOW_API_VERSION)
- --os-auth-type <auth-type>
Select an authentication type. Available types:
v2token, password, admin_token, v3oidcauthcode,
v3oidcpassword, v2password, v3samlpassword,
v3password, v3oidcaccesstoken, token_endpoint,
v3kerberos, v3totp, token, v3oidcclientcredentials,
v3tokenlessauth, gnocchi-noauth, v3token, v3oauth1,
aodh-noauth, v3fedkerb. Default: selected based on
--os-username/--os-token (Env: OS_AUTH_TYPE)
- --os-authorization-code <auth-authorization-code>
With v3oidcauthcode: OAuth 2.0 Authorization Code
(Env: OS_AUTHORIZATION_CODE)
- --os-project-domain-id <auth-project-domain-id>
With password: Domain ID containing project With
v3oidcauthcode: Domain ID containing project With
v3oidcpassword: Domain ID containing project With
v3samlpassword: Domain ID containing project With
v3password: Domain ID containing project With
v3oidcaccesstoken: Domain ID containing project With
v3kerberos: Domain ID containing project With v3totp:
Domain ID containing project With token: Domain ID
containing project With v3oidcclientcredentials:
Domain ID containing project With v3tokenlessauth:
Domain ID containing project With v3token: Domain ID
containing project With v3fedkerb: Domain ID
containing project (Env: OS_PROJECT_DOMAIN_ID)
- --os-protocol <auth-protocol>
With v3oidcauthcode: Protocol for federated plugin
With v3oidcpassword: Protocol for federated plugin
With v3samlpassword: Protocol for federated plugin
With v3oidcaccesstoken: Protocol for federated plugin
With v3oidcclientcredentials: Protocol for federated
plugin (Env: OS_PROTOCOL)
- --os-project-name <auth-project-name>
With password: Project name to scope to With
v3oidcauthcode: Project name to scope to With
v3oidcpassword: Project name to scope to With
v3samlpassword: Project name to scope to With
v3password: Project name to scope to With
v3oidcaccesstoken: Project name to scope to With
v3kerberos: Project name to scope to With v3totp:
Project name to scope to With token: Project name to
scope to With v3oidcclientcredentials: Project name to
scope to With v3tokenlessauth: Project name to scope
to With v3token: Project name to scope to With
v3fedkerb: Project name to scope to (Env:
OS_PROJECT_NAME)
- --os-trust-id <auth-trust-id>
With v2token: Trust ID With password: Trust ID With
v3oidcauthcode: Trust ID With v3oidcpassword: Trust ID
With v2password: Trust ID With v3samlpassword: Trust
ID With v3password: Trust ID With v3oidcaccesstoken:
Trust ID With v3kerberos: Trust ID With v3totp: Trust
ID With token: Trust ID With v3oidcclientcredentials:
Trust ID With v3token: Trust ID With v3fedkerb: Trust
ID (Env: OS_TRUST_ID)
- --os-consumer-key <auth-consumer-key>
With v3oauth1: OAuth Consumer ID/Key (Env:
OS_CONSUMER_KEY)
- --os-domain-name <auth-domain-name>
With password: Domain name to scope to With
v3oidcauthcode: Domain name to scope to With
v3oidcpassword: Domain name to scope to With
v3samlpassword: Domain name to scope to With
v3password: Domain name to scope to With
v3oidcaccesstoken: Domain name to scope to With
v3kerberos: Domain name to scope to With v3totp:
Domain name to scope to With token: Domain name to
scope to With v3oidcclientcredentials: Domain name to
scope to With v3tokenlessauth: Domain name to scope to
With v3token: Domain name to scope to With v3fedkerb:
Domain name to scope to (Env: OS_DOMAIN_NAME)
- --os-access-secret <auth-access-secret>
With v3oauth1: OAuth Access Secret (Env:
OS_ACCESS_SECRET)
- --os-user-domain-id <auth-user-domain-id>
With password: User's domain id With v3password:
User's domain id With v3totp: User's domain id (Env:
OS_USER_DOMAIN_ID)
- --os-access-token-type <auth-access-token-type>
With v3oidcauthcode: OAuth 2.0 Authorization Server
Introspection token type, it is used to decide which
type of token will be used when processing token
introspection. Valid values are: "access_token" or
"id_token" With v3oidcpassword: OAuth 2.0
Authorization Server Introspection token type, it is
used to decide which type of token will be used when
processing token introspection. Valid values are:
"access_token" or "id_token" With
v3oidcclientcredentials: OAuth 2.0 Authorization
Server Introspection token type, it is used to decide
which type of token will be used when processing token
introspection. Valid values are: "access_token" or
"id_token" (Env: OS_ACCESS_TOKEN_TYPE)
- --os-identity-provider-url <auth-identity-provider-url>
With v3samlpassword: An Identity Provider URL, where
the SAML2 authentication request will be sent. (Env:
OS_IDENTITY_PROVIDER_URL)
- --os-default-domain-name <auth-default-domain-name>
With password: Optional domain name to use with v3 API
and v2 parameters. It will be used for both the user
and project domain in v3 and ignored in v2
authentication. With token: Optional domain name to
use with v3 API and v2 parameters. It will be used for
both the user and project domain in v3 and ignored in
v2 authentication. (Env: OS_DEFAULT_DOMAIN_NAME)
- --os-access-token-endpoint <auth-access-token-endpoint>
With v3oidcauthcode: OpenID Connect Provider Token
Endpoint. Note that if a discovery document is being
passed this option will override the endpoint provided
by the server in the discovery document. With
v3oidcpassword: OpenID Connect Provider Token
Endpoint. Note that if a discovery document is being
passed this option will override the endpoint provided
by the server in the discovery document. With
v3oidcclientcredentials: OpenID Connect Provider Token
Endpoint. Note that if a discovery document is being
passed this option will override the endpoint provided
by the server in the discovery document. (Env:
OS_ACCESS_TOKEN_ENDPOINT)
- --os-access-token <auth-access-token>
With v3oidcaccesstoken: OAuth 2.0 Access Token (Env:
OS_ACCESS_TOKEN)
- --os-domain-id <auth-domain-id>
With password: Domain ID to scope to With
v3oidcauthcode: Domain ID to scope to With
v3oidcpassword: Domain ID to scope to With
v3samlpassword: Domain ID to scope to With v3password:
Domain ID to scope to With v3oidcaccesstoken: Domain
ID to scope to With v3kerberos: Domain ID to scope to
With v3totp: Domain ID to scope to With token: Domain
ID to scope to With v3oidcclientcredentials: Domain ID
to scope to With v3tokenlessauth: Domain ID to scope
to With v3token: Domain ID to scope to With v3fedkerb:
Domain ID to scope to (Env: OS_DOMAIN_ID)
- --os-user-domain-name <auth-user-domain-name>
With password: User's domain name With v3password:
User's domain name With v3totp: User's domain name
(Env: OS_USER_DOMAIN_NAME)
- --os-openid-scope <auth-openid-scope>
With v3oidcauthcode: OpenID Connect scope that is
requested from authorization server. Note that the
OpenID Connect specification states that "openid" must
be always specified. With v3oidcpassword: OpenID
Connect scope that is requested from authorization
server. Note that the OpenID Connect specification
states that "openid" must be always specified. With
v3oidcclientcredentials: OpenID Connect scope that is
requested from authorization server. Note that the
OpenID Connect specification states that "openid" must
be always specified. (Env: OS_OPENID_SCOPE)
- --os-user-id <auth-user-id>
With password: User id With v2password: User ID to
login with With v3password: User ID With v3totp: User
ID With gnocchi-noauth: User ID With aodh-noauth: User
ID (Env: OS_USER_ID)
- --os-identity-provider <auth-identity-provider>
With v3oidcauthcode: Identity Provider's name With
v3oidcpassword: Identity Provider's name With
v3samlpassword: Identity Provider's name With
v3oidcaccesstoken: Identity Provider's name With
v3oidcclientcredentials: Identity Provider's name
(Env: OS_IDENTITY_PROVIDER)
- --os-username <auth-username>
With password: Username With v3oidcpassword: Username
With v2password: Username to login with With
v3samlpassword: Username With v3password: Username
With v3totp: Username (Env: OS_USERNAME)
- --os-auth-url <auth-auth-url>
With v2token: Authentication URL With password:
Authentication URL With v3oidcauthcode: Authentication
URL With v3oidcpassword: Authentication URL With
v2password: Authentication URL With v3samlpassword:
Authentication URL With v3password: Authentication URL
With v3oidcaccesstoken: Authentication URL With
v3kerberos: Authentication URL With v3totp:
Authentication URL With token: Authentication URL With
v3oidcclientcredentials: Authentication URL With
v3tokenlessauth: Authentication URL With v3token:
Authentication URL With v3oauth1: Authentication URL
With v3fedkerb: Authentication URL (Env: OS_AUTH_URL)
- --os-client-secret <auth-client-secret>
With v3oidcauthcode: OAuth 2.0 Client Secret With
v3oidcpassword: OAuth 2.0 Client Secret With
v3oidcclientcredentials: OAuth 2.0 Client Secret (Env:
OS_CLIENT_SECRET)
- --os-default-domain-id <auth-default-domain-id>
With password: Optional domain ID to use with v3 and
v2 parameters. It will be used for both the user and
project domain in v3 and ignored in v2 authentication.
With token: Optional domain ID to use with v3 and v2
parameters. It will be used for both the user and
project domain in v3 and ignored in v2 authentication.
(Env: OS_DEFAULT_DOMAIN_ID)
- --os-discovery-endpoint <auth-discovery-endpoint>
With v3oidcauthcode: OpenID Connect Discovery Document
URL. The discovery document will be used to obtain the
values of the access token endpoint and the
authentication endpoint. This URL should look like
https://idp.example.org/.well-known/openid-
configuration With v3oidcpassword: OpenID Connect
Discovery Document URL. The discovery document will be
used to obtain the values of the access token endpoint
and the authentication endpoint. This URL should look
like https://idp.example.org/.well-known/openid-
configuration With v3oidcclientcredentials: OpenID
Connect Discovery Document URL. The discovery document
will be used to obtain the values of the access token
endpoint and the authentication endpoint. This URL
should look like https://idp.example.org/.well-known
/openid-configuration (Env: OS_DISCOVERY_ENDPOINT)
- --os-client-id <auth-client-id>
With v3oidcauthcode: OAuth 2.0 Client ID With
v3oidcpassword: OAuth 2.0 Client ID With
v3oidcclientcredentials: OAuth 2.0 Client ID (Env:
OS_CLIENT_ID)
- --os-project-domain-name <auth-project-domain-name>
With password: Domain name containing project With
v3oidcauthcode: Domain name containing project With
v3oidcpassword: Domain name containing project With
v3samlpassword: Domain name containing project With
v3password: Domain name containing project With
v3oidcaccesstoken: Domain name containing project With
v3kerberos: Domain name containing project With
v3totp: Domain name containing project With token:
Domain name containing project With
v3oidcclientcredentials: Domain name containing
project With v3tokenlessauth: Domain name containing
project With v3token: Domain name containing project
With v3fedkerb: Domain name containing project (Env:
OS_PROJECT_DOMAIN_NAME)
- --os-access-key <auth-access-key>
With v3oauth1: OAuth Access Key (Env: OS_ACCESS_KEY)
- --os-password <auth-password>
With password: User's password With v3oidcpassword:
Password With v2password: Password to use With
v3samlpassword: Password With v3password: User's
password (Env: OS_PASSWORD)
- --os-redirect-uri <auth-redirect-uri>
With v3oidcauthcode: OpenID Connect Redirect URL (Env:
OS_REDIRECT_URI)
- --os-endpoint <auth-endpoint>
With admin_token: The endpoint that will always be
used With gnocchi-noauth: Gnocchi endpoint (Env:
OS_ENDPOINT)
- --os-aodh-endpoint <auth-aodh-endpoint>
With aodh-noauth: Aodh endpoint (Env:
OS_AODH_ENDPOINT)
- --os-roles <auth-roles>
With gnocchi-noauth: Roles With aodh-noauth: Roles
(Env: OS_ROLES)
- --os-url <auth-url>
With token_endpoint: Specific service endpoint to use
(Env: OS_URL)
- --os-consumer-secret <auth-consumer-secret>
With v3oauth1: OAuth Consumer Secret (Env:
OS_CONSUMER_SECRET)
- --os-token <auth-token>
With v2token: Token With admin_token: The token that
will always be used With token_endpoint:
Authentication token to use With token: Token to
authenticate with With v3token: Token to authenticate
with (Env: OS_TOKEN)
- --os-passcode <auth-passcode>
With v3totp: User's TOTP passcode (Env: OS_PASSCODE)
- --os-project-id <auth-project-id>
With password: Project ID to scope to With
v3oidcauthcode: Project ID to scope to With
v3oidcpassword: Project ID to scope to With
v3samlpassword: Project ID to scope to With
v3password: Project ID to scope to With
v3oidcaccesstoken: Project ID to scope to With
v3kerberos: Project ID to scope to With v3totp:
Project ID to scope to With token: Project ID to scope
to With v3oidcclientcredentials: Project ID to scope
to With v3tokenlessauth: Project ID to scope to With
gnocchi-noauth: Project ID With v3token: Project ID to
scope to With aodh-noauth: Project ID With v3fedkerb:
Project ID to scope to (Env: OS_PROJECT_ID)
2.3. openstack acl delete
usage: openstack acl delete [-h] URI
usage: openstack acl delete [-h] URIPositional arguments
- URI
The URI reference for the secret or container.
Optional arguments
- -h, --help
show this help message and exit
2.4. openstack acl get
usage: openstack acl get [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
URI
usage: openstack acl get [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
URIPositional arguments
- URI
The URI reference for the secret or container.
Optional arguments
- -h, --help
show this help message and exit
2.5. openstack acl submit
Positional arguments
- URI
The URI reference for the secret or container.
Optional arguments
- -h, --help
show this help message and exit
- --user [USERS], -u [USERS]
Keystone userid(s) for ACL.
- --project-access
Flag to enable project access behavior.
- --no-project-access
Flag to disable project access behavior.
- --operation-type {read}, -o {read}
Type of Barbican operation ACL is set for
2.6. openstack acl user add
Positional arguments
- URI
The URI reference for the secret or container.
Optional arguments
- -h, --help
show this help message and exit
- --user [USERS], -u [USERS]
Keystone userid(s) for ACL.
- --project-access
Flag to enable project access behavior.
- --no-project-access
Flag to disable project access behavior.
- --operation-type {read}, -o {read}
Type of Barbican operation ACL is set for
2.7. openstack acl user remove
Positional arguments
- URI
The URI reference for the secret or container.
Optional arguments
- -h, --help
show this help message and exit
- --user [USERS], -u [USERS]
Keystone userid(s) for ACL.
- --project-access
Flag to enable project access behavior.
- --no-project-access
Flag to disable project access behavior.
- --operation-type {read}, -o {read}
Type of Barbican operation ACL is set for
2.8. openstack action definition create
Positional arguments
- definition
Action definition file
Optional arguments
- -h, --help
show this help message and exit
- --public
With this flag action will be marked as "public".
2.9. openstack action definition delete
usage: openstack action definition delete [-h] action [action ...]
usage: openstack action definition delete [-h] action [action ...]Positional arguments
- action
Name or ID of action(s).
Optional arguments
- -h, --help
show this help message and exit
2.10. openstack action definition list
usage: openstack action definition list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
usage: openstack action definition list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.11. openstack action definition show
usage: openstack action definition show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
action
usage: openstack action definition show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
actionPositional arguments
- action
Action (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.12. openstack action definition update
Positional arguments
- definition
Action definition file
Optional arguments
- -h, --help
show this help message and exit
- --id ID
Action ID.
- --public
With this flag action will be marked as "public".
2.13. openstack action execution delete
usage: openstack action execution delete [-h]
action_execution
[action_execution ...]
usage: openstack action execution delete [-h]
action_execution
[action_execution ...]Positional arguments
- action_execution
Id of action execution identifier(s).
Optional arguments
- -h, --help
show this help message and exit
2.14. openstack action execution list
usage: openstack action execution list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[task_execution_id]
usage: openstack action execution list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[task_execution_id]Positional arguments
- task_execution_id
Task execution ID.
Optional arguments
- -h, --help
show this help message and exit
2.15. openstack action execution run
usage: openstack action execution run [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] [-s]
[--run-sync] [-t TARGET]
name [input]
usage: openstack action execution run [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] [-s]
[--run-sync] [-t TARGET]
name [input]Positional arguments
- name
Action name to execute.
- input
Action input.
Optional arguments
- -h, --help
show this help message and exit
- -s, --save-result
Save the result into DB.
- --run-sync
Run the action synchronously.
- -t TARGET, --target TARGET
Action will be executed on <target> executor.
2.16. openstack action execution show
usage: openstack action execution show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
action_execution
usage: openstack action execution show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
action_executionPositional arguments
- action_execution
Action execution ID.
Optional arguments
- -h, --help
show this help message and exit
2.17. openstack action execution update
Positional arguments
- id
Action execution ID.
Optional arguments
- -h, --help
show this help message and exit
- --state {IDLE,RUNNING,SUCCESS,ERROR}
Action execution state
- --output OUTPUT
Action execution output
2.18. openstack address scope create
Positional arguments
- <name>
New address scope name
Optional arguments
- -h, --help
show this help message and exit
- --ip-version {4,6} IP
version (default is 4)
- --project <project>
Owner's project (name or ID)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
- --share
Share the address scope between projects
- --no-share
Do not share the address scope between projects
(default)
2.19. openstack address scope delete
usage: openstack address scope delete [-h]
<address-scope> [<address-scope> ...]
usage: openstack address scope delete [-h]
<address-scope> [<address-scope> ...]Positional arguments
- <address-scope>
Address scope(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.20. openstack address scope list
usage: openstack address scope list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
usage: openstack address scope list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.21. openstack address scope set
usage: openstack address scope set [-h] [--name <name>] [--share | --no-share]
<address-scope>
usage: openstack address scope set [-h] [--name <name>] [--share | --no-share]
<address-scope>Positional arguments
- <address-scope>
Address scope to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Set address scope name
- --share
Share the address scope between projects
- --no-share
Do not share the address scope between projects
2.22. openstack address scope show
usage: openstack address scope show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<address-scope>
usage: openstack address scope show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<address-scope>Positional arguments
- <address-scope>
Address scope to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.23. openstack aggregate add host
usage: openstack aggregate add host [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<aggregate> <host>
usage: openstack aggregate add host [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<aggregate> <host>Positional arguments
- <aggregate>
Aggregate (name or ID)
- <host>
Host to add to <aggregate>
Optional arguments
- -h, --help
show this help message and exit
2.24. openstack aggregate create
Positional arguments
- <name>
New aggregate name
Optional arguments
- -h, --help
show this help message and exit
- --zone <availability-zone>
Availability zone name
- --property <key=value>
Property to add to this aggregate (repeat option to
set multiple properties)
2.25. openstack aggregate delete
usage: openstack aggregate delete [-h] <aggregate> [<aggregate> ...]
usage: openstack aggregate delete [-h] <aggregate> [<aggregate> ...]Positional arguments
- <aggregate>
Aggregate(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.26. openstack aggregate list
usage: openstack aggregate list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long]
usage: openstack aggregate list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long]Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
2.27. openstack aggregate remove host
usage: openstack aggregate remove host [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<aggregate> <host>
usage: openstack aggregate remove host [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<aggregate> <host>Positional arguments
- <aggregate>
Aggregate (name or ID)
- <host>
Host to remove from <aggregate>
Optional arguments
- -h, --help
show this help message and exit
2.28. openstack aggregate set
usage: openstack aggregate set [-h] [--name <name>]
[--zone <availability-zone>]
[--property <key=value>]
<aggregate>
usage: openstack aggregate set [-h] [--name <name>]
[--zone <availability-zone>]
[--property <key=value>]
<aggregate>Positional arguments
- <aggregate>
Aggregate to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Set aggregate name
- --zone <availability-zone>
Set availability zone name
- --property <key=value>
Property to set on <aggregate> (repeat option to set
multiple properties)
2.29. openstack aggregate show
usage: openstack aggregate show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<aggregate>
usage: openstack aggregate show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<aggregate>Positional arguments
- <aggregate>
Aggregate to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.30. openstack aggregate unset
usage: openstack aggregate unset [-h] --property <key> <aggregate>
usage: openstack aggregate unset [-h] --property <key> <aggregate>Positional arguments
- <aggregate>
Aggregate to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --property <key>
Property to remove from aggregate (repeat option to remove
multiple properties)
2.31. openstack alarm create
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.32. openstack alarm delete
usage: openstack alarm delete [-h] [--name <NAME>] [<ALARM ID or NAME>]
usage: openstack alarm delete [-h] [--name <NAME>] [<ALARM ID or NAME>]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.33. openstack alarm list
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.34. openstack alarm show
usage: openstack alarm show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name <NAME>]
[<ALARM ID or NAME>]
usage: openstack alarm show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name <NAME>]
[<ALARM ID or NAME>]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.35. openstack alarm state get
usage: openstack alarm state get [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--name <NAME>]
[<ALARM ID or NAME>]
usage: openstack alarm state get [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--name <NAME>]
[<ALARM ID or NAME>]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.36. openstack alarm state set
usage: openstack alarm state set [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--name <NAME>] --state <STATE>
[<ALARM ID or NAME>]
usage: openstack alarm state set [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--name <NAME>] --state <STATE>
[<ALARM ID or NAME>]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.37. openstack alarm update
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.38. openstack alarm-history search
usage: openstack alarm-history search [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--query QUERY]
usage: openstack alarm-history search [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--query QUERY]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
2.39. openstack alarm-history show
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.40. openstack alarming capabilities list
usage: openstack alarming capabilities list [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
usage: openstack alarming capabilities list [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]Optional arguments
- -h, --help
show this help message and exit
2.41. openstack availability zone list
Optional arguments
- -h, --help
show this help message and exit
- --compute
List compute availability zones
- --network
List network availability zones
- --volume
List volume availability zones
- --long
List additional fields in output
2.42. openstack ca get
usage: openstack ca get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
URI
usage: openstack ca get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
URIPositional arguments
- URI
The URI reference for the CA.
Optional arguments
- -h, --help
show this help message and exit
2.43. openstack ca list
usage: openstack ca list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--limit LIMIT] [--offset OFFSET] [--name NAME]
usage: openstack ca list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--limit LIMIT] [--offset OFFSET] [--name NAME]Optional arguments
- -h, --help
show this help message and exit
- --limit LIMIT, -l LIMIT
specify the limit to the number of items to list per
page (default: 10; maximum: 100)
- --offset OFFSET, -o OFFSET
specify the page offset (default: 0)
- --name NAME, -n NAME
specify the secret name (default: None)
2.44. openstack catalog list
usage: openstack catalog list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
usage: openstack catalog list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.45. openstack catalog show
usage: openstack catalog show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<service>
usage: openstack catalog show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<service>Positional arguments
- <service>
Service to display (type or name)
Optional arguments
- -h, --help
show this help message and exit
2.46. openstack command list
usage: openstack command list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
usage: openstack command list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.47. openstack compute agent create
usage: openstack compute agent create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<os> <architecture> <version> <url>
<md5hash> <hypervisor>
usage: openstack compute agent create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<os> <architecture> <version> <url>
<md5hash> <hypervisor>Positional arguments
- <os>
Type of OS
- <architecture>
Type of architecture
- <version>
Version
- <url>
URL
- <md5hash>
MD5 hash
- <hypervisor>
Type of hypervisor
Optional arguments
- -h, --help
show this help message and exit
2.48. openstack compute agent delete
usage: openstack compute agent delete [-h] <id> [<id> ...]
usage: openstack compute agent delete [-h] <id> [<id> ...]Positional arguments
- <id>
ID of agent(s) to delete
Optional arguments
- -h, --help
show this help message and exit
2.49. openstack compute agent list
usage: openstack compute agent list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--hypervisor <hypervisor>]
usage: openstack compute agent list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--hypervisor <hypervisor>]Optional arguments
- -h, --help
show this help message and exit
- --hypervisor <hypervisor>
Type of hypervisor
2.50. openstack compute agent set
usage: openstack compute agent set [-h] [--agent-version <version>]
[--url <url>] [--md5hash <md5hash>]
<id>
usage: openstack compute agent set [-h] [--agent-version <version>]
[--url <url>] [--md5hash <md5hash>]
<id>Positional arguments
- <id>
ID of the agent
Optional arguments
- -h, --help
show this help message and exit
- --agent-version <version>
Version of the agent
- --url <url> URL
of the agent
- --md5hash <md5hash>
MD5 hash of the agent
2.51. openstack compute service delete
usage: openstack compute service delete [-h] <service> [<service> ...]
usage: openstack compute service delete [-h] <service> [<service> ...]Positional arguments
- <service>
Compute service(s) to delete (ID only)
Optional arguments
- -h, --help
show this help message and exit
2.52. openstack compute service list
Optional arguments
- -h, --help
show this help message and exit
- --host <host>
List services on specified host (name only)
- --service <service>
List only specified service (name only)
- --long
List additional fields in output
2.53. openstack compute service set
usage: openstack compute service set [-h] [--enable | --disable]
[--disable-reason <reason>]
[--up | --down]
<host> <service>
usage: openstack compute service set [-h] [--enable | --disable]
[--disable-reason <reason>]
[--up | --down]
<host> <service>Positional arguments
- <host>
Name of host
- <service>
Name of service (Binary name)
Optional arguments
- -h, --help
show this help message and exit
- --enable
Enable service
- --disable
Disable service
- --disable-reason <reason>
Reason for disabling the service (in quotas). Should
be used with --disable option.
- --up
Force up service
- --down
Force down service
2.54. openstack configuration show
usage: openstack configuration show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--mask | --unmask]
usage: openstack configuration show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--mask | --unmask]Optional arguments
- -h, --help
show this help message and exit
- --mask
Attempt to mask passwords (default)
- --unmask
Show password in clear text
2.55. openstack console log show
usage: openstack console log show [-h] [--lines <num-lines>] <server>
usage: openstack console log show [-h] [--lines <num-lines>] <server>Positional arguments
- <server>
Server to show console log (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --lines <num-lines>
Number of lines to display from the end of the log
(default=all)
2.56. openstack console url show
usage: openstack console url show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--novnc | --xvpvnc | --spice | --rdp | --serial | --mks]
<server>
usage: openstack console url show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--novnc | --xvpvnc | --spice | --rdp | --serial | --mks]
<server>Positional arguments
- <server>
Server to show URL (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --novnc
Show noVNC console URL (default)
- --xvpvnc
Show xvpvnc console URL
- --spice
Show SPICE console URL
- --rdp
Show RDP console URL
- --serial
Show serial console URL
- --mks
Show WebMKS console URL
2.57. openstack container create
usage: openstack container create [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
<container-name> [<container-name> ...]
usage: openstack container create [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
<container-name> [<container-name> ...]Positional arguments
- <container-name>
New container name(s)
Optional arguments
- -h, --help
show this help message and exit
2.58. openstack container delete
usage: openstack container delete [-h] [--recursive]
<container> [<container> ...]
usage: openstack container delete [-h] [--recursive]
<container> [<container> ...]Positional arguments
- <container>
Container(s) to delete
Optional arguments
- -h, --help
show this help message and exit
- --recursive, -r
Recursively delete objects and container
2.59. openstack container list
Optional arguments
- -h, --help
show this help message and exit
- --prefix <prefix>
Filter list using <prefix>
- --marker <marker>
Anchor for paging
- --end-marker <end-marker>
End anchor for paging
- --limit <limit>
Limit the number of containers returned
- --long
List additional fields in output
- --all
List all containers (default is 10000)
2.60. openstack container save
usage: openstack container save [-h] <container>
usage: openstack container save [-h] <container>Positional arguments
- <container>
Container to save
Optional arguments
- -h, --help
show this help message and exit
2.61. openstack container set
usage: openstack container set [-h] --property <key=value> <container>
usage: openstack container set [-h] --property <key=value> <container>Positional arguments
- <container>
Container to modify
Optional arguments
- -h, --help
show this help message and exit
- --property <key=value>
Set a property on this container (repeat option to set
multiple properties)
2.62. openstack container show
usage: openstack container show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<container>
usage: openstack container show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<container>Positional arguments
- <container>
Container to display
Optional arguments
- -h, --help
show this help message and exit
2.63. openstack container unset
usage: openstack container unset [-h] --property <key> <container>
usage: openstack container unset [-h] --property <key> <container>Positional arguments
- <container>
Container to modify
Optional arguments
- -h, --help
show this help message and exit
- --property <key>
Property to remove from container (repeat option to remove
multiple properties)
2.64. openstack dataprocessing cluster create
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Name of the cluster [REQUIRED if JSON is not provided]
- --cluster-template <cluster-template>
Cluster template name or ID [REQUIRED if JSON is not
provided]
- --image <image>
Image that will be used for cluster deployment (Name
or ID) [REQUIRED if JSON is not provided]
- --description <description>
Description of the cluster
- --user-keypair <keypair>
User keypair to get acces to VMs after cluster
creation
- --neutron-network <network>
Instances of the cluster will get fixed IP addresses
in this network. (Name or ID should be provided)
- --count <count>
Number of clusters to be created
- --public
Make the cluster public (Visible from other tenants)
- --protected
Make the cluster protected
- --transient
Create transient cluster
- --json <filename> JSON
representation of the cluster. Other arguments
(except for --wait) will not be taken into account if
this one is provided
- --wait
Wait for the cluster creation to complete
2.65. openstack dataprocessing cluster delete
usage: openstack dataprocessing cluster delete [-h] [--wait]
<cluster> [<cluster> ...]
usage: openstack dataprocessing cluster delete [-h] [--wait]
<cluster> [<cluster> ...]Positional arguments
- <cluster>
Name(s) or id(s) of the cluster(s) to delete
Optional arguments
- -h, --help
show this help message and exit
- --wait
Wait for the cluster(s) delete to complete
2.66. openstack dataprocessing cluster list
Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
- --plugin <plugin>
List clusters with specific plugin
- --plugin-version <plugin_version>
List clusters with specific version of the plugin
- --name <name-substring>
List clusters with specific substring in the name
2.67. openstack dataprocessing cluster scale
Positional arguments
- <cluster>
Name or ID of the cluster
Optional arguments
- -h, --help
show this help message and exit
- --instances <node-group-template:instances_count> [<node-group-template:instances_count> ...]
Node group templates and number of their instances to
be scale to [REQUIRED if JSON is not provided]
- --json <filename> JSON
representation of the cluster scale object. Other
arguments (except for --wait) will not be taken into
account if this one is provided
- --wait
Wait for the cluster scale to complete
2.68. openstack dataprocessing cluster show
Positional arguments
- <cluster>
Name or id of the cluster to display
Optional arguments
- -h, --help
show this help message and exit
- --verification
List additional fields for verifications
- --show-progress
Provides ability to show brief details of event logs.
- --full-dump-events
Provides ability to make full dump with event log
details.
2.69. openstack dataprocessing cluster template create
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Name of the cluster template [REQUIRED if JSON is not
provided]
- --node-groups <node-group:instances_count> [<node-group:instances_count> ...]
List of the node groups(names or IDs) and numbers of
instances for each one of them [REQUIRED if JSON is
not provided]
- --anti-affinity <anti-affinity> [<anti-affinity> ...]
List of processes that should be added to an anti-
affinity group
- --description <description>
Description of the cluster template
- --autoconfig
If enabled, instances of the cluster will be
automatically configured
- --public
Make the cluster template public (Visible from other
tenants)
- --protected
Make the cluster template protected
- --json <filename> JSON
representation of the cluster template. Other
arguments will not be taken into account if this one
is provided
- --shares <filename> JSON
representation of the manila shares
- --configs <filename> JSON
representation of the cluster template configs
- --domain-name <domain-name>
Domain name for instances of this cluster template.
This option is available if 'use_designate' config is
True
2.70. openstack dataprocessing cluster template delete
usage: openstack dataprocessing cluster template delete [-h]
<cluster-template>
[<cluster-template> ...]
usage: openstack dataprocessing cluster template delete [-h]
<cluster-template>
[<cluster-template> ...]Positional arguments
- <cluster-template>
Name(s) or id(s) of the cluster template(s) to delete
Optional arguments
- -h, --help
show this help message and exit
2.71. openstack dataprocessing cluster template list
Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
- --plugin <plugin>
List cluster templates for specific plugin
- --plugin-version <plugin_version>
List cluster templates with specific version of the
plugin
- --name <name-substring>
List cluster templates with specific substring in the
name
2.72. openstack dataprocessing cluster template show
Positional arguments
- <cluster-template>
Name or id of the cluster template to display
Optional arguments
- -h, --help
show this help message and exit
2.73. openstack dataprocessing cluster template update
Positional arguments
- <cluster-template>
Name or ID of the cluster template [REQUIRED]
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
New name of the cluster template
- --node-groups <node-group:instances_count> [<node-group:instances_count> ...]
List of the node groups(names or IDs) and numbers
ofinstances for each one of them
- --anti-affinity <anti-affinity> [<anti-affinity> ...]
List of processes that should be added to an anti-
affinity group
- --description <description>
Description of the cluster template
- --autoconfig-enable
Instances of the cluster will be automatically
configured
- --autoconfig-disable
Instances of the cluster will not be automatically
configured
- --public
Make the cluster template public (Visible from other
tenants)
- --private
Make the cluster template private (Visible only from
this tenant)
- --protected
Make the cluster template protected
- --unprotected
Make the cluster template unprotected
- --json <filename> JSON
representation of the cluster template. Other
arguments will not be taken into account if this one
is provided
- --shares <filename> JSON
representation of the manila shares
- --configs <filename> JSON
representation of the cluster template configs
- --domain-name <domain-name>
Domain name for instances of this cluster template.
This option is available if 'use_designate' config is
True
2.74. openstack dataprocessing cluster update
Positional arguments
- <cluster>
Name or ID of the cluster
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
New name of the cluster
- --description <description>
Description of the cluster
- --shares <filename> JSON
representation of the manila shares
- --public
Make the cluster public (Visible from other tenants)
- --private
Make the cluster private (Visible only from this
tenant)
- --protected
Make the cluster protected
- --unprotected
Make the cluster unprotected
2.75. openstack dataprocessing cluster verification
Positional arguments
- <cluster>
Name or ID of the cluster
Optional arguments
- -h, --help
show this help message and exit
- --start
Start health verification for the cluster
- --show
Show health of the cluster
2.76. openstack dataprocessing data source create
Positional arguments
- <name>
Name of the data source
Optional arguments
- -h, --help
show this help message and exit
- --type <type>
Type of the data source (swift, hdfs, maprfs, manila)
[REQUIRED]
- --url <url>
Url for the data source [REQUIRED]
- --username <username>
Username for accessing the data source url
- --password <password>
Password for accessing the data source url
- --description <description>
Description of the data source
- --public
Make the data source public
- --protected
Make the data source protected
2.77. openstack dataprocessing data source delete
usage: openstack dataprocessing data source delete [-h]
<data-source>
[<data-source> ...]
usage: openstack dataprocessing data source delete [-h]
<data-source>
[<data-source> ...]Positional arguments
- <data-source>
Name(s) or id(s) of the data source(s) to delete
Optional arguments
- -h, --help
show this help message and exit
2.78. openstack dataprocessing data source list
Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
- --type <type>
List data sources of specific type (swift, hdfs,
maprfs, manila)
2.79. openstack dataprocessing data source show
Positional arguments
- <data-source>
Name or id of the data source to display
Optional arguments
- -h, --help
show this help message and exit
2.80. openstack dataprocessing data source update
Positional arguments
- <data-source>
Name or id of the data source
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
New name of the data source
- --type <type>
Type of the data source (swift, hdfs, maprfs, manila)
- --url <url>
Url for the data source
- --username <username>
Username for accessing the data source url
- --password <password>
Password for accessing the data source url
- --description <description>
Description of the data source
- --public
Make the data source public (Visible from other
tenants)
- --private
Make the data source private (Visible only from this
tenant)
- --protected
Make the data source protected
- --unprotected
Make the data source unprotected
2.81. openstack dataprocessing image list
Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
- --name <name-regex>
Regular expression to match image name
- --tags <tag> [<tag> ...]
List images with specific tag(s)
- --username <username>
List images with specific username
2.82. openstack dataprocessing image register
Positional arguments
- <image>
Name or ID of the image to register
Optional arguments
- -h, --help
show this help message and exit
- --username <username>
Username of privileged user in the image [REQUIRED]
- --description <description>
Description of the image. If not provided, description
of the image will be reset to empty
2.83. openstack dataprocessing image show
usage: openstack dataprocessing image show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<image>
usage: openstack dataprocessing image show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<image>Positional arguments
- <image>
Name or id of the image to display
Optional arguments
- -h, --help
show this help message and exit
2.84. openstack dataprocessing image tags add
Positional arguments
- <image>
Name or id of the image
Optional arguments
- -h, --help
show this help message and exit
- --tags <tag> [<tag> ...]
Tag(s) to add [REQUIRED]
2.85. openstack dataprocessing image tags remove
Positional arguments
- <image>
Name or id of the image
Optional arguments
- -h, --help
show this help message and exit
- --tags <tag> [<tag> ...]
Tag(s) to remove
- --all
Remove all tags from image
2.86. openstack dataprocessing image tags set
Positional arguments
- <image>
Name or id of the image
Optional arguments
- -h, --help
show this help message and exit
- --tags <tag> [<tag> ...]
Tag(s) to set [REQUIRED]
2.87. openstack dataprocessing image unregister
usage: openstack dataprocessing image unregister [-h] <image> [<image> ...]
usage: openstack dataprocessing image unregister [-h] <image> [<image> ...]Positional arguments
- <image>
Name(s) or id(s) of the image(s) to unregister
Optional arguments
- -h, --help
show this help message and exit
2.88. openstack dataprocessing job binary create
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Name of the job binary [REQUIRED if JSON is not
provided]
- --data <file>
File that will be stored in the internal DB [REQUIRED
if JSON and URL are not provided]
- --url <url> URL
for the job binary [REQUIRED if JSON and file are
not provided]
- --description <description>
Description of the job binary
- --username <username>
Username for accessing the job binary URL
- --password <password>
Password for accessing the job binary URL
- --password-prompt
Prompt interactively for password
- --public
Make the job binary public
- --protected
Make the job binary protected
- --json <filename> JSON
representation of the job binary. Other arguments
will not be taken into account if this one is provided
2.89. openstack dataprocessing job binary delete
usage: openstack dataprocessing job binary delete [-h]
<job-binary>
[<job-binary> ...]
usage: openstack dataprocessing job binary delete [-h]
<job-binary>
[<job-binary> ...]Positional arguments
- <job-binary>
Name(s) or id(s) of the job binary(ies) to delete
Optional arguments
- -h, --help
show this help message and exit
2.90. openstack dataprocessing job binary download
usage: openstack dataprocessing job binary download [-h] [--file <file>]
<job-binary>
usage: openstack dataprocessing job binary download [-h] [--file <file>]
<job-binary>Positional arguments
- <job-binary>
Name or ID of the job binary to download
Optional arguments
- -h, --help
show this help message and exit
- --file <file>
Destination file (defaults to job binary name)
2.91. openstack dataprocessing job binary list
Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
- --name <name-substring>
List job binaries with specific substring in the name
2.92. openstack dataprocessing job binary show
Positional arguments
- <job-binary>
Name or ID of the job binary to display
Optional arguments
- -h, --help
show this help message and exit
2.93. openstack dataprocessing job binary update
Positional arguments
- <job-binary>
Name or ID of the job binary
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
New name of the job binary
- --url <url> URL
for the job binary [Internal DB URL can not be
updated]
- --description <description>
Description of the job binary
- --username <username>
Username for accessing the job binary URL
- --password <password>
Password for accessing the job binary URL
- --password-prompt
Prompt interactively for password
- --public
Make the job binary public (Visible from other
tenants)
- --private
Make the job binary private (Visible only from this
tenant)
- --protected
Make the job binary protected
- --unprotected
Make the job binary unprotected
- --json <filename> JSON
representation of the update object. Other
arguments will not be taken into account if this one
is provided
2.94. openstack dataprocessing job delete
usage: openstack dataprocessing job delete [-h] [--wait] <job> [<job> ...]
usage: openstack dataprocessing job delete [-h] [--wait] <job> [<job> ...]Positional arguments
- <job>
ID(s) of the job(s) to delete
Optional arguments
- -h, --help
show this help message and exit
- --wait
Wait for the job(s) delete to complete
2.95. openstack dataprocessing job execute
Optional arguments
- -h, --help
show this help message and exit
- --job-template <job-template>
Name or ID of the job template [REQUIRED if JSON is
not provided]
- --cluster <cluster>
Name or ID of the cluster [REQUIRED if JSON is not
provided]
- --input <input>
Name or ID of the input data source
- --output <output>
Name or ID of the output data source
- --params <name:value> [<name:value> ...]
Parameters to add to the job
- --args <argument> [<argument> ...]
Arguments to add to the job
- --public
Make the job public
- --protected
Make the job protected
- --config-json <filename>
JSON representation of the job configs
- --configs <name:value> [<name:value> ...]
Configs to add to the job
- --interface <filename>
JSON representation of the interface
- --json <filename> JSON
representation of the job. Other arguments will
not be taken into account if this one is provided
2.96. openstack dataprocessing job list
usage: openstack dataprocessing job list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long] [--status <status>]
usage: openstack dataprocessing job list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long] [--status <status>]Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
- --status <status>
List jobs with specific status
2.97. openstack dataprocessing job show
usage: openstack dataprocessing job show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<job>
usage: openstack dataprocessing job show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<job>Positional arguments
- <job>
ID of the job to display
Optional arguments
- -h, --help
show this help message and exit
2.98. openstack dataprocessing job template create
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Name of the job template [REQUIRED if JSON is not
provided]
- --type <type>
Type of the job (Hive, Java, MapReduce, Storm,
Storm.Pyleus, Pig, Shell, MapReduce.Streaming, Spark)
[REQUIRED if JSON is not provided]
- --mains <main> [<main> ...]
Name(s) or ID(s) for job's main job binary(s)
- --libs <lib> [<lib> ...]
Name(s) or ID(s) for job's lib job binary(s)
- --description <description>
Description of the job template
- --public
Make the job template public
- --protected
Make the job template protected
- --interface <filename>
JSON representation of the interface
- --json <filename> JSON
representation of the job template
2.99. openstack dataprocessing job template delete
usage: openstack dataprocessing job template delete [-h]
<job-template>
[<job-template> ...]
usage: openstack dataprocessing job template delete [-h]
<job-template>
[<job-template> ...]Positional arguments
- <job-template>
Name(s) or id(s) of the job template(s) to delete
Optional arguments
- -h, --help
show this help message and exit
2.100. openstack dataprocessing job template list
Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
- --type <type>
List job templates of specific type
- --name <name-substring>
List job templates with specific substring in the name
2.101. openstack dataprocessing job template show
Positional arguments
- <job-template>
Name or ID of the job template to display
Optional arguments
- -h, --help
show this help message and exit
2.102. openstack dataprocessing job template update
Positional arguments
- <job-template>
Name or ID of the job template
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
New name of the job template
- --description <description>
Description of the job template
- --public
Make the job template public (Visible from other
tenants)
- --private
Make the job_template private (Visible only from this
tenant)
- --protected
Make the job template protected
- --unprotected
Make the job template unprotected
2.103. openstack dataprocessing job type configs get
usage: openstack dataprocessing job type configs get [-h] [--file <file>]
<job-type>
usage: openstack dataprocessing job type configs get [-h] [--file <file>]
<job-type>Positional arguments
- <job-type>
Type of the job to provide config information about
Optional arguments
- -h, --help
show this help message and exit
- --file <file>
Destination file (defaults to job type)
2.104. openstack dataprocessing job type list
Optional arguments
- -h, --help
show this help message and exit
- --type <type>
Get information about specific job type
- --plugin <plugin>
Get only job types supported by this plugin
- --plugin-version <plugin_version>
Get only job types supported by specific version of
the plugin. This parameter will be taken into account
only if plugin is provided
2.105. openstack dataprocessing job update
Positional arguments
- <job>
ID of the job to update
Optional arguments
- -h, --help
show this help message and exit
- --public
Make the job public (Visible from other tenants)
- --private
Make the job private (Visible only from this tenant)
- --protected
Make the job protected
- --unprotected
Make the job unprotected
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Name of the node group template [REQUIRED if JSON is
not provided]
- --plugin <plugin>
Name of the plugin [REQUIRED if JSON is not provided]
- --plugin-version <plugin_version>
Version of the plugin [REQUIRED if JSON is not
provided]
- --processes <processes> [<processes> ...]
List of the processes that will be launched on each
instance [REQUIRED if JSON is not provided]
- --flavor <flavor>
Name or ID of the flavor [REQUIRED if JSON is not
provided]
- --security-groups <security-groups> [<security-groups> ...]
List of the security groups for the instances in this
node group
- --auto-security-group
Indicates if an additional security group should be
created for the node group
- --availability-zone <availability-zone>
Name of the availability zone where instances will be
created
- --floating-ip-pool <floating-ip-pool>
ID of the floating IP pool
- --volumes-per-node <volumes-per-node>
Number of volumes attached to every node
- --volumes-size <volumes-size>
Size of volumes attached to node (GB). This parameter
will be taken into account only if volumes-per-node is
set and non-zero
- --volumes-type <volumes-type>
Type of the volumes. This parameter will be taken into
account only if volumes-per-node is set and non-zero
- --volumes-availability-zone <volumes-availability-zone>
Name of the availability zone where volumes will be
created. This parameter will be taken into account
only if volumes-per-node is set and non-zero
- --volumes-mount-prefix <volumes-mount-prefix>
Prefix for mount point directory. This parameter will
be taken into account only if volumes-per-node is set
and non-zero
- --volumes-locality
If enabled, instance and attached volumes will be
created on the same physical host. This parameter will
be taken into account only if volumes-per-node is set
and non-zero
- --description <description>
Description of the node group template
- --autoconfig
If enabled, instances of the node group will be
automatically configured
- --proxy-gateway
If enabled, instances of the node group will be used
to access other instances in the cluster
- --public
Make the node group template public (Visible from
other tenants)
- --protected
Make the node group template protected
- --json <filename> JSON
representation of the node group template. Other
arguments will not be taken into account if this one
is provided
- --shares <filename> JSON
representation of the manila shares
- --configs <filename> JSON
representation of the node group template configs
usage: openstack dataprocessing node group template delete [-h]
<node-group-template>
[<node-group-template> ...]
usage: openstack dataprocessing node group template delete [-h]
<node-group-template>
[<node-group-template> ...]Positional arguments
- <node-group-template>
Name(s) or id(s) of the node group template(s) to
delete
Optional arguments
- -h, --help
show this help message and exit
2.108. openstack dataprocessing node group template list
Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
- --plugin <plugin>
List node group templates for specific plugin
- --plugin-version <plugin_version>
List node group templates with specific version of the
plugin
- --name <name-substring>
List node group templates with specific substring in
the name
2.109. openstack dataprocessing node group template show
Positional arguments
- <node-group-template>
Name or id of the node group template to display
Optional arguments
- -h, --help
show this help message and exit
Positional arguments
- <node-group-template>
Name or ID of the node group template
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
New name of the node group template
- --plugin <plugin>
Name of the plugin
- --plugin-version <plugin_version>
Version of the plugin
- --processes <processes> [<processes> ...]
List of the processes that will be launched on each
instance
- --security-groups <security-groups> [<security-groups> ...]
List of the security groups for the instances in this
node group
- --auto-security-group-enable
Additional security group should be created for the
node group
- --auto-security-group-disable
Additional security group should not be created for
the node group
- --availability-zone <availability-zone>
Name of the availability zone where instances will be
created
- --flavor <flavor>
Name or ID of the flavor
- --floating-ip-pool <floating-ip-pool>
ID of the floating IP pool
- --volumes-per-node <volumes-per-node>
Number of volumes attached to every node
- --volumes-size <volumes-size>
Size of volumes attached to node (GB). This parameter
will be taken into account only if volumes-per-node is
set and non-zero
- --volumes-type <volumes-type>
Type of the volumes. This parameter will be taken into
account only if volumes-per-node is set and non-zero
- --volumes-availability-zone <volumes-availability-zone>
Name of the availability zone where volumes will be
created. This parameter will be taken into account
only if volumes-per-node is set and non-zero
- --volumes-mount-prefix <volumes-mount-prefix>
Prefix for mount point directory. This parameter will
be taken into account only if volumes-per-node is set
and non-zero
- --volumes-locality-enable
Instance and attached volumes will be created on the
same physical host. This parameter will be taken into
account only if volumes-per-node is set and non-zero
- --volumes-locality-disable
Instance and attached volumes creation on the same
physical host will not be regulated. This parameter
will be takeninto account only if volumes-per-node is
set and non-zero
- --description <description>
Description of the node group template
- --autoconfig-enable
Instances of the node group will be automatically
configured
- --autoconfig-disable
Instances of the node group will not be automatically
configured
- --proxy-gateway-enable
Instances of the node group will be used to access
other instances in the cluster
- --proxy-gateway-disable
Instances of the node group will not be used to access
other instances in the cluster
- --public
Make the node group template public (Visible from
other tenants)
- --private
Make the node group template private (Visible only
from this tenant)
- --protected
Make the node group template protected
- --unprotected
Make the node group template unprotected
- --json <filename> JSON
representation of the node group template update
fields. Other arguments will not be taken into account
if this one is provided
- --shares <filename> JSON
representation of the manila shares
- --configs <filename> JSON
representation of the node group template configs
2.111. openstack dataprocessing plugin configs get
usage: openstack dataprocessing plugin configs get [-h] [--file <file>]
<plugin> <plugin_version>
usage: openstack dataprocessing plugin configs get [-h] [--file <file>]
<plugin> <plugin_version>Positional arguments
- <plugin>
Name of the plugin to provide config information about
- <plugin_version>
Version of the plugin to provide config information about
Optional arguments
- -h, --help
show this help message and exit
- --file <file>
Destination file (defaults to plugin name)
2.112. openstack dataprocessing plugin list
Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
2.113. openstack dataprocessing plugin show
Positional arguments
- <plugin>
Name of the plugin to display
Optional arguments
- -h, --help
show this help message and exit
- --plugin-version <plugin_version>
Version of the plugin to display
2.114. openstack dataprocessing plugin update
Positional arguments
- <plugin>
Name of the plugin to provide config information about
- <json>
JSON representation of the plugin update dictionary
Optional arguments
- -h, --help
show this help message and exit
2.115. openstack dns quota list
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
- --project-id PROJECT_ID
Project ID Default: current project
2.116. openstack dns quota reset
usage: openstack dns quota reset [-h] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
[--project-id PROJECT_ID]
usage: openstack dns quota reset [-h] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
[--project-id PROJECT_ID]Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
- --project-id PROJECT_ID
Project ID
2.117. openstack dns quota set
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
- --project-id PROJECT_ID
Project ID
- --api-export-size <api-export-size>
New value for the api-export-size quota
- --zones <zones>
New value for the zones quota
- --recordset-records <recordset-records>
New value for the recordset-records quota
- --zone-records <zone-records>
New value for the zone-records quota
- --zone-recordsets <zone-recordsets>
New value for the zone-recordsets quota
2.118. openstack dns service list
Optional arguments
- -h, --help
show this help message and exit
- --hostname HOSTNAME
Hostname
- --service_name SERVICE_NAME
Service Name
- --status STATUS
Status
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.119. openstack dns service show
Positional arguments
- id
Service Status ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.120. openstack ec2 credentials create
usage: openstack ec2 credentials create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--project <project>] [--user <user>]
usage: openstack ec2 credentials create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--project <project>] [--user <user>]Optional arguments
- -h, --help
show this help message and exit
- --project <project>
Create credentials in project (name or ID; default:
current authenticated project)
- --user <user>
Create credentials for user (name or ID; default:
current authenticated user)
2.121. openstack ec2 credentials delete
usage: openstack ec2 credentials delete [-h] [--user <user>]
<access-key> [<access-key> ...]
usage: openstack ec2 credentials delete [-h] [--user <user>]
<access-key> [<access-key> ...]Positional arguments
- <access-key>
Credentials access key(s)
Optional arguments
- -h, --help
show this help message and exit
- --user <user>
Delete credentials for user (name or ID)
2.122. openstack ec2 credentials list
usage: openstack ec2 credentials list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--user <user>]
usage: openstack ec2 credentials list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--user <user>]Optional arguments
- -h, --help
show this help message and exit
- --user <user>
Filter list by user (name or ID)
2.123. openstack ec2 credentials show
usage: openstack ec2 credentials show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--user <user>]
<access-key>
usage: openstack ec2 credentials show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--user <user>]
<access-key>Positional arguments
- <access-key>
Credentials access key
Optional arguments
- -h, --help
show this help message and exit
- --user <user>
Show credentials for user (name or ID)
2.124. openstack endpoint create
Positional arguments
- <service>
Service to be associated with new endpoint (name or
ID)
Optional arguments
- -h, --help
show this help message and exit
- --publicurl <url>
New endpoint public URL (required)
- --adminurl <url>
New endpoint admin URL
- --internalurl <url>
New endpoint internal URL
- --region <region-id>
New endpoint region ID
2.125. openstack endpoint delete
usage: openstack endpoint delete [-h] <endpoint-id> [<endpoint-id> ...]
usage: openstack endpoint delete [-h] <endpoint-id> [<endpoint-id> ...]Positional arguments
- <endpoint-id>
Endpoint(s) to delete (ID only)
Optional arguments
- -h, --help
show this help message and exit
2.126. openstack endpoint list
usage: openstack endpoint list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long]
usage: openstack endpoint list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long]Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
2.127. openstack endpoint show
usage: openstack endpoint show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<endpoint>
usage: openstack endpoint show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<endpoint>Positional arguments
- <endpoint>
Endpoint to display (endpoint ID, service ID, service
name, service type)
Optional arguments
- -h, --help
show this help message and exit
2.128. openstack extension list
Optional arguments
- -h, --help
show this help message and exit
- --compute
List extensions for the Compute API
- --identity
List extensions for the Identity API
- --network
List extensions for the Network API
- --volume
List extensions for the Block Storage API
- --long
List additional fields in output
2.129. openstack flavor create
Positional arguments
- <flavor-name>
New flavor name
Optional arguments
- -h, --help
show this help message and exit
- --id <id>
Unique flavor ID; 'auto' creates a UUID (default:
auto)
- --ram <size-mb>
Memory size in MB (default 256M)
- --disk <size-gb>
Disk size in GB (default 0G)
- --ephemeral <size-gb>
Ephemeral disk size in GB (default 0G)
- --swap <size-gb>
Swap space size in GB (default 0G)
- --vcpus <vcpus>
Number of vcpus (default 1)
- --rxtx-factor <factor>
RX/TX factor (default 1.0)
- --public
Flavor is available to other projects (default)
- --private
Flavor is not available to other projects
- --property <key=value>
Property to add for this flavor (repeat option to set
multiple properties)
- --project <project>
Allow <project> to access private flavor (name or ID)
(Must be used with --private option)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
2.130. openstack flavor delete
usage: openstack flavor delete [-h] <flavor> [<flavor> ...]
usage: openstack flavor delete [-h] <flavor> [<flavor> ...]Positional arguments
- <flavor>
Flavor(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.131. openstack flavor list
usage: openstack flavor list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--public | --private | --all] [--long]
[--marker <marker>] [--limit <limit>]
usage: openstack flavor list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--public | --private | --all] [--long]
[--marker <marker>] [--limit <limit>]Optional arguments
- -h, --help
show this help message and exit
- --public
List only public flavors (default)
- --private
List only private flavors
- --all
List all flavors, whether public or private
- --long
List additional fields in output
- --marker <marker>
The last flavor ID of the previous page
- --limit <limit>
Maximum number of flavors to display
2.132. openstack flavor set
usage: openstack flavor set [-h] [--property <key=value>]
[--project <project>]
[--project-domain <project-domain>]
<flavor>
usage: openstack flavor set [-h] [--property <key=value>]
[--project <project>]
[--project-domain <project-domain>]
<flavor>Positional arguments
- <flavor>
Flavor to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --property <key=value>
Property to add or modify for this flavor (repeat
option to set multiple properties)
- --project <project>
Set flavor access to project (name or ID) (admin only)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
2.133. openstack flavor show
usage: openstack flavor show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<flavor>
usage: openstack flavor show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<flavor>Positional arguments
- <flavor>
Flavor to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.134. openstack flavor unset
usage: openstack flavor unset [-h] [--property <key>] [--project <project>]
[--project-domain <project-domain>]
<flavor>
usage: openstack flavor unset [-h] [--property <key>] [--project <project>]
[--project-domain <project-domain>]
<flavor>Positional arguments
- <flavor>
Flavor to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --property <key>
Property to remove from flavor (repeat option to unset
multiple properties)
- --project <project>
Remove flavor access from project (name or ID) (admin
only)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
2.135. openstack floating ip create
Positional arguments
- <network>
Network to allocate floating IP from (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --subnet <subnet>
Subnet on which you want to create the floating IP
(name or ID)
- --port <port>
Port to be associated with the floating IP (name or
ID)
- --floating-ip-address <floating-ip-address>
Floating IP address
- --fixed-ip-address <fixed-ip-address>
Fixed IP address mapped to the floating IP
2.136. openstack floating ip delete
usage: openstack floating ip delete [-h] <floating-ip> [<floating-ip> ...]
usage: openstack floating ip delete [-h] <floating-ip> [<floating-ip> ...]Positional arguments
- <floating-ip>
Floating IP(s) to delete (IP address or ID)
Optional arguments
- -h, --help
show this help message and exit
2.137. openstack floating ip list
usage: openstack floating ip list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
usage: openstack floating ip list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.138. openstack floating ip pool
Command "floating ip pool" matches: floating ip pool list
Command "floating ip pool" matches:
floating ip pool list2.139. openstack floating ip show
usage: openstack floating ip show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<floating-ip>
usage: openstack floating ip show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<floating-ip>Positional arguments
- <floating-ip>
Floating IP to display (IP address or ID)
Optional arguments
- -h, --help
show this help message and exit
2.140. openstack host list
usage: openstack host list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--zone <zone>]
usage: openstack host list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--zone <zone>]Optional arguments
- -h, --help
show this help message and exit
- --zone <zone>
Only return hosts in the availability zone
2.141. openstack host set
usage: openstack host set [-h] [--enable | --disable]
[--enable-maintenance | --disable-maintenance]
<host>
usage: openstack host set [-h] [--enable | --disable]
[--enable-maintenance | --disable-maintenance]
<host>Positional arguments
- <host>
Host to modify (name only)
Optional arguments
- -h, --help
show this help message and exit
- --enable
Enable the host
- --disable
Disable the host
- --enable-maintenance
Enable maintenance mode for the host
- --disable-maintenance
Disable maintenance mode for the host
2.142. openstack host show
usage: openstack host show [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
<host>
usage: openstack host show [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
<host>Positional arguments
- <host>
Name of host
Optional arguments
- -h, --help
show this help message and exit
2.143. openstack hypervisor list
usage: openstack hypervisor list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--matching <hostname>]
usage: openstack hypervisor list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--matching <hostname>]Optional arguments
- -h, --help
show this help message and exit
- --matching <hostname>
Filter hypervisors using <hostname> substring
2.144. openstack hypervisor show
usage: openstack hypervisor show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<hypervisor>
usage: openstack hypervisor show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<hypervisor>Positional arguments
- <hypervisor>
Hypervisor to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.145. openstack hypervisor stats show
usage: openstack hypervisor stats show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
usage: openstack hypervisor stats show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]Optional arguments
- -h, --help
show this help message and exit
2.146. openstack image add project
usage: openstack image add project [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--project-domain <project-domain>]
<image> <project>
usage: openstack image add project [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--project-domain <project-domain>]
<image> <project>Positional arguments
- <image>
Image to share (name or ID)
- <project>
Project to associate with image (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
2.147. openstack image create
Positional arguments
- <image-name>
New image name
Optional arguments
- -h, --help
show this help message and exit
- --id <id>
Image ID to reserve
- --container-format <container-format>
Image container format (default: bare)
- --disk-format <disk-format>
Image disk format (default: raw)
- --min-disk <disk-gb>
Minimum disk size needed to boot image, in gigabytes
- --min-ram <ram-mb>
Minimum RAM size needed to boot image, in megabytes
- --file <file>
Upload image from local file
- --volume <volume>
Create image from a volume
- --force
Force image creation if volume is in use (only
meaningful with --volume)
- --protected
Prevent image from being deleted
- --unprotected
Allow image to be deleted (default)
- --public
Image is accessible to the public
- --private
Image is inaccessible to the public (default)
- --property <key=value>
Set a property on this image (repeat option to set
multiple properties)
- --tag <tag>
Set a tag on this image (repeat option to set multiple
tags)
- --project <project>
Set an alternate project on this image (name or ID)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
2.148. openstack image delete
usage: openstack image delete [-h] <image> [<image> ...]
usage: openstack image delete [-h] <image> [<image> ...]Positional arguments
- <image>
Image(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.149. openstack image list
Optional arguments
- -h, --help
show this help message and exit
- --public
List only public images
- --private
List only private images
- --shared
List only shared images
- --property <key=value>
Filter output based on property
- --long
List additional fields in output
- --sort <key>[:<direction>]
Sort output by selected keys and directions(asc or
desc) (default: asc), multiple keys and directions can
be specified separated by comma
- --limit <limit>
Maximum number of images to display.
- --marker <marker>
The last image (name or ID) of the previous page.
Display list of images after marker. Display all
images if not specified.
2.150. openstack image remove project
usage: openstack image remove project [-h] [--project-domain <project-domain>]
<image> <project>
usage: openstack image remove project [-h] [--project-domain <project-domain>]
<image> <project>Positional arguments
- <image>
Image to unshare (name or ID)
- <project>
Project to disassociate with image (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
2.151. openstack image save
usage: openstack image save [-h] [--file <filename>] <image>
usage: openstack image save [-h] [--file <filename>] <image>Positional arguments
- <image>
Image to save (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --file <filename>
Downloaded image save filename (default: stdout)
2.152. openstack image set
Positional arguments
- <image>
Image to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
New image name
- --min-disk <disk-gb>
Minimum disk size needed to boot image, in gigabytes
- --min-ram <ram-mb>
Minimum RAM size needed to boot image, in megabytes
- --container-format <container-format>
Image container format (default: bare)
- --disk-format <disk-format>
Image disk format (default: raw)
- --protected
Prevent image from being deleted
- --unprotected
Allow image to be deleted (default)
- --public
Image is accessible to the public
- --private
Image is inaccessible to the public (default)
- --property <key=value>
Set a property on this image (repeat option to set
multiple properties)
- --tag <tag>
Set a tag on this image (repeat option to set multiple
tags)
- --architecture <architecture>
Operating system architecture
- --instance-id <instance-id>
ID of server instance used to create this image
- --kernel-id <kernel-id>
ID of kernel image used to boot this disk image
- --os-distro <os-distro>
Operating system distribution name
- --os-version <os-version>
Operating system distribution version
- --ramdisk-id <ramdisk-id>
ID of ramdisk image used to boot this disk image
- --deactivate
Deactivate the image
- --activate
Activate the image
- --project <project>
Set an alternate project on this image (name or ID)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
2.153. openstack image show
usage: openstack image show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<image>
usage: openstack image show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<image>Positional arguments
- <image>
Image to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.154. openstack image unset
usage: openstack image unset [-h] [--tag <tag>] [--property <property_key>]
<image>
usage: openstack image unset [-h] [--tag <tag>] [--property <property_key>]
<image>Positional arguments
- <image>
Image to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --tag <tag>
Unset a tag on this image (repeat option to set
multiple tags)
- --property <property_key>
Unset a property on this image (repeat option to set
multiple properties)
2.155. openstack ip availability list
Optional arguments
- -h, --help
show this help message and exit
- --ip-version <ip-version>
List IP availability of given IP version networks
(default is 4)
- --project <project>
List IP availability of given project (name or ID)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
2.156. openstack ip availability show
usage: openstack ip availability show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<network>
usage: openstack ip availability show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<network>Positional arguments
- <network>
Show IP availability for a specific network (name or
ID)
Optional arguments
- -h, --help
show this help message and exit
2.157. openstack keypair create
usage: openstack keypair create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--public-key <file>]
<name>
usage: openstack keypair create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--public-key <file>]
<name>Positional arguments
- <name>
New public key name
Optional arguments
- -h, --help
show this help message and exit
- --public-key <file>
Filename for public key to add
2.158. openstack keypair delete
usage: openstack keypair delete [-h] <key> [<key> ...]
usage: openstack keypair delete [-h] <key> [<key> ...]Positional arguments
- <key>
Public key(s) to delete (name only)
Optional arguments
- -h, --help
show this help message and exit
2.159. openstack keypair list
usage: openstack keypair list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
usage: openstack keypair list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.160. openstack keypair show
usage: openstack keypair show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--public-key]
<key>
usage: openstack keypair show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--public-key]
<key>Positional arguments
- <key>
Public key to display (name only)
Optional arguments
- -h, --help
show this help message and exit
- --public-key
Show only bare public key (name only)
2.161. openstack limits show
usage: openstack limits show [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
(--absolute | --rate) [--reserved]
[--project <project>] [--domain <domain>]
usage: openstack limits show [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
(--absolute | --rate) [--reserved]
[--project <project>] [--domain <domain>]Optional arguments
- -h, --help
show this help message and exit
- --absolute
Show absolute limits
- --rate
Show rate limits
- --reserved
Include reservations count [only valid with
--absolute]
- --project <project>
Show limits for a specific project (name or ID) [only
valid with --absolute]
- --domain <domain>
Domain the project belongs to (name or ID) [only valid
with --absolute]
2.162. openstack metric archive-policy create
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
2.163. openstack metric archive-policy delete
usage: openstack metric archive-policy delete [-h] name
usage: openstack metric archive-policy delete [-h] namePositional arguments
- name
Name of the archive policy
Optional arguments
- -h, --help
show this help message and exit
2.164. openstack metric archive-policy list
Optional arguments
- -h, --help
show this help message and exit
2.165. openstack metric archive-policy show
Positional arguments
- name
Name of the archive policy
Optional arguments
- -h, --help
show this help message and exit
2.166. openstack metric archive-policy-rule create
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
2.167. openstack metric archive-policy-rule delete
usage: openstack metric archive-policy-rule delete [-h] name
usage: openstack metric archive-policy-rule delete [-h] namePositional arguments
- name
Name of the archive policy rule
Optional arguments
- -h, --help
show this help message and exit
2.168. openstack metric archive-policy-rule list
Optional arguments
- -h, --help
show this help message and exit
2.169. openstack metric archive-policy-rule show
Positional arguments
- name
Name of the archive policy rule
Optional arguments
- -h, --help
show this help message and exit
2.170. openstack metric benchmark measures add
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
2.171. openstack metric benchmark measures 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 (in seconds)
- --refresh
force aggregation of all known measures
- --workers WORKERS, -w WORKERS
Number of workers to use
- --count COUNT, -n COUNT
Number of total measures to send
2.172. openstack metric benchmark metric create
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
2.173. openstack metric benchmark 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
2.174. openstack metric capabilities list
usage: openstack metric capabilities list [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
usage: openstack metric capabilities list [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]Optional arguments
- -h, --help
show this help message and exit
2.175. openstack metric measures add
usage: openstack metric measures add [-h] [--resource-id RESOURCE_ID] -m
MEASURE
metric
usage: openstack metric measures add [-h] [--resource-id RESOURCE_ID] -m
MEASURE
metricPositional 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 '@'
2.176. openstack metric measures aggregation
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 (in seconds)
- --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
2.177. openstack metric measures batch-metrics
usage: openstack metric measures batch-metrics [-h] file
usage: openstack metric measures batch-metrics [-h] filePositional 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
2.178. openstack metric measures batch-resources-metrics
usage: openstack metric measures batch-resources-metrics [-h] file
usage: openstack metric measures batch-resources-metrics [-h] filePositional 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
2.179. openstack metric measures 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 (in seconds)
- --refresh
force aggregation of all known measures
2.180. openstack metric metric create
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
2.181. openstack metric metric delete
usage: openstack metric metric delete [-h] [--resource-id RESOURCE_ID]
metric [metric ...]
usage: openstack metric metric delete [-h] [--resource-id RESOURCE_ID]
metric [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
2.182. openstack metric metric list
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
2.183. openstack metric metric show
usage: openstack metric metric show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--resource-id RESOURCE_ID]
metric
usage: openstack metric metric show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--resource-id RESOURCE_ID]
metricPositional 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
2.184. openstack metric resource create
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
2.185. openstack metric resource delete
usage: openstack metric resource delete [-h] resource_id
usage: openstack metric resource delete [-h] resource_idPositional arguments
- resource_id
ID of the resource
Optional arguments
- -h, --help
show this help message and exit
2.186. openstack metric resource history
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
2.187. openstack metric resource list
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
2.188. openstack metric resource search
Positional arguments
- query
A query to filter resource. The syntax is a
combination of attribute, operator and value. For
example: id=90d58eea-70d7-4294-a49a-170dcdf44c3c would
filter resource with a certain id. More complex
queries can be built, e.g.: not (flavor_id!="1" and
memory>=24). Use "" to force data to be interpreted as
string. Supported operators are: not, and, ∧ or, ∨,
>=, <=, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in,
like, ≠, ≥, ≤, like, in.
Optional arguments
- -h, --help
show this help message and exit
- --details
Show all attributes of generic resources
- --history
Show history of the resources
- --limit <LIMIT>
Number of resources to return (Default is server
default)
- --marker <MARKER>
Last item of the previous listing. Return the next
results after this value
- --sort <SORT>
Sort of resource attribute (example: user_id:desc-
nullslast
- --type RESOURCE_TYPE, -t RESOURCE_TYPE
Type of resource
2.189. openstack metric resource show
usage: openstack metric resource show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--type RESOURCE_TYPE]
resource_id
usage: openstack metric resource show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--type RESOURCE_TYPE]
resource_idPositional 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
2.190. openstack metric resource update
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
2.191. openstack metric resource-type create
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
2.192. openstack metric resource-type delete
usage: openstack metric resource-type delete [-h] name
usage: openstack metric resource-type delete [-h] namePositional arguments
- name
name of the resource type
Optional arguments
- -h, --help
show this help message and exit
2.193. openstack metric resource-type list
usage: openstack metric resource-type list [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
usage: openstack metric resource-type list [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.194. openstack metric resource-type show
usage: openstack metric resource-type show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
name
usage: openstack metric resource-type show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
namePositional arguments
- name
name of the resource type
Optional arguments
- -h, --help
show this help message and exit
2.195. openstack metric status
usage: openstack metric status [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
usage: openstack metric status [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]Optional arguments
- -h, --help
show this help message and exit
2.196. openstack module list
usage: openstack module list [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--all]
usage: openstack module list [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--all]Optional arguments
- -h, --help
show this help message and exit
- --all
Show all modules that have version information
2.197. openstack network agent delete
usage: openstack network agent delete [-h]
<network-agent> [<network-agent> ...]
usage: openstack network agent delete [-h]
<network-agent> [<network-agent> ...]Positional arguments
- <network-agent>
Network agent(s) to delete (ID only)
Optional arguments
- -h, --help
show this help message and exit
2.198. openstack network agent list
usage: openstack network agent list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
usage: openstack network agent list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.199. openstack network agent set
usage: openstack network agent set [-h] [--description <description>]
[--enable | --disable]
<network-agent>
usage: openstack network agent set [-h] [--description <description>]
[--enable | --disable]
<network-agent>Positional arguments
- <network-agent>
Network agent to modify (ID only)
Optional arguments
- -h, --help
show this help message and exit
- --description <description>
Set network agent description
- --enable
Enable network agent
- --disable
Disable network agent
2.200. openstack network agent show
usage: openstack network agent show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<network-agent>
usage: openstack network agent show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<network-agent>Positional arguments
- <network-agent>
Network agent to display (ID only)
Optional arguments
- -h, --help
show this help message and exit
2.201. openstack network create
Positional arguments
- <name>
New network name
Optional arguments
- -h, --help
show this help message and exit
- --share
Share the network between projects
- --no-share
Do not share the network between projects
- --enable
Enable network (default)
- --disable
Disable network
- --project <project>
Owner's project (name or ID)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
- --availability-zone-hint <availability-zone>
Availability Zone in which to create this network
(Network Availability Zone extension required, repeat
option to set multiple availability zones)
- --enable-port-security
Enable port security by default for ports created on
this network (default)
- --disable-port-security
Disable port security by default for ports created on
this network
- --external
Set this network as an external network (external-net
extension required)
- --internal
Set this network as an internal network (default)
- --default
Specify if this network should be used as the default
external network
- --no-default
Do not use the network as the default external network
(default)
- --provider-network-type <provider-network-type>
The physical mechanism by which the virtual network is
implemented. The supported options are: flat, geneve,
gre, local, vlan, vxlan.
- --provider-physical-network <provider-physical-network>
Name of the physical network over which the virtual
network is implemented
- --provider-segment <provider-segment>
VLAN ID for VLAN networks or Tunnel ID for
GENEVE/GRE/VXLAN networks
- --transparent-vlan
Make the network VLAN transparent
- --no-transparent-vlan
Do not make the network VLAN transparent
2.202. openstack network delete
usage: openstack network delete [-h] <network> [<network> ...]
usage: openstack network delete [-h] <network> [<network> ...]Positional arguments
- <network>
Network(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.203. openstack network list
usage: openstack network list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--external] [--long]
usage: openstack network list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--external] [--long]Optional arguments
- -h, --help
show this help message and exit
- --external
List external networks
- --long
List additional fields in output
2.204. openstack network rbac create
Positional arguments
- <rbac-object>
The object to which this RBAC policy affects (name or
ID for network objects, ID only for QoS policy
objects)
Optional arguments
- -h, --help
show this help message and exit
- --type <type>
Type of the object that RBAC policy affects
("qos_policy" or "network")
- --action <action>
Action for the RBAC policy ("access_as_external" or
"access_as_shared")
- --target-project <target-project>
The project to which the RBAC policy will be enforced
(name or ID)
- --target-project-domain <target-project-domain>
Domain the target project belongs to (name or ID).
This can be used in case collisions between project
names exist.
- --project <project>
The owner project (name or ID)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
2.205. openstack network rbac delete
usage: openstack network rbac delete [-h] <rbac-policy> [<rbac-policy> ...]
usage: openstack network rbac delete [-h] <rbac-policy> [<rbac-policy> ...]Positional arguments
- <rbac-policy>
RBAC policy(s) to delete (ID only)
Optional arguments
- -h, --help
show this help message and exit
2.206. openstack network rbac list
usage: openstack network rbac list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
usage: openstack network rbac list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.207. openstack network rbac set
usage: openstack network rbac set [-h] [--target-project <target-project>]
[--target-project-domain <target-project-domain>]
<rbac-policy>
usage: openstack network rbac set [-h] [--target-project <target-project>]
[--target-project-domain <target-project-domain>]
<rbac-policy>Positional arguments
- <rbac-policy>
RBAC policy to be modified (ID only)
Optional arguments
- -h, --help
show this help message and exit
- --target-project <target-project>
The project to which the RBAC policy will be enforced
(name or ID)
- --target-project-domain <target-project-domain>
Domain the target project belongs to (name or ID).
This can be used in case collisions between project
names exist.
2.208. openstack network rbac show
usage: openstack network rbac show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<rbac-policy>
usage: openstack network rbac show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<rbac-policy>Positional arguments
- <rbac-policy>
RBAC policy (ID only)
Optional arguments
- -h, --help
show this help message and exit
2.209. openstack network segment list
usage: openstack network segment list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long] [--network <network>]
usage: openstack network segment list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long] [--network <network>]Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
- --network <network>
List network segments that belong to this network
(name or ID)
2.210. openstack network segment show
usage: openstack network segment show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<network-segment>
usage: openstack network segment show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<network-segment>Positional arguments
- <network-segment>
Network segment to display (ID only)
Optional arguments
- -h, --help
show this help message and exit
2.211. openstack network set
Positional arguments
- <network>
Network to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Set network name
- --enable
Enable network
- --disable
Disable network
- --share
Share the network between projects
- --no-share
Do not share the network between projects
- --enable-port-security
Enable port security by default for ports created on
this network
- --disable-port-security
Disable port security by default for ports created on
this network
- --external
Set this network as an external network (external-net
extension required)
- --internal
Set this network as an internal network
- --default
Set the network as the default external network
- --no-default
Do not use the network as the default external network
- --provider-network-type <provider-network-type>
The physical mechanism by which the virtual network is
implemented. The supported options are: flat, geneve,
gre, local, vlan, vxlan.
- --provider-physical-network <provider-physical-network>
Name of the physical network over which the virtual
network is implemented
- --provider-segment <provider-segment>
VLAN ID for VLAN networks or Tunnel ID for
GENEVE/GRE/VXLAN networks
- --transparent-vlan
Make the network VLAN transparent
- --no-transparent-vlan
Do not make the network VLAN transparent
2.212. openstack network show
usage: openstack network show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<network>
usage: openstack network show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<network>Positional arguments
- <network>
Network to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.213. openstack network subport list
usage: openstack network subport list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
--trunk <trunk>
usage: openstack network subport list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
--trunk <trunk>Optional arguments
- -h, --help
show this help message and exit
- --trunk <trunk>
List subports belonging to this trunk (name or ID)
2.214. openstack network trunk create
Positional arguments
- <name>
Name of the trunk to create
Optional arguments
- -h, --help
show this help message and exit
- --description <description>
A description of the trunk
- --parent-port <parent-port>
Parent port belonging to this trunk (name or ID)
- --subport <port=,segmentation-type=,segmentation-id=>
Subport to add. Subport is of form 'port=<name or ID
>,segmentation-type=,segmentation-ID=' (--subport)
option can be repeated
- --enable
Enable trunk (default)
- --disable
Disable trunk
- --project <project>
Owner's project (name or ID)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
2.215. openstack network trunk delete
usage: openstack network trunk delete [-h] <trunk> [<trunk> ...]
usage: openstack network trunk delete [-h] <trunk> [<trunk> ...]Positional arguments
- <trunk>
Trunk(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.216. openstack network trunk list
usage: openstack network trunk list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long]
usage: openstack network trunk list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long]Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
2.217. openstack network trunk set
usage: openstack network trunk set [-h] [--name <name>]
[--description <description>]
[--subport <port=,segmentation-type=,segmentation-id=>]
[--enable | --disable]
<trunk>
usage: openstack network trunk set [-h] [--name <name>]
[--description <description>]
[--subport <port=,segmentation-type=,segmentation-id=>]
[--enable | --disable]
<trunk>Positional arguments
- <trunk>
Trunk to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Set trunk name
- --description <description>
A description of the trunk
- --subport <port=,segmentation-type=,segmentation-id=>
Subport to add. Subport is of form 'port=<name or ID
>,segmentation-type=,segmentation-ID='(--subport)
option can be repeated
- --enable
Enable trunk
- --disable
Disable trunk
2.218. openstack network trunk show
usage: openstack network trunk show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<trunk>
usage: openstack network trunk show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<trunk>Positional arguments
- <trunk>
Trunk to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.219. openstack network trunk unset
usage: openstack network trunk unset [-h] --subport <subport> <trunk>
usage: openstack network trunk unset [-h] --subport <subport> <trunk>Positional arguments
- <trunk>
Unset subports from this trunk (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --subport <subport>
Subport to delete (name or ID of the port) (--subport)
option can be repeated
2.220. openstack object create
usage: openstack object create [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
<container> <filename> [<filename> ...]
usage: openstack object create [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
<container> <filename> [<filename> ...]Positional arguments
- <container>
Container for new object
- <filename>
Local filename(s) to upload
Optional arguments
- -h, --help
show this help message and exit
2.221. openstack object delete
usage: openstack object delete [-h] <container> <object> [<object> ...]
usage: openstack object delete [-h] <container> <object> [<object> ...]Positional arguments
- <container>
Delete object(s) from <container>
- <object>
Object(s) to delete
Optional arguments
- -h, --help
show this help message and exit
2.222. openstack object list
Positional arguments
- <container>
Container to list
Optional arguments
- -h, --help
show this help message and exit
- --prefix <prefix>
Filter list using <prefix>
- --delimiter <delimiter>
Roll up items with <delimiter>
- --marker <marker>
Anchor for paging
- --end-marker <end-marker>
End anchor for paging
- --limit <limit>
Limit the number of objects returned
- --long
List additional fields in output
- --all
List all objects in container (default is 10000)
2.223. openstack object save
usage: openstack object save [-h] [--file <filename>] <container> <object>
usage: openstack object save [-h] [--file <filename>] <container> <object>Positional arguments
- <container>
Download <object> from <container>
- <object>
Object to save
Optional arguments
- -h, --help
show this help message and exit
- --file <filename>
Destination filename (defaults to object name)
2.224. openstack object set
usage: openstack object set [-h] --property <key=value> <container> <object>
usage: openstack object set [-h] --property <key=value> <container> <object>Positional arguments
- <container>
Modify <object> from <container>
- <object>
Object to modify
Optional arguments
- -h, --help
show this help message and exit
- --property <key=value>
Set a property on this object (repeat option to set
multiple properties)
2.225. openstack object show
usage: openstack object show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<container> <object>
usage: openstack object show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<container> <object>Positional arguments
- <container>
Display <object> from <container>
- <object>
Object to display
Optional arguments
- -h, --help
show this help message and exit
2.226. openstack object store account set
usage: openstack object store account set [-h] --property <key=value>
usage: openstack object store account set [-h] --property <key=value>Optional arguments
- -h, --help
show this help message and exit
- --property <key=value>
Set a property on this account (repeat option to set
multiple properties)
2.227. openstack object store account show
usage: openstack object store account show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
usage: openstack object store account show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]Optional arguments
- -h, --help
show this help message and exit
2.228. openstack object store account unset
usage: openstack object store account unset [-h] --property <key>
usage: openstack object store account unset [-h] --property <key>Optional arguments
- -h, --help
show this help message and exit
- --property <key>
Property to remove from account (repeat option to remove
multiple properties)
2.229. openstack object unset
usage: openstack object unset [-h] --property <key> <container> <object>
usage: openstack object unset [-h] --property <key> <container> <object>Positional arguments
- <container>
Modify <object> from <container>
- <object>
Object to modify
Optional arguments
- -h, --help
show this help message and exit
- --property <key>
Property to remove from object (repeat option to remove
multiple properties)
2.230. openstack orchestration build info
usage: openstack orchestration build info [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
usage: openstack orchestration build info [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]Optional arguments
- -h, --help
show this help message and exit
2.231. openstack orchestration resource type list
Optional arguments
- -h, --help
show this help message and exit
- --filter <key=value>
Filter parameters to apply on returned resource types.
This can be specified multiple times. It can be any of
name, version or support_status
- --long
Show resource types with corresponding description of
each resource type.
2.232. openstack orchestration resource type show
Positional arguments
- <resource-type>
Resource type to show details for
Optional arguments
- -h, --help
show this help message and exit
- --template-type <template-type>
Optional template type to generate, hot or cfn
- --long
Show resource type with corresponding description.
2.233. openstack orchestration service list
Optional arguments
- -h, --help
show this help message and exit
2.234. openstack orchestration template function list
Positional arguments
- <template-version>
Template version to get the functions for
Optional arguments
- -h, --help
show this help message and exit
2.235. openstack orchestration template validate
Optional arguments
- -h, --help
show this help message and exit
- -e <environment>, --environment <environment>
Path to the environment. Can be specified multiple
times
- --show-nested
Resolve parameters from nested templates as well
- --parameter <key=value>
Parameter values used to create the stack. This can be
specified multiple times
- --ignore-errors <error1,error2,...>
List of heat errors to ignore
- -t <template>, --template <template>
Path to the template
2.236. openstack orchestration template version list
Optional arguments
- -h, --help
show this help message and exit
2.237. openstack port create
Positional arguments
- <name>
Name of this port
Optional arguments
- -h, --help
show this help message and exit
- --network <network>
Network this port belongs to (name or ID)
- --device <device-id>
Port device ID
- --device-owner <device-owner>
Device owner of this port. This is the entity that
uses the port (for example, network:dhcp).
- --vnic-type <vnic-type>
VNIC type for this port (direct | direct-physical |
macvtap | normal | baremetal, default: normal)
- --host <host-id>
Allocate port on host <host-id> (ID only)
- --fixed-ip
subnet=<subnet>,ip-address=<ip-address>
Desired IP and/or subnet (name or ID) for this port:
subnet=<subnet>,ip-address=<ip-address> (repeat option
to set multiple fixed IP addresses)
- --binding-profile <binding-profile>
Custom data to be passed as binding:profile. Data may
be passed as <key>=<value> or JSON. (repeat option to
set multiple binding:profile data)
- --enable
Enable port (default)
- --disable
Disable port
- --mac-address <mac-address>
MAC address of this port
- --project <project>
Owner's project (name or ID)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
2.238. openstack port delete
usage: openstack port delete [-h] <port> [<port> ...]
usage: openstack port delete [-h] <port> [<port> ...]Positional arguments
- <port>
Port(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.239. openstack port list
usage: openstack port list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--device-owner <device-owner>] [--router <router>]
usage: openstack port list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--device-owner <device-owner>] [--router <router>]Optional arguments
- -h, --help
show this help message and exit
- --device-owner <device-owner>
List only ports with the specified device owner. This
is the entity that uses the port (for example,
network:dhcp).
- --router <router>
List only ports attached to this router (name or ID)
2.240. openstack port set
Positional arguments
- <port>
Port to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --device <device-id>
Port device ID
- --device-owner <device-owner>
Device owner of this port. This is the entity that
uses the port (for example, network:dhcp).
- --vnic-type <vnic-type>
VNIC type for this port (direct | direct-physical |
macvtap | normal | baremetal, default: normal)
- --host <host-id>
Allocate port on host <host-id> (ID only)
- --enable
Enable port
- --disable
Disable port
- --name <name>
Set port name
- --fixed-ip
subnet=<subnet>,ip-address=<ip-address>
Desired IP and/or subnet (name or ID) for this port:
subnet=<subnet>,ip-address=<ip-address> (repeat option
to set multiple fixed IP addresses)
- --no-fixed-ip
Clear existing information of fixed IP addresses
- --binding-profile <binding-profile>
Custom data to be passed as binding:profile. Data may
be passed as <key>=<value> or JSON. (repeat option to
set multiple binding:profile data)
- --no-binding-profile
Clear existing information of binding:profile
2.241. openstack port show
usage: openstack port show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
<port>
usage: openstack port show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
<port>Positional arguments
- <port>
Port to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.242. openstack port unset
usage: openstack port unset [-h]
[--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
[--binding-profile <binding-profile-key>]
<port>
usage: openstack port unset [-h]
[--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
[--binding-profile <binding-profile-key>]
<port>Positional arguments
- <port>
Port to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --fixed-ip
subnet=<subnet>,ip-address=<ip-address>
Desired IP and/or subnet (name or ID) which should be
removed from this port: subnet=<subnet>,ip-address
=<ip-address> (repeat option to unset multiple fixed
IP addresses)
- --binding-profile <binding-profile-key>
Desired key which should be removed from
binding:profile(repeat option to unset multiple
binding:profile data)
2.243. openstack project create
Positional arguments
- <project-name>
New project name
Optional arguments
- -h, --help
show this help message and exit
- --description <description>
Project description
- --enable
Enable project (default)
- --disable
Disable project
- --property <key=value>
Add a property to <name> (repeat option to set
multiple properties)
- --or-show
Return existing project
2.244. openstack project delete
usage: openstack project delete [-h] <project> [<project> ...]
usage: openstack project delete [-h] <project> [<project> ...]Positional arguments
- <project>
Project(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.245. openstack project list
usage: openstack project list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--long]
usage: openstack project list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--long]Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
2.246. openstack project set
usage: openstack project set [-h] [--name <name>]
[--description <description>]
[--enable | --disable] [--property <key=value>]
<project>
usage: openstack project set [-h] [--name <name>]
[--description <description>]
[--enable | --disable] [--property <key=value>]
<project>Positional arguments
- <project>
Project to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Set project name
- --description <description>
Set project description
- --enable
Enable project
- --disable
Disable project
- --property <key=value>
Set a project property (repeat option to set multiple
properties)
2.247. openstack project show
usage: openstack project show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<project>
usage: openstack project show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<project>Positional arguments
- <project>
Project to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.248. openstack project unset
usage: openstack project unset [-h] [--property <key>] <project>
usage: openstack project unset [-h] [--property <key>] <project>Positional arguments
- <project>
Project to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --property <key>
Unset a project property (repeat option to unset multiple
properties)
2.249. openstack ptr record list
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.250. openstack ptr record set
Positional arguments
- floatingip_id
Floating IP ID in format region:floatingip_id
- ptrdname
PTRD Name
Optional arguments
- -h, --help
show this help message and exit
- --description DESCRIPTION
Description
- --no-description
- --ttl TTL TTL
- --no-ttl
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.251. openstack ptr record show
Positional arguments
- floatingip_id
Floating IP ID in format region:floatingip_id
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.252. openstack ptr record unset
usage: openstack ptr record unset [-h] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
floatingip_id
usage: openstack ptr record unset [-h] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
floatingip_idPositional arguments
- floatingip_id
Floating IP ID in format region:floatingip_id
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.253. openstack quota set
Positional arguments
- <project/class>
Set quotas for this project or class (name/ID)
Optional arguments
- -h, --help
show this help message and exit
- --class
Set quotas for <class>
- --properties <properties>
New value for the properties quota
- --server-groups <server-groups>
New value for the server-groups quota
- --ram <ram>
New value for the ram quota
- --key-pairs <key-pairs>
New value for the key-pairs quota
- --instances <instances>
New value for the instances quota
- --fixed-ips <fixed-ips>
New value for the fixed-ips quota
- --injected-file-size <injected-file-size>
New value for the injected-file-size quota
- --server-group-members <server-group-members>
New value for the server-group-members quota
- --injected-files <injected-files>
New value for the injected-files quota
- --cores <cores>
New value for the cores quota
- --injected-path-size <injected-path-size>
New value for the injected-path-size quota
- --gigabytes <gigabytes>
New value for the gigabytes quota
- --volumes <volumes>
New value for the volumes quota
- --snapshots <snapshots>
New value for the snapshots quota
- --subnetpools <subnetpools>
New value for the subnetpools quota
- --vips <vips>
New value for the vips quota
- --members <members>
New value for the members quota
- --ports <ports>
New value for the ports quota
- --subnets <subnets>
New value for the subnets quota
- --networks <networks>
New value for the networks quota
- --floating-ips <floating-ips>
New value for the floating-ips quota
- --health-monitors <health-monitors>
New value for the health-monitors quota
- --secgroup-rules <secgroup-rules>
New value for the secgroup-rules quota
- --secgroups <secgroups>
New value for the secgroups quota
- --routers <routers>
New value for the routers quota
- --rbac-policies <rbac-policies>
New value for the rbac-policies quota
- --volume-type <volume-type>
Set quotas for a specific <volume-type>
2.254. openstack quota show
usage: openstack quota show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--class | --default]
[<project/class>]
usage: openstack quota show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--class | --default]
[<project/class>]Positional arguments
- <project/class>
Show quotas for this project or class (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --class
Show quotas for <class>
- --default
Show default quotas for <project>
2.255. openstack recordset create
Positional arguments
- zone_id
Zone ID
- name
RecordSet Name
Optional arguments
- -h, --help
show this help message and exit
- --records RECORDS [RECORDS ...]
RecordSet Records
- --type TYPE
RecordSet Type
- --ttl TTL
Time To Live (Seconds)
- --description DESCRIPTION
Description
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.256. openstack recordset delete
Positional arguments
- zone_id
Zone ID
- id
RecordSet ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.257. openstack recordset list
Positional arguments
- zone_id
Zone ID. To list all recordsets specify 'all'
Optional arguments
- -h, --help
show this help message and exit
- --name NAME
RecordSet Name
- --type TYPE
RecordSet Type
- --data DATA
RecordSet Record Data
- --ttl TTL
Time To Live (Seconds)
- --description DESCRIPTION
Description
- --status STATUS
RecordSet Status
- --action ACTION
RecordSet Action
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.258. openstack recordset set
Positional arguments
- zone_id
Zone ID
- id
RecordSet ID
Optional arguments
- -h, --help
show this help message and exit
- --records RECORDS [RECORDS ...]
Records
- --description DESCRIPTION
Description
- --no-description
- --ttl TTL TTL
- --no-ttl
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.259. openstack recordset show
Positional arguments
- zone_id
Zone ID
- id
RecordSet ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.260. openstack resource member create
usage: openstack resource member create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
resource_id resource_type member_id
usage: openstack resource member create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
resource_id resource_type member_idPositional arguments
- resource_id
Resource ID to be shared.
- resource_type
Resource type.
- member_id
Project ID to whom the resource is shared to.
Optional arguments
- -h, --help
show this help message and exit
2.261. openstack resource member delete
usage: openstack resource member delete [-h] resource resource_type member_id
usage: openstack resource member delete [-h] resource resource_type member_idPositional arguments
- resource
Resource ID to be shared.
- resource_type
Resource type.
- member_id
Project ID to whom the resource is shared to.
Optional arguments
- -h, --help
show this help message and exit
2.262. openstack resource member list
usage: openstack resource member list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
resource_id resource_type
usage: openstack resource member list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
resource_id resource_typePositional arguments
- resource_id
Resource id to be shared.
- resource_type
Resource type.
Optional arguments
- -h, --help
show this help message and exit
2.263. openstack resource member show
usage: openstack resource member show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m MEMBER_ID]
resource resource_type
usage: openstack resource member show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m MEMBER_ID]
resource resource_typePositional arguments
- resource
Resource ID to be shared.
- resource_type
Resource type.
Optional arguments
- -h, --help
show this help message and exit
- -m MEMBER_ID, --member-id MEMBER_ID
Project ID to whom the resource is shared to. No need
to provide this param if you are the resource member.
2.264. openstack resource member update
Positional arguments
- resource_id
Resource ID to be shared.
- resource_type
Resource type.
Optional arguments
- -h, --help
show this help message and exit
- -m MEMBER_ID, --member-id MEMBER_ID
Project ID to whom the resource is shared to. No need
to provide this param if you are the resource member.
- -s {pending,accepted,rejected}, --status {pending,accepted,rejected}
status of the sharing.
2.265. openstack role add
usage: openstack role add [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] --project <project> --user <user>
<role>
usage: openstack role add [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] --project <project> --user <user>
<role>Positional arguments
- <role>
Role to add to <project>:<user> (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --project <project>
Include <project> (name or ID)
- --user <user>
Include <user> (name or ID)
2.266. openstack role assignment list
Optional arguments
- -h, --help
show this help message and exit
- --user <user>
User to filter (name or ID)
- --project <project>
Project to filter (name or ID)
- --names
Display names instead of IDs
- --auth-user
Only list assignments for the authenticated user
- --auth-project
Only list assignments for the project to which the
authenticated user's token is scoped
2.267. openstack role create
usage: openstack role create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--or-show]
<name>
usage: openstack role create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--or-show]
<name>Positional arguments
- <name>
New role name
Optional arguments
- -h, --help
show this help message and exit
- --or-show
Return existing role
2.268. openstack role delete
usage: openstack role delete [-h] <role> [<role> ...]
usage: openstack role delete [-h] <role> [<role> ...]Positional arguments
- <role>
Role(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.269. openstack role list
usage: openstack role list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--project <project>] [--user <user>]
usage: openstack role list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--project <project>] [--user <user>]Optional arguments
- -h, --help
show this help message and exit
- --project <project>
Filter roles by <project> (name or ID)
- --user <user>
Filter roles by <user> (name or ID)
2.270. openstack role remove
usage: openstack role remove [-h] --project <project> --user <user> <role>
usage: openstack role remove [-h] --project <project> --user <user> <role>Positional arguments
- <role>
Role to remove (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --project <project>
Include <project> (name or ID)
- --user <user>
Include <user> (name or ID)
2.271. openstack role show
usage: openstack role show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
<role>
usage: openstack role show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
<role>Positional arguments
- <role>
Role to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.272. openstack router add port
usage: openstack router add port [-h] <router> <port>
usage: openstack router add port [-h] <router> <port>Positional arguments
- <router>
Router to which port will be added (name or ID)
- <port>
Port to be added (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.273. openstack router add subnet
usage: openstack router add subnet [-h] <router> <subnet>
usage: openstack router add subnet [-h] <router> <subnet>Positional arguments
- <router>
Router to which subnet will be added (name or ID)
- <subnet>
Subnet to be added (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.274. openstack router create
Positional arguments
- <name>
New router name
Optional arguments
- -h, --help
show this help message and exit
- --enable
Enable router (default)
- --disable
Disable router
- --distributed
Create a distributed router
- --project <project>
Owner's project (name or ID)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
- --availability-zone-hint <availability-zone>
Availability Zone in which to create this router
(Router Availability Zone extension required, repeat
option to set multiple availability zones)
2.275. openstack router delete
usage: openstack router delete [-h] <router> [<router> ...]
usage: openstack router delete [-h] <router> [<router> ...]Positional arguments
- <router>
Router(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.276. openstack router list
usage: openstack router list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--long]
usage: openstack router list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--long]Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
2.277. openstack router remove port
usage: openstack router remove port [-h] <router> <port>
usage: openstack router remove port [-h] <router> <port>Positional arguments
- <router>
Router from which port will be removed (name or ID)
- <port>
Port to be removed and deleted (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.278. openstack router remove subnet
usage: openstack router remove subnet [-h] <router> <subnet>
usage: openstack router remove subnet [-h] <router> <subnet>Positional arguments
- <router>
Router from which the subnet will be removed (name or ID)
- <subnet>
Subnet to be removed (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.279. openstack router set
usage: openstack router set [-h] [--name <name>] [--enable | --disable]
[--distributed | --centralized]
[--route destination=<subnet>,gateway=<ip-address> | --no-route]
<router>
usage: openstack router set [-h] [--name <name>] [--enable | --disable]
[--distributed | --centralized]
[--route destination=<subnet>,gateway=<ip-address> | --no-route]
<router>Positional arguments
- <router>
Router to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Set router name
- --enable
Enable router
- --disable
Disable router
- --distributed
Set router to distributed mode (disabled router only)
- --centralized
Set router to centralized mode (disabled router only)
- --route
destination=<subnet>,gateway=<ip-address>
Routes associated with the router destination:
destination subnet (in CIDR notation) gateway: nexthop
IP address (repeat option to set multiple routes)
- --no-route
Clear routes associated with the router
2.280. openstack router show
usage: openstack router show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<router>
usage: openstack router show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<router>Positional arguments
- <router>
Router to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.281. openstack router unset
usage: openstack router unset [-h]
[--route destination=<subnet>,gateway=<ip-address>]
<router>
usage: openstack router unset [-h]
[--route destination=<subnet>,gateway=<ip-address>]
<router>Positional arguments
- <router>
Router to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --route
destination=<subnet>,gateway=<ip-address>
Routes to be removed from the router destination:
destination subnet (in CIDR notation) gateway: nexthop
IP address (repeat option to unset multiple routes)
2.282. openstack secret container create
Optional arguments
- -h, --help
show this help message and exit
- --name NAME, -n NAME
a human-friendly name.
- --type TYPE
type of container to create (default: generic).
- --secret SECRET, -s SECRET
one secret to store in a container (can be set
multiple times). Example: --secret
"private_key=https://url.test/v1/secrets/1-2-3-4"
2.283. openstack secret container delete
usage: openstack secret container delete [-h] URI
usage: openstack secret container delete [-h] URIPositional arguments
- URI
The URI reference for the container
Optional arguments
- -h, --help
show this help message and exit
2.284. openstack secret container get
usage: openstack secret container get [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
URI
usage: openstack secret container get [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
URIPositional arguments
- URI
The URI reference for the container.
Optional arguments
- -h, --help
show this help message and exit
2.285. openstack secret container list
Optional arguments
- -h, --help
show this help message and exit
- --limit LIMIT, -l LIMIT
specify the limit to the number of items to list per
page (default: 10; maximum: 100)
- --offset OFFSET, -o OFFSET
specify the page offset (default: 0)
- --name NAME, -n NAME
specify the container name (default: None)
- --type TYPE, -t TYPE
specify the type filter for the list (default: None).
2.286. openstack secret delete
usage: openstack secret delete [-h] URI
usage: openstack secret delete [-h] URIPositional arguments
- URI
The URI reference for the secret
Optional arguments
- -h, --help
show this help message and exit
2.287. openstack secret get
usage: openstack secret get [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--decrypt] [--payload]
[--payload_content_type PAYLOAD_CONTENT_TYPE]
URI
usage: openstack secret get [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--decrypt] [--payload]
[--payload_content_type PAYLOAD_CONTENT_TYPE]
URIPositional arguments
- URI
The URI reference for the secret.
Optional arguments
- -h, --help
show this help message and exit
- --decrypt, -d
if specified, retrieve the unencrypted secret data;
the data type can be specified with --payload-content-
type.
- --payload, -p
if specified, retrieve the unencrypted secret data;
the data type can be specified with --payload-content-
type. If the user wishes to only retrieve the value of
the payload they must add "-f value" to format
returning only the value of the payload
- --payload_content_type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE
the content type of the decrypted secret (default:
text/plain.
2.288. openstack secret list
Optional arguments
- -h, --help
show this help message and exit
- --limit LIMIT, -l LIMIT
specify the limit to the number of items to list per
page (default: 10; maximum: 100)
- --offset OFFSET, -o OFFSET
specify the page offset (default: 0)
- --name NAME, -n NAME
specify the secret name (default: None)
- --algorithm ALGORITHM, -a ALGORITHM
the algorithm filter for the list(default: None).
- --bit-length BIT_LENGTH, -b BIT_LENGTH
the bit length filter for the list (default: 0).
- --mode MODE, -m MODE
the algorithm mode filter for the list (default:
None).
2.289. openstack secret order create
Positional arguments
- type
the type of the order to create.
Optional arguments
- -h, --help
show this help message and exit
- --name NAME, -n NAME
a human-friendly name.
- --algorithm ALGORITHM, -a ALGORITHM
the algorithm to be used with the requested key
(default: aes).
- --bit-length BIT_LENGTH, -b BIT_LENGTH
the bit length of the requested secret key (default:
256).
- --mode MODE, -m MODE
the algorithm mode to be used with the requested key
(default: cbc).
- --payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE
the type/format of the secret to be generated
(default: application/octet-stream).
- --expiration EXPIRATION, -x EXPIRATION
the expiration time for the secret in ISO 8601 format.
- --request-type REQUEST_TYPE
the type of the certificate request.
- --subject-dn SUBJECT_DN
the subject of the certificate.
- --source-container-ref SOURCE_CONTAINER_REF
the source of the certificate when using stored-key
requests.
- --ca-id CA_ID
the identifier of the CA to use for the certificate
request.
- --profile PROFILE
the profile of certificate to use.
- --request-file REQUEST_FILE
the file containing the CSR.
2.290. openstack secret order delete
usage: openstack secret order delete [-h] URI
usage: openstack secret order delete [-h] URIPositional arguments
- URI
The URI reference for the order
Optional arguments
- -h, --help
show this help message and exit
2.291. openstack secret order get
usage: openstack secret order get [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
URI
usage: openstack secret order get [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
URIPositional arguments
- URI
The URI reference order.
Optional arguments
- -h, --help
show this help message and exit
2.292. openstack secret order list
usage: openstack secret order list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--limit LIMIT] [--offset OFFSET]
usage: openstack secret order list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--limit LIMIT] [--offset OFFSET]Optional arguments
- -h, --help
show this help message and exit
- --limit LIMIT, -l LIMIT
specify the limit to the number of items to list per
page (default: 10; maximum: 100)
- --offset OFFSET, -o OFFSET
specify the page offset (default: 0)
2.293. openstack secret store
Optional arguments
- -h, --help
show this help message and exit
- --name NAME, -n NAME
a human-friendly name.
- --payload PAYLOAD, -p PAYLOAD
the unencrypted secret; if provided, you must also
provide a payload_content_type
- --secret-type SECRET_TYPE, -s SECRET_TYPE
the secret type; must be one of symmetric, public,
private, certificate, passphrase, opaque (default)
- --payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE
the type/format of the provided secret data;
"text/plain" is assumed to be UTF-8; required when
--payload is supplied.
- --payload-content-encoding PAYLOAD_CONTENT_ENCODING, -e PAYLOAD_CONTENT_ENCODING
required if --payload-content-type is "application
/octet-stream".
- --algorithm ALGORITHM, -a ALGORITHM
the algorithm (default: aes).
- --bit-length BIT_LENGTH, -b BIT_LENGTH
the bit length (default: 256).
- --mode MODE, -m MODE
the algorithm mode; used only for reference (default:
cbc)
- --expiration EXPIRATION, -x EXPIRATION
the expiration time for the secret in ISO 8601 format.
2.294. openstack secret update
usage: openstack secret update [-h] URI payload
usage: openstack secret update [-h] URI payloadPositional arguments
- URI
The URI reference for the secret.
- payload
the unencrypted secret
Optional arguments
- -h, --help
show this help message and exit
2.295. openstack security group create
Positional arguments
- <name>
New security group name
Optional arguments
- -h, --help
show this help message and exit
- --description <description>
Security group description
- --project <project>
Owner's project (name or ID)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
2.296. openstack security group delete
usage: openstack security group delete [-h] <group> [<group> ...]
usage: openstack security group delete [-h] <group> [<group> ...]Positional arguments
- <group>
Security group(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.297. openstack security group list
usage: openstack security group list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
usage: openstack security group list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.298. openstack security group rule create
Positional arguments
- <group>
Create rule in this security group (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --src-ip <ip-address>
Source IP address block (may use CIDR notation;
default for IPv4 rule: 0.0.0.0/0)
- --src-group <group>
Source security group (name or ID)
- --dst-port <port-range>
Destination port, may be a single port or a starting
and ending port range: 137:139. Required for IP
protocols TCP and UDP. Ignored for ICMP IP protocols.
- --icmp-type <icmp-type>
ICMP type for ICMP IP protocols
- --icmp-code <icmp-code>
ICMP code for ICMP IP protocols
- --protocol <protocol>
IP protocol (ah, dccp, egp, esp, gre, icmp, igmp,
ipv6-encap, ipv6-frag, ipv6-icmp, ipv6-nonxt,
ipv6-opts, ipv6-route, ospf, pgm, rsvp, sctp, tcp,
udp, udplite, vrrp and integer representations
[0-255]; default: tcp)
- --ingress
Rule applies to incoming network traffic (default)
- --egress
Rule applies to outgoing network traffic
- --ethertype <ethertype>
Ethertype of network traffic (IPv4, IPv6; default:
based on IP protocol)
- --project <project>
Owner's project (name or ID)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
2.299. openstack security group rule delete
usage: openstack security group rule delete [-h] <rule> [<rule> ...]
usage: openstack security group rule delete [-h] <rule> [<rule> ...]Positional arguments
- <rule>
Security group rule(s) to delete (ID only)
Optional arguments
- -h, --help
show this help message and exit
2.300. openstack security group rule list
Positional arguments
- <group>
List all rules in this security group (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
2.301. openstack security group rule show
usage: openstack security group rule show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<rule>
usage: openstack security group rule show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<rule>Positional arguments
- <rule>
Security group rule to display (ID only)
Optional arguments
- -h, --help
show this help message and exit
2.302. openstack security group set
usage: openstack security group set [-h] [--name <new-name>]
[--description <description>]
<group>
usage: openstack security group set [-h] [--name <new-name>]
[--description <description>]
<group>Positional arguments
- <group>
Security group to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <new-name>
New security group name
- --description <description>
New security group description
2.303. openstack security group show
usage: openstack security group show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<group>
usage: openstack security group show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<group>Positional arguments
- <group>
Security group to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.304. openstack server add fixed ip
usage: openstack server add fixed ip [-h] <server> <network>
usage: openstack server add fixed ip [-h] <server> <network>Positional arguments
- <server>
Server (name or ID) to receive the fixed IP address
- <network>
Network (name or ID) to allocate the fixed IP address from
Optional arguments
- -h, --help
show this help message and exit
2.305. openstack server add floating ip
usage: openstack server add floating ip [-h] <server> <ip-address>
usage: openstack server add floating ip [-h] <server> <ip-address>Positional arguments
- <server>
Server (name or ID) to receive the floating IP address
- <ip-address>
Floating IP address (IP address only) to assign to server
Optional arguments
- -h, --help
show this help message and exit
2.306. openstack server add security group
usage: openstack server add security group [-h] <server> <group>
usage: openstack server add security group [-h] <server> <group>Positional arguments
- <server>
Server (name or ID)
- <group>
Security group to add (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.307. openstack server add volume
usage: openstack server add volume [-h] [--device <device>] <server> <volume>
usage: openstack server add volume [-h] [--device <device>] <server> <volume>Positional arguments
- <server>
Server (name or ID)
- <volume>
Volume to add (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --device <device>
Server internal device name for volume
2.308. openstack server backup create
Positional arguments
- <server>
Server to back up (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <image-name>
Name of the backup image (default: server name)
- --type <backup-type>
Used to populate the backup_type property of the
backup image (default: empty)
- --rotate <count>
Number of backups to keep (default: 1)
- --wait
Wait for backup image create to complete
2.309. openstack server create
Positional arguments
- <server-name>
New server name
Optional arguments
- -h, --help
show this help message and exit
- --image <image>
Create server from this image (name or ID)
- --volume <volume>
Create server from this volume (name or ID)
- --flavor <flavor>
Create server with this flavor (name or ID)
- --security-group <security-group-name>
Security group to assign to this server (name or ID)
(repeat option to set multiple groups)
- --key-name <key-name>
Keypair to inject into this server (optional
extension)
- --property <key=value>
Set a property on this server (repeat option to set
multiple values)
- --file <dest-filename=source-filename>
File to inject into image before boot (repeat option
to set multiple files)
- --user-data <user-data>
User data file to serve from the metadata server
- --availability-zone <zone-name>
Select an availability zone for the server
- --block-device-mapping <dev-name=mapping>
Map block devices; map is
<id>:<type>:<size(GB)>:<delete_on_terminate> (optional
extension)
- --nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid>
Create a NIC on the server. Specify option multiple
times to create multiple NICs. Either net-id or port-
id must be provided, but not both. net-id: attach NIC
to network with this UUID, port-id: attach NIC to port
with this UUID, v4-fixed-ip: IPv4 fixed address for
NIC (optional), v6-fixed-ip: IPv6 fixed address for
NIC (optional).
- --hint <key=value>
Hints for the scheduler (optional extension)
- --config-drive <config-drive-volume>|True
Use specified volume as the config drive, or 'True' to
use an ephemeral drive
- --min <count>
Minimum number of servers to launch (default=1)
- --max <count>
Maximum number of servers to launch (default=1)
- --wait
Wait for build to complete
2.310. openstack server delete
usage: openstack server delete [-h] [--wait] <server> [<server> ...]
usage: openstack server delete [-h] [--wait] <server> [<server> ...]Positional arguments
- <server>
Server(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --wait
Wait for delete to complete
2.311. openstack server dump create
usage: openstack server dump create [-h] <server> [<server> ...]
usage: openstack server dump create [-h] <server> [<server> ...]Positional arguments
- <server>
Server(s) to create dump file (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.312. openstack server group create
usage: openstack server group create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] --policy
<policy>
<name>
usage: openstack server group create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] --policy
<policy>
<name>Positional arguments
- <name>
New server group name
Optional arguments
- -h, --help
show this help message and exit
- --policy <policy>
Add a policy to <name> (repeat option to add multiple
policies)
2.313. openstack server group delete
usage: openstack server group delete [-h] <server-group> [<server-group> ...]
usage: openstack server group delete [-h] <server-group> [<server-group> ...]Positional arguments
- <server-group>
server group(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.314. openstack server group list
usage: openstack server group list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--all-projects] [--long]
usage: openstack server group list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--all-projects] [--long]Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Display information from all projects (admin only)
- --long
List additional fields in output
2.315. openstack server group show
usage: openstack server group show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<server-group>
usage: openstack server group show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<server-group>Positional arguments
- <server-group>
server group to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.316. openstack server image create
usage: openstack server image create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--name <image-name>] [--wait]
<server>
usage: openstack server image create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--name <image-name>] [--wait]
<server>Positional arguments
- <server>
Server to create image (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <image-name>
Name of new disk image (default: server name)
- --wait
Wait for operation to complete
2.317. openstack server list
Optional arguments
- -h, --help
show this help message and exit
- --reservation-id <reservation-id>
Only return instances that match the reservation
- --ip <ip-address-regex>
Regular expression to match IP addresses
- --ip6 <ip-address-regex>
Regular expression to match IPv6 addresses
- --name <name-regex>
Regular expression to match names
- --instance-name <server-name>
Regular expression to match instance name (admin only)
- --status <status>
Search by server status
- --flavor <flavor>
Search by flavor (name or ID)
- --image <image>
Search by image (name or ID)
- --host <hostname>
Search by hostname
- --all-projects
Include all projects (admin only)
- --project <project>
Search by project (admin only) (name or ID)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
- --user <user>
Search by user (admin only) (name or ID)
- --user-domain <user-domain>
Domain the user belongs to (name or ID). This can be
used in case collisions between user names exist.
- --long
List additional fields in output
- --marker <marker>
The last server (name or ID) of the previous page.
Display list of servers after marker. Display all
servers if not specified.
- --limit <limit>
Maximum number of servers to display. If limit equals
-1, all servers will be displayed. If limit is greater
than 'osapi_max_limit' option of Nova API,
'osapi_max_limit' will be used instead.
2.318. openstack server lock
usage: openstack server lock [-h] <server> [<server> ...]
usage: openstack server lock [-h] <server> [<server> ...]Positional arguments
- <server>
Server(s) to lock (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.319. openstack server migrate
usage: openstack server migrate [-h] [--live <hostname>]
[--shared-migration | --block-migration]
[--disk-overcommit | --no-disk-overcommit]
[--wait]
<server>
usage: openstack server migrate [-h] [--live <hostname>]
[--shared-migration | --block-migration]
[--disk-overcommit | --no-disk-overcommit]
[--wait]
<server>Positional arguments
- <server>
Server (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --live <hostname>
Target hostname
- --shared-migration
Perform a shared live migration (default)
- --block-migration
Perform a block live migration
- --disk-overcommit
Allow disk over-commit on the destination host
- --no-disk-overcommit
Do not over-commit disk on the destination host
(default)
- --wait
Wait for resize to complete
2.320. openstack server pause
usage: openstack server pause [-h] <server> [<server> ...]
usage: openstack server pause [-h] <server> [<server> ...]Positional arguments
- <server>
Server(s) to pause (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.321. openstack server reboot
usage: openstack server reboot [-h] [--hard | --soft] [--wait] <server>
usage: openstack server reboot [-h] [--hard | --soft] [--wait] <server>Positional arguments
- <server>
Server (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --hard
Perform a hard reboot
- --soft
Perform a soft reboot
- --wait
Wait for reboot to complete
2.322. openstack server rebuild
Positional arguments
- <server>
Server (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --image <image>
Recreate server from the specified image (name or ID).
Defaults to the currently used one.
- --password <password>
Set the password on the rebuilt instance
- --wait
Wait for rebuild to complete
2.323. openstack server remove fixed ip
usage: openstack server remove fixed ip [-h] <server> <ip-address>
usage: openstack server remove fixed ip [-h] <server> <ip-address>Positional arguments
- <server>
Server (name or ID) to remove the fixed IP address from
- <ip-address>
Fixed IP address (IP address only) to remove from the server
Optional arguments
- -h, --help
show this help message and exit
2.324. openstack server remove floating ip
usage: openstack server remove floating ip [-h] <server> <ip-address>
usage: openstack server remove floating ip [-h] <server> <ip-address>Positional arguments
- <server>
Server (name or ID) to remove the floating IP address from
- <ip-address>
Floating IP address (IP address only) to remove from server
Optional arguments
- -h, --help
show this help message and exit
2.325. openstack server remove security group
usage: openstack server remove security group [-h] <server> <group>
usage: openstack server remove security group [-h] <server> <group>Positional arguments
- <server>
Name or ID of server to use
- <group>
Name or ID of security group to remove from server
Optional arguments
- -h, --help
show this help message and exit
2.326. openstack server remove volume
usage: openstack server remove volume [-h] <server> <volume>
usage: openstack server remove volume [-h] <server> <volume>Positional arguments
- <server>
Server (name or ID)
- <volume>
Volume to remove (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.327. openstack server rescue
usage: openstack server rescue [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<server>
usage: openstack server rescue [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<server>Positional arguments
- <server>
Server (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.328. openstack server resize
usage: openstack server resize [-h] [--flavor <flavor> | --confirm | --revert]
[--wait]
<server>
usage: openstack server resize [-h] [--flavor <flavor> | --confirm | --revert]
[--wait]
<server>Positional arguments
- <server>
Server (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --flavor <flavor>
Resize server to specified flavor
- --confirm
Confirm server resize is complete
- --revert
Restore server state before resize
- --wait
Wait for resize to complete
2.329. openstack server restore
usage: openstack server restore [-h] <server> [<server> ...]
usage: openstack server restore [-h] <server> [<server> ...]Positional arguments
- <server>
Server(s) to restore (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.330. openstack server resume
usage: openstack server resume [-h] <server> [<server> ...]
usage: openstack server resume [-h] <server> [<server> ...]Positional arguments
- <server>
Server(s) to resume (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.331. openstack server set
usage: openstack server set [-h] [--name <new-name>] [--root-password]
[--property <key=value>] [--state <state>]
<server>
usage: openstack server set [-h] [--name <new-name>] [--root-password]
[--property <key=value>] [--state <state>]
<server>Positional arguments
- <server>
Server (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <new-name>
New server name
- --root-password
Set new root password (interactive only)
- --property <key=value>
Property to add/change for this server (repeat option
to set multiple properties)
- --state <state>
New server state (valid value: active, error)
2.332. openstack server shelve
usage: openstack server shelve [-h] <server> [<server> ...]
usage: openstack server shelve [-h] <server> [<server> ...]Positional arguments
- <server>
Server(s) to shelve (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.333. openstack server show
usage: openstack server show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--diagnostics]
<server>
usage: openstack server show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--diagnostics]
<server>Positional arguments
- <server>
Server (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --diagnostics
Display server diagnostics information
2.334. openstack server ssh
usage: openstack server ssh [-h] [--login <login-name>] [--port <port>]
[--identity <keyfile>] [--option <config-options>]
[-4 | -6]
[--public | --private | --address-type <address-type>]
<server>
usage: openstack server ssh [-h] [--login <login-name>] [--port <port>]
[--identity <keyfile>] [--option <config-options>]
[-4 | -6]
[--public | --private | --address-type <address-type>]
<server>Positional arguments
- <server>
Server (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --login <login-name>
Login name (ssh -l option)
- --port <port>
Destination port (ssh -p option)
- --identity <keyfile>
Private key file (ssh -i option)
- --option <config-options>
Options in ssh_config(5) format (ssh -o option)
- -4
Use only IPv4 addresses
- -6
Use only IPv6 addresses
- --public
Use public IP address
- --private
Use private IP address
- --address-type <address-type>
Use other IP address (public, private, etc)
2.335. openstack server start
usage: openstack server start [-h] <server> [<server> ...]
usage: openstack server start [-h] <server> [<server> ...]Positional arguments
- <server>
Server(s) to start (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.336. openstack server stop
usage: openstack server stop [-h] <server> [<server> ...]
usage: openstack server stop [-h] <server> [<server> ...]Positional arguments
- <server>
Server(s) to stop (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.337. openstack server suspend
usage: openstack server suspend [-h] <server> [<server> ...]
usage: openstack server suspend [-h] <server> [<server> ...]Positional arguments
- <server>
Server(s) to suspend (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.338. openstack server unlock
usage: openstack server unlock [-h] <server> [<server> ...]
usage: openstack server unlock [-h] <server> [<server> ...]Positional arguments
- <server>
Server(s) to unlock (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.339. openstack server unpause
usage: openstack server unpause [-h] <server> [<server> ...]
usage: openstack server unpause [-h] <server> [<server> ...]Positional arguments
- <server>
Server(s) to unpause (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.340. openstack server unrescue
usage: openstack server unrescue [-h] <server>
usage: openstack server unrescue [-h] <server>Positional arguments
- <server>
Server (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.341. openstack server unset
usage: openstack server unset [-h] [--property <key>] <server>
usage: openstack server unset [-h] [--property <key>] <server>Positional arguments
- <server>
Server (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --property <key>
Property key to remove from server (repeat option to
remove multiple values)
2.342. openstack server unshelve
usage: openstack server unshelve [-h] <server> [<server> ...]
usage: openstack server unshelve [-h] <server> [<server> ...]Positional arguments
- <server>
Server(s) to unshelve (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.343. openstack service create
usage: openstack service create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] [--name <name>]
[--description <description>]
<type>
usage: openstack service create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] [--name <name>]
[--description <description>]
<type>Positional arguments
- <type>
New service type (compute, image, identity, volume,
etc)
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
New service name
- --description <description>
New service description
2.344. openstack service delete
usage: openstack service delete [-h] <service> [<service> ...]
usage: openstack service delete [-h] <service> [<service> ...]Positional arguments
- <service>
Service(s) to delete (type, name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.345. openstack service list
usage: openstack service list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--long]
usage: openstack service list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--long]Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
2.346. openstack service show
usage: openstack service show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--catalog]
<service>
usage: openstack service show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--catalog]
<service>Positional arguments
- <service>
Service to display (type, name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --catalog
Show service catalog information
2.347. openstack snapshot create
Positional arguments
- <volume>
Volume to snapshot (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Name of the snapshot
- --description <description>
Description of the snapshot
- --force
Create a snapshot attached to an instance. Default is
False
- --property <key=value>
Set a property to this snapshot (repeat option to set
multiple properties)
2.348. openstack snapshot delete
usage: openstack snapshot delete [-h] <snapshot> [<snapshot> ...]
usage: openstack snapshot delete [-h] <snapshot> [<snapshot> ...]Positional arguments
- <snapshot>
Snapshot(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.349. openstack snapshot list
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Include all projects (admin only)
- --long
List additional fields in output
- --marker <marker>
The last snapshot ID of the previous page
- --limit <limit>
Maximum number of snapshots to display
2.350. openstack snapshot set
usage: openstack snapshot set [-h] [--name <name>]
[--description <description>]
[--property <key=value>] [--state <state>]
<snapshot>
usage: openstack snapshot set [-h] [--name <name>]
[--description <description>]
[--property <key=value>] [--state <state>]
<snapshot>Positional arguments
- <snapshot>
Snapshot to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
New snapshot name
- --description <description>
New snapshot description
- --property <key=value>
Property to add/change for this snapshot (repeat
option to set multiple properties)
- --state <state>
New snapshot state. Valid values are available, error,
creating, deleting, and error-deleting.
2.351. openstack snapshot show
usage: openstack snapshot show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<snapshot>
usage: openstack snapshot show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<snapshot>Positional arguments
- <snapshot>
Snapshot to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.352. openstack snapshot unset
usage: openstack snapshot unset [-h] [--property <key>] <snapshot>
usage: openstack snapshot unset [-h] [--property <key>] <snapshot>Positional arguments
- <snapshot>
Snapshot to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --property <key>
Property to remove from snapshot (repeat option to remove
multiple properties)
2.353. openstack software config create
Positional arguments
- <config-name>
Name of the software config to create
Optional arguments
- -h, --help
show this help message and exit
- --config-file <config-file>
Path to JSON/YAML containing map defining <inputs>,
<outputs>, and <options>
- --definition-file <destination-file>
Path to software config script/data
- --group <group>
Group name of tool expected by the software config
2.354. openstack software config delete
usage: openstack software config delete [-h] <config> [<config> ...]
usage: openstack software config delete [-h] <config> [<config> ...]Positional arguments
- <config>
IDs of the software configs to delete
Optional arguments
- -h, --help
show this help message and exit
2.355. openstack software config list
usage: openstack software config list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--limit <limit>] [--marker <id>]
usage: openstack software config list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--limit <limit>] [--marker <id>]Optional arguments
- -h, --help
show this help message and exit
- --limit <limit>
Limit the number of configs returned
- --marker <id>
Return configs that appear after the given config ID
2.356. openstack software config show
usage: openstack software config show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--config-only]
<config>
usage: openstack software config show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--config-only]
<config>Positional arguments
- <config>
ID of the config
Optional arguments
- -h, --help
show this help message and exit
- --config-only
Only display the value of the <config> property.
2.357. openstack software deployment create
Positional arguments
- <deployment-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
- -h, --help
show this help message and exit
- --input-value <key=value>
Input value to set on the deployment. This can be
specified multiple times.
- --action <action>
Name of an action for this deployment. This can be a
custom action, or one of CREATE, UPDATE, DELETE,
SUSPEND, RESUME. Default is UPDATE
- --config <config> ID
of the configuration to deploy
- --signal-transport <signal-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.
ZAQAR_SIGNAL will create a dedicated zaqar queue to be
signaled using the provided keystone
credentials.NO_SIGNAL will result in the resource
going to the COMPLETE state without waiting for any
signal
- --container <container>
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
- --server <server> ID
of the server being deployed to
2.358. openstack software deployment delete
usage: openstack software deployment delete [-h]
<deployment> [<deployment> ...]
usage: openstack software deployment delete [-h]
<deployment> [<deployment> ...]Positional arguments
- <deployment>
ID of the deployment(s) to delete.
Optional arguments
- -h, --help
show this help message and exit
2.359. openstack software deployment list
Optional arguments
- -h, --help
show this help message and exit
- --server <server> ID
of the server to fetch deployments for
- --long
List more fields in output
2.360. openstack software deployment metadata show
usage: openstack software deployment metadata show [-h] <server>
usage: openstack software deployment metadata show [-h] <server>Positional arguments
- <server>
ID of the server to fetch deployments for
Optional arguments
- -h, --help
show this help message and exit
2.361. openstack software deployment output show
usage: openstack software deployment output show [-h] [--all] [--long]
<deployment> [<output-name>]
usage: openstack software deployment output show [-h] [--all] [--long]
<deployment> [<output-name>]Positional arguments
- <deployment>
ID of deployment to show the output for
- <output-name>
Name of an output to display
Optional arguments
- -h, --help
show this help message and exit
- --all
Display all deployment outputs
- --long
Show full deployment logs in output
2.362. openstack software deployment show
Positional arguments
- <deployment>
ID of the deployment
Optional arguments
- -h, --help
show this help message and exit
- --long
Show more fields in output
2.363. openstack stack abandon
usage: openstack stack abandon [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--output-file <output-file>]
<stack>
usage: openstack stack abandon [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--output-file <output-file>]
<stack>Positional arguments
- <stack>
Name or ID of stack to abandon
Optional arguments
- -h, --help
show this help message and exit
- --output-file <output-file>
File to output abandon results
2.364. openstack stack adopt
Positional arguments
- <stack-name>
Name of the stack to adopt
Optional arguments
- -h, --help
show this help message and exit
- -e <environment>, --environment <environment>
Path to the environment. Can be specified multiple
times
- --timeout <timeout>
Stack creation timeout in minutes
- --enable-rollback
Enable rollback on create/update failure
- --parameter <key=value>
Parameter values used to create the stack. Can be
specified multiple times
- --wait
Wait until stack adopt completes
- --adopt-file <adopt-file>
Path to adopt stack data file
2.365. openstack stack cancel
usage: openstack stack cancel [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--wait]
<stack> [<stack> ...]
usage: openstack stack cancel [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--wait]
<stack> [<stack> ...]Positional arguments
- <stack>
Stack(s) to cancel (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --wait
Wait for check to complete
2.366. openstack stack check
usage: openstack stack check [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--wait]
<stack> [<stack> ...]
usage: openstack stack check [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--wait]
<stack> [<stack> ...]Positional arguments
- <stack>
Stack(s) to check update (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --wait
Wait for check to complete
2.367. openstack stack create
Positional arguments
- <stack-name>
Name of the stack to create
Optional arguments
- -h, --help
show this help message and exit
- -e <environment>, --environment <environment>
Path to the environment. Can be specified multiple
times
- --timeout <timeout>
Stack creating timeout in minutes
- --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
- --enable-rollback
Enable rollback on create/update failure
- --parameter <key=value>
Parameter values used to create the stack. This can be
specified multiple times
- --parameter-file <key=file>
Parameter values from file used to create the stack.
This can be specified multiple times. Parameter values
would be the content of the file
- --wait
Wait until stack goes to CREATE_COMPLETE or
CREATE_FAILED
- --tags <tag1,tag2...>
A list of tags to associate with the stack
- --dry-run
Do not actually perform the stack create, but show
what would be created
- -t <template>, --template <template>
Path to the template
2.368. openstack stack delete
usage: openstack stack delete [-h] [--yes] [--wait] <stack> [<stack> ...]
usage: openstack stack delete [-h] [--yes] [--wait] <stack> [<stack> ...]Positional arguments
- <stack>
Stack(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --yes
Skip yes/no prompt (assume yes)
- --wait
Wait for stack delete to complete
2.369. openstack stack environment show
usage: openstack stack environment show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<NAME or ID>
usage: openstack stack environment show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<NAME or ID>Positional arguments
- <NAME or ID>
Name or ID of stack to query
Optional arguments
- -h, --help
show this help message and exit
2.370. openstack stack event list
Positional arguments
- <stack>
Name or ID of stack to show events for
Optional arguments
- -h, --help
show this help message and exit
- --resource <resource>
Name of resource to show events for. Note: this cannot
be specified with --nested-depth
- --filter <key=value>
Filter parameters to apply on returned events
- --limit <limit>
Limit the number of events returned
- --marker <id>
Only return events that appear after the given ID
- --nested-depth <depth>
Depth of nested stacks from which to display events.
Note: this cannot be specified with --resource
- --sort <key>[:<direction>]
Sort output by selected keys and directions (asc or
desc) (default: asc). Specify multiple times to sort
on multiple keys
- --follow
Print events until process is halted
2.371. openstack stack event show
usage: openstack stack event show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<stack> <resource> <event>
usage: openstack stack event show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<stack> <resource> <event>Positional arguments
- <stack>
Name or ID of stack to show events for
- <resource>
Name of the resource event belongs to
- <event>
ID of event to display details for
Optional arguments
- -h, --help
show this help message and exit
2.372. openstack stack failures list
usage: openstack stack failures list [-h] [--long] <stack>
usage: openstack stack failures list [-h] [--long] <stack>Positional arguments
- <stack>
Stack to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --long
Show full deployment logs in output
2.373. openstack stack file list
usage: openstack stack file list [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<NAME or ID>
usage: openstack stack file list [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<NAME or ID>Positional arguments
- <NAME or ID>
Name or ID of stack to query
Optional arguments
- -h, --help
show this help message and exit
2.374. openstack stack hook clear
usage: openstack stack hook clear [-h] [--pre-create] [--pre-update]
[--pre-delete]
<stack> <resource> [<resource> ...]
usage: openstack stack hook clear [-h] [--pre-create] [--pre-update]
[--pre-delete]
<stack> <resource> [<resource> ...]Positional arguments
- <stack>
Stack to display (name or ID)
- <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
- -h, --help
show this help message and exit
- --pre-create
Clear the pre-create hooks
- --pre-update
Clear the pre-update hooks
- --pre-delete
Clear the pre-delete hooks
2.375. openstack stack hook poll
Positional arguments
- <stack>
Stack to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --nested-depth <nested-depth>
Depth of nested stacks from which to display hooks
2.376. openstack stack list
Optional arguments
- -h, --help
show this help message and exit
- --deleted
Include soft-deleted stacks in the stack listing
- --nested
Include nested stacks in the stack listing
- --hidden
Include hidden stacks in the stack listing
- --property <key=value>
Filter properties to apply on returned stacks (repeat
to filter on multiple properties)
- --tags <tag1,tag2...>
List of tags to filter by. Can be combined with --tag-
mode to specify how to filter tags
- --tag-mode <mode>
Method of filtering tags. Must be one of "any", "not",
or "not-any". If not specified, multiple tags will be
combined with the boolean AND expression
- --limit <limit>
The number of stacks returned
- --marker <id>
Only return stacks that appear after the given ID
- --sort <key>[:<direction>]
Sort output by selected keys and directions (asc or
desc) (default: asc). Specify multiple times to sort
on multiple properties
- --all-projects
Include all projects (admin only)
- --short
List fewer fields in output
- --long
List additional fields in output, this is implied by
--all-projects
2.377. openstack stack output list
usage: openstack stack output list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
<stack>
usage: openstack stack output list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
<stack>Positional arguments
- <stack>
Name or ID of stack to query
Optional arguments
- -h, --help
show this help message and exit
2.378. openstack stack output show
usage: openstack stack output show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] [--all]
<stack> [<output>]
usage: openstack stack output show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] [--all]
<stack> [<output>]Positional arguments
- <stack>
Name or ID of stack to query
- <output>
Name of an output to display
Optional arguments
- -h, --help
show this help message and exit
- --all
Display all stack outputs
2.379. openstack stack resource list
Positional arguments
- <stack>
Name or ID of stack to query
Optional arguments
- -h, --help
show this help message and exit
- --long
Enable detailed information presented for each
resource in resource list
- -n <nested-depth>, --nested-depth <nested-depth>
Depth of nested stacks from which to display resources
- --filter <key=value>
Filter parameters to apply on returned resources based
on their name, status, type, action, id and
physical_resource_id
2.380. openstack stack resource mark unhealthy
usage: openstack stack resource mark unhealthy [-h] [--reset]
<stack> <resource> [reason]
usage: openstack stack resource mark unhealthy [-h] [--reset]
<stack> <resource> [reason]Positional arguments
- <stack>
Name or ID of stack the resource belongs to
- <resource>
Name of the resource
- reason
Reason for state change
Optional arguments
- -h, --help
show this help message and exit
- --reset
Set the resource as healthy
2.381. openstack stack resource metadata
usage: openstack stack resource metadata [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<stack> <resource>
usage: openstack stack resource metadata [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<stack> <resource>Positional arguments
- <stack>
Stack to display (name or ID)
- <resource>
Name of the resource to show the metadata for
Optional arguments
- -h, --help
show this help message and exit
2.382. openstack stack resource show
usage: openstack stack resource show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--with-attr <attribute>]
<stack> <resource>
usage: openstack stack resource show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--with-attr <attribute>]
<stack> <resource>Positional arguments
- <stack>
Name or ID of stack to query
- <resource>
Name or ID of resource
Optional arguments
- -h, --help
show this help message and exit
- --with-attr <attribute>
Attribute to show, can be specified multiple times
2.383. openstack stack resource signal
usage: openstack stack resource signal [-h] [--data <data>]
[--data-file <data-file>]
<stack> <resource>
usage: openstack stack resource signal [-h] [--data <data>]
[--data-file <data-file>]
<stack> <resource>Positional arguments
- <stack>
Name or ID of stack the resource belongs to
- <resource>
Name of the resoure to signal
Optional arguments
- -h, --help
show this help message and exit
- --data <data> JSON
Data to send to the signal handler
- --data-file <data-file>
File containing JSON data to send to the signal
handler
2.384. openstack stack resume
usage: openstack stack resume [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--wait]
<stack> [<stack> ...]
usage: openstack stack resume [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--wait]
<stack> [<stack> ...]Positional arguments
- <stack>
Stack(s) to resume (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --wait
Wait for resume to complete
2.385. openstack stack show
usage: openstack stack show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<stack>
usage: openstack stack show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<stack>Positional arguments
- <stack>
Stack to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.386. openstack stack snapshot create
usage: openstack stack snapshot create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--name <name>]
<stack>
usage: openstack stack snapshot create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--name <name>]
<stack>Positional arguments
- <stack>
Name or ID of stack
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Name of snapshot
2.387. openstack stack snapshot delete
usage: openstack stack snapshot delete [-h] <stack> <snapshot>
usage: openstack stack snapshot delete [-h] <stack> <snapshot>Positional arguments
- <stack>
Name or ID of stack
- <snapshot>
ID of stack snapshot
Optional arguments
- -h, --help
show this help message and exit
2.388. openstack stack snapshot list
usage: openstack stack snapshot list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
<stack>
usage: openstack stack snapshot list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
<stack>Positional arguments
- <stack>
Name or ID of stack containing the snapshots
Optional arguments
- -h, --help
show this help message and exit
2.389. openstack stack snapshot restore
usage: openstack stack snapshot restore [-h] <stack> <snapshot>
usage: openstack stack snapshot restore [-h] <stack> <snapshot>Positional arguments
- <stack>
Name or ID of stack containing the snapshot
- <snapshot>
ID of the snapshot to restore
Optional arguments
- -h, --help
show this help message and exit
2.390. openstack stack snapshot show
usage: openstack stack snapshot show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<stack> <snapshot>
usage: openstack stack snapshot show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<stack> <snapshot>Positional arguments
- <stack>
Name or ID of stack containing the snapshot
- <snapshot>
ID of the snapshot to show
Optional arguments
- -h, --help
show this help message and exit
2.391. openstack stack suspend
Positional arguments
- <stack>
Stack(s) to suspend (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --wait
Wait for suspend to complete
2.392. openstack stack template show
usage: openstack stack template show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<stack>
usage: openstack stack template show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<stack>Positional arguments
- <stack>
Name or ID of stack to query
Optional arguments
- -h, --help
show this help message and exit
2.393. openstack stack update
Positional arguments
- <stack>
Name or ID of stack to update
Optional arguments
- -h, --help
show this help message and exit
- -t <template>, --template <template>
Path to the template
- -e <environment>, --environment <environment>
Path to the environment. 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
- --timeout <timeout>
Stack update timeout in minutes
- --rollback <value>
Set rollback on update failure. Value "enabled" sets
rollback to enabled. Value "disabled" sets rollback to
disabled. Value "keep" uses the value of existing
stack to be updated (default)
- --dry-run
Do not actually perform the stack update, but show
what would be changed
- --parameter <key=value>
Parameter values used to create the stack. This can be
specified multiple times
- --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
- --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 is specified then the existing
environment is used. Parameters specified in
--parameter will patch over the existing values in the
current stack. Parameters omitted will keep the
existing values
- --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
- --wait
Wait until stack goes to UPDATE_COMPLETE or
UPDATE_FAILED
2.394. openstack subnet create
Positional arguments
- name
New subnet name
Optional arguments
- -h, --help
show this help message and exit
- --project <project>
Owner's project (name or ID)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
- --subnet-pool <subnet-pool>
Subnet pool from which this subnet will obtain a CIDR
(Name or ID)
- --use-default-subnet-pool
Use default subnet pool for --ip-version
- --prefix-length <prefix-length>
Prefix length for subnet allocation from subnet pool
- --subnet-range <subnet-range>
Subnet range in CIDR notation (required if --subnet-
pool is not specified, optional otherwise)
- --dhcp
Enable DHCP (default)
- --no-dhcp
Disable DHCP
- --gateway <gateway>
Specify a gateway for the subnet. The three options
are: <ip-address>: Specific IP address to use as the
gateway, 'auto': Gateway address should automatically
be chosen from within the subnet itself, 'none': This
subnet will not use a gateway, e.g.: --gateway
192.168.9.1, --gateway auto, --gateway none (default
is 'auto').
- --ip-version {4,6} IP
version (default is 4). Note that when subnet pool
is specified, IP version is determined from the subnet
pool and this option is ignored.
- --ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}
IPv6 RA (Router Advertisement) mode, valid modes:
[dhcpv6-stateful, dhcpv6-stateless, slaac]
- --ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}
IPv6 address mode, valid modes: [dhcpv6-stateful,
dhcpv6-stateless, slaac]
- --network <network>
Network this subnet belongs to (name or ID)
- --allocation-pool
start=<ip-address>,end=<ip-address>
Allocation pool IP addresses for this subnet e.g.:
start=192.168.199.2,end=192.168.199.254 (repeat option
to add multiple IP addresses)
- --dns-nameserver <dns-nameserver>
DNS server for this subnet (repeat option to set
multiple DNS servers)
- --host-route
destination=<subnet>,gateway=<ip-address>
Additional route for this subnet e.g.:
destination=10.10.0.0/16,gateway=192.168.71.254
destination: destination subnet (in CIDR notation)
gateway: nexthop IP address (repeat option to add
multiple routes)
2.395. openstack subnet delete
usage: openstack subnet delete [-h] <subnet> [<subnet> ...]
usage: openstack subnet delete [-h] <subnet> [<subnet> ...]Positional arguments
- <subnet>
Subnet(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.396. openstack subnet list
usage: openstack subnet list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--long]
[--ip-version <ip-version>] [--dhcp | --no-dhcp]
usage: openstack subnet list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--long]
[--ip-version <ip-version>] [--dhcp | --no-dhcp]Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
- --ip-version <ip-version>
List only subnets of given IP version in
output.Allowed values for IP version are 4 and 6.
- --dhcp
List subnets which have DHCP enabled
- --no-dhcp
List subnets which have DHCP disabled
2.397. openstack subnet pool create
Positional arguments
- <name>
Name of the new subnet pool
Optional arguments
- -h, --help
show this help message and exit
- --pool-prefix <pool-prefix>
Set subnet pool prefixes (in CIDR notation) (repeat
option to set multiple prefixes)
- --default-prefix-length <default-prefix-length>
Set subnet pool default prefix length
- --min-prefix-length <min-prefix-length>
Set subnet pool minimum prefix length
- --max-prefix-length <max-prefix-length>
Set subnet pool maximum prefix length
- --project <project>
Owner's project (name or ID)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
- --address-scope <address-scope>
Set address scope associated with the subnet pool
(name or ID), prefixes must be unique across address
scopes
- --default
Set this as a default subnet pool
- --no-default
Set this as a non-default subnet pool
- --share
Set this subnet pool as shared
- --no-share
Set this subnet pool as not shared
2.398. openstack subnet pool delete
usage: openstack subnet pool delete [-h] <subnet-pool> [<subnet-pool> ...]
usage: openstack subnet pool delete [-h] <subnet-pool> [<subnet-pool> ...]Positional arguments
- <subnet-pool>
Subnet pool(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.399. openstack subnet pool list
usage: openstack subnet pool list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long]
usage: openstack subnet pool list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long]Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
2.400. openstack subnet pool set
Positional arguments
- <subnet-pool>
Subnet pool to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Set subnet pool name
- --pool-prefix <pool-prefix>
Set subnet pool prefixes (in CIDR notation) (repeat
option to set multiple prefixes)
- --default-prefix-length <default-prefix-length>
Set subnet pool default prefix length
- --min-prefix-length <min-prefix-length>
Set subnet pool minimum prefix length
- --max-prefix-length <max-prefix-length>
Set subnet pool maximum prefix length
- --address-scope <address-scope>
Set address scope associated with the subnet pool
(name or ID), prefixes must be unique across address
scopes
- --no-address-scope
Remove address scope associated with the subnet pool
- --default
Set this as a default subnet pool
- --no-default
Set this as a non-default subnet pool
2.401. openstack subnet pool show
usage: openstack subnet pool show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<subnet-pool>
usage: openstack subnet pool show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<subnet-pool>Positional arguments
- <subnet-pool>
Subnet pool to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.402. openstack subnet pool unset
usage: openstack subnet pool unset [-h] [--pool-prefix <pool-prefix>]
<subnet-pool>
usage: openstack subnet pool unset [-h] [--pool-prefix <pool-prefix>]
<subnet-pool>Positional arguments
- <subnet-pool>
Subnet pool to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --pool-prefix <pool-prefix>
Remove subnet pool prefixes (in CIDR notation).
(repeat option to unset multiple prefixes).
2.403. openstack subnet set
Positional arguments
- <subnet>
Subnet to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Updated name of the subnet
- --dhcp
Enable DHCP
- --no-dhcp
Disable DHCP
- --gateway <gateway>
Specify a gateway for the subnet. The options are:
<ip-address>: Specific IP address to use as the
gateway, 'none': This subnet will not use a gateway,
e.g.: --gateway 192.168.9.1, --gateway none.
- --allocation-pool
start=<ip-address>,end=<ip-address>
Allocation pool IP addresses for this subnet e.g.:
start=192.168.199.2,end=192.168.199.254 (repeat option
to add multiple IP addresses)
- --dns-nameserver <dns-nameserver>
DNS server for this subnet (repeat option to set
multiple DNS servers)
- --host-route
destination=<subnet>,gateway=<ip-address>
Additional route for this subnet e.g.:
destination=10.10.0.0/16,gateway=192.168.71.254
destination: destination subnet (in CIDR notation)
gateway: nexthop IP address (repeat option to add
multiple routes)
2.404. openstack subnet show
usage: openstack subnet show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<subnet>
usage: openstack subnet show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<subnet>Positional arguments
- <subnet>
Subnet to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.405. openstack subnet unset
usage: openstack subnet unset [-h]
[--allocation-pool start=<ip-address>,end=<ip-address>]
[--dns-nameserver <dns-nameserver>]
[--host-route destination=<subnet>,gateway=<ip-address>]
<subnet>
usage: openstack subnet unset [-h]
[--allocation-pool start=<ip-address>,end=<ip-address>]
[--dns-nameserver <dns-nameserver>]
[--host-route destination=<subnet>,gateway=<ip-address>]
<subnet>Positional arguments
- <subnet>
Subnet to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --allocation-pool
start=<ip-address>,end=<ip-address>
Allocation pool to be removed from this subnet e.g.:
start=192.168.199.2,end=192.168.199.254 (repeat option
to unset multiple Allocation pools)
- --dns-nameserver <dns-nameserver>
DNS server to be removed from this subnet (repeat
option to set multiple DNS servers)
- --host-route
destination=<subnet>,gateway=<ip-address>
Route to be removed from this subnet e.g.:
destination=10.10.0.0/16,gateway=192.168.71.254
destination: destination subnet (in CIDR notation)
gateway: nexthop IP address (repeat option to unset
multiple host routes)
2.406. openstack task execution list
usage: openstack task execution list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[workflow_execution]
usage: openstack task execution list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[workflow_execution]Positional arguments
- workflow_execution
Workflow execution ID associated with list of Tasks.
Optional arguments
- -h, --help
show this help message and exit
2.407. openstack task execution rerun
usage: openstack task execution rerun [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--resume] [-e ENV]
id
usage: openstack task execution rerun [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--resume] [-e ENV]
idPositional arguments
- id
Task identifier
Optional arguments
- -h, --help
show this help message and exit
- --resume
rerun only failed or unstarted action executions for
with-items task
- -e ENV, --env ENV
Environment variables
2.408. openstack task execution show
usage: openstack task execution show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
task
usage: openstack task execution show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
taskPositional arguments
- task
Task identifier
Optional arguments
- -h, --help
show this help message and exit
2.409. openstack tld create
Optional arguments
- -h, --help
show this help message and exit
- --name NAME TLD
Name
- --description DESCRIPTION
Description
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.410. openstack tld delete
usage: openstack tld delete [-h] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
id
usage: openstack tld delete [-h] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
idPositional arguments
- id
TLD ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.411. openstack tld list
Optional arguments
- -h, --help
show this help message and exit
- --name NAME TLD NAME
- --description DESCRIPTION
TLD Description
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.412. openstack tld set
Positional arguments
- id
TLD ID
Optional arguments
- -h, --help
show this help message and exit
- --name NAME TLD
Name
- --description DESCRIPTION
Description
- --no-description
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.413. openstack tld show
usage: openstack tld show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
id
usage: openstack tld show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
idPositional arguments
- id
TLD ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.414. openstack token issue
usage: openstack token issue [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
usage: openstack token issue [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]Optional arguments
- -h, --help
show this help message and exit
2.415. openstack token revoke
usage: openstack token revoke [-h] <token>
usage: openstack token revoke [-h] <token>Positional arguments
- <token>
Token to be deleted
Optional arguments
- -h, --help
show this help message and exit
2.416. openstack usage list
usage: openstack usage list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--start <start>] [--end <end>]
usage: openstack usage list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--start <start>] [--end <end>]Optional arguments
- -h, --help
show this help message and exit
- --start <start>
Usage range start date, ex 2012-01-20 (default: 4
weeks ago)
- --end <end>
Usage range end date, ex 2012-01-20 (default:
tomorrow)
2.417. openstack usage show
usage: openstack usage show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--project <project>]
[--start <start>] [--end <end>]
usage: openstack usage show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--project <project>]
[--start <start>] [--end <end>]Optional arguments
- -h, --help
show this help message and exit
- --project <project>
Name or ID of project to show usage for
- --start <start>
Usage range start date, ex 2012-01-20 (default: 4
weeks ago)
- --end <end>
Usage range end date, ex 2012-01-20 (default:
tomorrow)
2.418. openstack user create
Positional arguments
- <name>
New user name
Optional arguments
- -h, --help
show this help message and exit
- --project <project>
Default project (name or ID)
- --password <password>
Set user password
- --password-prompt
Prompt interactively for password
- --email <email-address>
Set user email address
- --enable
Enable user (default)
- --disable
Disable user
- --or-show
Return existing user
2.419. openstack user delete
usage: openstack user delete [-h] <user> [<user> ...]
usage: openstack user delete [-h] <user> [<user> ...]Positional arguments
- <user>
User(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.420. openstack user list
usage: openstack user list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--project <project>] [--long]
usage: openstack user list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--project <project>] [--long]Optional arguments
- -h, --help
show this help message and exit
- --project <project>
Filter users by project (name or ID)
- --long
List additional fields in output
2.421. openstack user role list
Positional arguments
- <user>
User to list (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --project <project>
Filter users by <project> (name or ID)
2.422. openstack user set
usage: openstack user set [-h] [--name <name>] [--project <project>]
[--password <user-password>] [--password-prompt]
[--email <email-address>] [--enable | --disable]
<user>
usage: openstack user set [-h] [--name <name>] [--project <project>]
[--password <user-password>] [--password-prompt]
[--email <email-address>] [--enable | --disable]
<user>Positional arguments
- <user>
User to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Set user name
- --project <project>
Set default project (name or ID)
- --password <user-password>
Set user password
- --password-prompt
Prompt interactively for password
- --email <email-address>
Set user email address
- --enable
Enable user (default)
- --disable
Disable user
2.423. openstack user show
usage: openstack user show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
<user>
usage: openstack user show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
<user>Positional arguments
- <user>
User to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.424. openstack volume backup create
Positional arguments
- <volume>
Volume to backup (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Name of the backup
- --description <description>
Description of the backup
- --container <container>
Optional backup container name
- --snapshot <snapshot>
Snapshot to backup (name or ID)
- --force
Allow to back up an in-use volume
- --incremental
Perform an incremental backup
2.425. openstack volume backup delete
usage: openstack volume backup delete [-h] [--force] <backup> [<backup> ...]
usage: openstack volume backup delete [-h] [--force] <backup> [<backup> ...]Positional arguments
- <backup>
Backup(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --force
Allow delete in state other than error or available
2.426. openstack volume backup list
usage: openstack volume backup list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long]
usage: openstack volume backup list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long]Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
2.427. openstack volume backup restore
usage: openstack volume backup restore [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<backup> <volume>
usage: openstack volume backup restore [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<backup> <volume>Positional arguments
- <backup>
Backup to restore (name or ID)
- <volume>
Volume to restore to (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.428. openstack volume backup show
usage: openstack volume backup show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<backup>
usage: openstack volume backup show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<backup>Positional arguments
- <backup>
Backup to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.429. openstack volume create
Positional arguments
- <name>
Volume name
Optional arguments
- -h, --help
show this help message and exit
- --size <size>
Volume size in GB
- --type <volume-type>
Set the type of volume
- --image <image>
Use <image> as source of volume (name or ID)
- --snapshot <snapshot>
Use <snapshot> as source of volume (name or ID)
- --source <volume>
Volume to clone (name or ID)
- --description <description>
Volume description
- --user <user>
Specify an alternate user (name or ID)
- --project <project>
Specify an alternate project (name or ID)
- --availability-zone <availability-zone>
Create volume in <availability-zone>
- --property <key=value>
Set a property to this volume (repeat option to set
multiple properties)
2.430. openstack volume delete
usage: openstack volume delete [-h] [--force | --purge]
<volume> [<volume> ...]
usage: openstack volume delete [-h] [--force | --purge]
<volume> [<volume> ...]Positional arguments
- <volume>
Volume(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --force
Attempt forced removal of volume(s), regardless of state
(defaults to False)
- --purge
Remove any snapshots along with volume(s) (defaults to False)
2.431. openstack volume list
Optional arguments
- -h, --help
show this help message and exit
- --project <project>
Filter results by project (name or ID) (admin only)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
- --user <user>
Filter results by user (name or ID) (admin only)
- --user-domain <user-domain>
Domain the user belongs to (name or ID). This can be
used in case collisions between user names exist.
- --name <name>
Filter results by volume name
- --status <status>
Filter results by status
- --all-projects
Include all projects (admin only)
- --long
List additional fields in output
2.432. openstack volume qos associate
usage: openstack volume qos associate [-h] <qos-spec> <volume-type>
usage: openstack volume qos associate [-h] <qos-spec> <volume-type>Positional arguments
- <qos-spec>
QoS specification to modify (name or ID)
- <volume-type>
Volume type to associate the QoS (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.433. openstack volume qos create
Positional arguments
- <name>
New QoS specification name
Optional arguments
- -h, --help
show this help message and exit
- --consumer <consumer>
Consumer of the QoS. Valid consumers: back-end, both,
front-end (defaults to 'both')
- --property <key=value>
Set a QoS specification property (repeat option to set
multiple properties)
2.434. openstack volume qos delete
usage: openstack volume qos delete [-h] [--force] <qos-spec> [<qos-spec> ...]
usage: openstack volume qos delete [-h] [--force] <qos-spec> [<qos-spec> ...]Positional arguments
- <qos-spec>
QoS specification(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --force
Allow to delete in-use QoS specification(s)
2.435. openstack volume qos disassociate
usage: openstack volume qos disassociate [-h]
[--volume-type <volume-type> | --all]
<qos-spec>
usage: openstack volume qos disassociate [-h]
[--volume-type <volume-type> | --all]
<qos-spec>Positional arguments
- <qos-spec>
QoS specification to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --volume-type <volume-type>
Volume type to disassociate the QoS from (name or ID)
- --all
Disassociate the QoS from every volume type
2.436. openstack volume qos list
usage: openstack volume qos list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
usage: openstack volume qos list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.437. openstack volume qos set
usage: openstack volume qos set [-h] [--property <key=value>] <qos-spec>
usage: openstack volume qos set [-h] [--property <key=value>] <qos-spec>Positional arguments
- <qos-spec>
QoS specification to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --property <key=value>
Property to add or modify for this QoS specification
(repeat option to set multiple properties)
2.438. openstack volume qos show
usage: openstack volume qos show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<qos-spec>
usage: openstack volume qos show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<qos-spec>Positional arguments
- <qos-spec>
QoS specification to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.439. openstack volume qos unset
usage: openstack volume qos unset [-h] [--property <key>] <qos-spec>
usage: openstack volume qos unset [-h] [--property <key>] <qos-spec>Positional arguments
- <qos-spec>
QoS specification to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --property <key>
Property to remove from the QoS specification. (repeat
option to unset multiple properties)
2.440. openstack volume service list
Optional arguments
- -h, --help
show this help message and exit
- --host <host>
List services on specified host (name only)
- --service <service>
List only specified service (name only)
- --long
List additional fields in output
2.441. openstack volume set
usage: openstack volume set [-h] [--name <name>] [--size <size>]
[--description <description>]
[--property <key=value>]
[--image-property <key=value>] [--state <state>]
<volume>
usage: openstack volume set [-h] [--name <name>] [--size <size>]
[--description <description>]
[--property <key=value>]
[--image-property <key=value>] [--state <state>]
<volume>Positional arguments
- <volume>
Volume to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
New volume name
- --size <size>
Extend volume size in GB
- --description <description>
New volume description
- --property <key=value>
Set a property on this volume (repeat option to set
multiple properties)
- --image-property <key=value>
Set an image property on this volume (repeat option to
set multiple image properties)
- --state <state>
New volume state ("available", "error", "creating",
"deleting", "in-use", "attaching", "detaching",
"error_deleting" or "maintenance")
2.442. openstack volume show
usage: openstack volume show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<volume-id>
usage: openstack volume show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<volume-id>Positional arguments
- <volume-id>
Volume to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.443. openstack volume transfer request list
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Shows detail for all projects. Admin only. (defaults
to False)
2.444. openstack volume type create
Positional arguments
- <name>
Volume type name
Optional arguments
- -h, --help
show this help message and exit
- --description <description>
Volume type description
- --public
Volume type is accessible to the public
- --private
Volume type is not accessible to the public
- --property <key=value>
Set a property on this volume type (repeat option to
set multiple properties)
- --project <project>
Allow <project> to access private type (name or ID)
(Must be used with --private option)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
2.445. openstack volume type delete
usage: openstack volume type delete [-h] <volume-type> [<volume-type> ...]
usage: openstack volume type delete [-h] <volume-type> [<volume-type> ...]Positional arguments
- <volume-type>
Volume type(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.446. openstack volume type list
usage: openstack volume type list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long] [--public | --private]
usage: openstack volume type list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long] [--public | --private]Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
- --public
List only public types
- --private
List only private types (admin only)
2.447. openstack volume type set
usage: openstack volume type set [-h] [--name <name>] [--description <name>]
[--property <key=value>]
[--project <project>]
[--project-domain <project-domain>]
<volume-type>
usage: openstack volume type set [-h] [--name <name>] [--description <name>]
[--property <key=value>]
[--project <project>]
[--project-domain <project-domain>]
<volume-type>Positional arguments
- <volume-type>
Volume type to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Set volume type name
- --description <name>
Set volume type description
- --property <key=value>
Set a property on this volume type (repeat option to
set multiple properties)
- --project <project>
Set volume type access to project (name or ID) (admin
only)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
2.448. openstack volume type show
usage: openstack volume type show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<volume-type>
usage: openstack volume type show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<volume-type>Positional arguments
- <volume-type>
Volume type to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.449. openstack volume type unset
usage: openstack volume type unset [-h] [--property <key>]
[--project <project>]
[--project-domain <project-domain>]
<volume-type>
usage: openstack volume type unset [-h] [--property <key>]
[--project <project>]
[--project-domain <project-domain>]
<volume-type>Positional arguments
- <volume-type>
Volume type to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --property <key>
Remove a property from this volume type (repeat option
to remove multiple properties)
- --project <project>
Removes volume type access to project (name or ID)
(admin only)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
2.450. openstack volume unset
usage: openstack volume unset [-h] [--property <key>] [--image-property <key>]
<volume>
usage: openstack volume unset [-h] [--property <key>] [--image-property <key>]
<volume>Positional arguments
- <volume>
Volume to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --property <key>
Remove a property from volume (repeat option to remove
multiple properties)
- --image-property <key>
Remove an image property from volume (repeat option to
remove multiple image properties)
2.451. openstack workbook create
usage: openstack workbook create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
definition
usage: openstack workbook create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
definitionPositional arguments
- definition
Workbook definition file
Optional arguments
- -h, --help
show this help message and exit
2.452. openstack workbook delete
usage: openstack workbook delete [-h] workbook [workbook ...]
usage: openstack workbook delete [-h] workbook [workbook ...]Positional arguments
- workbook
Name of workbook(s).
Optional arguments
- -h, --help
show this help message and exit
2.453. openstack workbook list
usage: openstack workbook list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
usage: openstack workbook list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.454. openstack workbook show
usage: openstack workbook show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
workbook
usage: openstack workbook show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
workbookPositional arguments
- workbook
Workbook name
Optional arguments
- -h, --help
show this help message and exit
2.455. openstack workbook update
usage: openstack workbook update [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
definition
usage: openstack workbook update [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
definitionPositional arguments
- definition
Workbook definition file
Optional arguments
- -h, --help
show this help message and exit
2.456. openstack workbook validate
usage: openstack workbook validate [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
definition
usage: openstack workbook validate [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
definitionPositional arguments
- definition
Workbook definition file
Optional arguments
- -h, --help
show this help message and exit
2.457. openstack workflow create
Positional arguments
- definition
Workflow definition file.
Optional arguments
- -h, --help
show this help message and exit
- --public
With this flag workflow will be marked as "public".
2.458. openstack workflow delete
usage: openstack workflow delete [-h] workflow [workflow ...]
usage: openstack workflow delete [-h] workflow [workflow ...]Positional arguments
- workflow
Name or ID of workflow(s).
Optional arguments
- -h, --help
show this help message and exit
2.459. openstack workflow engine service list
Optional arguments
- -h, --help
show this help message and exit
2.460. openstack workflow env create
usage: openstack workflow env create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
file
usage: openstack workflow env create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
filePositional arguments
- file
Environment configuration file in JSON or YAML
Optional arguments
- -h, --help
show this help message and exit
2.461. openstack workflow env delete
usage: openstack workflow env delete [-h] environment [environment ...]
usage: openstack workflow env delete [-h] environment [environment ...]Positional arguments
- environment
Name of environment(s).
Optional arguments
- -h, --help
show this help message and exit
2.462. openstack workflow env list
usage: openstack workflow env list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
usage: openstack workflow env list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.463. openstack workflow env show
usage: openstack workflow env show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
environment
usage: openstack workflow env show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
environmentPositional arguments
- environment
Environment name
Optional arguments
- -h, --help
show this help message and exit
2.464. openstack workflow env update
usage: openstack workflow env update [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
file
usage: openstack workflow env update [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
filePositional arguments
- file
Environment configuration file in JSON or YAML
Optional arguments
- -h, --help
show this help message and exit
2.465. openstack workflow execution create
Positional arguments
- workflow_identifier
Workflow ID or name. Workflow name will be deprecated
sinceMitaka.
- workflow_input
Workflow input
- params
Workflow additional parameters
Optional arguments
- -h, --help
show this help message and exit
- -d DESCRIPTION, --description DESCRIPTION
Execution description
2.466. openstack workflow execution delete
usage: openstack workflow execution delete [-h] execution [execution ...]
usage: openstack workflow execution delete [-h] execution [execution ...]Positional arguments
- execution
Id of execution identifier(s).
Optional arguments
- -h, --help
show this help message and exit
2.467. openstack workflow execution list
Optional arguments
- -h, --help
show this help message and exit
- --marker [MARKER]
The last execution uuid of the previous page, displays
list of executions after "marker".
- --limit [LIMIT]
Maximum number of executions to return in a single
result.
- --sort_keys [SORT_KEYS]
Comma-separated list of sort keys to sort results by.
Default: created_at. Example: mistral execution-list
--sort_keys=id,description
- --sort_dirs [SORT_DIRS]
Comma-separated list of sort directions. Default: asc.
Example: mistral execution-list
--sort_keys=id,description --sort_dirs=asc,desc
2.468. openstack workflow execution show
usage: openstack workflow execution show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
execution
usage: openstack workflow execution show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
executionPositional arguments
- execution
Execution identifier
Optional arguments
- -h, --help
show this help message and exit
2.469. openstack workflow execution update
Positional arguments
- id
Execution identifier
Optional arguments
- -h, --help
show this help message and exit
- -s {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}, --state {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}
Execution state
- -e ENV, --env ENV
Environment variables
- -d DESCRIPTION, --description DESCRIPTION
Execution description
2.470. openstack workflow list
usage: openstack workflow list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
usage: openstack workflow list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.471. openstack workflow show
usage: openstack workflow show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
workflow
usage: openstack workflow show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
workflowPositional arguments
- workflow
Workflow ID or name.
Optional arguments
- -h, --help
show this help message and exit
2.472. openstack workflow update
Positional arguments
- definition
Workflow definition
Optional arguments
- -h, --help
show this help message and exit
- --id ID
Workflow ID.
- --public
With this flag workflow will be marked as "public".
2.473. openstack workflow validate
usage: openstack workflow validate [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
definition
usage: openstack workflow validate [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
definitionPositional arguments
- definition
Workflow definition file
Optional arguments
- -h, --help
show this help message and exit
2.474. openstack zone abandon
usage: openstack zone abandon [-h] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
id
usage: openstack zone abandon [-h] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
idPositional arguments
- id
Zone ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.475. openstack zone axfr
usage: openstack zone axfr [-h] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
id
usage: openstack zone axfr [-h] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
idPositional arguments
- id
Zone ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.476. openstack zone blacklist create
Optional arguments
- -h, --help
show this help message and exit
- --pattern PATTERN
Blacklist pattern
- --description DESCRIPTION
Description
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.477. openstack zone blacklist delete
usage: openstack zone blacklist delete [-h] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
id
usage: openstack zone blacklist delete [-h] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
idPositional arguments
- id
Blacklist ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.478. openstack zone blacklist list
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.479. openstack zone blacklist set
Positional arguments
- id
Blacklist ID
Optional arguments
- -h, --help
show this help message and exit
- --pattern PATTERN
Blacklist pattern
- --description DESCRIPTION
Description
- --no-description
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.480. openstack zone blacklist show
Positional arguments
- id
Blacklist ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.481. openstack zone create
Positional arguments
- name
Zone Name
Optional arguments
- -h, --help
show this help message and exit
- --email EMAIL
Zone Email
- --type TYPE
Zone Type
- --ttl TTL
Time To Live (Seconds)
- --description DESCRIPTION
Description
- --masters MASTERS [MASTERS ...]
Zone Masters
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.482. openstack zone delete
Positional arguments
- id
Zone ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.483. openstack zone export create
Positional arguments
- zone_id
Zone ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.484. openstack zone export delete
usage: openstack zone export delete [-h] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
zone_export_id
usage: openstack zone export delete [-h] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
zone_export_idPositional arguments
- zone_export_id
Zone Export ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.485. openstack zone export list
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.486. openstack zone export show
Positional arguments
- zone_export_id
Zone Export ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.487. openstack zone export showfile
Positional arguments
- zone_export_id
Zone Export ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.488. openstack zone import create
Positional arguments
- zone_file_path
Path to a zone file
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.489. openstack zone import delete
usage: openstack zone import delete [-h] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
zone_import_id
usage: openstack zone import delete [-h] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
zone_import_idPositional arguments
- zone_import_id
Zone Import ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.490. openstack zone import list
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.491. openstack zone import show
Positional arguments
- zone_import_id
Zone Import ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.492. openstack zone list
Optional arguments
- -h, --help
show this help message and exit
- --name NAME
Zone Name
- --email EMAIL
Zone Email
- --type TYPE
Zone Type
- --ttl TTL
Time To Live (Seconds)
- --description DESCRIPTION
Description
- --status STATUS
Zone Status
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.493. openstack zone set
Positional arguments
- id
Zone ID
Optional arguments
- -h, --help
show this help message and exit
- --email EMAIL
Zone Email
- --ttl TTL
Time To Live (Seconds)
- --description DESCRIPTION
Description
- --no-description
- --masters MASTERS [MASTERS ...]
Zone Masters
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.494. openstack zone show
usage: openstack zone show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
id
usage: openstack zone show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
idPositional arguments
- id
Zone ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.495. openstack zone transfer accept list
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.496. openstack zone transfer accept request
Optional arguments
- -h, --help
show this help message and exit
- --transfer-id TRANSFER_ID
Transfer ID
- --key KEY
Transfer Key
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.497. openstack zone transfer accept show
Positional arguments
- id
Zone Tranfer Accept ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.498. openstack zone transfer request create
Positional arguments
- zone_id
Zone ID to transfer.
Optional arguments
- -h, --help
show this help message and exit
- --target-project-id TARGET_PROJECT_ID
Target Project ID to transfer to.
- --description DESCRIPTION
Description
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.499. openstack zone transfer request delete
usage: openstack zone transfer request delete [-h] [--all-projects]
[--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
id
usage: openstack zone transfer request delete [-h] [--all-projects]
[--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
idPositional arguments
- id
Zone Transfer Request ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.500. openstack zone transfer request list
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.501. openstack zone transfer request set
Positional arguments
- id
Zone Transfer Request ID
Optional arguments
- -h, --help
show this help message and exit
- --description DESCRIPTION
Description
- --no-description
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.502. openstack zone transfer request show
Positional arguments
- id
Zone Tranfer Request ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
Chapter 3. Configuration File Editor
0.7.
3.1. openstack-config Usage
Usage: crudini --set [OPTION]... config_file section [param] [value] crudini --get [OPTION]... config_file [section] [param] crudini --del [OPTION]... config_file section [param] [list value] crudini --merge [OPTION]... config_file [section]
Usage: crudini --set [OPTION]... config_file section [param] [value]
crudini --get [OPTION]... config_file [section] [param]
crudini --del [OPTION]... config_file section [param] [list value]
crudini --merge [OPTION]... config_file [section]3.2. openstack-config Optional Arguments
- --existing[=WHAT]
For --set, --del and --merge, fail if item is missing,
where WHAT is 'file', 'section', or 'param', or if
not specified; all specifed items.
- --format=FMT
For --get, select the output FMT.
Formats are sh,ini,lines
- --inplace
Lock and write files in place.
This is not atomic but has less restrictions
than the default replacement method.
- --list
For --set and --del, update a list (set) of values
- --list-sep=STR
Delimit list values with "STR" instead of " ,"
- --output=FILE
Write output to FILE instead. '-' means stdout
- --verbose
Indicate on stderr if changes were made
Chapter 4. Block Storage Service Command-line Client
1.9.0.
cinder help COMMAND
$ cinder help COMMAND4.1. cinder Usage
Subcommands
- absolute-limits
Lists absolute limits for a user.
- 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.
- cgsnapshot-create
Creates a cgsnapshot.
- cgsnapshot-delete
Removes one or more cgsnapshots.
- cgsnapshot-list
Lists all cgsnapshots.
- cgsnapshot-show
Shows cgsnapshot details.
- 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 consistencygroups.
- consisgroup-show
Shows details of a consistency group.
- consisgroup-update
Updates a consistencygroup.
- 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-show
Shows details of a group.
- 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.
- 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.
- 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.
- 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'. (Admin only will see
private 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.
- bash-completion
Prints arguments for bash_completion.
- help
Shows help about this program or one of its
subcommands.
- list-extensions
Lists all available os-api 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 toenv[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 toenv[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 toenv[OS_PROJECT_DOMAIN_ID].
- --os-project-domain-name <auth-project-domain-name>
Defaults toenv[OS_PROJECT_DOMAIN_NAME].
- --os-region-name <region-name>
Region name. Default=env[OS_REGION_NAME].
- --os-token <token>
Defaults toenv[OS_TOKEN].
- --os-url <url>
Defaults toenv[OS_URL].
4.3. Block Storage API v1 Commands
4.3.1. cinder absolute-limits
usage: cinder absolute-limits [<tenant_id>]
usage: cinder absolute-limits [<tenant_id>]Positional arguments
- <tenant_id>
Display information for a single tenant (Admin only).
4.3.2. cinder availability-zone-list
usage: cinder availability-zone-list
usage: cinder availability-zone-list4.3.3. cinder backup-create
usage: cinder backup-create [--container <container>] [--name <name>]
[--description <description>] [--incremental]
[--force] [--snapshot-id <snapshot-id>]
<volume>
usage: cinder backup-create [--container <container>] [--name <name>]
[--description <description>] [--incremental]
[--force] [--snapshot-id <snapshot-id>]
<volume>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.3.4. cinder backup-delete
usage: cinder backup-delete [--force] <backup> [<backup> ...]
usage: cinder backup-delete [--force] <backup> [<backup> ...]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.3.5. cinder backup-export
usage: cinder backup-export <backup>
usage: cinder backup-export <backup>Positional arguments
- <backup>
ID of the backup to export.
4.3.6. cinder backup-import
usage: cinder backup-import <backup_service> <backup_url>
usage: cinder backup-import <backup_service> <backup_url>Positional arguments
- <backup_service>
Backup service to use for importing the backup.
- <backup_url>
Backup URL for importing the backup metadata.
4.3.7. 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>]]
usage: cinder backup-list [--all-tenants [<all_tenants>]] [--name <name>]
[--status <status>] [--volume-id <volume-id>]
[--marker <marker>] [--limit <limit>]
[--sort <key>[:<direction>]]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.3.8. cinder backup-reset-state
usage: cinder backup-reset-state [--state <state>] <backup> [<backup> ...]
usage: cinder backup-reset-state [--state <state>] <backup> [<backup> ...]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.3.9. cinder backup-restore
usage: cinder backup-restore [--volume <volume>] [--name <name>] <backup>
usage: cinder backup-restore [--volume <volume>] [--name <name>] <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.3.10. cinder backup-show
usage: cinder backup-show <backup>
usage: cinder backup-show <backup>Positional arguments
- <backup>
Name or ID of backup.
4.3.11. cinder cgsnapshot-create
usage: cinder cgsnapshot-create [--name <name>] [--description <description>]
<consistencygroup>
usage: cinder cgsnapshot-create [--name <name>] [--description <description>]
<consistencygroup>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.3.12. cinder cgsnapshot-delete
usage: cinder cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]
usage: cinder cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]Positional arguments
- <cgsnapshot>
Name or ID of one or more cgsnapshots to be deleted.
4.3.13. cinder cgsnapshot-list
usage: cinder cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>]
[--consistencygroup-id <consistencygroup_id>]
usage: cinder cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>]
[--consistencygroup-id <consistencygroup_id>]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.3.14. cinder cgsnapshot-show
usage: cinder cgsnapshot-show <cgsnapshot>
usage: cinder cgsnapshot-show <cgsnapshot>Positional arguments
- <cgsnapshot>
Name or ID of cgsnapshot.
4.3.15. cinder consisgroup-create
usage: cinder consisgroup-create [--name <name>] [--description <description>]
[--availability-zone <availability-zone>]
<volume-types>
usage: cinder consisgroup-create [--name <name>] [--description <description>]
[--availability-zone <availability-zone>]
<volume-types>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.3.16. cinder consisgroup-create-from-src
usage: cinder consisgroup-create-from-src [--cgsnapshot <cgsnapshot>]
[--source-cg <source-cg>]
[--name <name>]
[--description <description>]
usage: cinder consisgroup-create-from-src [--cgsnapshot <cgsnapshot>]
[--source-cg <source-cg>]
[--name <name>]
[--description <description>]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.3.17. cinder consisgroup-delete
usage: cinder consisgroup-delete [--force]
<consistencygroup> [<consistencygroup> ...]
usage: cinder consisgroup-delete [--force]
<consistencygroup> [<consistencygroup> ...]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.3.18. cinder consisgroup-list
usage: cinder consisgroup-list [--all-tenants [<0|1>]]
usage: cinder consisgroup-list [--all-tenants [<0|1>]]Optional arguments
- --all-tenants [<0|1>]
Shows details for all tenants. Admin only.
4.3.19. cinder consisgroup-show
usage: cinder consisgroup-show <consistencygroup>
usage: cinder consisgroup-show <consistencygroup>Positional arguments
- <consistencygroup>
Name or ID of a consistency group.
4.3.20. cinder consisgroup-update
usage: cinder consisgroup-update [--name <name>] [--description <description>]
[--add-volumes <uuid1,uuid2,......>]
[--remove-volumes <uuid3,uuid4,......>]
<consistencygroup>
usage: cinder consisgroup-update [--name <name>] [--description <description>]
[--add-volumes <uuid1,uuid2,......>]
[--remove-volumes <uuid3,uuid4,......>]
<consistencygroup>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.3.21. cinder create
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.
- --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.3.22. cinder credentials
usage: cinder credentials
usage: cinder credentials4.3.23. cinder delete
usage: cinder delete [--cascade] <volume> [<volume> ...]
usage: cinder delete [--cascade] <volume> [<volume> ...]Positional arguments
- <volume>
Name or ID of volume or volumes to delete.
Optional arguments
- --cascade
Remove any snapshots along with volume. Default=False.
4.3.24. cinder encryption-type-create
usage: cinder encryption-type-create [--cipher <cipher>]
[--key_size <key_size>]
[--control_location <control_location>]
<volume_type> <provider>
usage: cinder encryption-type-create [--cipher <cipher>]
[--key_size <key_size>]
[--control_location <control_location>]
<volume_type> <provider>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
256. 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.3.25. cinder encryption-type-delete
usage: cinder encryption-type-delete <volume_type>
usage: cinder encryption-type-delete <volume_type>Positional arguments
- <volume_type>
Name or ID of volume type.
4.3.26. cinder encryption-type-list
usage: cinder encryption-type-list
usage: cinder encryption-type-list4.3.27. cinder encryption-type-show
usage: cinder encryption-type-show <volume_type>
usage: cinder encryption-type-show <volume_type>Positional arguments
- <volume_type>
Name or ID of volume type.
4.3.28. cinder encryption-type-update
usage: cinder encryption-type-update [--provider <provider>]
[--cipher [<cipher>]]
[--key-size [<key-size>]]
[--control-location <control-location>]
<volume-type>
usage: cinder encryption-type-update [--provider <provider>]
[--cipher [<cipher>]]
[--key-size [<key-size>]]
[--control-location <control-location>]
<volume-type>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.3.29. cinder endpoints
usage: cinder endpoints
usage: cinder endpoints4.3.30. cinder extend
usage: cinder extend <volume> <new_size>
usage: cinder extend <volume> <new_size>Positional arguments
- <volume>
Name or ID of volume to extend.
- <new_size>
New size of volume, in GiBs.
4.3.31. cinder extra-specs-list
usage: cinder extra-specs-list
usage: cinder extra-specs-list4.3.32. cinder failover-host
usage: cinder failover-host [--backend_id <backend-id>] <hostname>
usage: cinder failover-host [--backend_id <backend-id>] <hostname>Positional arguments
- <hostname>
Host name.
Optional arguments
- --backend_id <backend-id>
ID of backend to failover to (Default=None)
4.3.33. cinder force-delete
usage: cinder force-delete <volume> [<volume> ...]
usage: cinder force-delete <volume> [<volume> ...]Positional arguments
- <volume>
Name or ID of volume or volumes to delete.
4.3.34. cinder freeze-host
usage: cinder freeze-host <hostname>
usage: cinder freeze-host <hostname>Positional arguments
- <hostname>
Host name.
4.3.35. cinder get-capabilities
usage: cinder get-capabilities <host>
usage: cinder get-capabilities <host>Positional arguments
- <host>
Cinder host to show backend volume stats and properties; takes the
form: host@backend-name
4.3.36. cinder get-pools
usage: cinder get-pools [--detail]
usage: cinder get-pools [--detail]Optional arguments
- --detail
Show detailed information about pools.
4.3.37. cinder group-show
usage: cinder group-show <group>
usage: cinder group-show <group>Positional arguments
- <group>
Name or ID of a group.
4.3.38. cinder image-metadata
usage: cinder image-metadata <volume> <action> <key=value> [<key=value> ...]
usage: cinder image-metadata <volume> <action> <key=value> [<key=value> ...]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.3.39. cinder image-metadata-show
usage: cinder image-metadata-show <volume>
usage: cinder image-metadata-show <volume>Positional arguments
- <volume>
ID of volume.
4.3.40. cinder list
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.
- --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.
- --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.3.41. cinder list-extensions
usage: cinder list-extensions
usage: cinder list-extensions4.3.42. cinder manage
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.3.43. cinder manageable-list
usage: cinder manageable-list [--detailed <detailed>] [--marker <marker>]
[--limit <limit>] [--offset <offset>]
[--sort <key>[:<direction>]]
<host>
usage: cinder manageable-list [--detailed <detailed>] [--marker <marker>]
[--limit <limit>] [--offset <offset>]
[--sort <key>[:<direction>]]
<host>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: id,
status, size, availability_zone, name, bootable,
created_at, reference. Default=None.
4.3.44. cinder metadata
usage: cinder metadata <volume> <action> <key=value> [<key=value> ...]
usage: cinder metadata <volume> <action> <key=value> [<key=value> ...]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. Supported until API version 3.14)
4.3.45. cinder metadata-show
usage: cinder metadata-show <volume>
usage: cinder metadata-show <volume>Positional arguments
- <volume>
ID of volume.
4.3.46. cinder metadata-update-all
usage: cinder metadata-update-all <volume> <key=value> [<key=value> ...]
usage: cinder metadata-update-all <volume> <key=value> [<key=value> ...]Positional arguments
- <volume>
ID of volume for which to update metadata.
- <key=value>
Metadata key and value pair or pairs to update.
4.3.47. cinder migrate
usage: cinder migrate [--force-host-copy [<True|False>]]
[--lock-volume [<True|False>]]
<volume> <host>
usage: cinder migrate [--force-host-copy [<True|False>]]
[--lock-volume [<True|False>]]
<volume> <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.3.48. cinder qos-associate
usage: cinder qos-associate <qos_specs> <volume_type_id>
usage: cinder qos-associate <qos_specs> <volume_type_id>Positional arguments
- <qos_specs>
ID of QoS specifications.
- <volume_type_id>
ID of volume type with which to associate QoS
specifications.
4.3.49. cinder qos-create
usage: cinder qos-create <name> <key=value> [<key=value> ...]
usage: cinder qos-create <name> <key=value> [<key=value> ...]Positional arguments
- <name>
Name of new QoS specifications.
- <key=value>
QoS specifications.
4.3.50. cinder qos-delete
usage: cinder qos-delete [--force [<True|False>]] <qos_specs>
usage: cinder qos-delete [--force [<True|False>]] <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.3.51. cinder qos-disassociate
usage: cinder qos-disassociate <qos_specs> <volume_type_id>
usage: cinder qos-disassociate <qos_specs> <volume_type_id>Positional arguments
- <qos_specs>
ID of QoS specifications.
- <volume_type_id>
ID of volume type with which to associate QoS
specifications.
4.3.52. cinder qos-disassociate-all
usage: cinder qos-disassociate-all <qos_specs>
usage: cinder qos-disassociate-all <qos_specs>Positional arguments
- <qos_specs>
ID of QoS specifications on which to operate.
4.3.53. cinder qos-get-association
usage: cinder qos-get-association <qos_specs>
usage: cinder qos-get-association <qos_specs>Positional arguments
- <qos_specs>
ID of QoS specifications.
4.3.54. cinder qos-key
usage: cinder qos-key <qos_specs> <action> key=value [key=value ...]
usage: cinder qos-key <qos_specs> <action> key=value [key=value ...]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.3.55. cinder qos-list
usage: cinder qos-list
usage: cinder qos-list4.3.56. cinder qos-show
usage: cinder qos-show <qos_specs>
usage: cinder qos-show <qos_specs>Positional arguments
- <qos_specs>
ID of QoS specifications to show.
4.3.57. cinder quota-class-show
usage: cinder quota-class-show <class>
usage: cinder quota-class-show <class>Positional arguments
- <class>
Name of quota class for which to list quotas.
4.3.58. cinder quota-class-update
usage: cinder quota-class-update [--volumes <volumes>]
[--snapshots <snapshots>]
[--gigabytes <gigabytes>]
[--volume-type <volume_type_name>]
<class_name>
usage: cinder quota-class-update [--volumes <volumes>]
[--snapshots <snapshots>]
[--gigabytes <gigabytes>]
[--volume-type <volume_type_name>]
<class_name>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.3.59. cinder quota-defaults
usage: cinder quota-defaults <tenant_id>
usage: cinder quota-defaults <tenant_id>Positional arguments
- <tenant_id>
ID of tenant for which to list quota defaults.
4.3.60. cinder quota-delete
usage: cinder quota-delete <tenant_id>
usage: cinder quota-delete <tenant_id>Positional arguments
- <tenant_id>
UUID of tenant to delete the quotas for.
4.3.61. cinder quota-show
usage: cinder quota-show <tenant_id>
usage: cinder quota-show <tenant_id>Positional arguments
- <tenant_id>
ID of tenant for which to list quotas.
4.3.62. cinder quota-update
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.
- --volume-type <volume_type_name>
Volume type. Default=None.
- --per-volume-gigabytes <per_volume_gigabytes>
Set max volume size limit. Default=None.
4.3.63. cinder quota-usage
usage: cinder quota-usage <tenant_id>
usage: cinder quota-usage <tenant_id>Positional arguments
- <tenant_id>
ID of tenant for which to list quota usage.
4.3.64. cinder rate-limits
usage: cinder rate-limits [<tenant_id>]
usage: cinder rate-limits [<tenant_id>]Positional arguments
- <tenant_id>
Display information for a single tenant (Admin only).
4.3.65. cinder readonly-mode-update
usage: cinder readonly-mode-update <volume> <True|true|False|false>
usage: cinder readonly-mode-update <volume> <True|true|False|false>Positional arguments
- <volume>
ID of volume to update.
- <True|true|False|false>
Enables or disables update of volume to read-only
access mode.
4.3.66. cinder rename
usage: cinder rename [--description <description>] <volume> [<name>]
usage: cinder rename [--description <description>] <volume> [<name>]Positional arguments
- <volume>
Name or ID of volume to rename.
- <name>
New name for volume.
Optional arguments
- --description <description>
Volume description. Default=None.
4.3.67. cinder replication-promote
usage: cinder replication-promote <volume>
usage: cinder replication-promote <volume>Positional arguments
- <volume>
Name or ID of the volume to promote. The volume should have the
replica volume created with source-replica argument.
4.3.68. cinder replication-reenable
usage: cinder replication-reenable <volume>
usage: cinder replication-reenable <volume>Positional arguments
- <volume>
Name or ID of the volume to reenable replication. The replication-
status of the volume should be inactive.
4.3.69. cinder reset-state
usage: cinder reset-state [--state <state>] [--attach-status <attach-status>]
[--reset-migration-status]
<volume> [<volume> ...]
usage: cinder reset-state [--state <state>] [--attach-status <attach-status>]
[--reset-migration-status]
<volume> [<volume> ...]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.3.70. cinder retype
usage: cinder retype [--migration-policy <never|on-demand>]
<volume> <volume-type>
usage: cinder retype [--migration-policy <never|on-demand>]
<volume> <volume-type>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.3.71. cinder service-disable
usage: cinder service-disable [--reason <reason>] <hostname> <binary>
usage: cinder service-disable [--reason <reason>] <hostname> <binary>Positional arguments
- <hostname>
Host name.
- <binary>
Service binary.
Optional arguments
- --reason <reason>
Reason for disabling service.
4.3.72. cinder service-enable
usage: cinder service-enable <hostname> <binary>
usage: cinder service-enable <hostname> <binary>Positional arguments
- <hostname>
Host name.
- <binary>
Service binary.
4.3.73. cinder service-list
usage: cinder service-list [--host <hostname>] [--binary <binary>]
[--withreplication [<True|False>]]
usage: cinder service-list [--host <hostname>] [--binary <binary>]
[--withreplication [<True|False>]]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.
4.3.74. cinder set-bootable
usage: cinder set-bootable <volume> <True|true|False|false>
usage: cinder set-bootable <volume> <True|true|False|false>Positional arguments
- <volume>
ID of the volume to update.
- <True|true|False|false>
Flag to indicate whether volume is bootable.
4.3.75. cinder show
usage: cinder show <volume>
usage: cinder show <volume>Positional arguments
- <volume>
Name or ID of volume.
4.3.76. cinder snapshot-create
usage: cinder snapshot-create [--force [<True|False>]] [--name <name>]
[--description <description>]
[--metadata [<key=value> [<key=value> ...]]]
<volume>
usage: cinder snapshot-create [--force [<True|False>]] [--name <name>]
[--description <description>]
[--metadata [<key=value> [<key=value> ...]]]
<volume>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.3.77. cinder snapshot-delete
usage: cinder snapshot-delete [--force] <snapshot> [<snapshot> ...]
usage: cinder snapshot-delete [--force] <snapshot> [<snapshot> ...]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.3.78. 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>]]
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>]]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).
4.3.79. cinder snapshot-manage
usage: cinder snapshot-manage [--id-type <id-type>] [--name <name>]
[--description <description>]
[--metadata [<key=value> [<key=value> ...]]]
<volume> <identifier>
usage: cinder snapshot-manage [--id-type <id-type>] [--name <name>]
[--description <description>]
[--metadata [<key=value> [<key=value> ...]]]
<volume> <identifier>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.3.80. cinder snapshot-manageable-list
usage: cinder snapshot-manageable-list [--detailed <detailed>]
[--marker <marker>] [--limit <limit>]
[--offset <offset>]
[--sort <key>[:<direction>]]
<host>
usage: cinder snapshot-manageable-list [--detailed <detailed>]
[--marker <marker>] [--limit <limit>]
[--offset <offset>]
[--sort <key>[:<direction>]]
<host>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: id,
status, size, availability_zone, name, bootable,
created_at, reference. Default=None.
4.3.81. cinder snapshot-metadata
usage: cinder snapshot-metadata <snapshot> <action> <key=value>
[<key=value> ...]
usage: cinder snapshot-metadata <snapshot> <action> <key=value>
[<key=value> ...]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.3.82. cinder snapshot-metadata-show
usage: cinder snapshot-metadata-show <snapshot>
usage: cinder snapshot-metadata-show <snapshot>Positional arguments
- <snapshot>
ID of snapshot.
4.3.83. cinder snapshot-metadata-update-all
usage: cinder snapshot-metadata-update-all <snapshot> <key=value>
[<key=value> ...]
usage: cinder snapshot-metadata-update-all <snapshot> <key=value>
[<key=value> ...]Positional arguments
- <snapshot>
ID of snapshot for which to update metadata.
- <key=value>
Metadata key and value pair to update.
4.3.84. cinder snapshot-rename
usage: cinder snapshot-rename [--description <description>]
<snapshot> [<name>]
usage: cinder snapshot-rename [--description <description>]
<snapshot> [<name>]Positional arguments
- <snapshot>
Name or ID of snapshot.
- <name>
New name for snapshot.
Optional arguments
- --description <description>
Snapshot description. Default=None.
4.3.85. cinder snapshot-reset-state
usage: cinder snapshot-reset-state [--state <state>]
<snapshot> [<snapshot> ...]
usage: cinder snapshot-reset-state [--state <state>]
<snapshot> [<snapshot> ...]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.3.86. cinder snapshot-show
usage: cinder snapshot-show <snapshot>
usage: cinder snapshot-show <snapshot>Positional arguments
- <snapshot>
Name or ID of snapshot.
4.3.87. cinder snapshot-unmanage
usage: cinder snapshot-unmanage <snapshot>
usage: cinder snapshot-unmanage <snapshot>Positional arguments
- <snapshot>
Name or ID of the snapshot to unmanage.
4.3.88. cinder thaw-host
usage: cinder thaw-host <hostname>
usage: cinder thaw-host <hostname>Positional arguments
- <hostname>
Host name.
4.3.89. cinder transfer-accept
usage: cinder transfer-accept <transfer> <auth_key>
usage: cinder transfer-accept <transfer> <auth_key>Positional arguments
- <transfer>
ID of transfer to accept.
- <auth_key>
Authentication key of transfer to accept.
4.3.90. cinder transfer-create
usage: cinder transfer-create [--name <name>] <volume>
usage: cinder transfer-create [--name <name>] <volume>Positional arguments
- <volume>
Name or ID of volume to transfer.
Optional arguments
- --name <name>
Transfer name. Default=None.
4.3.91. cinder transfer-delete
usage: cinder transfer-delete <transfer>
usage: cinder transfer-delete <transfer>Positional arguments
- <transfer>
Name or ID of transfer to delete.
4.3.92. cinder transfer-list
usage: cinder transfer-list [--all-tenants [<0|1>]]
usage: cinder transfer-list [--all-tenants [<0|1>]]Optional arguments
- --all-tenants [<0|1>]
Shows details for all tenants. Admin only.
4.3.93. cinder transfer-show
usage: cinder transfer-show <transfer>
usage: cinder transfer-show <transfer>Positional arguments
- <transfer>
Name or ID of transfer to accept.
4.3.94. cinder type-access-add
usage: cinder type-access-add --volume-type <volume_type> --project-id
<project_id>
usage: cinder type-access-add --volume-type <volume_type> --project-id
<project_id>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.3.95. cinder type-access-list
usage: cinder type-access-list --volume-type <volume_type>
usage: cinder type-access-list --volume-type <volume_type>Optional arguments
- --volume-type <volume_type>
Filter results by volume type name or ID.
4.3.96. cinder type-access-remove
usage: cinder type-access-remove --volume-type <volume_type> --project-id
<project_id>
usage: cinder type-access-remove --volume-type <volume_type> --project-id
<project_id>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.3.97. cinder type-create
usage: cinder type-create [--description <description>]
[--is-public <is-public>]
<name>
usage: cinder type-create [--description <description>]
[--is-public <is-public>]
<name>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.3.98. cinder type-default
usage: cinder type-default
usage: cinder type-default4.3.99. cinder type-delete
usage: cinder type-delete <vol_type> [<vol_type> ...]
usage: cinder type-delete <vol_type> [<vol_type> ...]Positional arguments
- <vol_type>
Name or ID of volume type or types to delete.
4.3.100. cinder type-key
usage: cinder type-key <vtype> <action> <key=value> [<key=value> ...]
usage: cinder type-key <vtype> <action> <key=value> [<key=value> ...]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.3.101. cinder type-list
usage: cinder type-list
usage: cinder type-list4.3.102. cinder type-show
usage: cinder type-show <volume_type>
usage: cinder type-show <volume_type>Positional arguments
- <volume_type>
Name or ID of the volume type.
4.3.103. cinder type-update
usage: cinder type-update [--name <name>] [--description <description>]
[--is-public <is-public>]
<id>
usage: cinder type-update [--name <name>] [--description <description>]
[--is-public <is-public>]
<id>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.3.104. cinder unmanage
usage: cinder unmanage <volume>
usage: cinder unmanage <volume>Positional arguments
- <volume>
Name or ID of the volume to unmanage.
4.3.105. cinder upload-to-image
usage: cinder upload-to-image [--force [<True|False>]]
[--container-format <container-format>]
[--disk-format <disk-format>]
<volume> <image-name>
usage: cinder upload-to-image [--force [<True|False>]]
[--container-format <container-format>]
[--disk-format <disk-format>]
<volume> <image-name>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.
4.4. Block Storage API v2 Commands
--os-volume-api-version option or by setting the corresponding environment variable:
export OS_VOLUME_API_VERSION=2
$ export OS_VOLUME_API_VERSION=24.4.1. cinder absolute-limits (v2)
usage: cinder --os-volume-api-version 2 absolute-limits [<tenant_id>]
usage: cinder --os-volume-api-version 2 absolute-limits [<tenant_id>]Positional arguments
- <tenant_id>
Display information for a single tenant (Admin only).
4.4.2. cinder availability-zone-list (v2)
usage: cinder --os-volume-api-version 2 availability-zone-list
usage: cinder --os-volume-api-version 2 availability-zone-list4.4.3. cinder backup-create (v2)
usage: cinder --os-volume-api-version 2 backup-create [--container <container>] [--name <name>]
[--description <description>] [--incremental]
[--force] [--snapshot-id <snapshot-id>]
<volume>
usage: cinder --os-volume-api-version 2 backup-create [--container <container>] [--name <name>]
[--description <description>] [--incremental]
[--force] [--snapshot-id <snapshot-id>]
<volume>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.4.4. cinder backup-delete (v2)
usage: cinder --os-volume-api-version 2 backup-delete [--force] <backup> [<backup> ...]
usage: cinder --os-volume-api-version 2 backup-delete [--force] <backup> [<backup> ...]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.4.5. cinder backup-export (v2)
usage: cinder --os-volume-api-version 2 backup-export <backup>
usage: cinder --os-volume-api-version 2 backup-export <backup>Positional arguments
- <backup>
ID of the backup to export.
4.4.6. cinder backup-import (v2)
usage: cinder --os-volume-api-version 2 backup-import <backup_service> <backup_url>
usage: cinder --os-volume-api-version 2 backup-import <backup_service> <backup_url>Positional arguments
- <backup_service>
Backup service to use for importing the backup.
- <backup_url>
Backup URL for importing the backup metadata.
4.4.7. cinder backup-list (v2)
usage: cinder --os-volume-api-version 2 backup-list [--all-tenants [<all_tenants>]] [--name <name>]
[--status <status>] [--volume-id <volume-id>]
[--marker <marker>] [--limit <limit>]
[--sort <key>[:<direction>]]
usage: cinder --os-volume-api-version 2 backup-list [--all-tenants [<all_tenants>]] [--name <name>]
[--status <status>] [--volume-id <volume-id>]
[--marker <marker>] [--limit <limit>]
[--sort <key>[:<direction>]]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.4.8. cinder backup-reset-state (v2)
usage: cinder --os-volume-api-version 2 backup-reset-state [--state <state>] <backup> [<backup> ...]
usage: cinder --os-volume-api-version 2 backup-reset-state [--state <state>] <backup> [<backup> ...]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.4.9. cinder backup-restore (v2)
usage: cinder --os-volume-api-version 2 backup-restore [--volume <volume>] [--name <name>] <backup>
usage: cinder --os-volume-api-version 2 backup-restore [--volume <volume>] [--name <name>] <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.4.10. cinder backup-show (v2)
usage: cinder --os-volume-api-version 2 backup-show <backup>
usage: cinder --os-volume-api-version 2 backup-show <backup>Positional arguments
- <backup>
Name or ID of backup.
4.4.11. cinder cgsnapshot-create (v2)
usage: cinder --os-volume-api-version 2 cgsnapshot-create [--name <name>] [--description <description>]
<consistencygroup>
usage: cinder --os-volume-api-version 2 cgsnapshot-create [--name <name>] [--description <description>]
<consistencygroup>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.4.12. cinder cgsnapshot-delete (v2)
usage: cinder --os-volume-api-version 2 cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]
usage: cinder --os-volume-api-version 2 cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]Positional arguments
- <cgsnapshot>
Name or ID of one or more cgsnapshots to be deleted.
4.4.13. cinder cgsnapshot-list (v2)
usage: cinder --os-volume-api-version 2 cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>]
[--consistencygroup-id <consistencygroup_id>]
usage: cinder --os-volume-api-version 2 cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>]
[--consistencygroup-id <consistencygroup_id>]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.4.14. cinder cgsnapshot-show (v2)
usage: cinder --os-volume-api-version 2 cgsnapshot-show <cgsnapshot>
usage: cinder --os-volume-api-version 2 cgsnapshot-show <cgsnapshot>Positional arguments
- <cgsnapshot>
Name or ID of cgsnapshot.
4.4.15. cinder consisgroup-create (v2)
usage: cinder --os-volume-api-version 2 consisgroup-create [--name <name>] [--description <description>]
[--availability-zone <availability-zone>]
<volume-types>
usage: cinder --os-volume-api-version 2 consisgroup-create [--name <name>] [--description <description>]
[--availability-zone <availability-zone>]
<volume-types>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.4.16. cinder consisgroup-create-from-src (v2)
usage: cinder --os-volume-api-version 2 consisgroup-create-from-src [--cgsnapshot <cgsnapshot>]
[--source-cg <source-cg>]
[--name <name>]
[--description <description>]
usage: cinder --os-volume-api-version 2 consisgroup-create-from-src [--cgsnapshot <cgsnapshot>]
[--source-cg <source-cg>]
[--name <name>]
[--description <description>]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.4.17. cinder consisgroup-delete (v2)
usage: cinder --os-volume-api-version 2 consisgroup-delete [--force]
<consistencygroup> [<consistencygroup> ...]
usage: cinder --os-volume-api-version 2 consisgroup-delete [--force]
<consistencygroup> [<consistencygroup> ...]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.4.18. cinder consisgroup-list (v2)
usage: cinder --os-volume-api-version 2 consisgroup-list [--all-tenants [<0|1>]]
usage: cinder --os-volume-api-version 2 consisgroup-list [--all-tenants [<0|1>]]Optional arguments
- --all-tenants [<0|1>]
Shows details for all tenants. Admin only.
4.4.19. cinder consisgroup-show (v2)
usage: cinder --os-volume-api-version 2 consisgroup-show <consistencygroup>
usage: cinder --os-volume-api-version 2 consisgroup-show <consistencygroup>Positional arguments
- <consistencygroup>
Name or ID of a consistency group.
4.4.20. cinder consisgroup-update (v2)
usage: cinder --os-volume-api-version 2 consisgroup-update [--name <name>] [--description <description>]
[--add-volumes <uuid1,uuid2,......>]
[--remove-volumes <uuid3,uuid4,......>]
<consistencygroup>
usage: cinder --os-volume-api-version 2 consisgroup-update [--name <name>] [--description <description>]
[--add-volumes <uuid1,uuid2,......>]
[--remove-volumes <uuid3,uuid4,......>]
<consistencygroup>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.4.21. cinder create (v2)
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.
- --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.4.22. cinder credentials (v2)
usage: cinder --os-volume-api-version 2 credentials
usage: cinder --os-volume-api-version 2 credentials4.4.23. cinder delete (v2)
usage: cinder --os-volume-api-version 2 delete [--cascade] <volume> [<volume> ...]
usage: cinder --os-volume-api-version 2 delete [--cascade] <volume> [<volume> ...]Positional arguments
- <volume>
Name or ID of volume or volumes to delete.
Optional arguments
- --cascade
Remove any snapshots along with volume. Default=False.
4.4.24. cinder encryption-type-create (v2)
usage: cinder --os-volume-api-version 2 encryption-type-create [--cipher <cipher>]
[--key_size <key_size>]
[--control_location <control_location>]
<volume_type> <provider>
usage: cinder --os-volume-api-version 2 encryption-type-create [--cipher <cipher>]
[--key_size <key_size>]
[--control_location <control_location>]
<volume_type> <provider>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
256. 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.4.25. cinder encryption-type-delete (v2)
usage: cinder --os-volume-api-version 2 encryption-type-delete <volume_type>
usage: cinder --os-volume-api-version 2 encryption-type-delete <volume_type>Positional arguments
- <volume_type>
Name or ID of volume type.
4.4.26. cinder encryption-type-list (v2)
usage: cinder --os-volume-api-version 2 encryption-type-list
usage: cinder --os-volume-api-version 2 encryption-type-list4.4.27. cinder encryption-type-show (v2)
usage: cinder --os-volume-api-version 2 encryption-type-show <volume_type>
usage: cinder --os-volume-api-version 2 encryption-type-show <volume_type>Positional arguments
- <volume_type>
Name or ID of volume type.
4.4.28. cinder encryption-type-update (v2)
usage: cinder --os-volume-api-version 2 encryption-type-update [--provider <provider>]
[--cipher [<cipher>]]
[--key-size [<key-size>]]
[--control-location <control-location>]
<volume-type>
usage: cinder --os-volume-api-version 2 encryption-type-update [--provider <provider>]
[--cipher [<cipher>]]
[--key-size [<key-size>]]
[--control-location <control-location>]
<volume-type>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.4.29. cinder endpoints (v2)
usage: cinder --os-volume-api-version 2 endpoints
usage: cinder --os-volume-api-version 2 endpoints4.4.30. cinder extend (v2)
usage: cinder --os-volume-api-version 2 extend <volume> <new_size>
usage: cinder --os-volume-api-version 2 extend <volume> <new_size>Positional arguments
- <volume>
Name or ID of volume to extend.
- <new_size>
New size of volume, in GiBs.
4.4.31. cinder extra-specs-list (v2)
usage: cinder --os-volume-api-version 2 extra-specs-list
usage: cinder --os-volume-api-version 2 extra-specs-list4.4.32. cinder failover-host (v2)
usage: cinder --os-volume-api-version 2 failover-host [--backend_id <backend-id>] <hostname>
usage: cinder --os-volume-api-version 2 failover-host [--backend_id <backend-id>] <hostname>Positional arguments
- <hostname>
Host name.
Optional arguments
- --backend_id <backend-id>
ID of backend to failover to (Default=None)
4.4.33. cinder force-delete (v2)
usage: cinder --os-volume-api-version 2 force-delete <volume> [<volume> ...]
usage: cinder --os-volume-api-version 2 force-delete <volume> [<volume> ...]Positional arguments
- <volume>
Name or ID of volume or volumes to delete.
4.4.34. cinder freeze-host (v2)
usage: cinder --os-volume-api-version 2 freeze-host <hostname>
usage: cinder --os-volume-api-version 2 freeze-host <hostname>Positional arguments
- <hostname>
Host name.
4.4.35. cinder get-capabilities (v2)
usage: cinder --os-volume-api-version 2 get-capabilities <host>
usage: cinder --os-volume-api-version 2 get-capabilities <host>Positional arguments
- <host>
Cinder host to show backend volume stats and properties; takes the
form: host@backend-name
4.4.36. cinder get-pools (v2)
usage: cinder --os-volume-api-version 2 get-pools [--detail]
usage: cinder --os-volume-api-version 2 get-pools [--detail]Optional arguments
- --detail
Show detailed information about pools.
4.4.37. cinder group-show (v2)
usage: cinder --os-volume-api-version 2 group-show <group>
usage: cinder --os-volume-api-version 2 group-show <group>Positional arguments
- <group>
Name or ID of a group.
4.4.38. cinder image-metadata (v2)
usage: cinder --os-volume-api-version 2 image-metadata <volume> <action> <key=value> [<key=value> ...]
usage: cinder --os-volume-api-version 2 image-metadata <volume> <action> <key=value> [<key=value> ...]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.4.39. cinder image-metadata-show (v2)
usage: cinder --os-volume-api-version 2 image-metadata-show <volume>
usage: cinder --os-volume-api-version 2 image-metadata-show <volume>Positional arguments
- <volume>
ID of volume.
4.4.40. cinder list (v2)
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.
- --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.
- --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.4.41. cinder list-extensions (v2)
usage: cinder --os-volume-api-version 2 list-extensions
usage: cinder --os-volume-api-version 2 list-extensions4.4.42. cinder manage (v2)
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.4.43. cinder manageable-list (v2)
usage: cinder --os-volume-api-version 2 manageable-list [--detailed <detailed>] [--marker <marker>]
[--limit <limit>] [--offset <offset>]
[--sort <key>[:<direction>]]
<host>
usage: cinder --os-volume-api-version 2 manageable-list [--detailed <detailed>] [--marker <marker>]
[--limit <limit>] [--offset <offset>]
[--sort <key>[:<direction>]]
<host>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: id,
status, size, availability_zone, name, bootable,
created_at, reference. Default=None.
4.4.44. cinder metadata (v2)
usage: cinder --os-volume-api-version 2 metadata <volume> <action> <key=value> [<key=value> ...]
usage: cinder --os-volume-api-version 2 metadata <volume> <action> <key=value> [<key=value> ...]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. Supported until API version 3.14)
4.4.45. cinder metadata-show (v2)
usage: cinder --os-volume-api-version 2 metadata-show <volume>
usage: cinder --os-volume-api-version 2 metadata-show <volume>Positional arguments
- <volume>
ID of volume.
4.4.46. cinder metadata-update-all (v2)
usage: cinder --os-volume-api-version 2 metadata-update-all <volume> <key=value> [<key=value> ...]
usage: cinder --os-volume-api-version 2 metadata-update-all <volume> <key=value> [<key=value> ...]Positional arguments
- <volume>
ID of volume for which to update metadata.
- <key=value>
Metadata key and value pair or pairs to update.
4.4.47. cinder migrate (v2)
usage: cinder --os-volume-api-version 2 migrate [--force-host-copy [<True|False>]]
[--lock-volume [<True|False>]]
<volume> <host>
usage: cinder --os-volume-api-version 2 migrate [--force-host-copy [<True|False>]]
[--lock-volume [<True|False>]]
<volume> <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.4.48. cinder qos-associate (v2)
usage: cinder --os-volume-api-version 2 qos-associate <qos_specs> <volume_type_id>
usage: cinder --os-volume-api-version 2 qos-associate <qos_specs> <volume_type_id>Positional arguments
- <qos_specs>
ID of QoS specifications.
- <volume_type_id>
ID of volume type with which to associate QoS
specifications.
4.4.49. cinder qos-create (v2)
usage: cinder --os-volume-api-version 2 qos-create <name> <key=value> [<key=value> ...]
usage: cinder --os-volume-api-version 2 qos-create <name> <key=value> [<key=value> ...]Positional arguments
- <name>
Name of new QoS specifications.
- <key=value>
QoS specifications.
4.4.50. cinder qos-delete (v2)
usage: cinder --os-volume-api-version 2 qos-delete [--force [<True|False>]] <qos_specs>
usage: cinder --os-volume-api-version 2 qos-delete [--force [<True|False>]] <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.4.51. cinder qos-disassociate (v2)
usage: cinder --os-volume-api-version 2 qos-disassociate <qos_specs> <volume_type_id>
usage: cinder --os-volume-api-version 2 qos-disassociate <qos_specs> <volume_type_id>Positional arguments
- <qos_specs>
ID of QoS specifications.
- <volume_type_id>
ID of volume type with which to associate QoS
specifications.
4.4.52. cinder qos-disassociate-all (v2)
usage: cinder --os-volume-api-version 2 qos-disassociate-all <qos_specs>
usage: cinder --os-volume-api-version 2 qos-disassociate-all <qos_specs>Positional arguments
- <qos_specs>
ID of QoS specifications on which to operate.
4.4.53. cinder qos-get-association (v2)
usage: cinder --os-volume-api-version 2 qos-get-association <qos_specs>
usage: cinder --os-volume-api-version 2 qos-get-association <qos_specs>Positional arguments
- <qos_specs>
ID of QoS specifications.
4.4.54. cinder qos-key (v2)
usage: cinder --os-volume-api-version 2 qos-key <qos_specs> <action> key=value [key=value ...]
usage: cinder --os-volume-api-version 2 qos-key <qos_specs> <action> key=value [key=value ...]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.4.55. cinder qos-list (v2)
usage: cinder --os-volume-api-version 2 qos-list
usage: cinder --os-volume-api-version 2 qos-list4.4.56. cinder qos-show (v2)
usage: cinder --os-volume-api-version 2 qos-show <qos_specs>
usage: cinder --os-volume-api-version 2 qos-show <qos_specs>Positional arguments
- <qos_specs>
ID of QoS specifications to show.
4.4.57. cinder quota-class-show (v2)
usage: cinder --os-volume-api-version 2 quota-class-show <class>
usage: cinder --os-volume-api-version 2 quota-class-show <class>Positional arguments
- <class>
Name of quota class for which to list quotas.
4.4.58. cinder quota-class-update (v2)
usage: cinder --os-volume-api-version 2 quota-class-update [--volumes <volumes>]
[--snapshots <snapshots>]
[--gigabytes <gigabytes>]
[--volume-type <volume_type_name>]
<class_name>
usage: cinder --os-volume-api-version 2 quota-class-update [--volumes <volumes>]
[--snapshots <snapshots>]
[--gigabytes <gigabytes>]
[--volume-type <volume_type_name>]
<class_name>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.4.59. cinder quota-defaults (v2)
usage: cinder --os-volume-api-version 2 quota-defaults <tenant_id>
usage: cinder --os-volume-api-version 2 quota-defaults <tenant_id>Positional arguments
- <tenant_id>
ID of tenant for which to list quota defaults.
4.4.60. cinder quota-delete (v2)
usage: cinder --os-volume-api-version 2 quota-delete <tenant_id>
usage: cinder --os-volume-api-version 2 quota-delete <tenant_id>Positional arguments
- <tenant_id>
UUID of tenant to delete the quotas for.
4.4.61. cinder quota-show (v2)
usage: cinder --os-volume-api-version 2 quota-show <tenant_id>
usage: cinder --os-volume-api-version 2 quota-show <tenant_id>Positional arguments
- <tenant_id>
ID of tenant for which to list quotas.
4.4.62. cinder quota-update (v2)
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.
- --volume-type <volume_type_name>
Volume type. Default=None.
- --per-volume-gigabytes <per_volume_gigabytes>
Set max volume size limit. Default=None.
4.4.63. cinder quota-usage (v2)
usage: cinder --os-volume-api-version 2 quota-usage <tenant_id>
usage: cinder --os-volume-api-version 2 quota-usage <tenant_id>Positional arguments
- <tenant_id>
ID of tenant for which to list quota usage.
4.4.64. cinder rate-limits (v2)
usage: cinder --os-volume-api-version 2 rate-limits [<tenant_id>]
usage: cinder --os-volume-api-version 2 rate-limits [<tenant_id>]Positional arguments
- <tenant_id>
Display information for a single tenant (Admin only).
4.4.65. cinder readonly-mode-update (v2)
usage: cinder --os-volume-api-version 2 readonly-mode-update <volume> <True|true|False|false>
usage: cinder --os-volume-api-version 2 readonly-mode-update <volume> <True|true|False|false>Positional arguments
- <volume>
ID of volume to update.
- <True|true|False|false>
Enables or disables update of volume to read-only
access mode.
4.4.66. cinder rename (v2)
usage: cinder --os-volume-api-version 2 rename [--description <description>] <volume> [<name>]
usage: cinder --os-volume-api-version 2 rename [--description <description>] <volume> [<name>]Positional arguments
- <volume>
Name or ID of volume to rename.
- <name>
New name for volume.
Optional arguments
- --description <description>
Volume description. Default=None.
4.4.67. cinder replication-promote (v2)
usage: cinder --os-volume-api-version 2 replication-promote <volume>
usage: cinder --os-volume-api-version 2 replication-promote <volume>Positional arguments
- <volume>
Name or ID of the volume to promote. The volume should have the
replica volume created with source-replica argument.
4.4.68. cinder replication-reenable (v2)
usage: cinder --os-volume-api-version 2 replication-reenable <volume>
usage: cinder --os-volume-api-version 2 replication-reenable <volume>Positional arguments
- <volume>
Name or ID of the volume to reenable replication. The replication-
status of the volume should be inactive.
4.4.69. cinder reset-state (v2)
usage: cinder --os-volume-api-version 2 reset-state [--state <state>] [--attach-status <attach-status>]
[--reset-migration-status]
<volume> [<volume> ...]
usage: cinder --os-volume-api-version 2 reset-state [--state <state>] [--attach-status <attach-status>]
[--reset-migration-status]
<volume> [<volume> ...]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.4.70. cinder retype (v2)
usage: cinder --os-volume-api-version 2 retype [--migration-policy <never|on-demand>]
<volume> <volume-type>
usage: cinder --os-volume-api-version 2 retype [--migration-policy <never|on-demand>]
<volume> <volume-type>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.4.71. cinder service-disable (v2)
usage: cinder --os-volume-api-version 2 service-disable [--reason <reason>] <hostname> <binary>
usage: cinder --os-volume-api-version 2 service-disable [--reason <reason>] <hostname> <binary>Positional arguments
- <hostname>
Host name.
- <binary>
Service binary.
Optional arguments
- --reason <reason>
Reason for disabling service.
4.4.72. cinder service-enable (v2)
usage: cinder --os-volume-api-version 2 service-enable <hostname> <binary>
usage: cinder --os-volume-api-version 2 service-enable <hostname> <binary>Positional arguments
- <hostname>
Host name.
- <binary>
Service binary.
4.4.73. cinder service-list (v2)
usage: cinder --os-volume-api-version 2 service-list [--host <hostname>] [--binary <binary>]
[--withreplication [<True|False>]]
usage: cinder --os-volume-api-version 2 service-list [--host <hostname>] [--binary <binary>]
[--withreplication [<True|False>]]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.
4.4.74. cinder set-bootable (v2)
usage: cinder --os-volume-api-version 2 set-bootable <volume> <True|true|False|false>
usage: cinder --os-volume-api-version 2 set-bootable <volume> <True|true|False|false>Positional arguments
- <volume>
ID of the volume to update.
- <True|true|False|false>
Flag to indicate whether volume is bootable.
4.4.75. cinder show (v2)
usage: cinder --os-volume-api-version 2 show <volume>
usage: cinder --os-volume-api-version 2 show <volume>Positional arguments
- <volume>
Name or ID of volume.
4.4.76. cinder snapshot-create (v2)
usage: cinder --os-volume-api-version 2 snapshot-create [--force [<True|False>]] [--name <name>]
[--description <description>]
[--metadata [<key=value> [<key=value> ...]]]
<volume>
usage: cinder --os-volume-api-version 2 snapshot-create [--force [<True|False>]] [--name <name>]
[--description <description>]
[--metadata [<key=value> [<key=value> ...]]]
<volume>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.4.77. cinder snapshot-delete (v2)
usage: cinder --os-volume-api-version 2 snapshot-delete [--force] <snapshot> [<snapshot> ...]
usage: cinder --os-volume-api-version 2 snapshot-delete [--force] <snapshot> [<snapshot> ...]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.4.78. cinder snapshot-list (v2)
usage: cinder --os-volume-api-version 2 snapshot-list [--all-tenants [<0|1>]] [--name <name>]
[--status <status>] [--volume-id <volume-id>]
[--marker <marker>] [--limit <limit>]
[--sort <key>[:<direction>]] [--tenant [<tenant>]]
usage: cinder --os-volume-api-version 2 snapshot-list [--all-tenants [<0|1>]] [--name <name>]
[--status <status>] [--volume-id <volume-id>]
[--marker <marker>] [--limit <limit>]
[--sort <key>[:<direction>]] [--tenant [<tenant>]]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).
4.4.79. cinder snapshot-manage (v2)
usage: cinder --os-volume-api-version 2 snapshot-manage [--id-type <id-type>] [--name <name>]
[--description <description>]
[--metadata [<key=value> [<key=value> ...]]]
<volume> <identifier>
usage: cinder --os-volume-api-version 2 snapshot-manage [--id-type <id-type>] [--name <name>]
[--description <description>]
[--metadata [<key=value> [<key=value> ...]]]
<volume> <identifier>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.4.80. cinder snapshot-manageable-list (v2)
usage: cinder --os-volume-api-version 2 snapshot-manageable-list [--detailed <detailed>]
[--marker <marker>] [--limit <limit>]
[--offset <offset>]
[--sort <key>[:<direction>]]
<host>
usage: cinder --os-volume-api-version 2 snapshot-manageable-list [--detailed <detailed>]
[--marker <marker>] [--limit <limit>]
[--offset <offset>]
[--sort <key>[:<direction>]]
<host>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: id,
status, size, availability_zone, name, bootable,
created_at, reference. Default=None.
4.4.81. cinder snapshot-metadata (v2)
usage: cinder --os-volume-api-version 2 snapshot-metadata <snapshot> <action> <key=value>
[<key=value> ...]
usage: cinder --os-volume-api-version 2 snapshot-metadata <snapshot> <action> <key=value>
[<key=value> ...]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.4.82. cinder snapshot-metadata-show (v2)
usage: cinder --os-volume-api-version 2 snapshot-metadata-show <snapshot>
usage: cinder --os-volume-api-version 2 snapshot-metadata-show <snapshot>Positional arguments
- <snapshot>
ID of snapshot.
4.4.83. cinder snapshot-metadata-update-all (v2)
usage: cinder --os-volume-api-version 2 snapshot-metadata-update-all <snapshot> <key=value>
[<key=value> ...]
usage: cinder --os-volume-api-version 2 snapshot-metadata-update-all <snapshot> <key=value>
[<key=value> ...]Positional arguments
- <snapshot>
ID of snapshot for which to update metadata.
- <key=value>
Metadata key and value pair to update.
4.4.84. cinder snapshot-rename (v2)
usage: cinder --os-volume-api-version 2 snapshot-rename [--description <description>]
<snapshot> [<name>]
usage: cinder --os-volume-api-version 2 snapshot-rename [--description <description>]
<snapshot> [<name>]Positional arguments
- <snapshot>
Name or ID of snapshot.
- <name>
New name for snapshot.
Optional arguments
- --description <description>
Snapshot description. Default=None.
4.4.85. cinder snapshot-reset-state (v2)
usage: cinder --os-volume-api-version 2 snapshot-reset-state [--state <state>]
<snapshot> [<snapshot> ...]
usage: cinder --os-volume-api-version 2 snapshot-reset-state [--state <state>]
<snapshot> [<snapshot> ...]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.4.86. cinder snapshot-show (v2)
usage: cinder --os-volume-api-version 2 snapshot-show <snapshot>
usage: cinder --os-volume-api-version 2 snapshot-show <snapshot>Positional arguments
- <snapshot>
Name or ID of snapshot.
4.4.87. cinder snapshot-unmanage (v2)
usage: cinder --os-volume-api-version 2 snapshot-unmanage <snapshot>
usage: cinder --os-volume-api-version 2 snapshot-unmanage <snapshot>Positional arguments
- <snapshot>
Name or ID of the snapshot to unmanage.
4.4.88. cinder thaw-host (v2)
usage: cinder --os-volume-api-version 2 thaw-host <hostname>
usage: cinder --os-volume-api-version 2 thaw-host <hostname>Positional arguments
- <hostname>
Host name.
4.4.89. cinder transfer-accept (v2)
usage: cinder --os-volume-api-version 2 transfer-accept <transfer> <auth_key>
usage: cinder --os-volume-api-version 2 transfer-accept <transfer> <auth_key>Positional arguments
- <transfer>
ID of transfer to accept.
- <auth_key>
Authentication key of transfer to accept.
4.4.90. cinder transfer-create (v2)
usage: cinder --os-volume-api-version 2 transfer-create [--name <name>] <volume>
usage: cinder --os-volume-api-version 2 transfer-create [--name <name>] <volume>Positional arguments
- <volume>
Name or ID of volume to transfer.
Optional arguments
- --name <name>
Transfer name. Default=None.
4.4.91. cinder transfer-delete (v2)
usage: cinder --os-volume-api-version 2 transfer-delete <transfer>
usage: cinder --os-volume-api-version 2 transfer-delete <transfer>Positional arguments
- <transfer>
Name or ID of transfer to delete.
4.4.92. cinder transfer-list (v2)
usage: cinder --os-volume-api-version 2 transfer-list [--all-tenants [<0|1>]]
usage: cinder --os-volume-api-version 2 transfer-list [--all-tenants [<0|1>]]Optional arguments
- --all-tenants [<0|1>]
Shows details for all tenants. Admin only.
4.4.93. cinder transfer-show (v2)
usage: cinder --os-volume-api-version 2 transfer-show <transfer>
usage: cinder --os-volume-api-version 2 transfer-show <transfer>Positional arguments
- <transfer>
Name or ID of transfer to accept.
4.4.94. cinder type-access-add (v2)
usage: cinder --os-volume-api-version 2 type-access-add --volume-type <volume_type> --project-id
<project_id>
usage: cinder --os-volume-api-version 2 type-access-add --volume-type <volume_type> --project-id
<project_id>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.4.95. cinder type-access-list (v2)
usage: cinder --os-volume-api-version 2 type-access-list --volume-type <volume_type>
usage: cinder --os-volume-api-version 2 type-access-list --volume-type <volume_type>Optional arguments
- --volume-type <volume_type>
Filter results by volume type name or ID.
4.4.96. cinder type-access-remove (v2)
usage: cinder --os-volume-api-version 2 type-access-remove --volume-type <volume_type> --project-id
<project_id>
usage: cinder --os-volume-api-version 2 type-access-remove --volume-type <volume_type> --project-id
<project_id>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.4.97. cinder type-create (v2)
usage: cinder --os-volume-api-version 2 type-create [--description <description>]
[--is-public <is-public>]
<name>
usage: cinder --os-volume-api-version 2 type-create [--description <description>]
[--is-public <is-public>]
<name>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.4.98. cinder type-default (v2)
usage: cinder --os-volume-api-version 2 type-default
usage: cinder --os-volume-api-version 2 type-default4.4.99. cinder type-delete (v2)
usage: cinder --os-volume-api-version 2 type-delete <vol_type> [<vol_type> ...]
usage: cinder --os-volume-api-version 2 type-delete <vol_type> [<vol_type> ...]Positional arguments
- <vol_type>
Name or ID of volume type or types to delete.
4.4.100. cinder type-key (v2)
usage: cinder --os-volume-api-version 2 type-key <vtype> <action> <key=value> [<key=value> ...]
usage: cinder --os-volume-api-version 2 type-key <vtype> <action> <key=value> [<key=value> ...]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.4.101. cinder type-list (v2)
usage: cinder --os-volume-api-version 2 type-list
usage: cinder --os-volume-api-version 2 type-list4.4.102. cinder type-show (v2)
usage: cinder --os-volume-api-version 2 type-show <volume_type>
usage: cinder --os-volume-api-version 2 type-show <volume_type>Positional arguments
- <volume_type>
Name or ID of the volume type.
4.4.103. cinder type-update (v2)
usage: cinder --os-volume-api-version 2 type-update [--name <name>] [--description <description>]
[--is-public <is-public>]
<id>
usage: cinder --os-volume-api-version 2 type-update [--name <name>] [--description <description>]
[--is-public <is-public>]
<id>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.4.104. cinder unmanage (v2)
usage: cinder --os-volume-api-version 2 unmanage <volume>
usage: cinder --os-volume-api-version 2 unmanage <volume>Positional arguments
- <volume>
Name or ID of the volume to unmanage.
4.4.105. cinder upload-to-image (v2)
usage: cinder --os-volume-api-version 2 upload-to-image [--force [<True|False>]]
[--container-format <container-format>]
[--disk-format <disk-format>]
<volume> <image-name>
usage: cinder --os-volume-api-version 2 upload-to-image [--force [<True|False>]]
[--container-format <container-format>]
[--disk-format <disk-format>]
<volume> <image-name>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.
Chapter 5. Compute Service Command-line Client
6.0.0.
nova help COMMAND
$ nova help COMMAND5.1. nova Usage
Subcommands
- absolute-limits
DEPRECATED, use limits instead.
- add-fixed-ip
Add new IP address on a network to server.
- add-floating-ip
DEPRECATED, use floating-ip-associate instead.
- add-secgroup
Add a Security Group to a server.
- agent-create
Create new agent build.
- agent-delete
Delete existing agent build.
- agent-list
List all builds.
- agent-modify
Modify existing agent build.
- aggregate-add-host
Add the host to the specified aggregate.
- aggregate-create
Create a new aggregate with the specified
details.
- aggregate-delete
Delete the aggregate.
- aggregate-details
DEPRECATED, use aggregate-show instead.
- aggregate-list
Print a list of all aggregates.
- aggregate-remove-host
Remove the specified host from the specified
aggregate.
- aggregate-set-metadata
Update the metadata associated with the
aggregate.
- aggregate-show
Show details of the specified aggregate.
- aggregate-update
Update the aggregate's name and optionally
availability zone.
- availability-zone-list
List all the availability zones.
- backup
Backup a server by creating a 'backup' type
snapshot.
- boot
Boot a new server.
- clear-password
Clear the admin password for a server from the
metadata server. This action does not actually
change the instance server password.
- cloudpipe-configure
Update the VPN IP/port of a cloudpipe
instance.
- cloudpipe-create
Create a cloudpipe instance for the given
project.
- cloudpipe-list
Print a list of all cloudpipe instances.
- console-log
Get console log output of a server.
- credentials
Show user credentials returned from auth.
- delete
Immediately shut down and delete specified
server(s).
- diagnostics
Retrieve server diagnostics.
- dns-create
DEPRECATED: Create a DNS entry for domain,
name, and IP.
- dns-create-private-domain
DEPRECATED: Create the specified DNS domain.
- dns-create-public-domain
DEPRECATED: Create the specified DNS domain.
- dns-delete
DEPRECATED: Delete the specified DNS entry.
- dns-delete-domain
DEPRECATED: Delete the specified DNS domain.
- dns-domains
DEPRECATED: Print a list of available dns
domains.
- dns-list
DEPRECATED: List current DNS entries for
domain and IP or domain and name.
- endpoints
Discover endpoints that get returned from the
authenticate services.
- evacuate
Evacuate server from failed host.
- fixed-ip-get
DEPRECATED: Retrieve info on a fixed IP.
- fixed-ip-reserve
DEPRECATED: Reserve a fixed IP.
- fixed-ip-unreserve
DEPRECATED: Unreserve a fixed IP.
- flavor-access-add
Add flavor access for the given tenant.
- flavor-access-list
Print access information about the given
flavor.
- flavor-access-remove
Remove flavor access for the given tenant.
- flavor-create
Create a new flavor.
- flavor-delete
Delete a specific flavor
- flavor-key
Set or unset extra_spec for a flavor.
- flavor-list
Print a list of available 'flavors' (sizes of
servers).
- flavor-show
Show details about the given flavor.
- floating-ip-associate
Associate a floating IP address to a server.
- floating-ip-bulk-create
DEPRECATED: Bulk create floating IPs by range
(nova-network only).
- floating-ip-bulk-delete
DEPRECATED: Bulk delete floating IPs by range
(nova-network only).
- floating-ip-bulk-list
DEPRECATED: List all floating IPs (nova-
network only).
- floating-ip-create
DEPRECATED: Allocate a floating IP for the
current tenant.
- floating-ip-delete
DEPRECATED: De-allocate a floating IP.
- floating-ip-disassociate
Disassociate a floating IP address from a
server.
- floating-ip-list
DEPRECATED: List floating IPs.
- floating-ip-pool-list
DEPRECATED: List all floating IP pools.
- get-mks-console
Get an MKS console to a server. (Supported by
API versions '2.8' - '2.latest') [hint: use
'--os-compute-api-version' flag to show help
message for proper version]
- get-password
Get the admin password for a server. This
operation calls the metadata service to query
metadata information and does not read
password information from the server itself.
- get-rdp-console
Get a rdp console to a server.
- get-serial-console
Get a serial console to a server.
- get-spice-console
Get a spice console to a server.
- get-vnc-console
Get a vnc console to a server.
- host-action
Perform a power action on a host.
- host-describe
Describe a specific host.
- host-list
List all hosts by service.
- host-update
Update host settings.
- hypervisor-list
List hypervisors. (Supported by API versions
'2.0' - '2.latest') [hint: use '--os-compute-
api-version' flag to show help message for
proper version]
- hypervisor-servers
List servers belonging to specific
hypervisors.
- hypervisor-show
Display the details of the specified
hypervisor.
- hypervisor-stats
Get hypervisor statistics over all compute
nodes.
- hypervisor-uptime
Display the uptime of the specified
hypervisor.
- image-create
Create a new image by taking a snapshot of a
running server.
- image-delete
DEPRECATED: Delete specified image(s).
- image-list
DEPRECATED: Print a list of available images
to boot from.
- image-meta
DEPRECATED: Set or delete metadata on an
image.
- image-show
DEPRECATED: Show details about the given
image.
- interface-attach
Attach a network interface to a server.
- interface-detach
Detach a network interface from a server.
- interface-list
List interfaces attached to a server.
- keypair-add
Create a new key pair for use with servers.
- keypair-delete
Delete keypair given by its name. (Supported
by API versions '2.0' - '2.latest') [hint: use
'--os-compute-api-version' flag to show help
message for proper version]
- keypair-list
Print a list of keypairs for a user (Supported
by API versions '2.0' - '2.latest') [hint: use
'--os-compute-api-version' flag to show help
message for proper version]
- keypair-show
Show details about the given keypair.
(Supported by API versions '2.0' - '2.latest')
[hint: use '--os-compute-api-version' flag to
show help message for proper version]
- limits
Print rate and absolute limits.
- list
List active servers.
- list-secgroup
List Security Group(s) of a server.
- live-migration
Migrate running server to a new machine.
- live-migration-abort
Abort an on-going live migration. (Supported
by API versions '2.24' - '2.latest') [hint:
use '--os-compute-api-version' flag to show
help message for proper version]
- live-migration-force-complete
Force on-going live migration to complete.
(Supported by API versions '2.22' -
'2.latest') [hint: use '--os-compute-api-
version' flag to show help message for proper
version]
- lock
Lock a server. A normal (non-admin) user will
not be able to execute actions on a locked
server.
- meta
Set or delete metadata on a server.
- migrate
Migrate a server. The new host will be
selected by the scheduler.
- network-associate-host
DEPRECATED: Associate host with network.
- network-associate-project
DEPRECATED: Associate project with network.
- network-create
DEPRECATED: Create a network.
- network-delete
DEPRECATED: Delete network by label or id.
- network-disassociate
DEPRECATED: Disassociate host and/or project
from the given network.
- network-list
DEPRECATED: Print a list of available
networks.
- network-show
DEPRECATED: Show details about the given
network.
- pause
Pause a server.
- quota-class-show
List the quotas for a quota class.
- quota-class-update
Update the quotas for a quota class.
(Supported by API versions '2.0' - '2.latest')
[hint: use '--os-compute-api-version' flag to
show help message for proper version]
- quota-defaults
List the default quotas for a tenant.
- quota-delete
Delete quota for a tenant/user so their quota
will Revert back to default.
- quota-show
List the quotas for a tenant/user.
- quota-update
Update the quotas for a tenant/user.
(Supported by API versions '2.0' - '2.latest')
[hint: use '--os-compute-api-version' flag to
show help message for proper version]
- rate-limits
DEPRECATED, use limits instead.
- reboot
Reboot a server.
- rebuild
Shutdown, re-image, and re-boot a server.
- refresh-network
Refresh server network information.
- remove-fixed-ip
Remove an IP address from a server.
- remove-floating-ip
DEPRECATED, use floating-ip-disassociate
instead.
- remove-secgroup
Remove a Security Group from a server.
- rename
DEPRECATED, use update instead.
- rescue
Reboots a server into rescue mode, which
starts the machine from either the initial
image or a specified image, attaching the
current boot disk as secondary.
- reset-network
Reset network of a server.
- reset-state
Reset the state of a server.
- resize
Resize a server.
- resize-confirm
Confirm a previous resize.
- resize-revert
Revert a previous resize (and return to the
previous VM).
- resume
Resume a server.
- root-password
DEPRECATED, use set-password instead.
- scrub
DEPRECATED: Delete networks and security
groups associated with a project.
- secgroup-add-default-rule
DEPRECATED: Add a rule to the set of rules
that will be added to the 'default' security
group for new tenants (nova-network only).
- secgroup-add-group-rule
DEPRECATED: Add a source group rule to a
security group.
- secgroup-add-rule
DEPRECATED: Add a rule to a security group.
- secgroup-create
DEPRECATED: Create a security group.
- secgroup-delete
DEPRECATED: Delete a security group.
- secgroup-delete-default-rule
DEPRECATED: Delete a rule from the set of
rules that will be added to the 'default'
security group for new tenants (nova-network
only).
- secgroup-delete-group-rule
DEPRECATED: Delete a source group rule from a
security group.
- secgroup-delete-rule
DEPRECATED: Delete a rule from a security
group.
- secgroup-list
DEPRECATED: List security groups for the
current tenant.
- secgroup-list-default-rules
DEPRECATED: List rules that will be added to
the 'default' security group for new tenants.
- secgroup-list-rules
DEPRECATED: List rules for a security group.
- secgroup-update
DEPRECATED: Update a security group.
- server-group-create
Create a new server group with the specified
details.
- server-group-delete
Delete specific server group(s).
- server-group-get
Get a specific server group.
- server-group-list
Print a list of all server groups.
- server-migration-list
Get the migrations list of specified server.
(Supported by API versions '2.23' -
'2.latest') [hint: use '--os-compute-api-
version' flag to show help message for proper
version]
- server-migration-show
Get the migration of specified server.
(Supported by API versions '2.23' -
'2.latest') [hint: use '--os-compute-api-
version' flag to show help message for proper
version]
- server-tag-add
Add single tag to a server. (Supported by API
versions '2.26' - '2.latest') [hint: use
'--os-compute-api-version' flag to show help
message for proper version]
- server-tag-delete
Delete single tag from a server. (Supported by
API versions '2.26' - '2.latest') [hint: use
'--os-compute-api-version' flag to show help
message for proper version]
- server-tag-delete-all
Delete all tags from a server. (Supported by
API versions '2.26' - '2.latest') [hint: use
'--os-compute-api-version' flag to show help
message for proper version]
- server-tag-list
Get list of tags from a server. (Supported by
API versions '2.26' - '2.latest') [hint: use
'--os-compute-api-version' flag to show help
message for proper version]
- server-tag-set
Set list of tags to a server. (Supported by
API versions '2.26' - '2.latest') [hint: use
'--os-compute-api-version' flag to show help
message for proper version]
- service-delete
Delete the service.
- service-disable
Disable the service.
- service-enable
Enable the service.
- service-force-down
Force service to down. (Supported by API
versions '2.11' - '2.latest') [hint: use
'--os-compute-api-version' flag to show help
message for proper version]
- service-list
Show a list of all running services. Filter by
host & binary.
- set-password
Change the admin password for a server.
- shelve
Shelve a server.
- shelve-offload
Remove a shelved server from the compute node.
- show
Show details about the given server.
- ssh
SSH into a server.
- start
Start the server(s).
- stop
Stop the server(s).
- suspend
Suspend a server.
- trigger-crash-dump
Trigger crash dump in an instance. (Supported
by API versions '2.17' - '2.latest') [hint:
use '--os-compute-api-version' flag to show
help message for proper version]
- unlock
Unlock a server.
- unpause
Unpause a server.
- unrescue
Restart the server from normal boot disk
again.
- unshelve
Unshelve a server.
- update
Update the name or the description for a
server.
- usage
Show usage data for a single tenant.
- usage-list
List usage data for all tenants.
- version-list
List all API versions.
- virtual-interface-list
Show virtual interface info about the given
server.
- volume-attach
Attach a volume to a server.
- volume-attachments
List all the volumes attached to a server.
- volume-detach
Detach a volume from a server.
- volume-update
Update volume attachment.
- x509-create-cert
Create x509 cert for a user in tenant.
- x509-get-root-cert
Fetch the x509 root cert.
- bash-completion
Prints all of the commands and options to
stdout so that the nova.bash_completion script
doesn't have to hard code them.
- help
Display help about this program or one of its
subcommands.
- baremetal-interface-list
DEPRECATED: List network interfaces associated
with a baremetal node.
- baremetal-node-list
DEPRECATED: Print list of available baremetal
nodes.
- baremetal-node-show
DEPRECATED: Show information about a baremetal
node.
- cell-capacities
Get cell capacities for all cells or a given
cell.
- cell-show
Show details of a given cell.
- force-delete
Force delete a server.
- restore
Restore a soft-deleted server.
- host-evacuate
Evacuate all instances from failed host.
- host-evacuate-live
Live migrate all instances of the specified
host to other available hosts.
- host-servers-migrate
Cold migrate all instances off the specified
host to other available hosts.
- instance-action
Show an action.
- instance-action-list
List actions on a server.
- list-extensions
List all the os-api extensions that are
available.
- host-meta
Set or Delete metadata on all instances of a
host.
- migration-list
Print a list of migrations.
- net
DEPRECATED, use tenant-network-show instead.
- net-create
DEPRECATED, use tenant-network-create instead.
- net-delete
DEPRECATED, use tenant-network-delete instead.
- net-list
DEPRECATED, use tenant-network-list instead.
- tenant-network-create
DEPRECATED: Create a tenant network.
- tenant-network-delete
DEPRECATED: Delete a tenant network.
- tenant-network-list
DEPRECATED: List tenant networks.
- tenant-network-show
DEPRECATED: Show a tenant network.
5.2. nova Optional Arguments
- --version
show program's version number and exit
- --debug
Print debugging output.
- --os-cache
Use the auth token cache. Defaults to False if
env[OS_CACHE]is not set.
- --timings
Print call timing info.
- --os-region-name <region-name>
Defaults toenv[OS_REGION_NAME].
- --service-type <service-type>
Defaults to compute for most actions.
- --service-name <service-name>
Defaults toenv[NOVA_SERVICE_NAME].
- --os-endpoint-type <endpoint-type>
Defaults toenv[NOVA_ENDPOINT_TYPE],
env[OS_ENDPOINT_TYPE]or publicURL.
- --os-compute-api-version <compute-api-ver>
Accepts X, X.Y (where X is major and Y is
minor part) or "X.latest", defaults to
env[OS_COMPUTE_API_VERSION].
- --bypass-url <bypass-url>
Use this API endpoint instead of the Service
Catalog. Defaults to
env[NOVACLIENT_BYPASS_URL].
- --os-auth-type <name>, --os-auth-plugin <name>
Authentication type to use
5.3. nova absolute-limits
usage: nova absolute-limits [--tenant [<tenant>]] [--reserved]
usage: nova absolute-limits [--tenant [<tenant>]] [--reserved]Optional arguments
- --tenant [<tenant>]
Display information from single tenant (Admin only).
- --reserved
Include reservations count.
5.4. nova add-fixed-ip
usage: nova add-fixed-ip <server> <network-id>
usage: nova add-fixed-ip <server> <network-id>Positional arguments
- <server>
Name or ID of server.
- <network-id>
Network ID.
5.5. nova add-secgroup
usage: nova add-secgroup <server> <secgroup>
usage: nova add-secgroup <server> <secgroup>Positional arguments
- <server>
Name or ID of server.
- <secgroup>
Name or ID of Security Group.
5.6. nova agent-create
usage: nova agent-create <os> <architecture> <version> <url> <md5hash>
<hypervisor>
usage: nova agent-create <os> <architecture> <version> <url> <md5hash>
<hypervisor>Positional arguments
- <os>
Type of OS.
- <architecture>
Type of architecture.
- <version>
Version.
- <url>
URL.
- <md5hash>
MD5 hash.
- <hypervisor>
Type of hypervisor.
5.7. nova agent-delete
usage: nova agent-delete <id>
usage: nova agent-delete <id>Positional arguments
- <id>
ID of the agent-build.
5.8. nova agent-list
usage: nova agent-list [--hypervisor <hypervisor>]
usage: nova agent-list [--hypervisor <hypervisor>]Optional arguments
- --hypervisor <hypervisor>
Type of hypervisor.
5.9. nova agent-modify
usage: nova agent-modify <id> <version> <url> <md5hash>
usage: nova agent-modify <id> <version> <url> <md5hash>Positional arguments
- <id>
ID of the agent-build.
- <version>
Version.
- <url>
URL
- <md5hash>
MD5 hash.
5.10. nova aggregate-add-host
usage: nova aggregate-add-host <aggregate> <host>
usage: nova aggregate-add-host <aggregate> <host>Positional arguments
- <aggregate>
Name or ID of aggregate.
- <host>
The host to add to the aggregate.
5.11. nova aggregate-create
usage: nova aggregate-create <name> [<availability-zone>]
usage: nova aggregate-create <name> [<availability-zone>]Positional arguments
- <name>
Name of aggregate.
- <availability-zone>
The availability zone of the aggregate (optional).
5.12. nova aggregate-delete
usage: nova aggregate-delete <aggregate>
usage: nova aggregate-delete <aggregate>Positional arguments
- <aggregate>
Name or ID of aggregate to delete.
5.13. nova aggregate-details
usage: nova aggregate-details <aggregate>
usage: nova aggregate-details <aggregate>Positional arguments
- <aggregate>
Name or ID of aggregate.
5.14. nova aggregate-list
usage: nova aggregate-list
usage: nova aggregate-list5.15. nova aggregate-remove-host
usage: nova aggregate-remove-host <aggregate> <host>
usage: nova aggregate-remove-host <aggregate> <host>Positional arguments
- <aggregate>
Name or ID of aggregate.
- <host>
The host to remove from the aggregate.
5.16. nova aggregate-set-metadata
usage: nova aggregate-set-metadata <aggregate> <key=value> [<key=value> ...]
usage: nova aggregate-set-metadata <aggregate> <key=value> [<key=value> ...]Positional arguments
- <aggregate>
Name or ID of aggregate to update.
- <key=value>
Metadata to add/update to aggregate. Specify only the key to
delete a metadata item.
5.17. nova aggregate-show
usage: nova aggregate-show <aggregate>
usage: nova aggregate-show <aggregate>Positional arguments
- <aggregate>
Name or ID of aggregate.
5.18. nova aggregate-update
usage: nova aggregate-update [--name NAME]
[--availability-zone <availability-zone>]
<aggregate>
usage: nova aggregate-update [--name NAME]
[--availability-zone <availability-zone>]
<aggregate>Positional arguments
- <aggregate>
Name or ID of aggregate to update.
Optional arguments
- --name NAME
Name of aggregate.
- --availability-zone <availability-zone>
The availability zone of the aggregate.
5.19. nova availability-zone-list
usage: nova availability-zone-list
usage: nova availability-zone-list5.20. nova backup
usage: nova backup <server> <name> <backup-type> <rotation>
usage: nova backup <server> <name> <backup-type> <rotation>Positional arguments
- <server>
Name or ID of server.
- <name>
Name of the backup image.
- <backup-type>
The backup type, like "daily" or "weekly".
- <rotation>
Int parameter representing how many backups to keep around.
5.21. nova baremetal-interface-list
usage: nova baremetal-interface-list <node>
usage: nova baremetal-interface-list <node>Positional arguments
- <node>
ID of node
5.22. nova baremetal-node-list
usage: nova baremetal-node-list
usage: nova baremetal-node-list5.23. nova baremetal-node-show
usage: nova baremetal-node-show <node>
usage: nova baremetal-node-show <node>Positional arguments
- <node>
ID of node
5.24. nova boot
Positional arguments
- <name>
Name for the new server.
Optional arguments
- --flavor <flavor>
Name or ID of flavor (see 'nova flavor-list').
- --image <image>
Name or ID of image (see 'glance image-list').
- --image-with <key=value>
Image metadata property (see 'glance image-
show').
- --boot-volume <volume_id>
Volume ID to boot from.
- --snapshot <snapshot_id>
Snapshot ID to boot from (will create a
volume).
- --min-count <number>
Boot at least <number> servers (limited by
quota).
- --max-count <number>
Boot up to <number> servers (limited by
quota).
- --meta <key=value>
Record arbitrary key/value metadata to
/meta_data.json on the metadata server. Can be
specified multiple times.
- --file <dst-path=src-path>
Store arbitrary files from <src-path> locally
to <dst-path> on the new server. Limited by
the injected_files quota value.
- --key-name <key-name>
Key name of keypair that should be created
earlier with the command keypair-add.
- --user-data <user-data>
user data file to pass to be exposed by the
metadata server.
- --availability-zone <availability-zone>
The availability zone for server placement.
- --security-groups <security-groups>
Comma separated list of security group names.
- --block-device-mapping <dev-name=mapping>
Block device mapping in the format <dev-
name>=<id>:<type>:<size(GB)>:<delete-on-
terminate>.
- --block-device
key1=value1[,key2=value2...]
Block device mapping with the keys: id=UUID
(image_id, snapshot_id or volume_id only if
using source image, snapshot or volume)
source=source type (image, snapshot, volume or
blank), dest=destination type of the block
device (volume or local), bus=device's bus
(e.g. uml, lxc, virtio, ...; if omitted,
hypervisor driver chooses a suitable default,
honoured only if device type is supplied)
type=device type (e.g. disk, cdrom, ...;
defaults to 'disk') device=name of the device
(e.g. vda, xda, ...; tag=device metadata tag
(optional) if omitted, hypervisor driver
chooses suitable device depending on selected
bus; note the libvirt driver always uses
default device names), size=size of the block
device in MB(for swap) and in GB(for other
formats) (if omitted, hypervisor driver
calculates size), format=device will be
formatted (e.g. swap, ntfs, ...; optional),
bootindex=integer used for ordering the boot
disks (for image backed instances it is equal
to 0, for others need to be specified) and
shutdown=shutdown behaviour (either preserve
or remove, for local destination set to
remove). (Supported by API versions '2.32' -
'2.latest')
- --swap <swap_size>
Create and attach a local swap block device of
<swap_size> MB.
- --ephemeral
size=<size>[,format=<format>]
Create and attach a local ephemeral block
device of <size> GB and format it to <format>.
- --hint <key=value>
Send arbitrary key/value pairs to the
scheduler for custom use.
- --nic <auto,none,net-id=net-uuid,net-name=network-name,port-id=port-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,tag=tag>
Create a NIC on the server. Specify option
multiple times to create multiple nics unless
using the special 'auto' or 'none' values.
auto: automatically allocate network resources
if none are available. This cannot be
specified with any other nic value and cannot
be specified multiple times. none: do not
attach a NIC at all. This cannot be specified
with any other nic value and cannot be
specified multiple times. net-id: attach NIC
to network with a specific UUID. net-name:
attach NIC to network with this name (either
port-id or net-id or net-name must be
provided), v4-fixed-ip: IPv4 fixed address for
NIC (optional), v6-fixed-ip: IPv6 fixed
address for NIC (optional), port-id: attach
NIC to port with this UUID tag: interface
metadata tag (optional) (either port-id or
net-id must be provided). (Supported by API
versions '2.37' - '2.latest')
- --config-drive <value>
Enable config drive.
- --poll
Report the new server boot progress until it
completes.
- --admin-pass <value>
Admin password for the instance.
- --access-ip-v4 <value>
Alternative access IPv4 of the instance.
- --access-ip-v6 <value>
Alternative access IPv6 of the instance.
- --description <description>
Description for the server. (Supported by API
versions '2.19' - '2.latest')
5.25. nova cell-capacities
usage: nova cell-capacities [--cell <cell-name>]
usage: nova cell-capacities [--cell <cell-name>]Optional arguments
- --cell <cell-name>
Name of the cell to get the capacities.
5.26. nova cell-show
usage: nova cell-show <cell-name>
usage: nova cell-show <cell-name>Positional arguments
- <cell-name>
Name of the cell.
5.27. nova clear-password
usage: nova clear-password <server>
usage: nova clear-password <server>Positional arguments
- <server>
Name or ID of server.
5.28. nova cloudpipe-configure
usage: nova cloudpipe-configure <ip address> <port>
usage: nova cloudpipe-configure <ip address> <port>Positional arguments
- <ip address>
New IP Address.
- <port>
New Port.
5.29. nova cloudpipe-create
usage: nova cloudpipe-create <project_id>
usage: nova cloudpipe-create <project_id>Positional arguments
- <project_id>
UUID of the project to create the cloudpipe for.
5.30. nova cloudpipe-list
usage: nova cloudpipe-list
usage: nova cloudpipe-list5.31. nova console-log
usage: nova console-log [--length <length>] <server>
usage: nova console-log [--length <length>] <server>Positional arguments
- <server>
Name or ID of server.
Optional arguments
- --length <length>
Length in lines to tail.
5.32. nova credentials
usage: nova credentials [--wrap <integer>]
usage: nova credentials [--wrap <integer>]Optional arguments
- --wrap <integer>
Wrap PKI tokens to a specified length, or 0 to disable.
5.33. nova delete
usage: nova delete [--all-tenants] <server> [<server> ...]
usage: nova delete [--all-tenants] <server> [<server> ...]Positional arguments
- <server>
Name or ID of server(s).
Optional arguments
- --all-tenants
Delete server(s) in another tenant by name (Admin only).
5.34. nova diagnostics
usage: nova diagnostics <server>
usage: nova diagnostics <server>Positional arguments
- <server>
Name or ID of server.
5.35. nova dns-create
usage: nova dns-create [--type <type>] <ip> <name> <domain>
usage: nova dns-create [--type <type>] <ip> <name> <domain>Positional arguments
- <ip>
IP address.
- <name>
DNS name.
- <domain>
DNS domain.
Optional arguments
- --type <type> DNS
type (e.g. "A")
5.36. nova dns-create-private-domain
usage: nova dns-create-private-domain
[--availability-zone <availability-zone>]
<domain>
usage: nova dns-create-private-domain
[--availability-zone <availability-zone>]
<domain>Positional arguments
- <domain>
DNS domain.
Optional arguments
- --availability-zone <availability-zone>
Limit access to this domain to servers in the
specified availability zone.
5.37. nova dns-create-public-domain
usage: nova dns-create-public-domain [--project <project>] <domain>
usage: nova dns-create-public-domain [--project <project>] <domain>Positional arguments
- <domain>
DNS domain.
Optional arguments
- --project <project>
Limit access to this domain to users of the specified
project.
5.38. nova dns-delete
usage: nova dns-delete <domain> <name>
usage: nova dns-delete <domain> <name>Positional arguments
- <domain>
DNS domain.
- <name>
DNS name.
5.39. nova dns-delete-domain
usage: nova dns-delete-domain <domain>
usage: nova dns-delete-domain <domain>Positional arguments
- <domain>
DNS domain.
5.40. nova dns-domains
usage: nova dns-domains
usage: nova dns-domains5.41. nova dns-list
usage: nova dns-list [--ip <ip>] [--name <name>] <domain>
usage: nova dns-list [--ip <ip>] [--name <name>] <domain>Positional arguments
- <domain>
DNS domain.
Optional arguments
- --ip <ip> IP
address.
- --name <name> DNS
name.
5.42. nova endpoints
usage: nova endpoints
usage: nova endpoints5.43. nova evacuate
usage: nova evacuate [--password <password>] [--force] <server> [<host>]
usage: nova evacuate [--password <password>] [--force] <server> [<host>]Positional arguments
- <server>
Name or ID of server.
- <host>
Name or ID of the target host. If no host is
specified, the scheduler will choose one.
Optional arguments
- --password <password>
Set the provided admin password on the evacuated
server. Not applicable if the server is on shared
storage.
- --force
Force to not verify the scheduler if a host is
provided. (Supported by API versions '2.29' -
'2.latest')
5.44. nova fixed-ip-get
usage: nova fixed-ip-get <fixed_ip>
usage: nova fixed-ip-get <fixed_ip>Positional arguments
- <fixed_ip>
Fixed IP Address.
5.45. nova fixed-ip-reserve
usage: nova fixed-ip-reserve <fixed_ip>
usage: nova fixed-ip-reserve <fixed_ip>Positional arguments
- <fixed_ip>
Fixed IP Address.
5.46. nova fixed-ip-unreserve
usage: nova fixed-ip-unreserve <fixed_ip>
usage: nova fixed-ip-unreserve <fixed_ip>Positional arguments
- <fixed_ip>
Fixed IP Address.
5.47. nova flavor-access-add
usage: nova flavor-access-add <flavor> <tenant_id>
usage: nova flavor-access-add <flavor> <tenant_id>Positional arguments
- <flavor>
Flavor name or ID to add access for the given tenant.
- <tenant_id>
Tenant ID to add flavor access for.
5.48. nova flavor-access-list
usage: nova flavor-access-list [--flavor <flavor>] [--tenant <tenant_id>]
usage: nova flavor-access-list [--flavor <flavor>] [--tenant <tenant_id>]Optional arguments
- --flavor <flavor>
Filter results by flavor name or ID.
- --tenant <tenant_id>
Filter results by tenant ID. (Deprecated; this option
is not supported, and will be removed in version
5.0.0.)
5.49. nova flavor-access-remove
usage: nova flavor-access-remove <flavor> <tenant_id>
usage: nova flavor-access-remove <flavor> <tenant_id>Positional arguments
- <flavor>
Flavor name or ID to remove access for the given tenant.
- <tenant_id>
Tenant ID to remove flavor access for.
5.50. nova flavor-create
usage: nova flavor-create [--ephemeral <ephemeral>] [--swap <swap>]
[--rxtx-factor <factor>] [--is-public <is-public>]
<name> <id> <ram> <disk> <vcpus>
usage: nova flavor-create [--ephemeral <ephemeral>] [--swap <swap>]
[--rxtx-factor <factor>] [--is-public <is-public>]
<name> <id> <ram> <disk> <vcpus>Positional arguments
- <name>
Unique name of the new flavor.
- <id>
Unique ID of the new flavor. Specifying 'auto' will
generated a UUID for the ID.
- <ram>
Memory size in MB.
- <disk>
Disk size in GB.
- <vcpus>
Number of vcpus
Optional arguments
- --ephemeral <ephemeral>
Ephemeral space size in GB (default 0).
- --swap <swap>
Swap space size in MB (default 0).
- --rxtx-factor <factor>
RX/TX factor (default 1).
- --is-public <is-public>
Make flavor accessible to the public (default
true).
5.51. nova flavor-delete
usage: nova flavor-delete <flavor>
usage: nova flavor-delete <flavor>Positional arguments
- <flavor>
Name or ID of the flavor to delete.
5.52. nova flavor-key
usage: nova flavor-key <flavor> <action> <key=value> [<key=value> ...]
usage: nova flavor-key <flavor> <action> <key=value> [<key=value> ...]Positional arguments
- <flavor>
Name or ID of flavor.
- <action>
Actions: 'set' or 'unset'.
- <key=value>
Extra_specs to set/unset (only key is necessary on unset).
5.53. nova flavor-list
usage: nova flavor-list [--extra-specs] [--all] [--marker <marker>]
[--limit <limit>]
usage: nova flavor-list [--extra-specs] [--all] [--marker <marker>]
[--limit <limit>]Optional arguments
- --extra-specs
Get extra-specs of each flavor.
- --all
Display all flavors (Admin only).
- --marker <marker>
The last flavor ID of the previous page; displays list of
flavors after "marker".
- --limit <limit>
Maximum number of flavors to display. If limit == -1, all
flavors will be displayed. If limit is bigger than
'osapi_max_limit' option of Nova API, limit
'osapi_max_limit' will be used instead.
5.54. nova flavor-show
usage: nova flavor-show <flavor>
usage: nova flavor-show <flavor>Positional arguments
- <flavor>
Name or ID of flavor.
5.55. nova floating-ip-associate
usage: nova floating-ip-associate [--fixed-address <fixed_address>]
<server> <address>
usage: nova floating-ip-associate [--fixed-address <fixed_address>]
<server> <address>Positional arguments
- <server>
Name or ID of server.
- <address>
IP Address.
Optional arguments
- --fixed-address <fixed_address>
Fixed IP Address to associate with.
5.56. nova floating-ip-bulk-create
usage: nova floating-ip-bulk-create [--pool <pool>] [--interface <interface>]
<range>
usage: nova floating-ip-bulk-create [--pool <pool>] [--interface <interface>]
<range>Positional arguments
- <range>
Address range to create.
Optional arguments
- --pool <pool>
Pool for new Floating IPs.
- --interface <interface>
Interface for new Floating IPs.
5.57. nova floating-ip-bulk-delete
usage: nova floating-ip-bulk-delete <range>
usage: nova floating-ip-bulk-delete <range>Positional arguments
- <range>
Address range to delete.
5.58. nova floating-ip-bulk-list
usage: nova floating-ip-bulk-list [--host <host>]
usage: nova floating-ip-bulk-list [--host <host>]Optional arguments
- --host <host>
Filter by host.
5.59. nova floating-ip-create
usage: nova floating-ip-create [<floating-ip-pool>]
usage: nova floating-ip-create [<floating-ip-pool>]Positional arguments
- <floating-ip-pool>
Name of Floating IP Pool. (Optional)
5.60. nova floating-ip-delete
usage: nova floating-ip-delete <address>
usage: nova floating-ip-delete <address>Positional arguments
- <address>
IP of Floating IP.
5.61. nova floating-ip-disassociate
usage: nova floating-ip-disassociate <server> <address>
usage: nova floating-ip-disassociate <server> <address>Positional arguments
- <server>
Name or ID of server.
- <address>
IP Address.
5.62. nova floating-ip-list
usage: nova floating-ip-list
usage: nova floating-ip-list5.63. nova floating-ip-pool-list
usage: nova floating-ip-pool-list
usage: nova floating-ip-pool-list5.64. nova force-delete
usage: nova force-delete <server>
usage: nova force-delete <server>Positional arguments
- <server>
Name or ID of server.
5.65. nova get-mks-console
usage: nova get-mks-console <server>
usage: nova get-mks-console <server>Positional arguments
- <server>
Name or ID of server.
5.66. nova get-password
usage: nova get-password <server> [<private-key>]
usage: nova get-password <server> [<private-key>]Positional arguments
- <server>
Name or ID of server.
- <private-key>
Private key (used locally to decrypt password) (Optional).
When specified, the command displays the clear (decrypted) VM
password. When not specified, the ciphered VM password is
displayed.
5.67. nova get-rdp-console
usage: nova get-rdp-console <server> <console-type>
usage: nova get-rdp-console <server> <console-type>Positional arguments
- <server>
Name or ID of server.
- <console-type>
Type of rdp console ("rdp-html5").
5.68. nova get-serial-console
usage: nova get-serial-console [--console-type CONSOLE_TYPE] <server>
usage: nova get-serial-console [--console-type CONSOLE_TYPE] <server>Positional arguments
- <server>
Name or ID of server.
Optional arguments
- --console-type CONSOLE_TYPE
Type of serial console, default="serial".
5.69. nova get-spice-console
usage: nova get-spice-console <server> <console-type>
usage: nova get-spice-console <server> <console-type>Positional arguments
- <server>
Name or ID of server.
- <console-type>
Type of spice console ("spice-html5").
5.70. nova get-vnc-console
usage: nova get-vnc-console <server> <console-type>
usage: nova get-vnc-console <server> <console-type>Positional arguments
- <server>
Name or ID of server.
- <console-type>
Type of vnc console ("novnc" or "xvpvnc").
5.71. nova host-action
usage: nova host-action [--action <action>] <hostname>
usage: nova host-action [--action <action>] <hostname>Positional arguments
- <hostname>
Name of host.
Optional arguments
- --action <action> A
power action: startup, reboot, or shutdown.
5.72. nova host-describe
usage: nova host-describe <hostname>
usage: nova host-describe <hostname>Positional arguments
- <hostname>
Name of host.
5.73. nova host-evacuate
usage: nova host-evacuate [--target_host <target_host>] [--force] <host>
usage: nova host-evacuate [--target_host <target_host>] [--force] <host>Positional arguments
- <host>
Name of host.
Optional arguments
- --target_host <target_host>
Name of target host. If no host is specified
the scheduler will select a target.
- --force
Force to not verify the scheduler if a host is
provided. (Supported by API versions '2.29' -
'2.latest')
5.74. nova host-evacuate-live
usage: nova host-evacuate-live [--target-host <target_host>] [--block-migrate]
[--max-servers <max_servers>] [--force]
<host>
usage: nova host-evacuate-live [--target-host <target_host>] [--block-migrate]
[--max-servers <max_servers>] [--force]
<host>Positional arguments
- <host>
Name of host.
Optional arguments
- --target-host <target_host>
Name of target host.
- --block-migrate
Enable block migration. (Default=auto)
(Supported by API versions '2.25' - '2.latest')
- --max-servers <max_servers>
Maximum number of servers to live migrate
simultaneously
- --force
Force to not verify the scheduler if a host is
provided. (Supported by API versions '2.30' -
'2.latest')
5.75. nova host-list
usage: nova host-list [--zone <zone>]
usage: nova host-list [--zone <zone>]Optional arguments
- --zone <zone>
Filters the list, returning only those hosts in the
availability zone <zone>.
5.76. nova host-meta
usage: nova host-meta <host> <action> <key=value> [<key=value> ...]
usage: nova host-meta <host> <action> <key=value> [<key=value> ...]Positional arguments
- <host>
Name of host.
- <action>
Actions: 'set' or 'delete'
- <key=value>
Metadata to set or delete (only key is necessary on delete)
5.77. nova host-servers-migrate
usage: nova host-servers-migrate <host>
usage: nova host-servers-migrate <host>Positional arguments
- <host>
Name of host.
5.78. nova host-update
usage: nova host-update [--status <enable|disable>]
[--maintenance <enable|disable>]
<hostname>
usage: nova host-update [--status <enable|disable>]
[--maintenance <enable|disable>]
<hostname>Positional arguments
- <hostname>
Name of host.
Optional arguments
- --status <enable|disable>
Either enable or disable a host.
- --maintenance <enable|disable>
Either put or resume host to/from maintenance.
5.79. nova hypervisor-list
usage: nova hypervisor-list [--matching <hostname>] [--marker <marker>]
[--limit <limit>]
usage: nova hypervisor-list [--matching <hostname>] [--marker <marker>]
[--limit <limit>]Optional arguments
- --matching <hostname>
List hypervisors matching the given <hostname>. If
matching is used limit and marker options will be
ignored.
- --marker <marker>
The last hypervisor of the previous page; displays
list of hypervisors after "marker".
- --limit <limit>
Maximum number of hypervisors to display. If limit ==
-1, all hypervisors will be displayed. If limit is
bigger than 'osapi_max_limit' option of Nova API,
limit 'osapi_max_limit' will be used instead.
5.80. nova hypervisor-servers
usage: nova hypervisor-servers <hostname>
usage: nova hypervisor-servers <hostname>Positional arguments
- <hostname>
The hypervisor hostname (or pattern) to search for.
5.81. nova hypervisor-show
usage: nova hypervisor-show [--wrap <integer>] <hypervisor>
usage: nova hypervisor-show [--wrap <integer>] <hypervisor>Positional arguments
- <hypervisor>
Name or ID of the hypervisor to show the details of.
Optional arguments
- --wrap <integer>
Wrap the output to a specified length. Default is 40 or 0
to disable
5.82. nova hypervisor-stats
usage: nova hypervisor-stats
usage: nova hypervisor-stats5.83. nova hypervisor-uptime
usage: nova hypervisor-uptime <hypervisor>
usage: nova hypervisor-uptime <hypervisor>Positional arguments
- <hypervisor>
Name or ID of the hypervisor to show the uptime of.
5.84. nova image-create
usage: nova image-create [--metadata <key=value>] [--show] [--poll]
<server> <name>
usage: nova image-create [--metadata <key=value>] [--show] [--poll]
<server> <name>nova image-create are only usable by nova (and not glance).
Positional arguments
- <server>
Name or ID of server.
- <name>
Name of snapshot.
Optional arguments
- --metadata <key=value>
Record arbitrary key/value metadata to
/meta_data.json on the metadata server. Can be
specified multiple times.
- --show
Print image info.
- --poll
Report the snapshot progress and poll until image
creation is complete.
5.85. nova image-delete
usage: nova image-delete <image> [<image> ...]
usage: nova image-delete <image> [<image> ...]Positional arguments
- <image>
Name or ID of image(s).
5.86. nova image-list
usage: nova image-list [--limit <limit>]
usage: nova image-list [--limit <limit>]Optional arguments
- --limit <limit>
Number of images to return per request.
5.87. nova image-meta
usage: nova image-meta <image> <action> <key=value> [<key=value> ...]
usage: nova image-meta <image> <action> <key=value> [<key=value> ...]Positional arguments
- <image>
Name or ID of image.
- <action>
Actions: 'set' or 'delete'.
- <key=value>
Metadata to add/update or delete (only key is necessary on
delete).
5.88. nova image-show
usage: nova image-show <image>
usage: nova image-show <image>Positional arguments
- <image>
Name or ID of image.
5.89. nova instance-action
usage: nova instance-action <server> <request_id>
usage: nova instance-action <server> <request_id>Positional arguments
- <server>
Name or UUID of the server to show actions for. Only UUID can
be used to show actions for a deleted server. (Supported by
API versions '2.21' - '2.latest')
- <request_id>
Request ID of the action to get.
5.90. nova instance-action-list
usage: nova instance-action-list <server>
usage: nova instance-action-list <server>Positional arguments
- <server>
Name or UUID of the server to list actions for. Only UUID can be
used to list actions on a deleted server. (Supported by API
versions '2.21' - '2.latest')
5.91. nova interface-attach
usage: nova interface-attach [--port-id <port_id>] [--net-id <net_id>]
[--fixed-ip <fixed_ip>]
<server>
usage: nova interface-attach [--port-id <port_id>] [--net-id <net_id>]
[--fixed-ip <fixed_ip>]
<server>Positional arguments
- <server>
Name or ID of server.
Optional arguments
- --port-id <port_id>
Port ID.
- --net-id <net_id>
Network ID
- --fixed-ip <fixed_ip>
Requested fixed IP.
5.92. nova interface-detach
usage: nova interface-detach <server> <port_id>
usage: nova interface-detach <server> <port_id>Positional arguments
- <server>
Name or ID of server.
- <port_id>
Port ID.
5.93. nova interface-list
usage: nova interface-list <server>
usage: nova interface-list <server>Positional arguments
- <server>
Name or ID of server.
5.94. nova keypair-add
usage: nova keypair-add [--pub-key <pub-key>] [--key-type <key-type>]
[--user <user-id>]
<name>
usage: nova keypair-add [--pub-key <pub-key>] [--key-type <key-type>]
[--user <user-id>]
<name>Positional arguments
- <name>
Name of key.
Optional arguments
- --pub-key <pub-key>
Path to a public ssh key.
- --key-type <key-type>
Keypair type. Can be ssh or x509. (Supported by API
versions '2.2' - '2.latest')
- --user <user-id> ID
of user to whom to add key-pair (Admin only).
(Supported by API versions '2.10' - '2.latest')
5.95. nova keypair-delete
usage: nova keypair-delete [--user <user-id>] <name>
usage: nova keypair-delete [--user <user-id>] <name>Positional arguments
- <name>
Keypair name to delete.
Optional arguments
- --user <user-id> ID
of key-pair owner (Admin only).
5.96. nova keypair-list
usage: nova keypair-list [--user <user-id>] [--marker <marker>]
[--limit <limit>]
usage: nova keypair-list [--user <user-id>] [--marker <marker>]
[--limit <limit>]Optional arguments
- --user <user-id>
List key-pairs of specified user ID (Admin only).
- --marker <marker>
The last keypair of the previous page; displays list of
keypairs after "marker".
- --limit <limit>
Maximum number of keypairs to display. If limit == -1,
all keypairs will be displayed. If limit is bigger than
'osapi_max_limit' option of Nova API, limit
'osapi_max_limit' will be used instead.
5.97. nova keypair-show
usage: nova keypair-show [--user <user-id>] <keypair>
usage: nova keypair-show [--user <user-id>] <keypair>Positional arguments
- <keypair>
Name of keypair.
Optional arguments
- --user <user-id> ID
of key-pair owner (Admin only).
5.98. nova limits
usage: nova limits [--tenant [<tenant>]] [--reserved]
usage: nova limits [--tenant [<tenant>]] [--reserved]Optional arguments
- --tenant [<tenant>]
Display information from single tenant (Admin only).
- --reserved
Include reservations count.
5.99. nova list
Optional arguments
- --reservation-id <reservation-id>
Only return servers that match reservation-id.
- --ip <ip-regexp>
Search with regular expression match by IP
address.
- --ip6 <ip6-regexp>
Search with regular expression match by IPv6
address.
- --name <name-regexp>
Search with regular expression match by name.
- --instance-name <name-regexp>
Search with regular expression match by server
name.
- --status <status>
Search by server status.
- --flavor <flavor>
Search by flavor name or ID.
- --image <image>
Search by image name or ID.
- --host <hostname>
Search servers by hostname to which they are
assigned (Admin only).
- --all-tenants [<0|1>]
Display information from all tenants (Admin
only).
- --tenant [<tenant>]
Display information from single tenant (Admin
only).
- --user [<user>]
Display information from single user (Admin
only).
- --deleted
Only display deleted servers (Admin only).
- --fields <fields>
Comma-separated list of fields to display. Use
the show command to see which fields are
available.
- --minimal
Get only UUID and name.
- --sort <key>[:<direction>]
Comma-separated list of sort keys and
directions in the form of <key>[:<asc|desc>].
The direction defaults to descending if not
specified.
- --marker <marker>
The last server UUID of the previous page;
displays list of servers after "marker".
- --limit <limit>
Maximum number of servers to display. If limit
== -1, all servers will be displayed. If limit
is bigger than 'osapi_max_limit' option of
Nova API, limit 'osapi_max_limit' will be used
instead.
- --changes-since <changes_since>
List only servers changed after a certain
point of time.The provided time should be an
ISO 8061 formatted time.ex
2016-03-04T06:27:59Z .
- --tags <tags>
The given tags must all be present for a
server to be included in the list result.
Boolean expression in this case is 't1 AND
t2'. Tags must be separated by commas: --tags
<tag1,tag2> (Supported by API versions '2.26'
- '2.latest')
- --tags-any <tags-any>
If one of the given tags is present the server
will be included in the list result. Boolean
expression in this case is 't1 OR t2'. Tags
must be separated by commas: --tags-any
<tag1,tag2> (Supported by API versions '2.26'
- '2.latest')
- --not-tags <not-tags>
Only the servers that do not have any of the
given tags willbe included in the list
results. Boolean expression in this case is
'NOT(t1 AND t2)'. Tags must be separated by
commas: --not-tags <tag1,tag2> (Supported by
API versions '2.26' - '2.latest')
- --not-tags-any <not-tags-any>
Only the servers that do not have at least one
of the given tagswill be included in the list
result. Boolean expression in this case is
'NOT(t1 OR t2)'. Tags must be separated by
commas: --not-tags-any <tag1,tag2> (Supported
by API versions '2.26' - '2.latest')
5.100. nova list-extensions
usage: nova list-extensions
usage: nova list-extensions5.101. nova list-secgroup
usage: nova list-secgroup <server>
usage: nova list-secgroup <server>Positional arguments
- <server>
Name or ID of server.
5.102. nova live-migration
usage: nova live-migration [--block-migrate] [--force] <server> [<host>]
usage: nova live-migration [--block-migrate] [--force] <server> [<host>]Positional arguments
- <server>
Name or ID of server.
- <host>
Destination host name.
Optional arguments
- --block-migrate
True in case of block_migration.
(Default=auto:live_migration) (Supported by API versions
'2.25' - '2.latest')
- --force
Force to not verify the scheduler if a host is provided.
(Supported by API versions '2.30' - '2.latest')
5.103. nova live-migration-abort
usage: nova live-migration-abort <server> <migration>
usage: nova live-migration-abort <server> <migration>Positional arguments
- <server>
Name or ID of server.
- <migration>
ID of migration.
5.104. nova live-migration-force-complete
usage: nova live-migration-force-complete <server> <migration>
usage: nova live-migration-force-complete <server> <migration>Positional arguments
- <server>
Name or ID of server.
- <migration>
ID of migration.
5.105. nova lock
usage: nova lock <server>
usage: nova lock <server>Positional arguments
- <server>
Name or ID of server.
5.106. nova meta
usage: nova meta <server> <action> <key=value> [<key=value> ...]
usage: nova meta <server> <action> <key=value> [<key=value> ...]Positional arguments
- <server>
Name or ID of server.
- <action>
Actions: 'set' or 'delete'.
- <key=value>
Metadata to set or delete (only key is necessary on delete).
5.107. nova migrate
usage: nova migrate [--poll] <server>
usage: nova migrate [--poll] <server>Positional arguments
- <server>
Name or ID of server.
Optional arguments
- --poll
Report the server migration progress until it completes.
5.108. nova migration-list
usage: nova migration-list [--host <host>] [--status <status>]
[--cell_name <cell_name>]
usage: nova migration-list [--host <host>] [--status <status>]
[--cell_name <cell_name>]Optional arguments
- --host <host>
Fetch migrations for the given host.
- --status <status>
Fetch migrations for the given status.
- --cell_name <cell_name>
Fetch migrations for the given cell_name.
5.109. nova net
usage: nova net <network_id>
usage: nova net <network_id>Positional arguments
- <network_id>
ID of network
5.110. nova net-create
usage: nova net-create <network_label> <cidr>
usage: nova net-create <network_label> <cidr>Positional arguments
- <network_label>
Network label (ex. my_new_network)
- <cidr>
IP block to allocate from (ex. 172.16.0.0/24 or
2001:DB8::/64)
5.111. nova net-delete
usage: nova net-delete <network_id>
usage: nova net-delete <network_id>Positional arguments
- <network_id>
ID of network
5.112. nova net-list
usage: nova net-list
usage: nova net-list5.113. nova network-associate-host
usage: nova network-associate-host <network> <host>
usage: nova network-associate-host <network> <host>Positional arguments
- <network>
UUID of network.
- <host>
Name of host
5.114. nova network-associate-project
usage: nova network-associate-project <network>
usage: nova network-associate-project <network>Positional arguments
- <network>
UUID of network.
5.115. nova network-create
Positional arguments
- <network_label>
Label for network
Optional arguments
- --fixed-range-v4 <x.x.x.x/yy>
IPv4 subnet (ex: 10.0.0.0/8)
- --fixed-range-v6
CIDR_V6 IPv6 subnet (ex: fe80::/64
- --vlan <vlan id>
The vlan ID to be assigned to the project.
- --vlan-start <vlan start>
First vlan ID to be assigned to the project.
Subsequent vlan IDs will be assigned
incrementally.
- --vpn <vpn start>
vpn start
- --gateway GATEWAY
gateway
- --gateway-v6
GATEWAY_V6 IPv6 gateway
- --bridge <bridge>
VIFs on this network are connected to this
bridge.
- --bridge-interface <bridge interface>
The bridge is connected to this interface.
- --multi-host <'T'|'F'>
Multi host
- --dns1 <DNS Address>
First DNS.
- --dns2 <DNS Address>
Second DNS.
- --uuid <network uuid>
Network UUID.
- --fixed-cidr <x.x.x.x/yy>
IPv4 subnet for fixed IPs (ex: 10.20.0.0/16).
- --project-id <project id>
Project ID.
- --priority <number>
Network interface priority.
- --mtu MTU MTU
for network.
- --enable-dhcp <'T'|'F'>
Enable DHCP.
- --dhcp-server DHCP_SERVER
DHCP-server address (defaults to gateway
address)
- --share-address <'T'|'F'>
Share address
- --allowed-start ALLOWED_START
Start of allowed addresses for instances.
- --allowed-end ALLOWED_END
End of allowed addresses for instances.
5.116. nova network-delete
usage: nova network-delete <network>
usage: nova network-delete <network>Positional arguments
- <network>
UUID or label of network.
5.117. nova network-disassociate
usage: nova network-disassociate [--host-only [<0|1>]]
[--project-only [<0|1>]]
<network>
usage: nova network-disassociate [--host-only [<0|1>]]
[--project-only [<0|1>]]
<network>Positional arguments
- <network>
UUID of network.
Optional arguments
- --host-only [<0|1>]
- --project-only [<0|1>]
5.118. nova network-list
usage: nova network-list [--fields <fields>]
usage: nova network-list [--fields <fields>]Optional arguments
- --fields <fields>
Comma-separated list of fields to display. Use the show
command to see which fields are available.
5.119. nova network-show
usage: nova network-show <network>
usage: nova network-show <network>Positional arguments
- <network>
UUID or label of network.
5.120. nova pause
usage: nova pause <server>
usage: nova pause <server>Positional arguments
- <server>
Name or ID of server.
5.121. nova quota-class-show
usage: nova quota-class-show <class>
usage: nova quota-class-show <class>Positional arguments
- <class>
Name of quota class to list the quotas for.
5.122. nova quota-class-update
Positional arguments
- <class>
Name of quota class to set the quotas for.
Optional arguments
- --instances <instances>
New value for the "instances" quota.
- --cores <cores>
New value for the "cores" quota.
- --ram <ram>
New value for the "ram" quota.
- --metadata-items <metadata-items>
New value for the "metadata-items" quota.
- --injected-files <injected-files>
New value for the "injected-files" quota.
- --injected-file-content-bytes <injected-file-content-bytes>
New value for the "injected-file-content-
bytes" quota.
- --injected-file-path-bytes <injected-file-path-bytes>
New value for the "injected-file-path-bytes"
quota.
- --key-pairs <key-pairs>
New value for the "key-pairs" quota.
- --server-groups <server-groups>
New value for the "server-groups" quota.
- --server-group-members <server-group-members>
New value for the "server-group-members"
quota.
5.123. nova quota-defaults
usage: nova quota-defaults [--tenant <tenant-id>]
usage: nova quota-defaults [--tenant <tenant-id>]Optional arguments
- --tenant <tenant-id> ID
of tenant to list the default quotas for.
5.124. nova quota-delete
usage: nova quota-delete --tenant <tenant-id> [--user <user-id>]
usage: nova quota-delete --tenant <tenant-id> [--user <user-id>]Optional arguments
- --tenant <tenant-id> ID
of tenant to delete quota for.
- --user <user-id> ID
of user to delete quota for.
5.125. nova quota-show
usage: nova quota-show [--tenant <tenant-id>] [--user <user-id>] [--detail]
usage: nova quota-show [--tenant <tenant-id>] [--user <user-id>] [--detail]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
Show detailed info (limit, reserved, in-use).
5.126. nova quota-update
Positional arguments
- <tenant-id>
ID of tenant to set the quotas for.
Optional arguments
- --user <user-id> ID
of user to set the quotas for.
- --instances <instances>
New value for the "instances" quota.
- --cores <cores>
New value for the "cores" quota.
- --ram <ram>
New value for the "ram" quota.
- --metadata-items <metadata-items>
New value for the "metadata-items" quota.
- --injected-files <injected-files>
New value for the "injected-files" quota.
- --injected-file-content-bytes <injected-file-content-bytes>
New value for the "injected-file-content-
bytes" quota.
- --injected-file-path-bytes <injected-file-path-bytes>
New value for the "injected-file-path-bytes"
quota.
- --key-pairs <key-pairs>
New value for the "key-pairs" quota.
- --server-groups <server-groups>
New value for the "server-groups" quota.
- --server-group-members <server-group-members>
New value for the "server-group-members"
quota.
- --force
Whether force update the quota even if the
already used and reserved exceeds the new
quota.
5.127. nova rate-limits
usage: nova rate-limits
usage: nova rate-limits5.128. nova reboot
usage: nova reboot [--hard] [--poll] <server> [<server> ...]
usage: nova reboot [--hard] [--poll] <server> [<server> ...]Positional arguments
- <server>
Name or ID of server(s).
Optional arguments
- --hard
Perform a hard reboot (instead of a soft one). Note: Ironic does
not currently support soft reboot; consequently, bare metal nodes
will always do a hard reboot, regardless of the use of this
option.
- --poll
Poll until reboot is complete.
5.129. nova rebuild
usage: nova rebuild [--rebuild-password <rebuild-password>] [--poll]
[--minimal] [--preserve-ephemeral] [--name <name>]
[--description <description>] [--meta <key=value>]
[--file <dst-path=src-path>]
<server> <image>
usage: nova rebuild [--rebuild-password <rebuild-password>] [--poll]
[--minimal] [--preserve-ephemeral] [--name <name>]
[--description <description>] [--meta <key=value>]
[--file <dst-path=src-path>]
<server> <image>Positional arguments
- <server>
Name or ID of server.
- <image>
Name or ID of new image.
Optional arguments
- --rebuild-password <rebuild-password>
Set the provided admin password on the rebuilt
server.
- --poll
Report the server rebuild progress until it
completes.
- --minimal
Skips flavor/image lookups when showing
servers.
- --preserve-ephemeral
Preserve the default ephemeral storage
partition on rebuild.
- --name <name>
Name for the new server.
- --description <description>
New description for the server. (Supported by
API versions '2.19' - '2.latest')
- --meta <key=value>
Record arbitrary key/value metadata to
/meta_data.json on the metadata server. Can be
specified multiple times.
- --file <dst-path=src-path>
Store arbitrary files from <src-path> locally
to <dst-path> on the new server. You may store
up to 5 files.
5.130. nova refresh-network
usage: nova refresh-network <server>
usage: nova refresh-network <server>Positional arguments
- <server>
Name or ID of a server for which the network cache should be
refreshed from neutron (Admin only).
5.131. nova remove-fixed-ip
usage: nova remove-fixed-ip <server> <address>
usage: nova remove-fixed-ip <server> <address>Positional arguments
- <server>
Name or ID of server.
- <address>
IP Address.
5.132. nova remove-secgroup
usage: nova remove-secgroup <server> <secgroup>
usage: nova remove-secgroup <server> <secgroup>Positional arguments
- <server>
Name or ID of server.
- <secgroup>
Name of Security Group.
5.133. nova rename
usage: nova rename <server> <name>
usage: nova rename <server> <name>Positional arguments
- <server>
Name (old name) or ID of server.
- <name>
New name for the server.
5.134. nova rescue
usage: nova rescue [--password <password>] [--image <image>] <server>
usage: nova rescue [--password <password>] [--image <image>] <server>Positional arguments
- <server>
Name or ID of server.
Optional arguments
- --password <password>
The admin password to be set in the rescue
environment.
- --image <image>
The image to rescue with.