Red Hat Training

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

Command-Line Interface Reference

Red Hat OpenStack Platform 8

Command-line clients for Red Hat OpenStack Platform

OpenStack Documentation Team

Red Hat Customer Content Services

Abstract

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

Chapter 1. OpenStack command-line clients

1.1. Overview

You can use the OpenStack command-line clients to run simple commands that make API calls. You can run these commands from the command line or in scripts to automate tasks. If you provide OpenStack credentials, you can run these commands on any computer.
Internally, each client command runs cURL commands that embed API requests. The OpenStack APIs are RESTful APIs that use the HTTP protocol, including methods, URIs, media types, and response codes.
These open-source Python clients run on Linux or Mac OS X systems and are easy to learn and use. Each OpenStack service has its own command-line client. On some client commands, you can specify a debug parameter to show the underlying API request for the command. This is a good way to become familiar with the OpenStack API calls.
The following table lists the command-line client for each OpenStack service with its package name and description.

Table 1.1. OpenStack services and clients

Service Client Package Description
Block Storage cinder python-cinderclient Create and manage volumes.
Compute nova python-novaclient Create and manage images, instances, and flavors.
Database Service trove python-troveclient Create and manage databases.
Identity keystone python-keystoneclient Create and manage users, tenants, roles, endpoints, and credentials.
Image Service glance python-glanceclient Create and manage images.
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.
An OpenStack common client is in development.
For client installation instructions, see Section 1.2, “Install the OpenStack command-line clients”. For information about the OpenStack RC file, see the Red Hat OpenStack Platform End User Guide.

1.2. Install the OpenStack command-line clients

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

1.2.1. Install the prerequisite software

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

Table 1.2. Prerequisite software

Prerequisite Description
Python 2.6 or later
Currently, the clients do not support Python 3.
setuptools package
Many Linux distributions provide packages to make setuptools easy to install. Search your package manager for setuptools to find an installation package. If you cannot find one, download the setuptools package directly from http://pypi.python.org/pypi/setuptools.

1.2.2. Install the clients

When following the instructions in this section, replace PROJECT with the lowercase name of the client to install, such as nova. Repeat for each client. The following values are valid:
  • ceilometer - Telemetry API
  • cinder - Block Storage API and extensions
  • glance - Image Service API
  • heat - Orchestration API
  • keystone - Identity service API and extensions
  • neutron - Networking API
  • nova - Compute API and extensions
  • swift - Object Storage API
  • trove - Database Service API
The following example shows the command for installing the nova client with yum.
# yum install python-novaclient

1.2.2.1. Installing from packages

On Red Hat Enterprise Linux, use yum to install the clients:
# yum install python-PROJECTclient

1.2.3. Upgrade or remove clients

To upgrade a client, add the --upgrade option to the yum install command:
# yum install --upgrade python-PROJECTclient
To remove the a client, run the yum erase command:
# yum erase python-PROJECTclient

1.2.4. What's next

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

1.3. Discover the version number for a client

Run the following command to discover the version number for a client:
$ PROJECT --version
For example, to see the version number for the nova client, run the following command:
$ nova --version
The version number (2.15.0 in the example) is returned.
2.15.0

1.4. Set environment variables using the OpenStack RC file

To set the required environment variables for the OpenStack command-line clients, you must create an environment file called an OpenStack rc file, or openrc.sh file. If your OpenStack installation provides it, you can download the file from the OpenStack dashboard as an administrative user or any other user. This project-specific environment file contains the credentials that all OpenStack services use.
When you source the file, environment variables are set for your current shell. The variables enable the OpenStack client commands to communicate with the OpenStack services that run in the cloud.
Note
Defining environment variables using an environment file is not a common practice on Microsoft Windows. Environment variables are usually defined in the Advanced tab of the System Properties dialog box.

1.4.1. Download and source the OpenStack RC file

  1. Log in to the OpenStack dashboard, choose the project for which you want to download the OpenStack RC file, and click Access & Security.
  2. On the API Access tab, click Download OpenStack RC File and save the file. The filename will be of the form PROJECT-openrc.sh where PROJECT is the name of the project for which you downloaded the file.
  3. Copy the PROJECT-openrc.sh file to the computer from which you want to run OpenStack commands.
    For example, copy the file to the computer from which you want to upload an image with a glance client command.
  4. On any shell from which you want to run OpenStack commands, source the PROJECT-openrc.sh file for the respective project.
    In the following example, the demo-openrc.sh file is sourced for the demo project:
    $ source demo-openrc.sh
  5. When you are prompted for an OpenStack password, enter the password for the user who downloaded the PROJECT-openrc.sh file.

1.4.2. Create and source the OpenStack RC file

Alternatively, you can create the PROJECT-openrc.sh file from scratch, if for some reason you cannot download the file from the dashboard.
  1. In a text editor, create a file named PROJECT-openrc.sh file and add the following authentication information:
    export OS_USERNAME=username
    export OS_PASSWORD=password
    export OS_TENANT_NAME=projectName
    export OS_AUTH_URL=https://identityHost:portNumber/v2.0
    # The following lines can be omitted
    export OS_TENANT_ID=tenantIDString
    export OS_REGION_NAME=regionName
    The following example shows the information for a project called admin, where the OS username is also admin, and the identity host is located at controller.
    export OS_USERNAME=admin
    export OS_PASSWORD=ADMIN_PASS
    export OS_TENANT_NAME=admin
    export OS_AUTH_URL=http://controller:35357/v2.0
  2. On any shell from which you want to run OpenStack commands, source the PROJECT-openrc.sh file for the respective project. In this example, you source the admin-openrc.sh file for the admin project:
    $ source admin-openrc.sh
Note
You are not prompted for the password with this method. The password lives in clear text format in the PROJECT-openrc.sh file. Restrict the permissions on this file to avoid security problems. You can also remove the OS_PASSWORD variable from the file, and use the --password parameter with OpenStack client commands instead.

1.4.3. Override environment variable values

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

Chapter 2. Packstack command-line client

The packstack client is the command-line interface (CLI) for installing single node, proof-of-concept deployments. This chapter documents packstack version 2015.1.dev1537.gba5183c.
For help on a specific packstack command, enter:
$ packstack help COMMAND

2.1. packstack usage

Usage: packstack [options] [--help]

2.2. packstack optional arguments

--version
show program's version number and exit
-h, --help
show this help message and exit
--gen-answer-file=GEN_ANSWER_FILE
Generate a template of an answer file.
--answer-file=ANSWER_FILE
Runs the configuration in non-interactive mode, extracting all information from theconfiguration file. using this option excludes all other options
--install-hosts=INSTALL_HOSTS
Install on a set of hosts in a single step. The format should be a comma separated list of hosts, the first is setup as a controller, and the others are setup as compute nodes.if only a single host is supplied then it is setup as an all in one installation. An answerfile will also be generated and should be used if Packstack needs to be run a second time
--allinone
Shorthand for --install-hosts=<local ipaddr> --novanetwork-pubif=<dev> --novacompute-privif=lo --novanetwork-privif=lo --os-swift-install=y, this option can be used to install an all in one OpenStack on this host
-t TIMEOUT, --timeout=TIMEOUT
The timeout for puppet Exec calls
-o, --options
Print details on options available in answer file(rst format)
-d, --debug
Enable debug in logging
-y, --dry-run
Don't execute, just generate manifests

2.3. packstack Global Options

--ssh-public-key=SSH_PUBLIC_KEY
Path to a public key to install on servers. If a usable key has not been installed on the remote servers, the user is prompted for a password and this key is installed so the password will not be required again.
--default-password=DEFAULT_PASSWORD
Default password to be used everywhere (overridden by passwords set for individual services or users).
--mariadb-install=MARIADB_INSTALL
Specify 'y' to install MariaDB. ['y', 'n']
--os-glance-install=OS_GLANCE_INSTALL
Specify 'y' to install OpenStack Image Service (glance). ['y', 'n']
--os-cinder-install=OS_CINDER_INSTALL
Specify 'y' to install OpenStack Block Storage (cinder). ['y', 'n']
--os-manila-install=OS_MANILA_INSTALL
Specify 'y' to install OpenStack Shared File System (manila). ['y', 'n']
--os-nova-install=OS_NOVA_INSTALL
Specify 'y' to install OpenStack Compute (nova). ['y', 'n']
--os-neutron-install=OS_NEUTRON_INSTALL
Specify 'y' to install OpenStack Networking (neutron); otherwise, Compute Networking (nova) will be used. ['y', 'n']
--os-horizon-install=OS_HORIZON_INSTALL
Specify 'y' to install OpenStack Dashboard (horizon). ['y', 'n']
--os-swift-install=OS_SWIFT_INSTALL
Specify 'y' to install OpenStack Object Storage (swift). ['y', 'n']
--os-ceilometer-install=OS_CEILOMETER_INSTALL
Specify 'y' to install OpenStack Metering (ceilometer). ['y', 'n']
--os-heat-install=OS_HEAT_INSTALL
Specify 'y' to install OpenStack Orchestration (heat). ['y', 'n']
--os-sahara-install=OS_SAHARA_INSTALL
Specify 'y' to install OpenStack Data Processing (sahara). ['y', 'n']
--os-trove-install=OS_TROVE_INSTALL
Specify 'y' to install OpenStack Database (trove) ['y', 'n']
--os-ironic-install=OS_IRONIC_INSTALL
Specify 'y' to install OpenStack Bare Metal Provisioning (ironic). ['y', 'n']
--os-client-install=OS_CLIENT_INSTALL
Specify 'y' to install the OpenStack Client packages (command-line tools). An admin "rc" file will also be installed. ['y', 'n']
--ntp-servers=NTP_SERVERS
Comma-separated list of NTP servers. Leave plain if Packstack should not install ntpd on instances.
--exclude-servers=EXCLUDE_SERVERS
Comma-separated list of servers to be excluded from the installation. This is helpful if you are running Packstack a second time with the same answer file and do not want Packstack to overwrite these server's configurations. Leave empty if you do not need to exclude any servers.
--os-debug-mode=OS_DEBUG_MODE
Specify 'y' if you want to run OpenStack services in debug mode; otherwise, specify 'n'. ['y', 'n']
--os-controller-host=OS_CONTROLLER_HOST
IP address of the server on which to install OpenStack services specific to the controller role (for example, API servers or dashboard).
--os-compute-hosts=OS_COMPUTE_HOSTS
List of IP addresses of the servers on which to install the Compute service.
--os-network-hosts=OS_NETWORK_HOSTS
List of IP addresses of the server on which to install the network service such as Compute networking (nova network) or OpenStack Networking (neutron).
--os-vmware=OS_VMWARE
Specify 'y' if you want to use VMware vCenter as hypervisor and storage; otherwise, specify 'n'. ['y', 'n']
--unsupported=UNSUPPORTED
Specify 'y' if you want to use unsupported parameters. This should be used only if you know what you are doing. Issues caused by using unsupported options will not be fixed before the next major release. ['y', 'n']

2.4. packstack vCenter Config Parameters

--vcenter-host=VCENTER_HOST
IP address of the VMware vCenter server.
--vcenter-username=VCENTER_USERNAME
User name for VMware vCenter server authentication.
--vcenter-password=VCENTER_PASSWORD
Password for VMware vCenter server authentication.
--vcenter-cluster=VCENTER_CLUSTER
Name of the VMware vCenter cluster.

2.5. packstack Server Prepare Configs

--use-epel=USE_EPEL
Specify 'y' to enable the EPEL repository (Extra Packages for Enterprise Linux). ['y', 'n']
--additional-repo=ADDITIONAL_REPO
Comma-separated list of URLs for any additional yum repositories, to use for installation.

2.6. packstack RHEL config

--rh-username=RH_USERNAME
To subscribe each server with Red Hat Subscription Manager, include this with CONFIG_RH_PW.
--rhn-satellite-server=RHN_SATELLITE_SERVER
To subscribe each server to receive updates from a Satellite server, provide the URL of the Satellite server. You must also provide a user name (CONFIG_SATELLITE_USERNAME) and password (CONFIG_SATELLITE_PASSWORD) or an access key (CONFIG_SATELLITE_AKEY) for authentication.

2.7. packstack RHN Satellite config

--rhn-satellite-username=RHN_SATELLITE_USERNAME
User name to authenticate with the RHN Satellite server; if you intend to use an access key for Satellite authentication, leave this blank.
--rhn-satellite-password=RHN_SATELLITE_PASSWORD
Password to authenticate with the RHN Satellite server; if you intend to use an access key for Satellite authentication, leave this blank.
--rhn-satellite-activation-key=RHN_SATELLITE_ACTIVATION_KEY
Access key for the Satellite server; if you intend to use a user name and password for Satellite authentication, leave this blank.
--rhn-satellite-cacert=RHN_SATELLITE_CACERT
Certificate path or URL of the certificate authority to verify that the connection with the Satellite server is secure. If you are not using Satellite in your deployment, leave this blank.
--rhn-satellite-profile=RHN_SATELLITE_PROFILE
Profile name that should be used as an identifier for the system in RHN Satellite (if required).
--rhn-satellite-flags=RHN_SATELLITE_FLAGS
Comma-separated list of flags passed to the rhnreg_ks command. Valid flags are: novirtinfo, norhnsd, nopackages ['novirtinfo', 'norhnsd', 'nopackages']
--rhn-satellite-proxy-host=RHN_SATELLITE_PROXY_HOST
HTTP proxy to use when connecting to the RHN Satellite server (if required).

2.8. packstack RHN Satellite proxy config

--rhn-satellite-proxy-username=RHN_SATELLITE_PROXY_USERNAME
User name to authenticate with the Satellite-server HTTP proxy.
--rhn-satellite-proxy-password=RHN_SATELLITE_PROXY_PASSWORD
User password to authenticate with the Satellite- server HTTP proxy.

2.9. packstack AMQP Config parameters

--amqp-backend=AMQP_BACKEND
Service to be used as the AMQP broker. Allowed values are: qpid, rabbitmq ['qpid', 'rabbitmq']
--amqp-host=AMQP_HOST
IP address of the server on which to install the AMQP service.
--amqp-enable-ssl=AMQP_ENABLE_SSL
Specify 'y' to enable SSL for the AMQP service. ['y', 'n']
--amqp-enable-auth=AMQP_ENABLE_AUTH
Specify 'y' to enable authentication for the AMQP service. ['y', 'n']

2.10. packstack AMQP Config SSL parameters

--amqp-nss-certdb-pw=AMQP_NSS_CERTDB_PW
Password for the NSS certificate database of the AMQP service.
--amqp-ssl-port=AMQP_SSL_PORT
Port on which the AMQP service listens for SSL connections.
--amqp-ssl-cacert-file=AMQP_SSL_CACERT_FILE
File name of the CAcertificate that the AMQP service will use for verification.
--amqp-ssl-cert-file=AMQP_SSL_CERT_FILE
File name of the certificate that the AMQP service will use for verification.
--amqp-ssl-key-file=AMQP_SSL_KEY_FILE
File name of the private key that the AMQP service will use for verification.
--amqp-ssl-self-signed=AMQP_SSL_SELF_SIGNED
Specify 'y' to automatically generate a self-signed SSL certificate and key. ['y', 'n']

2.11. packstack AMQP Config Athentication parameters

--amqp-auth-user=AMQP_AUTH_USER
User for AMQP authentication.
--amqp-auth-password=AMQP_AUTH_PASSWORD
Password for AMQP authentication.

2.12. packstack Keystone Config parameters

--keystone-db-passwd=KEYSTONE_DB_PASSWD
Password to use for the Identity service (keystone) to access the database.
--keystone-region=KEYSTONE_REGION
Default region name to use when creating tenants in the Identity service.
--keystone-admin-email=KEYSTONE_ADMIN_EMAIL
Email address for the Identity service 'admin' user. Defaults to
--keystone-admin-username=KEYSTONE_ADMIN_USERNAME
User name for the Identity service 'admin' user. Defaults to 'admin'.
--keystone-admin-passwd=KEYSTONE_ADMIN_PASSWD
Password to use for the Identity service 'admin' user.
--keystone-demo-passwd=KEYSTONE_DEMO_PASSWD
Password to use for the Identity service 'demo' user.
--keystone-service-name=KEYSTONE_SERVICE_NAME
Name of service to use to run the Identity service (keystone or httpd). ['keystone', 'httpd']
--keystone-identity-backend=KEYSTONE_IDENTITY_BACKEND
Type of Identity service backend (sql or ldap). ['sql', 'ldap']

2.13. packstack Glance Config parameters

--glance-db-passwd=GLANCE_DB_PASSWD
Password to use for the Image service (glance) to access the database.
--glance-ks-passwd=GLANCE_KS_PASSWD
Password to use for the Image service to authenticate with the Identity service.
--glance-backend=GLANCE_BACKEND
Storage backend for the Image service (controls how the Image service stores disk images). Valid options are: file or swift (Object Storage). The Object Storage service must be enabled to use it as a working backend; otherwise, Packstack falls back to 'file'. ['file', 'swift']

2.14. packstack Cinder Config parameters

--cinder-db-passwd=CINDER_DB_PASSWD
Password to use for the Block Storage service (cinder) to access the database.
--cinder-ks-passwd=CINDER_KS_PASSWD
Password to use for the Block Storage service to authenticate with the Identity service.
--cinder-backend=CINDER_BACKEND
Storage backend to use for the Block Storage service; valid options are: lvm, gluster, nfs, vmdk, netapp. ['lvm', 'gluster', 'nfs', 'vmdk', 'netapp']

2.15. packstack Cinder volume create Config parameters

--cinder-volumes-create=CINDER_VOLUMES_CREATE
Specify 'y' to create the Block Storage volumes group. That is, Packstack creates a raw disk image in /var/lib/cinder, and mounts it using a loopback device. This should only be used for testing on a proof-of-concept installation of the Block Storage service (a file-backed volume group is not suitable for production usage). ['y', 'n']

2.16. packstack Cinder volume size Config parameters

--cinder-volumes-size=CINDER_VOLUMES_SIZE
Size of Block Storage volumes group. Actual volume size will be extended with 3% more space for VG metadata. Remember that the size of the volume group will restrict the amount of disk space that you can expose to Compute instances, and that the specified amount must be available on the device used for /var/lib/cinder.

2.17. packstack Cinder gluster Config parameters

--cinder-gluster-mounts=CINDER_GLUSTER_MOUNTS
A single or comma-separated list of Red Hat Storage (gluster) volume shares to mount. Example: 'ip-address :/vol-name', 'domain:/vol-name'

2.18. packstack Cinder NFS Config parameters

--cinder-nfs-mounts=CINDER_NFS_MOUNTS
A single or comma-separated list of NFS exports to mount. Example: 'ip-address:/export-name'

2.19. packstack Nova Options

--nova-db-passwd=NOVA_DB_PASSWD
Password to use for the Compute service (nova) to access the database.
--nova-ks-passwd=NOVA_KS_PASSWD
Password to use for the Compute service to authenticate with the Identity service.
--novasched-cpu-allocation-ratio=NOVASCHED_CPU_ALLOCATION_RATIO
Overcommitment ratio for virtual to physical CPUs. Specify 1.0 to disable CPU overcommitment.
--novasched-ram-allocation-ratio=NOVASCHED_RAM_ALLOCATION_RATIO
Overcommitment ratio for virtual to physical RAM. Specify 1.0 to disable RAM overcommitment.
--novacompute-migrate-protocol=NOVACOMPUTE_MIGRATE_PROTOCOL
Protocol used for instance migration. Valid options are: tcp and ssh. Note that by default, the Compute user is created with the /sbin/nologin shell so that the SSH protocol will not work. To make the SSH protocol work, you must configure the Compute user on compute hosts manually. ['tcp', 'ssh']
--nova-compute-manager=NOVA_COMPUTE_MANAGER
Manager that runs the Compute service.

2.20. packstack Nova Network Options

--novacompute-privif=NOVACOMPUTE_PRIVIF
Private interface for flat DHCP on the Compute servers.
--novanetwork-manager=NOVANETWORK_MANAGER
Compute Network Manager. ['^nova\.network\.manager\.\w+Manager$']
--novanetwork-pubif=NOVANETWORK_PUBIF
Public interface on the Compute network server.
--novanetwork-privif=NOVANETWORK_PRIVIF
Private interface for flat DHCP on the Compute network server.
--novanetwork-fixed-range=NOVANETWORK_FIXED_RANGE
IP Range for flat DHCP. ['^[\:\.\da- fA-f]+(\/\d+){0,1}$']
--novanetwork-floating-range=NOVANETWORK_FLOATING_RANGE
IP Range for floating IP addresses. ['^[\:\.\da- fA-f]+(\/\d+){0,1}$']
--novanetwork-auto-assign-floating-ip=NOVANETWORK_AUTO_ASSIGN_FLOATING_IP
Specify 'y' to automatically assign a floating IP to new instances. ['y', 'n']

2.21. packstack Nova Network VLAN Options

--novanetwork-vlan-start=NOVANETWORK_VLAN_START
First VLAN for private networks (Compute networking).
--novanetwork-num-networks=NOVANETWORK_NUM_NETWORKS
Number of networks to support (Compute networking).
--novanetwork-network-size=NOVANETWORK_NETWORK_SIZE
Number of addresses in each private subnet (Compute networking).

2.22. packstack Neutron config

--os-neutron-ks-password=OS_NEUTRON_KS_PASSWORD
Password to use for OpenStack Networking (neutron) to authenticate with the Identity service.
--os-neutron-db-password=OS_NEUTRON_DB_PASSWORD
The password to use for OpenStack Networking to access the database.
--os-neutron-l3-ext-bridge=OS_NEUTRON_L3_EXT_BRIDGE
The name of the Open vSwitch bridge (or empty for linuxbridge) for the OpenStack Networking L3 agent to use for external traffic. Specify 'provider' if you intend to use a provider network to handle external traffic.
--os-neutron-metadata-pw=OS_NEUTRON_METADATA_PW
Password for the OpenStack Networking metadata agent.
--os-neutron-lbaas-install=OS_NEUTRON_LBAAS_INSTALL
Specify 'y' to install OpenStack Networking's Load- Balancing-as-a-Service (LBaaS). ['y', 'n']
--os-neutron-metering-agent-install=OS_NEUTRON_METERING_AGENT_INSTALL
Specify 'y' to install OpenStack Networking's L3 Metering agent ['y', 'n']
--neutron-fwaas=NEUTRON_FWAAS
Specify 'y' to configure OpenStack Networking's Firewall-as-a-Service (FWaaS). ['y', 'n']

2.23. packstack Neutron LB agent config

--os-neutron-lb-interface-mappings=OS_NEUTRON_LB_INTERFACE_MAPPINGS
Comma-separated list of interface mappings for the OpenStack Networking linuxbridge plugin. Each tuple in the list must be in the format <physical_network>:<net_interface>. Example: physnet1:eth1,physnet2:eth2,physnet3:eth3.

2.24. packstack Neutron OVS agent config

--os-neutron-ovs-bridge-mappings=OS_NEUTRON_OVS_BRIDGE_MAPPINGS
Comma-separated list of bridge mappings for the OpenStack Networking Open vSwitch plugin. Each tuple in the list must be in the format <physical_network>:<ovs_bridge>. Example: physnet1:br- eth1,physnet2:br-eth2,physnet3:br-eth3
--os-neutron-ovs-bridge-interfaces=OS_NEUTRON_OVS_BRIDGE_INTERFACES
Comma-separated list of colon-separated Open vSwitch <bridge>:<interface> pairs. The interface will be added to the associated bridge.

2.25. packstack Neutron OVS agent config for tunnels

--os-neutron-ovs-tunnel-if=OS_NEUTRON_OVS_TUNNEL_IF
Interface for the Open vSwitch tunnel. Packstack overrides the IP address used for tunnels on this hypervisor to the IP found on the specified interface (for example, eth1).

2.26. packstack Neutron OVS agent config for VXLAN

--os-neutron-ovs-vxlan-udp-port=OS_NEUTRON_OVS_VXLAN_UDP_PORT
VXLAN UDP port.

2.27. packstack NOVACLIENT Config parameters

2.28. packstack OpenStack Horizon Config parameters

--os-horizon-ssl=OS_HORIZON_SSL
Specify 'y' to set up Horizon communication over https. ['y', 'n']

2.29. packstack SSL Config parameters

--os-ssl-cert=OS_SSL_CERT
PEM-encoded certificate to be used for SSL connections on the https server (the certificate should not require a passphrase). To generate a certificate, leave blank.
--os-ssl-key=OS_SSL_KEY
SSL keyfile corresponding to the certificate if one was specified.
--os-ssl-cachain=OS_SSL_CACHAIN
PEM-encoded CA certificates from which the certificate chain of the server certificate can be assembled.

2.30. packstack OpenStack Swift Config parameters

--os-swift-ks-passwd=OS_SWIFT_KS_PASSWD
Password to use for the Object Storage service to authenticate with the Identity service.
--os-swift-storages=OS_SWIFT_STORAGES
Comma-separated list of devices to use as storage device for Object Storage. Each entry must take the format /path/to/dev (for example, specifying /dev/vdb installs /dev/vdb as the Object Storage storage device; Packstack does not create the filesystem, you must do this first). If left empty, Packstack creates a loopback device for test setup.
--os-swift-storage-zones=OS_SWIFT_STORAGE_ZONES
Number of Object Storage storage zones; this number MUST be no larger than the number of configured storage devices.
--os-swift-storage-replicas=OS_SWIFT_STORAGE_REPLICAS
Number of Object Storage storage replicas; this number MUST be no larger than the number of configured storage zones.
--os-swift-storage-fstype=OS_SWIFT_STORAGE_FSTYPE
File system type for storage nodes. ['xfs', 'ext4']
--os-swift-storage-size=OS_SWIFT_STORAGE_SIZE
Size of the Object Storage loopback file storage device.

2.31. packstack Heat Config parameters

--os-heat-mysql-password=OS_HEAT_MYSQL_PASSWORD
Password used by Orchestration service user to authenticate against the database.
--os-heat-ks-passwd=OS_HEAT_KS_PASSWD
Password to use for the Orchestration service to authenticate with the Identity service.
--os-heat-cloudwatch-install=OS_HEAT_CLOUDWATCH_INSTALL
Specify 'y' to install the Orchestration CloudWatch API. ['y', 'n']
--os-heat-cfn-install=OS_HEAT_CFN_INSTALL
Specify 'y' to install the Orchestration CloudFormation API. ['y', 'n']
--os-heat-domain=OS_HEAT_DOMAIN
Name of the Identity domain for Orchestration.
--os-heat-domain-admin=OS_HEAT_DOMAIN_ADMIN
Name of the Identity domain administrative user for Orchestration.
--os-heat-domain-password=OS_HEAT_DOMAIN_PASSWORD
Password for the Identity domain administrative user for Orchestration.

2.32. packstack Provisioning demo config

--provision-demo=PROVISION_DEMO
Specify 'y' to provision for demo usage and testing. ['y', 'n']
--provision-tempest=PROVISION_TEMPEST
Specify 'y' to configure the OpenStack Integration Test Suite (tempest) for testing. The test suite requires OpenStack Networking to be installed. ['y', 'n']

2.33. packstack Provisioning demo config

--provision-demo-floatrange=PROVISION_DEMO_FLOATRANGE
CIDR network address for the floating IP subnet.
--provision-image-name=PROVISION_IMAGE_NAME
The name to be assigned to the demo image in Glance (default "cirros").
--provision-image-url=PROVISION_IMAGE_URL
A URL or local file location for an image to download and provision in Glance (defaults to a URL for a recent "cirros" image).
--provision-image-format=PROVISION_IMAGE_FORMAT
Format for the demo image (default "qcow2").
--provision-image-ssh-user=PROVISION_IMAGE_SSH_USER
User to use when connecting to instances booted from the demo image.

2.34. packstack Ceilometer Config parameters

--ceilometer-ks-passwd=CEILOMETER_KS_PASSWD
Password to use for Telemetry to authenticate with the Identity service.

2.35. packstack MONGODB Config parameters

--mongodb-host=MONGODB_HOST
IP address of the server on which to install MongoDB.

2.36. packstack POSTSCRIPT Config parameters

2.37. packstack Puppet Config parameters

Chapter 3. OpenStack command-line client

The openstack client is a common OpenStack command-line interface (CLI). This chapter documents openstack version 1.7.2.
For help on a specific openstack command, enter:
$ openstack help COMMAND

3.1. openstack usage

usage: openstack [--version] [-v] [--log-file LOG_FILE] [-q] [-h] [--debug] [--os-cloud <cloud-config-name>] [--os-region-name <auth-region-name>] [--os-cacert <ca-bundle-file>] [--verify | --insecure] [--os-default-domain <auth-domain>] [--os-interface <interface>] [--timing] [--os-compute-api-version <compute-api-version>] [--os-network-api-version <network-api-version>] [--os-image-api-version <image-api-version>] [--os-volume-api-version <volume-api-version>] [--os-identity-api-version <identity-api-version>] [--os-auth-type <auth-type>] [--os-project-domain-id <auth-project-domain-id>] [--os-protocol <auth-protocol>] [--os-project-name <auth-project-name>] [--os-trust-id <auth-trust-id>] [--os-service-provider-endpoint <auth-service-provider-endpoint>] [--os-domain-name <auth-domain-name>] [--os-user-domain-id <auth-user-domain-id>] [--os-identity-provider-url <auth-identity-provider-url>] [--os-access-token-endpoint <auth-access-token-endpoint>] [--os-domain-id <auth-domain-id>] [--os-user-domain-name <auth-user-domain-name>] [--os-scope <auth-scope>] [--os-user-id <auth-user-id>] [--os-identity-provider <auth-identity-provider>] [--os-username <auth-username>] [--os-auth-url <auth-auth-url>] [--os-client-secret <auth-client-secret>] [--os-client-id <auth-client-id>] [--os-project-domain-name <auth-project-domain-name>] [--os-password <auth-password>] [--os-endpoint <auth-endpoint>] [--os-url <auth-url>] [--os-token <auth-token>] [--os-project-id <auth-project-id>] [--os-object-api-version <object-api-version>] [--inspector-api-version INSPECTOR_API_VERSION] [--inspector-url INSPECTOR_URL] [--os-tripleoclient-api-version <tripleoclient-api-version>] [--os-data-processing-api-version <data-processing-api-version>] [--os-dns-api-version <dns-api-version>]

3.2. openstack optional arguments

--version
show program's version number and exit
-v, --verbose
Increase verbosity of output. Can be repeated.
--log-file LOG_FILE
Specify a file to log output. Disabled by default.
-q, --quiet
Suppress output except warnings and errors.
-h, --help
Show help message and exit.
--debug
Show tracebacks on errors.
--os-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)
--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-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 (Env: OS_NETWORK_API_VERSION)
--os-image-api-version <image-api-version>
Image API version, default=1 (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=2 (Env: OS_IDENTITY_API_VERSION)
--os-auth-type <auth-type>
Select an authentication type. Available types: v2token, admin_token, v2password, v3password, v3scopedsaml, v3oidcpassword, v3unscopedadfs, token, v3token, password, v3unscopedsaml, osc_password, token_endpoint. Default: selected based on --os- username/--os-token (Env: OS_AUTH_TYPE)
--os-project-domain-id <auth-project-domain-id>
With v3password: Domain ID containing project With v3scopedsaml: Domain ID containing project With v3oidcpassword: Domain ID containing project With v3unscopedadfs: Domain ID containing project With token: Domain ID containing project With v3token: Domain ID containing project With password: Domain ID containing project With v3unscopedsaml: Domain ID containing project With osc_password: Domain ID containing project (Env: OS_PROJECT_DOMAIN_ID)
--os-protocol <auth-protocol>
With v3oidcpassword: Name of the federated protocol used for federated authentication. Must match its counterpart name configured at the keystone service provider. Typically values would be 'saml2' or 'oidc'. (Env: OS_PROTOCOL)
--os-project-name <auth-project-name>
With v3password: Project name to scope to With v3scopedsaml: Project name to scope to With v3oidcpassword: Project name to scope to With v3unscopedadfs: Project name to scope to With token: Project name to scope to With v3token: Project name to scope to With password: Project name to scope to With v3unscopedsaml: Project name to scope to With osc_password: Project name to scope to (Env: OS_PROJECT_NAME)
--os-trust-id <auth-trust-id>
With v2token: Trust ID With v2password: Trust ID With v3password: Trust ID With v3scopedsaml: Trust ID With v3oidcpassword: Trust ID With v3unscopedadfs: Trust ID With token: Trust ID With v3token: Trust ID With password: Trust ID With v3unscopedsaml: Trust ID With osc_password: Trust ID (Env: OS_TRUST_ID)
--os-service-provider-endpoint <auth-service-provider-endpoint>
With v3unscopedadfs: Service Provider's Endpoint (Env: OS_SERVICE_PROVIDER_ENDPOINT)
--os-domain-name <auth-domain-name>
With v3password: Domain name to scope to With v3scopedsaml: Domain name to scope to With v3oidcpassword: Domain name to scope to With v3unscopedadfs: Domain name to scope to With token: Domain name to scope to With v3token: Domain name to scope to With password: Domain name to scope to With v3unscopedsaml: Domain name to scope to With osc_password: Domain name to scope to (Env: OS_DOMAIN_NAME)
--os-user-domain-id <auth-user-domain-id>
With v3password: User's domain id With password: User's domain id With osc_password: User's domain id (Env: OS_USER_DOMAIN_ID)
--os-identity-provider-url <auth-identity-provider-url>
With v3unscopedadfs: Identity Provider's URL With v3unscopedsaml: Identity Provider's URL (Env: OS_IDENTITY_PROVIDER_URL)
--os-access-token-endpoint <auth-access-token-endpoint>
With v3oidcpassword: OpenID Connect Provider Token Endpoint (Env: OS_ACCESS_TOKEN_ENDPOINT)
--os-domain-id <auth-domain-id>
With v3password: Domain ID to scope to With v3scopedsaml: Domain ID to scope to With v3oidcpassword: Domain ID to scope to With v3unscopedadfs: Domain ID to scope to With token: Domain ID to scope to With v3token: Domain ID to scope to With password: Domain ID to scope to With v3unscopedsaml: Domain ID to scope to With osc_password: Domain ID to scope to (Env: OS_DOMAIN_ID)
--os-user-domain-name <auth-user-domain-name>
With v3password: User's domain name With password: User's domain name With osc_password: User's domain name (Env: OS_USER_DOMAIN_NAME)
--os-scope <auth-scope>
With v3oidcpassword: OpenID Connect scope that is requested from OP (Env: OS_SCOPE)
--os-user-id <auth-user-id>
With v2password: User ID to login with With v3password: User ID With password: User id With osc_password: User id (Env: OS_USER_ID)
--os-identity-provider <auth-identity-provider>
With v3oidcpassword: Identity Provider's name With v3unscopedadfs: Identity Provider's name With v3unscopedsaml: Identity Provider's name (Env: OS_IDENTITY_PROVIDER)
--os-username <auth-username>
With v2password: Username to login with With v3password: Username With v3oidcpassword: Username With v3unscopedadfs: Username With password: Username With v3unscopedsaml: Username With osc_password: Username (Env: OS_USERNAME)
--os-auth-url <auth-auth-url>
With v2token: Authentication URL With v2password: Authentication URL With v3password: Authentication URL With v3scopedsaml: Authentication URL With v3oidcpassword: Authentication URL With v3unscopedadfs: Authentication URL With token: Authentication URL With v3token: Authentication URL With password: Authentication URL With v3unscopedsaml: Authentication URL With osc_password: Authentication URL (Env: OS_AUTH_URL)
--os-client-secret <auth-client-secret>
With v3oidcpassword: OAuth 2.0 Client Secret (Env: OS_CLIENT_SECRET)
--os-client-id <auth-client-id>
With v3oidcpassword: OAuth 2.0 Client ID (Env: OS_CLIENT_ID)
--os-project-domain-name <auth-project-domain-name>
With v3password: Domain name containing project With v3scopedsaml: Domain name containing project With v3oidcpassword: Domain name containing project With v3unscopedadfs: Domain name containing project With token: Domain name containing project With v3token: Domain name containing project With password: Domain name containing project With v3unscopedsaml: Domain name containing project With osc_password: Domain name containing project (Env: OS_PROJECT_DOMAIN_NAME)
--os-password <auth-password>
With v2password: Password to use With v3password: User's password With v3oidcpassword: Password With v3unscopedadfs: Password With password: User's password With v3unscopedsaml: Password With osc_password: User's password (Env: OS_PASSWORD)
--os-endpoint <auth-endpoint>
With admin_token: The endpoint that will always be used With token_endpoint: The endpoint that will always be used (Env: OS_ENDPOINT)
--os-url <auth-url>
With token_endpoint: Specific service endpoint to use (Env: OS_URL)
--os-token <auth-token>
With v2token: Token With admin_token: The token that will always be used With v3scopedsaml: Token to authenticate with With token: Token to authenticate with With v3token: Token to authenticate with With token_endpoint: The token that will always be used With token_endpoint: Authentication token to use (Env: OS_TOKEN)
--os-project-id <auth-project-id>
With v3password: Project ID to scope to With v3scopedsaml: Project ID to scope to With v3oidcpassword: Project ID to scope to With v3unscopedadfs: Project ID to scope to With token: Project ID to scope to With v3token: Project ID to scope to With password: Project ID to scope to With v3unscopedsaml: Project ID to scope to With osc_password: Project ID to scope to (Env: OS_PROJECT_ID)
--os-object-api-version <object-api-version>
Object API version, default=1 (Env: OS_OBJECT_API_VERSION)
--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-tripleoclient-api-version <tripleoclient-api-version>
TripleO Client API version, default=1 (Env: OS_TRIPLEOCLIENT_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-dns-api-version <dns-api-version>
DNS API version, default=2 (Env: OS_DNS_API_VERSION)

3.3. Subcommands

3.3.1. openstack aggregate add host

usage: openstack aggregate add host [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <aggregate> <host>
Add host to aggregate

Positional arguments

<aggregate>
Aggregate (name or ID)
<host>
Host to add to <aggregate>

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.2. openstack aggregate create

usage: openstack aggregate create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--zone <availability-zone>] [--property <key=value>] <name>
Create a new aggregate

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)

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.3. openstack aggregate delete

usage: openstack aggregate delete [-h] <aggregate>
Delete an existing aggregate

Positional arguments

<aggregate>
Aggregate to delete (name or ID)

Optional arguments

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

3.3.4. openstack aggregate list

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

Optional arguments

-h, --help
show this help message and exit
--long
List additional fields in output

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.5. openstack aggregate remove host

usage: openstack aggregate remove host [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <aggregate> <host>
Remove host from aggregate

Positional arguments

<aggregate>
Aggregate (name or ID)
<host>
Host to remove from <aggregate>

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.6. openstack aggregate set

usage: openstack aggregate set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name <name>] [--zone <availability-zone>] [--property <key=value>] <aggregate>
Set aggregate properties

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)

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.7. openstack aggregate show

usage: openstack aggregate show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <aggregate>
Display aggregate details

Positional arguments

<aggregate>
Aggregate to display (name or ID)

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.8. openstack availability zone list

usage: openstack availability zone list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long]
List availability zones and their status

Optional arguments

-h, --help
show this help message and exit
--long
List additional fields in output

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.9. openstack backup create

usage: openstack backup create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--container <container>] [--name <name>] [--description <description>] <volume>
Create new backup

Positional arguments

<volume>
Volume to backup (name or ID)

Optional arguments

-h, --help
show this help message and exit
--container <container>
Optional backup container name
--name <name>
Name of the backup
--description <description>
Description of the backup

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.10. openstack backup delete

usage: openstack backup delete [-h] <backup> [<backup> ...]
Delete backup(s)

Positional arguments

<backup>
Backup(s) to delete (ID only)

Optional arguments

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

3.3.11. openstack backup list

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

Optional arguments

-h, --help
show this help message and exit
--long
List additional fields in output

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.12. openstack backup restore

usage: openstack backup restore [-h] <backup> <volume>
Restore backup

Positional arguments

<backup>
Backup to restore (ID only)
<volume>
Volume to restore to (name or ID)

Optional arguments

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

3.3.13. openstack backup show

usage: openstack backup show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <backup>
Display backup details

Positional arguments

<backup>
Backup to display (ID only)

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.14. openstack baremetal introspection rule delete

usage: openstack baremetal introspection rule delete [-h] uuid
Delete an introspection rule.

Positional arguments

uuid
rule UUID

Optional arguments

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

3.3.15. openstack baremetal introspection rule import

usage: openstack baremetal introspection rule import [-h] file
Import one or several introspection rules from a json file.

Positional arguments

file
JSON file to import, may contain one or several rules

Optional arguments

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

3.3.16. openstack baremetal introspection rule list

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

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.17. openstack baremetal introspection rule purge

usage: openstack baremetal introspection rule purge [-h]
Drop all introspection rules.

Optional arguments

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

3.3.18. openstack baremetal introspection rule show

usage: openstack baremetal introspection rule show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] uuid
Show an introspection rule.

Positional arguments

uuid
rule UUID

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.19. openstack baremetal introspection start

usage: openstack baremetal introspection start [-h] [--new-ipmi-username NEW_IPMI_USERNAME] [--new-ipmi-password NEW_IPMI_PASSWORD] uuid
Start the introspection.

Positional arguments

uuid
baremetal node UUID

Optional arguments

-h, --help
show this help message and exit
--new-ipmi-username NEW_IPMI_USERNAME
if set, *Ironic Inspector* will update IPMI user name to this value
--new-ipmi-password NEW_IPMI_PASSWORD
if set, *Ironic Inspector* will update IPMI password to this value

3.3.20. openstack baremetal introspection status

usage: openstack baremetal introspection status [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] uuid
Get introspection status.

Positional arguments

uuid
baremetal node UUID

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.21. openstack catalog list

usage: openstack catalog list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
List services in the service catalog

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.22. openstack catalog show

usage: openstack catalog show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <service>
Display service catalog details

Positional arguments

<service>
Service to display (type or name)

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.23. openstack command list

usage: openstack command list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
List recognized commands by group

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.24. openstack compute agent create

usage: openstack compute agent create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <os> <architecture> <version> <url> <md5hash> <hypervisor>
Create compute agent command

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.25. openstack compute agent delete

usage: openstack compute agent delete [-h] <id>
Delete compute agent command

Positional arguments

<id>
ID of agent to delete

Optional arguments

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

3.3.26. openstack compute agent list

usage: openstack compute agent list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--hypervisor <hypervisor>]
List compute agent command

Optional arguments

-h, --help
show this help message and exit
--hypervisor <hypervisor>
Type of hypervisor

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.27. openstack compute agent set

usage: openstack compute agent set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <id> <version> <url> <md5hash>
Set compute agent command

Positional arguments

<id>
ID of the agent
<version>
Version of the agent
<url>
URL
<md5hash>
MD5 hash

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.28. openstack compute service list

usage: openstack compute service list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--host <host>] [--service <service>]
List service command

Optional arguments

-h, --help
show this help message and exit
--host <host>
Name of host
--service <service>
Name of service

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.29. openstack compute service set

usage: openstack compute service set [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--enable | --disable] <host> <service>
Set service command

Positional arguments

<host>
Name of host
<service>
Name of service

Optional arguments

-h, --help
show this help message and exit
--enable
Enable a service
--disable
Disable a service

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.30. openstack configuration show

usage: openstack configuration show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--mask | --unmask]
Display configuration details

Optional arguments

-h, --help
show this help message and exit
--mask
Attempt to mask passwords (default)
--unmask
Show password in clear text

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.31. openstack console log show

usage: openstack console log show [-h] [--lines <num-lines>] <server>
Show server's console output

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)

3.3.32. openstack console url show

usage: openstack console url show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--novnc | --xvpvnc | --spice] <server>
Show server's remote console URL

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 xpvnc console URL
--spice
Show SPICE console URL

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.33. openstack container create

usage: openstack container create [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] <container-name> [<container-name> ...]
Create new container

Positional arguments

<container-name>
New container name(s)

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.34. openstack container delete

usage: openstack container delete [-h] <container> [<container> ...]
Delete container

Positional arguments

<container>
Container(s) to delete

Optional arguments

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

3.3.35. openstack container list

usage: openstack container list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--prefix <prefix>] [--marker <marker>] [--end-marker <end-marker>] [--limit <limit>] [--long] [--all]
List containers

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)

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.36. openstack container save

usage: openstack container save [-h] <container>
Save container contents locally

Positional arguments

<container>
Container to save

Optional arguments

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

3.3.37. openstack container show

usage: openstack container show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <container>
Display container details

Positional arguments

<container>
Container to display

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.38. openstack dataprocessing data source create

usage: openstack dataprocessing data source create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --type <type> --url <url> [--username <username>] [--password <password>] [--description <description>] <name>
Creates data source

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 or maprfs) [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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.39. openstack dataprocessing data source delete

usage: openstack dataprocessing data source delete [-h] <data-source>
Delete data source

Positional arguments

<data-source>
Name or id of the data source to delete

Optional arguments

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

3.3.40. openstack dataprocessing data source list

usage: openstack dataprocessing data source list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long] [--type <type>]
Lists data sources

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 or maprfs)

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.41. openstack dataprocessing data source show

usage: openstack dataprocessing data source show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <data-source>
Display data source details

Positional arguments

<data-source>
Name or id of the data source to display

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.42. openstack dataprocessing plugin configs get

usage: openstack dataprocessing plugin configs get [-h] [--file <file>] <plugin> <version>
Get plugin configs

Positional arguments

<plugin>
Name of the plugin to provide config information about
<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)

3.3.43. openstack dataprocessing plugin list

usage: openstack dataprocessing plugin list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long]
Lists plugins

Optional arguments

-h, --help
show this help message and exit
--long
List additional fields in output

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.44. openstack dataprocessing plugin show

usage: openstack dataprocessing plugin show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <plugin>
Display plugin details

Positional arguments

<plugin>
Name of the plugin to display

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.45. openstack ec2 credentials create

usage: openstack ec2 credentials create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--project <project>] [--user <user>]
Create EC2 credentials

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)

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.46. openstack ec2 credentials delete

usage: openstack ec2 credentials delete [-h] [--user <user>] <access-key>
Delete EC2 credentials

Positional arguments

<access-key>
Credentials access key

Optional arguments

-h, --help
show this help message and exit
--user <user>
Delete credentials for user (name or ID)

3.3.47. openstack ec2 credentials list

usage: openstack ec2 credentials list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--user <user>]
List EC2 credentials

Optional arguments

-h, --help
show this help message and exit
--user <user>
Filter list by user (name or ID)

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.48. openstack ec2 credentials show

usage: openstack ec2 credentials show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--user <user>] <access-key>
Display EC2 credentials details

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)

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.49. openstack endpoint create

usage: openstack endpoint create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --publicurl <url> [--adminurl <url>] [--internalurl <url>] [--region <region-id>] <service>
Create new endpoint

Positional arguments

<service>
New endpoint service (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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.50. openstack endpoint delete

usage: openstack endpoint delete [-h] <endpoint-id>
Delete endpoint

Positional arguments

<endpoint-id>
Endpoint ID to delete

Optional arguments

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

3.3.51. openstack endpoint list

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

Optional arguments

-h, --help
show this help message and exit
--long
List additional fields in output

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.52. openstack endpoint show

usage: openstack endpoint show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <endpoint-id>
Display endpoint details

Positional arguments

<endpoint-id>
Endpoint ID to display

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.53. openstack extension list

usage: openstack extension list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--compute] [--identity] [--network] [--volume] [--long]
List API extensions

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 Volume API
--long
List additional fields in output

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.54. openstack flavor create

usage: openstack flavor create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--id <id>] [--ram <size-mb>] [--disk <size-gb>] [--ephemeral <size-gb>] [--swap <size-gb>] [--vcpus <vcpus>] [--rxtx-factor <factor>] [--public | --private] <flavor-name>
Create new flavor

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)
--public
Flavor is available to other projects (default)
--private
Flavor is not available to other projects

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.55. openstack flavor delete

usage: openstack flavor delete [-h] <flavor>
Delete flavor

Positional arguments

<flavor>
Flavor to delete (name or ID)

Optional arguments

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

3.3.56. openstack flavor list

usage: openstack flavor list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--public | --private | --all] [--long]
List flavors

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.57. openstack flavor set

usage: openstack flavor set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--property <key=value>] <flavor>
Set flavor properties

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)

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.58. openstack flavor show

usage: openstack flavor show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <flavor>
Display flavor details

Positional arguments

<flavor>
Flavor to display (name or ID)

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.59. openstack flavor unset

usage: openstack flavor unset [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --property <key> <flavor>
Unset flavor properties

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)

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.60. openstack host list

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

Optional arguments

-h, --help
show this help message and exit
--zone <zone>
Only return hosts in the availability zone.

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.61. openstack host show

usage: openstack host show [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] <host>
Show host command

Positional arguments

<host>
Name of host

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.62. openstack hypervisor list

usage: openstack hypervisor list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--matching <hostname>]
List hypervisors

Optional arguments

-h, --help
show this help message and exit
--matching <hostname>
Filter hypervisors using <hostname> substring

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.63. openstack hypervisor show

usage: openstack hypervisor show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <hypervisor>
Display hypervisor details

Positional arguments

<hypervisor>
Hypervisor to display (name or ID)

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.64. openstack hypervisor stats show

usage: openstack hypervisor stats show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX]
Display hypervisor stats details

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.65. openstack image add project

usage: openstack image add project [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--project-domain <project-domain>] <image> <project>
Associate project with image

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.

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.66. openstack image create

usage: openstack image create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--id <id>] [--container-format <container-format>] [--disk-format <disk-format>] [--min-disk <disk-gb>] [--min-ram <ram-mb>] [--file <file>] [--protected | --unprotected] [--public | --private] [--property <key=value>] [--tag <tag>] <image-name>
Create/upload an image

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.67. openstack image delete

usage: openstack image delete [-h] <image> [<image> ...]
Delete image(s)

Positional arguments

<image>
Image(s) to delete (name or ID)

Optional arguments

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

3.3.68. openstack image list

usage: openstack image list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--public | --private | --shared] [--property <key=value>] [--long] [--sort <key>[:<direction>]]
List available images

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.69. openstack image remove project

usage: openstack image remove project [-h] [--project-domain <project-domain>] <image> <project>
Disassociate project with image

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.

3.3.70. openstack image save

usage: openstack image save [-h] [--file <filename>] <image>
Save an image locally

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)

3.3.71. openstack image set

usage: openstack image set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name <name>] [--architecture <architecture>] [--protected | --unprotected] [--public] [--private] [--instance-uuid <instance_uuid>] [--min-disk <disk-gb>] [--kernel-id <kernel-id>] [--os-version <os-version>] [--disk-format <disk-format>] [--os-distro <os-distro>] [--owner <owner>] [--ramdisk-id <ramdisk-id>] [--min-ram <ram-mb>] [--container-format <container-format>] <image>
Set image properties

Positional arguments

<image>
Image to modify (name or ID)

Optional arguments

-h, --help
show this help message and exit
--name <name>
New image name
--architecture <architecture>
Operating system Architecture
--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)
--instance-uuid <instance_uuid>
ID of instance used to create this image
--min-disk <disk-gb>
Minimum disk size needed to boot image, in gigabytes
--kernel-id <kernel-id>
ID of image in Glance that should be used as the kernel when booting an AMI-style image
--os-version <os-version>
Operating system version as specified by the distributor
--disk-format <disk-format>
Format of the disk. Valid values: ['None', 'ami', 'ari', 'aki', 'vhd', 'vmdk', 'raw', 'qcow2', 'vdi', 'iso']
--os-distro <os-distro>
Common name of operating system distribution
--owner <owner>
New Owner of the image
--ramdisk-id <ramdisk-id>
ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image
--min-ram <ram-mb>
Amount of RAM (in MB) required to boot image
--container-format <container-format>
Format of the container. Valid values: ['None', 'ami', 'ari', 'aki', 'bare', 'ovf', 'ova']

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.72. openstack image show

usage: openstack image show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <image>
Display image details

Positional arguments

<image>
Image to display (name or ID)

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.73. openstack ip fixed add

usage: openstack ip fixed add [-h] <network> <server>
Add fixed-ip command

Positional arguments

<network>
Name of the network to fetch an IP address from
<server>
Name of the server to receive the IP address

Optional arguments

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

3.3.74. openstack ip fixed remove

usage: openstack ip fixed remove [-h] <ip-address> <server>
Remove fixed-ip command

Positional arguments

<ip-address>
IP address to remove from server
<server>
Name of the server to remove the IP address from

Optional arguments

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

3.3.75. openstack ip floating add

usage: openstack ip floating add [-h] <ip-address> <server>
Add floating-ip to server

Positional arguments

<ip-address>
IP address to add to server
<server>
Server to receive the IP address (name or ID)

Optional arguments

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

3.3.76. openstack ip floating create

usage: openstack ip floating create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <pool>
Create new floating-ip

Positional arguments

<pool>
Pool to fetch floating IP from

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.77. openstack ip floating delete

usage: openstack ip floating delete [-h] <ip-address>
Delete a floating-ip

Positional arguments

<ip-address>
IP address to delete

Optional arguments

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

3.3.78. openstack ip floating list

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

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.79. openstack ip floating pool list

usage: openstack ip floating pool list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
List floating-ip-pools

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.80. openstack ip floating remove

usage: openstack ip floating remove [-h] <ip-address> <server>
Remove floating-ip from server

Positional arguments

<ip-address>
IP address to remove from server
<server>
Server to remove the IP address from (name or ID)

Optional arguments

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

3.3.81. openstack keypair create

usage: openstack keypair create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--public-key <file>] <name>
Create new public key

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.82. openstack keypair delete

usage: openstack keypair delete [-h] <key>
Delete public key

Positional arguments

<key>
Public key to delete

Optional arguments

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

3.3.83. openstack keypair list

usage: openstack keypair list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
List public key fingerprints

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.84. openstack keypair show

usage: openstack keypair show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--public-key] <key>
Display public key details

Positional arguments

<key>
Public key to display

Optional arguments

-h, --help
show this help message and exit
--public-key
Show only bare public key

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.85. openstack limits show

usage: openstack limits show [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] (--absolute | --rate) [--reserved] [--project <project>] [--domain <domain>]
Show compute and volume limits

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 that owns --project (name or ID) [only valid with --absolute]

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.86. openstack module list

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

Optional arguments

-h, --help
show this help message and exit
--all
Show all modules that have version information

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.87. openstack network create

usage: openstack network create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--enable | --disable] [--share | --no-share] [--project <project>] [--project-domain <project-domain>] <name>
Create new network

Positional arguments

<name>
New network name

Optional arguments

-h, --help
show this help message and exit
--enable
Enable network (default)
--disable
Disable network
--share
Share the network between projects
--no-share
Do not share the network between projects
--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.

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.88. openstack network delete

usage: openstack network delete [-h] <network> [<network> ...]
Delete network(s)

Positional arguments

<network>
Network to delete (name or ID)

Optional arguments

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

3.3.89. openstack network list

usage: openstack network list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--external] [--long]
List networks

Optional arguments

-h, --help
show this help message and exit
--external
List external networks
--long
List additional fields in output

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.90. openstack network set

usage: openstack network set [-h] [--name <name>] [--enable | --disable] [--share | --no-share] <network>
Set network properties

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

3.3.91. openstack network show

usage: openstack network show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <network>
Show network details

Positional arguments

<network>
Network to display (name or ID)

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.92. openstack object create

usage: openstack object create [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] <container> <filename> [<filename> ...]
Upload object to container

Positional arguments

<container>
Container for new object
<filename>
Local filename(s) to upload

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.93. openstack object delete

usage: openstack object delete [-h] <container> <object> [<object> ...]
Delete object from container

Positional arguments

<container>
Delete object(s) from <container>
<object>
Object(s) to delete

Optional arguments

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

3.3.94. openstack object list

usage: openstack object list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--prefix <prefix>] [--delimiter <delimiter>] [--marker <marker>] [--end-marker <end-marker>] [--limit <limit>] [--long] [--all] <container>
List objects

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)

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.95. openstack object save

usage: openstack object save [-h] [--file <filename>] <container> <object>
Save object locally

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)

3.3.96. openstack object show

usage: openstack object show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <container> <object>
Display object details

Positional arguments

<container>
Display <object> from <container>
<object>
Object to display

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.97. openstack overcloud image build

usage: openstack overcloud image build [-h] [--all] [--type <image type>] [--base-image BASE_IMAGE] [--instack-undercloud-elements INSTACK_UNDERCLOUD_ELEMENTS] [--tripleo-puppet-elements TRIPLEO_PUPPET_ELEMENTS] [--elements-path ELEMENTS_PATH] [--tmp-dir TMP_DIR] [--node-arch NODE_ARCH] [--node-dist NODE_DIST] [--registration-method REG_METHOD] [--use-delorean-trunk] [--delorean-trunk-repo DELOREAN_TRUNK_REPO] [--delorean-repo-file DELOREAN_REPO_FILE] [--overcloud-full-dib-extra-args OVERCLOUD_FULL_DIB_EXTRA_ARGS] [--overcloud-full-name OVERCLOUD_FULL_NAME] [--fedora-user-name FEDORA_USER_NAME] [--agent-name AGENT_NAME] [--deploy-name DEPLOY_NAME] [--discovery-name DISCOVERY_NAME] [--agent-image-element AGENT_IMAGE_ELEMENT] [--deploy-image-element DEPLOY_IMAGE_ELEMENT] [--discovery-image-element DISCOVERY_IMAGE_ELEMENT] [--builder <builder>]
Build images for the overcloud

Optional arguments

-h, --help
show this help message and exit
--all
Build all images
--type <image type>
Build image by name. One of agent-ramdisk, deploy- ramdisk, discovery-ramdisk, fedora-user, overcloud- full
--base-image BASE_IMAGE
Image file to use as a base for new images
--instack-undercloud-elements INSTACK_UNDERCLOUD_ELEMENTS
Path to Instack Undercloud elements
--tripleo-puppet-elements TRIPLEO_PUPPET_ELEMENTS
Path to TripleO Puppet elements
--elements-path ELEMENTS_PATH
Full elements path, separated by :
--tmp-dir TMP_DIR
Path to a temporary directory for creating images
--node-arch NODE_ARCH
Architecture of image to build
--node-dist NODE_DIST
Distribution of image to build
--registration-method REG_METHOD
Registration method
--use-delorean-trunk
Use Delorean trunk repo
--delorean-trunk-repo DELOREAN_TRUNK_REPO
URL to Delorean trunk repo
--delorean-repo-file DELOREAN_REPO_FILE
Filename for delorean repo config file
--overcloud-full-dib-extra-args OVERCLOUD_FULL_DIB_EXTRA_ARGS
Extra args for Overcloud Full
--overcloud-full-name OVERCLOUD_FULL_NAME
Name of overcloud full image
--fedora-user-name FEDORA_USER_NAME
Name of Fedora user image
--agent-name AGENT_NAME
Name of the IPA ramdisk image
--deploy-name DEPLOY_NAME
Name of deployment ramdisk image
--discovery-name DISCOVERY_NAME
Name of discovery ramdisk image
--agent-image-element AGENT_IMAGE_ELEMENT
DIB elements for the IPA image
--deploy-image-element DEPLOY_IMAGE_ELEMENT
DIB elements for deploy image
--discovery-image-element DISCOVERY_IMAGE_ELEMENT
DIB elements for discovery image
--builder <builder>
Image builder. One of dib

3.3.98. openstack overcloud image upload

usage: openstack overcloud image upload [-h] [--image-path IMAGE_PATH] [--os-image OS_IMAGE] [--http-boot HTTP_BOOT] [--update-existing]
Create overcloud glance images from existing image files.

Optional arguments

-h, --help
show this help message and exit
--image-path IMAGE_PATH
Path to directory containing image files
--os-image OS_IMAGE
OpenStack disk image filename
--http-boot HTTP_BOOT
Root directory for discovery images
--update-existing
Update images if already exist

3.3.99. openstack overcloud netenv validate

usage: openstack overcloud netenv validate [-h] [-f NETENV]
Validate the network environment file.

Optional arguments

-h, --help
show this help message and exit
-f NETENV, --file NETENV
Path to the network environment file

3.3.100. openstack overcloud node delete

usage: openstack overcloud node delete [-h] [--stack STACK] [--templates [TEMPLATES]] [-e <HEAT ENVIRONMENT FILE>] <node> [<node> ...]
Delete overcloud nodes.

Positional arguments

<node>
Node ID(s) to delete

Optional arguments

-h, --help
show this help message and exit
--stack STACK
Name or ID of heat stack to scale (default=Env: OVERCLOUD_STACK_NAME)
--templates [TEMPLATES]
The directory containing the Heat templates to deploy
-e <HEAT ENVIRONMENT FILE>, --environment-file <HEAT ENVIRONMENT FILE>
Environment files to be passed to the heat stack- create or heat stack-update command. (Can be specified more than once.)

3.3.101. openstack overcloud update stack

usage: openstack overcloud update stack [-h] --templates [TEMPLATES] [-i] [-a] [-e <HEAT ENVIRONMENT FILE>] [stack]
Updates packages on overcloud nodes

Positional arguments

stack
Name or ID of heat stack to scale (default=Env: OVERCLOUD_STACK_NAME)

Optional arguments

-h, --help
show this help message and exit
--templates [TEMPLATES]
The directory containing the Heat templates to deploy
-i, --interactive
-a, --abort
-e <HEAT ENVIRONMENT FILE>, --environment-file <HEAT ENVIRONMENT FILE>
Environment files to be passed to the heat stack- create or heat stack-update command. (Can be specified more than once.)

3.3.102. openstack project create

usage: openstack project create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--description <description>] [--enable | --disable] [--property <key=value>] [--or-show] <project-name>
Create new project

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.103. openstack project delete

usage: openstack project delete [-h] <project> [<project> ...]
Delete project(s)

Positional arguments

<project>
Project(s) to delete (name or ID)

Optional arguments

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

3.3.104. openstack project list

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

Optional arguments

-h, --help
show this help message and exit
--long
List additional fields in output

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.105. openstack project set

usage: openstack project set [-h] [--name <name>] [--description <description>] [--enable | --disable] [--property <key=value>] <project>
Set project properties

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)

3.3.106. openstack project show

usage: openstack project show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <project>
Display project details

Positional arguments

<project>
Project to display (name or ID)

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.107. openstack ptr record list

usage: openstack ptr record list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
List floatingip ptr records

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.108. openstack ptr record set

usage: openstack ptr record set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--description DESCRIPTION | --no-description] [--ttl TTL | --no-ttl] floatingip_id ptrdname
Set floatingip ptr record

Positional arguments

floatingip_id
Floating IP ID
ptrdname
PTRD Name

Optional arguments

-h, --help
show this help message and exit
--description DESCRIPTION
Description
--no-description
--ttl TTL TTL
--no-ttl

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.109. openstack ptr record show

usage: openstack ptr record show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] floatingip_id
Show floatingip ptr record details

Positional arguments

floatingip_id
Floating IP ID

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.110. openstack ptr record unset

usage: openstack ptr record unset [-h] floatingip_id
Unset floatingip ptr record

Positional arguments

floatingip_id
Floating IP ID

Optional arguments

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

3.3.111. openstack quota set

usage: openstack quota set [-h] [--class] [--properties <properties>] [--ram <ram>] [--secgroup-rules <secgroup-rules>] [--instances <instances>] [--key-pairs <key-pairs>] [--fixed-ips <fixed-ips>] [--secgroups <secgroups>] [--injected-file-size <injected-file-size>] [--floating-ips <floating-ips>] [--injected-files <injected-files>] [--cores <cores>] [--injected-path-size <injected-path-size>] [--gigabytes <gigabytes>] [--volumes <volumes>] [--snapshots <snapshots>] [--volume-type <volume-type>] <project/class>
Set quotas for project or class

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
--ram <ram>
New value for the ram quota
--secgroup-rules <secgroup-rules>
New value for the secgroup-rules quota
--instances <instances>
New value for the instances quota
--key-pairs <key-pairs>
New value for the key-pairs quota
--fixed-ips <fixed-ips>
New value for the fixed-ips quota
--secgroups <secgroups>
New value for the secgroups quota
--injected-file-size <injected-file-size>
New value for the injected-file-size quota
--floating-ips <floating-ips>
New value for the floating-ips 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
--volume-type <volume-type>
Set quotas for a specific <volume-type>

3.3.112. openstack quota show

usage: openstack quota show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--class | --default] <project/class>
Show quotas for project or class

Positional arguments

<project/class>
Show this project or class (name/ID)

Optional arguments

-h, --help
show this help message and exit
--class
Show quotas for <class>
--default
Show default quotas for <project>

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.113. openstack recordset create

usage: openstack recordset create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --records RECORDS [RECORDS ...] --type TYPE [--ttl TTL] [--description DESCRIPTION] zone_id name
Create new recordset

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.114. openstack recordset delete

usage: openstack recordset delete [-h] zone_id id
Delete recordset

Positional arguments

zone_id
Zone ID
id
RecordSet ID

Optional arguments

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

3.3.115. openstack recordset list

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

Positional arguments

zone_id
Zone ID

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.116. openstack recordset set

usage: openstack recordset set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name NAME] [--records RECORDS [RECORDS ...]] [--description DESCRIPTION | --no-description] [--ttl TTL | --no-ttl] zone_id id
Set recordset properties

Positional arguments

zone_id
Zone ID
id
RecordSet ID

Optional arguments

-h, --help
show this help message and exit
--name NAME
RecordSet Name
--records RECORDS [RECORDS ...]
Records
--description DESCRIPTION
Description
--no-description
--ttl TTL TTL
--no-ttl

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.117. openstack recordset show

usage: openstack recordset show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] zone_id id
Show recordset details

Positional arguments

zone_id
Zone ID
id
RecordSet ID

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.118. openstack role add

usage: openstack role add [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --project <project> --user <user> <role>
Add role to project:user

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)

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.119. openstack role create

usage: openstack role create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--or-show] <name>
Create new role

Positional arguments

<name>
New role name

Optional arguments

-h, --help
show this help message and exit
--or-show
Return existing role

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.120. openstack role delete

usage: openstack role delete [-h] <role> [<role> ...]
Delete role(s)

Positional arguments

<role>
Role(s) to delete (name or ID)

Optional arguments

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

3.3.121. openstack role list

usage: openstack role list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--project <project>] [--user <user>]
List roles

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)

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.122. openstack role remove

usage: openstack role remove [-h] --project <project> --user <user> <role>
Remove role from project : user

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)

3.3.123. openstack role show

usage: openstack role show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <role>
Display role details

Positional arguments

<role>
Role to display (name or ID)

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.124. openstack security group create

usage: openstack security group create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--description <description>] <name>
Create a new security group

Positional arguments

<name>
New security group name

Optional arguments

-h, --help
show this help message and exit
--description <description>
Security group description

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.125. openstack security group delete

usage: openstack security group delete [-h] <group>
Delete a security group

Positional arguments

<group>
Name or ID of security group to delete

Optional arguments

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

3.3.126. openstack security group list

usage: openstack security group list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--all-projects]
List all security groups

Optional arguments

-h, --help
show this help message and exit
--all-projects
Display information from all projects (admin only)

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.127. openstack security group rule create

usage: openstack security group rule create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--proto <proto>] [--src-ip <ip-address>] [--dst-port <port-range>] <group>
Create a new security group rule

Positional arguments

<group>
Create rule in this security group

Optional arguments

-h, --help
show this help message and exit
--proto <proto> IP
protocol (icmp, tcp, udp; default: tcp)
--src-ip <ip-address>
Source IP (may use CIDR notation; default: 0.0.0.0/0)
--dst-port <port-range>
Destination port, may be a range: 137:139 (default: 0; only required for proto tcp and udp)

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.128. openstack security group rule delete

usage: openstack security group rule delete [-h] <rule>
Delete a security group rule

Positional arguments

<rule>
Security group rule ID to delete

Optional arguments

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

3.3.129. openstack security group rule list

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

Positional arguments

<group>
List all rules in this security group

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.130. openstack security group set

usage: openstack security group set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name <new-name>] [--description <description>] <group>
Set security group properties

Positional arguments

<group>
Name or ID of security group to change

Optional arguments

-h, --help
show this help message and exit
--name <new-name>
New security group name
--description <description>
New security group name

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.131. openstack security group show

usage: openstack security group show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <group>
Show a specific security group

Positional arguments

<group>
Name or ID of security group to change

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.132. openstack server add security group

usage: openstack server add security group [-h] <server> <group>
Add security group to server

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

3.3.133. openstack server add volume

usage: openstack server add volume [-h] [--device <device>] <server> <volume>
Add volume to server

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

3.3.134. openstack server create

usage: openstack server create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] (--image <image> | --volume <volume>) --flavor <flavor> [--security-group <security-group-name>] [--key-name <key-name>] [--property <key=value>] [--file <dest-filename=source-filename>] [--user-data <user-data>] [--availability-zone <zone-name>] [--block-device-mapping <dev-name=mapping>] [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid>] [--hint <key=value>] [--config-drive <config-drive-volume>|True] [--min <count>] [--max <count>] [--wait] <server-name>
Create a new server

Positional arguments

<server-name>
New server name

Optional arguments

-h, --help
show this help message and exit
--image <image>
Create server from this image
--volume <volume>
Create server from this volume
--flavor <flavor>
Create server with this flavor
--security-group <security-group-name>
Security group to assign to this server (repeat for multiple groups)
--key-name <key-name>
Keypair to inject into this server (optional extension)
--property <key=value>
Set a property on this server (repeat for multiple values)
--file <dest-filename=source-filename>
File to inject into image before boot (repeat for 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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.135. openstack server delete

usage: openstack server delete [-h] [--wait] <server> [<server> ...]
Delete server(s)

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

3.3.136. openstack server image create

usage: openstack server image create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name <image-name>] [--wait] <server>
Create a new disk image from a running server

Positional arguments

<server>
Server (name or ID)

Optional arguments

-h, --help
show this help message and exit
--name <image-name>
Name of new image (default is server name)
--wait
Wait for image create to complete

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.137. openstack server list

usage: openstack server list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--reservation-id <reservation-id>] [--ip <ip-address-regex>] [--ip6 <ip-address-regex>] [--name <name-regex>] [--instance-name <server-name>] [--status <status>] [--flavor <flavor>] [--image <image>] [--host <hostname>] [--all-projects] [--project <project>] [--project-domain <project-domain>] [--user <user>] [--user-domain <user-domain>] [--long]
List servers

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
--image <image>
Search by image
--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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.138. openstack server lock

usage: openstack server lock [-h] <server>
Lock a server. A non-admin user will not be able to execute actions

Positional arguments

<server>
Server (name or ID)

Optional arguments

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

3.3.139. openstack server migrate

usage: openstack server migrate [-h] [--live <hostname>] [--shared-migration | --block-migration] [--disk-overcommit | --no-disk-overcommit] [--wait] <server>
Migrate server to different host

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

3.3.140. openstack server pause

usage: openstack server pause [-h] <server>
Pause server

Positional arguments

<server>
Server (name or ID)

Optional arguments

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

3.3.141. openstack server reboot

usage: openstack server reboot [-h] [--hard | --soft] [--wait] <server>
Perform a hard or soft server reboot

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

3.3.142. openstack server rebuild

usage: openstack server rebuild [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --image <image> [--password <password>] [--wait] <server>
Rebuild server

Positional arguments

<server>
Server (name or ID)

Optional arguments

-h, --help
show this help message and exit
--image <image>
Recreate server from this image
--password <password>
Set the password on the rebuilt instance
--wait
Wait for rebuild to complete

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.143. openstack server remove security group

usage: openstack server remove security group [-h] <server> <group>
Remove security group from server

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

3.3.144. openstack server remove volume

usage: openstack server remove volume [-h] <server> <volume>
Remove volume from server

Positional arguments

<server>
Server (name or ID)
<volume>
Volume to remove (name or ID)

Optional arguments

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

3.3.145. openstack server rescue

usage: openstack server rescue [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <server>
Put server in rescue mode

Positional arguments

<server>
Server (name or ID)

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.146. openstack server resize

usage: openstack server resize [-h] [--flavor <flavor> | --confirm | --revert] [--wait] <server>
Scale server to a new flavor

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

3.3.147. openstack server resume

usage: openstack server resume [-h] <server>
Resume server

Positional arguments

<server>
Server (name or ID)

Optional arguments

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

3.3.148. openstack server set

usage: openstack server set [-h] [--name <new-name>] [--root-password] [--property <key=value>] <server>
Set server properties

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)

3.3.149. openstack server show

usage: openstack server show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--diagnostics] <server>
Show server details

Positional arguments

<server>
Server (name or ID)

Optional arguments

-h, --help
show this help message and exit
--diagnostics
Display server diagnostics information

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.150. 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>
Ssh to 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)

3.3.151. openstack server suspend

usage: openstack server suspend [-h] <server>
Suspend server

Positional arguments

<server>
Server (name or ID)

Optional arguments

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

3.3.152. openstack server unlock

usage: openstack server unlock [-h] <server>
Unlock server

Positional arguments

<server>
Server (name or ID)

Optional arguments

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

3.3.153. openstack server unpause

usage: openstack server unpause [-h] <server>
Unpause server

Positional arguments

<server>
Server (name or ID)

Optional arguments

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

3.3.154. openstack server unrescue

usage: openstack server unrescue [-h] <server>
Restore server from rescue mode

Positional arguments

<server>
Server (name or ID)

Optional arguments

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

3.3.155. openstack server unset

usage: openstack server unset [-h] [--property <key>] <server>
Unset server properties

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 to unset multiple values)

3.3.156. openstack service create

usage: openstack service create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name <name>] [--description <description>] <type>
Create new service

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.157. openstack service delete

usage: openstack service delete [-h] <service>
Delete service

Positional arguments

<service>
Service to delete (name or ID)

Optional arguments

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

3.3.158. openstack service list

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

Optional arguments

-h, --help
show this help message and exit
--long
List additional fields in output

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.159. openstack service show

usage: openstack service show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--catalog] <service>
Display service details

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.160. openstack snapshot create

usage: openstack snapshot create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --name <name> [--description <description>] [--force] <volume>
Create new snapshot

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.161. openstack snapshot delete

usage: openstack snapshot delete [-h] <snapshot> [<snapshot> ...]
Delete snapshot(s)

Positional arguments

<snapshot>
Snapshot(s) to delete (name or ID)

Optional arguments

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

3.3.162. openstack snapshot list

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

Optional arguments

-h, --help
show this help message and exit
--long
List additional fields in output

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.163. openstack snapshot set

usage: openstack snapshot set [-h] [--name <name>] [--description <description>] [--property <key=value>] <snapshot>
Set snapshot properties

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)

3.3.164. openstack snapshot show

usage: openstack snapshot show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <snapshot>
Display snapshot details

Positional arguments

<snapshot>
Snapshot to display (name or ID)

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.165. openstack snapshot unset

usage: openstack snapshot unset [-h] --property <key> <snapshot>
Unset snapshot properties

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 to remove multiple values)

3.3.166. openstack tld create

usage: openstack tld create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --name NAME [--description DESCRIPTION]
Create new tld

Optional arguments

-h, --help
show this help message and exit
--name NAME TLD
Name
--description DESCRIPTION
Description

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.167. openstack tld delete

usage: openstack tld delete [-h] id
Delete tld

Positional arguments

id
TLD ID

Optional arguments

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

3.3.168. openstack tld list

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

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.169. openstack tld set

usage: openstack tld set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name NAME] [--description DESCRIPTION | --no-description] id
Set tld properties

Positional arguments

id
TLD ID

Optional arguments

-h, --help
show this help message and exit
--name NAME TLD
Name
--description DESCRIPTION
Description
--no-description

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.170. openstack tld show

usage: openstack tld show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id
Show tld details

Positional arguments

id
TLD ID

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.171. openstack token issue

usage: openstack token issue [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX]
Issue new token

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.172. openstack token revoke

usage: openstack token revoke [-h] <token>
Revoke existing token

Positional arguments

<token>
Token to be deleted

Optional arguments

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

3.3.173. openstack undercloud install

usage: openstack undercloud install [-h]
Install and setup the undercloud

Optional arguments

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

3.3.174. openstack usage list

usage: openstack usage list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--start <start>] [--end <end>]
List resource usage per project

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)

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.175. openstack usage show

usage: openstack usage show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--project <project>] [--start <start>] [--end <end>]
Show resource usage for a single project

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)

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.176. openstack user create

usage: openstack user create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--project <project>] [--password <password>] [--password-prompt] [--email <email-address>] [--enable | --disable] [--or-show] <name>
Create new user

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.177. openstack user delete

usage: openstack user delete [-h] <user> [<user> ...]
Delete user(s)

Positional arguments

<user>
User(s) to delete (name or ID)

Optional arguments

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

3.3.178. openstack user list

usage: openstack user list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--project <project>] [--long]
List users

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.179. openstack user role list

usage: openstack user role list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--project <project>] [<user>]
List user-role assignments

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)

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.180. openstack user set

usage: openstack user set [-h] [--name <name>] [--project <project>] [--password <user-password>] [--password-prompt] [--email <email-address>] [--enable | --disable] <user>
Set user properties

Positional arguments

<user>
User to change (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

3.3.181. openstack user show

usage: openstack user show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <user>
Display user details

Positional arguments

<user>
User to display (name or ID)

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.182. openstack volume create

usage: openstack volume create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --size <size> [--snapshot <snapshot>] [--description <description>] [--type <volume-type>] [--user <user>] [--project <project>] [--availability-zone <availability-zone>] [--image <image>] [--source <volume>] [--property <key=value>] <name>
Create new volume

Positional arguments

<name>
New volume name

Optional arguments

-h, --help
show this help message and exit
--size <size>
New volume size in GB
--snapshot <snapshot>
Use <snapshot> as source of new volume
--description <description>
New volume description
--type <volume-type>
Use <volume-type> as the new volume type
--user <user>
Specify an alternate user (name or ID)
--project <project>
Specify an alternate project (name or ID)
--availability-zone <availability-zone>
Create new volume in <availability-zone>
--image <image>
Use <image> as source of new volume (name or ID)
--source <volume>
Volume to clone (name or ID)
--property <key=value>
Set a property on this volume (repeat option to set multiple properties)

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.183. openstack volume delete

usage: openstack volume delete [-h] [--force] <volume> [<volume> ...]
Delete volume(s)

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)

3.3.184. openstack volume list

usage: openstack volume list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--status <status>] [--name <name>] [--all-projects] [--long]
List volumes

Optional arguments

-h, --help
show this help message and exit
--status <status>
Filter results by status
--name <name>
Filter results by name
--all-projects
Include all projects (admin only)
--long
List additional fields in output

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.185. openstack volume qos associate

usage: openstack volume qos associate [-h] <qos-spec> <volume-type>
Associate a QoS specification to a 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

3.3.186. openstack volume qos create

usage: openstack volume qos create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--consumer <consumer>] [--property <key=value>] <name>
Create new QoS specification

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)

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.187. openstack volume qos delete

usage: openstack volume qos delete [-h] <qos-spec> [<qos-spec> ...]
Delete QoS specification

Positional arguments

<qos-spec>
QoS specification(s) to delete (name or ID)

Optional arguments

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

3.3.188. openstack volume qos disassociate

usage: openstack volume qos disassociate [-h] [--volume-type <volume-type> | --all] <qos-spec>
Disassociate a QoS specification from a volume type

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

3.3.189. openstack volume qos list

usage: openstack volume qos list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
List QoS specifications

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.190. openstack volume qos set

usage: openstack volume qos set [-h] [--property <key=value>] <qos-spec>
Set QoS specification properties

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)

3.3.191. openstack volume qos show

usage: openstack volume qos show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <qos-spec>
Display QoS specification details

Positional arguments

<qos-spec>
QoS specification to display (name or ID)

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.192. openstack volume qos unset

usage: openstack volume qos unset [-h] [--property <key>] <qos-spec>
Unset QoS specification properties

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)

3.3.193. openstack volume set

usage: openstack volume set [-h] [--name <name>] [--description <description>] [--size <size>] [--property <key=value>] <volume>
Set volume properties

Positional arguments

<volume>
Volume to change (name or ID)

Optional arguments

-h, --help
show this help message and exit
--name <name>
New volume name
--description <description>
New volume description
--size <size>
Extend volume size in GB
--property <key=value>
Property to add or modify for this volume (repeat option to set multiple properties)

3.3.194. openstack volume show

usage: openstack volume show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <volume>
Show volume details

Positional arguments

<volume>
Volume to display (name or ID)

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.195. openstack volume type create

usage: openstack volume type create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--property <key=value>] <name>
Create new volume type

Positional arguments

<name>
New volume type name

Optional arguments

-h, --help
show this help message and exit
--property <key=value>
Property to add for this volume type (repeat option to set multiple properties)

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.196. openstack volume type delete

usage: openstack volume type delete [-h] <volume-type>
Delete volume type

Positional arguments

<volume-type>
Volume type to delete (name or ID)

Optional arguments

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

3.3.197. openstack volume type list

usage: openstack volume type list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long]
List volume types

Optional arguments

-h, --help
show this help message and exit
--long
List additional fields in output

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.198. openstack volume type set

usage: openstack volume type set [-h] [--property <key=value>] <volume-type>
Set volume type properties

Positional arguments

<volume-type>
Volume type 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 volume type (repeat option to set multiple properties)

3.3.199. openstack volume type show

usage: openstack volume type show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <volume-type>
Display volume type details

Positional arguments

<volume-type>
Volume type to display (name or ID)

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.200. openstack volume type unset

usage: openstack volume type unset [-h] --property <key> <volume-type>
Unset volume type properties

Positional arguments

<volume-type>
Volume type to modify (name or ID)

Optional arguments

-h, --help
show this help message and exit
--property <key>
Property to remove from volume type (repeat option to remove multiple properties)

3.3.201. openstack volume unset

usage: openstack volume unset [-h] --property <key> <volume>
Unset volume properties

Positional arguments

<volume>
Volume to modify (name or ID)

Optional arguments

-h, --help
show this help message and exit
--property <key>
Property to remove from volume (repeat option to remove multiple properties)

3.3.202. openstack zone abandon

usage: openstack zone abandon [-h] id
Abandon a zone

Positional arguments

id
Zone ID

Optional arguments

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

3.3.203. openstack zone axfr

usage: openstack zone axfr [-h] id
AXFR a zone

Positional arguments

id
Zone ID

Optional arguments

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

3.3.204. openstack zone blacklist create

usage: openstack zone blacklist create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --pattern PATTERN [--description DESCRIPTION]
Create new blacklist

Optional arguments

-h, --help
show this help message and exit
--pattern PATTERN
Blacklist pattern
--description DESCRIPTION
Description

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.205. openstack zone blacklist delete

usage: openstack zone blacklist delete [-h] id
Delete blacklist

Positional arguments

id
Blacklist ID

Optional arguments

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

3.3.206. openstack zone blacklist list

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

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.207. openstack zone blacklist set

usage: openstack zone blacklist set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --pattern PATTERN [--description DESCRIPTION | --no-description] id
Set blacklist properties

Positional arguments

id
Blacklist ID

Optional arguments

-h, --help
show this help message and exit
--pattern PATTERN
Blacklist pattern
--description DESCRIPTION
Description
--no-description

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.208. openstack zone blacklist show

usage: openstack zone blacklist show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id
Show blacklist details

Positional arguments

id
Blacklist ID

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.209. openstack zone create

usage: openstack zone create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--email EMAIL] [--type TYPE] [--ttl TTL] [--description DESCRIPTION] [--masters MASTERS [MASTERS ...]] name
Create new zone

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.210. openstack zone delete

usage: openstack zone delete [-h] id
Delete zone

Positional arguments

id
Zone ID

Optional arguments

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

3.3.211. openstack zone list

usage: openstack zone list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--type TYPE]
List zones

Optional arguments

-h, --help
show this help message and exit
--type TYPE
Zone Type

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.212. openstack zone set

usage: openstack zone set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name NAME] [--email EMAIL] [--ttl TTL] [--description DESCRIPTION | --no-description] [--masters MASTERS [MASTERS ...]] id
Set zone properties

Positional arguments

id
Zone ID

Optional arguments

-h, --help
show this help message and exit
--name NAME
Zone Name
--email EMAIL
Zone Email
--ttl TTL
Time To Live (Seconds)
--description DESCRIPTION
Description
--no-description
--masters MASTERS [MASTERS ...]
Zone Masters

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.213. openstack zone show

usage: openstack zone show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id
Show zone details

Positional arguments

id
Zone ID

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.214. openstack zone transfer accept request

usage: openstack zone transfer accept request [-h] --transfer-id TRANSFER_ID --key KEY
Accept a Zone Transfer Request

Optional arguments

-h, --help
show this help message and exit
--transfer-id TRANSFER_ID
Transfer ID
--key KEY
Transfer Key

3.3.215. openstack zone transfer accept show

usage: openstack zone transfer accept show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id
Show Zone Transfer Accept

Positional arguments

id
Zone Tranfer Accept ID

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.216. openstack zone transfer request create

usage: openstack zone transfer request create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --target-project-id TARGET_PROJECT_ID [--description DESCRIPTION] zone_id
Create new zone transfer request

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

3.3.217. openstack zone transfer request delete

usage: openstack zone transfer request delete [-h] id

Positional arguments

id
Zone Transfer ID

Optional arguments

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

3.3.218. openstack zone transfer request list

usage: openstack zone transfer request list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
List zone transfer requests

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

3.3.219. openstack zone transfer request set

usage: openstack zone transfer request set [-h] [--description DESCRIPTION | --no-description] id
Set Transfer

Positional arguments

id
Zone Transfer ID

Optional arguments

-h, --help
show this help message and exit
--description DESCRIPTION
Description
--no-description

3.3.220. openstack zone transfer request show

usage: openstack zone transfer request show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id
Show zonet transfer details

Positional arguments

id
Zone Tranfer ID

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

Chapter 4. Configuration file editor

The openstack-config client is the command-line interface (CLI) for the and its extensions. This chapter documents openstack-config version 0.5.
For help on a specific openstack-config command, enter:
$ openstack-config help COMMAND

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

4.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 5. Block Storage service command-line client

The cinder client is the command-line interface (CLI) for the Block Storage service API and its extensions. This chapter documents cinder version 1.4.0.
For help on a specific cinder command, enter:
$ cinder help COMMAND

5.1. cinder usage

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

Subcommands

absolute-limits
Lists absolute limits for a user.
availability-zone-list
Lists all availability zones.
backup-create
Creates a volume backup.
backup-delete
Removes a backup.
backup-export
Export backup metadata record.
backup-import
Import backup metadata record.
backup-list
Lists all backups.
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.
force-delete
Attempts force-delete of volume, regardless of state.
get-capabilities
Show backend volume stats and properties. Admin only.
get-pools
Show pool information for backends. Admin only.
image-metadata
Sets or deletes volume image metadata.
list
Lists all volumes.
manage
Manage an existing volume.
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-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.
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 a volume type.
type-key
Sets or unsets extra_spec for a volume type.
type-list
Lists available 'volume types'. (Admin only will see private types)
type-update
Updates volume type name and/or description.
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.

5.2. cinder optional arguments

--version
show program's version number and exit
-d, --debug
Shows debugging output.
--os-auth-system <auth-system>
Defaults to env[OS_AUTH_SYSTEM].
--service-type <service-type>
Service type. For most actions, default is volume.
--service-name <service-name>
Service name. Default=env[CINDER_SERVICE_NAME].
--volume-service-name <volume-service-name>
Volume service name. Default=env[CINDER_VOLUME_SERVICE_NAME].
--endpoint-type <endpoint-type>
DEPRECATED! Use --os-endpoint-type.
--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.
--os-volume-api-version <volume-api-ver>
Block Storage API version. Valid values are 1 or 2. Default=env[OS_VOLUME_API_VERSION].
--bypass-url <bypass-url>
Use this API endpoint instead of the Service Catalog. Defaults to env[CINDERCLIENT_BYPASS_URL]
--retries <retries>
Number of retries.
--profile HMAC_KEY
HMAC key to use for encrypting context data for performance profiling of operation. This key needs to match the one configured on the cinder api server. Without key the profiling will not be triggered even if osprofiler is enabled on server side.
--os-auth-strategy <auth-strategy>
Authentication strategy (Env: OS_AUTH_STRATEGY, default keystone). For now, any other value will disable the authentication
--os-username <auth-user-name>
OpenStack user name. Default=env[OS_USERNAME].
--os-password <auth-password>
Password for OpenStack user. Default=env[OS_PASSWORD].
--os-tenant-name <auth-tenant-name>
Tenant name. Default=env[OS_TENANT_NAME].
--os-tenant-id <auth-tenant-id>
ID for the tenant. Default=env[OS_TENANT_ID].
--os-auth-url <auth-url>
URL for the authentication service. Default=env[OS_AUTH_URL].
--os-user-id <auth-user-id>
Authentication user ID (Env: OS_USER_ID)
--os-user-domain-id <auth-user-domain-id>
OpenStack user domain ID. Defaults to env[OS_USER_DOMAIN_ID].
--os-user-domain-name <auth-user-domain-name>
OpenStack user domain name. Defaults to env[OS_USER_DOMAIN_NAME].
--os-project-id <auth-project-id>
Another way to specify tenant ID. This option is mutually exclusive with --os-tenant-id. Defaults to env[OS_PROJECT_ID].
--os-project-name <auth-project-name>
Another way to specify tenant name. This option is mutually exclusive with --os-tenant-name. Defaults to env[OS_PROJECT_NAME].
--os-project-domain-id <auth-project-domain-id>
Defaults to env[OS_PROJECT_DOMAIN_ID].
--os-project-domain-name <auth-project-domain-name>
Defaults to env[OS_PROJECT_DOMAIN_NAME].
--os-region-name <region-name>
Region name. Default=env[OS_REGION_NAME].
--os-token <token>
Defaults to env[OS_TOKEN]
--os-url <url>
Defaults to env[OS_URL]
--insecure
Explicitly allow client to perform "insecure" TLS (https) requests. The server's certificate will not be verified against any certificate authorities. This option should be used with caution.
--os-cacert <ca-certificate>
Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to env[OS_CACERT].
--os-cert <certificate>
Defaults to env[OS_CERT].
--os-key <key>
Defaults to env[OS_KEY].
--timeout <seconds>
Set request timeout (in seconds).

5.3. Block Storage API v1 commands (DEPRECATED)

5.3.1. cinder absolute-limits

usage: cinder absolute-limits
Lists absolute limits for a user.

5.3.2. cinder availability-zone-list

usage: cinder availability-zone-list
Lists all availability zones.

5.3.3. cinder backup-create

usage: cinder backup-create [--container <container>] [--name <name>] [--description <description>] [--incremental] [--force] <volume>
Creates a volume backup.

Positional arguments

<volume>
Name or ID of volume to backup.

Optional arguments

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

5.3.4. cinder backup-delete

usage: cinder backup-delete <backup>
Removes a backup.

Positional arguments

<backup>
Name or ID of backup to delete.

5.3.5. cinder backup-export

usage: cinder backup-export <backup>
Export backup metadata record.

Positional arguments

<backup>
ID of the backup to export.

5.3.6. cinder backup-import

usage: cinder backup-import <backup_service> <backup_url>
Import backup metadata record.

Positional arguments

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

5.3.7. cinder backup-list

usage: cinder backup-list [--all-tenants [<all_tenants>]] [--name <name>] [--status <status>] [--volume-id <volume-id>]
Lists all backups.

Optional arguments

--all-tenants [<all_tenants>]
Shows details for all tenants. Admin only.
--name <name>
Filters results by a name. Default=None.
--status <status>
Filters results by a status. Default=None.
--volume-id <volume-id>
Filters results by a volume ID. Default=None.

5.3.8. cinder backup-restore

usage: cinder backup-restore [--volume <volume>] <backup>
Restores a backup.

Positional arguments

<backup>
ID of backup to restore.

Optional arguments

--volume <volume>
Name or ID of volume to which to restore. Default=None.

5.3.9. cinder backup-show

usage: cinder backup-show <backup>
Shows backup details.

Positional arguments

<backup>
Name or ID of backup.

5.3.10. cinder cgsnapshot-create

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

Positional arguments

<consistencygroup>
Name or ID of a consistency group.

Optional arguments

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

5.3.11. cinder cgsnapshot-delete

usage: cinder cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]
Removes one or more cgsnapshots.

Positional arguments

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

5.3.12. cinder cgsnapshot-list

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

Optional arguments

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

5.3.13. cinder cgsnapshot-show

usage: cinder cgsnapshot-show <cgsnapshot>
Shows cgsnapshot details.

Positional arguments

<cgsnapshot>
Name or ID of cgsnapshot.

5.3.14. cinder consisgroup-create

usage: cinder consisgroup-create [--name <name>] [--description <description>] [--availability-zone <availability-zone>] <volume-types>
Creates a consistency group.

Positional arguments

<volume-types>
Volume types.

Optional arguments

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

5.3.15. cinder consisgroup-create-from-src

usage: cinder consisgroup-create-from-src [--cgsnapshot <cgsnapshot>] [--source-cg <source-cg>] [--name <name>] [--description <description>]
Creates a consistency group from a cgsnapshot or a source CG.

Optional arguments

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

5.3.16. cinder consisgroup-delete

usage: cinder consisgroup-delete [--force] <consistencygroup> [<consistencygroup> ...]
Removes one or more consistency groups.

Positional arguments

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

Optional arguments

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

5.3.17. cinder consisgroup-list

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

Optional arguments

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

5.3.18. cinder consisgroup-show

usage: cinder consisgroup-show <consistencygroup>
Shows details of a consistency group.

Positional arguments

<consistencygroup>
Name or ID of a consistency group.

5.3.19. cinder consisgroup-update

usage: cinder consisgroup-update [--name <name>] [--description <description>] [--add-volumes <uuid1,uuid2,......>] [--remove-volumes <uuid3,uuid4,......>] <consistencygroup>
Updates a 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.

5.3.20. cinder create

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

Positional arguments

<size>
Size of volume, in GBs. (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

5.3.21. cinder credentials

usage: cinder credentials
Shows user credentials returned from auth.

5.3.22. cinder delete

usage: cinder delete <volume> [<volume> ...]
Removes one or more volumes.

Positional arguments

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

5.3.23. cinder encryption-type-create

usage: cinder encryption-type-create [--cipher <cipher>] [--key_size <key_size>] [--control_location <control_location>] <volume_type> <provider>
Creates encryption type for a volume type. Admin only.

Positional arguments

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

Optional arguments

--cipher <cipher>
The encryption algorithm or mode. For example, aes- xts-plain64. Default=None.
--key_size <key_size>
Size of encryption key, in bits. For example, 128 or 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."

5.3.24. cinder encryption-type-delete

usage: cinder encryption-type-delete <volume_type>
Deletes encryption type for a volume type. Admin only.

Positional arguments

<volume_type>
Name or ID of volume type.

5.3.25. cinder encryption-type-list

usage: cinder encryption-type-list
Shows encryption type details for volume types. Admin only.

5.3.26. cinder encryption-type-show

usage: cinder encryption-type-show <volume_type>
Shows encryption type details for a volume type. Admin only.

Positional arguments

<volume_type>
Name or ID of volume type.

5.3.27. cinder encryption-type-update

usage: cinder encryption-type-update [--provider <provider>] [--cipher [<cipher>]] [--key-size [<key-size>]] [--control-location <control-location>] <volume-type>
Update encryption type information for a volume type (Admin Only).

Positional arguments

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

Optional arguments

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

5.3.28. cinder endpoints

usage: cinder endpoints
Discovers endpoints registered by authentication service.

5.3.29. cinder extend

usage: cinder extend <volume> <new_size>
Attempts to extend size of an existing volume.

Positional arguments

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

5.3.30. cinder extra-specs-list

usage: cinder extra-specs-list
Lists current volume types and extra specs.

5.3.31. cinder force-delete

usage: cinder force-delete <volume> [<volume> ...]
Attempts force-delete of volume, regardless of state.

Positional arguments

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

5.3.32. cinder get-capabilities

usage: cinder get-capabilities <host>
Show backend volume stats and properties. Admin only.

Positional arguments

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

5.3.33. cinder get-pools

usage: cinder get-pools [--detail]
Show pool information for backends. Admin only.

Optional arguments

--detail
Show detailed information about pools.

5.3.34. cinder image-metadata

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

Positional arguments

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

5.3.35. cinder list

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

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.
--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.
--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. Default=None.
--tenant [<tenant>]
Display information from single tenant (Admin only).

5.3.36. cinder list-extensions

usage: cinder list-extensions
Lists all available os-api extensions.

5.3.37. cinder manage

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

Positional arguments

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

Optional arguments

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

5.3.38. cinder metadata

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

Positional arguments

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

5.3.39. cinder metadata-show

usage: cinder metadata-show <volume>
Shows volume metadata.

Positional arguments

<volume>
ID of volume.

5.3.40. cinder metadata-update-all

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

Positional arguments

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

5.3.41. cinder migrate

usage: cinder migrate [--force-host-copy [<True|False>]] [--lock-volume [<True|False>]] <volume> <host>
Migrates volume to a new host.

Positional arguments

<volume>
ID of volume to migrate.
<host>
Destination host.

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.

5.3.42. cinder qos-associate

usage: cinder qos-associate <qos_specs> <volume_type_id>
Associates qos specs with specified volume type.

Positional arguments

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

5.3.43. cinder qos-create

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

Positional arguments

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

5.3.44. cinder qos-delete

usage: cinder qos-delete [--force [<True|False>]] <qos_specs>
Deletes a specified qos specs.

Positional arguments

<qos_specs>
ID of QoS specifications to delete.

Optional arguments

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

5.3.45. cinder qos-disassociate

usage: cinder qos-disassociate <qos_specs> <volume_type_id>
Disassociates qos specs from specified volume type.

Positional arguments

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

5.3.46. cinder qos-disassociate-all

usage: cinder qos-disassociate-all <qos_specs>
Disassociates qos specs from all its associations.

Positional arguments

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

5.3.47. cinder qos-get-association

usage: cinder qos-get-association <qos_specs>
Lists all associations for specified qos specs.

Positional arguments

<qos_specs>
ID of QoS specifications.

5.3.48. cinder qos-key

usage: cinder qos-key <qos_specs> <action> key=value [key=value ...]
Sets or unsets specifications for a qos spec.

Positional arguments

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

5.3.49. cinder qos-list

usage: cinder qos-list
Lists qos specs.

5.3.50. cinder qos-show

usage: cinder qos-show <qos_specs>
Shows qos specs details.

Positional arguments

<qos_specs>
ID of QoS specifications to show.

5.3.51. cinder quota-class-show

usage: cinder quota-class-show <class>
Lists quotas for a quota class.

Positional arguments

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

5.3.52. cinder quota-class-update

usage: cinder quota-class-update [--volumes <volumes>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--volume-type <volume_type_name>] <class_name>
Updates quotas for a quota class.

Positional arguments

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

Optional arguments

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

5.3.53. cinder quota-defaults

usage: cinder quota-defaults <tenant_id>
Lists default quotas for a tenant.

Positional arguments

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

5.3.54. cinder quota-delete

usage: cinder quota-delete <tenant_id>
Delete the quotas for a tenant.

Positional arguments

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

5.3.55. cinder quota-show

usage: cinder quota-show <tenant_id>
Lists quotas for a tenant.

Positional arguments

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

5.3.56. cinder quota-update

usage: cinder quota-update [--volumes <volumes>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--backups <backups>] [--backup-gigabytes <backup_gigabytes>] [--consistencygroups <consistencygroups>] [--volume-type <volume_type_name>] [--per-volume-gigabytes <per_volume_gigabytes>] <tenant_id>
Updates quotas for a tenant.

Positional arguments

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

Optional arguments

--volumes <volumes>
The new "volumes" quota value. Default=None.
--snapshots <snapshots>
The new "snapshots" quota value. Default=None.
--gigabytes <gigabytes>
The new "gigabytes" quota value. Default=None.
--backups <backups>
The new "backups" quota value. Default=None.
--backup-gigabytes <backup_gigabytes>
The new "backup_gigabytes" quota value. Default=None.
--consistencygroups <consistencygroups>
The new "consistencygroups" quota value. Default=None.
--volume-type <volume_type_name>
Volume type. Default=None.
--per-volume-gigabytes <per_volume_gigabytes>
Set max volume size limit. Default=None.

5.3.57. cinder quota-usage

usage: cinder quota-usage <tenant_id>
Lists quota usage for a tenant.

Positional arguments

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

5.3.58. cinder rate-limits

usage: cinder rate-limits
Lists rate limits for a user.

5.3.59. cinder readonly-mode-update

usage: cinder readonly-mode-update <volume> <True|true|False|false>
Updates volume read-only access-mode flag.

Positional arguments

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

5.3.60. cinder rename

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

Positional arguments

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

Optional arguments

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

5.3.61. cinder replication-promote

usage: cinder replication-promote <volume>
Promote a secondary volume to primary for a relationship.

Positional arguments

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

5.3.62. cinder replication-reenable

usage: cinder replication-reenable <volume>
Sync the secondary volume with primary for a relationship.

Positional arguments

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

5.3.63. cinder reset-state

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

Positional arguments

<volume>
Name or ID of volume to modify.

Optional arguments

--state <state>
The state to assign to the volume. Valid values are "available", "error", "creating", "deleting", "in- use", "attaching", "detaching", "error_deleting" and "maintenance". NOTE: This command simply changes the state of the Volume in the DataBase with no regard to actual status, exercise caution when using. Default=available.
--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.

5.3.64. cinder retype

usage: cinder retype [--migration-policy <never|on-demand>] <volume> <volume-type>
Changes the volume type for a volume.

Positional arguments

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

Optional arguments

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

5.3.65. cinder service-disable

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

Positional arguments

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

Optional arguments

--reason <reason>
Reason for disabling service.

5.3.66. cinder service-enable

usage: cinder service-enable <hostname> <binary>
Enables the service.

Positional arguments

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

5.3.67. cinder service-list

usage: cinder service-list [--host <hostname>] [--binary <binary>]
Lists all services. Filter by host and service binary.

Optional arguments

--host <hostname>
Host name. Default=None.
--binary <binary>
Service binary. Default=None.

5.3.68. cinder set-bootable

usage: cinder set-bootable <volume> <True|true|False|false>
Update bootable status of a volume.

Positional arguments

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

5.3.69. cinder show

usage: cinder show <volume>
Shows volume details.

Positional arguments

<volume>
Name or ID of volume.

5.3.70. cinder snapshot-create

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

Positional arguments

<volume>
Name or ID of volume to snapshot.

Optional arguments

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

5.3.71. cinder snapshot-delete

usage: cinder snapshot-delete <snapshot> [<snapshot> ...]
Removes one or more snapshots.

Positional arguments

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

5.3.72. cinder snapshot-list

usage: cinder snapshot-list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] [--volume-id <volume-id>]
Lists all snapshots.

Optional arguments

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

5.3.73. cinder snapshot-metadata

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

Positional arguments

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

5.3.74. cinder snapshot-metadata-show

usage: cinder snapshot-metadata-show <snapshot>
Shows snapshot metadata.

Positional arguments

<snapshot>
ID of snapshot.

5.3.75. cinder snapshot-metadata-update-all

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

Positional arguments

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

5.3.76. cinder snapshot-rename

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

Positional arguments

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

Optional arguments

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

5.3.77. cinder snapshot-reset-state

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

Positional arguments

<snapshot>
Name or ID of snapshot to modify.

Optional arguments

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

5.3.78. cinder snapshot-show

usage: cinder snapshot-show <snapshot>
Shows snapshot details.

Positional arguments

<snapshot>
Name or ID of snapshot.

5.3.79. cinder transfer-accept

usage: cinder transfer-accept <transfer> <auth_key>
Accepts a volume transfer.

Positional arguments

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

5.3.80. cinder transfer-create

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

Positional arguments

<volume>
Name or ID of volume to transfer.

Optional arguments

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

5.3.81. cinder transfer-delete

usage: cinder transfer-delete <transfer>
Undoes a transfer.

Positional arguments

<transfer>
Name or ID of transfer to delete.

5.3.82. cinder transfer-list

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

Optional arguments

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

5.3.83. cinder transfer-show

usage: cinder transfer-show <transfer>
Shows transfer details.

Positional arguments

<transfer>
Name or ID of transfer to accept.

5.3.84. cinder type-access-add

usage: cinder type-access-add --volume-type <volume_type> --project-id <project_id>
Adds volume type access for the given project.

Optional arguments

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

5.3.85. cinder type-access-list

usage: cinder type-access-list --volume-type <volume_type>
Print access information about the given volume type.

Optional arguments

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

5.3.86. cinder type-access-remove

usage: cinder type-access-remove --volume-type <volume_type> --project-id <project_id>
Removes volume type access for the given project.

Optional arguments

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

5.3.87. cinder type-create

usage: cinder type-create [--description <description>] [--is-public <is-public>] <name>
Creates a volume type.

Positional arguments

<name>
Name of new volume type.

Optional arguments

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

5.3.88. cinder type-default

usage: cinder type-default
List the default volume type.

5.3.89. cinder type-delete

usage: cinder type-delete <id>
Deletes a volume type.

Positional arguments

<id>
ID of volume type to delete.

5.3.90. cinder type-key

usage: cinder type-key <vtype> <action> <key=value> [<key=value> ...]
Sets or unsets extra_spec for a volume type.

Positional arguments

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

5.3.91. cinder type-list

usage: cinder type-list
Lists available 'volume types'. (Admin only will see private types)

5.3.92. cinder type-update

usage: cinder type-update [--name <name>] [--description <description>] <id>
Updates volume type name and/or description.

Positional arguments

<id>
ID of the volume type.

Optional arguments

--name <name>
Name of the volume type.
--description <description>
Description of the volume type.

5.3.93. cinder unmanage

usage: cinder unmanage <volume>
Stop managing a volume.

Positional arguments

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

5.3.94. cinder upload-to-image

usage: cinder upload-to-image [--force [<True|False>]] [--container-format <container-format>] [--disk-format <disk-format>] <volume> <image-name>
Uploads volume to Image Service as an image.

Positional arguments

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

Optional arguments

--force [<True|False>]
Enables or disables upload of a volume that is attached to an instance. Default=False.
--container-format <container-format>
Container format type. Default is bare.
--disk-format <disk-format>
Disk format type. Default is raw.

5.4. Block Storage API v2 commands

You can select an API version to use by adding the --os-volume-api-version parameter or by setting the corresponding environment variable:
$ export OS_VOLUME_API_VERSION=2

5.4.1. cinder absolute-limits (v2)

usage: cinder --os-volume-api-version 2 absolute-limits
Lists absolute limits for a user.

5.4.2. cinder availability-zone-list (v2)

usage: cinder --os-volume-api-version 2 availability-zone-list
Lists all availability zones.

5.4.3. cinder backup-create (v2)

usage: cinder --os-volume-api-version 2 backup-create [--container <container>] [--name <name>] [--description <description>] [--incremental] [--force] <volume>
Creates a volume backup.

Positional arguments

<volume>
Name or ID of volume to backup.

Optional arguments

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

5.4.4. cinder backup-delete (v2)

usage: cinder --os-volume-api-version 2 backup-delete <backup>
Removes a backup.

Positional arguments

<backup>
Name or ID of backup to delete.

5.4.5. cinder backup-export (v2)

usage: cinder --os-volume-api-version 2 backup-export <backup>
Export backup metadata record.

Positional arguments

<backup>
ID of the backup to export.

5.4.6. cinder backup-import (v2)

usage: cinder --os-volume-api-version 2 backup-import <backup_service> <backup_url>
Import backup metadata record.

Positional arguments

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

5.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>]
Lists all backups.

Optional arguments

--all-tenants [<all_tenants>]
Shows details for all tenants. Admin only.
--name <name>
Filters results by a name. Default=None.
--status <status>
Filters results by a status. Default=None.
--volume-id <volume-id>
Filters results by a volume ID. Default=None.

5.4.8. cinder backup-restore (v2)

usage: cinder --os-volume-api-version 2 backup-restore [--volume <volume>] <backup>
Restores a backup.

Positional arguments

<backup>
ID of backup to restore.

Optional arguments

--volume <volume>
Name or ID of volume to which to restore. Default=None.

5.4.9. cinder backup-show (v2)

usage: cinder --os-volume-api-version 2 backup-show <backup>
Shows backup details.

Positional arguments

<backup>
Name or ID of backup.

5.4.10. cinder cgsnapshot-create (v2)

usage: cinder --os-volume-api-version 2 cgsnapshot-create [--name <name>] [--description <description>] <consistencygroup>
Creates a cgsnapshot.

Positional arguments

<consistencygroup>
Name or ID of a consistency group.

Optional arguments

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

5.4.11. cinder cgsnapshot-delete (v2)

usage: cinder --os-volume-api-version 2 cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]
Removes one or more cgsnapshots.

Positional arguments

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

5.4.12. cinder cgsnapshot-list (v2)

usage: cinder --os-volume-api-version 2 cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>] [--consistencygroup-id <consistencygroup_id>]
Lists all cgsnapshots.

Optional arguments

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

5.4.13. cinder cgsnapshot-show (v2)

usage: cinder --os-volume-api-version 2 cgsnapshot-show <cgsnapshot>
Shows cgsnapshot details.

Positional arguments

<cgsnapshot>
Name or ID of cgsnapshot.

5.4.14. cinder consisgroup-create (v2)

usage: cinder --os-volume-api-version 2 consisgroup-create [--name <name>] [--description <description>] [--availability-zone <availability-zone>] <volume-types>
Creates a consistency group.

Positional arguments

<volume-types>
Volume types.

Optional arguments

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

5.4.15. 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>]
Creates a consistency group from a cgsnapshot or a source CG.

Optional arguments

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

5.4.16. cinder consisgroup-delete (v2)

usage: cinder --os-volume-api-version 2 consisgroup-delete [--force] <consistencygroup> [<consistencygroup> ...]
Removes one or more consistency groups.

Positional arguments

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

Optional arguments

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

5.4.17. cinder consisgroup-list (v2)

usage: cinder --os-volume-api-version 2 consisgroup-list [--all-tenants [<0|1>]]
Lists all consistencygroups.

Optional arguments

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

5.4.18. cinder consisgroup-show (v2)

usage: cinder --os-volume-api-version 2 consisgroup-show <consistencygroup>
Shows details of a consistency group.

Positional arguments

<consistencygroup>
Name or ID of a consistency group.

5.4.19. 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>
Updates a 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.

5.4.20. cinder create (v2)

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

Positional arguments

<size>
Size of volume, in GBs. (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

5.4.21. cinder credentials (v2)

usage: cinder --os-volume-api-version 2 credentials
Shows user credentials returned from auth.

5.4.22. cinder delete (v2)

usage: cinder --os-volume-api-version 2 delete <volume> [<volume> ...]
Removes one or more volumes.

Positional arguments

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

5.4.23. 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>
Creates encryption type for a volume type. Admin only.

Positional arguments

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

Optional arguments

--cipher <cipher>
The encryption algorithm or mode. For example, aes- xts-plain64. Default=None.
--key_size <key_size>
Size of encryption key, in bits. For example, 128 or 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."

5.4.24. cinder encryption-type-delete (v2)

usage: cinder --os-volume-api-version 2 encryption-type-delete <volume_type>
Deletes encryption type for a volume type. Admin only.

Positional arguments

<volume_type>
Name or ID of volume type.

5.4.25. cinder encryption-type-list (v2)

usage: cinder --os-volume-api-version 2 encryption-type-list
Shows encryption type details for volume types. Admin only.

5.4.26. cinder encryption-type-show (v2)

usage: cinder --os-volume-api-version 2 encryption-type-show <volume_type>
Shows encryption type details for a volume type. Admin only.

Positional arguments

<volume_type>
Name or ID of volume type.

5.4.27. 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>
Update encryption type information for a volume type (Admin Only).

Positional arguments

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

Optional arguments

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

5.4.28. cinder endpoints (v2)

usage: cinder --os-volume-api-version 2 endpoints
Discovers endpoints registered by authentication service.

5.4.29. cinder extend (v2)

usage: cinder --os-volume-api-version 2 extend <volume> <new_size>
Attempts to extend size of an existing volume.

Positional arguments

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

5.4.30. cinder extra-specs-list (v2)

usage: cinder --os-volume-api-version 2 extra-specs-list
Lists current volume types and extra specs.

5.4.31. cinder force-delete (v2)

usage: cinder --os-volume-api-version 2 force-delete <volume> [<volume> ...]
Attempts force-delete of volume, regardless of state.

Positional arguments

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

5.4.32. cinder get-capabilities (v2)

usage: cinder --os-volume-api-version 2 get-capabilities <host>
Show backend volume stats and properties. Admin only.

Positional arguments

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

5.4.33. cinder get-pools (v2)

usage: cinder --os-volume-api-version 2 get-pools [--detail]
Show pool information for backends. Admin only.

Optional arguments

--detail
Show detailed information about pools.

5.4.34. cinder image-metadata (v2)

usage: cinder --os-volume-api-version 2 image-metadata <volume> <action> <key=value> [<key=value> ...]
Sets or deletes volume image metadata.

Positional arguments

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

5.4.35. cinder list (v2)

usage: cinder --os-volume-api-version 2 list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] [--migration_status <migration_status>] [--metadata [<key=value> [<key=value> ...]]] [--marker <marker>] [--limit <limit>] [--sort <key>[:<direction>]] [--tenant [<tenant>]]
Lists all volumes.

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.
--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.
--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. Default=None.
--tenant [<tenant>]
Display information from single tenant (Admin only).

5.4.36. cinder list-extensions (v2)

usage: cinder --os-volume-api-version 2 list-extensions
Lists all available os-api extensions.

5.4.37. cinder manage (v2)

usage: cinder --os-volume-api-version 2 manage [--id-type <id-type>] [--name <name>] [--description <description>] [--volume-type <volume-type>] [--availability-zone <availability-zone>] [--metadata [<key=value> [<key=value> ...]]] [--bootable] <host> <identifier>
Manage an existing volume.

Positional arguments

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

Optional arguments

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

5.4.38. cinder metadata (v2)

usage: cinder --os-volume-api-version 2 metadata <volume> <action> <key=value> [<key=value> ...]
Sets or deletes volume metadata.

Positional arguments

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

5.4.39. cinder metadata-show (v2)

usage: cinder --os-volume-api-version 2 metadata-show <volume>
Shows volume metadata.

Positional arguments

<volume>
ID of volume.

5.4.40. cinder metadata-update-all (v2)

usage: cinder --os-volume-api-version 2 metadata-update-all <volume> <key=value> [<key=value> ...]
Updates volume metadata.

Positional arguments

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

5.4.41. cinder migrate (v2)

usage: cinder --os-volume-api-version 2 migrate [--force-host-copy [<True|False>]] [--lock-volume [<True|False>]] <volume> <host>
Migrates volume to a new host.

Positional arguments

<volume>
ID of volume to migrate.
<host>
Destination host.

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.

5.4.42. cinder qos-associate (v2)

usage: cinder --os-volume-api-version 2 qos-associate <qos_specs> <volume_type_id>
Associates qos specs with specified volume type.

Positional arguments

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

5.4.43. cinder qos-create (v2)

usage: cinder --os-volume-api-version 2 qos-create <name> <key=value> [<key=value> ...]
Creates a qos specs.

Positional arguments

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

5.4.44. cinder qos-delete (v2)

usage: cinder --os-volume-api-version 2 qos-delete [--force [<True|False>]] <qos_specs>
Deletes a specified qos specs.

Positional arguments

<qos_specs>
ID of QoS specifications to delete.

Optional arguments

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

5.4.45. cinder qos-disassociate (v2)

usage: cinder --os-volume-api-version 2 qos-disassociate <qos_specs> <volume_type_id>
Disassociates qos specs from specified volume type.

Positional arguments

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

5.4.46. cinder qos-disassociate-all (v2)

usage: cinder --os-volume-api-version 2 qos-disassociate-all <qos_specs>
Disassociates qos specs from all its associations.

Positional arguments

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

5.4.47. cinder qos-get-association (v2)

usage: cinder --os-volume-api-version 2 qos-get-association <qos_specs>
Lists all associations for specified qos specs.

Positional arguments

<qos_specs>
ID of QoS specifications.

5.4.48. cinder qos-key (v2)

usage: cinder --os-volume-api-version 2 qos-key <qos_specs> <action> key=value [key=value ...]
Sets or unsets specifications for a qos spec.

Positional arguments

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

5.4.49. cinder qos-list (v2)

usage: cinder --os-volume-api-version 2 qos-list
Lists qos specs.

5.4.50. cinder qos-show (v2)

usage: cinder --os-volume-api-version 2 qos-show <qos_specs>
Shows qos specs details.

Positional arguments

<qos_specs>
ID of QoS specifications to show.

5.4.51. cinder quota-class-show (v2)

usage: cinder --os-volume-api-version 2 quota-class-show <class>
Lists quotas for a quota class.

Positional arguments

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

5.4.52. 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>
Updates quotas for a quota class.

Positional arguments

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

Optional arguments

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

5.4.53. cinder quota-defaults (v2)

usage: cinder --os-volume-api-version 2 quota-defaults <tenant_id>
Lists default quotas for a tenant.

Positional arguments

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

5.4.54. cinder quota-delete (v2)

usage: cinder --os-volume-api-version 2 quota-delete <tenant_id>
Delete the quotas for a tenant.

Positional arguments

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

5.4.55. cinder quota-show (v2)

usage: cinder --os-volume-api-version 2 quota-show <tenant_id>
Lists quotas for a tenant.

Positional arguments

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

5.4.56. cinder quota-update (v2)

usage: cinder --os-volume-api-version 2 quota-update [--volumes <volumes>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--backups <backups>] [--backup-gigabytes <backup_gigabytes>] [--consistencygroups <consistencygroups>] [--volume-type <volume_type_name>] [--per-volume-gigabytes <per_volume_gigabytes>] <tenant_id>
Updates quotas for a tenant.

Positional arguments

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

Optional arguments

--volumes <volumes>
The new "volumes" quota value. Default=None.
--snapshots <snapshots>
The new "snapshots" quota value. Default=None.
--gigabytes <gigabytes>
The new "gigabytes" quota value. Default=None.
--backups <backups>
The new "backups" quota value. Default=None.
--backup-gigabytes <backup_gigabytes>
The new "backup_gigabytes" quota value. Default=None.
--consistencygroups <consistencygroups>
The new "consistencygroups" quota value. Default=None.
--volume-type <volume_type_name>
Volume type. Default=None.
--per-volume-gigabytes <per_volume_gigabytes>
Set max volume size limit. Default=None.

5.4.57. cinder quota-usage (v2)

usage: cinder --os-volume-api-version 2 quota-usage <tenant_id>
Lists quota usage for a tenant.

Positional arguments

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

5.4.58. cinder rate-limits (v2)

usage: cinder --os-volume-api-version 2 rate-limits
Lists rate limits for a user.

5.4.59. cinder readonly-mode-update (v2)

usage: cinder --os-volume-api-version 2 readonly-mode-update <volume> <True|true|False|false>
Updates volume read-only access-mode flag.

Positional arguments

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

5.4.60. cinder rename (v2)

usage: cinder --os-volume-api-version 2 rename [--description <description>] <volume> [<name>]
Renames a volume.

Positional arguments

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

Optional arguments

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

5.4.61. cinder replication-promote (v2)

usage: cinder --os-volume-api-version 2 replication-promote <volume>
Promote a secondary volume to primary for a relationship.

Positional arguments

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

5.4.62. cinder replication-reenable (v2)

usage: cinder --os-volume-api-version 2 replication-reenable <volume>
Sync the secondary volume with primary for a relationship.

Positional arguments

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

5.4.63. cinder reset-state (v2)

usage: cinder --os-volume-api-version 2 reset-state [--state <state>] [--attach-status <attach-status>] [--reset-migration-status] <volume> [<volume> ...]
Explicitly updates the volume state in the Cinder database. Note that this does not affect whether the volume is actually attached to the Nova compute host or instance and can result in an unusable volume. Being a database change only, this has no impact on the true state of the volume and may not match the actual state. This can render a volume unusable in the case of change to the 'available' state.

Positional arguments

<volume>
Name or ID of volume to modify.

Optional arguments

--state <state>
The state to assign to the volume. Valid values are "available", "error", "creating", "deleting", "in- use", "attaching", "detaching", "error_deleting" and "maintenance". NOTE: This command simply changes the state of the Volume in the DataBase with no regard to actual status, exercise caution when using. Default=available.
--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.

5.4.64. cinder retype (v2)

usage: cinder --os-volume-api-version 2 retype [--migration-policy <never|on-demand>] <volume> <volume-type>
Changes the volume type for a volume.

Positional arguments

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

Optional arguments

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

5.4.65. cinder service-disable (v2)

usage: cinder --os-volume-api-version 2 service-disable [--reason <reason>] <hostname> <binary>
Disables the service.

Positional arguments

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

Optional arguments

--reason <reason>
Reason for disabling service.

5.4.66. cinder service-enable (v2)

usage: cinder --os-volume-api-version 2 service-enable <hostname> <binary>
Enables the service.

Positional arguments

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

5.4.67. cinder service-list (v2)

usage: cinder --os-volume-api-version 2 service-list [--host <hostname>] [--binary <binary>]
Lists all services. Filter by host and service binary.

Optional arguments

--host <hostname>
Host name. Default=None.
--binary <binary>
Service binary. Default=None.

5.4.68. cinder set-bootable (v2)

usage: cinder --os-volume-api-version 2 set-bootable <volume> <True|true|False|false>
Update bootable status of a volume.

Positional arguments

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

5.4.69. cinder show (v2)

usage: cinder --os-volume-api-version 2 show <volume>
Shows volume details.

Positional arguments

<volume>