Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Command-Line Interface Reference

Red Hat OpenStack Platform 9

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

1.1. Overview
Copy link

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.
Expand
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
Copy link

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

1.2.1. Install the prerequisite software
Copy link

The following table lists the software that you need to have to run the command-line clients, and provides installation instructions as needed.
Expand
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
Copy link

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
Copy to Clipboard Toggle word wrap
1.2.2.1. Installing from packages
Copy link
On Red Hat Enterprise Linux, use yum to install the clients: 
# yum install python-PROJECTclient
Copy to Clipboard Toggle word wrap

1.2.3. Upgrade or remove clients
Copy link

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

1.2.4. What's next
Copy link

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

Run the following command to discover the version number for a client: 
$ PROJECT --version
Copy to Clipboard Toggle word wrap
For example, to see the version number for the nova client, run the following command: 
$ nova --version
Copy to Clipboard Toggle word wrap
The version number (3.3.0 in the example) is returned. 
3.3.0
Copy to Clipboard Toggle word wrap
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
Copy link

  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
    Copy to Clipboard Toggle word wrap
  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
Copy link

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
    Copy to Clipboard Toggle word wrap
    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
    Copy to Clipboard Toggle word wrap
  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
    Copy to Clipboard Toggle word wrap
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
Copy link

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
Copy to Clipboard Toggle word wrap
Where PASSWORD is your password.

Chapter 2. Packstack command-line client
Copy link

The packstack client is the command-line interface (CLI) for installing single node, proof-of-concept deployments. This chapter documents packstack version 8.0.0.
For help on a specific packstack command, enter: 
$ packstack help COMMAND
Copy to Clipboard Toggle word wrap

2.1. packstack usage
Copy link

Usage: packstack [options] [--help]
Copy to Clipboard Toggle word wrap

2.2. packstack optional arguments
Copy link

--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 --nagios- 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
Copy link

--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).
--service-workers=SERVICE_WORKERS
The amount of service workers/threads to use for each service. Useful to tweak when you have memory constraints. Defaults to the amount of cores on the system.
--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-aodh-install=OS_AODH_INSTALL
Specify 'y' to install OpenStack Telemetry Alarming (Aodh). Note Aodh requires Ceilometer to be installed as well. ['y', 'n']
--os-gnocchi-install=OS_GNOCCHI_INSTALL
Specify 'y' to install OpenStack Metering as a Service (gnocchi). ['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.
--nagios-install=NAGIOS_INSTALL
Specify 'y' to install Nagios to monitor OpenStack hosts. Nagios provides additional tools for monitoring the OpenStack environment. ['y', 'n']
--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
Copy link

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

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

--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.
--rh-sat6-server=RH_SAT6_SERVER
Specify a Satellite 6 Server to register to. If not specified, Packstack will register the system to the Red Hat server. When this option is specified, you also need to set the Satellite 6 organization (CONFIG_RH_SAT6_ORG) and an activation key (CONFIG_RH_SAT6_KEY).

2.7. packstack RHN Satellite config
Copy link

--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).
--rh-sat6-org=RH_SAT6_ORG
Specify a Satellite 6 Server organization to use when registering the system.
--rh-sat6-key=RH_SAT6_KEY
Specify a Satellite 6 Server activation key to use when registering the system.

2.8. packstack RHN Satellite proxy config
Copy link

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

--amqp-backend=AMQP_BACKEND
Service to be used as the AMQP broker. Allowed values are: rabbitmq ['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
Copy link

--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']
--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
Copy link

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

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

--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']
--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']
--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
Copy link

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

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

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

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

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

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

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

--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.
--os-neutron-ovs-bridges-compute=OS_NEUTRON_OVS_BRIDGES_COMPUTE
Comma-separated list of Open vSwitch bridges that must be created and connected to interfaces in compute nodes when flat or vlan type drivers are enabled. These bridges must exist in CONFIG_NEUTRON_OVS_BRIDGE_MAPPINGS and CONFIG_NEUTRON_OVS_BRIDGE_IFACES. Example: --os- neutron-ovs-bridges-compute=br-vlan --os-neutron-ovs- bridge-mappings="extnet:br-ex,physnet1:br-vlan" --os- neutron-ovs-bridge-interfaces="br-ex:eth1,br- vlan:eth2"
--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).
--os-neutron-ovs-tunnel-subnets=OS_NEUTRON_OVS_TUNNEL_SUBNETS
Comma-separated list of subnets (for example, 192.168.10.0/24,192.168.11.0/24) used for sending tunneling packets. This is used to configure IP filtering to accept tunneling packets from these subnets instead of specific IP addresses of peer nodes. This is useful when you add existing nodes to EXCLUDE_SERVERS because, in this case, packstack cannot modify the IP filtering of the existing nodes.

2.26. packstack Neutron OVS agent config for VXLAN
Copy link

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

2.27. packstack Manila Config parameters
Copy link

--manila-db-passwd=MANILA_DB_PASSWD
Password to use for the OpenStack File Share service (manila) to access the database.
--manila-ks-passwd=MANILA_KS_PASSWD
Password to use for the OpenStack File Share service (manila) to authenticate with the Identity service.
--manila-backend=MANILA_BACKEND
Backend for the OpenStack File Share service (manila); valid options are: generic, netapp, glusternative, or glusternfs. ['generic', 'netapp', 'glusternative', 'glusternfs']

2.28. packstack Manila NetApp configuration
Copy link

--manila-netapp-driver-handles-share-servers=MANILA_NETAPP_DRIVER_HANDLES_SHARE_SERVERS
Denotes whether the driver should handle the responsibility of managing share servers. This must be set to false if the driver is to operate without managing share servers. Defaults to 'false' ['true', 'false']
--manila-netapp-transport-type=MANILA_NETAPP_TRANSPORT_TYPE
The transport protocol used when communicating with the storage system or proxy server. Valid values are 'http' and 'https'. Defaults to 'https'. ['https', 'http']
--manila-netapp-login=MANILA_NETAPP_LOGIN
Administrative user account name used to access the NetApp storage system. Defaults to ''.
--manila-netapp-password=MANILA_NETAPP_PASSWORD
Password for the NetApp administrative user account specified in the CONFIG_MANILA_NETAPP_LOGIN parameter. Defaults to ''.
--manila-netapp-server-hostname=MANILA_NETAPP_SERVER_HOSTNAME
Hostname (or IP address) for the NetApp storage system or proxy server. Defaults to ''.
--manila-netapp-storage-family=MANILA_NETAPP_STORAGE_FAMILY
The storage family type used on the storage system; valid values are ontap_cluster for clustered Data ONTAP. Defaults to 'ontap_cluster'. ['ontap_cluster']
--manila-netapp-server-port=MANILA_NETAPP_SERVER_PORT
The TCP port to use for communication with the storage system or proxy server. If not specified, Data ONTAP drivers will use 80 for HTTP and 443 for HTTPS. Defaults to '443'.
--manila-netapp-aggregate-name-search-pattern=MANILA_NETAPP_AGGREGATE_NAME_SEARCH_PATTERN
Pattern for searching available aggregates for NetApp provisioning. Defaults to '(.*)'.
--manila-netapp-root-volume-aggregate=MANILA_NETAPP_ROOT_VOLUME_AGGREGATE
Name of aggregate on which to create the NetApp root volume. This option only applies when the option CONFIG_MANILA_NETAPP_DRV_HANDLES_SHARE_SERVERS is set to True.
--manila-netapp-root-volume-name=MANILA_NETAPP_ROOT_VOLUME_NAME
NetApp root volume name. Defaults to 'root'.
--manila-netapp-vserver=MANILA_NETAPP_VSERVER
This option specifies the storage virtual machine (previously called a Vserver) name on the storage cluster on which provisioning of shared file systems should occur. This option only applies when the option driver_handles_share_servers is set to False. Defaults to ''.
--manila-generic-driver-handles-share-servers=MANILA_GENERIC_DRIVER_HANDLES_SHARE_SERVERS
Denotes whether the driver should handle the responsibility of managing share servers. This must be set to false if the driver is to operate without managing share servers. Defaults to 'true'. ['true', 'false']
--manila-generic-volume-name-template=MANILA_GENERIC_VOLUME_NAME_TEMPLATE
Volume name template for Manila service. Defaults to 'manila-share-%s'.
--manila-generic-share-mount-path=MANILA_GENERIC_SHARE_MOUNT_PATH
Share mount path for Manila service. Defaults to '/shares'.
--manila-service-image-location=MANILA_SERVICE_IMAGE_LOCATION
Location of disk image for Manila service instance. Defaults to ''.
--manila-service-instance-user=MANILA_SERVICE_INSTANCE_USER
User in Manila service instance.
--manila-service-instance-password=MANILA_SERVICE_INSTANCE_PASSWORD
Password to service instance user.
--manila-network-type=MANILA_NETWORK_TYPE
Type of networking that the backend will use. A more detailed description of each option is available in the Manila docs. Defaults to 'neutron'. ['neutron', 'nova-network', 'standalone']
--standalone_network_plugin_gateway=STANDALONE_NETWORK_PLUGIN_GATEWAY
Gateway IPv4 address that should be used. Required. Defaults to ''.
--standalone_network_plugin_mask=STANDALONE_NETWORK_PLUGIN_MASK
Network mask that will be used. Can be either decimal like '24' or binary like '255.255.255.0'. Required. Defaults to ''.
--standalone_network_plugin_segmentation_id=STANDALONE_NETWORK_PLUGIN_SEGMENTATION_ID
Set it if network has segmentation (VLAN, VXLAN, etc). It will be assigned to share-network and share drivers will be able to use this for network interfaces within provisioned share servers. Optional. Example: 1001. Defaults to ''.
--standalone_network_plugin_ip_range=STANDALONE_NETWORK_PLUGIN_IP_RANGE
Can be IP address, range of IP addresses or list of addresses or ranges. Contains addresses from IP network that are allowed to be used. If empty, then will be assumed that all host addresses from network can be used. Optional. Examples: 10.0.0.10 or 10.0.0.10-10.0.0.20 or 10.0.0.10-10.0.0.20,10.0.0.30-10.0.0.40,10.0.0.50. Defaults to ''.
--standalone_network_plugin_ip_version=STANDALONE_NETWORK_PLUGIN_IP_VERSION
IP version of network. Optional. Defaults to '4'. ['4', '6']
--glusterfs-servers=GLUSTERFS_SERVERS
List of GlusterFS servers that can be used to create shares. Each GlusterFS server should be of the form [remoteuser@]<volserver>, and they are assumed to belong to distinct Gluster clusters.
--glusterfs-native-path-to-private_key=GLUSTERFS_NATIVE_PATH_TO_PRIVATE_KEY
Path of Manila host's private SSH key file.
--glusterfs-volume-pattern=GLUSTERFS_VOLUME_PATTERN
Regular expression template used to filter GlusterFS volumes for share creation. The regex template can optionally (ie. with support of the GlusterFS backend) contain the #{size} parameter which matches an integer (sequence of digits) in which case the value shall be intepreted as size of the volume in GB. Examples: "manila-share-volume-d+$", "manila-share- volume-#{size}G-d+$"; with matching volume names, respectively: "manila-share-volume-12", "manila-share- volume-3G-13". In latter example, the number that matches "#{size}", that is, 3, is an indication that the size of volume is 3G.

2.35. packstack Manila GlusterNFS configuration
Copy link

--glusterfs-target=GLUSTERFS_TARGET
Specifies the GlusterFS volume to be mounted on the Manila host. For e.g: [remoteuser@]<volserver>:/<volid>
--glusterfs-mount-point-base=GLUSTERFS_MOUNT_POINT_BASE
Base directory containing mount points for Gluster volumes.
--glusterfs-nfs-server-type=GLUSTERFS_NFS_SERVER_TYPE
Type of NFS server that mediate access to the Gluster volumes (Gluster or Ganesha).
--glusterfs-path-to-private-key=GLUSTERFS_PATH_TO_PRIVATE_KEY
Path of Manila host's private SSH key file.
--glusterfs-ganesha-server-ip=GLUSTERFS_GANESHA_SERVER_IP
Remote Ganesha server node's IP address.

2.36. packstack NOVACLIENT Config parameters
Copy link

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

2.38. packstack SSL Config parameters
Copy link

--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.39. packstack OpenStack Swift Config parameters
Copy link

--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.40. packstack Heat Config parameters
Copy link

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

2.41. packstack Provisioning demo config
Copy link

--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.42. packstack Provisioning demo config
Copy link

--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.43. packstack Provisioning tempest config
Copy link

--tempest-host=TEMPEST_HOST
--provision-tempest-user=PROVISION_TEMPEST_USER
Name of the Integration Test Suite provisioning user. If you do not provide a user name, Tempest is configured in a standalone mode.
--provision-tempest-user-passwd=PROVISION_TEMPEST_USER_PASSWD
Password to use for the Integration Test Suite provisioning user.
--provision-tempest-floatrange=PROVISION_TEMPEST_FLOATRANGE
CIDR network address for the floating IP subnet.
--provision-tempest-repo-uri=PROVISION_TEMPEST_REPO_URI
URI of the Integration Test Suite git repository.
--provision-tempest-repo-revision=PROVISION_TEMPEST_REPO_REVISION
Revision (branch) of the Integration Test Suite git repository.
--run-tempest=RUN_TEMPEST
Specify 'y' to run Tempest smoke test as last step of installation.
--run-tempest-tests=RUN_TEMPEST_TESTS
Test suites to run, example: "smoke dashboard TelemetryAlarming". Optional, defaults to "smoke".
--provision-ovs-bridge=PROVISION_OVS_BRIDGE
Specify 'y' to configure the Open vSwitch external bridge for an all-in-one deployment (the L3 external bridge acts as the gateway for virtual machines). ['y', 'n']

2.45. packstack Gnocchi Config parameters
Copy link

--gnocchi-db-passwd=GNOCCHI_DB_PASSWD
Password to use for Gnocchi to access the database.
--gnocchi-ks-passwd=GNOCCHI_KS_PASSWD
Password to use for Gnocchi to authenticate with the Identity service.

2.46. packstack Ceilometer Config parameters
Copy link

--ceilometer-ks-passwd=CEILOMETER_KS_PASSWD
Password to use for Telemetry to authenticate with the Identity service.
--ceilometer-service-name=CEILOMETER_SERVICE_NAME
Ceilometer service name. ['httpd', 'ceilometer']

2.47. packstack MONGODB Config parameters
Copy link

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

2.48. packstack Redis Config parameters
Copy link

--redis-master-host=REDIS_MASTER_HOST
IP address of the server on which to install the Redis master server.
--redis-port=REDIS_PORT
Port on which the Redis server(s) listens.
--redis-ha=REDIS_HA
Specify 'y' to have Redis try to use HA. ['y', 'n']
--redis-slaves=REDIS_SLAVES
Hosts on which to install Redis slaves.
--redis-sentinels=REDIS_SENTINELS
Hosts on which to install Redis sentinel servers.
--redis-sentinel-contact=REDIS_SENTINEL_CONTACT
Host to configure as the Redis coordination sentinel.
--redis-sentinel-port=REDIS_SENTINEL_PORT
Port on which Redis sentinel servers listen.
--redis-sentinel-quorum=REDIS_SENTINEL_QUORUM
Quorum value for Redis sentinel servers.
--redis-sentinel-master-name=REDIS_SENTINEL_MASTER_NAME
Name of the master server watched by the Redis sentinel. ['[a-z]+']

2.49. packstack Aodh Config parameters
Copy link

--aodh-ks-passwd=AODH_KS_PASSWD
Password to use for Telemetry Alarming to authenticate with the Identity service.

2.50. packstack Trove config parameters
Copy link

--trove-db-passwd=TROVE_DB_PASSWD
Password to use for OpenStack Database-as-a-Service (trove) to access the database.
--trove-ks-passwd=TROVE_KS_PASSWD
Password to use for OpenStack Database-as-a-Service to authenticate with the Identity service.
--trove-nova-passwd=TROVE_NOVA_PASSWD
Password to use when OpenStack Database-as-a-Service connects to the Compute service.

2.51. packstack Sahara Config parameters
Copy link

--sahara-db-passwd=SAHARA_DB_PASSWD
Password to use for OpenStack Data Processing (sahara) to access the database.
--sahara-ks-passwd=SAHARA_KS_PASSWD
Password to use for OpenStack Data Processing to authenticate with the Identity service.

2.52. packstack Nagios Config parameters
Copy link

--nagios-passwd=NAGIOS_PASSWD
Password of the nagiosadmin user on the Nagios server.

2.53. packstack Puppet Config parameters
Copy link

2.54. packstack POSTSCRIPT Config parameters
Copy link

Chapter 3. OpenStack command-line client
Copy link

The openstack client is a common OpenStack command-line interface (CLI). This chapter documents openstack version 2.2.0.
For help on a specific openstack command, enter: 
$ openstack help COMMAND
Copy to Clipboard Toggle word wrap

3.1. openstack usage
Copy link

usage: openstack [--version] [-v | -q] [--log-file LOG_FILE] [-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] [--profile hmac-key] [--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>] [--os-orchestration-api-version <orchestration-api-version>] [--os-key-manager-api-version <key-manager-api-version>] [--os-data-processing-api-version <data-processing-api-version>] [--os-data-processing-url OS_DATA_PROCESSING_URL] [--os-dns-api-version <dns-api-version>] [--os-baremetal-api-version <baremetal-api-version>]
Copy to Clipboard Toggle word wrap

3.2. openstack optional arguments
Copy link

--version
show program's version number and exit
-v, --verbose
Increase verbosity of output. Can be repeated.
-q, --quiet
Suppress output except warnings and errors.
--log-file LOG_FILE
Specify a file to log output. Disabled by default.
-h, --help
Show help message and exit.
--debug
Show tracebacks on errors.
--os-cloud <cloud-config-name>
Cloud name in clouds.yaml (Env: OS_CLOUD)
--os-region-name <auth-region-name>
Authentication region name (Env: OS_REGION_NAME)
--os-cacert <ca-bundle-file>
CA certificate bundle file (Env: OS_CACERT)
--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
--profile
hmac-key HMAC key to use for encrypting context data for performance profiling of operation. This key should be the value of one of the HMAC keys configured in osprofiler middleware in the projects user would like to profile. It needs to be specified in configuration files of the required projects.
--os-compute-api-version <compute-api-version>
Compute API version, default=2 (Env: OS_COMPUTE_API_VERSION)
--os-network-api-version <network-api-version>
Network API version, default=2.0 (Env: OS_NETWORK_API_VERSION)
--os-image-api-version <image-api-version>
Image API version, default=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=3 (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)
--os-orchestration-api-version <orchestration-api-version>
Orchestration API version, default=1 (Env: OS_ORCHESTRATION_API_VERSION)
--os-key-manager-api-version <key-manager-api-version>
Barbican API version, default=1 (Env: OS_KEY_MANAGER_API_VERSION)
--os-data-processing-api-version <data-processing-api-version>
Data processing API version, default=1.1 (Env: OS_DATA_PROCESSING_API_VERSION)
--os-data-processing-url OS_DATA_PROCESSING_URL
Data processing API URL, (Env: OS_DATA_PROCESSING_API_URL)
--os-dns-api-version <dns-api-version>
DNS API version, default=2 (Env: OS_DNS_API_VERSION)
--os-baremetal-api-version <baremetal-api-version>
Baremetal API version, default=1.6 (Env: OS_BAREMETAL_API_VERSION)

3.3. Subcommands
Copy link

Important
OpenStack Identity API v2 is deprecated in the Mitaka release.
You can select the Identity API version to use by adding the --os-identity-api-version parameter or by setting the corresponding environment variable: 
export OS_IDENTITY_API_VERSION=3
Copy to Clipboard Toggle word wrap

3.3.1. openstack access token create
Copy link

usage: openstack access token create [-h]
                                     [-f {html,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent] [--prefix PREFIX]
                                     --consumer-key <consumer-key>
                                     --consumer-secret <consumer-secret>
                                     --request-key <request-key>
                                     --request-secret <request-secret>
                                     --verifier <verifier>
Copy to Clipboard Toggle word wrap
Create an access token
Optional arguments:
-h, --help
show this help message and exit
--consumer-key <consumer-key>
Consumer key (required)
--consumer-secret <consumer-secret>
Consumer secret (required)
--request-key <request-key>
Request token to exchange for access token (required)
--request-secret <request-secret>
Secret associated with <request-key> (required)
--verifier <verifier>
Verifier associated with <request-key> (required)

3.3.2. openstack acl delete
Copy link

usage: openstack acl delete [-h] URI
Copy to Clipboard Toggle word wrap
Delete ACLs for a secret or container as identified by its href.
Positional arguments:
URI
The URI reference for the secret or container.
Optional arguments:
-h, --help
show this help message and exit

3.3.3. openstack acl get
Copy link

usage: openstack acl get [-h] [-f {csv,html,json,table,value,yaml}]
                         [-c COLUMN] [--max-width <integer>] [--noindent]
                         [--quote {all,minimal,none,nonnumeric}]
                         URI
Copy to Clipboard Toggle word wrap
Retrieve ACLs for a secret or container by providing its href.
Positional arguments:
URI
The URI reference for the secret or container.
Optional arguments:
-h, --help
show this help message and exit

3.3.4. openstack acl submit
Copy link

usage: openstack acl submit [-h] [-f {csv,html,json,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--noindent]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--user [USERS]]
                            [--project-access | --no-project-access]
                            [--operation-type {read}]
                            URI
Copy to Clipboard Toggle word wrap
Submit ACL on a secret or container as identified by its href.
Positional arguments:
URI
The URI reference for the secret or container.
Optional arguments:
-h, --help
show this help message and exit
--user [USERS], -u [USERS]
Keystone userid(s) for ACL.
--project-access
Flag to enable project access behavior.
--no-project-access
Flag to disable project access behavior.
--operation-type {read}, -o {read}
Type of Barbican operation ACL is set for

3.3.5. openstack acl user add
Copy link

usage: openstack acl user add [-h] [-f {csv,html,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--user [USERS]]
                              [--project-access | --no-project-access]
                              [--operation-type {read}]
                              URI
Copy to Clipboard Toggle word wrap
Add ACL users to a secret or container as identified by its href.
Positional arguments:
URI
The URI reference for the secret or container.
Optional arguments:
-h, --help
show this help message and exit
--user [USERS], -u [USERS]
Keystone userid(s) for ACL.
--project-access
Flag to enable project access behavior.
--no-project-access
Flag to disable project access behavior.
--operation-type {read}, -o {read}
Type of Barbican operation ACL is set for

3.3.6. openstack acl user remove
Copy link

usage: openstack acl user remove [-h] [-f {csv,html,json,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--user [USERS]]
                                 [--project-access | --no-project-access]
                                 [--operation-type {read}]
                                 URI
Copy to Clipboard Toggle word wrap
Remove ACL users from a secret or container as identified by its href.
Positional arguments:
URI
The URI reference for the secret or container.
Optional arguments:
-h, --help
show this help message and exit
--user [USERS], -u [USERS]
Keystone userid(s) for ACL.
--project-access
Flag to enable project access behavior.
--no-project-access
Flag to disable project access behavior.
--operation-type {read}, -o {read}
Type of Barbican operation ACL is set for

3.3.7. openstack aggregate add host
Copy link

usage: openstack aggregate add host [-h]
                                    [-f {html,json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--noindent] [--prefix PREFIX]
                                    <aggregate> <host>
Copy to Clipboard Toggle word wrap
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

3.3.8. openstack aggregate create
Copy link

usage: openstack aggregate create [-h] [-f {html,json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent] [--prefix PREFIX]
                                  [--zone <availability-zone>]
                                  [--property <key=value>]
                                  <name>
Copy to Clipboard Toggle word wrap
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)

3.3.9. openstack aggregate delete
Copy link

usage: openstack aggregate delete [-h] <aggregate>
Copy to Clipboard Toggle word wrap
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.10. openstack aggregate list
Copy link

usage: openstack aggregate list [-h] [-f {csv,html,json,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--long]
Copy to Clipboard Toggle word wrap
List all aggregates
Optional arguments:
-h, --help
show this help message and exit
--long
List additional fields in output

3.3.11. openstack aggregate remove host
Copy link

usage: openstack aggregate remove host [-h]
                                       [-f {html,json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--noindent] [--prefix PREFIX]
                                       <aggregate> <host>
Copy to Clipboard Toggle word wrap
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

3.3.12. openstack aggregate set
Copy link

usage: openstack aggregate set [-h] [--name <name>]
                               [--zone <availability-zone>]
                               [--property <key=value>]
                               <aggregate>
Copy to Clipboard Toggle word wrap
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)

3.3.13. openstack aggregate show
Copy link

usage: openstack aggregate show [-h] [-f {html,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent] [--prefix PREFIX]
                                <aggregate>
Copy to Clipboard Toggle word wrap
Display aggregate details
Positional arguments:
<aggregate>
Aggregate to display (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.14. openstack availability zone list
Copy link

usage: openstack availability zone list [-h]
                                        [-f {csv,html,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--compute] [--network] [--volume]
                                        [--long]
Copy to Clipboard Toggle word wrap
List availability zones and their status
Optional arguments:
-h, --help
show this help message and exit
--compute
List compute availability zones
--network
List network availability zones
--volume
List volume availability zones
--long
List additional fields in output

3.3.15. openstack backup create
Copy link

usage: openstack backup create [-h] [-f {html,json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent] [--prefix PREFIX] [--name <name>]
                               [--description <description>]
                               [--container <container>]
                               <volume>
Copy to Clipboard Toggle word wrap
Create new backup
Positional arguments:
<volume>
Volume to backup (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--name <name>
Name of the backup
--description <description>
Description of the backup
--container <container>
Optional backup container name

3.3.16. openstack backup delete
Copy link

usage: openstack backup delete [-h] <backup> [<backup> ...]
Copy to Clipboard Toggle word wrap
Delete backup(s)
Positional arguments:
<backup>
Backup(s) to delete (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.17. openstack backup list
Copy link

usage: openstack backup list [-h] [-f {csv,html,json,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}] [--long]
Copy to Clipboard Toggle word wrap
List backups
Optional arguments:
-h, --help
show this help message and exit
--long
List additional fields in output

3.3.18. openstack backup restore
Copy link

usage: openstack backup restore [-h] [-f {html,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent] [--prefix PREFIX]
                                <backup> <volume>
Copy to Clipboard Toggle word wrap
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.19. openstack backup show
Copy link

usage: openstack backup show [-h] [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX]
                             <backup>
Copy to Clipboard Toggle word wrap
Display backup details
Positional arguments:
<backup>
Backup to display (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.20. openstack baremetal create
Copy link

usage: openstack baremetal create [-h] [-f {html,json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent] [--prefix PREFIX]
                                  [--chassis-uuid <chassis>] --driver <driver>
                                  [--driver-info <key=value>]
                                  [--property <key=value>]
                                  [--extra <key=value>] [--uuid <uuid>]
                                  [--name <name>]
Copy to Clipboard Toggle word wrap
Register a new node with the baremetal service
Optional arguments:
-h, --help
show this help message and exit
--chassis-uuid <chassis>
UUID of the chassis that this node belongs to.
--driver <driver>
Driver used to control the node [REQUIRED].
--driver-info <key=value>
Key/value pair used by the driver, such as out-of-band management credentials. Can be specified multiple times.
--property <key=value>
Key/value pair describing the physical characteristics of the node. This is exported to Nova and used by the scheduler. Can be specified multiple times.
--extra <key=value>
Record arbitrary key/value metadata. Can be specified multiple times.
--uuid <uuid>
Unique UUID for the node.
--name <name>
Unique name for the node.

3.3.21. openstack baremetal delete
Copy link

usage: openstack baremetal delete [-h] <node>
Copy to Clipboard Toggle word wrap
Unregister a baremetal node
Positional arguments:
<node>
Node to delete (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.22. openstack baremetal list
Copy link

usage: openstack baremetal list [-h] [-f {csv,html,json,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--limit <limit>] [--marker <node>]
                                [--sort <key>[:<direction>]] [--maintenance]
                                [--associated] [--long]
Copy to Clipboard Toggle word wrap
List baremetal nodes
Optional arguments:
-h, --help
show this help message and exit
--limit <limit>
Maximum number of nodes to return per request, 0 for no limit. Default is the maximum number used by the Baremetal API Service.
--marker <node>
Node UUID (for example, of the last node in the list from a previous request). Returns the list of nodes after this UUID.
--sort <key>[:<direction>]
Sort output by selected keys and directions(asc or desc) (default: asc), multiple keys and directions can be specified separated by comma
--maintenance
List nodes in maintenance mode.
--associated
List only nodes associated with an instance.
--long
Show detailed information about the nodes.

3.3.23. openstack baremetal set
Copy link

usage: openstack baremetal set [-h] [--property <path=value>] <node>
Copy to Clipboard Toggle word wrap
Set baremetal properties
Positional arguments:
<node>
Name or UUID of the node.
Optional arguments:
-h, --help
show this help message and exit
--property <path=value>
Property to add to this baremetal host (repeat option to set multiple properties)

3.3.24. openstack baremetal show
Copy link

usage: openstack baremetal show [-h] [-f {html,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent] [--prefix PREFIX] [--instance]
                                [--long]
                                <node>
Copy to Clipboard Toggle word wrap
Show baremetal node details
Positional arguments:
<node>
Name or UUID of the node (or instance UUID if --instance is specified)
Optional arguments:
-h, --help
show this help message and exit
--instance <node>
is an instance UUID.
--long

3.3.25. openstack baremetal unset
Copy link

usage: openstack baremetal unset [-h] [--property <path>] <node>
Copy to Clipboard Toggle word wrap
Unset baremetal properties
Positional arguments:
<node>
Name or UUID of the node.
Optional arguments:
-h, --help
show this help message and exit
--property <path>
Property to unset on this baremetal host (repeat option to unset multiple properties)

3.3.26. openstack ca get
Copy link

usage: openstack ca get [-h] [-f {html,json,shell,table,value,yaml}]
                        [-c COLUMN] [--max-width <integer>] [--noindent]
                        [--prefix PREFIX]
                        URI
Copy to Clipboard Toggle word wrap
Retrieve a CA by providing its URI.
Positional arguments:
URI
The URI reference for the CA.
Optional arguments:
-h, --help
show this help message and exit

3.3.27. openstack ca list
Copy link

usage: openstack ca list [-h] [-f {csv,html,json,table,value,yaml}]
                         [-c COLUMN] [--max-width <integer>] [--noindent]
                         [--quote {all,minimal,none,nonnumeric}]
                         [--limit LIMIT] [--offset OFFSET] [--name NAME]
Copy to Clipboard Toggle word wrap
List cas.
Optional arguments:
-h, --help
show this help message and exit
--limit LIMIT, -l LIMIT
specify the limit to the number of items to list per page (default: 10; maximum: 100)
--offset OFFSET, -o OFFSET
specify the page offset (default: 0)
--name NAME, -n NAME
specify the secret name (default: None)

3.3.28. openstack catalog list
Copy link

usage: openstack catalog list [-h] [-f {csv,html,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List services in the service catalog
Optional arguments:
-h, --help
show this help message and exit

3.3.29. openstack catalog show
Copy link

usage: openstack catalog show [-h] [-f {html,json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--prefix PREFIX]
                              <service>
Copy to Clipboard Toggle word wrap
Display service catalog details
Positional arguments:
<service>
Service to display (type or name)
Optional arguments:
-h, --help
show this help message and exit

3.3.30. openstack command list
Copy link

usage: openstack command list [-h] [-f {csv,html,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List recognized commands by group
Optional arguments:
-h, --help
show this help message and exit

3.3.31. openstack compute agent create
Copy link

usage: openstack compute agent create [-h]
                                      [-f {html,json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--noindent] [--prefix PREFIX]
                                      <os> <architecture> <version> <url>
                                      <md5hash> <hypervisor>
Copy to Clipboard Toggle word wrap
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

3.3.32. openstack compute agent delete
Copy link

usage: openstack compute agent delete [-h] <id> [<id> ...]
Copy to Clipboard Toggle word wrap
Delete compute agent(s)
Positional arguments:
<id>
ID of agent(s) to delete
Optional arguments:
-h, --help
show this help message and exit

3.3.33. openstack compute agent list
Copy link

usage: openstack compute agent list [-h] [-f {csv,html,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--hypervisor <hypervisor>]
Copy to Clipboard Toggle word wrap
List compute agent command
Optional arguments:
-h, --help
show this help message and exit
--hypervisor <hypervisor>
Type of hypervisor

3.3.34. openstack compute agent set
Copy link

usage: openstack compute agent set [-h] <id> <version> <url> <md5hash>
Copy to Clipboard Toggle word wrap
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

3.3.35. openstack compute service delete
Copy link

usage: openstack compute service delete [-h] <service>
Copy to Clipboard Toggle word wrap
Delete service command
Positional arguments:
<service>
Compute service to delete (ID only)
Optional arguments:
-h, --help
show this help message and exit

3.3.36. openstack compute service list
Copy link

usage: openstack compute service list [-h]
                                      [-f {csv,html,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--host <host>] [--service <service>]
                                      [--long]
Copy to Clipboard Toggle word wrap
List service command
Optional arguments:
-h, --help
show this help message and exit
--host <host>
List services on specified host (name only)
--service <service>
List only specified service (name only)
--long
List additional fields in output

3.3.37. openstack compute service set
Copy link

usage: openstack compute service set [-h] [--enable | --disable]
                                     [--disable-reason <reason>]
                                     <host> <service>
Copy to Clipboard Toggle word wrap
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 service
--disable
Disable service
--disable-reason <reason>
Reason for disabling the service (in quotas). Should be used with --disable option.

3.3.38. openstack configuration show
Copy link

usage: openstack configuration show [-h]
                                    [-f {html,json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--noindent] [--prefix PREFIX]
                                    [--mask | --unmask]
Copy to Clipboard Toggle word wrap
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

3.3.39. openstack console log show
Copy link

usage: openstack console log show [-h] [--lines <num-lines>] <server>
Copy to Clipboard Toggle word wrap
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.40. openstack console url show
Copy link

usage: openstack console url show [-h] [-f {html,json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent] [--prefix PREFIX]
                                  [--novnc | --xvpvnc | --spice]
                                  <server>
Copy to Clipboard Toggle word wrap
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

3.3.41. openstack consumer create
Copy link

usage: openstack consumer create [-h] [-f {html,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 [--description <description>]
Copy to Clipboard Toggle word wrap
Create new consumer
Optional arguments:
-h, --help
show this help message and exit
--description <description>
New consumer description

3.3.42. openstack consumer delete
Copy link

usage: openstack consumer delete [-h] <consumer>
Copy to Clipboard Toggle word wrap
Delete consumer
Positional arguments:
<consumer>
Consumer to delete
Optional arguments:
-h, --help
show this help message and exit

3.3.43. openstack consumer list
Copy link

usage: openstack consumer list [-h] [-f {csv,html,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List consumers
Optional arguments:
-h, --help
show this help message and exit

3.3.44. openstack consumer set
Copy link

usage: openstack consumer set [-h] [--description <description>] <consumer>
Copy to Clipboard Toggle word wrap
Set consumer properties
Positional arguments:
<consumer>
Consumer to modify
Optional arguments:
-h, --help
show this help message and exit
--description <description>
New consumer description

3.3.45. openstack consumer show
Copy link

usage: openstack consumer show [-h] [-f {html,json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent] [--prefix PREFIX]
                               <consumer>
Copy to Clipboard Toggle word wrap
Display consumer details
Positional arguments:
<consumer>
Consumer to display
Optional arguments:
-h, --help
show this help message and exit

3.3.46. openstack container create
Copy link

usage: openstack container create [-h] [-f {csv,html,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  <container-name> [<container-name> ...]
Copy to Clipboard Toggle word wrap
Create new container
Positional arguments:
<container-name>
New container name(s)
Optional arguments:
-h, --help
show this help message and exit

3.3.47. openstack container delete
Copy link

usage: openstack container delete [-h] [--recursive]
                                  <container> [<container> ...]
Copy to Clipboard Toggle word wrap
Delete container
Positional arguments:
<container>
Container(s) to delete
Optional arguments:
-h, --help
show this help message and exit
--recursive, -r
Recursively delete objects and container

3.3.48. openstack container list
Copy link

usage: openstack container list [-h] [-f {csv,html,json,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--prefix <prefix>] [--marker <marker>]
                                [--end-marker <end-marker>] [--limit <limit>]
                                [--long] [--all]
Copy to Clipboard Toggle word wrap
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)

3.3.49. openstack container save
Copy link

usage: openstack container save [-h] <container>
Copy to Clipboard Toggle word wrap
Save container contents locally
Positional arguments:
<container>
Container to save
Optional arguments:
-h, --help
show this help message and exit

3.3.50. openstack container set
Copy link

usage: openstack container set [-h] --property <key=value> <container>
Copy to Clipboard Toggle word wrap
Set container properties
Positional arguments:
<container>
Container to modify
Optional arguments:
-h, --help
show this help message and exit
--property <key=value>
Set a property on this container (repeat option to set multiple properties)

3.3.51. openstack container show
Copy link

usage: openstack container show [-h] [-f {html,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent] [--prefix PREFIX]
                                <container>
Copy to Clipboard Toggle word wrap
Display container details
Positional arguments:
<container>
Container to display
Optional arguments:
-h, --help
show this help message and exit

3.3.52. openstack container unset
Copy link

usage: openstack container unset [-h] --property <key> <container>
Copy to Clipboard Toggle word wrap
Unset container properties
Positional arguments:
<container>
Container to modify
Optional arguments:
-h, --help
show this help message and exit
--property <key>
Property to remove from container (repeat option to remove multiple properties)

3.3.53. openstack credential create
Copy link

usage: openstack credential create [-h]
                                   [-f {html,json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent] [--prefix PREFIX]
                                   [--type <type>] [--project <project>]
                                   <user> <data>
Copy to Clipboard Toggle word wrap
Create credential command
Positional arguments:
<user>
Name or ID of user that owns the credential
<data>
New credential data
Optional arguments:
-h, --help
show this help message and exit
--type <type>
New credential type
--project <project>
Project name or ID which limits the scope of the credential

3.3.54. openstack credential delete
Copy link

usage: openstack credential delete [-h] <credential-id>
Copy to Clipboard Toggle word wrap
Delete credential command
Positional arguments:
<credential-id>
ID of credential to delete
Optional arguments:
-h, --help
show this help message and exit

3.3.55. openstack credential list
Copy link

usage: openstack credential list [-h] [-f {csv,html,json,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent]
                                 [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List credential command
Optional arguments:
-h, --help
show this help message and exit

3.3.56. openstack credential set
Copy link

usage: openstack credential set [-h] --user <user> --type <type> --data <data>
                                [--project <project>]
                                <credential-id>
Copy to Clipboard Toggle word wrap
Set credential command
Positional arguments:
<credential-id>
ID of credential to change
Optional arguments:
-h, --help
show this help message and exit
--user <user>
Name or ID of user that owns the credential
--type <type>
New credential type
--data <data>
New credential data
--project <project>
Project name or ID which limits the scope of the credential

3.3.57. openstack credential show
Copy link

usage: openstack credential show [-h] [-f {html,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 <credential-id>
Copy to Clipboard Toggle word wrap
Show credential command
Positional arguments:
<credential-id>
ID of credential to display
Optional arguments:
-h, --help
show this help message and exit

3.3.58. openstack dataprocessing cluster create
Copy link

usage: openstack dataprocessing cluster create [-h]
                                               [-f {html,json,shell,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--noindent] [--prefix PREFIX]
                                               [--name <name>]
                                               [--cluster-template <cluster-template>]
                                               [--image <image>]
                                               [--description <description>]
                                               [--user-keypair <keypair>]
                                               [--neutron-network <network>]
                                               [--count <count>] [--public]
                                               [--protected] [--transient]
                                               [--json <filename>] [--wait]
Copy to Clipboard Toggle word wrap
Creates cluster
Optional arguments:
-h, --help
show this help message and exit
--name <name>
Name of the cluster [REQUIRED if JSON is not provided]
--cluster-template <cluster-template>
Cluster template name or ID [REQUIRED if JSON is not provided]
--image <image>
Image that will be used for cluster deployment (Name or ID) [REQUIRED if JSON is not provided]
--description <description>
Description of the cluster
--user-keypair <keypair>
User keypair to get acces to VMs after cluster creation
--neutron-network <network>
Instances of the cluster will get fixed IP addresses in this network. (Name or ID should be provided)
--count <count>
Number of clusters to be created
--public
Make the cluster public (Visible from other tenants)
--protected
Make the cluster protected
--transient
Create transient cluster
--json <filename>
JSON representation of the cluster. Other arguments (except for --wait) will not be taken into account if this one is provided
--wait
Wait for the cluster creation to complete

3.3.59. openstack dataprocessing cluster delete
Copy link

usage: openstack dataprocessing cluster delete [-h] [--wait]
                                               <cluster> [<cluster> ...]
Copy to Clipboard Toggle word wrap
Deletes cluster
Positional arguments:
<cluster>
Name(s) or id(s) of the cluster(s) to delete
Optional arguments:
-h, --help
show this help message and exit
--wait
Wait for the cluster(s) delete to complete

3.3.60. openstack dataprocessing cluster list
Copy link

usage: openstack dataprocessing cluster list [-h]
                                             [-f {csv,html,json,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--noindent]
                                             [--quote {all,minimal,none,nonnumeric}]
                                             [--long] [--plugin <plugin>]
                                             [--plugin-version <plugin_version>]
                                             [--name <name-substring>]
Copy to Clipboard Toggle word wrap
Lists clusters
Optional arguments:
-h, --help
show this help message and exit
--long
List additional fields in output
--plugin <plugin>
List clusters with specific plugin
--plugin-version <plugin_version>
List clusters with specific version of the plugin
--name <name-substring>
List clusters with specific substring in the name

3.3.61. openstack dataprocessing cluster scale
Copy link

usage: openstack dataprocessing cluster scale [-h]
                                              [-f {html,json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--noindent] [--prefix PREFIX]
                                              [--instances <node-group-template:instances_count> [<node-group-template:instances_count> ...]]
                                              [--json <filename>] [--wait]
                                              <cluster>
Copy to Clipboard Toggle word wrap
Scales cluster
Positional arguments:
<cluster>
Name or ID of the cluster
Optional arguments:
-h, --help
show this help message and exit
--instances <node-group-template:instances_count> [<node-group-template:instances_count> ...]
Node group templates and number of their instances to be scale to [REQUIRED if JSON is not provided]
--json <filename>
JSON representation of the cluster scale object. Other arguments (except for --wait) will not be taken into account if this one is provided
--wait
Wait for the cluster scale to complete

3.3.62. openstack dataprocessing cluster show
Copy link

usage: openstack dataprocessing cluster show [-h]
                                             [-f {html,json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--noindent] [--prefix PREFIX]
                                             [--verification]
                                             <cluster>
Copy to Clipboard Toggle word wrap
Display cluster details
Positional arguments:
<cluster>
Name or id of the cluster to display
Optional arguments:
-h, --help
show this help message and exit
--verification
List additional fields for verifications 
usage: openstack dataprocessing cluster template create [-h]
                                                        [-f {html,json,shell,table,value,yaml}]
                                                        [-c COLUMN]
                                                        [--max-width <integer>]
                                                        [--noindent]
                                                        [--prefix PREFIX]
                                                        [--name <name>]
                                                        [--node-groups <node-group:instances_count> [<node-group:instances_count> ...]]
                                                        [--anti-affinity <anti-affinity> [<anti-affinity> ...]]
                                                        [--description <description>]
                                                        [--autoconfig]
                                                        [--public]
                                                        [--protected]
                                                        [--json <filename>]
                                                        [--shares <filename>]
                                                        [--configs <filename>]
Copy to Clipboard Toggle word wrap
Creates cluster template
Optional arguments:
-h, --help
show this help message and exit
--name <name>
Name of the cluster template [REQUIRED if JSON is not provided]
--node-groups <node-group:instances_count> [<node-group:instances_count> ...]
List of the node groups(names or IDs) and numbers of instances for each one of them [REQUIRED if JSON is not provided]
--anti-affinity <anti-affinity> [<anti-affinity> ...]
List of processes that should be added to an anti-affinity group
--description <description>
Description of the cluster template
--autoconfig
If enabled, instances of the cluster will be automatically configured
--public
Make the cluster template public (Visible from other tenants)
--protected
Make the cluster template protected
--json <filename>
JSON representation of the cluster template. Other arguments will not be taken into account if this one is provided
--shares <filename>
JSON representation of the manila shares
--configs <filename>
JSON representation of the cluster template configs 
usage: openstack dataprocessing cluster template delete [-h]
                                                        <cluster-template>
                                                        [<cluster-template> ...]
Copy to Clipboard Toggle word wrap
Deletes cluster template
Positional arguments:
<cluster-template>
Name(s) or id(s) of the cluster template(s) to delete
Optional arguments:
-h, --help
show this help message and exit 
usage: openstack dataprocessing cluster template list [-h]
                                                      [-f {csv,html,json,table,value,yaml}]
                                                      [-c COLUMN]
                                                      [--max-width <integer>]
                                                      [--noindent]
                                                      [--quote {all,minimal,none,nonnumeric}]
                                                      [--long]
                                                      [--plugin <plugin>]
                                                      [--plugin-version <plugin_version>]
                                                      [--name <name-substring>]
Copy to Clipboard Toggle word wrap
Lists cluster templates
Optional arguments:
-h, --help
show this help message and exit
--long
List additional fields in output
--plugin <plugin>
List cluster templates for specific plugin
--plugin-version <plugin_version>
List cluster templates with specific version of the plugin
--name <name-substring>
List cluster templates with specific substring in the name 
usage: openstack dataprocessing cluster template show [-h]
                                                      [-f {html,json,shell,table,value,yaml}]
                                                      [-c COLUMN]
                                                      [--max-width <integer>]
                                                      [--noindent]
                                                      [--prefix PREFIX]
                                                      <cluster-template>
Copy to Clipboard Toggle word wrap
Display cluster template details
Positional arguments:
<cluster-template>
Name or id of the cluster template to display
Optional arguments:
-h, --help
show this help message and exit 
usage: openstack dataprocessing cluster template update [-h]
                                                        [-f {html,json,shell,table,value,yaml}]
                                                        [-c COLUMN]
                                                        [--max-width <integer>]
                                                        [--noindent]
                                                        [--prefix PREFIX]
                                                        [--name <name>]
                                                        [--node-groups <node-group:instances_count> [<node-group:instances_count> ...]]
                                                        [--anti-affinity <anti-affinity> [<anti-affinity> ...]]
                                                        [--description <description>]
                                                        [--autoconfig-enable | --autoconfig-disable]
                                                        [--public | --private]
                                                        [--protected | --unprotected]
                                                        [--json <filename>]
                                                        [--shares <filename>]
                                                        [--configs <filename>]
                                                        <cluster-template>
Copy to Clipboard Toggle word wrap
Updates cluster template
Positional arguments:
<cluster-template>
Name or ID of the cluster template [REQUIRED]
Optional arguments:
-h, --help
show this help message and exit
--name <name>
New name of the cluster template
--node-groups <node-group:instances_count> [<node-group:instances_count> ...]
List of the node groups(names or IDs) and numbers ofinstances for each one of them
--anti-affinity <anti-affinity> [<anti-affinity> ...]
List of processes that should be added to an anti-affinity group
--description <description>
Description of the cluster template
--autoconfig-enable
Instances of the cluster will be automatically configured
--autoconfig-disable
Instances of the cluster will not be automatically configured
--public
Make the cluster template public (Visible from other tenants)
--private
Make the cluster template private (Visible only from this tenant)
--protected
Make the cluster template protected
--unprotected
Make the cluster template unprotected
--json <filename>
JSON representation of the cluster template. Other arguments will not be taken into account if this one is provided
--shares <filename>
JSON representation of the manila shares
--configs <filename>
JSON representation of the cluster template configs

3.3.68. openstack dataprocessing cluster update
Copy link

usage: openstack dataprocessing cluster update [-h]
                                               [-f {html,json,shell,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--noindent] [--prefix PREFIX]
                                               [--name <name>]
                                               [--description <description>]
                                               [--shares <filename>]
                                               [--public | --private]
                                               [--protected | --unprotected]
                                               <cluster>
Copy to Clipboard Toggle word wrap
Updates cluster
Positional arguments:
<cluster>
Name or ID of the cluster
Optional arguments:
-h, --help
show this help message and exit
--name <name>
New name of the cluster
--description <description>
Description of the cluster
--shares <filename>
JSON representation of the manila shares
--public
Make the cluster public (Visible from other tenants)
--private
Make the cluster private (Visible only from this tenant)
--protected
Make the cluster protected
--unprotected
Make the cluster unprotected 
usage: openstack dataprocessing cluster verification [-h]
                                                     [-f {html,json,shell,table,value,yaml}]
                                                     [-c COLUMN]
                                                     [--max-width <integer>]
                                                     [--noindent]
                                                     [--prefix PREFIX]
                                                     (--start | --show)
                                                     <cluster>
Copy to Clipboard Toggle word wrap
Updates cluster verifications
Positional arguments:
<cluster>
Name or ID of the cluster
Optional arguments:
-h, --help
show this help message and exit
--start
Start health verification for the cluster
--show
Show health of the cluster 
usage: openstack dataprocessing data source create [-h]
                                                   [-f {html,json,shell,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--noindent]
                                                   [--prefix PREFIX] --type
                                                   <type> --url <url>
                                                   [--username <username>]
                                                   [--password <password>]
                                                   [--description <description>]
                                                   [--public] [--protected]
                                                   <name>
Copy to Clipboard Toggle word wrap
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, maprfs, manila) [REQUIRED]
--url <url>
Url for the data source [REQUIRED]
--username <username>
Username for accessing the data source url
--password <password>
Password for accessing the data source url
--description <description>
Description of the data source
--public
Make the data source public
--protected
Make the data source protected 
usage: openstack dataprocessing data source delete [-h]
                                                   <data-source>
                                                   [<data-source> ...]
Copy to Clipboard Toggle word wrap
Delete data source
Positional arguments:
<data-source>
Name(s) or id(s) of the data source(s) to delete
Optional arguments:
-h, --help
show this help message and exit

3.3.72. openstack dataprocessing data source list
Copy link

usage: openstack dataprocessing data source list [-h]
                                                 [-f {csv,html,json,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--noindent]
                                                 [--quote {all,minimal,none,nonnumeric}]
                                                 [--long] [--type <type>]
Copy to Clipboard Toggle word wrap
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, maprfs, manila)

3.3.73. openstack dataprocessing data source show
Copy link

usage: openstack dataprocessing data source show [-h]
                                                 [-f {html,json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--noindent]
                                                 [--prefix PREFIX]
                                                 <data-source>
Copy to Clipboard Toggle word wrap
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 
usage: openstack dataprocessing data source update [-h]
                                                   [-f {html,json,shell,table,value,yaml}]
                                                   [-c COLUMN]
                                                   [--max-width <integer>]
                                                   [--noindent]
                                                   [--prefix PREFIX]
                                                   [--name <name>]
                                                   [--type <type>]
                                                   [--url <url>]
                                                   [--username <username>]
                                                   [--password <password>]
                                                   [--description <description>]
                                                   [--public | --private]
                                                   [--protected | --unprotected]
                                                   <data-source>
Copy to Clipboard Toggle word wrap
Update data source
Positional arguments:
<data-source>
Name or id of the data source
Optional arguments:
-h, --help
show this help message and exit
--name <name>
New name of the data source
--type <type>
Type of the data source (swift, hdfs, maprfs, manila)
--url <url>
Url for the data source
--username <username>
Username for accessing the data source url
--password <password>
Password for accessing the data source url
--description <description>
Description of the data source
--public
Make the data source public (Visible from other tenants)
--private
Make the data source private (Visible only from this tenant)
--protected
Make the data source protected
--unprotected
Make the data source unprotected

3.3.75. openstack dataprocessing image list
Copy link

usage: openstack dataprocessing image list [-h]
                                           [-f {csv,html,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--long] [--name <name-regex>]
                                           [--tags <tag> [<tag> ...]]
                                           [--username <username>]
Copy to Clipboard Toggle word wrap
Lists registered images
Optional arguments:
-h, --help
show this help message and exit
--long
List additional fields in output
--name <name-regex>
Regular expression to match image name
--tags <tag> [<tag> ...]
List images with specific tag(s)
--username <username>
List images with specific username

3.3.76. openstack dataprocessing image register
Copy link

usage: openstack dataprocessing image register [-h]
                                               [-f {html,json,shell,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--noindent] [--prefix PREFIX]
                                               --username <username>
                                               [--description <description>]
                                               <image>
Copy to Clipboard Toggle word wrap
Register an image
Positional arguments:
<image>
Name or ID of the image to register
Optional arguments:
-h, --help
show this help message and exit
--username <username>
Username of privileged user in the image [REQUIRED]
--description <description>
Description of the image. If not provided, description of the image will be reset to empty

3.3.77. openstack dataprocessing image show
Copy link

usage: openstack dataprocessing image show [-h]
                                           [-f {html,json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--noindent] [--prefix PREFIX]
                                           <image>
Copy to Clipboard Toggle word wrap
Display image details
Positional arguments:
<image>
Name or id of the image to display
Optional arguments:
-h, --help
show this help message and exit

3.3.78. openstack dataprocessing image tags add
Copy link

usage: openstack dataprocessing image tags add [-h]
                                               [-f {html,json,shell,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--noindent] [--prefix PREFIX]
                                               --tags <tag> [<tag> ...]
                                               <image>
Copy to Clipboard Toggle word wrap
Add image tags
Positional arguments:
<image>
Name or id of the image
Optional arguments:
-h, --help
show this help message and exit
--tags <tag> [<tag> ...]
Tag(s) to add [REQUIRED]

3.3.79. openstack dataprocessing image tags remove
Copy link

usage: openstack dataprocessing image tags remove [-h]
                                                  [-f {html,json,shell,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--noindent]
                                                  [--prefix PREFIX]
                                                  [--tags <tag> [<tag> ...] |
                                                  --all]
                                                  <image>
Copy to Clipboard Toggle word wrap
Remove image tags
Positional arguments:
<image>
Name or id of the image
Optional arguments:
-h, --help
show this help message and exit
--tags <tag> [<tag> ...]
Tag(s) to remove
--all
Remove all tags from image

3.3.80. openstack dataprocessing image tags set
Copy link

usage: openstack dataprocessing image tags set [-h]
                                               [-f {html,json,shell,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--noindent] [--prefix PREFIX]
                                               --tags <tag> [<tag> ...]
                                               <image>
Copy to Clipboard Toggle word wrap
Set image tags (Replace current image tags with provided ones)
Positional arguments:
<image>
Name or id of the image
Optional arguments:
-h, --help
show this help message and exit
--tags <tag> [<tag> ...]
Tag(s) to set [REQUIRED]

3.3.81. openstack dataprocessing image unregister
Copy link

usage: openstack dataprocessing image unregister [-h] <image> [<image> ...]
Copy to Clipboard Toggle word wrap
Unregister image(s)
Positional arguments:
<image>
Name(s) or id(s) of the image(s) to unregister
Optional arguments:
-h, --help
show this help message and exit

3.3.82. openstack dataprocessing job binary create
Copy link

usage: openstack dataprocessing job binary create [-h]
                                                  [-f {html,json,shell,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--noindent]
                                                  [--prefix PREFIX]
                                                  [--name <name>]
                                                  [--data <file> | --url <url>]
                                                  [--description <description>]
                                                  [--username <username>]
                                                  [--password <password> | --password-prompt]
                                                  [--public] [--protected]
                                                  [--json <filename>]
Copy to Clipboard Toggle word wrap
Creates job binary
Optional arguments:
-h, --help
show this help message and exit
--name <name>
Name of the job binary [REQUIRED if JSON is not provided]
--data <file>
File that will be stored in the internal DB [REQUIRED if JSON and URL are not provided]
--url <url>
URL for the job binary [REQUIRED if JSON and file are not provided]
--description <description>
Description of the job binary
--username <username>
Username for accessing the job binary URL
--password <password>
Password for accessing the job binary URL
--password-prompt
Prompt interactively for password
--public
Make the job binary public
--protected
Make the job binary protected
--json <filename>
JSON representation of the job binary. Other arguments will not be taken into account if this one is provided

3.3.83. openstack dataprocessing job binary delete
Copy link

usage: openstack dataprocessing job binary delete [-h]
                                                  <job-binary>
                                                  [<job-binary> ...]
Copy to Clipboard Toggle word wrap
Deletes job binary
Positional arguments:
<job-binary>
Name(s) or id(s) of the job binary(ies) to delete
Optional arguments:
-h, --help
show this help message and exit 
usage: openstack dataprocessing job binary download [-h] [--file <file>]
                                                    <job-binary>
Copy to Clipboard Toggle word wrap
Downloads job binary
Positional arguments:
<job-binary>
Name or ID of the job binary to download
Optional arguments:
-h, --help
show this help message and exit
--file <file>
Destination file (defaults to job binary name)

3.3.85. openstack dataprocessing job binary list
Copy link

usage: openstack dataprocessing job binary list [-h]
                                                [-f {csv,html,json,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--noindent]
                                                [--quote {all,minimal,none,nonnumeric}]
                                                [--long]
                                                [--name <name-substring>]
Copy to Clipboard Toggle word wrap
Lists job binaries
Optional arguments:
-h, --help
show this help message and exit
--long
List additional fields in output
--name <name-substring>
List job binaries with specific substring in the name

3.3.86. openstack dataprocessing job binary show
Copy link

usage: openstack dataprocessing job binary show [-h]
                                                [-f {html,json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--noindent] [--prefix PREFIX]
                                                <job-binary>
Copy to Clipboard Toggle word wrap
Display job binary details
Positional arguments:
<job-binary>
Name or ID of the job binary to display
Optional arguments:
-h, --help
show this help message and exit

3.3.87. openstack dataprocessing job binary update
Copy link

usage: openstack dataprocessing job binary update [-h]
                                                  [-f {html,json,shell,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--noindent]
                                                  [--prefix PREFIX]
                                                  [--name <name>]
                                                  [--url <url>]
                                                  [--description <description>]
                                                  [--username <username>]
                                                  [--password <password> | --password-prompt]
                                                  [--public | --private]
                                                  [--protected | --unprotected]
                                                  [--json <filename>]
                                                  <job-binary>
Copy to Clipboard Toggle word wrap
Updates job binary
Positional arguments:
<job-binary>
Name or ID of the job binary
Optional arguments:
-h, --help
show this help message and exit
--name <name>
New name of the job binary
--url <url>
URL for the job binary [Internal DB URL can not be updated]
--description <description>
Description of the job binary
--username <username>
Username for accessing the job binary URL
--password <password>
Password for accessing the job binary URL
--password-prompt
Prompt interactively for password
--public
Make the job binary public (Visible from other tenants)
--private
Make the job binary private (Visible only from this tenant)
--protected
Make the job binary protected
--unprotected
Make the job binary unprotected
--json <filename>
JSON representation of the update object. Other arguments will not be taken into account if this one is provided

3.3.88. openstack dataprocessing job delete
Copy link

usage: openstack dataprocessing job delete [-h] [--wait] <job> [<job> ...]
Copy to Clipboard Toggle word wrap
Deletes job
Positional arguments:
<job>
ID(s) of the job(s) to delete
Optional arguments:
-h, --help
show this help message and exit
--wait
Wait for the job(s) delete to complete

3.3.89. openstack dataprocessing job execute
Copy link

usage: openstack dataprocessing job execute [-h]
                                            [-f {html,json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--noindent] [--prefix PREFIX]
                                            [--job-template <job-template>]
                                            [--cluster <cluster>]
                                            [--input <input>]
                                            [--output <output>]
                                            [--params <name:value> [<name:value> ...]]
                                            [--args <argument> [<argument> ...]]
                                            [--public] [--protected]
                                            [--config-json <filename> | --configs <name:value> [<name:value> ...]]
                                            [--interface <filename>]
                                            [--json <filename>]
Copy to Clipboard Toggle word wrap
Executes job
Optional arguments:
-h, --help
show this help message and exit
--job-template <job-template>
Name or ID of the job template [REQUIRED if JSON is not provided]
--cluster <cluster>
Name or ID of the cluster [REQUIRED if JSON is not provided]
--input <input>
Name or ID of the input data source
--output <output>
Name or ID of the output data source
--params <name:value> [<name:value> ...]
Parameters to add to the job
--args <argument> [<argument> ...]
Arguments to add to the job
--public
Make the job public
--protected
Make the job protected
--config-json <filename>
JSON representation of the job configs
--configs <name:value> [<name:value> ...]
Configs to add to the job
--interface <filename>
JSON representation of the interface
--json <filename>
JSON representation of the job. Other arguments will not be taken into account if this one is provided

3.3.90. openstack dataprocessing job list
Copy link

usage: openstack dataprocessing job list [-h]
                                         [-f {csv,html,json,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
                                         [--long] [--status <status>]
Copy to Clipboard Toggle word wrap
Lists jobs
Optional arguments:
-h, --help
show this help message and exit
--long
List additional fields in output
--status <status>
List jobs with specific status

3.3.91. openstack dataprocessing job show
Copy link

usage: openstack dataprocessing job show [-h]
                                         [-f {html,json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--noindent] [--prefix PREFIX]
                                         <job>
Copy to Clipboard Toggle word wrap
Display job details
Positional arguments:
<job>
ID of the job to display
Optional arguments:
-h, --help
show this help message and exit 
usage: openstack dataprocessing job template create [-h]
                                                    [-f {html,json,shell,table,value,yaml}]
                                                    [-c COLUMN]
                                                    [--max-width <integer>]
                                                    [--noindent]
                                                    [--prefix PREFIX]
                                                    [--name <name>]
                                                    [--type <type>]
                                                    [--mains <main> [<main> ...]]
                                                    [--libs <lib> [<lib> ...]]
                                                    [--description <description>]
                                                    [--public] [--protected]
                                                    [--interface <filename>]
                                                    [--json <filename>]
Copy to Clipboard Toggle word wrap
Creates job template
Optional arguments:
-h, --help
show this help message and exit
--name <name>
Name of the job template [REQUIRED if JSON is not provided]
--type <type>
Type of the job (Hive, Java, MapReduce, Storm, Pig, Shell, MapReduce.Streaming, Spark) [REQUIRED if JSON is not provided]
--mains <main> [<main> ...]
Name(s) or ID(s) for job's main job binary(s)
--libs <lib> [<lib> ...]
Name(s) or ID(s) for job's lib job binary(s)
--description <description>
Description of the job template
--public
Make the job template public
--protected
Make the job template protected
--interface <filename>
JSON representation of the interface
--json <filename>
JSON representation of the job template 
usage: openstack dataprocessing job template delete [-h]
                                                    <job-template>
                                                    [<job-template> ...]
Copy to Clipboard Toggle word wrap
Deletes job template
Positional arguments:
<job-template>
Name(s) or id(s) of the job template(s) to delete
Optional arguments:
-h, --help
show this help message and exit

3.3.94. openstack dataprocessing job template list
Copy link

usage: openstack dataprocessing job template list [-h]
                                                  [-f {csv,html,json,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--noindent]
                                                  [--quote {all,minimal,none,nonnumeric}]
                                                  [--long] [--type <type>]
                                                  [--name <name-substring>]
Copy to Clipboard Toggle word wrap
Lists job templates
Optional arguments:
-h, --help
show this help message and exit
--long
List additional fields in output
--type <type>
List job templates of specific type
--name <name-substring>
List job templates with specific substring in the name

3.3.95. openstack dataprocessing job template show
Copy link

usage: openstack dataprocessing job template show [-h]
                                                  [-f {html,json,shell,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--noindent]
                                                  [--prefix PREFIX]
                                                  <job-template>
Copy to Clipboard Toggle word wrap
Display job template details
Positional arguments:
<job-template>
Name or ID of the job template to display
Optional arguments:
-h, --help
show this help message and exit 
usage: openstack dataprocessing job template update [-h]
                                                    [-f {html,json,shell,table,value,yaml}]
                                                    [-c COLUMN]
                                                    [--max-width <integer>]
                                                    [--noindent]
                                                    [--prefix PREFIX]
                                                    [--name <name>]
                                                    [--description <description>]
                                                    [--public | --private]
                                                    [--protected | --unprotected]
                                                    <job-template>
Copy to Clipboard Toggle word wrap
Updates job template
Positional arguments:
<job-template>
Name or ID of the job template
Optional arguments:
-h, --help
show this help message and exit
--name <name>
New name of the job template
--description <description>
Description of the job template
--public
Make the job template public (Visible from other tenants)
--private
Make the job_template private (Visible only from this tenant)
--protected
Make the job template protected
--unprotected
Make the job template unprotected 
usage: openstack dataprocessing job type configs get [-h] [--file <file>]
                                                     <job-type>
Copy to Clipboard Toggle word wrap
Get job type configs
Positional arguments:
<job-type>
Type of the job to provide config information about
Optional arguments:
-h, --help
show this help message and exit
--file <file>
Destination file (defaults to job type)

3.3.98. openstack dataprocessing job type list
Copy link

usage: openstack dataprocessing job type list [-h]
                                              [-f {csv,html,json,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--noindent]
                                              [--quote {all,minimal,none,nonnumeric}]
                                              [--type <type>]
                                              [--plugin <plugin>]
                                              [--plugin-version <plugin_version>]
Copy to Clipboard Toggle word wrap
Lists job types supported by plugins
Optional arguments:
-h, --help
show this help message and exit
--type <type>
Get information about specific job type
--plugin <plugin>
Get only job types supported by this plugin
--plugin-version <plugin_version>
Get only job types supported by specific version of the plugin. This parameter will be taken into account only if plugin is provided

3.3.99. openstack dataprocessing job update
Copy link

usage: openstack dataprocessing job update [-h]
                                           [-f {html,json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--noindent] [--prefix PREFIX]
                                           [--public | --private]
                                           [--protected | --unprotected]
                                           <job>
Copy to Clipboard Toggle word wrap
Updates job
Positional arguments:
<job>
ID of the job to update
Optional arguments:
-h, --help
show this help message and exit
--public
Make the job public (Visible from other tenants)
--private
Make the job private (Visible only from this tenant)
--protected
Make the job protected
--unprotected
Make the job unprotected 
usage: openstack dataprocessing node group template create [-h]
                                                           [-f {html,json,shell,table,value,yaml}]
                                                           [-c COLUMN]
                                                           [--max-width <integer>]
                                                           [--noindent]
                                                           [--prefix PREFIX]
                                                           [--name <name>]
                                                           [--plugin <plugin>]
                                                           [--plugin-version <plugin_version>]
                                                           [--processes <processes> [<processes> ...]]
                                                           [--flavor <flavor>]
                                                           [--security-groups <security-groups> [<security-groups> ...]]
                                                           [--auto-security-group]
                                                           [--availability-zone <availability-zone>]
                                                           [--floating-ip-pool <floating-ip-pool>]
                                                           [--volumes-per-node <volumes-per-node>]
                                                           [--volumes-size <volumes-size>]
                                                           [--volumes-type <volumes-type>]
                                                           [--volumes-availability-zone <volumes-availability-zone>]
                                                           [--volumes-mount-prefix <volumes-mount-prefix>]
                                                           [--volumes-locality]
                                                           [--description <description>]
                                                           [--autoconfig]
                                                           [--proxy-gateway]
                                                           [--public]
                                                           [--protected]
                                                           [--json <filename>]
                                                           [--shares <filename>]
                                                           [--configs <filename>]
Copy to Clipboard Toggle word wrap
Creates node group template
Optional arguments:
-h, --help
show this help message and exit
--name <name>
Name of the node group template [REQUIRED if JSON is not provided]
--plugin <plugin>
Name of the plugin [REQUIRED if JSON is not provided]
--plugin-version <plugin_version>
Version of the plugin [REQUIRED if JSON is not provided]
--processes <processes> [<processes> ...]
List of the processes that will be launched on each instance [REQUIRED if JSON is not provided]
--flavor <flavor>
Name or ID of the flavor [REQUIRED if JSON is not provided]
--security-groups <security-groups> [<security-groups> ...]
List of the security groups for the instances in this node group
--auto-security-group
Indicates if an additional security group should be created for the node group
--availability-zone <availability-zone>
Name of the availability zone where instances will be created
--floating-ip-pool <floating-ip-pool>
ID of the floating IP pool
--volumes-per-node <volumes-per-node>
Number of volumes attached to every node
--volumes-size <volumes-size>
Size of volumes attached to node (GB). This parameter will be taken into account only if volumes-per-node is set and non-zero
--volumes-type <volumes-type>
Type of the volumes. This parameter will be taken into account only if volumes-per-node is set and non-zero
--volumes-availability-zone <volumes-availability-zone>
Name of the availability zone where volumes will be created. This parameter will be taken into account only if volumes-per-node is set and non-zero
--volumes-mount-prefix <volumes-mount-prefix>
Prefix for mount point directory. This parameter will be taken into account only if volumes-per-node is set and non-zero
--volumes-locality
If enabled, instance and attached volumes will be created on the same physical host. This parameter will be taken into account only if volumes-per-node is set and non-zero
--description <description>
Description of the node group template
--autoconfig
If enabled, instances of the node group will be automatically configured
--proxy-gateway
If enabled, instances of the node group will be used to access other instances in the cluster
--public
Make the node group template public (Visible from other tenants)
--protected
Make the node group template protected
--json <filename>
JSON representation of the node group template. Other arguments will not be taken into account if this one is provided
--shares <filename>
JSON representation of the manila shares
--configs <filename>
JSON representation of the node group template configs 
usage: openstack dataprocessing node group template delete [-h]
                                                           <node-group-template>
                                                           [<node-group-template> ...]
Copy to Clipboard Toggle word wrap
Deletes node group template
Positional arguments:
<node-group-template>
Name(s) or id(s) of the node group template(s) to delete
Optional arguments:
-h, --help
show this help message and exit 
usage: openstack dataprocessing node group template list [-h]
                                                         [-f {csv,html,json,table,value,yaml}]
                                                         [-c COLUMN]
                                                         [--max-width <integer>]
                                                         [--noindent]
                                                         [--quote {all,minimal,none,nonnumeric}]
                                                         [--long]
                                                         [--plugin <plugin>]
                                                         [--plugin-version <plugin_version>]
                                                         [--name <name-substring>]
Copy to Clipboard Toggle word wrap
Lists node group templates
Optional arguments:
-h, --help
show this help message and exit
--long
List additional fields in output
--plugin <plugin>
List node group templates for specific plugin
--plugin-version <plugin_version>
List node group templates with specific version of the plugin
--name <name-substring>
List node group templates with specific substring in the name 
usage: openstack dataprocessing node group template show [-h]
                                                         [-f {html,json,shell,table,value,yaml}]
                                                         [-c COLUMN]
                                                         [--max-width <integer>]
                                                         [--noindent]
                                                         [--prefix PREFIX]
                                                         <node-group-template>
Copy to Clipboard Toggle word wrap
Display node group template details
Positional arguments:
<node-group-template>
Name or id of the node group template to display
Optional arguments:
-h, --help
show this help message and exit 
usage: openstack dataprocessing node group template update [-h]
                                                           [-f {html,json,shell,table,value,yaml}]
                                                           [-c COLUMN]
                                                           [--max-width <integer>]
                                                           [--noindent]
                                                           [--prefix PREFIX]
                                                           [--name <name>]
                                                           [--plugin <plugin>]
                                                           [--plugin-version <plugin_version>]
                                                           [--processes <processes> [<processes> ...]]
                                                           [--security-groups <security-groups> [<security-groups> ...]]
                                                           [--auto-security-group-enable | --auto-security-group-disable]
                                                           [--availability-zone <availability-zone>]
                                                           [--flavor <flavor>]
                                                           [--floating-ip-pool <floating-ip-pool>]
                                                           [--volumes-per-node <volumes-per-node>]
                                                           [--volumes-size <volumes-size>]
                                                           [--volumes-type <volumes-type>]
                                                           [--volumes-availability-zone <volumes-availability-zone>]
                                                           [--volumes-mount-prefix <volumes-mount-prefix>]
                                                           [--volumes-locality-enable | --volumes-locality-disable]
                                                           [--description <description>]
                                                           [--autoconfig-enable | --autoconfig-disable]
                                                           [--proxy-gateway-enable | --proxy-gateway-disable]
                                                           [--public | --private]
                                                           [--protected | --unprotected]
                                                           [--json <filename>]
                                                           [--shares <filename>]
                                                           [--configs <filename>]
                                                           <node-group-template>
Copy to Clipboard Toggle word wrap
Updates node group template
Positional arguments:
<node-group-template>
Name or ID of the node group template
Optional arguments:
-h, --help
show this help message and exit
--name <name>
New name of the node group template
--plugin <plugin>
Name of the plugin
--plugin-version <plugin_version>
Version of the plugin
--processes <processes> [<processes> ...]
List of the processes that will be launched on each instance
--security-groups <security-groups> [<security-groups> ...]
List of the security groups for the instances in this node group
--auto-security-group-enable
Additional security group should be created for the node group
--auto-security-group-disable
Additional security group should not be created for the node group
--availability-zone <availability-zone>
Name of the availability zone where instances will be created
--flavor <flavor>
Name or ID of the flavor
--floating-ip-pool <floating-ip-pool>
ID of the floating IP pool
--volumes-per-node <volumes-per-node>
Number of volumes attached to every node
--volumes-size <volumes-size>
Size of volumes attached to node (GB). This parameter will be taken into account only if volumes-per-node is set and non-zero
--volumes-type <volumes-type>
Type of the volumes. This parameter will be taken into account only if volumes-per-node is set and non-zero
--volumes-availability-zone <volumes-availability-zone>
Name of the availability zone where volumes will be created. This parameter will be taken into account only if volumes-per-node is set and non-zero
--volumes-mount-prefix <volumes-mount-prefix>
Prefix for mount point directory. This parameter will be taken into account only if volumes-per-node is set and non-zero
--volumes-locality-enable
Instance and attached volumes will be created on the same physical host. This parameter will be taken into account only if volumes-per-node is set and non-zero
--volumes-locality-disable
Instance and attached volumes creation on the same physical host will not be regulated. This parameter will be takeninto account only if volumes-per-node is set and non-zero
--description <description>
Description of the node group template
--autoconfig-enable
Instances of the node group will be automatically configured
--autoconfig-disable
Instances of the node group will not be automatically configured
--proxy-gateway-enable
Instances of the node group will be used to access other instances in the cluster
--proxy-gateway-disable
Instances of the node group will not be used to access other instances in the cluster
--public
Make the node group template public (Visible from other tenants)
--private
Make the node group template private (Visible only from this tenant)
--protected
Make the node group template protected
--unprotected
Make the node group template unprotected
--json <filename>
JSON representation of the node group template update fields. Other arguments will not be taken into account if this one is provided
--shares <filename>
JSON representation of the manila shares
--configs <filename>
JSON representation of the node group template configs 
usage: openstack dataprocessing plugin configs get [-h] [--file <file>]
                                                   <plugin> <plugin_version>
Copy to Clipboard Toggle word wrap
Get plugin configs
Positional arguments:
<plugin>
Name of the plugin to provide config information about
<plugin_version>
Version of the plugin to provide config information about
Optional arguments:
-h, --help
show this help message and exit
--file <file>
Destination file (defaults to plugin name)

3.3.106. openstack dataprocessing plugin list
Copy link

usage: openstack dataprocessing plugin list [-h]
                                            [-f {csv,html,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--noindent]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--long]
Copy to Clipboard Toggle word wrap
Lists plugins
Optional arguments:
-h, --help
show this help message and exit
--long
List additional fields in output

3.3.107. openstack dataprocessing plugin show
Copy link

usage: openstack dataprocessing plugin show [-h]
                                            [-f {html,json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--noindent] [--prefix PREFIX]
                                            [--plugin-version <plugin_version>]
                                            <plugin>
Copy to Clipboard Toggle word wrap
Display plugin details
Positional arguments:
<plugin>
Name of the plugin to display
Optional arguments:
-h, --help
show this help message and exit
--plugin-version <plugin_version>
Version of the plugin to display

3.3.108. openstack domain create
Copy link

usage: openstack domain create [-h] [-f {html,json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent] [--prefix PREFIX]
                               [--description <description>]
                               [--enable | --disable] [--or-show]
                               <domain-name>
Copy to Clipboard Toggle word wrap
Create new domain
Positional arguments:
<domain-name>
New domain name
Optional arguments:
-h, --help
show this help message and exit
--description <description>
New domain description
--enable
Enable domain (default)
--disable
Disable domain
--or-show
Return existing domain

3.3.109. openstack domain delete
Copy link

usage: openstack domain delete [-h] <domain>
Copy to Clipboard Toggle word wrap
Delete domain
Positional arguments:
<domain>
Domain to delete (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.110. openstack domain list
Copy link

usage: openstack domain list [-h] [-f {csv,html,json,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List domains
Optional arguments:
-h, --help
show this help message and exit

3.3.111. openstack domain set
Copy link

usage: openstack domain set [-h] [--name <name>] [--description <description>]
                            [--enable | --disable]
                            <domain>
Copy to Clipboard Toggle word wrap
Set domain properties
Positional arguments:
<domain>
Domain to modify (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--name <name>
New domain name
--description <description>
New domain description
--enable
Enable domain
--disable
Disable domain

3.3.112. openstack domain show
Copy link

usage: openstack domain show [-h] [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX]
                             <domain>
Copy to Clipboard Toggle word wrap
Display domain details
Positional arguments:
<domain>
Domain to display (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.113. openstack ec2 credentials create
Copy link

usage: openstack ec2 credentials create [-h]
                                        [-f {html,json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent] [--prefix PREFIX]
                                        [--project <project>] [--user <user>]
                                        [--user-domain <user-domain>]
                                        [--project-domain <project-domain>]
Copy to Clipboard Toggle word wrap
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)
--user-domain <user-domain>
Domain the user belongs to (name or ID). This can be used in case collisions between user names exist.
--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.114. openstack ec2 credentials delete
Copy link

usage: openstack ec2 credentials delete [-h] [--user <user>]
                                        [--user-domain <user-domain>]
                                        <access-key>
Copy to Clipboard Toggle word wrap
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)
--user-domain <user-domain>
Domain the user belongs to (name or ID). This can be used in case collisions between user names exist.

3.3.115. openstack ec2 credentials list
Copy link

usage: openstack ec2 credentials list [-h]
                                      [-f {csv,html,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--user <user>]
                                      [--user-domain <user-domain>]
Copy to Clipboard Toggle word wrap
List EC2 credentials
Optional arguments:
-h, --help
show this help message and exit
--user <user>
Filter list by user (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.

3.3.116. openstack ec2 credentials show
Copy link

usage: openstack ec2 credentials show [-h]
                                      [-f {html,json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--noindent] [--prefix PREFIX]
                                      [--user <user>]
                                      [--user-domain <user-domain>]
                                      <access-key>
Copy to Clipboard Toggle word wrap
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)
--user-domain <user-domain>
Domain the user belongs to (name or ID). This can be used in case collisions between user names exist.

3.3.117. openstack endpoint create
Copy link

usage: openstack endpoint create [-h] [-f {html,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 [--region <region-id>] [--enable | --disable]
                                 <service> <interface> <url>
Copy to Clipboard Toggle word wrap
Create new endpoint
Positional arguments:
<service>
New endpoint service (name or ID)
<interface>
New endpoint interface type (admin, public or internal)
<url>
New endpoint URL
Optional arguments:
-h, --help
show this help message and exit
--region <region-id>
New endpoint region ID
--enable
Enable endpoint (default)
--disable
Disable endpoint

3.3.118. openstack endpoint delete
Copy link

usage: openstack endpoint delete [-h] <endpoint-id>
Copy to Clipboard Toggle word wrap
Delete endpoint
Positional arguments:
<endpoint-id>
Endpoint ID to delete
Optional arguments:
-h, --help
show this help message and exit

3.3.119. openstack endpoint list
Copy link

usage: openstack endpoint list [-h] [-f {csv,html,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--service <service>] [--interface <interface>]
                               [--region <region-id>]
Copy to Clipboard Toggle word wrap
List endpoints
Optional arguments:
-h, --help
show this help message and exit
--service <service>
Filter by service
--interface <interface>
Filter by interface type (admin, public or internal)
--region <region-id>
Filter by region ID

3.3.120. openstack endpoint set
Copy link

usage: openstack endpoint set [-h] [--region <region-id>]
                              [--interface <interface>] [--url <url>]
                              [--service <service>] [--enable | --disable]
                              <endpoint-id>
Copy to Clipboard Toggle word wrap
Set endpoint properties
Positional arguments:
<endpoint-id>
Endpoint ID to modify
Optional arguments:
-h, --help
show this help message and exit
--region <region-id>
New endpoint region ID
--interface <interface>
New endpoint interface type (admin, public or internal)
--url <url>
New endpoint URL
--service <service>
New endpoint service (name or ID)
--enable
Enable endpoint
--disable
Disable endpoint

3.3.121. openstack endpoint show
Copy link

usage: openstack endpoint show [-h] [-f {html,json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent] [--prefix PREFIX]
                               <endpoint>
Copy to Clipboard Toggle word wrap
Display endpoint details
Positional arguments:
<endpoint>
Endpoint to display (endpoint ID, service ID, service name, service type)
Optional arguments:
-h, --help
show this help message and exit

3.3.122. openstack extension list
Copy link

usage: openstack extension list [-h] [-f {csv,html,json,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--compute] [--identity] [--network]
                                [--volume] [--long]
Copy to Clipboard Toggle word wrap
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 Block Storage API
--long
List additional fields in output

3.3.123. openstack federation domain list
Copy link

usage: openstack federation domain list [-h]
                                        [-f {csv,html,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List accessible domains
Optional arguments:
-h, --help
show this help message and exit

3.3.124. openstack federation project list
Copy link

usage: openstack federation project list [-h]
                                         [-f {csv,html,json,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--noindent]
                                         [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List accessible projects
Optional arguments:
-h, --help
show this help message and exit

3.3.125. openstack federation protocol create
Copy link

usage: openstack federation protocol create [-h]
                                            [-f {html,json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--noindent] [--prefix PREFIX]
                                            --identity-provider
                                            <identity-provider> --mapping
                                            <mapping>
                                            <name>
Copy to Clipboard Toggle word wrap
Create new federation protocol
Positional arguments:
<name>
New federation protocol name (must be unique per identity provider)
Optional arguments:
-h, --help
show this help message and exit
--identity-provider <identity-provider>
Identity provider that will support the new federation protocol (name or ID) (required)
--mapping <mapping>
Mapping that is to be used (name or ID) (required)

3.3.126. openstack federation protocol delete
Copy link

usage: openstack federation protocol delete [-h] --identity-provider
                                            <identity-provider>
                                            <federation-protocol>
Copy to Clipboard Toggle word wrap
Delete federation protocol
Positional arguments:
<federation-protocol>
Federation protocol to delete (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--identity-provider <identity-provider>
Identity provider that supports <federation-protocol> (name or ID) (required)

3.3.127. openstack federation protocol list
Copy link

usage: openstack federation protocol list [-h]
                                          [-f {csv,html,json,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          --identity-provider
                                          <identity-provider>
Copy to Clipboard Toggle word wrap
List federation protocols
Optional arguments:
-h, --help
show this help message and exit
--identity-provider <identity-provider>
Identity provider to list (name or ID) (required)

3.3.128. openstack federation protocol set
Copy link

usage: openstack federation protocol set [-h] --identity-provider
                                         <identity-provider>
                                         [--mapping <mapping>]
                                         <name>
Copy to Clipboard Toggle word wrap
Set federation protocol properties
Positional arguments:
<name>
Federation protocol to modify (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--identity-provider <identity-provider>
Identity provider that supports <federation-protocol> (name or ID) (required)
--mapping <mapping>
Mapping that is to be used (name or ID)

3.3.129. openstack federation protocol show
Copy link

usage: openstack federation protocol show [-h]
                                          [-f {html,json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent] [--prefix PREFIX]
                                          --identity-provider
                                          <identity-provider>
                                          <federation-protocol>
Copy to Clipboard Toggle word wrap
Display federation protocol details
Positional arguments:
<federation-protocol>
Federation protocol to display (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--identity-provider <identity-provider>
Identity provider that supports <federation-protocol> (name or ID) (required)

3.3.130. openstack flavor create
Copy link

usage: openstack flavor create [-h] [-f {html,json,shell,table,value,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>
Copy to Clipboard Toggle word wrap
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.0)
--public
Flavor is available to other projects (default)
--private
Flavor is not available to other projects

3.3.131. openstack flavor delete
Copy link

usage: openstack flavor delete [-h] <flavor>
Copy to Clipboard Toggle word wrap
Delete flavor
Positional arguments:
<flavor>
Flavor to delete (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.132. openstack flavor list
Copy link

usage: openstack flavor list [-h] [-f {csv,html,json,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--public | --private | --all] [--long]
                             [--marker <marker>] [--limit <limit>]
Copy to Clipboard Toggle word wrap
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
--marker <marker>
The last flavor ID of the previous page
--limit <limit>
Maximum number of flavors to display

3.3.133. openstack flavor set
Copy link

usage: openstack flavor set [-h] [--property <key=value>]
                            [--project <project>]
                            [--project-domain <project-domain>]
                            <flavor>
Copy to Clipboard Toggle word wrap
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)
--project <project>
Set flavor access to project (name or ID) (admin only)
--project-domain <project-domain>
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

3.3.134. openstack flavor show
Copy link

usage: openstack flavor show [-h] [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX]
                             <flavor>
Copy to Clipboard Toggle word wrap
Display flavor details
Positional arguments:
<flavor>
Flavor to display (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.135. openstack flavor unset
Copy link

usage: openstack flavor unset [-h] [--property <key>] [--project <project>]
                              [--project-domain <project-domain>]
                              <flavor>
Copy to Clipboard Toggle word wrap
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)
--project <project>
Remove flavor access from project (name or ID) (admin only)
--project-domain <project-domain>
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

3.3.136. openstack group add user
Copy link

usage: openstack group add user [-h] [--group-domain <group-domain>]
                                [--user-domain <user-domain>]
                                <group> <user>
Copy to Clipboard Toggle word wrap
Add user to group
Positional arguments:
<group>
Group to contain <user> (name or ID)
<user>
User to add to <group> (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--group-domain <group-domain>
Domain the group belongs to (name or ID). This can be used in case collisions between group names exist.
--user-domain <user-domain>
Domain the user belongs to (name or ID). This can be used in case collisions between user names exist.

3.3.137. openstack group contains user
Copy link

usage: openstack group contains user [-h] [--group-domain <group-domain>]
                                     [--user-domain <user-domain>]
                                     <group> <user>
Copy to Clipboard Toggle word wrap
Check user membership in group
Positional arguments:
<group>
Group to check (name or ID)
<user>
User to check (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--group-domain <group-domain>
Domain the group belongs to (name or ID). This can be used in case collisions between group names exist.
--user-domain <user-domain>
Domain the user belongs to (name or ID). This can be used in case collisions between user names exist.

3.3.138. openstack group create
Copy link

usage: openstack group create [-h] [-f {html,json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--prefix PREFIX] [--domain <domain>]
                              [--description <description>] [--or-show]
                              <group-name>
Copy to Clipboard Toggle word wrap
Create new group
Positional arguments:
<group-name>
New group name
Optional arguments:
-h, --help
show this help message and exit
--domain <domain>
Domain to contain new group (name or ID)
--description <description>
New group description
--or-show
Return existing group

3.3.139. openstack group delete
Copy link

usage: openstack group delete [-h] [--domain <domain>] <group> [<group> ...]
Copy to Clipboard Toggle word wrap
Delete group(s)
Positional arguments:
<group>
Group(s) to delete (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--domain <domain>
Domain containing group(s) (name or ID)

3.3.140. openstack group list
Copy link

usage: openstack group list [-h] [-f {csv,html,json,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--noindent]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--domain <domain>] [--user <user>]
                            [--user-domain <user-domain>] [--long]
Copy to Clipboard Toggle word wrap
List groups
Optional arguments:
-h, --help
show this help message and exit
--domain <domain>
Filter group list by <domain> (name or ID)
--user <user>
Filter group list by <user> (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

3.3.141. openstack group remove user
Copy link

usage: openstack group remove user [-h] [--group-domain <group-domain>]
                                   [--user-domain <user-domain>]
                                   <group> <user>
Copy to Clipboard Toggle word wrap
Remove user from group
Positional arguments:
<group>
Group containing <user> (name or ID)
<user>
User to remove from <group> (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--group-domain <group-domain>
Domain the group belongs to (name or ID). This can be used in case collisions between group names exist.
--user-domain <user-domain>
Domain the user belongs to (name or ID). This can be used in case collisions between user names exist.

3.3.142. openstack group set
Copy link

usage: openstack group set [-h] [--domain <domain>] [--name <name>]
                           [--description <description>]
                           <group>
Copy to Clipboard Toggle word wrap
Set group properties
Positional arguments:
<group>
Group to modify (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--domain <domain>
Domain containing <group> (name or ID)
--name <name>
New group name
--description <description>
New group description

3.3.143. openstack group show
Copy link

usage: openstack group show [-h] [-f {html,json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--noindent]
                            [--prefix PREFIX] [--domain <domain>]
                            <group>
Copy to Clipboard Toggle word wrap
Display group details
Positional arguments:
<group>
Group to display (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--domain <domain>
Domain containing <group> (name or ID)

3.3.144. openstack host list
Copy link

usage: openstack host list [-h] [-f {csv,html,json,table,value,yaml}]
                           [-c COLUMN] [--max-width <integer>] [--noindent]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--zone <zone>]
Copy to Clipboard Toggle word wrap
List host command
Optional arguments:
-h, --help
show this help message and exit
--zone <zone>
Only return hosts in the availability zone

3.3.145. openstack host show
Copy link

usage: openstack host show [-h] [-f {csv,html,json,table,value,yaml}]
                           [-c COLUMN] [--max-width <integer>] [--noindent]
                           [--quote {all,minimal,none,nonnumeric}]
                           <host>
Copy to Clipboard Toggle word wrap
Show host command
Positional arguments:
<host>
Name of host
Optional arguments:
-h, --help
show this help message and exit

3.3.146. openstack hypervisor list
Copy link

usage: openstack hypervisor list [-h] [-f {csv,html,json,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--matching <hostname>]
Copy to Clipboard Toggle word wrap
List hypervisors
Optional arguments:
-h, --help
show this help message and exit
--matching <hostname>
Filter hypervisors using <hostname> substring

3.3.147. openstack hypervisor show
Copy link

usage: openstack hypervisor show [-h] [-f {html,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 <hypervisor>
Copy to Clipboard Toggle word wrap
Display hypervisor details
Positional arguments:
<hypervisor>
Hypervisor to display (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.148. openstack hypervisor stats show
Copy link

usage: openstack hypervisor stats show [-h]
                                       [-f {html,json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--noindent] [--prefix PREFIX]
Copy to Clipboard Toggle word wrap
Display hypervisor stats details
Optional arguments:
-h, --help
show this help message and exit

3.3.149. openstack identity provider create
Copy link

usage: openstack identity provider create [-h]
                                          [-f {html,json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent] [--prefix PREFIX]
                                          [--remote-id <remote-id> | --remote-id-file <file-name>]
                                          [--description <description>]
                                          [--enable | --disable]
                                          <name>
Copy to Clipboard Toggle word wrap
Create new identity provider
Positional arguments:
<name>
New identity provider name (must be unique)
Optional arguments:
-h, --help
show this help message and exit
--remote-id <remote-id>
Remote IDs to associate with the Identity Provider (repeat option to provide multiple values)
--remote-id-file <file-name>
Name of a file that contains many remote IDs to associate with the identity provider, one per line
--description <description>
New identity provider description
--enable
Enable identity provider (default)
--disable
Disable the identity provider

3.3.150. openstack identity provider delete
Copy link

usage: openstack identity provider delete [-h] <identity-provider>
Copy to Clipboard Toggle word wrap
Delete identity provider
Positional arguments:
<identity-provider>
Identity provider to delete
Optional arguments:
-h, --help
show this help message and exit

3.3.151. openstack identity provider list
Copy link

usage: openstack identity provider list [-h]
                                        [-f {csv,html,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List identity providers
Optional arguments:
-h, --help
show this help message and exit

3.3.152. openstack identity provider set
Copy link

usage: openstack identity provider set [-h] [--description <description>]
                                       [--remote-id <remote-id> | --remote-id-file <file-name>]
                                       [--enable | --disable]
                                       <identity-provider>
Copy to Clipboard Toggle word wrap
Set identity provider properties
Positional arguments:
<identity-provider>
Identity provider to modify
Optional arguments:
-h, --help
show this help message and exit
--description <description>
Set identity provider description
--remote-id <remote-id>
Remote IDs to associate with the Identity Provider (repeat option to provide multiple values)
--remote-id-file <file-name>
Name of a file that contains many remote IDs to associate with the identity provider, one per line
--enable
Enable the identity provider
--disable
Disable the identity provider

3.3.153. openstack identity provider show
Copy link

usage: openstack identity provider show [-h]
                                        [-f {html,json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent] [--prefix PREFIX]
                                        <identity-provider>
Copy to Clipboard Toggle word wrap
Display identity provider details
Positional arguments:
<identity-provider>
Identity provider to display
Optional arguments:
-h, --help
show this help message and exit

3.3.154. openstack image add project
Copy link

usage: openstack image add project [-h]
                                   [-f {html,json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent] [--prefix PREFIX]
                                   [--project-domain <project-domain>]
                                   <image> <project>
Copy to Clipboard Toggle word wrap
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.

3.3.155. openstack image create
Copy link

usage: openstack image create [-h] [-f {html,json,shell,table,value,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>] [--volume <volume>] [--force]
                              [--protected | --unprotected]
                              [--public | --private] [--property <key=value>]
                              [--tag <tag>] [--project <project>]
                              [--project-domain <project-domain>]
                              <image-name>
Copy to Clipboard Toggle word wrap
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
--volume <volume>
Create image from a volume
--force
Force image creation if volume is in use (only meaningful with --volume)
--protected
Prevent image from being deleted
--unprotected
Allow image to be deleted (default)
--public
Image is accessible to the public
--private
Image is inaccessible to the public (default)
--property <key=value>
Set a property on this image (repeat option to set multiple properties)
--tag <tag>
Set a tag on this image (repeat option to set multiple tags)
--project <project>
Set an alternate project on this image (name or ID)
--project-domain <project-domain>
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

3.3.156. openstack image delete
Copy link

usage: openstack image delete [-h] <image> [<image> ...]
Copy to Clipboard Toggle word wrap
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.157. openstack image list
Copy link

usage: openstack image list [-h] [-f {csv,html,json,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--noindent]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--public | --private | --shared]
                            [--property <key=value>] [--long]
                            [--sort <key>[:<direction>]] [--limit <limit>]
                            [--marker <marker>]
Copy to Clipboard Toggle word wrap
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
--limit <limit>
Maximum number of images to display.
--marker <marker>
The last image (name or ID) of the previous page. Display list of images after marker. Display all images if not specified.

3.3.158. openstack image remove project
Copy link

usage: openstack image remove project [-h] [--project-domain <project-domain>]
                                      <image> <project>
Copy to Clipboard Toggle word wrap
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.159. openstack image save
Copy link

usage: openstack image save [-h] [--file <filename>] <image>
Copy to Clipboard Toggle word wrap
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.160. openstack image set
Copy link

usage: openstack image set [-h] [--name <name>] [--min-disk <disk-gb>]
                           [--min-ram <ram-mb>]
                           [--container-format <container-format>]
                           [--disk-format <disk-format>]
                           [--protected | --unprotected]
                           [--public | --private] [--property <key=value>]
                           [--tag <tag>] [--architecture <architecture>]
                           [--instance-id <instance-id>]
                           [--kernel-id <kernel-id>] [--os-distro <os-distro>]
                           [--os-version <os-version>]
                           [--ramdisk-id <ramdisk-id>]
                           [--deactivate | --activate] [--project <project>]
                           [--project-domain <project-domain>]
                           <image>
Copy to Clipboard Toggle word wrap
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
--min-disk <disk-gb>
Minimum disk size needed to boot image, in gigabytes
--min-ram <ram-mb>
Minimum RAM size needed to boot image, in megabytes
--container-format <container-format>
Image container format (default: bare)
--disk-format <disk-format>
Image disk format (default: raw)
--protected
Prevent image from being deleted
--unprotected
Allow image to be deleted (default)
--public
Image is accessible to the public
--private
Image is inaccessible to the public (default)
--property <key=value>
Set a property on this image (repeat option to set multiple properties)
--tag <tag>
Set a tag on this image (repeat option to set multiple tags)
--architecture <architecture>
Operating system architecture
--instance-id <instance-id>
ID of server instance used to create this image
--kernel-id <kernel-id>
ID of kernel image used to boot this disk image
--os-distro <os-distro>
Operating system distribution name
--os-version <os-version>
Operating system distribution version
--ramdisk-id <ramdisk-id>
ID of ramdisk image used to boot this disk image
--deactivate
Deactivate the image
--activate
Activate the image
--project <project>
Set an alternate project on this image (name or ID)
--project-domain <project-domain>
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

3.3.161. openstack image show
Copy link

usage: openstack image show [-h] [-f {html,json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--noindent]
                            [--prefix PREFIX]
                            <image>
Copy to Clipboard Toggle word wrap
Display image details
Positional arguments:
<image>
Image to display (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.162. openstack ip fixed add
Copy link

usage: openstack ip fixed add [-h] <network> <server>
Copy to Clipboard Toggle word wrap
Add fixed IP address to server
Positional arguments:
<network>
Network to fetch an IP address from (name or ID)
<server>
Server to receive the IP address (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.163. openstack ip fixed remove
Copy link

usage: openstack ip fixed remove [-h] <ip-address> <server>
Copy to Clipboard Toggle word wrap
Remove fixed IP address from server
Positional arguments:
<ip-address>
IP address to remove from server (name only)
<server>
Server to remove the IP address from (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.164. openstack ip floating add
Copy link

usage: openstack ip floating add [-h] <ip-address> <server>
Copy to Clipboard Toggle word wrap
Add floating IP address to server
Positional arguments:
<ip-address>
IP address to add to server (name only)
<server>
Server to receive the IP address (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.165. openstack ip floating create
Copy link

usage: openstack ip floating create [-h]
                                    [-f {html,json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--noindent] [--prefix PREFIX]
                                    <network>
Copy to Clipboard Toggle word wrap
Create floating IP
Positional arguments:
<network>
Network to allocate floating IP from (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.166. openstack ip floating delete
Copy link

usage: openstack ip floating delete [-h] <floating-ip>
Copy to Clipboard Toggle word wrap
Delete floating IP
Positional arguments:
<floating-ip>
Floating IP to delete (IP address or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.167. openstack ip floating list
Copy link

usage: openstack ip floating list [-h] [-f {csv,html,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List floating IP(s)
Optional arguments:
-h, --help
show this help message and exit

3.3.168. openstack ip floating pool list
Copy link

usage: openstack ip floating pool list [-h]
                                       [-f {csv,html,json,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--noindent]
                                       [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List pools of floating IP addresses
Optional arguments:
-h, --help
show this help message and exit

3.3.169. openstack ip floating remove
Copy link

usage: openstack ip floating remove [-h] <ip-address> <server>
Copy to Clipboard Toggle word wrap
Remove floating IP address from server
Positional arguments:
<ip-address>
IP address to remove from server (name only)
<server>
Server to remove the IP address from (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.170. openstack ip floating show
Copy link

usage: openstack ip floating show [-h] [-f {html,json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent] [--prefix PREFIX]
                                  <floating-ip>
Copy to Clipboard Toggle word wrap
Show floating IP details
Positional arguments:
<floating-ip>
Floating IP to display (IP address or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.171. openstack keypair create
Copy link

usage: openstack keypair create [-h] [-f {html,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent] [--prefix PREFIX]
                                [--public-key <file>]
                                <name>
Copy to Clipboard Toggle word wrap
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

3.3.172. openstack keypair delete
Copy link

usage: openstack keypair delete [-h] <key>
Copy to Clipboard Toggle word wrap
Delete public key
Positional arguments:
<key>
Public key to delete (name only)
Optional arguments:
-h, --help
show this help message and exit

3.3.173. openstack keypair list
Copy link

usage: openstack keypair list [-h] [-f {csv,html,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List public key fingerprints
Optional arguments:
-h, --help
show this help message and exit

3.3.174. openstack keypair show
Copy link

usage: openstack keypair show [-h] [-f {html,json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--prefix PREFIX] [--public-key]
                              <key>
Copy to Clipboard Toggle word wrap
Display public key details
Positional arguments:
<key>
Public key to display (name only)
Optional arguments:
-h, --help
show this help message and exit
--public-key
Show only bare public key

3.3.175. openstack limits show
Copy link

usage: openstack limits show [-h] [-f {csv,html,json,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             (--absolute | --rate) [--reserved]
                             [--project <project>] [--domain <domain>]
Copy to Clipboard Toggle word wrap
Show compute and block storage 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 the project belongs to (name or ID) [only valid with --absolute]

3.3.176. openstack mapping create
Copy link

usage: openstack mapping create [-h] [-f {html,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent] [--prefix PREFIX] --rules
                                <filename>
                                <name>
Copy to Clipboard Toggle word wrap
Create new mapping
Positional arguments:
<name>
New mapping name (must be unique)
Optional arguments:
-h, --help
show this help message and exit
--rules <filename>
Filename that contains a set of mapping rules (required)

3.3.177. openstack mapping delete
Copy link

usage: openstack mapping delete [-h] <mapping>
Copy to Clipboard Toggle word wrap
Delete mapping
Positional arguments:
<mapping>
Mapping to delete
Optional arguments:
-h, --help
show this help message and exit

3.3.178. openstack mapping list
Copy link

usage: openstack mapping list [-h] [-f {csv,html,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List mappings
Optional arguments:
-h, --help
show this help message and exit

3.3.179. openstack mapping set
Copy link

usage: openstack mapping set [-h] [--rules <filename>] <name>
Copy to Clipboard Toggle word wrap
Set mapping properties
Positional arguments:
<name>
Mapping to modify
Optional arguments:
-h, --help
show this help message and exit
--rules <filename>
Filename that contains a new set of mapping rules

3.3.180. openstack mapping show
Copy link

usage: openstack mapping show [-h] [-f {html,json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--prefix PREFIX]
                              <mapping>
Copy to Clipboard Toggle word wrap
Display mapping details
Positional arguments:
<mapping>
Mapping to display
Optional arguments:
-h, --help
show this help message and exit

3.3.181. openstack module list
Copy link

usage: openstack module list [-h] [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX] [--all]
Copy to Clipboard Toggle word wrap
List module versions
Optional arguments:
-h, --help
show this help message and exit
--all
Show all modules that have version information

3.3.182. openstack network create
Copy link

usage: openstack network create [-h] [-f {html,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent] [--prefix PREFIX]
                                [--share | --no-share] [--subnet <subnet>]
                                <name>
Copy to Clipboard Toggle word wrap
Create new network
Positional arguments:
<name>
New network name
Optional arguments:
-h, --help
show this help message and exit
--share
Share the network between projects
--no-share
Do not share the network between projects
--subnet <subnet>
IPv4 subnet for fixed IPs (in CIDR notation)

3.3.183. openstack network delete
Copy link

usage: openstack network delete [-h] <network> [<network> ...]
Copy to Clipboard Toggle word wrap
Delete network(s)
Positional arguments:
<network>
Network(s) to delete (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.184. openstack network list
Copy link

usage: openstack network list [-h] [-f {csv,html,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--external] [--long]
Copy to Clipboard Toggle word wrap
List networks
Optional arguments:
-h, --help
show this help message and exit
--external
List external networks
--long
List additional fields in output

3.3.185. openstack network set
Copy link

usage: openstack network set [-h] [--name <name>] [--enable | --disable]
                             [--share | --no-share] [--external | --internal]
                             [--default | --no-default]
                             [--provider-network-type <provider-network-type>]
                             [--provider-physical-network <provider-physical-network>]
                             [--provider-segment <provider-segment>]
                             [--transparent-vlan | --no-transparent-vlan]
                             <network>
Copy to Clipboard Toggle word wrap
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
--external
Set this network as an external network (external-net extension required)
--internal
Set this network as an internal network
--default
Set the network as the default external network
--no-default
Do not use the network as the default external network
--provider-network-type <provider-network-type>
The physical mechanism by which the virtual network is implemented. The supported options are: flat, gre, local, vlan, vxlan
--provider-physical-network <provider-physical-network>
Name of the physical network over which the virtual network is implemented
--provider-segment <provider-segment>
VLAN ID for VLAN networks or Tunnel ID for GRE/VXLAN networks
--transparent-vlan
Make the network VLAN transparent
--no-transparent-vlan
Do not make the network VLAN transparent

3.3.186. openstack network show
Copy link

usage: openstack network show [-h] [-f {html,json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--prefix PREFIX]
                              <network>
Copy to Clipboard Toggle word wrap
Show network details
Positional arguments:
<network>
Network to display (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.187. openstack object create
Copy link

usage: openstack object create [-h] [-f {csv,html,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               <container> <filename> [<filename> ...]
Copy to Clipboard Toggle word wrap
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

3.3.188. openstack object delete
Copy link

usage: openstack object delete [-h] <container> <object> [<object> ...]
Copy to Clipboard Toggle word wrap
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.189. openstack object list
Copy link

usage: openstack object list [-h] [-f {csv,html,json,table,value,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>
Copy to Clipboard Toggle word wrap
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)

3.3.190. openstack object save
Copy link

usage: openstack object save [-h] [--file <filename>] <container> <object>
Copy to Clipboard Toggle word wrap
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.191. openstack object set
Copy link

usage: openstack object set [-h] --property <key=value> <container> <object>
Copy to Clipboard Toggle word wrap
Set object properties
Positional arguments:
<container>
Modify <object> from <container>
<object>
Object to modify
Optional arguments:
-h, --help
show this help message and exit
--property <key=value>
Set a property on this object (repeat option to set multiple properties)

3.3.192. openstack object show
Copy link

usage: openstack object show [-h] [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX]
                             <container> <object>
Copy to Clipboard Toggle word wrap
Display object details
Positional arguments:
<container>
Display <object> from <container>
<object>
Object to display
Optional arguments:
-h, --help
show this help message and exit

3.3.193. openstack object store account set
Copy link

usage: openstack object store account set [-h] --property <key=value>
Copy to Clipboard Toggle word wrap
Set account properties
Optional arguments:
-h, --help
show this help message and exit
--property <key=value>
Set a property on this account (repeat option to set multiple properties)

3.3.194. openstack object store account show
Copy link

usage: openstack object store account show [-h]
                                           [-f {html,json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--noindent] [--prefix PREFIX]
Copy to Clipboard Toggle word wrap
Display account details
Optional arguments:
-h, --help
show this help message and exit

3.3.195. openstack object store account unset
Copy link

usage: openstack object store account unset [-h] --property <key>
Copy to Clipboard Toggle word wrap
Unset account properties
Optional arguments:
-h, --help
show this help message and exit
--property <key>
Property to remove from account (repeat option to remove multiple properties)

3.3.196. openstack object unset
Copy link

usage: openstack object unset [-h] --property <key> <container> <object>
Copy to Clipboard Toggle word wrap
Unset object properties
Positional arguments:
<container>
Modify <object> from <container>
<object>
Object to modify
Optional arguments:
-h, --help
show this help message and exit
--property <key>
Property to remove from object (repeat option to remove multiple properties)

3.3.197. openstack orchestration build info
Copy link

usage: openstack orchestration build info [-h]
                                          [-f {html,json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent] [--prefix PREFIX]
Copy to Clipboard Toggle word wrap
Retrieve build information.
Optional arguments:
-h, --help
show this help message and exit 
usage: openstack orchestration resource type list [-h]
                                                  [-f {csv,html,json,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--noindent]
                                                  [--quote {all,minimal,none,nonnumeric}]
                                                  [--filter <key=value>]
Copy to Clipboard Toggle word wrap
List resource types.
Optional arguments:
-h, --help
show this help message and exit
--filter <key=value>
Filter parameters to apply on returned resource types. This can be specified multiple times. It can be any of name, version or support_status 
usage: openstack orchestration resource type show [-h]
                                                  [-f {html,json,shell,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--noindent]
                                                  [--prefix PREFIX]
                                                  [--template-type <template-type>]
                                                  <resource-type>
Copy to Clipboard Toggle word wrap
Show details and optionally generate a template for a resource type.
Positional arguments:
<resource-type>
Resource type to show details for
Optional arguments:
-h, --help
show this help message and exit
--template-type <template-type>
Optional template type to generate, hot or cfn

3.3.200. openstack orchestration service list
Copy link

usage: openstack orchestration service list [-h]
                                            [-f {csv,html,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--noindent]
                                            [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List the Heat engines.
Optional arguments:
-h, --help
show this help message and exit 
usage: openstack orchestration template function list [-h]
                                                      [-f {csv,html,json,table,value,yaml}]
                                                      [-c COLUMN]
                                                      [--max-width <integer>]
                                                      [--noindent]
                                                      [--quote {all,minimal,none,nonnumeric}]
                                                      <template-version>
Copy to Clipboard Toggle word wrap
List the available functions.
Positional arguments:
<template-version>
Template version to get the functions for
Optional arguments:
-h, --help
show this help message and exit

3.3.202. openstack orchestration template validate
Copy link

usage: openstack orchestration template validate [-h]
                                                 [-f {html,json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--noindent]
                                                 [--prefix PREFIX] -t
                                                 <template> [-e <environment>]
                                                 [--show-nested]
                                                 [--parameter <key=value>]
                                                 [--ignore-errors <error1,error2,...>]
Copy to Clipboard Toggle word wrap
Validate a template
Optional arguments:
-h, --help
show this help message and exit
-t <template>, --template <template>
Path to the template
-e <environment>, --environment <environment>
Path to the environment. Can be specified multiple times
--show-nested
Resolve parameters from nested templates as well
--parameter <key=value>
Parameter values used to create the stack. This can be specified multiple times
--ignore-errors <error1,error2,...>
List of heat errors to ignore 
usage: openstack orchestration template version list [-h]
                                                     [-f {csv,html,json,table,value,yaml}]
                                                     [-c COLUMN]
                                                     [--max-width <integer>]
                                                     [--noindent]
                                                     [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List the available template versions.
Optional arguments:
-h, --help
show this help message and exit

3.3.204. openstack policy create
Copy link

usage: openstack policy create [-h] [-f {html,json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent] [--prefix PREFIX] [--type <type>]
                               <filename>
Copy to Clipboard Toggle word wrap
Create new policy
Positional arguments:
<filename>
New serialized policy rules file
Optional arguments:
-h, --help
show this help message and exit
--type <type>
New MIME type of the policy rules file (defaults to application/json)

3.3.205. openstack policy delete
Copy link

usage: openstack policy delete [-h] <policy>
Copy to Clipboard Toggle word wrap
Delete policy
Positional arguments:
<policy>
Policy to delete
Optional arguments:
-h, --help
show this help message and exit

3.3.206. openstack policy list
Copy link

usage: openstack policy list [-h] [-f {csv,html,json,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}] [--long]
Copy to Clipboard Toggle word wrap
List policies
Optional arguments:
-h, --help
show this help message and exit
--long
List additional fields in output

3.3.207. openstack policy set
Copy link

usage: openstack policy set [-h] [--type <type>] [--rules <filename>] <policy>
Copy to Clipboard Toggle word wrap
Set policy properties
Positional arguments:
<policy>
Policy to modify
Optional arguments:
-h, --help
show this help message and exit
--type <type>
New MIME type of the policy rules file
--rules <filename>
New serialized policy rules file

3.3.208. openstack policy show
Copy link

usage: openstack policy show [-h] [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX]
                             <policy>
Copy to Clipboard Toggle word wrap
Display policy details
Positional arguments:
<policy>
Policy to display
Optional arguments:
-h, --help
show this help message and exit

3.3.209. openstack pool create
Copy link

usage: openstack pool create [-h] [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX] [--pool_group <pool_group>]
                             [--pool_options <pool_options>]
                             <pool_name> <pool_uri> <pool_weight>
Copy to Clipboard Toggle word wrap
Create a pool
Positional arguments:
<pool_name>
Name of the pool
<pool_uri>
Storage engine URI
<pool_weight>
weight of the pool
Optional arguments:
-h, --help
show this help message and exit
--pool_group <pool_group>
Group of the pool
--pool_options <pool_options>
An optional request component related to storage-specific options

3.3.210. openstack pool delete
Copy link

usage: openstack pool delete [-h] <pool_name>
Copy to Clipboard Toggle word wrap
Delete a pool
Positional arguments:
<pool_name>
Name of the pool
Optional arguments:
-h, --help
show this help message and exit

3.3.211. openstack pool list
Copy link

usage: openstack pool list [-h] [-f {csv,html,json,table,value,yaml}]
                           [-c COLUMN] [--max-width <integer>] [--noindent]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--marker <pool_name>] [--limit <limit>]
                           [--detailed <detailed>]
Copy to Clipboard Toggle word wrap
List available Pools
Optional arguments:
-h, --help
show this help message and exit
--marker <pool_name>
Pool's paging marker
--limit <limit>
Page size limit
--detailed <detailed>
Detailed output

3.3.212. openstack pool show
Copy link

usage: openstack pool show [-h] [-f {html,json,shell,table,value,yaml}]
                           [-c COLUMN] [--max-width <integer>] [--noindent]
                           [--prefix PREFIX]
                           <pool_name>
Copy to Clipboard Toggle word wrap
Display pool details
Positional arguments:
<pool_name>
Pool to display (name)
Optional arguments:
-h, --help
show this help message and exit

3.3.213. openstack pool update
Copy link

usage: openstack pool update [-h] [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX] [--pool_uri <pool_uri>]
                             [--pool_weight <pool_weight>]
                             [--pool_group <pool_group>]
                             [--pool_options <pool_options>]
                             <pool_name>
Copy to Clipboard Toggle word wrap
Update a pool attribute
Positional arguments:
<pool_name>
Name of the pool
Optional arguments:
-h, --help
show this help message and exit
--pool_uri <pool_uri>
Storage engine URI
--pool_weight <pool_weight>
Weight of the pool
--pool_group <pool_group>
Group of the pool
--pool_options <pool_options>
An optional request component related to storage-specific options

3.3.214. openstack port delete
Copy link

usage: openstack port delete [-h] <port> [<port> ...]
Copy to Clipboard Toggle word wrap
Delete port(s)
Positional arguments:
<port>
Port(s) to delete (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.215. openstack port show
Copy link

usage: openstack port show [-h] [-f {html,json,shell,table,value,yaml}]
                           [-c COLUMN] [--max-width <integer>] [--noindent]
                           [--prefix PREFIX]
                           <port>
Copy to Clipboard Toggle word wrap
Display port details
Positional arguments:
<port>
Port to display (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.216. openstack project create
Copy link

usage: openstack project create [-h] [-f {html,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent] [--prefix PREFIX]
                                [--domain <domain>] [--parent <project>]
                                [--description <description>]
                                [--enable | --disable]
                                [--property <key=value>] [--or-show]
                                <project-name>
Copy to Clipboard Toggle word wrap
Create new project
Positional arguments:
<project-name>
New project name
Optional arguments:
-h, --help
show this help message and exit
--domain <domain>
Domain owning the project (name or ID)
--parent <project>
Parent of the project (name or ID)
--description <description>
Project description
--enable
Enable project
--disable
Disable project
--property <key=value>
Add a property to <name> (repeat option to set multiple properties)
--or-show
Return existing project

3.3.217. openstack project delete
Copy link

usage: openstack project delete [-h] [--domain <domain>]
                                <project> [<project> ...]
Copy to Clipboard Toggle word wrap
Delete project(s)
Positional arguments:
<project>
Project(s) to delete (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--domain <domain>
Domain owning <project> (name or ID)

3.3.218. openstack project list
Copy link

usage: openstack project list [-h] [-f {csv,html,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--domain <domain>] [--user <user>] [--long]
Copy to Clipboard Toggle word wrap
List projects
Optional arguments:
-h, --help
show this help message and exit
--domain <domain>
Filter projects by <domain> (name or ID)
--user <user>
Filter projects by <user> (name or ID)
--long
List additional fields in output

3.3.219. openstack project set
Copy link

usage: openstack project set [-h] [--name <name>] [--domain <domain>]
                             [--description <description>]
                             [--enable | --disable] [--property <key=value>]
                             <project>
Copy to Clipboard Toggle word wrap
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
--domain <domain>
Domain owning <project> (name or ID)
--description <description>
Set project description
--enable
Enable project
--disable
Disable project
--property <key=value>
Set a property on <project> (repeat option to set multiple properties)

3.3.220. openstack project show
Copy link

usage: openstack project show [-h] [-f {html,json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--prefix PREFIX] [--domain <domain>]
                              [--parents] [--children]
                              <project>
Copy to Clipboard Toggle word wrap
Display project details
Positional arguments:
<project>
Project to display (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--domain <domain>
Domain owning <project> (name or ID)
--parents
Show the project's parents as a list
--children
Show project's subtree (children) as a list

3.3.221. openstack ptr record list
Copy link

usage: openstack ptr record list [-h] [-f {csv,html,json,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent]
                                 [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List floatingip ptr records
Optional arguments:
-h, --help
show this help message and exit

3.3.222. openstack ptr record set
Copy link

usage: openstack ptr record set [-h] [-f {html,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent] [--prefix PREFIX]
                                [--description DESCRIPTION | --no-description]
                                [--ttl TTL | --no-ttl]
                                floatingip_id ptrdname
Copy to Clipboard Toggle word wrap
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

3.3.223. openstack ptr record show
Copy link

usage: openstack ptr record show [-h] [-f {html,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 floatingip_id
Copy to Clipboard Toggle word wrap
Show floatingip ptr record details
Positional arguments:
floatingip_id
Floating IP ID
Optional arguments:
-h, --help
show this help message and exit

3.3.224. openstack ptr record unset
Copy link

usage: openstack ptr record unset [-h] floatingip_id
Copy to Clipboard Toggle word wrap
Unset floatingip ptr record
Positional arguments:
floatingip_id
Floating IP ID
Optional arguments:
-h, --help
show this help message and exit

3.3.225. openstack quota set
Copy link

usage: openstack quota set [-h] [--class]
                           [--injected-file-size <injected-file-size>]
                           [--instances <instances>]
                           [--properties <properties>]
                           [--injected-files <injected-files>]
                           [--cores <cores>] [--ram <ram>]
                           [--fixed-ips <fixed-ips>]
                           [--injected-path-size <injected-path-size>]
                           [--key-pairs <key-pairs>] [--gigabytes <gigabytes>]
                           [--volumes <volumes>] [--snapshots <snapshots>]
                           [--secgroups <secgroups>]
                           [--floating-ips <floating-ips>]
                           [--secgroup-rules <secgroup-rules>]
                           [--volume-type <volume-type>]
                           <project/class>
Copy to Clipboard Toggle word wrap
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>
--injected-file-size <injected-file-size>
New value for the injected-file-size quota
--instances <instances>
New value for the instances quota
--properties <properties>
New value for the properties quota
--injected-files <injected-files>
New value for the injected-files quota
--cores <cores>
New value for the cores quota
--ram <ram>
New value for the ram quota
--fixed-ips <fixed-ips>
New value for the fixed-ips quota
--injected-path-size <injected-path-size>
New value for the injected-path-size quota
--key-pairs <key-pairs>
New value for the key-pairs 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
--secgroups <secgroups>
New value for the secgroups quota
--floating-ips <floating-ips>
New value for the floating-ips quota
--secgroup-rules <secgroup-rules>
New value for the secgroup-rules quota
--volume-type <volume-type>
Set quotas for a specific <volume-type>

3.3.226. openstack quota show
Copy link

usage: openstack quota show [-h] [-f {html,json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--noindent]
                            [--prefix PREFIX] [--class | --default]
                            [<project/class>]
Copy to Clipboard Toggle word wrap
Show quotas for project or class
Positional arguments:
<project/class>
Show quotas for this project or class (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--class
Show quotas for <class>
--default
Show default quotas for <project>

3.3.227. openstack recordset create
Copy link

usage: openstack recordset create [-h] [-f {html,json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent] [--prefix PREFIX] --records
                                  RECORDS [RECORDS ...] --type TYPE
                                  [--ttl TTL] [--description DESCRIPTION]
                                  zone_id name
Copy to Clipboard Toggle word wrap
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

3.3.228. openstack recordset delete
Copy link

usage: openstack recordset delete [-h] zone_id id
Copy to Clipboard Toggle word wrap
Delete recordset
Positional arguments:
zone_id
Zone ID
id
RecordSet ID
Optional arguments:
-h, --help
show this help message and exit

3.3.229. openstack recordset list
Copy link

usage: openstack recordset list [-h] [-f {csv,html,json,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--name NAME] [--type TYPE] [--data DATA]
                                [--ttl TTL] [--description DESCRIPTION]
                                [--status STATUS] [--action ACTION]
                                zone_id
Copy to Clipboard Toggle word wrap
List recordsets
Positional arguments:
zone_id
Zone ID
Optional arguments:
-h, --help
show this help message and exit
--name NAME
RecordSet Name
--type TYPE
RecordSet Type
--data DATA
RecordSet Record Data
--ttl TTL
Time To Live (Seconds)
--description DESCRIPTION
Description
--status STATUS
RecordSet Status
--action ACTION
RecordSet Action

3.3.230. openstack recordset set
Copy link

usage: openstack recordset set [-h] [-f {html,json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent] [--prefix PREFIX]
                               [--records RECORDS [RECORDS ...]]
                               [--description DESCRIPTION | --no-description]
                               [--ttl TTL | --no-ttl]
                               zone_id id
Copy to Clipboard Toggle word wrap
Set recordset properties
Positional arguments:
zone_id
Zone ID
id
RecordSet ID
Optional arguments:
-h, --help
show this help message and exit
--records RECORDS [RECORDS ...]
Records
--description DESCRIPTION
Description
--no-description
--ttl TTL
TTL
--no-ttl

3.3.231. openstack recordset show
Copy link

usage: openstack recordset show [-h] [-f {html,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent] [--prefix PREFIX]
                                zone_id id
Copy to Clipboard Toggle word wrap
Show recordset details
Positional arguments:
zone_id
Zone ID
id
RecordSet ID
Optional arguments:
-h, --help
show this help message and exit

3.3.232. openstack region create
Copy link

usage: openstack region create [-h] [-f {html,json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent] [--prefix PREFIX]
                               [--parent-region <region-id>]
                               [--description <description>]
                               <region-id>
Copy to Clipboard Toggle word wrap
Create new region
Positional arguments:
<region-id>
New region ID
Optional arguments:
-h, --help
show this help message and exit
--parent-region <region-id>
Parent region ID
--description <description>
New region description

3.3.233. openstack region delete
Copy link

usage: openstack region delete [-h] <region-id>
Copy to Clipboard Toggle word wrap
Delete region
Positional arguments:
<region-id>
Region ID to delete
Optional arguments:
-h, --help
show this help message and exit

3.3.234. openstack region list
Copy link

usage: openstack region list [-h] [-f {csv,html,json,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--parent-region <region-id>]
Copy to Clipboard Toggle word wrap
List regions
Optional arguments:
-h, --help
show this help message and exit
--parent-region <region-id>
Filter by parent region ID

3.3.235. openstack region set
Copy link

usage: openstack region set [-h] [--parent-region <region-id>]
                            [--description <description>]
                            <region-id>
Copy to Clipboard Toggle word wrap
Set region properties
Positional arguments:
<region-id>
Region to modify
Optional arguments:
-h, --help
show this help message and exit
--parent-region <region-id>
New parent region ID
--description <description>
New region description

3.3.236. openstack region show
Copy link

usage: openstack region show [-h] [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX]
                             <region-id>
Copy to Clipboard Toggle word wrap
Display region details
Positional arguments:
<region-id>
Region to display
Optional arguments:
-h, --help
show this help message and exit

3.3.237. openstack request token authorize
Copy link

usage: openstack request token authorize [-h]
                                         [-f {html,json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--noindent] [--prefix PREFIX]
                                         --request-key <request-key> --role
                                         <role>
Copy to Clipboard Toggle word wrap
Authorize a request token
Optional arguments:
-h, --help
show this help message and exit
--request-key <request-key>
Request token to authorize (ID only) (required)
--role <role>
Roles to authorize (name or ID) (repeat option to set multiple values, required)

3.3.238. openstack request token create
Copy link

usage: openstack request token create [-h]
                                      [-f {html,json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--noindent] [--prefix PREFIX]
                                      --consumer-key <consumer-key>
                                      --consumer-secret <consumer-secret>
                                      --project <project> [--domain <domain>]
Copy to Clipboard Toggle word wrap
Create a request token
Optional arguments:
-h, --help
show this help message and exit
--consumer-key <consumer-key>
Consumer key (required)
--consumer-secret <consumer-secret>
Consumer secret (required)
--project <project>
Project that consumer wants to access (name or ID) (required)
--domain <domain>
Domain owning <project> (name or ID)

3.3.239. openstack role add
Copy link

usage: openstack role add [-h] [--domain <domain> | --project <project>]
                          [--user <user> | --group <group>]
                          [--group-domain <group-domain>]
                          [--project-domain <project-domain>]
                          [--user-domain <user-domain>] [--inherited]
                          <role>
Copy to Clipboard Toggle word wrap
Adds a role to a user or group on a domain or project
Positional arguments:
<role>
Role to add to <user> (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--domain <domain>
Include <domain> (name or ID)
--project <project>
Include <project> (name or ID)
--user <user>
Include <user> (name or ID)
--group <group>
Include <group> (name or ID)
--group-domain <group-domain>
Domain the group belongs to (name or ID). This can be used in case collisions between group names exist.
--project-domain <project-domain>
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
--user-domain <user-domain>
Domain the user belongs to (name or ID). This can be used in case collisions between user names exist.
--inherited
Specifies if the role grant is inheritable to the sub projects

3.3.240. openstack role assignment list
Copy link

usage: openstack role assignment list [-h]
                                      [-f {csv,html,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--effective] [--role <role>] [--names]
                                      [--user <user>]
                                      [--user-domain <user-domain>]
                                      [--group <group>]
                                      [--group-domain <group-domain>]
                                      [--domain <domain> | --project <project>]
                                      [--project-domain <project-domain>]
                                      [--inherited]
Copy to Clipboard Toggle word wrap
List role assignments
Optional arguments:
-h, --help
show this help message and exit
--effective
Returns only effective role assignments
--role <role>
Role to filter (name or ID)
--names
Display names instead of IDs
--user <user>
User to filter (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.
--group <group>
Group to filter (name or ID)
--group-domain <group-domain>
Domain the group belongs to (name or ID). This can be used in case collisions between group names exist.
--domain <domain>
Domain to filter (name or ID)
--project <project>
Project to filter (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.
--inherited
Specifies if the role grant is inheritable to the sub projects

3.3.241. openstack role create
Copy link

usage: openstack role create [-h] [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX] [--or-show]
                             <role-name>
Copy to Clipboard Toggle word wrap
Create new role
Positional arguments:
<role-name>
New role name
Optional arguments:
-h, --help
show this help message and exit
--or-show
Return existing role

3.3.242. openstack role delete
Copy link

usage: openstack role delete [-h] <role> [<role> ...]
Copy to Clipboard Toggle word wrap
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.243. openstack role list
Copy link

usage: openstack role list [-h] [-f {csv,html,json,table,value,yaml}]
                           [-c COLUMN] [--max-width <integer>] [--noindent]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--domain <domain> | --project <project>]
                           [--user <user> | --group <group>]
                           [--group-domain <group-domain>]
                           [--project-domain <project-domain>]
                           [--user-domain <user-domain>] [--inherited]
Copy to Clipboard Toggle word wrap
List roles
Optional arguments:
-h, --help
show this help message and exit
--domain <domain>
Include <domain> (name or ID)
--project <project>
Include <project> (name or ID)
--user <user>
Include <user> (name or ID)
--group <group>
Include <group> (name or ID)
--group-domain <group-domain>
Domain the group belongs to (name or ID). This can be used in case collisions between group names exist.
--project-domain <project-domain>
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
--user-domain <user-domain>
Domain the user belongs to (name or ID). This can be used in case collisions between user names exist.
--inherited
Specifies if the role grant is inheritable to the sub projects

3.3.244. openstack role remove
Copy link

usage: openstack role remove [-h] [--domain <domain> | --project <project>]
                             [--user <user> | --group <group>]
                             [--group-domain <group-domain>]
                             [--project-domain <project-domain>]
                             [--user-domain <user-domain>] [--inherited]
                             <role>
Copy to Clipboard Toggle word wrap
Remove role from domain/project : user/group
Positional arguments:
<role>
Role to remove (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--domain <domain>
Include <domain> (name or ID)
--project <project>
Include <project> (name or ID)
--user <user>
Include <user> (name or ID)
--group <group>
Include <group> (name or ID)
--group-domain <group-domain>
Domain the group belongs to (name or ID). This can be used in case collisions between group names exist.
--project-domain <project-domain>
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
--user-domain <user-domain>
Domain the user belongs to (name or ID). This can be used in case collisions between user names exist.
--inherited
Specifies if the role grant is inheritable to the sub projects

3.3.245. openstack role set
Copy link

usage: openstack role set [-h] [--name <name>] <role>
Copy to Clipboard Toggle word wrap
Set role properties
Positional arguments:
<role>
Role to modify (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--name <name>
Set role name

3.3.246. openstack role show
Copy link

usage: openstack role show [-h] [-f {html,json,shell,table,value,yaml}]
                           [-c COLUMN] [--max-width <integer>] [--noindent]
                           [--prefix PREFIX]
                           <role>
Copy to Clipboard Toggle word wrap
Display role details
Positional arguments:
<role>
Role to display (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.247. openstack router create
Copy link

usage: openstack router create [-h] [-f {html,json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent] [--prefix PREFIX]
                               [--enable | --disable] [--distributed]
                               [--project <project>]
                               [--project-domain <project-domain>]
                               [--availability-zone-hint <availability-zone>]
                               <name>
Copy to Clipboard Toggle word wrap
Create a new router
Positional arguments:
<name>
New router name
Optional arguments:
-h, --help
show this help message and exit
--enable
Enable router (default)
--disable
Disable router
--distributed
Create a distributed router
--project <project>
Owner's project (name or ID)
--project-domain <project-domain>
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
--availability-zone-hint <availability-zone>
Availability Zone in which to create this router (Router Availability Zone extension required, repeat option to set multiple availability zones)

3.3.248. openstack router delete
Copy link

usage: openstack router delete [-h] <router> [<router> ...]
Copy to Clipboard Toggle word wrap
Delete router(s)
Positional arguments:
<router>
Router(s) to delete (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.249. openstack router list
Copy link

usage: openstack router list [-h] [-f {csv,html,json,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}] [--long]
Copy to Clipboard Toggle word wrap
List routers
Optional arguments:
-h, --help
show this help message and exit
--long
List additional fields in output

3.3.250. openstack router set
Copy link

usage: openstack router set [-h] [--name <name>] [--enable | --disable]
                            [--distributed | --centralized]
                            [--route destination=<subnet>,gateway=<ip-address> | --no-route]
                            <router>
Copy to Clipboard Toggle word wrap
Set router properties
Positional arguments:
<router>
Router to modify (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--name <name>
Set router name
--enable
Enable router
--disable
Disable router
--distributed
Set router to distributed mode (disabled router only)
--centralized
Set router to centralized mode (disabled router only)
--route
destination=<subnet>,gateway=<ip-address> Routes associated with the router destination: destination subnet (in CIDR notation) gateway: nexthop IP address (repeat option to set multiple routes)
--no-route
Clear routes associated with the router

3.3.251. openstack router show
Copy link

usage: openstack router show [-h] [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX]
                             <router>
Copy to Clipboard Toggle word wrap
Display router details
Positional arguments:
<router>
Router to display (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.252. openstack secret container create
Copy link

usage: openstack secret container create [-h]
                                         [-f {html,json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--noindent] [--prefix PREFIX]
                                         [--name NAME] [--type TYPE]
                                         [--secret SECRET]
Copy to Clipboard Toggle word wrap
Store a container in Barbican.
Optional arguments:
-h, --help
show this help message and exit
--name NAME, -n NAME
a human-friendly name.
--type TYPE
type of container to create (default: generic).
--secret SECRET, -s SECRET
one secret to store in a container (can be set multiple times). Example: --secret "private_key=https://url.test/v1/secrets/1-2-3-4"

3.3.253. openstack secret container delete
Copy link

usage: openstack secret container delete [-h] URI
Copy to Clipboard Toggle word wrap
Delete a container by providing its href.
Positional arguments:
URI
The URI reference for the container
Optional arguments:
-h, --help
show this help message and exit

3.3.254. openstack secret container get
Copy link

usage: openstack secret container get [-h]
                                      [-f {html,json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--noindent] [--prefix PREFIX]
                                      URI
Copy to Clipboard Toggle word wrap
Retrieve a container by providing its URI.
Positional arguments:
URI
The URI reference for the container.
Optional arguments:
-h, --help
show this help message and exit

3.3.255. openstack secret container list
Copy link

usage: openstack secret container list [-h]
                                       [-f {csv,html,json,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--noindent]
                                       [--quote {all,minimal,none,nonnumeric}]
                                       [--limit LIMIT] [--offset OFFSET]
                                       [--name NAME] [--type TYPE]
Copy to Clipboard Toggle word wrap
List containers.
Optional arguments:
-h, --help
show this help message and exit
--limit LIMIT, -l LIMIT
specify the limit to the number of items to list per page (default: 10; maximum: 100)
--offset OFFSET, -o OFFSET
specify the page offset (default: 0)
--name NAME, -n NAME
specify the container name (default: None)
--type TYPE, -t TYPE
specify the type filter for the list (default: None).

3.3.256. openstack secret delete
Copy link

usage: openstack secret delete [-h] URI
Copy to Clipboard Toggle word wrap
Delete a secret by providing its URI.
Positional arguments:
URI
The URI reference for the secret
Optional arguments:
-h, --help
show this help message and exit

3.3.257. openstack secret get
Copy link

usage: openstack secret get [-h] [-f {html,json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--noindent]
                            [--prefix PREFIX] [--decrypt] [--payload]
                            [--payload_content_type PAYLOAD_CONTENT_TYPE]
                            URI
Copy to Clipboard Toggle word wrap
Retrieve a secret by providing its URI.
Positional arguments:
URI
The URI reference for the secret.
Optional arguments:
-h, --help
show this help message and exit
--decrypt, -d
if specified, retrieve the unencrypted secret data; the data type can be specified with --payload-content- type.
--payload, -p
if specified, retrieve the unencrypted secret data; the data type can be specified with --payload-content- type. If the user wishes to only retrieve the value of the payload they must add "-f value" to format returning only the value of the payload
--payload_content_type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE
the content type of the decrypted secret (default: text/plain.

3.3.258. openstack secret list
Copy link

usage: openstack secret list [-h] [-f {csv,html,json,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--limit LIMIT] [--offset OFFSET] [--name NAME]
                             [--algorithm ALGORITHM] [--bit-length BIT_LENGTH]
                             [--mode MODE]
Copy to Clipboard Toggle word wrap
List secrets.
Optional arguments:
-h, --help
show this help message and exit
--limit LIMIT, -l LIMIT
specify the limit to the number of items to list per page (default: 10; maximum: 100)
--offset OFFSET, -o OFFSET
specify the page offset (default: 0)
--name NAME, -n NAME
specify the secret name (default: None)
--algorithm ALGORITHM, -a ALGORITHM
the algorithm filter for the list(default: None).
--bit-length BIT_LENGTH, -b BIT_LENGTH
the bit length filter for the list (default: 0).
--mode MODE, -m MODE
the algorithm mode filter for the list (default: None).

3.3.259. openstack secret order create
Copy link

usage: openstack secret order create [-h]
                                     [-f {html,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent] [--prefix PREFIX]
                                     [--name NAME] [--algorithm ALGORITHM]
                                     [--bit-length BIT_LENGTH] [--mode MODE]
                                     [--payload-content-type PAYLOAD_CONTENT_TYPE]
                                     [--expiration EXPIRATION]
                                     [--request-type REQUEST_TYPE]
                                     [--subject-dn SUBJECT_DN]
                                     [--source-container-ref SOURCE_CONTAINER_REF]
                                     [--ca-id CA_ID] [--profile PROFILE]
                                     [--request-file REQUEST_FILE]
                                     type
Copy to Clipboard Toggle word wrap
Create a new order.
Positional arguments:
type
the type of the order to create.
Optional arguments:
-h, --help
show this help message and exit
--name NAME, -n NAME
a human-friendly name.
--algorithm ALGORITHM, -a ALGORITHM
the algorithm to be used with the requested key (default: aes).
--bit-length BIT_LENGTH, -b BIT_LENGTH
the bit length of the requested secret key (default: 256).
--mode MODE, -m MODE
the algorithm mode to be used with the requested key (default: cbc).
--payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE
the type/format of the secret to be generated (default: application/octet-stream).
--expiration EXPIRATION, -x EXPIRATION
the expiration time for the secret in ISO 8601 format.
--request-type REQUEST_TYPE
the type of the certificate request.
--subject-dn SUBJECT_DN
the subject of the certificate.
--source-container-ref SOURCE_CONTAINER_REF
the source of the certificate when using stored-key requests.
--ca-id CA_ID
the identifier of the CA to use for the certificate request.
--profile PROFILE
the profile of certificate to use.
--request-file REQUEST_FILE
the file containing the CSR.

3.3.260. openstack secret order delete
Copy link

usage: openstack secret order delete [-h] URI
Copy to Clipboard Toggle word wrap
Delete an order by providing its href.
Positional arguments:
URI
The URI reference for the order
Optional arguments:
-h, --help
show this help message and exit

3.3.261. openstack secret order get
Copy link

usage: openstack secret order get [-h] [-f {html,json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent] [--prefix PREFIX]
                                  URI
Copy to Clipboard Toggle word wrap
Retrieve an order by providing its URI.
Positional arguments:
URI
The URI reference order.
Optional arguments:
-h, --help
show this help message and exit

3.3.262. openstack secret order list
Copy link

usage: openstack secret order list [-h] [-f {csv,html,json,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--limit LIMIT] [--offset OFFSET]
Copy to Clipboard Toggle word wrap
List orders.
Optional arguments:
-h, --help
show this help message and exit
--limit LIMIT, -l LIMIT
specify the limit to the number of items to list per page (default: 10; maximum: 100)
--offset OFFSET, -o OFFSET
specify the page offset (default: 0)

3.3.263. openstack secret store
Copy link

usage: openstack secret store [-h] [-f {html,json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--prefix PREFIX] [--name NAME]
                              [--payload PAYLOAD] [--secret-type SECRET_TYPE]
                              [--payload-content-type PAYLOAD_CONTENT_TYPE]
                              [--payload-content-encoding PAYLOAD_CONTENT_ENCODING]
                              [--algorithm ALGORITHM]
                              [--bit-length BIT_LENGTH] [--mode MODE]
                              [--expiration EXPIRATION]
Copy to Clipboard Toggle word wrap
Store a secret in Barbican.
Optional arguments:
-h, --help
show this help message and exit
--name NAME, -n NAME
a human-friendly name.
--payload PAYLOAD, -p PAYLOAD
the unencrypted secret; if provided, you must also provide a payload_content_type
--secret-type SECRET_TYPE, -s SECRET_TYPE
the secret type; must be one of symmetric, public, private, certificate, passphrase, opaque (default)
--payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE
the type/format of the provided secret data; "text/plain" is assumed to be UTF-8; required when --payload is supplied.
--payload-content-encoding PAYLOAD_CONTENT_ENCODING, -e PAYLOAD_CONTENT_ENCODING
required if --payload-content-type is "application /octet-stream".
--algorithm ALGORITHM, -a ALGORITHM
the algorithm (default: aes).
--bit-length BIT_LENGTH, -b BIT_LENGTH
the bit length (default: 256).
--mode MODE, -m MODE
the algorithm mode; used only for reference (default: cbc)
--expiration EXPIRATION, -x EXPIRATION
the expiration time for the secret in ISO 8601 format.

3.3.264. openstack secret update
Copy link

usage: openstack secret update [-h] URI payload
Copy to Clipboard Toggle word wrap
Update a secret with no payload in Barbican.
Positional arguments:
URI
The URI reference for the secret.
payload
the unencrypted secret
Optional arguments:
-h, --help
show this help message and exit

3.3.265. openstack security group create
Copy link

usage: openstack security group create [-h]
                                       [-f {html,json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--noindent] [--prefix PREFIX]
                                       [--description <description>]
                                       <name>
Copy to Clipboard Toggle word wrap
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

3.3.266. openstack security group delete
Copy link

usage: openstack security group delete [-h] <group>
Copy to Clipboard Toggle word wrap
Delete a security group
Positional arguments:
<group>
Security group to delete (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.267. openstack security group list
Copy link

usage: openstack security group list [-h]
                                     [-f {csv,html,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--all-projects]
Copy to Clipboard Toggle word wrap
List security groups
Optional arguments:
-h, --help
show this help message and exit
--all-projects
Display information from all projects (admin only)

3.3.268. openstack security group rule create
Copy link

usage: openstack security group rule create [-h]
                                            [-f {html,json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--noindent] [--prefix PREFIX]
                                            [--src-ip <ip-address> | --src-group <group>]
                                            [--dst-port <port-range>]
                                            [--protocol <protocol>]
                                            <group>
Copy to Clipboard Toggle word wrap
Create a new security group rule
Positional arguments:
<group>
Create rule in this security group (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--src-ip <ip-address>
Source IP address block (may use CIDR notation; default for IPv4 rule: 0.0.0.0/0)
--src-group <group>
Source security group (name or ID)
--dst-port <port-range>
Destination port, may be a single port or a starting and ending port range: 137:139. Required for IP protocols TCP and UDP. Ignored for ICMP IP protocols.
--protocol <protocol>
IP protocol (icmp, tcp, udp; default: tcp)

3.3.269. openstack security group rule delete
Copy link

usage: openstack security group rule delete [-h] <rule>
Copy to Clipboard Toggle word wrap
Delete a security group rule
Positional arguments:
<rule>
Security group rule to delete (ID only)
Optional arguments:
-h, --help
show this help message and exit

3.3.270. openstack security group rule list
Copy link

usage: openstack security group rule list [-h]
                                          [-f {csv,html,json,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--all-projects]
                                          [<group>]
Copy to Clipboard Toggle word wrap
List security group rules
Positional arguments:
<group>
List all rules in this security group (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--all-projects
Display information from all projects (admin only)

3.3.271. openstack security group rule show
Copy link

usage: openstack security group rule show [-h]
                                          [-f {html,json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent] [--prefix PREFIX]
                                          <rule>
Copy to Clipboard Toggle word wrap
Display security group rule details
Positional arguments:
<rule>
Security group rule to display (ID only)
Optional arguments:
-h, --help
show this help message and exit

3.3.272. openstack security group set
Copy link

usage: openstack security group set [-h] [--name <new-name>]
                                    [--description <description>]
                                    <group>
Copy to Clipboard Toggle word wrap
Set security group properties
Positional arguments:
<group>
Security group to modify (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--name <new-name>
New security group name
--description <description>
New security group description

3.3.273. openstack security group show
Copy link

usage: openstack security group show [-h]
                                     [-f {html,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent] [--prefix PREFIX]
                                     <group>
Copy to Clipboard Toggle word wrap
Display security group details
Positional arguments:
<group>
Security group to display (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.274. openstack server add security group
Copy link

usage: openstack server add security group [-h] <server> <group>
Copy to Clipboard Toggle word wrap
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.275. openstack server add volume
Copy link

usage: openstack server add volume [-h] [--device <device>] <server> <volume>
Copy to Clipboard Toggle word wrap
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.276. openstack server create
Copy link

usage: openstack server create [-h] [-f {html,json,shell,table,value,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>
Copy to Clipboard Toggle word wrap
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 (name or ID)
--volume <volume>
Create server from this volume (name or ID)
--flavor <flavor>
Create server with this flavor (name or ID)
--security-group <security-group-name>
Security group to assign to this server (name or ID) (repeat option to set multiple groups)
--key-name <key-name>
Keypair to inject into this server (optional extension)
--property <key=value>
Set a property on this server (repeat option to set multiple values)
--file <dest-filename=source-filename>
File to inject into image before boot (repeat option to set multiple files)
--user-data <user-data>
User data file to serve from the metadata server
--availability-zone <zone-name>
Select an availability zone for the server
--block-device-mapping <dev-name=mapping>
Map block devices; map is <id>:<type>:<size(GB)>:<delete_on_terminate> (optional extension)
--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid>
Create a NIC on the server. Specify option multiple times to create multiple NICs. Either net-id or port-id must be provided, but not both. net-id: attach NIC to network with this UUID, port-id: attach NIC to port with this UUID, v4-fixed-ip: IPv4 fixed address for NIC (optional), v6-fixed-ip: IPv6 fixed address for NIC (optional).
--hint <key=value>
Hints for the scheduler (optional extension)
--config-drive <config-drive-volume>|True
Use specified volume as the config drive, or 'True' to use an ephemeral drive
--min <count>
Minimum number of servers to launch (default=1)
--max <count>
Maximum number of servers to launch (default=1)
--wait
Wait for build to complete

3.3.277. openstack server delete
Copy link

usage: openstack server delete [-h] [--wait] <server> [<server> ...]
Copy to Clipboard Toggle word wrap
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.278. openstack server dump create
Copy link

usage: openstack server dump create [-h] <server> [<server> ...]
Copy to Clipboard Toggle word wrap
Create a dump file in server(s) Trigger crash dump in server(s) with features like kdump in Linux. It will create a dump file in the server(s) dumping the server(s)' memory, and also crash the server(s). OSC sees the dump file (server dump) as a kind of resource.
Positional arguments:
<server>
Server(s) to create dump file (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.279. openstack server image create
Copy link

usage: openstack server image create [-h]
                                     [-f {html,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent] [--prefix PREFIX]
                                     [--name <image-name>] [--wait]
                                     <server>
Copy to Clipboard Toggle word wrap
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

3.3.280. openstack server list
Copy link

usage: openstack server list [-h] [-f {csv,html,json,table,value,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] [--marker <marker>] [--limit <limit>]
Copy to Clipboard Toggle word wrap
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 (name or ID)
--image <image>
Search by image (name or ID)
--host <hostname>
Search by hostname
--all-projects
Include all projects (admin only)
--project <project>
Search by project (admin only) (name or ID)
--project-domain <project-domain>
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
--user <user>
Search by user (admin only) (name or ID)
--user-domain <user-domain>
Domain the user belongs to (name or ID). This can be used in case collisions between user names exist.
--long
List additional fields in output
--marker <marker>
The last server (name or ID) of the previous page. Display list of servers after marker. Display all servers if not specified.
--limit <limit>
Maximum number of servers to display. If limit equals -1, all servers will be displayed. If limit is greater than 'osapi_max_limit' option of Nova API, 'osapi_max_limit' will be used instead.

3.3.281. openstack server lock
Copy link

usage: openstack server lock [-h] <server> [<server> ...]
Copy to Clipboard Toggle word wrap
Lock server(s). A non-admin user will not be able to execute actions
Positional arguments:
<server>
Server(s) to lock (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.282. openstack server migrate
Copy link

usage: openstack server migrate [-h] [--live <hostname>]
                                [--shared-migration | --block-migration]
                                [--disk-overcommit | --no-disk-overcommit]
                                [--wait]
                                <server>
Copy to Clipboard Toggle word wrap
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.283. openstack server pause
Copy link

usage: openstack server pause [-h] <server> [<server> ...]
Copy to Clipboard Toggle word wrap
Pause server(s)
Positional arguments:
<server>
Server(s) to pause (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.284. openstack server reboot
Copy link

usage: openstack server reboot [-h] [--hard | --soft] [--wait] <server>
Copy to Clipboard Toggle word wrap
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.285. openstack server rebuild
Copy link

usage: openstack server rebuild [-h] [-f {html,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent] [--prefix PREFIX]
                                [--image <image>] [--password <password>]
                                [--wait]
                                <server>
Copy to Clipboard Toggle word wrap
Rebuild server
Positional arguments:
<server>
Server (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--image <image>
Recreate server from the specified image (name or ID). Defaults to the currently used one.
--password <password>
Set the password on the rebuilt instance
--wait
Wait for rebuild to complete

3.3.286. openstack server remove security group
Copy link

usage: openstack server remove security group [-h] <server> <group>
Copy to Clipboard Toggle word wrap
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.287. openstack server remove volume
Copy link

usage: openstack server remove volume [-h] <server> <volume>
Copy to Clipboard Toggle word wrap
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.288. openstack server rescue
Copy link

usage: openstack server rescue [-h] [-f {html,json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent] [--prefix PREFIX]
                               <server>
Copy to Clipboard Toggle word wrap
Put server in rescue mode
Positional arguments:
<server>
Server (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.289. openstack server resize
Copy link

usage: openstack server resize [-h] [--flavor <flavor> | --confirm | --revert]
                               [--wait]
                               <server>
Copy to Clipboard Toggle word wrap
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.290. openstack server resume
Copy link

usage: openstack server resume [-h] <server> [<server> ...]
Copy to Clipboard Toggle word wrap
Resume server(s)
Positional arguments:
<server>
Server(s) to resume (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.291. openstack server set
Copy link

usage: openstack server set [-h] [--name <new-name>] [--root-password]
                            [--property <key=value>] [--state <state>]
                            <server>
Copy to Clipboard Toggle word wrap
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)
--state <state>
New server state (valid value: active, error)

3.3.292. openstack server shelve
Copy link

usage: openstack server shelve [-h] <server> [<server> ...]
Copy to Clipboard Toggle word wrap
Shelve server(s)
Positional arguments:
<server>
Server(s) to shelve (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.293. openstack server show
Copy link

usage: openstack server show [-h] [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX] [--diagnostics]
                             <server>
Copy to Clipboard Toggle word wrap
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

3.3.294. openstack server ssh
Copy link

usage: openstack server ssh [-h] [--login <login-name>] [--port <port>]
                            [--identity <keyfile>] [--option <config-options>]
                            [-4 | -6]
                            [--public | --private | --address-type <address-type>]
                            <server>
Copy to Clipboard Toggle word wrap
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.295. openstack server start
Copy link

usage: openstack server start [-h] <server> [<server> ...]
Copy to Clipboard Toggle word wrap
Start server(s).
Positional arguments:
<server>
Server(s) to start (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.296. openstack server stop
Copy link

usage: openstack server stop [-h] <server> [<server> ...]
Copy to Clipboard Toggle word wrap
Stop server(s).
Positional arguments:
<server>
Server(s) to stop (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.297. openstack server suspend
Copy link

usage: openstack server suspend [-h] <server> [<server> ...]
Copy to Clipboard Toggle word wrap
Suspend server(s)
Positional arguments:
<server>
Server(s) to suspend (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.298. openstack server unlock
Copy link

usage: openstack server unlock [-h] <server> [<server> ...]
Copy to Clipboard Toggle word wrap
Unlock server(s)
Positional arguments:
<server>
Server(s) to unlock (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.299. openstack server unpause
Copy link

usage: openstack server unpause [-h] <server> [<server> ...]
Copy to Clipboard Toggle word wrap
Unpause server(s)
Positional arguments:
<server>
Server(s) to unpause (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.300. openstack server unrescue
Copy link

usage: openstack server unrescue [-h] <server>
Copy to Clipboard Toggle word wrap
Restore server from rescue mode
Positional arguments:
<server>
Server (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.301. openstack server unset
Copy link

usage: openstack server unset [-h] [--property <key>] <server>
Copy to Clipboard Toggle word wrap
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 option to remove multiple values)

3.3.302. openstack server unshelve
Copy link

usage: openstack server unshelve [-h] <server> [<server> ...]
Copy to Clipboard Toggle word wrap
Unshelve server(s)
Positional arguments:
<server>
Server(s) to unshelve (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.303. openstack service create
Copy link

usage: openstack service create [-h] [-f {html,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent] [--prefix PREFIX] [--name <name>]
                                [--description <description>]
                                [--enable | --disable]
                                <type>
Copy to Clipboard Toggle word wrap
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
--enable
Enable service (default)
--disable
Disable service

3.3.304. openstack service delete
Copy link

usage: openstack service delete [-h] <service>
Copy to Clipboard Toggle word wrap
Delete service
Positional arguments:
<service>
Service to delete (type, name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.305. openstack service list
Copy link

usage: openstack service list [-h] [-f {csv,html,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}] [--long]
Copy to Clipboard Toggle word wrap
List services
Optional arguments:
-h, --help
show this help message and exit
--long
List additional fields in output

3.3.306. openstack service provider create
Copy link

usage: openstack service provider create [-h]
                                         [-f {html,json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--noindent] [--prefix PREFIX]
                                         --auth-url <auth-url>
                                         [--description <description>]
                                         --service-provider-url <sp-url>
                                         [--enable | --disable]
                                         <name>
Copy to Clipboard Toggle word wrap
Create new service provider
Positional arguments:
<name>
New service provider name (must be unique)
Optional arguments:
-h, --help
show this help message and exit
--auth-url <auth-url>
Authentication URL of remote federated service provider (required)
--description <description>
New service provider description
--service-provider-url <sp-url>
A service URL where SAML assertions are being sent (required)
--enable
Enable the service provider (default)
--disable
Disable the service provider

3.3.307. openstack service provider delete
Copy link

usage: openstack service provider delete [-h] <service-provider>
Copy to Clipboard Toggle word wrap
Delete service provider
Positional arguments:
<service-provider>
Service provider to delete
Optional arguments:
-h, --help
show this help message and exit

3.3.308. openstack service provider list
Copy link

usage: openstack service provider list [-h]
                                       [-f {csv,html,json,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--noindent]
                                       [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List service providers
Optional arguments:
-h, --help
show this help message and exit

3.3.309. openstack service provider set
Copy link

usage: openstack service provider set [-h] [--auth-url <auth-url>]
                                      [--description <description>]
                                      [--service-provider-url <sp-url>]
                                      [--enable | --disable]
                                      <service-provider>
Copy to Clipboard Toggle word wrap
Set service provider properties
Positional arguments:
<service-provider>
Service provider to modify
Optional arguments:
-h, --help
show this help message and exit
--auth-url <auth-url>
New Authentication URL of remote federated service provider
--description <description>
New service provider description
--service-provider-url <sp-url>
New service provider URL, where SAML assertions are sent
--enable
Enable the service provider
--disable
Disable the service provider

3.3.310. openstack service provider show
Copy link

usage: openstack service provider show [-h]
                                       [-f {html,json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--noindent] [--prefix PREFIX]
                                       <service-provider>
Copy to Clipboard Toggle word wrap
Display service provider details
Positional arguments:
<service-provider>
Service provider to display
Optional arguments:
-h, --help
show this help message and exit

3.3.311. openstack service set
Copy link

usage: openstack service set [-h] [--type <type>] [--name <service-name>]
                             [--description <description>]
                             [--enable | --disable]
                             <service>
Copy to Clipboard Toggle word wrap
Set service properties
Positional arguments:
<service>
Service to update (type, name or ID)
Optional arguments:
-h, --help
show this help message and exit
--type <type>
New service type (compute, image, identity, volume, etc)
--name <service-name>
New service name
--description <description>
New service description
--enable
Enable service
--disable
Disable service

3.3.312. openstack service show
Copy link

usage: openstack service show [-h] [-f {html,json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--prefix PREFIX]
                              <service>
Copy to Clipboard Toggle word wrap
Display service details
Positional arguments:
<service>
Service to display (type, name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.313. openstack snapshot create
Copy link

usage: openstack snapshot create [-h] [-f {html,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 [--name <name>] [--description <description>]
                                 [--force]
                                 <volume>
Copy to Clipboard Toggle word wrap
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

3.3.314. openstack snapshot delete
Copy link

usage: openstack snapshot delete [-h] <snapshot> [<snapshot> ...]
Copy to Clipboard Toggle word wrap
Delete volume snapshot(s)
Positional arguments:
<snapshot>
Snapshot(s) to delete (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.315. openstack snapshot list
Copy link

usage: openstack snapshot list [-h] [-f {csv,html,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--all-projects] [--long]
Copy to Clipboard Toggle word wrap
List snapshots
Optional arguments:
-h, --help
show this help message and exit
--all-projects
Include all projects (admin only)
--long
List additional fields in output

3.3.316. openstack snapshot set
Copy link

usage: openstack snapshot set [-h] [--name <name>]
                              [--description <description>]
                              [--property <key=value>] [--state <state>]
                              <snapshot>
Copy to Clipboard Toggle word wrap
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)
--state <state>
New snapshot state. Valid values are available, error, creating, deleting, and error-deleting.

3.3.317. openstack snapshot show
Copy link

usage: openstack snapshot show [-h] [-f {html,json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent] [--prefix PREFIX]
                               <snapshot>
Copy to Clipboard Toggle word wrap
Display snapshot details
Positional arguments:
<snapshot>
Snapshot to display (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.318. openstack snapshot unset
Copy link

usage: openstack snapshot unset [-h] [--property <key>] <snapshot>
Copy to Clipboard Toggle word wrap
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 option to remove multiple properties)

3.3.319. openstack software config create
Copy link

usage: openstack software config create [-h]
                                        [-f {html,json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent] [--prefix PREFIX]
                                        [--config-file <config-file>]
                                        [--definition-file <destination-file>]
                                        [--group <group>]
                                        <config-name>
Copy to Clipboard Toggle word wrap
Create software config
Positional arguments:
<config-name>
Name of the software config to create
Optional arguments:
-h, --help
show this help message and exit
--config-file <config-file>
Path to JSON/YAML containing map defining <inputs>, <outputs>, and <options>
--definition-file <destination-file>
Path to software config script/data
--group <group>
Group name of tool expected by the software config

3.3.320. openstack software config delete
Copy link

usage: openstack software config delete [-h] <config> [<config> ...]
Copy to Clipboard Toggle word wrap
Delete software configs
Positional arguments:
<config>
IDs of the software configs to delete
Optional arguments:
-h, --help
show this help message and exit

3.3.321. openstack software config list
Copy link

usage: openstack software config list [-h]
                                      [-f {csv,html,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--limit <limit>] [--marker <id>]
Copy to Clipboard Toggle word wrap
List software configs
Optional arguments:
-h, --help
show this help message and exit
--limit <limit>
Limit the number of configs returned
--marker <id>
Return configs that appear after the given config ID

3.3.322. openstack software config show
Copy link

usage: openstack software config show [-h]
                                      [-f {html,json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--noindent] [--prefix PREFIX]
                                      [--config-only]
                                      <config>
Copy to Clipboard Toggle word wrap
Show software config details
Positional arguments:
<config>
ID of the config
Optional arguments:
-h, --help
show this help message and exit
--config-only
Only display the value of the <config> property.

3.3.323. openstack software deployment create
Copy link

usage: openstack software deployment create [-h]
                                            [-f {html,json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--noindent] [--prefix PREFIX]
                                            [--input-value <key=value>]
                                            [--action <action>]
                                            [--config <config>] --server
                                            <server>
                                            [--signal-transport <signal-transport>]
                                            [--container <container>]
                                            [--timeout <timeout>]
                                            <deployment-name>
Copy to Clipboard Toggle word wrap
Create a software deployment.
Positional arguments:
<deployment-name>
Name of the derived config associated with this deployment. This is used to apply a sort order to the list of configurations currently deployed to the server.
Optional arguments:
-h, --help
show this help message and exit
--input-value <key=value>
Input value to set on the deployment. This can be specified multiple times.
--action <action>
Name of an action for this deployment. This can be a custom action, or one of CREATE, UPDATE, DELETE, SUSPEND, RESUME. Default is UPDATE
--config <config>
ID of the configuration to deploy
--server <server>
ID of the server being deployed to
--signal-transport <signal-transport>
How the server should signal to heat with the deployment output values. TEMP_URL_SIGNAL will create a Swift TempURL to be signaled via HTTP PUT. ZAQAR_SIGNAL will create a dedicated zaqar queue to be signaled using the provided keystone credentials.NO_SIGNAL will result in the resource going to the COMPLETE state without waiting for any signal
--container <container>
Optional name of container to store TEMP_URL_SIGNAL objects in. If not specified a container will be created with a name derived from the DEPLOY_NAME
--timeout <timeout>
Deployment timeout in minutes

3.3.324. openstack software deployment delete
Copy link

usage: openstack software deployment delete [-h]
                                            <deployment> [<deployment> ...]
Copy to Clipboard Toggle word wrap
Delete software deployment(s) and correlative config(s).
Positional arguments:
<deployment>
ID of the deployment(s) to delete.
Optional arguments:
-h, --help
show this help message and exit

3.3.325. openstack software deployment list
Copy link

usage: openstack software deployment list [-h]
                                          [-f {csv,html,json,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--server <server>] [--long]
Copy to Clipboard Toggle word wrap
List software deployments.
Optional arguments:
-h, --help
show this help message and exit
--server <server>
ID of the server to fetch deployments for
--long
List more fields in output 
usage: openstack software deployment metadata show [-h] <server>
Copy to Clipboard Toggle word wrap
Get deployment configuration metadata for the specified server.
Positional arguments:
<server>
ID of the server to fetch deployments for
Optional arguments:
-h, --help
show this help message and exit

3.3.327. openstack software deployment output show
Copy link

usage: openstack software deployment output show [-h] [--all] [--long]
                                                 <deployment> [<output-name>]
Copy to Clipboard Toggle word wrap
Show a specific deployment output.
Positional arguments:
<deployment>
ID of deployment to show the output for
<output-name>
Name of an output to display
Optional arguments:
-h, --help
show this help message and exit
--all
Display all deployment outputs
--long
Show full deployment logs in output

3.3.328. openstack software deployment show
Copy link

usage: openstack software deployment show [-h]
                                          [-f {html,json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent] [--prefix PREFIX]
                                          [--long]
                                          <deployment>
Copy to Clipboard Toggle word wrap
Show SoftwareDeployment Details.
Positional arguments:
<deployment>
ID of the deployment
Optional arguments:
-h, --help
show this help message and exit
--long
Show more fields in output

3.3.329. openstack stack abandon
Copy link

usage: openstack stack abandon [-h] [-f {html,json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent] [--prefix PREFIX]
                               [--output-file <output-file>]
                               <stack>
Copy to Clipboard Toggle word wrap
Abandon stack and output results.
Positional arguments:
<stack>
Name or ID of stack to abandon
Optional arguments:
-h, --help
show this help message and exit
--output-file <output-file>
File to output abandon results

3.3.330. openstack stack adopt
Copy link

usage: openstack stack adopt [-h] [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX] [-e <environment>]
                             [--timeout <timeout>] --adopt-file <adopt-file>
                             [--enable-rollback] [--parameter <key=value>]
                             [--wait]
                             <stack-name>
Copy to Clipboard Toggle word wrap
Adopt a stack.
Positional arguments:
<stack-name>
Name of the stack to adopt
Optional arguments:
-h, --help
show this help message and exit
-e <environment>, --environment <environment>
Path to the environment. Can be specified multiple times
--timeout <timeout>
Stack creation timeout in minutes
--adopt-file <adopt-file>
Path to adopt stack data file
--enable-rollback
Enable rollback on create/update failure
--parameter <key=value>
Parameter values used to create the stack. Can be specified multiple times
--wait
Wait until stack adopt completes

3.3.331. openstack stack cancel
Copy link

usage: openstack stack cancel [-h] [-f {csv,html,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}] [--wait]
                              <stack> [<stack> ...]
Copy to Clipboard Toggle word wrap
Cancel current task for a stack. Supported tasks for cancellation: * update
Positional arguments:
<stack>
Stack(s) to cancel (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--wait
Wait for check to complete

3.3.332. openstack stack check
Copy link

usage: openstack stack check [-h] [-f {csv,html,json,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}] [--wait]
                             <stack> [<stack> ...]
Copy to Clipboard Toggle word wrap
Check a stack.
Positional arguments:
<stack>
Stack(s) to check update (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--wait
Wait for check to complete

3.3.333. openstack stack create
Copy link

usage: openstack stack create [-h] [-f {html,json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--prefix PREFIX] -t <template>
                              [-e <environment>] [--timeout <timeout>]
                              [--pre-create <resource>] [--enable-rollback]
                              [--parameter <key=value>]
                              [--parameter-file <key=file>] [--wait]
                              [--tags <tag1,tag2...>] [--dry-run]
                              <stack-name>
Copy to Clipboard Toggle word wrap
Create a stack.
Positional arguments:
<stack-name>
Name of the stack to create
Optional arguments:
-h, --help
show this help message and exit
-t <template>, --template <template>
Path to the template
-e <environment>, --environment <environment>
Path to the environment. Can be specified multiple times
--timeout <timeout>
Stack creating timeout in minutes
--pre-create <resource>
Name of a resource to set a pre-create hook to. Resources in nested stacks can be set using slash as a separator: nested_stack/another/my_resource. You can use wildcards to match multiple stacks or resources: nested_stack/an*/*_resource. This can be specified multiple times
--enable-rollback
Enable rollback on create/update failure
--parameter <key=value>
Parameter values used to create the stack. This can be specified multiple times
--parameter-file <key=file>
Parameter values from file used to create the stack. This can be specified multiple times. Parameter values would be the content of the file
--wait
Wait until stack goes to CREATE_COMPLETE or CREATE_FAILED
--tags <tag1,tag2...>
A list of tags to associate with the stack
--dry-run
Do not actually perform the stack create, but show what would be created

3.3.334. openstack stack delete
Copy link

usage: openstack stack delete [-h] [--yes] [--wait] <stack> [<stack> ...]
Copy to Clipboard Toggle word wrap
Delete stack(s).
Positional arguments:
<stack>
Stack(s) to delete (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--yes
Skip yes/no prompt (assume yes)
--wait
Wait for stack delete to complete

3.3.335. openstack stack event list
Copy link

usage: openstack stack event list [-h] [-f {csv,html,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--resource <resource>]
                                  [--filter <key=value>] [--limit <limit>]
                                  [--marker <id>] [--nested-depth <depth>]
                                  [--sort <key>[:<direction>]] [--follow]
                                  <stack>
Copy to Clipboard Toggle word wrap
List events.
Positional arguments:
<stack>
Name or ID of stack to show events for
Optional arguments:
-h, --help
show this help message and exit
--resource <resource>
Name of resource to show events for. Note: this cannot be specified with --nested-depth
--filter <key=value>
Filter parameters to apply on returned events
--limit <limit>
Limit the number of events returned
--marker <id>
Only return events that appear after the given ID
--nested-depth <depth>
Depth of nested stacks from which to display events. Note: this cannot be specified with --resource
--sort <key>[:<direction>]
Sort output by selected keys and directions (asc or desc) (default: asc). Specify multiple times to sort on multiple keys
--follow
Print events until process is halted

3.3.336. openstack stack event show
Copy link

usage: openstack stack event show [-h] [-f {html,json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent] [--prefix PREFIX]
                                  <stack> <resource> <event>
Copy to Clipboard Toggle word wrap
Show event details.
Positional arguments:
<stack>
Name or ID of stack to show events for
<resource>
Name of the resource event belongs to
<event>
ID of event to display details for
Optional arguments:
-h, --help
show this help message and exit

3.3.337. openstack stack hook clear
Copy link

usage: openstack stack hook clear [-h] [--pre-create] [--pre-update]
                                  <stack> <resource> [<resource> ...]
Copy to Clipboard Toggle word wrap
Clear resource hooks on a given stack.
Positional arguments:
<stack>
Stack to display (name or ID)
<resource>
Resource names with hooks to clear. Resources in nested stacks can be set using slash as a separator: nested_stack/another/my_resource. You can use wildcards to match multiple stacks or resources: nested_stack/an*/*_resource
Optional arguments:
-h, --help
show this help message and exit
--pre-create
Clear the pre-create hooks
--pre-update
Clear the pre-update hooks

3.3.338. openstack stack hook poll
Copy link

usage: openstack stack hook poll [-h] [-f {csv,html,json,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--nested-depth <nested-depth>]
                                 <stack>
Copy to Clipboard Toggle word wrap
List resources with pending hook for a stack.
Positional arguments:
<stack>
Stack to display (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--nested-depth <nested-depth>
Depth of nested stacks from which to display hooks

3.3.339. openstack stack list
Copy link

usage: openstack stack list [-h] [-f {csv,html,json,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--noindent]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--deleted] [--nested] [--hidden]
                            [--property <key=value>] [--tags <tag1,tag2...>]
                            [--tag-mode <mode>] [--limit <limit>]
                            [--marker <id>] [--sort <key>[:<direction>]]
                            [--all-projects] [--short] [--long]
Copy to Clipboard Toggle word wrap
List stacks.
Optional arguments:
-h, --help
show this help message and exit
--deleted
Include soft-deleted stacks in the stack listing
--nested
Include nested stacks in the stack listing
--hidden
Include hidden stacks in the stack listing
--property <key=value>
Filter properties to apply on returned stacks (repeat to filter on multiple properties)
--tags <tag1,tag2...>
List of tags to filter by. Can be combined with --tag- mode to specify how to filter tags
--tag-mode <mode>
Method of filtering tags. Must be one of "any", "not", or "not-any". If not specified, multiple tags will be combined with the boolean AND expression
--limit <limit>
The number of stacks returned
--marker <id>
Only return stacks that appear after the given ID
--sort <key>[:<direction>]
Sort output by selected keys and directions (asc or desc) (default: asc). Specify multiple times to sort on multiple properties
--all-projects
Include all projects (admin only)
--short
List fewer fields in output
--long
List additional fields in output, this is implied by --all-projects

3.3.340. openstack stack output list
Copy link

usage: openstack stack output list [-h] [-f {csv,html,json,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   <stack>
Copy to Clipboard Toggle word wrap
List stack outputs.
Positional arguments:
<stack>
Name or ID of stack to query
Optional arguments:
-h, --help
show this help message and exit

3.3.341. openstack stack output show
Copy link

usage: openstack stack output show [-h]
                                   [-f {html,json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent] [--prefix PREFIX] [--all]
                                   <stack> [<output>]
Copy to Clipboard Toggle word wrap
Show stack output.
Positional arguments:
<stack>
Name or ID of stack to query
<output>
Name of an output to display
Optional arguments:
-h, --help
show this help message and exit
--all
Display all stack outputs

3.3.342. openstack stack resource list
Copy link

usage: openstack stack resource list [-h]
                                     [-f {csv,html,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--long] [-n <nested-depth>]
                                     [--filter <key=value>]
                                     <stack>
Copy to Clipboard Toggle word wrap
List stack resources.
Positional arguments:
<stack>
Name or ID of stack to query
Optional arguments:
-h, --help
show this help message and exit
--long
Enable detailed information presented for each resource in resource list
-n <nested-depth>, --nested-depth <nested-depth>
Depth of nested stacks from which to display resources
--filter <key=value>
Filter parameters to apply on returned resources based on their name, status, type, action, id and physcial_resource_id

3.3.343. openstack stack resource mark unhealthy
Copy link

usage: openstack stack resource mark unhealthy [-h] [--reset]
                                               <stack> <resource> [reason]
Copy to Clipboard Toggle word wrap
Set resource's health.
Positional arguments:
<stack>
Name or ID of stack the resource belongs to
<resource>
Name of the resource
reason
Reason for state change
Optional arguments:
-h, --help
show this help message and exit
--reset
Set the resource as healthy

3.3.344. openstack stack resource metadata
Copy link

usage: openstack stack resource metadata [-h]
                                         [-f {html,json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--noindent] [--prefix PREFIX]
                                         <stack> <resource>
Copy to Clipboard Toggle word wrap
Show resource metadata
Positional arguments:
<stack>
Stack to display (name or ID)
<resource>
Name of the resource to show the metadata for
Optional arguments:
-h, --help
show this help message and exit

3.3.345. openstack stack resource show
Copy link

usage: openstack stack resource show [-h]
                                     [-f {html,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent] [--prefix PREFIX]
                                     [--with-attr <attribute>]
                                     <stack> <resource>
Copy to Clipboard Toggle word wrap
Display stack resource.
Positional arguments:
<stack>
Name or ID of stack to query
<resource>
Name or ID of resource
Optional arguments:
-h, --help
show this help message and exit
--with-attr <attribute>
Attribute to show, can be specified multiple times

3.3.346. openstack stack resource signal
Copy link

usage: openstack stack resource signal [-h] [--data <data>]
                                       [--data-file <data-file>]
                                       <stack> <resource>
Copy to Clipboard Toggle word wrap
Signal a resource with optional data.
Positional arguments:
<stack>
Name or ID of stack the resource belongs to
<resource>
Name of the resoure to signal
Optional arguments:
-h, --help
show this help message and exit
--data <data>
JSON Data to send to the signal handler
--data-file <data-file>
File containing JSON data to send to the signal handler

3.3.347. openstack stack resume
Copy link

usage: openstack stack resume [-h] [-f {csv,html,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}] [--wait]
                              <stack> [<stack> ...]
Copy to Clipboard Toggle word wrap
Resume a stack.
Positional arguments:
<stack>
Stack(s) to resume (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--wait
Wait for resume to complete

3.3.348. openstack stack show
Copy link

usage: openstack stack show [-h] [-f {html,json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--noindent]
                            [--prefix PREFIX]
                            <stack>
Copy to Clipboard Toggle word wrap
Show stack details.
Positional arguments:
<stack>
Stack to display (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.349. openstack stack snapshot create
Copy link

usage: openstack stack snapshot create [-h]
                                       [-f {html,json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--noindent] [--prefix PREFIX]
                                       [--name <name>]
                                       <stack>
Copy to Clipboard Toggle word wrap
Create stack snapshot.
Positional arguments:
<stack>
Name or ID of stack
Optional arguments:
-h, --help
show this help message and exit
--name <name>
Name of snapshot

3.3.350. openstack stack snapshot delete
Copy link

usage: openstack stack snapshot delete [-h] <stack> <snapshot>
Copy to Clipboard Toggle word wrap
Delete stack snapshot.
Positional arguments:
<stack>
Name or ID of stack
<snapshot>
ID of stack snapshot
Optional arguments:
-h, --help
show this help message and exit

3.3.351. openstack stack snapshot list
Copy link

usage: openstack stack snapshot list [-h]
                                     [-f {csv,html,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     <stack>
Copy to Clipboard Toggle word wrap
List stack snapshots.
Positional arguments:
<stack>
Name or ID of stack containing the snapshots
Optional arguments:
-h, --help
show this help message and exit

3.3.352. openstack stack snapshot restore
Copy link

usage: openstack stack snapshot restore [-h] <stack> <snapshot>
Copy to Clipboard Toggle word wrap
Restore stack snapshot
Positional arguments:
<stack>
Name or ID of stack containing the snapshot
<snapshot>
ID of the snapshot to restore
Optional arguments:
-h, --help
show this help message and exit

3.3.353. openstack stack snapshot show
Copy link

usage: openstack stack snapshot show [-h]
                                     [-f {html,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent] [--prefix PREFIX]
                                     <stack> <snapshot>
Copy to Clipboard Toggle word wrap
Show stack snapshot.
Positional arguments:
<stack>
Name or ID of stack containing the snapshot
<snapshot>
ID of the snapshot to show
Optional arguments:
-h, --help
show this help message and exit

3.3.354. openstack stack suspend
Copy link

usage: openstack stack suspend [-h] [-f {csv,html,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--wait]
                               <stack> [<stack> ...]
Copy to Clipboard Toggle word wrap
Suspend a stack.
Positional arguments:
<stack>
Stack(s) to suspend (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--wait
Wait for suspend to complete

3.3.355. openstack stack template show
Copy link

usage: openstack stack template show [-h]
                                     [-f {html,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent] [--prefix PREFIX]
                                     <stack>
Copy to Clipboard Toggle word wrap
Display stack template.
Positional arguments:
<stack>
Name or ID of stack to query
Optional arguments:
-h, --help
show this help message and exit

3.3.356. openstack stack update
Copy link

usage: openstack stack update [-h] [-f {html,json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--prefix PREFIX] [-t <template>]
                              [-e <environment>] [--pre-update <resource>]
                              [--timeout <timeout>] [--rollback <value>]
                              [--dry-run] [--parameter <key=value>]
                              [--parameter-file <key=file>] [--existing]
                              [--clear-parameter <parameter>]
                              [--tags <tag1,tag2...>] [--wait]
                              <stack>
Copy to Clipboard Toggle word wrap
Update a stack.
Positional arguments:
<stack>
Name or ID of stack to update
Optional arguments:
-h, --help
show this help message and exit
-t <template>, --template <template>
Path to the template
-e <environment>, --environment <environment>
Path to the environment. Can be specified multiple times
--pre-update <resource>
Name of a resource to set a pre-update hook to. Resources in nested stacks can be set using slash as a separator: nested_stack/another/my_resource. You can use wildcards to match multiple stacks or resources: nested_stack/an*/*_resource. This can be specified multiple times
--timeout <timeout>
Stack update timeout in minutes
--rollback <value>
Set rollback on update failure. Value "enabled" sets rollback to enabled. Value "disabled" sets rollback to disabled. Value "keep" uses the value of existing stack to be updated (default)
--dry-run
Do not actually perform the stack update, but show what would be changed
--parameter <key=value>
Parameter values used to create the stack. This can be specified multiple times
--parameter-file <key=file>
Parameter values from file used to create the stack. This can be specified multiple times. Parameter value would be the content of the file
--existing
Re-use the template, parameters and environment of the current stack. If the template argument is omitted then the existing template is used. If no --environment is specified then the existing environment is used. Parameters specified in --parameter will patch over the existing values in the current stack. Parameters omitted will keep the existing values
--clear-parameter <parameter>
Remove the parameters from the set of parameters of current stack for the stack-update. The default value in the template will be used. This can be specified multiple times
--tags <tag1,tag2...>
An updated list of tags to associate with the stack
--wait
Wait until stack goes to UPDATE_COMPLETE or UPDATE_FAILED

3.3.357. openstack subnet delete
Copy link

usage: openstack subnet delete [-h] <subnet>
Copy to Clipboard Toggle word wrap
Delete subnet
Positional arguments:
<subnet>
Subnet to delete (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.358. openstack subnet list
Copy link

usage: openstack subnet list [-h] [-f {csv,html,json,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}] [--long]
                             [--ip-version <ip-version>]
Copy to Clipboard Toggle word wrap
List subnets
Optional arguments:
-h, --help
show this help message and exit
--long
List additional fields in output
--ip-version <ip-version>
List only subnets of given IP version in outputAllowed values for IP version are 4 and 6.

3.3.359. openstack subnet pool delete
Copy link

usage: openstack subnet pool delete [-h] <subnet-pool>
Copy to Clipboard Toggle word wrap
Delete subnet pool
Positional arguments:
<subnet-pool>
Subnet pool to delete (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.360. openstack subnet pool list
Copy link

usage: openstack subnet pool list [-h] [-f {csv,html,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--long]
Copy to Clipboard Toggle word wrap
List subnet pools
Optional arguments:
-h, --help
show this help message and exit
--long
List additional fields in output

3.3.361. openstack subnet pool show
Copy link

usage: openstack subnet pool show [-h] [-f {html,json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent] [--prefix PREFIX]
                                  <subnet-pool>
Copy to Clipboard Toggle word wrap
Display subnet pool details
Positional arguments:
<subnet-pool>
Subnet pool to display (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.362. openstack subnet show
Copy link

usage: openstack subnet show [-h] [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX]
                             <subnet>
Copy to Clipboard Toggle word wrap
Display subnet details
Positional arguments:
<subnet>
Subnet to display (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.363. openstack tld create
Copy link

usage: openstack tld create [-h] [-f {html,json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--noindent]
                            [--prefix PREFIX] --name NAME
                            [--description DESCRIPTION]
Copy to Clipboard Toggle word wrap
Create new tld
Optional arguments:
-h, --help
show this help message and exit
--name NAME
TLD Name
--description DESCRIPTION
Description

3.3.364. openstack tld delete
Copy link

usage: openstack tld delete [-h] id
Copy to Clipboard Toggle word wrap
Delete tld
Positional arguments:
id
TLD ID
Optional arguments:
-h, --help
show this help message and exit

3.3.365. openstack tld list
Copy link

usage: openstack tld list [-h] [-f {csv,html,json,table,value,yaml}]
                          [-c COLUMN] [--max-width <integer>] [--noindent]
                          [--quote {all,minimal,none,nonnumeric}]
                          [--name NAME] [--description DESCRIPTION]
Copy to Clipboard Toggle word wrap
List tlds
Optional arguments:
-h, --help
show this help message and exit
--name NAME
TLD NAME
--description DESCRIPTION
TLD Description

3.3.366. openstack tld set
Copy link

usage: openstack tld set [-h] [-f {html,json,shell,table,value,yaml}]
                         [-c COLUMN] [--max-width <integer>] [--noindent]
                         [--prefix PREFIX] [--name NAME]
                         [--description DESCRIPTION | --no-description]
                         id
Copy to Clipboard Toggle word wrap
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

3.3.367. openstack tld show
Copy link

usage: openstack tld show [-h] [-f {html,json,shell,table,value,yaml}]
                          [-c COLUMN] [--max-width <integer>] [--noindent]
                          [--prefix PREFIX]
                          id
Copy to Clipboard Toggle word wrap
Show tld details
Positional arguments:
id
TLD ID
Optional arguments:
-h, --help
show this help message and exit

3.3.368. openstack token issue
Copy link

usage: openstack token issue [-h] [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX]
Copy to Clipboard Toggle word wrap
Issue new token
Optional arguments:
-h, --help
show this help message and exit

3.3.369. openstack token revoke
Copy link

usage: openstack token revoke [-h] <token>
Copy to Clipboard Toggle word wrap
Revoke existing token
Positional arguments:
<token>
Token to be deleted
Optional arguments:
-h, --help
show this help message and exit

3.3.370. openstack trust create
Copy link

usage: openstack trust create [-h] [-f {html,json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--prefix PREFIX] --project <project> --role
                              <role> [--impersonate]
                              [--expiration <expiration>]
                              [--project-domain <project-domain>]
                              [--trustor-domain <trustor-domain>]
                              [--trustee-domain <trustee-domain>]
                              <trustor-user> <trustee-user>
Copy to Clipboard Toggle word wrap
Create new trust
Positional arguments:
<trustor-user>
User that is delegating authorization (name or ID)
<trustee-user>
User that is assuming authorization (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--project <project>
Project being delegated (name or ID) (required)
--role <role>
Roles to authorize (name or ID) (repeat option to set multiple values, required)
--impersonate
Tokens generated from the trust will represent <trustor> (defaults to False)
--expiration <expiration>
Sets an expiration date for the trust (format of YYYY-mm-ddTHH:MM:SS)
--project-domain <project-domain>
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
--trustor-domain <trustor-domain>
Domain that contains <trustor> (name or ID)
--trustee-domain <trustee-domain>
Domain that contains <trustee> (name or ID)

3.3.371. openstack trust delete
Copy link

usage: openstack trust delete [-h] <trust> [<trust> ...]
Copy to Clipboard Toggle word wrap
Delete trust(s)
Positional arguments:
<trust>
Trust(s) to delete
Optional arguments:
-h, --help
show this help message and exit

3.3.372. openstack trust list
Copy link

usage: openstack trust list [-h] [-f {csv,html,json,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--noindent]
                            [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List trusts
Optional arguments:
-h, --help
show this help message and exit

3.3.373. openstack trust show
Copy link

usage: openstack trust show [-h] [-f {html,json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--noindent]
                            [--prefix PREFIX]
                            <trust>
Copy to Clipboard Toggle word wrap
Display trust details
Positional arguments:
<trust>
Trust to display
Optional arguments:
-h, --help
show this help message and exit

3.3.374. openstack usage list
Copy link

usage: openstack usage list [-h] [-f {csv,html,json,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--noindent]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--start <start>] [--end <end>]
Copy to Clipboard Toggle word wrap
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)

3.3.375. openstack usage show
Copy link

usage: openstack usage show [-h] [-f {html,json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--noindent]
                            [--prefix PREFIX] [--project <project>]
                            [--start <start>] [--end <end>]
Copy to Clipboard Toggle word wrap
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)

3.3.376. openstack user create
Copy link

usage: openstack user create [-h] [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX] [--domain <domain>]
                             [--project <project>]
                             [--project-domain <project-domain>]
                             [--password <password>] [--password-prompt]
                             [--email <email-address>]
                             [--description <description>]
                             [--enable | --disable] [--or-show]
                             <name>
Copy to Clipboard Toggle word wrap
Create new user
Positional arguments:
<name>
New user name
Optional arguments:
-h, --help
show this help message and exit
--domain <domain>
Default domain (name or ID)
--project <project>
Default 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.
--password <password>
Set user password
--password-prompt
Prompt interactively for password
--email <email-address>
Set user email address
--description <description>
User description
--enable
Enable user (default)
--disable
Disable user
--or-show
Return existing user

3.3.377. openstack user delete
Copy link

usage: openstack user delete [-h] [--domain <domain>] <user> [<user> ...]
Copy to Clipboard Toggle word wrap
Delete user(s)
Positional arguments:
<user>
User(s) to delete (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--domain <domain>
Domain owning <user> (name or ID)

3.3.378. openstack user list
Copy link

usage: openstack user list [-h] [-f {csv,html,json,table,value,yaml}]
                           [-c COLUMN] [--max-width <integer>] [--noindent]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--domain <domain>]
                           [--group <group> | --project <project>] [--long]
Copy to Clipboard Toggle word wrap
List users
Optional arguments:
-h, --help
show this help message and exit
--domain <domain>
Filter users by <domain> (name or ID)
--group <group>
Filter users by <group> membership (name or ID)
--project <project>
Filter users by <project> (name or ID)
--long
List additional fields in output

3.3.379. openstack user password set
Copy link

usage: openstack user password set [-h] [--password <new-password>]
                                   [--original-password <original-password>]
Copy to Clipboard Toggle word wrap
Change current user password
Optional arguments:
-h, --help
show this help message and exit
--password <new-password>
New user password
--original-password <original-password>
Original user password

3.3.380. openstack user set
Copy link

usage: openstack user set [-h] [--name <name>] [--project <project>]
                          [--project-domain <project-domain>]
                          [--password <password>] [--password-prompt]
                          [--email <email-address>]
                          [--description <description>] [--enable | --disable]
                          <user>
Copy to Clipboard Toggle word wrap
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)
--project-domain <project-domain>
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
--password <password>
Set user password
--password-prompt
Prompt interactively for password
--email <email-address>
Set user email address
--description <description>
Set user description
--enable
Enable user (default)
--disable
Disable user

3.3.381. openstack user show
Copy link

usage: openstack user show [-h] [-f {html,json,shell,table,value,yaml}]
                           [-c COLUMN] [--max-width <integer>] [--noindent]
                           [--prefix PREFIX] [--domain <domain>]
                           <user>
Copy to Clipboard Toggle word wrap
Display user details
Positional arguments:
<user>
User to display (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--domain <domain>
Domain owning <user> (name or ID)

3.3.382. openstack volume create
Copy link

usage: openstack volume create [-h] [-f {html,json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent] [--prefix PREFIX] --size <size>
                               [--type <volume-type>] [--image <image>]
                               [--snapshot <snapshot>] [--source <volume>]
                               [--description <description>] [--user <user>]
                               [--project <project>]
                               [--availability-zone <availability-zone>]
                               [--property <key=value>]
                               <name>
Copy to Clipboard Toggle word wrap
Create new volume
Positional arguments:
<name>
Volume name
Optional arguments:
-h, --help
show this help message and exit
--size <size>
Volume size in GB
--type <volume-type>
Set the type of volume
--image <image>
Use <image> as source of volume (name or ID)
--snapshot <snapshot>
Use <snapshot> as source of volume (name or ID)
--source <volume>
Volume to clone (name or ID)
--description <description>
Volume description
--user <user>
Specify an alternate user (name or ID)
--project <project>
Specify an alternate project (name or ID)
--availability-zone <availability-zone>
Create volume in <availability-zone>
--property <key=value>
Set a property to this volume (repeat option to set multiple properties)

3.3.383. openstack volume delete
Copy link

usage: openstack volume delete [-h] [--force] <volume> [<volume> ...]
Copy to Clipboard Toggle word wrap
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.384. openstack volume list
Copy link

usage: openstack volume list [-h] [-f {csv,html,json,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--project <project>]
                             [--project-domain <project-domain>]
                             [--user <user>] [--user-domain <user-domain>]
                             [--name <name>] [--status <status>]
                             [--all-projects] [--long]
Copy to Clipboard Toggle word wrap
List volumes
Optional arguments:
-h, --help
show this help message and exit
--project <project>
Filter results by project (name or ID) (admin only)
--project-domain <project-domain>
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
--user <user>
Filter results by user (name or ID) (admin only)
--user-domain <user-domain>
Domain the user belongs to (name or ID). This can be used in case collisions between user names exist.
--name <name>
Filter results by volume name
--status <status>
Filter results by status
--all-projects
Include all projects (admin only)
--long
List additional fields in output

3.3.385. openstack volume qos associate
Copy link

usage: openstack volume qos associate [-h] <qos-spec> <volume-type>
Copy to Clipboard Toggle word wrap
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.386. openstack volume qos create
Copy link

usage: openstack volume qos create [-h]
                                   [-f {html,json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent] [--prefix PREFIX]
                                   [--consumer <consumer>]
                                   [--property <key=value>]
                                   <name>
Copy to Clipboard Toggle word wrap
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)

3.3.387. openstack volume qos delete
Copy link

usage: openstack volume qos delete [-h] <qos-spec> [<qos-spec> ...]
Copy to Clipboard Toggle word wrap
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.388. openstack volume qos disassociate
Copy link

usage: openstack volume qos disassociate [-h]
                                         [--volume-type <volume-type> | --all]
                                         <qos-spec>
Copy to Clipboard Toggle word wrap
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.389. openstack volume qos list
Copy link

usage: openstack volume qos list [-h] [-f {csv,html,json,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent]
                                 [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List QoS specifications
Optional arguments:
-h, --help
show this help message and exit

3.3.390. openstack volume qos set
Copy link

usage: openstack volume qos set [-h] [--property <key=value>] <qos-spec>
Copy to Clipboard Toggle word wrap
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.391. openstack volume qos show
Copy link

usage: openstack volume qos show [-h] [-f {html,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 <qos-spec>
Copy to Clipboard Toggle word wrap
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

3.3.392. openstack volume qos unset
Copy link

usage: openstack volume qos unset [-h] [--property <key>] <qos-spec>
Copy to Clipboard Toggle word wrap
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.393. openstack volume set
Copy link

usage: openstack volume set [-h] [--name <name>] [--size <size>]
                            [--description <description>]
                            [--property <key=value>]
                            [--image-property <key=value>]
                            <volume>
Copy to Clipboard Toggle word wrap
Set volume properties
Positional arguments:
<volume>
Volume to modify (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--name <name>
New volume name
--size <size>
Extend volume size in GB
--description <description>
New volume description
--property <key=value>
Set a property on this volume (repeat option to set multiple properties)
--image-property <key=value>
Set an image property on this volume (repeat option to set multiple image properties)

3.3.394. openstack volume show
Copy link

usage: openstack volume show [-h] [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX]
                             <volume-id>
Copy to Clipboard Toggle word wrap
Display volume details
Positional arguments:
<volume-id>
Volume to display (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.395. openstack volume type create
Copy link

usage: openstack volume type create [-h]
                                    [-f {html,json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--noindent] [--prefix PREFIX]
                                    [--description <description>]
                                    [--public | --private]
                                    [--property <key=value>]
                                    <name>
Copy to Clipboard Toggle word wrap
Create new volume type
Positional arguments:
<name>
Volume type name
Optional arguments:
-h, --help
show this help message and exit
--description <description>
Volume type description
--public
Volume type is accessible to the public
--private
Volume type is not accessible to the public
--property <key=value>
Set a property on this volume type (repeat option to set multiple properties)

3.3.396. openstack volume type delete
Copy link

usage: openstack volume type delete [-h] <volume-type>
Copy to Clipboard Toggle word wrap
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.397. openstack volume type list
Copy link

usage: openstack volume type list [-h] [-f {csv,html,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--long]
Copy to Clipboard Toggle word wrap
List volume types
Optional arguments:
-h, --help
show this help message and exit
--long
List additional fields in output

3.3.398. openstack volume type set
Copy link

usage: openstack volume type set [-h] [--name <name>] [--description <name>]
                                 [--property <key=value>]
                                 [--project <project>]
                                 [--project-domain <project-domain>]
                                 <volume-type>
Copy to Clipboard Toggle word wrap
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
--name <name>
Set volume type name
--description <name>
Set volume type description
--property <key=value>
Set a property on this volume type (repeat option to set multiple properties)
--project <project>
Set volume type access to project (name or ID) (admin only)
--project-domain <project-domain>
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

3.3.399. openstack volume type show
Copy link

usage: openstack volume type show [-h] [-f {html,json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent] [--prefix PREFIX]
                                  <volume-type>
Copy to Clipboard Toggle word wrap
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

3.3.400. openstack volume type unset
Copy link

usage: openstack volume type unset [-h] [--property <key>]
                                   [--project <project>]
                                   [--project-domain <project-domain>]
                                   <volume-type>
Copy to Clipboard Toggle word wrap
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>
Remove a property from this volume type (repeat option to remove multiple properties)
--project <project>
Removes volume type access to project (name or ID) (admin only)
--project-domain <project-domain>
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

3.3.401. openstack volume unset
Copy link

usage: openstack volume unset [-h] [--property <key>] [--image-property <key>]
                              <volume>
Copy to Clipboard Toggle word wrap
Unset volume properties
Positional arguments:
<volume>
Volume to modify (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--property <key>
Remove a property from volume (repeat option to remove multiple properties)
--image-property <key>
Remove an image property from volume (repeat option to remove multiple image properties)

3.3.402. openstack zone abandon
Copy link

usage: openstack zone abandon [-h] id
Copy to Clipboard Toggle word wrap
Abandon a zone
Positional arguments:
id
Zone ID
Optional arguments:
-h, --help
show this help message and exit

3.3.403. openstack zone axfr
Copy link

usage: openstack zone axfr [-h] id
Copy to Clipboard Toggle word wrap
AXFR a zone
Positional arguments:
id
Zone ID
Optional arguments:
-h, --help
show this help message and exit

3.3.404. openstack zone blacklist create
Copy link

usage: openstack zone blacklist create [-h]
                                       [-f {html,json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--noindent] [--prefix PREFIX]
                                       --pattern PATTERN
                                       [--description DESCRIPTION]
Copy to Clipboard Toggle word wrap
Create new blacklist
Optional arguments:
-h, --help
show this help message and exit
--pattern PATTERN
Blacklist pattern
--description DESCRIPTION
Description

3.3.405. openstack zone blacklist delete
Copy link

usage: openstack zone blacklist delete [-h] id
Copy to Clipboard Toggle word wrap
Delete blacklist
Positional arguments:
id
Blacklist ID
Optional arguments:
-h, --help
show this help message and exit

3.3.406. openstack zone blacklist list
Copy link

usage: openstack zone blacklist list [-h]
                                     [-f {csv,html,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List blacklists
Optional arguments:
-h, --help
show this help message and exit

3.3.407. openstack zone blacklist set
Copy link

usage: openstack zone blacklist set [-h]
                                    [-f {html,json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--noindent] [--prefix PREFIX]
                                    [--pattern PATTERN]
                                    [--description DESCRIPTION | --no-description]
                                    id
Copy to Clipboard Toggle word wrap
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

3.3.408. openstack zone blacklist show
Copy link

usage: openstack zone blacklist show [-h]
                                     [-f {html,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent] [--prefix PREFIX]
                                     id
Copy to Clipboard Toggle word wrap
Show blacklist details
Positional arguments:
id
Blacklist ID
Optional arguments:
-h, --help
show this help message and exit

3.3.409. openstack zone create
Copy link

usage: openstack zone create [-h] [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX] [--email EMAIL] [--type TYPE]
                             [--ttl TTL] [--description DESCRIPTION]
                             [--masters MASTERS [MASTERS ...]]
                             name
Copy to Clipboard Toggle word wrap
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

3.3.410. openstack zone delete
Copy link

usage: openstack zone delete [-h] id
Copy to Clipboard Toggle word wrap
Delete zone
Positional arguments:
id
Zone ID
Optional arguments:
-h, --help
show this help message and exit

3.3.411. openstack zone list
Copy link

usage: openstack zone list [-h] [-f {csv,html,json,table,value,yaml}]
                           [-c COLUMN] [--max-width <integer>] [--noindent]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--name NAME] [--email EMAIL] [--type TYPE]
                           [--ttl TTL] [--description DESCRIPTION]
                           [--status STATUS]
Copy to Clipboard Toggle word wrap
List zones
Optional arguments:
-h, --help
show this help message and exit
--name NAME
Zone Name
--email EMAIL
Zone Email
--type TYPE
Zone Type
--ttl TTL
Time To Live (Seconds)
--description DESCRIPTION
Description
--status STATUS
Zone Status

3.3.412. openstack zone set
Copy link

usage: openstack zone set [-h] [-f {html,json,shell,table,value,yaml}]
                          [-c COLUMN] [--max-width <integer>] [--noindent]
                          [--prefix PREFIX] [--email EMAIL] [--ttl TTL]
                          [--description DESCRIPTION | --no-description]
                          [--masters MASTERS [MASTERS ...]]
                          id
Copy to Clipboard Toggle word wrap
Set zone properties
Positional arguments:
id
Zone ID
Optional arguments:
-h, --help
show this help message and exit
--email EMAIL
Zone Email
--ttl TTL
Time To Live (Seconds)
--description DESCRIPTION
Description
--no-description
--masters MASTERS [MASTERS ...]
Zone Masters

3.3.413. openstack zone show
Copy link

usage: openstack zone show [-h] [-f {html,json,shell,table,value,yaml}]
                           [-c COLUMN] [--max-width <integer>] [--noindent]
                           [--prefix PREFIX]
                           id
Copy to Clipboard Toggle word wrap
Show zone details
Positional arguments:
id
Zone ID
Optional arguments:
-h, --help
show this help message and exit

3.3.414. openstack zone transfer accept request
Copy link

usage: openstack zone transfer accept request [-h]
                                              [-f {html,json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--noindent] [--prefix PREFIX]
                                              --transfer-id TRANSFER_ID --key
                                              KEY
Copy to Clipboard Toggle word wrap
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.415. openstack zone transfer accept show
Copy link

usage: openstack zone transfer accept show [-h]
                                           [-f {html,json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--noindent] [--prefix PREFIX]
                                           id
Copy to Clipboard Toggle word wrap
Show Zone Transfer Accept
Positional arguments:
id
Zone Tranfer Accept ID
Optional arguments:
-h, --help
show this help message and exit

3.3.416. openstack zone transfer request create
Copy link

usage: openstack zone transfer request create [-h]
                                              [-f {html,json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--noindent] [--prefix PREFIX]
                                              [--target-project-id TARGET_PROJECT_ID]
                                              [--description DESCRIPTION]
                                              zone_id
Copy to Clipboard Toggle word wrap
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

3.3.417. openstack zone transfer request delete
Copy link

usage: openstack zone transfer request delete [-h] id
Copy to Clipboard Toggle word wrap
Delete a Zone Transfer Request
Positional arguments:
id
Zone Transfer Request ID
Optional arguments:
-h, --help
show this help message and exit

3.3.418. openstack zone transfer request list
Copy link

usage: openstack zone transfer request list [-h]
                                            [-f {csv,html,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--noindent]
                                            [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List Zone Transfer Requests
Optional arguments:
-h, --help
show this help message and exit

3.3.419. openstack zone transfer request set
Copy link

usage: openstack zone transfer request set [-h]
                                           [-f {html,json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--noindent] [--prefix PREFIX]
                                           [--description DESCRIPTION | --no-description]
                                           id
Copy to Clipboard Toggle word wrap
Set a Zone Transfer Request
Positional arguments:
id
Zone Transfer Request ID
Optional arguments:
-h, --help
show this help message and exit
--description DESCRIPTION
Description
--no-description

3.3.420. openstack zone transfer request show
Copy link

usage: openstack zone transfer request show [-h]
                                            [-f {html,json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--noindent] [--prefix PREFIX]
                                            id
Copy to Clipboard Toggle word wrap
Show Zone Transfer Request Details
Positional arguments:
id
Zone Tranfer Request ID
Optional arguments:
-h, --help
show this help message and exit

Chapter 4. Configuration file editor
Copy link

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
Copy to Clipboard Toggle word wrap

4.1. openstack-config usage
Copy link

 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]
Copy to Clipboard Toggle word wrap

4.2. openstack-config optional arguments
Copy link

--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
The cinder client is the command-line interface (CLI) for the Block Storage service API and its extensions. This chapter documents cinder version 1.6.0.
For help on a specific cinder command, enter: 
$ cinder help COMMAND
Copy to Clipboard Toggle word wrap

5.1. cinder usage
Copy link

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

Subcommands

absolute-limits
Lists absolute limits for a user.
availability-zone-list
Lists all availability zones.
backup-create
Creates a volume backup.
backup-delete
Removes one or more backups.
backup-export
Export backup metadata record.
backup-import
Import backup metadata record.
backup-list
Lists all backups.
backup-reset-state
Explicitly updates the backup state.
backup-restore
Restores a backup.
backup-show
Shows backup details.
cgsnapshot-create
Creates a cgsnapshot.
cgsnapshot-delete
Removes one or more cgsnapshots.
cgsnapshot-list
Lists all cgsnapshots.
cgsnapshot-show
Shows cgsnapshot details.
consisgroup-create
Creates a consistency group.
consisgroup-create-from-src
Creates a consistency group from a cgsnapshot or a source CG.
consisgroup-delete
Removes one or more consistency groups.
consisgroup-list
Lists all consistencygroups.
consisgroup-show
Shows details of a consistency group.
consisgroup-update
Updates a consistencygroup.
create
Creates a volume.
credentials
Shows user credentials returned from auth.
delete
Removes one or more volumes.
encryption-type-create
Creates encryption type for a volume type. Admin only.
encryption-type-delete
Deletes encryption type for a volume type. Admin only.
encryption-type-list
Shows encryption type details for volume types. Admin only.
encryption-type-show
Shows encryption type details for a volume type. Admin only.
encryption-type-update
Update encryption type information for a volume type (Admin Only).
endpoints
Discovers endpoints registered by authentication service.
extend
Attempts to extend size of an existing volume.
extra-specs-list
Lists current volume types and extra specs.
failover-host
force-delete
Attempts force-delete of volume, regardless of state.
freeze-host
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.
image-metadata-show
Shows 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-manage
Manage an existing snapshot.
snapshot-metadata
Sets or deletes snapshot metadata.
snapshot-metadata-show
Shows snapshot metadata.
snapshot-metadata-update-all
Updates snapshot metadata.
snapshot-rename
Renames a snapshot.
snapshot-reset-state
Explicitly updates the snapshot state.
snapshot-show
Shows snapshot details.
snapshot-unmanage
Stop managing a snapshot.
thaw-host
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-show
Show volume type details.
type-update
Updates volume type name, description, and/or is_public.
unmanage
Stop managing a volume.
upload-to-image
Uploads volume to Image Service as an image.
bash-completion
Prints arguments for bash_completion.
help
Shows help about this program or one of its subcommands.
list-extensions
Lists all available os-api extensions.

5.2. cinder optional arguments
Copy link

--version
show program's version number and exit
-d, --debug
Shows debugging output.
--os-auth-system <auth-system>
Defaults to env[OS_AUTH_SYSTEM].
--service-type <service-type>
Service type. For most actions, default is volume.
--service-name <service-name>
Service name. Default=env[CINDER_SERVICE_NAME].
--volume-service-name <volume-service-name>
Volume service name. Default=env[CINDER_VOLUME_SERVICE_NAME].
--os-endpoint-type <os-endpoint-type>
Endpoint type, which is publicURL or internalURL. Default=env[OS_ENDPOINT_TYPE] or nova env[CINDER_ENDPOINT_TYPE] or publicURL.
--endpoint-type <endpoint-type>
DEPRECATED! Use --os-endpoint-type.
--os-volume-api-version <volume-api-ver>
Block Storage API version. 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)
Copy link

5.3.1. cinder absolute-limits
Copy link

usage: cinder absolute-limits
Copy to Clipboard Toggle word wrap
Lists absolute limits for a user.

5.3.2. cinder availability-zone-list
Copy link

usage: cinder availability-zone-list
Copy to Clipboard Toggle word wrap
Lists all availability zones.

5.3.3. cinder backup-create
Copy link

usage: cinder backup-create [--container <container>] [--name <name>] [--description <description>] [--incremental] [--force] [--snapshot-id <snapshot-id>] <volume>
Copy to Clipboard Toggle word wrap
Creates a volume backup.

Positional arguments

<volume>
Name or ID of volume to backup.

Optional arguments

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

5.3.4. cinder backup-delete
Copy link

usage: cinder backup-delete <backup> [<backup> ...]
Copy to Clipboard Toggle word wrap
Removes one or more backups.

Positional arguments

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

5.3.5. cinder backup-export
Copy link

usage: cinder backup-export <backup>
Copy to Clipboard Toggle word wrap
Export backup metadata record.

Positional arguments

<backup>
ID of the backup to export.

5.3.6. cinder backup-import
Copy link

usage: cinder backup-import <backup_service> <backup_url>
Copy to Clipboard Toggle word wrap
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
Copy link

usage: cinder backup-list [--all-tenants [<all_tenants>]] [--name <name>] [--status <status>] [--volume-id <volume-id>] [--marker <marker>] [--limit <limit>] [--sort <key>[:<direction>]]
Copy to Clipboard Toggle word wrap
Lists all backups.

Optional arguments

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

5.3.8. cinder backup-reset-state
Copy link

usage: cinder backup-reset-state [--state <state>] <backup> [<backup> ...]
Copy to Clipboard Toggle word wrap
Explicitly updates the backup state.

Positional arguments

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

Optional arguments

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

5.3.9. cinder backup-restore
Copy link

usage: cinder backup-restore [--volume <volume>] <backup>
Copy to Clipboard Toggle word wrap
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.10. cinder backup-show
Copy link

usage: cinder backup-show <backup>
Copy to Clipboard Toggle word wrap
Shows backup details.

Positional arguments

<backup>
Name or ID of backup.

5.3.11. cinder cgsnapshot-create
Copy link

usage: cinder cgsnapshot-create [--name <name>] [--description <description>] <consistencygroup>
Copy to Clipboard Toggle word wrap
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.12. cinder cgsnapshot-delete
Copy link

usage: cinder cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]
Copy to Clipboard Toggle word wrap
Removes one or more cgsnapshots.

Positional arguments

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

5.3.13. cinder cgsnapshot-list
Copy link

usage: cinder cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>] [--consistencygroup-id <consistencygroup_id>]
Copy to Clipboard Toggle word wrap
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.14. cinder cgsnapshot-show
Copy link

usage: cinder cgsnapshot-show <cgsnapshot>
Copy to Clipboard Toggle word wrap
Shows cgsnapshot details.

Positional arguments

<cgsnapshot>
Name or ID of cgsnapshot.

5.3.15. cinder consisgroup-create
Copy link

usage: cinder consisgroup-create [--name <name>] [--description <description>] [--availability-zone <availability-zone>] <volume-types>
Copy to Clipboard Toggle word wrap
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.16. cinder consisgroup-create-from-src
Copy link

usage: cinder consisgroup-create-from-src [--cgsnapshot <cgsnapshot>] [--source-cg <source-cg>] [--name <name>] [--description <description>]
Copy to Clipboard Toggle word wrap
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.17. cinder consisgroup-delete
Copy link

usage: cinder consisgroup-delete [--force] <consistencygroup> [<consistencygroup> ...]
Copy to Clipboard Toggle word wrap
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.18. cinder consisgroup-list
Copy link

usage: cinder consisgroup-list [--all-tenants [<0|1>]]
Copy to Clipboard Toggle word wrap
Lists all consistencygroups.

Optional arguments

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

5.3.19. cinder consisgroup-show
Copy link

usage: cinder consisgroup-show <consistencygroup>
Copy to Clipboard Toggle word wrap
Shows details of a consistency group.

Positional arguments

<consistencygroup>
Name or ID of a consistency group.

5.3.20. cinder consisgroup-update
Copy link

usage: cinder consisgroup-update [--name <name>] [--description <description>] [--add-volumes <uuid1,uuid2,......>] [--remove-volumes <uuid3,uuid4,......>] <consistencygroup>
Copy to Clipboard Toggle word wrap
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.21. cinder create
Copy link

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>]
Copy to Clipboard Toggle word wrap
Creates a volume.

Positional arguments

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

Optional arguments

--consisgroup-id <consistencygroup-id>
ID of a consistency group where the new volume belongs to. Default=None.
--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.22. cinder credentials
Copy link

usage: cinder credentials
Copy to Clipboard Toggle word wrap
Shows user credentials returned from auth.

5.3.23. cinder delete
Copy link

usage: cinder delete <volume> [<volume> ...]
Copy to Clipboard Toggle word wrap
Removes one or more volumes.

Positional arguments

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

5.3.24. cinder encryption-type-create
Copy link

usage: cinder encryption-type-create [--cipher <cipher>] [--key_size <key_size>] [--control_location <control_location>] <volume_type> <provider>
Copy to Clipboard Toggle word wrap
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.25. cinder encryption-type-delete
Copy link

usage: cinder encryption-type-delete <volume_type>
Copy to Clipboard Toggle word wrap
Deletes encryption type for a volume type. Admin only.

Positional arguments

<volume_type>
Name or ID of volume type.

5.3.26. cinder encryption-type-list
Copy link

usage: cinder encryption-type-list
Copy to Clipboard Toggle word wrap
Shows encryption type details for volume types. Admin only.

5.3.27. cinder encryption-type-show
Copy link

usage: cinder encryption-type-show <volume_type>
Copy to Clipboard Toggle word wrap
Shows encryption type details for a volume type. Admin only.

Positional arguments

<volume_type>
Name or ID of volume type.

5.3.28. cinder encryption-type-update
Copy link

usage: cinder encryption-type-update [--provider <provider>] [--cipher [<cipher>]] [--key-size [<key-size>]] [--control-location <control-location>] <volume-type>
Copy to Clipboard Toggle word wrap
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.29. cinder endpoints
Copy link

usage: cinder endpoints
Copy to Clipboard Toggle word wrap
Discovers endpoints registered by authentication service.

5.3.30. cinder extend
Copy link

usage: cinder extend <volume> <new_size>
Copy to Clipboard Toggle word wrap
Attempts to extend size of an existing volume.

Positional arguments

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

5.3.31. cinder extra-specs-list
Copy link

usage: cinder extra-specs-list
Copy to Clipboard Toggle word wrap
Lists current volume types and extra specs.

5.3.32. cinder failover-host
Copy link

usage: cinder failover-host [--backend_id <backend-id>] <hostname>
Copy to Clipboard Toggle word wrap

Positional arguments

<hostname>
Host name.

Optional arguments

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

5.3.33. cinder force-delete
Copy link

usage: cinder force-delete <volume> [<volume> ...]
Copy to Clipboard Toggle word wrap
Attempts force-delete of volume, regardless of state.

Positional arguments

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

5.3.34. cinder freeze-host
Copy link

usage: cinder freeze-host <hostname>
Copy to Clipboard Toggle word wrap

Positional arguments

<hostname>
Host name.

5.3.35. cinder get-capabilities
Copy link

usage: cinder get-capabilities <host>
Copy to Clipboard Toggle word wrap
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.36. cinder get-pools
Copy link

usage: cinder get-pools [--detail]
Copy to Clipboard Toggle word wrap
Show pool information for backends. Admin only.

Optional arguments

--detail
Show detailed information about pools.

5.3.37. cinder image-metadata
Copy link

usage: cinder image-metadata <volume> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
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.38. cinder image-metadata-show
Copy link

usage: cinder image-metadata-show <volume>
Copy to Clipboard Toggle word wrap
Shows volume image metadata.

Positional arguments

<volume>
ID of volume.

5.3.39. cinder list
Copy link

usage: cinder list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] [--bootable [<True|true|False|false>]] [--migration_status <migration_status>] [--metadata [<key=value> [<key=value> ...]]] [--marker <marker>] [--limit <limit>] [--fields <fields>] [--sort <key>[:<direction>]] [--tenant [<tenant>]]
Copy to Clipboard Toggle word wrap
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.
--bootable [<True|true|False|false>]
Filters results by bootable status. Default=None.
--migration_status <migration_status>
Filters results by a migration status. Default=None. Admin only.
--metadata [<key=value> [<key=value> ...]]
Filters results by a metadata key and value pair. Default=None.
--marker <marker>
Begin returning volumes that appear later in the volume list than that represented by this volume id. Default=None.
--limit <limit>
Maximum number of volumes to return. Default=None.
--fields <fields>
Comma-separated list of fields to display. Use the show command to see which fields are available. Unavailable/non-existent fields will be ignored. Default=None.
--sort <key>[:<direction>]
Comma-separated list of sort keys and directions in the form of <key>[:<asc|desc>]. Valid keys: id, status, size, availability_zone, name, bootable, created_at. Default=None.
--tenant [<tenant>]
Display information from single tenant (Admin only).

5.3.40. cinder list-extensions
Copy link

usage: cinder list-extensions
Copy to Clipboard Toggle word wrap
Lists all available os-api extensions.

5.3.41. cinder manage
Copy link

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>
Copy to Clipboard Toggle word wrap
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.42. cinder metadata
Copy link

usage: cinder metadata <volume> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
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.43. cinder metadata-show
Copy link

usage: cinder metadata-show <volume>
Copy to Clipboard Toggle word wrap
Shows volume metadata.

Positional arguments

<volume>
ID of volume.

5.3.44. cinder metadata-update-all
Copy link

usage: cinder metadata-update-all <volume> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
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.45. cinder migrate
Copy link

usage: cinder migrate [--force-host-copy [<True|False>]] [--lock-volume [<True|False>]] <volume> <host>
Copy to Clipboard Toggle word wrap
Migrates volume to a new host.

Positional arguments

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

Optional arguments

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

5.3.46. cinder qos-associate
Copy link

usage: cinder qos-associate <qos_specs> <volume_type_id>
Copy to Clipboard Toggle word wrap
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.47. cinder qos-create
Copy link

usage: cinder qos-create <name> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
Creates a qos specs.

Positional arguments

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

5.3.48. cinder qos-delete
Copy link

usage: cinder qos-delete [--force [<True|False>]] <qos_specs>
Copy to Clipboard Toggle word wrap
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.49. cinder qos-disassociate
Copy link

usage: cinder qos-disassociate <qos_specs> <volume_type_id>
Copy to Clipboard Toggle word wrap
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.50. cinder qos-disassociate-all
Copy link

usage: cinder qos-disassociate-all <qos_specs>
Copy to Clipboard Toggle word wrap
Disassociates qos specs from all its associations.

Positional arguments

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

5.3.51. cinder qos-get-association
Copy link

usage: cinder qos-get-association <qos_specs>
Copy to Clipboard Toggle word wrap
Lists all associations for specified qos specs.

Positional arguments

<qos_specs>
ID of QoS specifications.

5.3.52. cinder qos-key
Copy link

usage: cinder qos-key <qos_specs> <action> key=value [key=value ...]
Copy to Clipboard Toggle word wrap
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.53. cinder qos-list
Copy link

usage: cinder qos-list
Copy to Clipboard Toggle word wrap
Lists qos specs.

5.3.54. cinder qos-show
Copy link

usage: cinder qos-show <qos_specs>
Copy to Clipboard Toggle word wrap
Shows qos specs details.

Positional arguments

<qos_specs>
ID of QoS specifications to show.

5.3.55. cinder quota-class-show
Copy link

usage: cinder quota-class-show <class>
Copy to Clipboard Toggle word wrap
Lists quotas for a quota class.

Positional arguments

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

5.3.56. cinder quota-class-update
Copy link

usage: cinder quota-class-update [--volumes <volumes>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--volume-type <volume_type_name>] <class_name>
Copy to Clipboard Toggle word wrap
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.57. cinder quota-defaults
Copy link

usage: cinder quota-defaults <tenant_id>
Copy to Clipboard Toggle word wrap
Lists default quotas for a tenant.

Positional arguments

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

5.3.58. cinder quota-delete
Copy link

usage: cinder quota-delete <tenant_id>
Copy to Clipboard Toggle word wrap
Delete the quotas for a tenant.

Positional arguments

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

5.3.59. cinder quota-show
Copy link

usage: cinder quota-show <tenant_id>
Copy to Clipboard Toggle word wrap
Lists quotas for a tenant.

Positional arguments

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

5.3.60. cinder quota-update
Copy link

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>
Copy to Clipboard Toggle word wrap
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.61. cinder quota-usage
Copy link

usage: cinder quota-usage <tenant_id>
Copy to Clipboard Toggle word wrap
Lists quota usage for a tenant.

Positional arguments

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

5.3.62. cinder rate-limits
Copy link

usage: cinder rate-limits
Copy to Clipboard Toggle word wrap
Lists rate limits for a user.

5.3.63. cinder readonly-mode-update
Copy link

usage: cinder readonly-mode-update <volume> <True|true|False|false>
Copy to Clipboard Toggle word wrap
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.64. cinder rename
Copy link

usage: cinder rename [--description <description>] <volume> [<name>]
Copy to Clipboard Toggle word wrap
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.65. cinder replication-promote
Copy link

usage: cinder replication-promote <volume>
Copy to Clipboard Toggle word wrap
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.66. cinder replication-reenable
Copy link

usage: cinder replication-reenable <volume>
Copy to Clipboard Toggle word wrap
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.67. cinder reset-state
Copy link

usage: cinder reset-state [--state <state>] [--attach-status <attach-status>] [--reset-migration-status] <volume> [<volume> ...]
Copy to Clipboard Toggle word wrap
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.68. cinder retype
Copy link

usage: cinder retype [--migration-policy <never|on-demand>] <volume> <volume-type>
Copy to Clipboard Toggle word wrap
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.69. cinder service-disable
Copy link

usage: cinder service-disable [--reason <reason>] <hostname> <binary>
Copy to Clipboard Toggle word wrap
Disables the service.

Positional arguments

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

Optional arguments

--reason <reason>
Reason for disabling service.

5.3.70. cinder service-enable
Copy link

usage: cinder service-enable <hostname> <binary>
Copy to Clipboard Toggle word wrap
Enables the service.

Positional arguments

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

5.3.71. cinder service-list
Copy link

usage: cinder service-list [--host <hostname>] [--binary <binary>] [--withreplication [<True|False>]]
Copy to Clipboard Toggle word wrap
Lists all services. Filter by host and service binary.

Optional arguments

--host <hostname>
Host name. Default=None.
--binary <binary>
Service binary. Default=None.
--withreplication [<True|False>]
Enables or disables display of Replication info for c-vol services. Default=False.

5.3.72. cinder set-bootable
Copy link

usage: cinder set-bootable <volume> <True|true|False|false>
Copy to Clipboard Toggle word wrap
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.73. cinder show
Copy link

usage: cinder show <volume>
Copy to Clipboard Toggle word wrap
Shows volume details.

Positional arguments

<volume>
Name or ID of volume.

5.3.74. cinder snapshot-create
Copy link

usage: cinder snapshot-create [--force [<True|False>]] [--name <name>] [--description <description>] [--metadata [<key=value> [<key=value> ...]]] <volume>
Copy to Clipboard Toggle word wrap
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.75. cinder snapshot-delete
Copy link

usage: cinder snapshot-delete <snapshot> [<snapshot> ...]
Copy to Clipboard Toggle word wrap
Removes one or more snapshots.

Positional arguments

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

5.3.76. cinder snapshot-list
Copy link

usage: cinder snapshot-list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] [--volume-id <volume-id>] [--marker <marker>] [--limit <limit>] [--sort <key>[:<direction>]] [--tenant [<tenant>]]
Copy to Clipboard Toggle word wrap
Lists all snapshots.

Optional arguments

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

5.3.77. cinder snapshot-manage
Copy link

usage: cinder snapshot-manage [--id-type <id-type>] [--name <name>] [--description <description>] [--metadata [<key=value> [<key=value> ...]]] <volume> <identifier>
Copy to Clipboard Toggle word wrap
Manage an existing snapshot.

Positional arguments

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

Optional arguments

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

5.3.78. cinder snapshot-metadata
Copy link

usage: cinder snapshot-metadata <snapshot> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
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.79. cinder snapshot-metadata-show
Copy link

usage: cinder snapshot-metadata-show <snapshot>
Copy to Clipboard Toggle word wrap
Shows snapshot metadata.

Positional arguments

<snapshot>
ID of snapshot.

5.3.80. cinder snapshot-metadata-update-all
Copy link

usage: cinder snapshot-metadata-update-all <snapshot> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
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.81. cinder snapshot-rename
Copy link

usage: cinder snapshot-rename [--description <description>] <snapshot> [<name>]
Copy to Clipboard Toggle word wrap
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.82. cinder snapshot-reset-state
Copy link

usage: cinder snapshot-reset-state [--state <state>] <snapshot> [<snapshot> ...]
Copy to Clipboard Toggle word wrap
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.83. cinder snapshot-show
Copy link

usage: cinder snapshot-show <snapshot>
Copy to Clipboard Toggle word wrap
Shows snapshot details.

Positional arguments

<snapshot>
Name or ID of snapshot.

5.3.84. cinder snapshot-unmanage
Copy link

usage: cinder snapshot-unmanage <snapshot>
Copy to Clipboard Toggle word wrap
Stop managing a snapshot.

Positional arguments

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

5.3.85. cinder thaw-host
Copy link

usage: cinder thaw-host <hostname>
Copy to Clipboard Toggle word wrap

Positional arguments

<hostname>
Host name.

5.3.86. cinder transfer-accept
Copy link

usage: cinder transfer-accept <transfer> <auth_key>
Copy to Clipboard Toggle word wrap
Accepts a volume transfer.

Positional arguments

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

5.3.87. cinder transfer-create
Copy link

usage: cinder transfer-create [--name <name>] <volume>
Copy to Clipboard Toggle word wrap
Creates a volume transfer.

Positional arguments

<volume>
Name or ID of volume to transfer.

Optional arguments

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

5.3.88. cinder transfer-delete
Copy link

usage: cinder transfer-delete <transfer>
Copy to Clipboard Toggle word wrap
Undoes a transfer.

Positional arguments

<transfer>
Name or ID of transfer to delete.

5.3.89. cinder transfer-list
Copy link

usage: cinder transfer-list [--all-tenants [<0|1>]]
Copy to Clipboard Toggle word wrap
Lists all transfers.

Optional arguments

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

5.3.90. cinder transfer-show
Copy link

usage: cinder transfer-show <transfer>
Copy to Clipboard Toggle word wrap
Shows transfer details.

Positional arguments

<transfer>
Name or ID of transfer to accept.

5.3.91. cinder type-access-add
Copy link

usage: cinder type-access-add --volume-type <volume_type> --project-id <project_id>
Copy to Clipboard Toggle word wrap
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.92. cinder type-access-list
Copy link

usage: cinder type-access-list --volume-type <volume_type>
Copy to Clipboard Toggle word wrap
Print access information about the given volume type.

Optional arguments

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

5.3.93. cinder type-access-remove
Copy link

usage: cinder type-access-remove --volume-type <volume_type> --project-id <project_id>
Copy to Clipboard Toggle word wrap
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.94. cinder type-create
Copy link

usage: cinder type-create [--description <description>] [--is-public <is-public>] <name>
Copy to Clipboard Toggle word wrap
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.95. cinder type-default
Copy link

usage: cinder type-default
Copy to Clipboard Toggle word wrap
List the default volume type.

5.3.96. cinder type-delete
Copy link

usage: cinder type-delete <id>
Copy to Clipboard Toggle word wrap
Deletes a volume type.

Positional arguments

<id>
ID of volume type to delete.

5.3.97. cinder type-key
Copy link

usage: cinder type-key <vtype> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
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.98. cinder type-list
Copy link

usage: cinder type-list
Copy to Clipboard Toggle word wrap
Lists available 'volume types'. (Admin only will see private types)

5.3.99. cinder type-show
Copy link

usage: cinder type-show <volume_type>
Copy to Clipboard Toggle word wrap
Show volume type details.

Positional arguments

<volume_type>
Name or ID of the volume type.

5.3.100. cinder type-update
Copy link

usage: cinder type-update [--name <name>] [--description <description>] [--is-public <is-public>] <id>
Copy to Clipboard Toggle word wrap
Updates volume type name, description, and/or is_public.

Positional arguments

<id>
ID of the volume type.

Optional arguments

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

5.3.101. cinder unmanage
Copy link

usage: cinder unmanage <volume>
Copy to Clipboard Toggle word wrap
Stop managing a volume.

Positional arguments

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

5.3.102. cinder upload-to-image
Copy link

usage: cinder upload-to-image [--force [<True|False>]] [--container-format <container-format>] [--disk-format <disk-format>] <volume> <image-name>
Copy to Clipboard Toggle word wrap
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
Copy link

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
Copy to Clipboard Toggle word wrap

5.4.1. cinder absolute-limits (v2)
Copy link

usage: cinder --os-volume-api-version 2 absolute-limits
Copy to Clipboard Toggle word wrap
Lists absolute limits for a user.

5.4.2. cinder availability-zone-list (v2)
Copy link

usage: cinder --os-volume-api-version 2 availability-zone-list
Copy to Clipboard Toggle word wrap
Lists all availability zones.

5.4.3. cinder backup-create (v2)
Copy link

usage: cinder --os-volume-api-version 2 backup-create [--container <container>] [--name <name>] [--description <description>] [--incremental] [--force] [--snapshot-id <snapshot-id>] <volume>
Copy to Clipboard Toggle word wrap
Creates a volume backup.

Positional arguments

<volume>
Name or ID of volume to backup.

Optional arguments

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

5.4.4. cinder backup-delete (v2)
Copy link

usage: cinder --os-volume-api-version 2 backup-delete <backup> [<backup> ...]
Copy to Clipboard Toggle word wrap
Removes one or more backups.

Positional arguments

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

5.4.5. cinder backup-export (v2)
Copy link

usage: cinder --os-volume-api-version 2 backup-export <backup>
Copy to Clipboard Toggle word wrap
Export backup metadata record.

Positional arguments

<backup>
ID of the backup to export.

5.4.6. cinder backup-import (v2)
Copy link

usage: cinder --os-volume-api-version 2 backup-import <backup_service> <backup_url>
Copy to Clipboard Toggle word wrap
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)
Copy link

usage: cinder --os-volume-api-version 2 backup-list [--all-tenants [<all_tenants>]] [--name <name>] [--status <status>] [--volume-id <volume-id>] [--marker <marker>] [--limit <limit>] [--sort <key>[:<direction>]]
Copy to Clipboard Toggle word wrap
Lists all backups.

Optional arguments

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

5.4.8. cinder backup-reset-state (v2)
Copy link

usage: cinder --os-volume-api-version 2 backup-reset-state [--state <state>] <backup> [<backup> ...]
Copy to Clipboard Toggle word wrap
Explicitly updates the backup state.

Positional arguments

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

Optional arguments

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

5.4.9. cinder backup-restore (v2)
Copy link

usage: cinder --os-volume-api-version 2 backup-restore [--volume <volume>] <backup>
Copy to Clipboard Toggle word wrap
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.10. cinder backup-show (v2)
Copy link

usage: cinder --os-volume-api-version 2 backup-show <backup>
Copy to Clipboard Toggle word wrap
Shows backup details.

Positional arguments

<backup>
Name or ID of backup.

5.4.11. cinder cgsnapshot-create (v2)
Copy link

usage: cinder --os-volume-api-version 2 cgsnapshot-create [--name <name>] [--description <description>] <consistencygroup>
Copy to Clipboard Toggle word wrap
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.12. cinder cgsnapshot-delete (v2)
Copy link

usage: cinder --os-volume-api-version 2 cgsnapshot-delete <cgsnapshot> [<cgsnapshot> ...]
Copy to Clipboard Toggle word wrap
Removes one or more cgsnapshots.

Positional arguments

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

5.4.13. cinder cgsnapshot-list (v2)
Copy link

usage: cinder --os-volume-api-version 2 cgsnapshot-list [--all-tenants [<0|1>]] [--status <status>] [--consistencygroup-id <consistencygroup_id>]
Copy to Clipboard Toggle word wrap
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.14. cinder cgsnapshot-show (v2)
Copy link

usage: cinder --os-volume-api-version 2 cgsnapshot-show <cgsnapshot>
Copy to Clipboard Toggle word wrap
Shows cgsnapshot details.

Positional arguments

<cgsnapshot>
Name or ID of cgsnapshot.

5.4.15. cinder consisgroup-create (v2)
Copy link

usage: cinder --os-volume-api-version 2 consisgroup-create [--name <name>] [--description <description>] [--availability-zone <availability-zone>] <volume-types>
Copy to Clipboard Toggle word wrap
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.16. cinder consisgroup-create-from-src (v2)
Copy link

usage: cinder --os-volume-api-version 2 consisgroup-create-from-src [--cgsnapshot <cgsnapshot>] [--source-cg <source-cg>] [--name <name>] [--description <description>]
Copy to Clipboard Toggle word wrap
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.17. cinder consisgroup-delete (v2)
Copy link

usage: cinder --os-volume-api-version 2 consisgroup-delete [--force] <consistencygroup> [<consistencygroup> ...]
Copy to Clipboard Toggle word wrap
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.18. cinder consisgroup-list (v2)
Copy link

usage: cinder --os-volume-api-version 2 consisgroup-list [--all-tenants [<0|1>]]
Copy to Clipboard Toggle word wrap
Lists all consistencygroups.

Optional arguments

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

5.4.19. cinder consisgroup-show (v2)
Copy link

usage: cinder --os-volume-api-version 2 consisgroup-show <consistencygroup>
Copy to Clipboard Toggle word wrap
Shows details of a consistency group.

Positional arguments

<consistencygroup>
Name or ID of a consistency group.

5.4.20. cinder consisgroup-update (v2)
Copy link

usage: cinder --os-volume-api-version 2 consisgroup-update [--name <name>] [--description <description>] [--add-volumes <uuid1,uuid2,......>] [--remove-volumes <uuid3,uuid4,......>] <consistencygroup>
Copy to Clipboard Toggle word wrap
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.21. cinder create (v2)
Copy link

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>]
Copy to Clipboard Toggle word wrap
Creates a volume.

Positional arguments

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

Optional arguments

--consisgroup-id <consistencygroup-id>
ID of a consistency group where the new volume belongs to. Default=None.
--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.22. cinder credentials (v2)
Copy link

usage: cinder --os-volume-api-version 2 credentials
Copy to Clipboard Toggle word wrap
Shows user credentials returned from auth.

5.4.23. cinder delete (v2)
Copy link

usage: cinder --os-volume-api-version 2 delete <volume> [<volume> ...]
Copy to Clipboard Toggle word wrap
Removes one or more volumes.

Positional arguments

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

5.4.24. cinder encryption-type-create (v2)
Copy link

usage: cinder --os-volume-api-version 2 encryption-type-create [--cipher <cipher>] [--key_size <key_size>] [--control_location <control_location>] <volume_type> <provider>
Copy to Clipboard Toggle word wrap
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.25. cinder encryption-type-delete (v2)
Copy link

usage: cinder --os-volume-api-version 2 encryption-type-delete <volume_type>
Copy to Clipboard Toggle word wrap
Deletes encryption type for a volume type. Admin only.

Positional arguments

<volume_type>
Name or ID of volume type.

5.4.26. cinder encryption-type-list (v2)
Copy link

usage: cinder --os-volume-api-version 2 encryption-type-list
Copy to Clipboard Toggle word wrap
Shows encryption type details for volume types. Admin only.

5.4.27. cinder encryption-type-show (v2)
Copy link

usage: cinder --os-volume-api-version 2 encryption-type-show <volume_type>
Copy to Clipboard Toggle word wrap
Shows encryption type details for a volume type. Admin only.

Positional arguments

<volume_type>
Name or ID of volume type.

5.4.28. cinder encryption-type-update (v2)
Copy link

usage: cinder --os-volume-api-version 2 encryption-type-update [--provider <provider>] [--cipher [<cipher>]] [--key-size [<key-size>]] [--control-location <control-location>] <volume-type>
Copy to Clipboard Toggle word wrap
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.29. cinder endpoints (v2)
Copy link

usage: cinder --os-volume-api-version 2 endpoints
Copy to Clipboard Toggle word wrap
Discovers endpoints registered by authentication service.

5.4.30. cinder extend (v2)
Copy link

usage: cinder --os-volume-api-version 2 extend <volume> <new_size>
Copy to Clipboard Toggle word wrap
Attempts to extend size of an existing volume.

Positional arguments

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

5.4.31. cinder extra-specs-list (v2)
Copy link

usage: cinder --os-volume-api-version 2 extra-specs-list
Copy to Clipboard Toggle word wrap
Lists current volume types and extra specs.

5.4.32. cinder failover-host (v2)
Copy link

usage: cinder --os-volume-api-version 2 failover-host [--backend_id <backend-id>] <hostname>
Copy to Clipboard Toggle word wrap

Positional arguments

<hostname>
Host name.

Optional arguments

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

5.4.33. cinder force-delete (v2)
Copy link

usage: cinder --os-volume-api-version 2 force-delete <volume> [<volume> ...]
Copy to Clipboard Toggle word wrap
Attempts force-delete of volume, regardless of state.

Positional arguments

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

5.4.34. cinder freeze-host (v2)
Copy link

usage: cinder --os-volume-api-version 2 freeze-host <hostname>
Copy to Clipboard Toggle word wrap

Positional arguments

<hostname>
Host name.

5.4.35. cinder get-capabilities (v2)
Copy link

usage: cinder --os-volume-api-version 2 get-capabilities <host>
Copy to Clipboard Toggle word wrap
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.36. cinder get-pools (v2)
Copy link

usage: cinder --os-volume-api-version 2 get-pools [--detail]
Copy to Clipboard Toggle word wrap
Show pool information for backends. Admin only.

Optional arguments

--detail
Show detailed information about pools.

5.4.37. cinder image-metadata (v2)
Copy link

usage: cinder --os-volume-api-version 2 image-metadata <volume> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
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.38. cinder image-metadata-show (v2)
Copy link

usage: cinder --os-volume-api-version 2 image-metadata-show <volume>
Copy to Clipboard Toggle word wrap
Shows volume image metadata.

Positional arguments

<volume>
ID of volume.

5.4.39. cinder list (v2)
Copy link

usage: cinder --os-volume-api-version 2 list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] [--bootable [<True|true|False|false>]] [--migration_status <migration_status>] [--metadata [<key=value> [<key=value> ...]]] [--marker <marker>] [--limit <limit>] [--fields <fields>] [--sort <key>[:<direction>]] [--tenant [<tenant>]]
Copy to Clipboard Toggle word wrap
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.
--bootable [<True|true|False|false>]
Filters results by bootable status. Default=None.
--migration_status <migration_status>
Filters results by a migration status. Default=None. Admin only.
--metadata [<key=value> [<key=value> ...]]
Filters results by a metadata key and value pair. Default=None.
--marker <marker>
Begin returning volumes that appear later in the volume list than that represented by this volume id. Default=None.
--limit <limit>
Maximum number of volumes to return. Default=None.
--fields <fields>
Comma-separated list of fields to display. Use the show command to see which fields are available. Unavailable/non-existent fields will be ignored. Default=None.
--sort <key>[:<direction>]
Comma-separated list of sort keys and directions in the form of <key>[:<asc|desc>]. Valid keys: id, status, size, availability_zone, name, bootable, created_at. Default=None.
--tenant [<tenant>]
Display information from single tenant (Admin only).

5.4.40. cinder list-extensions (v2)
Copy link

usage: cinder --os-volume-api-version 2 list-extensions
Copy to Clipboard Toggle word wrap
Lists all available os-api extensions.

5.4.41. cinder manage (v2)
Copy link

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>
Copy to Clipboard Toggle word wrap
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.42. cinder metadata (v2)
Copy link

usage: cinder --os-volume-api-version 2 metadata <volume> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
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.43. cinder metadata-show (v2)
Copy link

usage: cinder --os-volume-api-version 2 metadata-show <volume>
Copy to Clipboard Toggle word wrap
Shows volume metadata.

Positional arguments

<volume>
ID of volume.

5.4.44. cinder metadata-update-all (v2)
Copy link

usage: cinder --os-volume-api-version 2 metadata-update-all <volume> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
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.45. cinder migrate (v2)
Copy link

usage: cinder --os-volume-api-version 2 migrate [--force-host-copy [<True|False>]] [--lock-volume [<True|False>]] <volume> <host>
Copy to Clipboard Toggle word wrap
Migrates volume to a new host.

Positional arguments

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

Optional arguments

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

5.4.46. cinder qos-associate (v2)
Copy link

usage: cinder --os-volume-api-version 2 qos-associate <qos_specs> <volume_type_id>
Copy to Clipboard Toggle word wrap
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.47. cinder qos-create (v2)
Copy link

usage: cinder --os-volume-api-version 2 qos-create <name> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
Creates a qos specs.

Positional arguments

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

5.4.48. cinder qos-delete (v2)
Copy link

usage: cinder --os-volume-api-version 2 qos-delete [--force [<True|False>]] <qos_specs>
Copy to Clipboard Toggle word wrap
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.49. cinder qos-disassociate (v2)
Copy link

usage: cinder --os-volume-api-version 2 qos-disassociate <qos_specs> <volume_type_id>
Copy to Clipboard Toggle word wrap
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.50. cinder qos-disassociate-all (v2)
Copy link

usage: cinder --os-volume-api-version 2 qos-disassociate-all <qos_specs>
Copy to Clipboard Toggle word wrap
Disassociates qos specs from all its associations.

Positional arguments

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

5.4.51. cinder qos-get-association (v2)
Copy link

usage: cinder --os-volume-api-version 2 qos-get-association <qos_specs>
Copy to Clipboard Toggle word wrap
Lists all associations for specified qos specs.

Positional arguments

<qos_specs>
ID of QoS specifications.

5.4.52. cinder qos-key (v2)
Copy link

usage: cinder --os-volume-api-version 2 qos-key <qos_specs> <action> key=value [key=value ...]
Copy to Clipboard Toggle word wrap
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.53. cinder qos-list (v2)
Copy link

usage: cinder --os-volume-api-version 2 qos-list
Copy to Clipboard Toggle word wrap
Lists qos specs.

5.4.54. cinder qos-show (v2)
Copy link

usage: cinder --os-volume-api-version 2 qos-show <qos_specs>
Copy to Clipboard Toggle word wrap
Shows qos specs details.

Positional arguments

<qos_specs>
ID of QoS specifications to show.

5.4.55. cinder quota-class-show (v2)
Copy link

usage: cinder --os-volume-api-version 2 quota-class-show <class>
Copy to Clipboard Toggle word wrap
Lists quotas for a quota class.

Positional arguments

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

5.4.56. cinder quota-class-update (v2)
Copy link

usage: cinder --os-volume-api-version 2 quota-class-update [--volumes <volumes>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--volume-type <volume_type_name>] <class_name>
Copy to Clipboard Toggle word wrap
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.57. cinder quota-defaults (v2)
Copy link

usage: cinder --os-volume-api-version 2 quota-defaults <tenant_id>
Copy to Clipboard Toggle word wrap
Lists default quotas for a tenant.

Positional arguments

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

5.4.58. cinder quota-delete (v2)
Copy link

usage: cinder --os-volume-api-version 2 quota-delete <tenant_id>
Copy to Clipboard Toggle word wrap
Delete the quotas for a tenant.

Positional arguments

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

5.4.59. cinder quota-show (v2)
Copy link

usage: cinder --os-volume-api-version 2 quota-show <tenant_id>
Copy to Clipboard Toggle word wrap
Lists quotas for a tenant.

Positional arguments

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

5.4.60. cinder quota-update (v2)
Copy link

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>
Copy to Clipboard Toggle word wrap
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.61. cinder quota-usage (v2)
Copy link

usage: cinder --os-volume-api-version 2 quota-usage <tenant_id>
Copy to Clipboard Toggle word wrap
Lists quota usage for a tenant.

Positional arguments

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

5.4.62. cinder rate-limits (v2)
Copy link

usage: cinder --os-volume-api-version 2 rate-limits
Copy to Clipboard Toggle word wrap
Lists rate limits for a user.

5.4.63. cinder readonly-mode-update (v2)
Copy link

usage: cinder --os-volume-api-version 2 readonly-mode-update <volume> <True|true|False|false>
Copy to Clipboard Toggle word wrap
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.64. cinder rename (v2)
Copy link

usage: cinder --os-volume-api-version 2 rename [--description <description>] <volume> [<name>]
Copy to Clipboard Toggle word wrap
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.65. cinder replication-promote (v2)
Copy link

usage: cinder --os-volume-api-version 2 replication-promote <volume>
Copy to Clipboard Toggle word wrap
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.66. cinder replication-reenable (v2)
Copy link

usage: cinder --os-volume-api-version 2 replication-reenable <volume>
Copy to Clipboard Toggle word wrap
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.67. cinder reset-state (v2)
Copy link

usage: cinder --os-volume-api-version 2 reset-state [--state <state>] [--attach-status <attach-status>] [--reset-migration-status] <volume> [<volume> ...]
Copy to Clipboard Toggle word wrap
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.68. cinder retype (v2)
Copy link

usage: cinder --os-volume-api-version 2 retype [--migration-policy <never|on-demand>] <volume> <volume-type>
Copy to Clipboard Toggle word wrap
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.69. cinder service-disable (v2)
Copy link

usage: cinder --os-volume-api-version 2 service-disable [--reason <reason>] <hostname> <binary>
Copy to Clipboard Toggle word wrap
Disables the service.

Positional arguments

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

Optional arguments

--reason <reason>
Reason for disabling service.

5.4.70. cinder service-enable (v2)
Copy link

usage: cinder --os-volume-api-version 2 service-enable <hostname> <binary>
Copy to Clipboard Toggle word wrap
Enables the service.

Positional arguments

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

5.4.71. cinder service-list (v2)
Copy link

usage: cinder --os-volume-api-version 2 service-list [--host <hostname>] [--binary <binary>] [--withreplication [<True|False>]]
Copy to Clipboard Toggle word wrap
Lists all services. Filter by host and service binary.

Optional arguments

--host <hostname>
Host name. Default=None.
--binary <binary>
Service binary. Default=None.
--withreplication [<True|False>]
Enables or disables display of Replication info for c-vol services. Default=False.

5.4.72. cinder set-bootable (v2)
Copy link

usage: cinder --os-volume-api-version 2 set-bootable <volume> <True|true|False|false>
Copy to Clipboard Toggle word wrap
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.73. cinder show (v2)
Copy link

usage: cinder --os-volume-api-version 2 show <volume>
Copy to Clipboard Toggle word wrap
Shows volume details.

Positional arguments

<volume>
Name or ID of volume.

5.4.74. cinder snapshot-create (v2)
Copy link

usage: cinder --os-volume-api-version 2 snapshot-create [--force [<True|False>]] [--name <name>] [--description <description>] [--metadata [<key=value> [<key=value> ...]]] <volume>
Copy to Clipboard Toggle word wrap
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.4.75. cinder snapshot-delete (v2)
Copy link

usage: cinder --os-volume-api-version 2 snapshot-delete <snapshot> [<snapshot> ...]
Copy to Clipboard Toggle word wrap
Removes one or more snapshots.

Positional arguments

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

5.4.76. cinder snapshot-list (v2)
Copy link

usage: cinder --os-volume-api-version 2 snapshot-list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] [--volume-id <volume-id>] [--marker <marker>] [--limit <limit>] [--sort <key>[:<direction>]] [--tenant [<tenant>]]
Copy to Clipboard Toggle word wrap
Lists all snapshots.

Optional arguments

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

5.4.77. cinder snapshot-manage (v2)
Copy link

usage: cinder --os-volume-api-version 2 snapshot-manage [--id-type <id-type>] [--name <name>] [--description <description>] [--metadata [<key=value> [<key=value> ...]]] <volume> <identifier>
Copy to Clipboard Toggle word wrap
Manage an existing snapshot.

Positional arguments

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

Optional arguments

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

5.4.78. cinder snapshot-metadata (v2)
Copy link

usage: cinder --os-volume-api-version 2 snapshot-metadata <snapshot> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
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.4.79. cinder snapshot-metadata-show (v2)
Copy link

usage: cinder --os-volume-api-version 2 snapshot-metadata-show <snapshot>
Copy to Clipboard Toggle word wrap
Shows snapshot metadata.

Positional arguments

<snapshot>
ID of snapshot.

5.4.80. cinder snapshot-metadata-update-all (v2)
Copy link

usage: cinder --os-volume-api-version 2 snapshot-metadata-update-all <snapshot> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
Updates snapshot metadata.

Positional arguments

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

5.4.81. cinder snapshot-rename (v2)
Copy link

usage: cinder --os-volume-api-version 2 snapshot-rename [--description <description>] <snapshot> [<name>]
Copy to Clipboard Toggle word wrap
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.4.82. cinder snapshot-reset-state (v2)
Copy link

usage: cinder --os-volume-api-version 2 snapshot-reset-state [--state <state>] <snapshot> [<snapshot> ...]
Copy to Clipboard Toggle word wrap
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.4.83. cinder snapshot-show (v2)
Copy link

usage: cinder --os-volume-api-version 2 snapshot-show <snapshot>
Copy to Clipboard Toggle word wrap
Shows snapshot details.

Positional arguments

<snapshot>
Name or ID of snapshot.

5.4.84. cinder snapshot-unmanage (v2)
Copy link

usage: cinder --os-volume-api-version 2 snapshot-unmanage <snapshot>
Copy to Clipboard Toggle word wrap
Stop managing a snapshot.

Positional arguments

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

5.4.85. cinder thaw-host (v2)
Copy link

usage: cinder --os-volume-api-version 2 thaw-host <hostname>
Copy to Clipboard Toggle word wrap

Positional arguments

<hostname>
Host name.

5.4.86. cinder transfer-accept (v2)
Copy link

usage: cinder --os-volume-api-version 2 transfer-accept <transfer> <auth_key>
Copy to Clipboard Toggle word wrap
Accepts a volume transfer.

Positional arguments

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

5.4.87. cinder transfer-create (v2)
Copy link

usage: cinder --os-volume-api-version 2 transfer-create [--name <name>] <volume>
Copy to Clipboard Toggle word wrap
Creates a volume transfer.

Positional arguments

<volume>
Name or ID of volume to transfer.

Optional arguments

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

5.4.88. cinder transfer-delete (v2)
Copy link

usage: cinder --os-volume-api-version 2 transfer-delete <transfer>
Copy to Clipboard Toggle word wrap
Undoes a transfer.

Positional arguments

<transfer>
Name or ID of transfer to delete.

5.4.89. cinder transfer-list (v2)
Copy link

usage: cinder --os-volume-api-version 2 transfer-list [--all-tenants [<0|1>]]
Copy to Clipboard Toggle word wrap
Lists all transfers.

Optional arguments

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

5.4.90. cinder transfer-show (v2)
Copy link

usage: cinder --os-volume-api-version 2 transfer-show <transfer>
Copy to Clipboard Toggle word wrap
Shows transfer details.

Positional arguments

<transfer>
Name or ID of transfer to accept.

5.4.91. cinder type-access-add (v2)
Copy link

usage: cinder --os-volume-api-version 2 type-access-add --volume-type <volume_type> --project-id <project_id>
Copy to Clipboard Toggle word wrap
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.4.92. cinder type-access-list (v2)
Copy link

usage: cinder --os-volume-api-version 2 type-access-list --volume-type <volume_type>
Copy to Clipboard Toggle word wrap
Print access information about the given volume type.

Optional arguments

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

5.4.93. cinder type-access-remove (v2)
Copy link

usage: cinder --os-volume-api-version 2 type-access-remove --volume-type <volume_type> --project-id <project_id>
Copy to Clipboard Toggle word wrap
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.4.94. cinder type-create (v2)
Copy link

usage: cinder --os-volume-api-version 2 type-create [--description <description>] [--is-public <is-public>] <name>
Copy to Clipboard Toggle word wrap
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.4.95. cinder type-default (v2)
Copy link

usage: cinder --os-volume-api-version 2 type-default
Copy to Clipboard Toggle word wrap
List the default volume type.

5.4.96. cinder type-delete (v2)
Copy link

usage: cinder --os-volume-api-version 2 type-delete <id>
Copy to Clipboard Toggle word wrap
Deletes a volume type.

Positional arguments

<id>
ID of volume type to delete.

5.4.97. cinder type-key (v2)
Copy link

usage: cinder --os-volume-api-version 2 type-key <vtype> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
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.4.98. cinder type-list (v2)
Copy link

usage: cinder --os-volume-api-version 2 type-list
Copy to Clipboard Toggle word wrap
Lists available 'volume types'. (Admin only will see private types)

5.4.99. cinder type-show (v2)
Copy link

usage: cinder --os-volume-api-version 2 type-show <volume_type>
Copy to Clipboard Toggle word wrap
Show volume type details.

Positional arguments

<volume_type>
Name or ID of the volume type.

5.4.100. cinder type-update (v2)
Copy link

usage: cinder --os-volume-api-version 2 type-update [--name <name>] [--description <description>] [--is-public <is-public>] <id>
Copy to Clipboard Toggle word wrap
Updates volume type name, description, and/or is_public.

Positional arguments

<id>
ID of the volume type.

Optional arguments

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

5.4.101. cinder unmanage (v2)
Copy link

usage: cinder --os-volume-api-version 2 unmanage <volume>
Copy to Clipboard Toggle word wrap
Stop managing a volume.

Positional arguments

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

5.4.102. cinder upload-to-image (v2)
Copy link

usage: cinder --os-volume-api-version 2 upload-to-image [--force [<True|False>]] [--container-format <container-format>] [--disk-format <disk-format>] <volume> <image-name>
Copy to Clipboard Toggle word wrap
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.

Chapter 6. Compute command-line client
Copy link

The nova client is the command-line interface (CLI) for the OpenStack Compute API and its extensions. This chapter documents nova version 3.3.0.
For help on a specific nova command, enter: 
$ nova help COMMAND
Copy to Clipboard Toggle word wrap

6.1. nova usage
Copy link

usage: nova [--version] [--debug] [--os-cache] [--timings] [--os-region-name <region-name>] [--service-type <service-type>] [--service-name <service-name>] [--volume-service-name <volume-service-name>] [--os-endpoint-type <endpoint-type>] [--os-compute-api-version <compute-api-ver>] [--bypass-url <bypass-url>] [--insecure] [--os-cacert <ca-certificate>] [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>] [--os-auth-type <name>] [--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID] [--os-domain-name OS_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID] [--os-project-name OS_PROJECT_NAME] [--os-project-domain-id OS_PROJECT_DOMAIN_ID] [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] [--os-trust-id OS_TRUST_ID] [--os-default-domain-id OS_DEFAULT_DOMAIN_ID] [--os-default-domain-name OS_DEFAULT_DOMAIN_NAME] [--os-user-id OS_USER_ID] [--os-user-name OS_USERNAME] [--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-password OS_PASSWORD] <subcommand> ...
Copy to Clipboard Toggle word wrap

Subcommands

absolute-limits
DEPRECATED, use limits instead.
add-fixed-ip
Add new IP address on a network to server.
add-floating-ip
DEPRECATED, use floating-ip-associate instead.
add-secgroup
Add a Security Group to a server.
agent-create
Create new agent build.
agent-delete
Delete existing agent build.
agent-list
List all builds.
agent-modify
Modify existing agent build.
aggregate-add-host
Add the host to the specified aggregate.
aggregate-create
Create a new aggregate with the specified details.
aggregate-delete
Delete the aggregate.
aggregate-details
Show details of the specified aggregate.
aggregate-list
Print a list of all aggregates.
aggregate-remove-host
Remove the specified host from the specified aggregate.
aggregate-set-metadata
Update the metadata associated with the aggregate.
aggregate-update
Update the aggregate's name and optionally availability zone.
availability-zone-list
List all the availability zones.
backup
Backup a server by creating a 'backup' type snapshot.
boot
Boot a new server.
clear-password
Clear the admin password for a server.
cloudpipe-configure
Update the VPN IP/port of a cloudpipe instance.
cloudpipe-create
Create a cloudpipe instance for the given project.
cloudpipe-list
Print a list of all cloudpipe instances.
console-log
Get console log output of a server.
credentials
Show user credentials returned from auth.
delete
Immediately shut down and delete specified server(s).
diagnostics
Retrieve server diagnostics.
dns-create
Create a DNS entry for domain, name, and IP.
dns-create-private-domain
Create the specified DNS domain.
dns-create-public-domain
Create the specified DNS domain.
dns-delete
Delete the specified DNS entry.
dns-delete-domain
Delete the specified DNS domain.
dns-domains
Print a list of available dns domains.
dns-list
List current DNS entries for domain and IP or domain and name.
endpoints
Discover endpoints that get returned from the authenticate services.
evacuate
Evacuate server from failed host.
fixed-ip-get
Retrieve info on a fixed IP.
fixed-ip-reserve
Reserve a fixed IP.
fixed-ip-unreserve
Unreserve a fixed IP.
flavor-access-add
Add flavor access for the given tenant.
flavor-access-list
Print access information about the given flavor.
flavor-access-remove
Remove flavor access for the given tenant.
flavor-create
Create a new flavor.
flavor-delete
Delete a specific flavor
flavor-key
Set or unset extra_spec for a flavor.
flavor-list
Print a list of available 'flavors' (sizes of servers).
flavor-show
Show details about the given flavor.
floating-ip-associate
Associate a floating IP address to a server.
floating-ip-bulk-create
Bulk create floating IPs by range (nova- network only).
floating-ip-bulk-delete
Bulk delete floating IPs by range (nova- network only).
floating-ip-bulk-list
List all floating IPs (nova-network only).
floating-ip-create
Allocate a floating IP for the current tenant.
floating-ip-delete
De-allocate a floating IP.
floating-ip-disassociate
Disassociate a floating IP address from a server.
floating-ip-list
List floating IPs.
floating-ip-pool-list
List all floating IP pools.
get-mks-console
Get a serial console to a server. (Supported by API versions '2.8' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]
get-password
Get the admin password for a server.
get-rdp-console
Get a rdp console to a server.
get-serial-console
Get a serial console to a server.
get-spice-console
Get a spice console to a server.
get-vnc-console
Get a vnc console to a server.
host-action
Perform a power action on a host.
host-describe
Describe a specific host.
host-list
List all hosts by service.
host-update
Update host settings.
hypervisor-list
List hypervisors.
hypervisor-servers
List servers belonging to specific hypervisors.
hypervisor-show
Display the details of the specified hypervisor.
hypervisor-stats
Get hypervisor statistics over all compute nodes.
hypervisor-uptime
Display the uptime of the specified hypervisor.
image-create
Create a new image by taking a snapshot of a running server.
image-delete
Delete specified image(s).
image-list
Print a list of available images to boot from.
image-meta
Set or delete metadata on an image.
image-show
Show details about the given image.
interface-attach
Attach a network interface to a server.
interface-detach
Detach a network interface from a server.
interface-list
List interfaces attached to a server.
keypair-add
Create a new key pair for use with servers.
keypair-delete
Delete keypair given by its name. (Supported by API versions '2.0' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]
keypair-list
Print a list of keypairs for a user (Supported by API versions '2.0' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]
keypair-show
Show details about the given keypair. (Supported by API versions '2.0' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]
limits
Print rate and absolute limits.
list
List active servers.
list-secgroup
List Security Group(s) of a server.
live-migration
Migrate running server to a new machine.
live-migration-abort
Abort an on-going live migration. (Supported by API versions '2.24' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]
live-migration-force-complete
Force on-going live migration to complete. (Supported by API versions '2.22' - '2.latest') [hint: use '--os-compute-api- version' flag to show help message for proper version]
lock
Lock a server. A normal (non-admin) user will not be able to execute actions on a locked server.
meta
Set or delete metadata on a server.
migrate
Migrate a server. The new host will be selected by the scheduler.
network-associate-host
Associate host with network.
network-associate-project
Associate project with network.
network-create
Create a network.
network-delete
Delete network by label or id.
network-disassociate
Disassociate host and/or project from the given network.
network-list
Print a list of available networks.
network-show
Show details about the given network.
pause
Pause a server.
quota-class-show
List the quotas for a quota class.
quota-class-update
Update the quotas for a quota class.
quota-defaults
List the default quotas for a tenant.
quota-delete
Delete quota for a tenant/user so their quota will Revert back to default.
quota-show
List the quotas for a tenant/user.
quota-update
Update the quotas for a tenant/user.
rate-limits
DEPRECATED, use limits instead.
reboot
Reboot a server.
rebuild
Shutdown, re-image, and re-boot a server.
refresh-network
Refresh server network information.
remove-fixed-ip
Remove an IP address from a server.
remove-floating-ip
DEPRECATED, use floating-ip-disassociate instead.
remove-secgroup
Remove a Security Group from a server.
rename
DEPRECATED, use update instead.
rescue
Reboots a server into rescue mode, which starts the machine from either the initial image or a specified image, attaching the current boot disk as secondary.
reset-network
Reset network of a server.
reset-state
Reset the state of a server.
resize
Resize a server.
resize-confirm
Confirm a previous resize.
resize-revert
Revert a previous resize (and return to the previous VM).
resume
Resume a server.
root-password
DEPRECATED, use set-password instead.
scrub
Delete networks and security groups associated with a project.
secgroup-add-default-rule
Add a rule to the set of rules that will be added to the 'default' security group for new tenants (nova-network only).
secgroup-add-group-rule
Add a source group rule to a security group.
secgroup-add-rule
Add a rule to a security group.
secgroup-create
Create a security group.
secgroup-delete
Delete a security group.
secgroup-delete-default-rule
Delete a rule from the set of rules that will be added to the 'default' security group for new tenants (nova-network only).
secgroup-delete-group-rule
Delete a source group rule from a security group.
secgroup-delete-rule
Delete a rule from a security group.
secgroup-list
List security groups for the current tenant.
secgroup-list-default-rules
List rules that will be added to the 'default' security group for new tenants.
secgroup-list-rules
List rules for a security group.
secgroup-update
Update a security group.
server-group-create
Create a new server group with the specified details.
server-group-delete
Delete specific server group(s).
server-group-get
Get a specific server group.
server-group-list
Print a list of all server groups.
server-migration-list
Get the migrations list of specified server. (Supported by API versions '2.23' - '2.latest') [hint: use '--os-compute-api- version' flag to show help message for proper version]
server-migration-show
Get the migration of specified server. (Supported by API versions '2.23' - '2.latest') [hint: use '--os-compute-api- version' flag to show help message for proper version]
service-delete
Delete the service.
service-disable
Disable the service.
service-enable
Enable the service.
service-force-down
Force service to down. (Supported by API versions '2.11' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]
service-list
Show a list of all running services. Filter by host & binary.
set-password
Change the admin password for a server.
shelve
Shelve a server.
shelve-offload
Remove a shelved server from the compute node.
show
Show details about the given server.
ssh
SSH into a server.
start
Start the server(s).
stop
Stop the server(s).
suspend
Suspend a server.
trigger-crash-dump
Trigger crash dump in an instance. (Supported by API versions '2.17' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]
unlock
Unlock a server.
unpause
Unpause a server.
unrescue
Restart the server from normal boot disk again.
unshelve
Unshelve a server.
update
Update the name or the description for a server.
usage
Show usage data for a single tenant.
usage-list
List usage data for all tenants.
version-list
List all API versions.
virtual-interface-list
Show virtual interface info about the given server.
volume-attach
Attach a volume to a server.
volume-attachments
List all the volumes attached to a server.
volume-create
DEPRECATED: Add a new volume.
volume-delete
DEPRECATED: Remove volume(s).
volume-detach
Detach a volume from a server.
volume-list
DEPRECATED: List all the volumes.
volume-show
DEPRECATED: Show details about a volume.
volume-snapshot-create
DEPRECATED: Add a new snapshot.
volume-snapshot-delete
DEPRECATED: Remove a snapshot.
volume-snapshot-list
DEPRECATED: List all the snapshots.
volume-snapshot-show
DEPRECATED: Show details about a snapshot.
volume-type-create
DEPRECATED: Create a new volume type.
volume-type-delete
DEPRECATED: Delete a specific volume type.
volume-type-list
DEPRECATED: Print a list of available 'volume types'.
volume-update
Update volume attachment.
x509-create-cert
Create x509 cert for a user in tenant.
x509-get-root-cert
Fetch the x509 root cert.
bash-completion
Prints all of the commands and options to stdout so that the nova.bash_completion script doesn't have to hard code them.
help
Display help about this program or one of its subcommands.
baremetal-interface-add
Add a network interface to a baremetal node.
baremetal-interface-list
List network interfaces associated with a baremetal node.
baremetal-interface-remove
Remove a network interface from a baremetal node.
baremetal-node-create
Create a baremetal node.
baremetal-node-delete
Remove a baremetal node and any associated interfaces.
baremetal-node-list
Print list of available baremetal nodes.
baremetal-node-show
Show information about a baremetal node.
cell-capacities
Get cell capacities for all cells or a given cell.
cell-show
Show details of a given cell.
force-delete
Force delete a server.
restore
Restore a soft-deleted server.
host-evacuate
Evacuate all instances from failed host.
host-evacuate-live
Live migrate all instances of the specified host to other available hosts.
host-servers-migrate
Migrate all instances of the specified host to other available hosts.
instance-action
Show an action.
instance-action-list
List actions on a server.
list-extensions
List all the os-api extensions that are available.
host-meta
Set or Delete metadata on all instances of a host.
migration-list
Print a list of migrations.
net
DEPRECATED, use tenant-network-show instead.
net-create
DEPRECATED, use tenant-network-create instead.
net-delete
DEPRECATED, use tenant-network-delete instead.
net-list
DEPRECATED, use tenant-network-list instead.
tenant-network-create
Create a tenant network.
tenant-network-delete
Delete a tenant network.
tenant-network-list
List tenant networks.
tenant-network-show
Show a tenant network.

6.2. nova optional arguments
Copy link

--version
show program's version number and exit
--debug
Print debugging output.
--os-cache
Use the auth token cache. Defaults to False if env[OS_CACHE] is not set.
--timings
Print call timing info.
--os-region-name <region-name>
Defaults to env[OS_REGION_NAME].
--service-type <service-type>
Defaults to compute for most actions.
--service-name <service-name>
Defaults to env[NOVA_SERVICE_NAME].
--volume-service-name <volume-service-name>
Defaults to env[NOVA_VOLUME_SERVICE_NAME].
--os-endpoint-type <endpoint-type>
Defaults to env[NOVA_ENDPOINT_TYPE], env[OS_ENDPOINT_TYPE] or publicURL.
--os-compute-api-version <compute-api-ver>
Accepts X, X.Y (where X is major and Y is minor part) or "X.latest", defaults to env[OS_COMPUTE_API_VERSION].
--bypass-url <bypass-url>
Use this API endpoint instead of the Service Catalog. Defaults to env[NOVACLIENT_BYPASS_URL].
--os-auth-type <name>, --os-auth-plugin <name>
Authentication type to use

6.3. nova add-fixed-ip
Copy link

usage: nova add-fixed-ip <server> <network-id>
Copy to Clipboard Toggle word wrap
Add new IP address on a network to server.

Positional arguments

<server>
Name or ID of server.
<network-id>
Network ID.

6.4. nova add-secgroup
Copy link

usage: nova add-secgroup <server> <secgroup>
Copy to Clipboard Toggle word wrap
Add a Security Group to a server.

Positional arguments

<server>
Name or ID of server.
<secgroup>
Name of Security Group.

6.5. nova agent-create
Copy link

usage: nova agent-create <os> <architecture> <version> <url> <md5hash> <hypervisor>
Copy to Clipboard Toggle word wrap
Create new agent build.

Positional arguments

<os>
Type of OS.
<architecture>
Type of architecture.
<version>
Version.
<url>
URL.
<md5hash>
MD5 hash.
<hypervisor>
Type of hypervisor.

6.6. nova agent-delete
Copy link

usage: nova agent-delete <id>
Copy to Clipboard Toggle word wrap
Delete existing agent build.

Positional arguments

<id>
ID of the agent-build.

6.7. nova agent-list
Copy link

usage: nova agent-list [--hypervisor <hypervisor>]
Copy to Clipboard Toggle word wrap
List all builds.

Optional arguments

--hypervisor <hypervisor>
Type of hypervisor.

6.8. nova agent-modify
Copy link

usage: nova agent-modify <id> <version> <url> <md5hash>
Copy to Clipboard Toggle word wrap
Modify existing agent build.

Positional arguments

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

6.9. nova aggregate-add-host
Copy link

usage: nova aggregate-add-host <aggregate> <host>
Copy to Clipboard Toggle word wrap
Add the host to the specified aggregate.

Positional arguments

<aggregate>
Name or ID of aggregate.
<host>
The host to add to the aggregate.

6.10. nova aggregate-create
Copy link

usage: nova aggregate-create <name> [<availability-zone>]
Copy to Clipboard Toggle word wrap
Create a new aggregate with the specified details.

Positional arguments

<name>
Name of aggregate.
<availability-zone>
The availability zone of the aggregate (optional).

6.11. nova aggregate-delete
Copy link

usage: nova aggregate-delete <aggregate>
Copy to Clipboard Toggle word wrap
Delete the aggregate.

Positional arguments

<aggregate>
Name or ID of aggregate to delete.

6.12. nova aggregate-details
Copy link

usage: nova aggregate-details <aggregate>
Copy to Clipboard Toggle word wrap
Show details of the specified aggregate.

Positional arguments

<aggregate>
Name or ID of aggregate.

6.13. nova aggregate-list
Copy link

usage: nova aggregate-list
Copy to Clipboard Toggle word wrap
Print a list of all aggregates.

6.14. nova aggregate-remove-host
Copy link

usage: nova aggregate-remove-host <aggregate> <host>
Copy to Clipboard Toggle word wrap
Remove the specified host from the specified aggregate.

Positional arguments

<aggregate>
Name or ID of aggregate.
<host>
The host to remove from the aggregate.

6.15. nova aggregate-set-metadata
Copy link

usage: nova aggregate-set-metadata <aggregate> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
Update the metadata associated with the aggregate.

Positional arguments

<aggregate>
Name or ID of aggregate to update.
<key=value>
Metadata to add/update to aggregate. Specify only the key to delete a metadata item.

6.16. nova aggregate-update
Copy link

usage: nova aggregate-update <aggregate> <name> [<availability-zone>]
Copy to Clipboard Toggle word wrap
Update the aggregate's name and optionally availability zone.

Positional arguments

<aggregate>
Name or ID of aggregate to update.
<name>
Name of aggregate.
<availability-zone>
The availability zone of the aggregate.

6.17. nova availability-zone-list
Copy link

usage: nova availability-zone-list
Copy to Clipboard Toggle word wrap
List all the availability zones.

6.18. nova backup
Copy link

usage: nova backup <server> <name> <backup-type> <rotation>
Copy to Clipboard Toggle word wrap
Backup a server by creating a 'backup' type snapshot.

Positional arguments

<server>
Name or ID of server.
<name>
Name of the backup image.
<backup-type>
The backup type, like "daily" or "weekly".
<rotation>
Int parameter representing how many backups to keep around.

6.19. nova baremetal-interface-add
Copy link

usage: nova baremetal-interface-add [--datapath_id <datapath_id>] [--port_no <port_no>] <node> <address>
Copy to Clipboard Toggle word wrap
Add a network interface to a baremetal node.

Positional arguments

<node>
ID of node
<address>
MAC address of interface

Optional arguments

--datapath_id <datapath_id>
OpenFlow Datapath ID of interface
--port_no <port_no>
OpenFlow port number of interface

6.20. nova baremetal-interface-list
Copy link

usage: nova baremetal-interface-list <node>
Copy to Clipboard Toggle word wrap
List network interfaces associated with a baremetal node.

Positional arguments

<node>
ID of node

6.21. nova baremetal-interface-remove
Copy link

usage: nova baremetal-interface-remove <node> <address>
Copy to Clipboard Toggle word wrap
Remove a network interface from a baremetal node.

Positional arguments

<node>
ID of node
<address>
MAC address of interface

6.22. nova baremetal-node-create
Copy link

usage: nova baremetal-node-create [--pm_address <pm_address>] [--pm_user <pm_user>] [--pm_password <pm_password>] [--terminal_port <terminal_port>] <service_host> <cpus> <memory_mb> <local_gb> <prov_mac_address>
Copy to Clipboard Toggle word wrap
Create a baremetal node.

Positional arguments

<service_host>
Name of nova compute host which will control this baremetal node
<cpus>
Number of CPUs in the node
<memory_mb>
Megabytes of RAM in the node
<local_gb>
Gigabytes of local storage in the node
<prov_mac_address>
MAC address to provision the node

Optional arguments

--pm_address <pm_address>
Power management IP for the node
--pm_user <pm_user>
Username for the node's power management
--pm_password <pm_password>
Password for the node's power management
--terminal_port <terminal_port>
ShellInABox port?

6.23. nova baremetal-node-delete
Copy link

usage: nova baremetal-node-delete <node>
Copy to Clipboard Toggle word wrap
Remove a baremetal node and any associated interfaces.

Positional arguments

<node>
ID of the node to delete.

6.24. nova baremetal-node-list
Copy link

usage: nova baremetal-node-list
Copy to Clipboard Toggle word wrap
Print list of available baremetal nodes.

6.25. nova baremetal-node-show
Copy link

usage: nova baremetal-node-show <node>
Copy to Clipboard Toggle word wrap
Show information about a baremetal node.

Positional arguments

<node>
ID of node

6.26. nova boot
Copy link

usage: nova boot [--flavor <flavor>] [--image <image>] [--image-with <key=value>] [--boot-volume <volume_id>] [--snapshot <snapshot_id>] [--min-count <number>] [--max-count <number>] [--meta <key=value>] [--file <dst-path=src-path>] [--key-name <key-name>] [--user-data <user-data>] [--availability-zone <availability-zone>] [--security-groups <security-groups>] [--block-device-mapping <dev-name=mapping>] [--block-device key1=value1[,key2=value2...]] [--swap <swap_size>] [--ephemeral size=<size>[,format=<format>]] [--hint <key=value>] [--nic <net-id=net-uuid,net-name=network-name,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid>] [--config-drive <value>] [--poll] [--admin-pass <value>] [--access-ip-v4 <value>] [--access-ip-v6 <value>] [--description <description>] <name>
Copy to Clipboard Toggle word wrap
Boot a new server.

Positional arguments

<name>
Name for the new server.

Optional arguments

--flavor <flavor>
Name or ID of flavor (see 'nova flavor-list').
--image <image>
Name or ID of image (see 'nova image-list').
--image-with <key=value>
Image metadata property (see 'nova image- show').
--boot-volume <volume_id>
Volume ID to boot from.
--snapshot <snapshot_id>
Snapshot ID to boot from (will create a volume).
--min-count <number>
Boot at least <number> servers (limited by quota).
--max-count <number>
Boot up to <number> servers (limited by quota).
--meta <key=value>
Record arbitrary key/value metadata to /meta_data.json on the metadata server. Can be specified multiple times.
--file <dst-path=src-path>
Store arbitrary files from <src-path> locally to <dst-path> on the new server. Limited by the injected_files quota value.
--key-name <key-name>
Key name of keypair that should be created earlier with the command keypair-add.
--user-data <user-data>
user data file to pass to be exposed by the metadata server.
--availability-zone <availability-zone>
The availability zone for server placement.
--security-groups <security-groups>
Comma separated list of security group names.
--block-device-mapping <dev-name=mapping>
Block device mapping in the format <dev- name>=<id>:<type>:<size(GB)>:<delete-on- terminate>.
--block-device
key1=value1[,key2=value2...] Block device mapping with the keys: id=UUID (image_id, snapshot_id or volume_id only if using source image, snapshot or volume) source=source type (image, snapshot, volume or blank), dest=destination type of the block device (volume or local), bus=device's bus (e.g. uml, lxc, virtio, ...; if omitted, hypervisor driver chooses a suitable default, honoured only if device type is supplied) type=device type (e.g. disk, cdrom, ...; defaults to 'disk') device=name of the device (e.g. vda, xda, ...; if omitted, hypervisor driver chooses suitable device depending on selected bus; note the libvirt driver always uses default device names), size=size of the block device in MB(for swap) and in GB(for other formats) (if omitted, hypervisor driver calculates size), format=device will be formatted (e.g. swap, ntfs, ...; optional), bootindex=integer used for ordering the boot disks (for image backed instances it is equal to 0, for others need to be specified) and shutdown=shutdown behaviour (either preserve or remove, for local destination set to remove).
--swap <swap_size>
Create and attach a local swap block device of <swap_size> MB.
--ephemeral
size=<size>[,format=<format>] Create and attach a local ephemeral block device of <size> GB and format it to <format>.
--hint <key=value>
Send arbitrary key/value pairs to the scheduler for custom use.
--nic <net-id=net-uuid,net-name=network-name,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. net- id: attach NIC to network with this UUID net- name: attach NIC to network with this name (either port-id or net-id or net-name must be provided), v4-fixed-ip: IPv4 fixed address for NIC (optional), v6-fixed-ip: IPv6 fixed address for NIC (optional), port-id: attach NIC to port with this UUID (either port-id or net-id must be provided).
--config-drive <value>
Enable config drive.
--poll
Report the new server boot progress until it completes.
--admin-pass <value>
Admin password for the instance.
--access-ip-v4 <value>
Alternative access IPv4 of the instance.
--access-ip-v6 <value>
Alternative access IPv6 of the instance.
--description <description>
Description for the server. (Supported by API versions '2.19' - '2.latest')

6.27. nova cell-capacities
Copy link

usage: nova cell-capacities [--cell <cell-name>]
Copy to Clipboard Toggle word wrap
Get cell capacities for all cells or a given cell.

Optional arguments

--cell <cell-name>
Name of the cell to get the capacities.

6.28. nova cell-show
Copy link

usage: nova cell-show <cell-name>
Copy to Clipboard Toggle word wrap
Show details of a given cell.

Positional arguments

<cell-name>
Name of the cell.

6.29. nova clear-password
Copy link

usage: nova clear-password <server>
Copy to Clipboard Toggle word wrap
Clear the admin password for a server.

Positional arguments

<server>
Name or ID of server.

6.30. nova cloudpipe-configure
Copy link

usage: nova cloudpipe-configure <ip address> <port>
Copy to Clipboard Toggle word wrap
Update the VPN IP/port of a cloudpipe instance.

Positional arguments

<ip address>
New IP Address.
<port>
New Port.

6.31. nova cloudpipe-create
Copy link

usage: nova cloudpipe-create <project_id>
Copy to Clipboard Toggle word wrap
Create a cloudpipe instance for the given project.

Positional arguments

<project_id>
UUID of the project to create the cloudpipe for.

6.32. nova cloudpipe-list
Copy link

usage: nova cloudpipe-list
Copy to Clipboard Toggle word wrap
Print a list of all cloudpipe instances.

6.33. nova console-log
Copy link

usage: nova console-log [--length <length>] <server>
Copy to Clipboard Toggle word wrap
Get console log output of a server.

Positional arguments

<server>
Name or ID of server.

Optional arguments

--length <length>
Length in lines to tail.

6.34. nova credentials
Copy link

usage: nova credentials [--wrap <integer>]
Copy to Clipboard Toggle word wrap
Show user credentials returned from auth.

Optional arguments

--wrap <integer>
Wrap PKI tokens to a specified length, or 0 to disable.

6.35. nova delete
Copy link

usage: nova delete [--all-tenants] <server> [<server> ...]
Copy to Clipboard Toggle word wrap
Immediately shut down and delete specified server(s).

Positional arguments

<server>
Name or ID of server(s).

Optional arguments

--all-tenants
Delete server(s) in another tenant by name (Admin only).

6.36. nova diagnostics
Copy link

usage: nova diagnostics <server>
Copy to Clipboard Toggle word wrap
Retrieve server diagnostics.

Positional arguments

<server>
Name or ID of server.

6.37. nova dns-create
Copy link

usage: nova dns-create [--type <type>] <ip> <name> <domain>
Copy to Clipboard Toggle word wrap
Create a DNS entry for domain, name, and IP.

Positional arguments

<ip>
IP address.
<name>
DNS name.
<domain>
DNS domain.

Optional arguments

--type <type>
DNS type (e.g. "A")

6.38. nova dns-create-private-domain
Copy link

usage: nova dns-create-private-domain [--availability-zone <availability-zone>] <domain>
Copy to Clipboard Toggle word wrap
Create the specified DNS domain.

Positional arguments

<domain>
DNS domain.

Optional arguments

--availability-zone <availability-zone>
Limit access to this domain to servers in the specified availability zone.

6.39. nova dns-create-public-domain
Copy link

usage: nova dns-create-public-domain [--project <project>] <domain>
Copy to Clipboard Toggle word wrap
Create the specified DNS domain.

Positional arguments

<domain>
DNS domain.

Optional arguments

--project <project>
Limit access to this domain to users of the specified project.

6.40. nova dns-delete
Copy link

usage: nova dns-delete <domain> <name>
Copy to Clipboard Toggle word wrap
Delete the specified DNS entry.

Positional arguments

<domain>
DNS domain.
<name>
DNS name.

6.41. nova dns-delete-domain
Copy link

usage: nova dns-delete-domain <domain>
Copy to Clipboard Toggle word wrap
Delete the specified DNS domain.

Positional arguments

<domain>
DNS domain.

6.42. nova dns-domains
Copy link

usage: nova dns-domains
Copy to Clipboard Toggle word wrap
Print a list of available dns domains.

6.43. nova dns-list
Copy link

usage: nova dns-list [--ip <ip>] [--name <name>] <domain>
Copy to Clipboard Toggle word wrap
List current DNS entries for domain and IP or domain and name.

Positional arguments

<domain>
DNS domain.

Optional arguments

--ip <ip>
IP address.
--name <name>
DNS name.

6.44. nova endpoints
Copy link

usage: nova endpoints
Copy to Clipboard Toggle word wrap
Discover endpoints that get returned from the authenticate services.

6.45. nova evacuate
Copy link

usage: nova evacuate [--password <password>] <server> [<host>]
Copy to Clipboard Toggle word wrap
Evacuate server from failed host.

Positional arguments

<server>
Name or ID of server.
<host>
Name or ID of the target host. If no host is specified, the scheduler will choose one.

Optional arguments

--password <password>
Set the provided admin password on the evacuated server. Not applicable if the server is on shared storage.

6.46. nova fixed-ip-get
Copy link

usage: nova fixed-ip-get <fixed_ip>
Copy to Clipboard Toggle word wrap
Retrieve info on a fixed IP.

Positional arguments

<fixed_ip>
Fixed IP Address.

6.47. nova fixed-ip-reserve
Copy link

usage: nova fixed-ip-reserve <fixed_ip>
Copy to Clipboard Toggle word wrap
Reserve a fixed IP.

Positional arguments

<fixed_ip>
Fixed IP Address.

6.48. nova fixed-ip-unreserve
Copy link

usage: nova fixed-ip-unreserve <fixed_ip>
Copy to Clipboard Toggle word wrap
Unreserve a fixed IP.

Positional arguments

<fixed_ip>
Fixed IP Address.

6.49. nova flavor-access-add
Copy link

usage: nova flavor-access-add <flavor> <tenant_id>
Copy to Clipboard Toggle word wrap
Add flavor access for the given tenant.

Positional arguments

<flavor>
Flavor name or ID to add access for the given tenant.
<tenant_id>
Tenant ID to add flavor access for.

6.50. nova flavor-access-list
Copy link

usage: nova flavor-access-list [--flavor <flavor>] [--tenant <tenant_id>]
Copy to Clipboard Toggle word wrap
Print access information about the given flavor.

Optional arguments

--flavor <flavor>
Filter results by flavor name or ID.
--tenant <tenant_id>
Filter results by tenant ID.

6.51. nova flavor-access-remove
Copy link

usage: nova flavor-access-remove <flavor> <tenant_id>
Copy to Clipboard Toggle word wrap
Remove flavor access for the given tenant.

Positional arguments

<flavor>
Flavor name or ID to remove access for the given tenant.
<tenant_id>
Tenant ID to remove flavor access for.

6.52. nova flavor-create
Copy link

usage: nova flavor-create [--ephemeral <ephemeral>] [--swap <swap>] [--rxtx-factor <factor>] [--is-public <is-public>] <name> <id> <ram> <disk> <vcpus>
Copy to Clipboard Toggle word wrap
Create a new flavor.

Positional arguments

<name>
Unique name of the new flavor.
<id>
Unique ID of the new flavor. Specifying 'auto' will generated a UUID for the ID.
<ram>
Memory size in MB.
<disk>
Disk size in GB.
<vcpus>
Number of vcpus

Optional arguments

--ephemeral <ephemeral>
Ephemeral space size in GB (default 0).
--swap <swap>
Swap space size in MB (default 0).
--rxtx-factor <factor>
RX/TX factor (default 1).
--is-public <is-public>
Make flavor accessible to the public (default true).

6.53. nova flavor-delete
Copy link

usage: nova flavor-delete <flavor>
Copy to Clipboard Toggle word wrap
Delete a specific flavor

Positional arguments

<flavor>
Name or ID of the flavor to delete.

6.54. nova flavor-key
Copy link

usage: nova flavor-key <flavor> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
Set or unset extra_spec for a flavor.

Positional arguments

<flavor>
Name or ID of flavor.
<action>
Actions: 'set' or 'unset'.
<key=value>
Extra_specs to set/unset (only key is necessary on unset).

6.55. nova flavor-list
Copy link

usage: nova flavor-list [--extra-specs] [--all] [--marker <marker>] [--limit <limit>]
Copy to Clipboard Toggle word wrap
Print a list of available 'flavors' (sizes of servers).

Optional arguments

--extra-specs
Get extra-specs of each flavor.
--all
Display all flavors (Admin only).
--marker <marker>
The last flavor ID of the previous page; displays list of flavors after "marker".
--limit <limit>
Maximum number of flavors to display. If limit == -1, all flavors will be displayed. If limit is bigger than 'osapi_max_limit' option of Nova API, limit 'osapi_max_limit' will be used instead.

6.56. nova flavor-show
Copy link

usage: nova flavor-show <flavor>
Copy to Clipboard Toggle word wrap
Show details about the given flavor.

Positional arguments

<flavor>
Name or ID of flavor.

6.57. nova floating-ip-associate
Copy link

usage: nova floating-ip-associate [--fixed-address <fixed_address>] <server> <address>
Copy to Clipboard Toggle word wrap
Associate a floating IP address to a server.

Positional arguments

<server>
Name or ID of server.
<address>
IP Address.

Optional arguments

--fixed-address <fixed_address>
Fixed IP Address to associate with.

6.58. nova floating-ip-bulk-create
Copy link

usage: nova floating-ip-bulk-create [--pool <pool>] [--interface <interface>] <range>
Copy to Clipboard Toggle word wrap
Bulk create floating IPs by range (nova-network only).

Positional arguments

<range>
Address range to create.

Optional arguments

--pool <pool>
Pool for new Floating IPs.
--interface <interface>
Interface for new Floating IPs.

6.59. nova floating-ip-bulk-delete
Copy link

usage: nova floating-ip-bulk-delete <range>
Copy to Clipboard Toggle word wrap
Bulk delete floating IPs by range (nova-network only).

Positional arguments

<range>
Address range to delete.

6.60. nova floating-ip-bulk-list
Copy link

usage: nova floating-ip-bulk-list [--host <host>]
Copy to Clipboard Toggle word wrap
List all floating IPs (nova-network only).

Optional arguments

--host <host>
Filter by host.

6.61. nova floating-ip-create
Copy link

usage: nova floating-ip-create [<floating-ip-pool>]
Copy to Clipboard Toggle word wrap
Allocate a floating IP for the current tenant.

Positional arguments

<floating-ip-pool>
Name of Floating IP Pool. (Optional)

6.62. nova floating-ip-delete
Copy link

usage: nova floating-ip-delete <address>
Copy to Clipboard Toggle word wrap
De-allocate a floating IP.

Positional arguments

<address>
IP of Floating IP.

6.63. nova floating-ip-disassociate
Copy link

usage: nova floating-ip-disassociate <server> <address>
Copy to Clipboard Toggle word wrap
Disassociate a floating IP address from a server.

Positional arguments

<server>
Name or ID of server.
<address>
IP Address.

6.64. nova floating-ip-list
Copy link

usage: nova floating-ip-list
Copy to Clipboard Toggle word wrap
List floating IPs.

6.65. nova floating-ip-pool-list
Copy link

usage: nova floating-ip-pool-list
Copy to Clipboard Toggle word wrap
List all floating IP pools.

6.66. nova force-delete
Copy link

usage: nova force-delete <server>
Copy to Clipboard Toggle word wrap
Force delete a server.

Positional arguments

<server>
Name or ID of server.

6.67. nova get-mks-console
Copy link

usage: nova get-mks-console <server>
Copy to Clipboard Toggle word wrap
Get a serial console to a server. (Supported by API versions '2.8' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]

Positional arguments

<server>
Name or ID of server.

6.68. nova get-password
Copy link

usage: nova get-password <server> [<private-key>]
Copy to Clipboard Toggle word wrap
Get the admin password for a server.

Positional arguments

<server>
Name or ID of server.
<private-key>
Private key (used locally to decrypt password) (Optional). When specified, the command displays the clear (decrypted) VM password. When not specified, the ciphered VM password is displayed.

6.69. nova get-rdp-console
Copy link

usage: nova get-rdp-console <server> <console-type>
Copy to Clipboard Toggle word wrap
Get a rdp console to a server.

Positional arguments

<server>
Name or ID of server.
<console-type>
Type of rdp console ("rdp-html5").

6.70. nova get-serial-console
Copy link

usage: nova get-serial-console [--console-type CONSOLE_TYPE] <server>
Copy to Clipboard Toggle word wrap
Get a serial console to a server.

Positional arguments

<server>
Name or ID of server.

Optional arguments

--console-type CONSOLE_TYPE
Type of serial console, default="serial".

6.71. nova get-spice-console
Copy link

usage: nova get-spice-console <server> <console-type>
Copy to Clipboard Toggle word wrap
Get a spice console to a server.

Positional arguments

<server>
Name or ID of server.
<console-type>
Type of spice console ("spice-html5").

6.72. nova get-vnc-console
Copy link

usage: nova get-vnc-console <server> <console-type>
Copy to Clipboard Toggle word wrap
Get a vnc console to a server.

Positional arguments

<server>
Name or ID of server.
<console-type>
Type of vnc console ("novnc" or "xvpvnc").

6.73. nova host-action
Copy link

usage: nova host-action [--action <action>] <hostname>
Copy to Clipboard Toggle word wrap
Perform a power action on a host.

Positional arguments

<hostname>
Name of host.

Optional arguments

--action <action>
A power action: startup, reboot, or shutdown.

6.74. nova host-describe
Copy link

usage: nova host-describe <hostname>
Copy to Clipboard Toggle word wrap
Describe a specific host.

Positional arguments

<hostname>
Name of host.

6.75. nova host-evacuate
Copy link

usage: nova host-evacuate [--target_host <target_host>] [--on-shared-storage] <host>
Copy to Clipboard Toggle word wrap
Evacuate all instances from failed host.

Positional arguments

<host>
Name of host.

Optional arguments

--target_host <target_host>
Name of target host. If no host is specified the scheduler will select a target.
--on-shared-storage
Specifies whether all instances files are on shared storage

6.76. nova host-evacuate-live
Copy link

usage: nova host-evacuate-live [--target-host <target_host>] [--block-migrate] [--disk-over-commit] [--max-servers <max_servers>] <host>
Copy to Clipboard Toggle word wrap
Live migrate all instances of the specified host to other available hosts.

Positional arguments

<host>
Name of host.

Optional arguments

--target-host <target_host>
Name of target host.
--block-migrate
Enable block migration.
--disk-over-commit
Enable disk overcommit.
--max-servers <max_servers>
Maximum number of servers to live migrate simultaneously

6.77. nova host-list
Copy link

usage: nova host-list [--zone <zone>]
Copy to Clipboard Toggle word wrap
List all hosts by service.

Optional arguments

--zone <zone>
Filters the list, returning only those hosts in the availability zone <zone>.

6.78. nova host-meta
Copy link

usage: nova host-meta <host> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
Set or Delete metadata on all instances of a host.

Positional arguments

<host>
Name of host.
<action>
Actions: 'set' or 'delete'
<key=value>
Metadata to set or delete (only key is necessary on delete)

6.79. nova host-servers-migrate
Copy link

usage: nova host-servers-migrate <host>
Copy to Clipboard Toggle word wrap
Migrate all instances of the specified host to other available hosts.

Positional arguments

<host>
Name of host.

6.80. nova host-update
Copy link

usage: nova host-update [--status <enable|disable>] [--maintenance <enable|disable>] <hostname>
Copy to Clipboard Toggle word wrap
Update host settings.

Positional arguments

<hostname>
Name of host.

Optional arguments

--status <enable|disable>
Either enable or disable a host.
--maintenance <enable|disable>
Either put or resume host to/from maintenance.

6.81. nova hypervisor-list
Copy link

usage: nova hypervisor-list [--matching <hostname>]
Copy to Clipboard Toggle word wrap
List hypervisors.

Optional arguments

--matching <hostname>
List hypervisors matching the given <hostname>.

6.82. nova hypervisor-servers
Copy link

usage: nova hypervisor-servers <hostname>
Copy to Clipboard Toggle word wrap
List servers belonging to specific hypervisors.

Positional arguments

<hostname>
The hypervisor hostname (or pattern) to search for.

6.83. nova hypervisor-show
Copy link

usage: nova hypervisor-show [--wrap <integer>] <hypervisor>
Copy to Clipboard Toggle word wrap
Display the details of the specified hypervisor.

Positional arguments

<hypervisor>
Name or ID of the hypervisor to show the details of.

Optional arguments

--wrap <integer>
Wrap the output to a specified length. Default is 40 or 0 to disable

6.84. nova hypervisor-stats
Copy link

usage: nova hypervisor-stats
Copy to Clipboard Toggle word wrap
Get hypervisor statistics over all compute nodes.
Warning
When using Red Hat Ceph as a back end for ephemeral storage, the Compute service does not calculate the amount of available storage correctly. Specifically, Compute simply adds up the amount of available storage without factoring in replication. This results in grossly overstated available storage, which in turn could cause unexpected storage oversubscription.
To determine the correct ephemeral storage capacity, query the Ceph service directly instead. For more information, see BZ#1236473.

6.85. nova hypervisor-uptime
Copy link

usage: nova hypervisor-uptime <hypervisor>
Copy to Clipboard Toggle word wrap
Display the uptime of the specified hypervisor.

Positional arguments

<hypervisor>
Name or ID of the hypervisor to show the uptime of.

6.86. nova image-create
Copy link

usage: nova image-create [--metadata <key=value>] [--show] [--poll] <server> <name>
Copy to Clipboard Toggle word wrap
Create a new image by taking a snapshot of a running server.

Positional arguments

<server>
Name or ID of server.
<name>
Name of snapshot.

Optional arguments

--metadata <key=value>
Record arbitrary key/value metadata to /meta_data.json on the metadata server. Can be specified multiple times.
--show
Print image info.
--poll
Report the snapshot progress and poll until image creation is complete.

6.87. nova image-delete
Copy link

usage: nova image-delete <image> [<image> ...]
Copy to Clipboard Toggle word wrap
Delete specified image(s).

Positional arguments

<image>
Name or ID of image(s).

6.88. nova image-list
Copy link

usage: nova image-list [--limit <limit>]
Copy to Clipboard Toggle word wrap
Print a list of available images to boot from.

Optional arguments

--limit <limit>
Number of images to return per request.

6.89. nova image-meta
Copy link

usage: nova image-meta <image> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
Set or delete metadata on an image.

Positional arguments

<image>
Name or ID of image.
<action>
Actions: 'set' or 'delete'.
<key=value>
Metadata to add/update or delete (only key is necessary on delete).

6.90. nova image-show
Copy link

usage: nova image-show <image>
Copy to Clipboard Toggle word wrap
Show details about the given image.

Positional arguments

<image>
Name or ID of image.

6.91. nova instance-action
Copy link

usage: nova instance-action <server> <request_id>
Copy to Clipboard Toggle word wrap
Show an action.

Positional arguments

<server>
Name or UUID of the server to show actions for. Only UUID can be used to show actions for a deleted server. (Supported by API versions '2.21' - '2.latest')
<request_id>
Request ID of the action to get.

6.92. nova instance-action-list
Copy link

usage: nova instance-action-list <server>
Copy to Clipboard Toggle word wrap
List actions on a server.

Positional arguments

<server>
Name or UUID of the server to list actions for. Only UUID can be used to list actions on a deleted server. (Supported by API versions '2.21' - '2.latest')

6.93. nova interface-attach
Copy link

usage: nova interface-attach [--port-id <port_id>] [--net-id <net_id>] [--fixed-ip <fixed_ip>] <server>
Copy to Clipboard Toggle word wrap
Attach a network interface to a server.

Positional arguments

<server>
Name or ID of server.

Optional arguments

--port-id <port_id>
Port ID.
--net-id <net_id>
Network ID
--fixed-ip <fixed_ip>
Requested fixed IP.

6.94. nova interface-detach
Copy link

usage: nova interface-detach <server> <port_id>
Copy to Clipboard Toggle word wrap
Detach a network interface from a server.

Positional arguments

<server>
Name or ID of server.
<port_id>
Port ID.

6.95. nova interface-list
Copy link

usage: nova interface-list <server>
Copy to Clipboard Toggle word wrap
List interfaces attached to a server.

Positional arguments

<server>
Name or ID of server.

6.96. nova keypair-add
Copy link

usage: nova keypair-add [--pub-key <pub-key>] [--key-type <key-type>] [--user <user-id>] <name>
Copy to Clipboard Toggle word wrap
Create a new key pair for use with servers.

Positional arguments

<name>
Name of key.

Optional arguments

--pub-key <pub-key>
Path to a public ssh key.
--key-type <key-type>
Keypair type. Can be ssh or x509. (Supported by API versions '2.2' - '2.latest')
--user <user-id>
ID of user to whom to add key-pair (Admin only). (Supported by API versions '2.10' - '2.latest')

6.97. nova keypair-delete
Copy link

usage: nova keypair-delete [--user <user-id>] <name>
Copy to Clipboard Toggle word wrap
Delete keypair given by its name. (Supported by API versions '2.0' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]

Positional arguments

<name>
Keypair name to delete.

Optional arguments

--user <user-id>
ID of key-pair owner (Admin only).

6.98. nova keypair-list
Copy link

usage: nova keypair-list [--user <user-id>]
Copy to Clipboard Toggle word wrap
Print a list of keypairs for a user (Supported by API versions '2.0' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]

Optional arguments

--user <user-id>
List key-pairs of specified user ID (Admin only).

6.99. nova keypair-show
Copy link

usage: nova keypair-show [--user <user-id>] <keypair>
Copy to Clipboard Toggle word wrap
Show details about the given keypair. (Supported by API versions '2.0' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]

Positional arguments

<keypair>
Name of keypair.

Optional arguments

--user <user-id>
ID of key-pair owner (Admin only).

6.100. nova limits
Copy link

usage: nova limits [--tenant [<tenant>]] [--reserved]
Copy to Clipboard Toggle word wrap
Print rate and absolute limits.

Optional arguments

--tenant [<tenant>]
Display information from single tenant (Admin only).
--reserved
Include reservations count.

6.101. nova list
Copy link

usage: nova list [--reservation-id <reservation-id>] [--ip <ip-regexp>] [--ip6 <ip6-regexp>] [--name <name-regexp>] [--instance-name <name-regexp>] [--status <status>] [--flavor <flavor>] [--image <image>] [--host <hostname>] [--all-tenants [<0|1>]] [--tenant [<tenant>]] [--user [<user>]] [--deleted] [--fields <fields>] [--minimal] [--sort <key>[:<direction>]] [--marker <marker>] [--limit <limit>]
Copy to Clipboard Toggle word wrap
List active servers.

Optional arguments

--reservation-id <reservation-id>
Only return servers that match reservation-id.
--ip <ip-regexp>
Search with regular expression match by IP address.
--ip6 <ip6-regexp>
Search with regular expression match by IPv6 address.
--name <name-regexp>
Search with regular expression match by name.
--instance-name <name-regexp>
Search with regular expression match by server name.
--status <status>
Search by server status.
--flavor <flavor>
Search by flavor name or ID.
--image <image>
Search by image name or ID.
--host <hostname>
Search servers by hostname to which they are assigned (Admin only).
--all-tenants [<0|1>]
Display information from all tenants (Admin only).
--tenant [<tenant>]
Display information from single tenant (Admin only).
--user [<user>]
Display information from single user (Admin only).
--deleted
Only display deleted servers (Admin only).
--fields <fields>
Comma-separated list of fields to display. Use the show command to see which fields are available.
--minimal
Get only UUID and name.
--sort <key>[:<direction>]
Comma-separated list of sort keys and directions in the form of <key>[:<asc|desc>]. The direction defaults to descending if not specified.
--marker <marker>
The last server UUID of the previous page; displays list of servers after "marker".
--limit <limit>
Maximum number of servers to display. If limit == -1, all servers will be displayed. If limit is bigger than 'osapi_max_limit' option of Nova API, limit 'osapi_max_limit' will be used instead.

6.102. nova list-extensions
Copy link

usage: nova list-extensions
Copy to Clipboard Toggle word wrap
List all the os-api extensions that are available.

6.103. nova list-secgroup
Copy link

usage: nova list-secgroup <server>
Copy to Clipboard Toggle word wrap
List Security Group(s) of a server.

Positional arguments

<server>
Name or ID of server.

6.104. nova live-migration
Copy link

usage: nova live-migration [--block-migrate] <server> [<host>]
Copy to Clipboard Toggle word wrap
Migrate running server to a new machine.

Positional arguments

<server>
Name or ID of server.
<host>
Destination host name.

Optional arguments

--block-migrate
True in case of block_migration. (Default=auto:live_migration) (Supported by API versions '2.25' - '2.latest')

6.105. nova live-migration-abort
Copy link

usage: nova live-migration-abort <server> <migration>
Copy to Clipboard Toggle word wrap
Abort an on-going live migration. (Supported by API versions '2.24' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]

Positional arguments

<server>
Name or ID of server.
<migration>
ID of migration.

6.106. nova live-migration-force-complete
Copy link

usage: nova live-migration-force-complete <server> <migration>
Copy to Clipboard Toggle word wrap
Force on-going live migration to complete. (Supported by API versions '2.22' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]

Positional arguments

<server>
Name or ID of server.
<migration>
ID of migration.

6.107. nova lock
Copy link

usage: nova lock <server>
Copy to Clipboard Toggle word wrap
Lock a server. A normal (non-admin) user will not be able to execute actions on a locked server.

Positional arguments

<server>
Name or ID of server.

6.108. nova meta
Copy link

usage: nova meta <server> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
Set or delete metadata on a server.

Positional arguments

<server>
Name or ID of server.
<action>
Actions: 'set' or 'delete'.
<key=value>
Metadata to set or delete (only key is necessary on delete).

6.109. nova migrate
Copy link

usage: nova migrate [--poll] <server>
Copy to Clipboard Toggle word wrap
Migrate a server. The new host will be selected by the scheduler.

Positional arguments

<server>
Name or ID of server.

Optional arguments

--poll
Report the server migration progress until it completes.

6.110. nova migration-list
Copy link

usage: nova migration-list [--host <host>] [--status <status>] [--cell_name <cell_name>]
Copy to Clipboard Toggle word wrap
Print a list of migrations.

Optional arguments

--host <host>
Fetch migrations for the given host.
--status <status>
Fetch migrations for the given status.
--cell_name <cell_name>
Fetch migrations for the given cell_name.

6.111. nova network-associate-host
Copy link

usage: nova network-associate-host <network> <host>
Copy to Clipboard Toggle word wrap
Associate host with network.

Positional arguments

<network>
UUID of network.
<host>
Name of host

6.112. nova network-associate-project
Copy link

usage: nova network-associate-project <network>
Copy to Clipboard Toggle word wrap
Associate project with network.

Positional arguments

<network>
UUID of network.

6.113. nova network-create
Copy link

usage: nova network-create [--fixed-range-v4 <x.x.x.x/yy>] [--fixed-range-v6 CIDR_V6] [--vlan <vlan id>] [--vlan-start <vlan start>] [--vpn <vpn start>] [--gateway GATEWAY] [--gateway-v6 GATEWAY_V6] [--bridge <bridge>] [--bridge-interface <bridge interface>] [--multi-host <'T'|'F'>] [--dns1 <DNS Address>] [--dns2 <DNS Address>] [--uuid <network uuid>] [--fixed-cidr <x.x.x.x/yy>] [--project-id <project id>] [--priority <number>] [--mtu MTU] [--enable-dhcp <'T'|'F'>] [--dhcp-server DHCP_SERVER] [--share-address <'T'|'F'>] [--allowed-start ALLOWED_START] [--allowed-end ALLOWED_END] <network_label>
Copy to Clipboard Toggle word wrap
Create a network.

Positional arguments

<network_label>
Label for network

Optional arguments

--fixed-range-v4 <x.x.x.x/yy>
IPv4 subnet (ex: 10.0.0.0/8)
--fixed-range-v6
CIDR_V6 IPv6 subnet (ex: fe80::/64
--vlan <vlan id>
The vlan ID to be assigned to the project.
--vlan-start <vlan start>
First vlan ID to be assigned to the project. Subsequent vlan IDs will be assigned incrementally.
--vpn <vpn start>
vpn start
--gateway GATEWAY
gateway
--gateway-v6
GATEWAY_V6 IPv6 gateway
--bridge <bridge>
VIFs on this network are connected to this bridge.
--bridge-interface <bridge interface>
The bridge is connected to this interface.
--multi-host <'T'|'F'>
Multi host
--dns1 <DNS Address>
First DNS.
--dns2 <DNS Address>
Second DNS.
--uuid <network uuid>
Network UUID.
--fixed-cidr <x.x.x.x/yy>
IPv4 subnet for fixed IPs (ex: 10.20.0.0/16).
--project-id <project id>
Project ID.
--priority <number>
Network interface priority.
--mtu MTU
MTU for network.
--enable-dhcp <'T'|'F'>
Enable DHCP.
--dhcp-server DHCP_SERVER
DHCP-server address (defaults to gateway address)
--share-address <'T'|'F'>
Share address
--allowed-start ALLOWED_START
Start of allowed addresses for instances.
--allowed-end ALLOWED_END
End of allowed addresses for instances.

6.114. nova network-delete
Copy link

usage: nova network-delete <network>
Copy to Clipboard Toggle word wrap
Delete network by label or id.

Positional arguments

<network>
UUID or label of network.

6.115. nova network-disassociate
Copy link

usage: nova network-disassociate [--host-only [<0|1>]] [--project-only [<0|1>]] <network>
Copy to Clipboard Toggle word wrap
Disassociate host and/or project from the given network.

Positional arguments

<network>
UUID of network.

Optional arguments

--host-only [<0|1>]
--project-only [<0|1>]

6.116. nova network-list
Copy link

usage: nova network-list [--fields <fields>]
Copy to Clipboard Toggle word wrap
Print a list of available networks.

Optional arguments

--fields <fields>
Comma-separated list of fields to display. Use the show command to see which fields are available.

6.117. nova network-show
Copy link

usage: nova network-show <network>
Copy to Clipboard Toggle word wrap
Show details about the given network.

Positional arguments

<network>
UUID or label of network.

6.118. nova pause
Copy link

usage: nova pause <server>
Copy to Clipboard Toggle word wrap
Pause a server.

Positional arguments

<server>
Name or ID of server.

6.119. nova quota-class-show
Copy link

usage: nova quota-class-show <class>
Copy to Clipboard Toggle word wrap
List the quotas for a quota class.

Positional arguments

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

6.120. nova quota-class-update
Copy link

usage: nova quota-class-update [--instances <instances>] [--cores <cores>] [--ram <ram>] [--floating-ips <floating-ips>] [--fixed-ips <fixed-ips>] [--metadata-items <metadata-items>] [--injected-files <injected-files>] [--injected-file-content-bytes <injected-file-content-bytes>] [--injected-file-path-bytes <injected-file-path-bytes>] [--key-pairs <key-pairs>] [--security-groups <security-groups>] [--security-group-rules <security-group-rules>] [--server-groups <server-groups>] [--server-group-members <server-group-members>] <class>
Copy to Clipboard Toggle word wrap
Update the quotas for a quota class.

Positional arguments

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

Optional arguments

--instances <instances>
New value for the "instances" quota.
--cores <cores>
New value for the "cores" quota.
--ram <ram>
New value for the "ram" quota.
--floating-ips <floating-ips>
New value for the "floating-ips" quota.
--fixed-ips <fixed-ips>
New value for the "fixed-ips" quota.
--metadata-items <metadata-items>
New value for the "metadata-items" quota.
--injected-files <injected-files>
New value for the "injected-files" quota.
--injected-file-content-bytes <injected-file-content-bytes>
New value for the "injected-file-content- bytes" quota.
--injected-file-path-bytes <injected-file-path-bytes>
New value for the "injected-file-path-bytes" quota.
--key-pairs <key-pairs>
New value for the "key-pairs" quota.
--security-groups <security-groups>
New value for the "security-groups" quota.
--security-group-rules <security-group-rules>
New value for the "security-group-rules" quota.
--server-groups <server-groups>
New value for the "server-groups" quota.
--server-group-members <server-group-members>
New value for the "server-group-members" quota.

6.121. nova quota-defaults
Copy link

usage: nova quota-defaults [--tenant <tenant-id>]
Copy to Clipboard Toggle word wrap
List the default quotas for a tenant.

Optional arguments

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

6.122. nova quota-delete
Copy link

usage: nova quota-delete --tenant <tenant-id> [--user <user-id>]
Copy to Clipboard Toggle word wrap
Delete quota for a tenant/user so their quota will Revert back to default.

Optional arguments

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

6.123. nova quota-show
Copy link

usage: nova quota-show [--tenant <tenant-id>] [--user <user-id>]
Copy to Clipboard Toggle word wrap
List the quotas for a tenant/user.

Optional arguments

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

6.124. nova quota-update
Copy link

usage: nova quota-update [--user <user-id>] [--instances <instances>] [--cores <cores>] [--ram <ram>] [--floating-ips <floating-ips>] [--fixed-ips <fixed-ips>] [--metadata-items <metadata-items>] [--injected-files <injected-files>] [--injected-file-content-bytes <injected-file-content-bytes>] [--injected-file-path-bytes <injected-file-path-bytes>] [--key-pairs <key-pairs>] [--security-groups <security-groups>] [--security-group-rules <security-group-rules>] [--server-groups <server-groups>] [--server-group-members <server-group-members>] [--force] <tenant-id>
Copy to Clipboard Toggle word wrap
Update the quotas for a tenant/user.

Positional arguments

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

Optional arguments

--user <user-id>
ID of user to set the quotas for.
--instances <instances>
New value for the "instances" quota.
--cores <cores>
New value for the "cores" quota.
--ram <ram>
New value for the "ram" quota.
--floating-ips <floating-ips>
New value for the "floating-ips" quota.
--fixed-ips <fixed-ips>
New value for the "fixed-ips" quota.
--metadata-items <metadata-items>
New value for the "metadata-items" quota.
--injected-files <injected-files>
New value for the "injected-files" quota.
--injected-file-content-bytes <injected-file-content-bytes>
New value for the "injected-file-content- bytes" quota.
--injected-file-path-bytes <injected-file-path-bytes>
New value for the "injected-file-path-bytes" quota.
--key-pairs <key-pairs>
New value for the "key-pairs" quota.
--security-groups <security-groups>
New value for the "security-groups" quota.
--security-group-rules <security-group-rules>
New value for the "security-group-rules" quota.
--server-groups <server-groups>
New value for the "server-groups" quota.
--server-group-members <server-group-members>
New value for the "server-group-members" quota.
--force
Whether force update the quota even if the already used and reserved exceeds the new quota.

6.125. nova reboot
Copy link

usage: nova reboot [--hard] [--poll] <server> [<server> ...]
Copy to Clipboard Toggle word wrap
Reboot a server.

Positional arguments

<server>
Name or ID of server(s).

Optional arguments

--hard
Perform a hard reboot (instead of a soft one).
--poll
Poll until reboot is complete.

6.126. nova rebuild
Copy link

usage: nova rebuild [--rebuild-password <rebuild-password>] [--poll] [--minimal] [--preserve-ephemeral] [--name <name>] [--description <description>] [--meta <key=value>] [--file <dst-path=src-path>] <server> <image>
Copy to Clipboard Toggle word wrap
Shutdown, re-image, and re-boot a server.

Positional arguments

<server>
Name or ID of server.
<image>
Name or ID of new image.

Optional arguments

--rebuild-password <rebuild-password>
Set the provided admin password on the rebuilt server.
--poll
Report the server rebuild progress until it completes.
--minimal
Skips flavor/image lookups when showing servers.
--preserve-ephemeral
Preserve the default ephemeral storage partition on rebuild.
--name <name>
Name for the new server.
--description <description>
New description for the server. (Supported by API versions '2.19' - '2.latest')
--meta <key=value>
Record arbitrary key/value metadata to /meta_data.json on the metadata server. Can be specified multiple times.
--file <dst-path=src-path>
Store arbitrary files from <src-path> locally to <dst-path> on the new server. You may store up to 5 files.

6.127. nova refresh-network
Copy link

usage: nova refresh-network <server>
Copy to Clipboard Toggle word wrap
Refresh server network information.

Positional arguments

<server>
Name or ID of a server for which the network cache should be refreshed from neutron (Admin only).

6.128. nova remove-fixed-ip
Copy link

usage: nova remove-fixed-ip <server> <address>
Copy to Clipboard Toggle word wrap
Remove an IP address from a server.

Positional arguments

<server>
Name or ID of server.
<address>
IP Address.

6.129. nova remove-secgroup
Copy link

usage: nova remove-secgroup <server> <secgroup>
Copy to Clipboard Toggle word wrap
Remove a Security Group from a server.

Positional arguments

<server>
Name or ID of server.
<secgroup>
Name of Security Group.

6.130. nova rescue
Copy link

usage: nova rescue [--password <password>] [--image <image>] <server>
Copy to Clipboard Toggle word wrap
Reboots a server into rescue mode, which starts the machine from either the initial image or a specified image, attaching the current boot disk as secondary.

Positional arguments

<server>
Name or ID of server.

Optional arguments

--password <password>
The admin password to be set in the rescue environment.
--image <image>
The image to rescue with.

6.131. nova reset-network
Copy link

usage: nova reset-network <server>
Copy to Clipboard Toggle word wrap
Reset network of a server.

Positional arguments

<server>
Name or ID of server.

6.132. nova reset-state
Copy link

usage: nova reset-state [--all-tenants] [--active] <server> [<server> ...]
Copy to Clipboard Toggle word wrap
Reset the state of a server.

Positional arguments

<server>
Name or ID of server(s).

Optional arguments

--all-tenants
Reset state server(s) in another tenant by name (Admin only).
--active
Request the server be reset to "active" state instead of "error" state (the default).

6.133. nova resize
Copy link

usage: nova resize [--poll] <server> <flavor>
Copy to Clipboard Toggle word wrap
Resize a server.

Positional arguments

<server>
Name or ID of server.
<flavor>
Name or ID of new flavor.

Optional arguments

--poll
Report the server resize progress until it completes.

6.134. nova resize-confirm
Copy link

usage: nova resize-confirm <server>
Copy to Clipboard Toggle word wrap
Confirm a previous resize.

Positional arguments

<server>
Name or ID of server.

6.135. nova resize-revert
Copy link

usage: nova resize-revert <server>
Copy to Clipboard Toggle word wrap
Revert a previous resize (and return to the previous VM).

Positional arguments

<server>
Name or ID of server.

6.136. nova restore
Copy link

usage: nova restore <server>
Copy to Clipboard Toggle word wrap
Restore a soft-deleted server.

Positional arguments

<server>
Name or ID of server.

6.137. nova resume
Copy link

usage: nova resume <server>
Copy to Clipboard Toggle word wrap
Resume a server.

Positional arguments

<server>
Name or ID of server.

6.138. nova scrub
Copy link

usage: nova scrub <project_id>
Copy to Clipboard Toggle word wrap
Delete networks and security groups associated with a project.

Positional arguments

<project_id>
The ID of the project.

6.139. nova secgroup-add-default-rule
Copy link

usage: nova secgroup-add-default-rule <ip-proto> <from-port> <to-port> <cidr>
Copy to Clipboard Toggle word wrap
Add a rule to the set of rules that will be added to the 'default' security group for new tenants (nova-network only).

Positional arguments

<ip-proto>
IP protocol (icmp, tcp, udp).
<from-port>
Port at start of range.
<to-port>
Port at end of range.
<cidr>
CIDR for address range.

6.140. nova secgroup-add-group-rule
Copy link

usage: nova secgroup-add-group-rule <secgroup> <source-group> <ip-proto> <from-port> <to-port>
Copy to Clipboard Toggle word wrap
Add a source group rule to a security group.

Positional arguments

<secgroup>
ID or name of security group.
<source-group>
ID or name of source group.
<ip-proto>
IP protocol (icmp, tcp, udp).
<from-port>
Port at start of range.
<to-port>
Port at end of range.

6.141. nova secgroup-add-rule
Copy link

usage: nova secgroup-add-rule <secgroup> <ip-proto> <from-port> <to-port> <cidr>
Copy to Clipboard Toggle word wrap
Add a rule to a security group.

Positional arguments

<secgroup>
ID or name of security group.
<ip-proto>
IP protocol (icmp, tcp, udp).
<from-port>
Port at start of range.
<to-port>
Port at end of range.
<cidr>
CIDR for address range.

6.142. nova secgroup-create
Copy link

usage: nova secgroup-create <name> <description>
Copy to Clipboard Toggle word wrap
Create a security group.

Positional arguments

<name>
Name of security group.
<description>
Description of security group.

6.143. nova secgroup-delete
Copy link

usage: nova secgroup-delete <secgroup>
Copy to Clipboard Toggle word wrap
Delete a security group.

Positional arguments

<secgroup>
ID or name of security group.

6.144. nova secgroup-delete-default-rule
Copy link

usage: nova secgroup-delete-default-rule <ip-proto> <from-port> <to-port> <cidr>
Copy to Clipboard Toggle word wrap
Delete a rule from the set of rules that will be added to the 'default' security group for new tenants (nova-network only).

Positional arguments

<ip-proto>
IP protocol (icmp, tcp, udp).
<from-port>
Port at start of range.
<to-port>
Port at end of range.
<cidr>
CIDR for address range.

6.145. nova secgroup-delete-group-rule
Copy link

usage: nova secgroup-delete-group-rule <secgroup> <source-group> <ip-proto> <from-port> <to-port>
Copy to Clipboard Toggle word wrap
Delete a source group rule from a security group.

Positional arguments

<secgroup>
ID or name of security group.
<source-group>
ID or name of source group.
<ip-proto>
IP protocol (icmp, tcp, udp).
<from-port>
Port at start of range.
<to-port>
Port at end of range.

6.146. nova secgroup-delete-rule
Copy link

usage: nova secgroup-delete-rule <secgroup> <ip-proto> <from-port> <to-port> <cidr>
Copy to Clipboard Toggle word wrap
Delete a rule from a security group.

Positional arguments

<secgroup>
ID or name of security group.
<ip-proto>
IP protocol (icmp, tcp, udp).
<from-port>
Port at start of range.
<to-port>
Port at end of range.
<cidr>
CIDR for address range.

6.147. nova secgroup-list
Copy link

usage: nova secgroup-list [--all-tenants [<0|1>]]
Copy to Clipboard Toggle word wrap
List security groups for the current tenant.

Optional arguments

--all-tenants [<0|1>]
Display information from all tenants (Admin only).

6.148. nova secgroup-list-default-rules
Copy link

usage: nova secgroup-list-default-rules
Copy to Clipboard Toggle word wrap
List rules that will be added to the 'default' security group for new tenants.

6.149. nova secgroup-list-rules
Copy link

usage: nova secgroup-list-rules <secgroup>
Copy to Clipboard Toggle word wrap
List rules for a security group.

Positional arguments

<secgroup>
ID or name of security group.

6.150. nova secgroup-update
Copy link

usage: nova secgroup-update <secgroup> <name> <description>
Copy to Clipboard Toggle word wrap
Update a security group.

Positional arguments

<secgroup>
ID or name of security group.
<name>
Name of security group.
<description>
Description of security group.

6.151. nova server-group-create
Copy link

usage: nova server-group-create <name> [<policy> [<policy> ...]]
Copy to Clipboard Toggle word wrap
Create a new server group with the specified details.

Positional arguments

<name>
Server group name.
<policy>
Policies for the server groups.

6.152. nova server-group-delete
Copy link

usage: nova server-group-delete <id> [<id> ...]
Copy to Clipboard Toggle word wrap
Delete specific server group(s).

Positional arguments

<id>
Unique ID(s) of the server group to delete.

6.153. nova server-group-get
Copy link

usage: nova server-group-get <id>
Copy to Clipboard Toggle word wrap
Get a specific server group.

Positional arguments

<id>
Unique ID of the server group to get.

6.154. nova server-group-list
Copy link

usage: nova server-group-list [--all-projects]
Copy to Clipboard Toggle word wrap
Print a list of all server groups.

Optional arguments

--all-projects
Display server groups from all projects (Admin only).

6.155. nova server-migration-list
Copy link

usage: nova server-migration-list <server>
Copy to Clipboard Toggle word wrap
Get the migrations list of specified server. (Supported by API versions '2.23' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]

Positional arguments

<server>
Name or ID of server.

6.156. nova server-migration-show
Copy link

usage: nova server-migration-show <server> <migration>
Copy to Clipboard Toggle word wrap
Get the migration of specified server. (Supported by API versions '2.23' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]

Positional arguments

<server>
Name or ID of server.
<migration>
ID of migration.

6.157. nova service-delete
Copy link

usage: nova service-delete <id>
Copy to Clipboard Toggle word wrap
Delete the service.

Positional arguments

<id>
ID of service.

6.158. nova service-disable
Copy link

usage: nova service-disable [--reason <reason>] <hostname> <binary>
Copy to Clipboard Toggle word wrap
Disable the service.

Positional arguments

<hostname>
Name of host.
<binary>
Service binary.

Optional arguments

--reason <reason>
Reason for disabling service.

6.159. nova service-enable
Copy link

usage: nova service-enable <hostname> <binary>
Copy to Clipboard Toggle word wrap
Enable the service.

Positional arguments

<hostname>
Name of host.
<binary>
Service binary.

6.160. nova service-force-down
Copy link

usage: nova service-force-down [--unset] <hostname> <binary>
Copy to Clipboard Toggle word wrap
Force service to down. (Supported by API versions '2.11' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]

Positional arguments

<hostname>
Name of host.
<binary>
Service binary.

Optional arguments

--unset
Unset the force state down of service.

6.161. nova service-list
Copy link

usage: nova service-list [--host <hostname>] [--binary <binary>]
Copy to Clipboard Toggle word wrap
Show a list of all running services. Filter by host & binary.

Optional arguments

--host <hostname>
Name of host.
--binary <binary>
Service binary.

6.162. nova set-password
Copy link

usage: nova set-password <server>
Copy to Clipboard Toggle word wrap
Change the admin password for a server.

Positional arguments

<server>
Name or ID of server.

6.163. nova shelve
Copy link

usage: nova shelve <server>
Copy to Clipboard Toggle word wrap
Shelve a server.

Positional arguments

<server>
Name or ID of server.

6.164. nova shelve-offload
Copy link

usage: nova shelve-offload <server>
Copy to Clipboard Toggle word wrap
Remove a shelved server from the compute node.

Positional arguments

<server>
Name or ID of server.

6.165. nova show
Copy link

usage: nova show [--minimal] <server>
Copy to Clipboard Toggle word wrap
Show details about the given server.

Positional arguments

<server>
Name or ID of server.

Optional arguments

--minimal
Skips flavor/image lookups when showing servers.

6.166. nova ssh
Copy link

usage: nova ssh [--port PORT] [--address-type ADDRESS_TYPE] [--network <network>] [--ipv6] [--login <login>] [-i IDENTITY] [--extra-opts EXTRA] <server>
Copy to Clipboard Toggle word wrap
SSH into a server.

Positional arguments

<server>
Name or ID of server.

Optional arguments

--port PORT
Optional flag to indicate which port to use for ssh. (Default=22)
--address-type ADDRESS_TYPE
Optional flag to indicate which IP type to use. Possible values includes fixed and floating (the Default).
--network <network>
Network to use for the ssh.
--ipv6
Optional flag to indicate whether to use an IPv6 address attached to a server. (Defaults to IPv4 address)
--login <login>
Login to use.
-i IDENTITY, --identity IDENTITY
Private key file, same as the -i option to the ssh command.
--extra-opts EXTRA
Extra options to pass to ssh. see: man ssh.

6.167. nova start
Copy link

usage: nova start [--all-tenants] <server> [<server> ...]
Copy to Clipboard Toggle word wrap
Start the server(s).

Positional arguments

<server>
Name or ID of server(s).

Optional arguments

--all-tenants
Start server(s) in another tenant by name (Admin only).

6.168. nova stop
Copy link

usage: nova stop [--all-tenants] <server> [<server> ...]
Copy to Clipboard Toggle word wrap
Stop the server(s).

Positional arguments

<server>
Name or ID of server(s).

Optional arguments

--all-tenants
Stop server(s) in another tenant by name (Admin only).

6.169. nova suspend
Copy link

usage: nova suspend <server>
Copy to Clipboard Toggle word wrap
Suspend a server.

Positional arguments

<server>
Name or ID of server.

6.170. nova tenant-network-create
Copy link

usage: nova tenant-network-create <network_label> <cidr>
Copy to Clipboard Toggle word wrap
Create a tenant network.

Positional arguments

<network_label>
Network label (ex. my_new_network)
<cidr>
IP block to allocate from (ex. 172.16.0.0/24 or 2001:DB8::/64)

6.171. nova tenant-network-delete
Copy link

usage: nova tenant-network-delete <network_id>
Copy to Clipboard Toggle word wrap
Delete a tenant network.

Positional arguments

<network_id>
ID of network

6.172. nova tenant-network-list
Copy link

usage: nova tenant-network-list
Copy to Clipboard Toggle word wrap
List tenant networks.

6.173. nova tenant-network-show
Copy link

usage: nova tenant-network-show <network_id>
Copy to Clipboard Toggle word wrap
Show a tenant network.

Positional arguments

<network_id>
ID of network

6.174. nova trigger-crash-dump
Copy link

usage: nova trigger-crash-dump <server>
Copy to Clipboard Toggle word wrap
Trigger crash dump in an instance. (Supported by API versions '2.17' - '2.latest') [hint: use '--os-compute-api-version' flag to show help message for proper version]

Positional arguments

<server>
Name or ID of server.

6.175. nova unlock
Copy link

usage: nova unlock <server>
Copy to Clipboard Toggle word wrap
Unlock a server.

Positional arguments

<server>
Name or ID of server.

6.176. nova unpause
Copy link

usage: nova unpause <server>
Copy to Clipboard Toggle word wrap
Unpause a server.

Positional arguments

<server>
Name or ID of server.

6.177. nova unrescue
Copy link

usage: nova unrescue <server>
Copy to Clipboard Toggle word wrap
Restart the server from normal boot disk again.

Positional arguments

<server>
Name or ID of server.

6.178. nova unshelve
Copy link

usage: nova unshelve <server>
Copy to Clipboard Toggle word wrap
Unshelve a server.

Positional arguments

<server>
Name or ID of server.

6.179. nova update
Copy link

usage: nova update [--name <name>] [--description <description>] <server>
Copy to Clipboard Toggle word wrap
Update the name or the description for a server.

Positional arguments

<server>
Name (old name) or ID of server.

Optional arguments

--name <name>
New name for the server.
--description <description>
New description for the server. If it equals to empty string (i.g. ""), the server description will be removed. (Supported by API versions '2.19' - '2.latest')

6.180. nova usage
Copy link

usage: nova usage [--start <start>] [--end <end>] [--tenant <tenant-id>]
Copy to Clipboard Toggle word wrap
Show usage data for a single tenant.

Optional arguments

--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)
--tenant <tenant-id>
UUID of tenant to get usage for.

6.181. nova usage-list
Copy link

usage: nova usage-list [--start <start>] [--end <end>]
Copy to Clipboard Toggle word wrap
List usage data for all tenants.

Optional arguments

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

6.182. nova version-list
Copy link

usage: nova version-list
Copy to Clipboard Toggle word wrap
List all API versions.

6.183. nova virtual-interface-list
Copy link

usage: nova virtual-interface-list <server>
Copy to Clipboard Toggle word wrap
Show virtual interface info about the given server.

Positional arguments

<server>
ID of server.

6.184. nova volume-attach
Copy link

usage: nova volume-attach <server> <volume> [<device>]
Copy to Clipboard Toggle word wrap
Attach a volume to a server.

Positional arguments

<server>
Name or ID of server.
<volume>
ID of the volume to attach.
<device>
Name of the device e.g. /dev/vdb. Use "auto" for autoassign (if supported). Libvirt driver will use default device name.

6.185. nova volume-attachments
Copy link

usage: nova volume-attachments <server>
Copy to Clipboard Toggle word wrap
List all the volumes attached to a server.

Positional arguments

<server>
Name or ID of server.

6.186. nova volume-detach
Copy link

usage: nova volume-detach <server> <volume>
Copy to Clipboard Toggle word wrap
Detach a volume from a server.

Positional arguments

<server>
Name or ID of server.
<volume>
ID of the volume to detach.

6.187. nova volume-update
Copy link

usage: nova volume-update <server> <attachment> <volume>
Copy to Clipboard Toggle word wrap
Update volume attachment.

Positional arguments

<server>
Name or ID of server.
<attachment>
Attachment ID of the volume.
<volume>
ID of the volume to attach.

6.188. nova x509-create-cert
Copy link

usage: nova x509-create-cert [<private-key-filename>] [<x509-cert-filename>]
Copy to Clipboard Toggle word wrap
Create x509 cert for a user in tenant.

Positional arguments

<private-key-filename>
Filename for the private key. [Default: pk.pem]
<x509-cert-filename>
Filename for the X.509 certificate. [Default: cert.pem]

6.189. nova x509-get-root-cert
Copy link

usage: nova x509-get-root-cert [<filename>]
Copy to Clipboard Toggle word wrap
Fetch the x509 root cert.

Positional arguments

<filename>
Filename to write the x509 root cert.

Chapter 7. Identity service command-line client
Copy link

Warning
The keystone CLI is deprecated in favor of python-openstackclient. For more information on python-openstackclient, please see Section 3.3, “Subcommands”. For a Python library, continue using python-keystoneclient.
The keystone client is the command-line interface (CLI) for the Identity service API and its extensions. This chapter documents keystone version 2.3.1.
For help on a specific keystone command, enter: 
$ keystone help COMMAND
Copy to Clipboard Toggle word wrap

7.1. keystone usage
Copy link

usage: keystone [--version] [--debug] [--os-username <auth-user-name>] [--os-password <auth-password>] [--os-tenant-name <auth-tenant-name>] [--os-tenant-id <tenant-id>] [--os-auth-url <auth-url>] [--os-region-name <region-name>] [--os-identity-api-version <identity-api-version>] [--os-token <service-token>] [--os-endpoint <service-endpoint>] [--os-cache] [--force-new-token] [--stale-duration <seconds>] [--insecure] [--os-cacert <ca-certificate>] [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>] <subcommand> ...
Copy to Clipboard Toggle word wrap

Subcommands

catalog
List service catalog, possibly filtered by service.
ec2-credentials-create
Create EC2-compatible credentials for user per tenant.
ec2-credentials-delete
Delete EC2-compatible credentials.
ec2-credentials-get
Display EC2-compatible credentials.
ec2-credentials-list
List EC2-compatible credentials for a user.
endpoint-create
Create a new endpoint associated with a service.
endpoint-delete
Delete a service endpoint.
endpoint-get
Find endpoint filtered by a specific attribute or service type.
endpoint-list
List configured service endpoints.
password-update
Update own password.
role-create
Create new role.
role-delete
Delete role.
role-get
Display role details.
role-list
List all roles.
service-create
Add service to Service Catalog.
service-delete
Delete service from Service Catalog.
service-get
Display service from Service Catalog.
service-list
List all services in Service Catalog.
tenant-create
Create new tenant.
tenant-delete
Delete tenant.
tenant-get
Display tenant details.
tenant-list
List all tenants.
tenant-update
Update tenant name, description, enabled status.
token-get
Display the current user token.
user-create
Create new user.
user-delete
Delete user.
user-get
Display user details.
user-list
List users.
user-password-update
Update user password.
user-role-add
Add role to user.
user-role-list
List roles granted to a user.
user-role-remove
Remove role from user.
user-update
Update user's name, email, and enabled status.
discover
Discover Keystone servers, supported API versions and extensions.
bootstrap
Grants a new role to a new user on a new tenant, after creating each.
bash-completion
Prints all of the commands and options to stdout.
help
Display help about this program or one of its subcommands.

7.2. keystone optional arguments
Copy link

--version
Shows the client version and exits.
--debug
Prints debugging output onto the console, this includes the curl request and response calls. Helpful for debugging and understanding the API calls.
--os-username <auth-user-name>
Name used for authentication with the OpenStack Identity service. Defaults to env[OS_USERNAME].
--os-password <auth-password>
Password used for authentication with the OpenStack Identity service. Defaults to env[OS_PASSWORD].
--os-tenant-name <auth-tenant-name>
Tenant to request authorization on. Defaults to env[OS_TENANT_NAME].
--os-tenant-id <tenant-id>
Tenant to request authorization on. Defaults to env[OS_TENANT_ID].
--os-auth-url <auth-url>
Specify the Identity endpoint to use for authentication. Defaults to env[OS_AUTH_URL].
--os-region-name <region-name>
Specify the region to use. Defaults to env[OS_REGION_NAME].
--os-identity-api-version <identity-api-version>
Specify Identity API version to use. Defaults to env[OS_IDENTITY_API_VERSION] or 2.0.
--os-token <service-token>
Specify an existing token to use instead of retrieving one via authentication (e.g. with username & password). Defaults to env[OS_SERVICE_TOKEN].
--os-endpoint <service-endpoint>
Specify an endpoint to use instead of retrieving one from the service catalog (via authentication). Defaults to env[OS_SERVICE_ENDPOINT].
--os-cache
Use the auth token cache. Defaults to env[OS_CACHE].
--force-new-token
If the keyring is available and in use, token will always be stored and fetched from the keyring until the token has expired. Use this option to request a new token and replace the existing one in the keyring.
--stale-duration <seconds>
Stale duration (in seconds) used to determine whether a token has expired when retrieving it from keyring. This is useful in mitigating process or network delays. Default is 30 seconds.
--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).

7.3. keystone bootstrap
Copy link

usage: keystone bootstrap [--user-name <user-name>] --pass <password> [--role-name <role-name>] [--tenant-name <tenant-name>]
Copy to Clipboard Toggle word wrap
Grants a new role to a new user on a new tenant, after creating each.

Arguments

--user-name <user-name>
The name of the user to be created (default="admin").
--pass <password>
The password for the new user.
--role-name <role-name>
The name of the role to be created and granted to the user (default="admin").
--tenant-name <tenant-name>
The name of the tenant to be created (default="admin").

7.4. keystone catalog
Copy link

usage: keystone catalog [--service <service-type>]
Copy to Clipboard Toggle word wrap
List service catalog, possibly filtered by service.

Arguments

--service <service-type>
Service type to return.

7.5. keystone discover
Copy link

usage: keystone discover
Copy to Clipboard Toggle word wrap
Discover Keystone servers, supported API versions and extensions.

7.6. keystone ec2-credentials-create
Copy link

usage: keystone ec2-credentials-create [--user-id <user-id>] [--tenant-id <tenant-id>]
Copy to Clipboard Toggle word wrap
Create EC2-compatible credentials for user per tenant.

Arguments

--user-id <user-id>
User ID for which to create credentials. If not specified, the authenticated user will be used.
--tenant-id <tenant-id>
Tenant ID for which to create credentials. If not specified, the authenticated tenant ID will be used.

7.7. keystone ec2-credentials-delete
Copy link

usage: keystone ec2-credentials-delete [--user-id <user-id>] --access <access-key>
Copy to Clipboard Toggle word wrap
Delete EC2-compatible credentials.

Arguments

--user-id <user-id>
User ID.
--access <access-key>
Access Key.

7.8. keystone ec2-credentials-get
Copy link

usage: keystone ec2-credentials-get [--user-id <user-id>] --access <access-key>
Copy to Clipboard Toggle word wrap
Display EC2-compatible credentials.

Arguments

--user-id <user-id>
User ID.
--access <access-key>
Access Key.

7.9. keystone ec2-credentials-list
Copy link

usage: keystone ec2-credentials-list [--user-id <user-id>]
Copy to Clipboard Toggle word wrap
List EC2-compatible credentials for a user.

Arguments

--user-id <user-id>
User ID.

7.10. keystone endpoint-create
Copy link

usage: keystone endpoint-create [--region <endpoint-region>] --service <service> --publicurl <public-url> [--adminurl <admin-url>] [--internalurl <internal-url>]
Copy to Clipboard Toggle word wrap
Create a new endpoint associated with a service.

Arguments

--region <endpoint-region>
Endpoint region.
--service <service>, --service-id <service>, --service_id <service>
Name or ID of service associated with endpoint.
--publicurl <public-url>
Public URL endpoint.
--adminurl <admin-url>
Admin URL endpoint.
--internalurl <internal-url>
Internal URL endpoint.

7.11. keystone endpoint-delete
Copy link

usage: keystone endpoint-delete <endpoint-id>
Copy to Clipboard Toggle word wrap
Delete a service endpoint.

Arguments

<endpoint-id>
ID of endpoint to delete.

7.12. keystone endpoint-get
Copy link

usage: keystone endpoint-get --service <service-type> [--endpoint-type <endpoint-type>] [--attr <service-attribute>] [--value <value>]
Copy to Clipboard Toggle word wrap
Find endpoint filtered by a specific attribute or service type.

Arguments

--service <service-type>
Service type to select.
--endpoint-type <endpoint-type>
Endpoint type to select.
--attr <service-attribute>
Service attribute to match for selection.
--value <value>
Value of attribute to match.

7.13. keystone endpoint-list
Copy link

usage: keystone endpoint-list
Copy to Clipboard Toggle word wrap
List configured service endpoints.

7.14. keystone password-update
Copy link

usage: keystone password-update [--current-password <current-password>] [--new-password <new-password>]
Copy to Clipboard Toggle word wrap
Update own password.

Arguments

--current-password <current-password>
Current password, Defaults to the password as set by --os-password or env[OS_PASSWORD].
--new-password <new-password>
Desired new password.

7.15. keystone role-create
Copy link

usage: keystone role-create --name <role-name>
Copy to Clipboard Toggle word wrap
Create new role.

Arguments

--name <role-name>
Name of new role.

7.16. keystone role-delete
Copy link

usage: keystone role-delete <role>
Copy to Clipboard Toggle word wrap
Delete role.

Arguments

<role>
Name or ID of role to delete.

7.17. keystone role-get
Copy link

usage: keystone role-get <role>
Copy to Clipboard Toggle word wrap
Display role details.

Arguments

<role>
Name or ID of role to display.

7.18. keystone role-list
Copy link

usage: keystone role-list
Copy to Clipboard Toggle word wrap
List all roles.

7.19. keystone service-create
Copy link

usage: keystone service-create --type <type> [--name <name>] [--description <service-description>]
Copy to Clipboard Toggle word wrap
Add service to Service Catalog.

Arguments

--type <type>
Service type (one of: identity, compute, network, image, object-store, or other service identifier string).
--name <name>
Name of new service (must be unique).
--description <service-description>
Description of service.

7.20. keystone service-delete
Copy link

usage: keystone service-delete <service>
Copy to Clipboard Toggle word wrap
Delete service from Service Catalog.

Arguments

<service>
Name or ID of service to delete.

7.21. keystone service-get
Copy link

usage: keystone service-get <service>
Copy to Clipboard Toggle word wrap
Display service from Service Catalog.

Arguments

<service>
Name or ID of service to display.

7.22. keystone service-list
Copy link

usage: keystone service-list
Copy to Clipboard Toggle word wrap
List all services in Service Catalog.

7.23. keystone tenant-create
Copy link

usage: keystone tenant-create --name <tenant-name> [--description <tenant-description>] [--enabled <true|false>]
Copy to Clipboard Toggle word wrap
Create new tenant.

Arguments

--name <tenant-name>
New tenant name (must be unique).
--description <tenant-description>
Description of new tenant. Default is none.
--enabled <true|false>
Initial tenant enabled status. Default is true.

7.24. keystone tenant-delete
Copy link

usage: keystone tenant-delete <tenant>
Copy to Clipboard Toggle word wrap
Delete tenant.

Arguments

<tenant>
Name or ID of tenant to delete.

7.25. keystone tenant-get
Copy link

usage: keystone tenant-get <tenant>
Copy to Clipboard Toggle word wrap
Display tenant details.

Arguments

<tenant>
Name or ID of tenant to display.

7.26. keystone tenant-list
Copy link

usage: keystone tenant-list
Copy to Clipboard Toggle word wrap
List all tenants.

7.27. keystone tenant-update
Copy link

usage: keystone tenant-update [--name <tenant_name>] [--description <tenant-description>] [--enabled <true|false>] <tenant>
Copy to Clipboard Toggle word wrap
Update tenant name, description, enabled status.

Arguments

--name <tenant_name>
Desired new name of tenant.
--description <tenant-description>
Desired new description of tenant.
--enabled <true|false>
Enable or disable tenant.
<tenant>
Name or ID of tenant to update.

7.28. keystone token-get
Copy link

usage: keystone token-get [--wrap <integer>]
Copy to Clipboard Toggle word wrap
Display the current user token.

Arguments

--wrap <integer>
Wrap PKI tokens to a specified length, or 0 to disable.

7.29. keystone user-create
Copy link

usage: keystone user-create --name <user-name> [--tenant <tenant>] [--pass [<pass>]] [--email <email>] [--enabled <true|false>]
Copy to Clipboard Toggle word wrap
Create new user.

Arguments

--name <user-name>
New user name (must be unique).
--tenant <tenant>, --tenant-id <tenant>
New user default tenant.
--pass [<pass>]
New user password; required for some auth backends.
--email <email>
New user email address.
--enabled <true|false>
Initial user enabled status. Default is true.

7.30. keystone user-delete
Copy link

usage: keystone user-delete <user>
Copy to Clipboard Toggle word wrap
Delete user.

Arguments

<user>
Name or ID of user to delete.

7.31. keystone user-get
Copy link

usage: keystone user-get <user>
Copy to Clipboard Toggle word wrap
Display user details.

Arguments

<user>
Name or ID of user to display.

7.32. keystone user-list
Copy link

usage: keystone user-list [--tenant <tenant>]
Copy to Clipboard Toggle word wrap
List users.

Arguments

--tenant <tenant>, --tenant-id <tenant>
Tenant; lists all users if not specified.

7.33. keystone user-password-update
Copy link

usage: keystone user-password-update [--pass <password>] <user>
Copy to Clipboard Toggle word wrap
Update user password.

Arguments

--pass <password>
Desired new password.
<user>
Name or ID of user to update password.

7.34. keystone user-role-add
Copy link

usage: keystone user-role-add --user <user> --role <role> [--tenant <tenant>]
Copy to Clipboard Toggle word wrap
Add role to user.

Arguments

--user <user>, --user-id <user>, --user_id <user>
Name or ID of user.
--role <role>, --role-id <role>, --role_id <role>
Name or ID of role.
--tenant <tenant>, --tenant-id <tenant>
Name or ID of tenant.

7.35. keystone user-role-list
Copy link

usage: keystone user-role-list [--user <user>] [--tenant <tenant>]
Copy to Clipboard Toggle word wrap
List roles granted to a user.

Arguments

--user <user>, --user-id <user>
List roles granted to specified user.
--tenant <tenant>, --tenant-id <tenant>
List only roles granted on specified tenant.

7.36. keystone user-role-remove
Copy link

usage: keystone user-role-remove --user <user> --role <role> [--tenant <tenant>]
Copy to Clipboard Toggle word wrap
Remove role from user.

Arguments

--user <user>, --user-id <user>, --user_id <user>
Name or ID of user.
--role <role>, --role-id <role>, --role_id <role>
Name or ID of role.
--tenant <tenant>, --tenant-id <tenant>
Name or ID of tenant.

7.37. keystone user-update
Copy link

usage: keystone user-update [--name <user-name>] [--email <email>] [--enabled <true|false>] <user>
Copy to Clipboard Toggle word wrap
Update user's name, email, and enabled status.

Arguments

--name <user-name>
Desired new user name.
--email <email>
Desired new email address.
--enabled <true|false>
Enable or disable user.
<user>
Name or ID of user to update.

Chapter 8. Image service command-line client
Copy link

The glance client is the command-line interface (CLI) for the Image service API and its extensions. This chapter documents glance version 2.0.0.
For help on a specific glance command, enter: 
$ glance help COMMAND
Copy to Clipboard Toggle word wrap

8.1. glance usage
Copy link

usage: glance [--version] [-d] [-v] [--get-schema] [--no-ssl-compression] [-f] [--os-image-url OS_IMAGE_URL] [--os-image-api-version OS_IMAGE_API_VERSION] [--profile HMAC_KEY] [--insecure] [--os-cacert <ca-certificate>] [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>] [--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID] [--os-domain-name OS_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID] [--os-project-name OS_PROJECT_NAME] [--os-project-domain-id OS_PROJECT_DOMAIN_ID] [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] [--os-trust-id OS_TRUST_ID] [--os-user-id OS_USER_ID] [--os-username OS_USERNAME] [--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-password OS_PASSWORD] [--key-file OS_KEY] [--ca-file OS_CACERT] [--cert-file OS_CERT] [--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME] [--os-region-name OS_REGION_NAME] [--os-auth-token OS_AUTH_TOKEN] [--os-service-type OS_SERVICE_TYPE] [--os-endpoint-type OS_ENDPOINT_TYPE] <subcommand> ...
Copy to Clipboard Toggle word wrap

8.2. glance optional arguments
Copy link

--version
show program's version number and exit
-d, --debug
Defaults to env[GLANCECLIENT_DEBUG].
-v, --verbose
Print more verbose output.
--get-schema
Ignores cached copy and forces retrieval of schema that generates portions of the help text. Ignored with API version 1.
--no-ssl-compression
DEPRECATED! This option is deprecated and not used anymore. SSL compression should be disabled by default by the system SSL library.
-f, --force
Prevent select actions from requesting user confirmation.
--os-image-url OS_IMAGE_URL
Defaults to env[OS_IMAGE_URL]. If the provided image url contains a version number and `--os-image-api- version` is omitted the version of the URL will be picked as the image api version to use.
--os-image-api-version OS_IMAGE_API_VERSION
Defaults to env[OS_IMAGE_API_VERSION] or 2.
--profile HMAC_KEY
HMAC key to use for encrypting context data for performance profiling of operation. This key should be the value of HMAC key configured in osprofiler middleware in glance, it is specified in paste configuration file at /etc/glance/api-paste.ini and /etc/glance/registry-paste.ini. Without key the profiling will not be triggered even if osprofiler is enabled on server side.
--insecure
Explicitly allow client to perform "insecure" TLS (https) requests. The server's certificate will not be verified against any certificate authorities. This option should be used with caution.
--os-cacert <ca-certificate>
Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to env[OS_CACERT].
--os-cert <certificate>
Defaults to env[OS_CERT].
--os-key <key>
Defaults to env[OS_KEY].
--timeout <seconds>
Set request timeout (in seconds).
--os-auth-url OS_AUTH_URL
Authentication URL
--os-domain-id OS_DOMAIN_ID
Domain ID to scope to
--os-domain-name OS_DOMAIN_NAME
Domain name to scope to
--os-project-id OS_PROJECT_ID
Project ID to scope to
--os-project-name OS_PROJECT_NAME
Project name to scope to
--os-project-domain-id OS_PROJECT_DOMAIN_ID
Domain ID containing project
--os-project-domain-name OS_PROJECT_DOMAIN_NAME
Domain name containing project
--os-trust-id OS_TRUST_ID
Trust ID
--os-user-id OS_USER_ID
User ID
--os-username OS_USERNAME, --os-user_name OS_USERNAME
Username
--os-user-domain-id OS_USER_DOMAIN_ID
User's domain id
--os-user-domain-name OS_USER_DOMAIN_NAME
User's domain name
--os-password OS_PASSWORD
User's password
--key-file OS_KEY
DEPRECATED! Use --os-key.
--ca-file OS_CACERT
DEPRECATED! Use --os-cacert.
--cert-file OS_CERT
DEPRECATED! Use --os-cert.
--os-tenant-id OS_TENANT_ID
Defaults to env[OS_TENANT_ID].
--os-tenant-name OS_TENANT_NAME
Defaults to env[OS_TENANT_NAME].
--os-region-name OS_REGION_NAME
Defaults to env[OS_REGION_NAME].
--os-auth-token OS_AUTH_TOKEN
Defaults to env[OS_AUTH_TOKEN].
--os-service-type OS_SERVICE_TYPE
Defaults to env[OS_SERVICE_TYPE].
--os-endpoint-type OS_ENDPOINT_TYPE
Defaults to env[OS_ENDPOINT_TYPE].

8.3. Image service API v1 commands
Copy link

8.3.1. glance image-create (v1)
Copy link

usage: glance --os-image-api-version 1 image-create [--id <IMAGE_ID>] [--name <NAME>] [--store <STORE>] [--disk-format <DISK_FORMAT>] [--container-format <CONTAINER_FORMAT>] [--owner <TENANT_ID>] [--size <SIZE>] [--min-disk <DISK_GB>] [--min-ram <DISK_RAM>] [--location <IMAGE_URL>] [--file <FILE>] [--checksum <CHECKSUM>] [--copy-from <IMAGE_URL>] [--is-public {True,False}] [--is-protected {True,False}] [--property <key=value>] [--human-readable] [--progress]
Copy to Clipboard Toggle word wrap
Create a new image.

Optional arguments

--id <IMAGE_ID>
ID of image to reserve.
--name <NAME>
Name of image.
--store <STORE>
Store to upload image to.
--disk-format <DISK_FORMAT>
Disk format of image. Acceptable formats: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, and iso.
--container-format <CONTAINER_FORMAT>
Container format of image. Acceptable formats: ami, ari, aki, bare, and ovf.
--owner <TENANT_ID>
Tenant who should own image.
--size <SIZE>
Size of image data (in bytes). Only used with '-- location' and '--copy_from'.
--min-disk <DISK_GB>
Minimum size of disk needed to boot image (in gigabytes).
--min-ram <DISK_RAM>
Minimum amount of ram needed to boot image (in megabytes).
--location <IMAGE_URL>
URL where the data for this image already resides. For example, if the image data is stored in swift, you could specify 'swift+http://tenant%3Aaccount:key@auth_ url/v2.0/container/obj'. (Note: '%3A' is ':' URL encoded.)
--file <FILE>
Local file that contains disk image to be uploaded during creation. Alternatively, images can be passed to the client via stdin.
--checksum <CHECKSUM>
Hash of image data used Glance can use for verification. Provide a md5 checksum here.
--copy-from <IMAGE_URL>
Similar to '--location' in usage, but this indicates that the Glance server should immediately copy the data and store it in its configured image store.
--is-public {True,False}
Make image accessible to the public.
--is-protected {True,False}
Prevent image from being deleted.
--property <key=value>
Arbitrary property to associate with image. May be used multiple times.
--human-readable
Print image size in a human-friendly format.
--progress
Show upload progress bar.

8.3.2. glance image-delete (v1)
Copy link

usage: glance --os-image-api-version 1 image-delete <IMAGE> [<IMAGE> ...]
Copy to Clipboard Toggle word wrap
Delete specified image(s).

Positional arguments

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

8.3.3. glance image-download (v1)
Copy link

usage: glance --os-image-api-version 1 image-download [--file <FILE>] [--progress] <IMAGE>
Copy to Clipboard Toggle word wrap
Download a specific image.

Positional arguments

<IMAGE>
Name or ID of image to download.

Optional arguments

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

8.3.4. glance image-list (v1)
Copy link

usage: glance --os-image-api-version 1 image-list [--name <NAME>] [--status <STATUS>] [--changes-since <CHANGES_SINCE>] [--container-format <CONTAINER_FORMAT>] [--disk-format <DISK_FORMAT>] [--size-min <SIZE>] [--size-max <SIZE>] [--property-filter <KEY=VALUE>] [--page-size <SIZE>] [--human-readable] [--sort-key {name,status,container_format,disk_format,size,id,created_at,updated_at}] [--sort-dir {asc,desc}] [--is-public {True,False}] [--owner <TENANT_ID>] [--all-tenants]
Copy to Clipboard Toggle word wrap
List images you can access.

Optional arguments

--name <NAME>
Filter images to those that have this name.
--status <STATUS>
Filter images to those that have this status.
--changes-since <CHANGES_SINCE>
Filter images to those that changed since the given time, which will include the deleted images.
--container-format <CONTAINER_FORMAT>
Filter images to those that have this container format. Acceptable formats: ami, ari, aki, bare, and ovf.
--disk-format <DISK_FORMAT>
Filter images to those that have this disk format. Acceptable formats: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, and iso.
--size-min <SIZE>
Filter images to those with a size greater than this.
--size-max <SIZE>
Filter images to those with a size less than this.
--property-filter <KEY=VALUE>
Filter images by a user-defined image property.
--page-size <SIZE>
Number of images to request in each paginated request.
--human-readable
Print image size in a human-friendly format.
--sort-key {name,status,container_format,disk_format,size,id,created_at,updated_at}
Sort image list by specified field.
--sort-dir {asc,desc}
Sort image list in specified direction.
--is-public {True,False}
Allows the user to select a listing of public or non public images.
--owner <TENANT_ID>
Display only images owned by this tenant id. Filtering occurs on the client side so may be inefficient. This option is mainly intended for admin use. Use an empty string ('') to list images with no owner. Note: This option overrides the --is-public argument if present. Note: the v2 API supports more efficient server-side owner based filtering.
--all-tenants
Allows the admin user to list all images irrespective of the image's owner or is_public value.

8.3.5. glance image-show (v1)
Copy link

usage: glance --os-image-api-version 1 image-show [--human-readable] [--max-column-width <integer>] <IMAGE>
Copy to Clipboard Toggle word wrap
Describe a specific image.

Positional arguments

<IMAGE>
Name or ID of image to describe.

Optional arguments

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

8.3.6. glance image-update (v1)
Copy link

usage: glance --os-image-api-version 1 image-update [--name <NAME>] [--disk-format <DISK_FORMAT>] [--container-format <CONTAINER_FORMAT>] [--owner <TENANT_ID>] [--size <SIZE>] [--min-disk <DISK_GB>] [--min-ram <DISK_RAM>] [--location <IMAGE_URL>] [--file <FILE>] [--checksum <CHECKSUM>] [--copy-from <IMAGE_URL>] [--is-public {True,False}] [--is-protected {True,False}] [--property <key=value>] [--purge-props] [--human-readable] [--progress] <IMAGE>
Copy to Clipboard Toggle word wrap
Update a specific image.

Positional arguments

<IMAGE>
Name or ID of image to modify.

Optional arguments

--name <NAME>
Name of image.
--disk-format <DISK_FORMAT>
Disk format of image. Acceptable formats: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, and iso.
--container-format <CONTAINER_FORMAT>
Container format of image. Acceptable formats: ami, ari, aki, bare, and ovf.
--owner <TENANT_ID>
Tenant who should own image.
--size <SIZE>
Size of image data (in bytes).
--min-disk <DISK_GB>
Minimum size of disk needed to boot image (in gigabytes).
--min-ram <DISK_RAM>
Minimum amount of ram needed to boot image (in megabytes).
--location <IMAGE_URL>
URL where the data for this image already resides. For example, if the image data is stored in swift, you could specify 'swift+http://tenant%3Aaccount:key@auth_ url/v2.0/container/obj'. (Note: '%3A' is ':' URL encoded.) This option only works for images in 'queued' status.
--file <FILE>
Local file that contains disk image to be uploaded during update. Alternatively, images can be passed to the client via stdin.
--checksum <CHECKSUM>
Hash of image data used Glance can use for verification.
--copy-from <IMAGE_URL>
Similar to '--location' in usage, but this indicates that the Glance server should immediately copy the data and store it in its configured image store. This option only works for images in 'queued' status.
--is-public {True,False}
Make image accessible to the public.
--is-protected {True,False}
Prevent image from being deleted.
--property <key=value>
Arbitrary property to associate with image. May be used multiple times.
--purge-props
If this flag is present, delete all image properties not explicitly set in the update request. Otherwise, those properties not referenced are preserved.
--human-readable
Print image size in a human-friendly format.
--progress
Show upload progress bar.

8.3.7. glance member-create (v1)
Copy link

usage: glance --os-image-api-version 1 member-create [--can-share] <IMAGE> <TENANT_ID>
Copy to Clipboard Toggle word wrap
Share a specific image with a tenant.

Positional arguments

<IMAGE>
Image to add member to.
<TENANT_ID>
Tenant to add as member.

Optional arguments

--can-share
Allow the specified tenant to share this image.

8.3.8. glance member-delete (v1)
Copy link

usage: glance --os-image-api-version 1 member-delete <IMAGE> <TENANT_ID>
Copy to Clipboard Toggle word wrap
Remove a shared image from a tenant.

Positional arguments

<IMAGE>
Image from which to remove member.
<TENANT_ID>
Tenant to remove as member.

8.3.9. glance member-list (v1)
Copy link

usage: glance --os-image-api-version 1 member-list [--image-id <IMAGE_ID>] [--tenant-id <TENANT_ID>]
Copy to Clipboard Toggle word wrap
Describe sharing permissions by image or tenant.

Optional arguments

--image-id <IMAGE_ID>
Filter results by an image ID.
--tenant-id <TENANT_ID>
Filter results by a tenant ID.

8.4. Image service API v2 commands
Copy link

You can select an API version to use by adding the --os-image-api-version parameter or by setting the corresponding environment variable: 
$ export OS_IMAGE_API_VERSION=2
Copy to Clipboard Toggle word wrap

8.4.1. glance explain (v2)
Copy link

usage: glance --os-image-api-version 2 explain <MODEL>
Copy to Clipboard Toggle word wrap
Describe a specific model.

Positional arguments

<MODEL>
Name of model to describe.

8.4.2. glance image-create (v2)
Copy link

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

Optional arguments

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

8.4.3. glance image-deactivate (v2)
Copy link

usage: glance --os-image-api-version 2 image-deactivate <IMAGE_ID>
Copy to Clipboard Toggle word wrap
Deactivate specified image.

Positional arguments

<IMAGE_ID>
ID of image to deactivate.

8.4.4. glance image-delete (v2)
Copy link

usage: glance --os-image-api-version 2 image-delete <IMAGE_ID> [<IMAGE_ID> ...]
Copy to Clipboard Toggle word wrap
Delete specified image.

Positional arguments

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

8.4.5. glance image-download (v2)
Copy link

usage: glance --os-image-api-version 2 image-download [--file <FILE>] [--progress] <IMAGE_ID>
Copy to Clipboard Toggle word wrap
Download a specific image.

Positional arguments

<IMAGE_ID>
ID of image to download.

Optional arguments

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

8.4.6. glance image-list (v2)
Copy link

usage: glance --os-image-api-version 2 image-list [--limit <LIMIT>] [--page-size <SIZE>] [--visibility <VISIBILITY>] [--member-status <MEMBER_STATUS>] [--owner <OWNER>] [--property-filter <KEY=VALUE>] [--checksum <CHECKSUM>] [--tag <TAG>] [--sort-key {name,status,container_format,disk_format,size,id,created_at,updated_at}] [--sort-dir {asc,desc}] [--sort <key>[:<direction>]]
Copy to Clipboard Toggle word wrap
List images you can access.

Optional arguments

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

8.4.7. glance image-reactivate (v2)
Copy link

usage: glance --os-image-api-version 2 image-reactivate <IMAGE_ID>
Copy to Clipboard Toggle word wrap
Reactivate specified image.

Positional arguments

<IMAGE_ID>
ID of image to reactivate.

8.4.8. glance image-show (v2)
Copy link

usage: glance --os-image-api-version 2 image-show [--human-readable] [--max-column-width <integer>] <IMAGE_ID>
Copy to Clipboard Toggle word wrap
Describe a specific image.

Positional arguments

<IMAGE_ID>
ID of image to describe.

Optional arguments

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

8.4.9. glance image-tag-delete (v2)
Copy link

usage: glance --os-image-api-version 2 image-tag-delete <IMAGE_ID> <TAG_VALUE>
Copy to Clipboard Toggle word wrap
Delete the tag associated with the given image.

Positional arguments

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

8.4.10. glance image-tag-update (v2)
Copy link

usage: glance --os-image-api-version 2 image-tag-update <IMAGE_ID> <TAG_VALUE>
Copy to Clipboard Toggle word wrap
Update an image with the given tag.

Positional arguments

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

8.4.11. glance image-update (v2)
Copy link

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

Positional arguments

<IMAGE_ID>
ID of image to update.

Optional arguments

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

8.4.12. glance image-upload (v2)
Copy link

usage: glance --os-image-api-version 2 image-upload [--file <FILE>] [--size <IMAGE_SIZE>] [--progress] <IMAGE_ID>
Copy to Clipboard Toggle word wrap
Upload data for a specific image.

Positional arguments

<IMAGE_ID>
ID of image to upload data to.

Optional arguments

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

8.4.13. glance location-add (v2)
Copy link

usage: glance --os-image-api-version 2 location-add --url <URL> [--metadata <STRING>] <IMAGE_ID>
Copy to Clipboard Toggle word wrap
Add a location (and related metadata) to an image.

Positional arguments

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

Optional arguments

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

8.4.14. glance location-delete (v2)
Copy link

usage: glance --os-image-api-version 2 location-delete --url <URL> <IMAGE_ID>
Copy to Clipboard Toggle word wrap
Remove locations (and related metadata) from an image.

Positional arguments

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

Optional arguments

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

8.4.15. glance location-update (v2)
Copy link

usage: glance --os-image-api-version 2 location-update --url <URL> [--metadata <STRING>] <IMAGE_ID>
Copy to Clipboard Toggle word wrap
Update metadata of an image's location.

Positional arguments

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

Optional arguments

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

8.4.16. glance md-namespace-create (v2)
Copy link

usage: glance --os-image-api-version 2 md-namespace-create <NAMESPACE> <unavailable>
Copy to Clipboard Toggle word wrap
Create a new metadata definitions namespace.

Positional arguments

<NAMESPACE>
Name of the namespace.
<unavailable>
Please run with connection parameters set to retrieve the schema for generating help for this command

8.4.17. glance md-namespace-delete (v2)
Copy link

usage: glance --os-image-api-version 2 md-namespace-delete <NAMESPACE>
Copy to Clipboard Toggle word wrap
Delete specified metadata definitions namespace with its contents.

Positional arguments

<NAMESPACE>
Name of namespace to delete.

8.4.18. glance md-namespace-import (v2)
Copy link

usage: glance --os-image-api-version 2 md-namespace-import [--file <FILEPATH>]
Copy to Clipboard Toggle word wrap
Import a metadata definitions namespace from file or standard input.

Optional arguments

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

8.4.19. glance md-namespace-list (v2)
Copy link

usage: glance --os-image-api-version 2 md-namespace-list [--resource-types <RESOURCE_TYPES>] [--visibility <VISIBILITY>] [--page-size <SIZE>]
Copy to Clipboard Toggle word wrap
List metadata definitions namespaces.

Optional arguments

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

8.4.20. glance md-namespace-objects-delete (v2)
Copy link

usage: glance --os-image-api-version 2 md-namespace-objects-delete <NAMESPACE>
Copy to Clipboard Toggle word wrap
Delete all metadata definitions objects inside a specific namespace.

Positional arguments

<NAMESPACE>
Name of namespace.

8.4.21. glance md-namespace-properties-delete (v2)
Copy link

usage: glance --os-image-api-version 2 md-namespace-properties-delete <NAMESPACE>
Copy to Clipboard Toggle word wrap
Delete all metadata definitions property inside a specific namespace.

Positional arguments

<NAMESPACE>
Name of namespace. 
usage: glance --os-image-api-version 2 md-namespace-resource-type-list <NAMESPACE>
Copy to Clipboard Toggle word wrap
List resource types associated to specific namespace.

Positional arguments

<NAMESPACE>
Name of namespace.

8.4.23. glance md-namespace-show (v2)
Copy link

usage: glance --os-image-api-version 2 md-namespace-show [--resource-type <RESOURCE_TYPE>] [--max-column-width <integer>] <NAMESPACE>
Copy to Clipboard Toggle word wrap
Describe a specific metadata definitions namespace. Lists also the namespace properties, objects and resource type associations.

Positional arguments

<NAMESPACE>
Name of namespace to describe.

Optional arguments

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

8.4.24. glance md-namespace-tags-delete (v2)
Copy link

usage: glance --os-image-api-version 2 md-namespace-tags-delete <NAMESPACE>
Copy to Clipboard Toggle word wrap
Delete all metadata definitions tags inside a specific namespace.

Positional arguments

<NAMESPACE>
Name of namespace.

8.4.25. glance md-namespace-update (v2)
Copy link

usage: glance --os-image-api-version 2 md-namespace-update <NAMESPACE> <unavailable>
Copy to Clipboard Toggle word wrap
Update an existing metadata definitions namespace.

Positional arguments

<NAMESPACE>
Name of namespace to update.
<unavailable>
Please run with connection parameters set to retrieve the schema for generating help for this command

8.4.26. glance md-object-create (v2)
Copy link

usage: glance --os-image-api-version 2 md-object-create --name <NAME> --schema <SCHEMA> <NAMESPACE>
Copy to Clipboard Toggle word wrap
Create a new metadata definitions object inside a namespace.

Positional arguments

<NAMESPACE>
Name of namespace the object will belong.

Optional arguments

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

8.4.27. glance md-object-delete (v2)
Copy link

usage: glance --os-image-api-version 2 md-object-delete <NAMESPACE> <OBJECT>
Copy to Clipboard Toggle word wrap
Delete a specific metadata definitions object inside a namespace.

Positional arguments

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

8.4.28. glance md-object-list (v2)
Copy link

usage: glance --os-image-api-version 2 md-object-list <NAMESPACE>
Copy to Clipboard Toggle word wrap
List metadata definitions objects inside a specific namespace.

Positional arguments

<NAMESPACE>
Name of namespace.

8.4.29. glance md-object-property-show (v2)
Copy link

usage: glance --os-image-api-version 2 md-object-property-show [--max-column-width <integer>] <NAMESPACE> <OBJECT> <PROPERTY>
Copy to Clipboard Toggle word wrap
Describe a specific metadata definitions property inside an object.

Positional arguments

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

Optional arguments

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

8.4.30. glance md-object-show (v2)
Copy link

usage: glance --os-image-api-version 2 md-object-show [--max-column-width <integer>] <NAMESPACE> <OBJECT>
Copy to Clipboard Toggle word wrap
Describe a specific metadata definitions object inside a namespace.

Positional arguments

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

Optional arguments

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

8.4.31. glance md-object-update (v2)
Copy link

usage: glance --os-image-api-version 2 md-object-update [--name <NAME>] [--schema <SCHEMA>] <NAMESPACE> <OBJECT>
Copy to Clipboard Toggle word wrap
Update metadata definitions object inside a namespace.

Positional arguments

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

Optional arguments

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

8.4.32. glance md-property-create (v2)
Copy link

usage: glance --os-image-api-version 2 md-property-create --name <NAME> --title <TITLE> --schema <SCHEMA> <NAMESPACE>
Copy to Clipboard Toggle word wrap
Create a new metadata definitions property inside a namespace.

Positional arguments

<NAMESPACE>
Name of namespace the property will belong.

Optional arguments

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

8.4.33. glance md-property-delete (v2)
Copy link

usage: glance --os-image-api-version 2 md-property-delete <NAMESPACE> <PROPERTY>
Copy to Clipboard Toggle word wrap
Delete a specific metadata definitions property inside a namespace.

Positional arguments

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

8.4.34. glance md-property-list (v2)
Copy link

usage: glance --os-image-api-version 2 md-property-list <NAMESPACE>
Copy to Clipboard Toggle word wrap
List metadata definitions properties inside a specific namespace.

Positional arguments

<NAMESPACE>
Name of namespace.

8.4.35. glance md-property-show (v2)
Copy link

usage: glance --os-image-api-version 2 md-property-show [--max-column-width <integer>] <NAMESPACE> <PROPERTY>
Copy to Clipboard Toggle word wrap
Describe a specific metadata definitions property inside a namespace.

Positional arguments

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

Optional arguments

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

8.4.36. glance md-property-update (v2)
Copy link

usage: glance --os-image-api-version 2 md-property-update [--name <NAME>] [--title <TITLE>] [--schema <SCHEMA>] <NAMESPACE> <PROPERTY>
Copy to Clipboard Toggle word wrap
Update metadata definitions property inside a namespace.

Positional arguments

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

Optional arguments

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

8.4.37. glance md-resource-type-associate (v2)
Copy link

usage: glance --os-image-api-version 2 md-resource-type-associate <NAMESPACE> <unavailable>
Copy to Clipboard Toggle word wrap
Associate resource type with a metadata definitions namespace.

Positional arguments

<NAMESPACE>
Name of namespace.
<unavailable>
Please run with connection parameters set to retrieve the schema for generating help for this command

8.4.38. glance md-resource-type-deassociate (v2)
Copy link

usage: glance --os-image-api-version 2 md-resource-type-deassociate <NAMESPACE> <RESOURCE_TYPE>
Copy to Clipboard Toggle word wrap
Deassociate resource type with a metadata definitions namespace.

Positional arguments

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

8.4.39. glance md-resource-type-list (v2)
Copy link

usage: glance --os-image-api-version 2 md-resource-type-list
Copy to Clipboard Toggle word wrap
List available resource type names.

8.4.40. glance md-tag-create (v2)
Copy link

usage: glance --os-image-api-version 2 md-tag-create --name <NAME> <NAMESPACE>
Copy to Clipboard Toggle word wrap
Add a new metadata definitions tag inside a namespace.

Positional arguments

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

Optional arguments

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

8.4.41. glance md-tag-create-multiple (v2)
Copy link

usage: glance --os-image-api-version 2 md-tag-create-multiple --names <NAMES> [--delim <DELIM>] <NAMESPACE>
Copy to Clipboard Toggle word wrap
Create new metadata definitions tags inside a namespace.

Positional arguments

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

Optional arguments

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

8.4.42. glance md-tag-delete (v2)
Copy link

usage: glance --os-image-api-version 2 md-tag-delete <NAMESPACE> <TAG>
Copy to Clipboard Toggle word wrap
Delete a specific metadata definitions tag inside a namespace.

Positional arguments

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

8.4.43. glance md-tag-list (v2)
Copy link

usage: glance --os-image-api-version 2 md-tag-list <NAMESPACE>
Copy to Clipboard Toggle word wrap
List metadata definitions tags inside a specific namespace.

Positional arguments

<NAMESPACE>
Name of namespace.

8.4.44. glance md-tag-show (v2)
Copy link

usage: glance --os-image-api-version 2 md-tag-show <NAMESPACE> <TAG>
Copy to Clipboard Toggle word wrap
Describe a specific metadata definitions tag inside a namespace.

Positional arguments

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

8.4.45. glance md-tag-update (v2)
Copy link

usage: glance --os-image-api-version 2 md-tag-update --name <NAME> <NAMESPACE> <TAG>
Copy to Clipboard Toggle word wrap
Rename a metadata definitions tag inside a namespace.

Positional arguments

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

Optional arguments

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

8.4.46. glance member-create (v2)
Copy link

usage: glance --os-image-api-version 2 member-create <IMAGE_ID> <MEMBER_ID>
Copy to Clipboard Toggle word wrap
Create member for a given image.

Positional arguments

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

8.4.47. glance member-delete (v2)
Copy link

usage: glance --os-image-api-version 2 member-delete <IMAGE_ID> <MEMBER_ID>
Copy to Clipboard Toggle word wrap
Delete image member.

Positional arguments

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

8.4.48. glance member-list (v2)
Copy link

usage: glance --os-image-api-version 2 member-list --image-id <IMAGE_ID>
Copy to Clipboard Toggle word wrap
Describe sharing permissions by image.

Optional arguments

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

8.4.49. glance member-update (v2)
Copy link

usage: glance --os-image-api-version 2 member-update <IMAGE_ID> <MEMBER_ID> <MEMBER_STATUS>
Copy to Clipboard Toggle word wrap
Update the status of a member for a given image.

Positional arguments

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

8.4.50. glance task-create (v2)
Copy link

usage: glance --os-image-api-version 2 task-create [--type <TYPE>] [--input <STRING>]
Copy to Clipboard Toggle word wrap
Create a new task.

Optional arguments

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

8.4.51. glance task-list (v2)
Copy link

usage: glance --os-image-api-version 2 task-list [--sort-key {id,type,status}] [--sort-dir {asc,desc}] [--page-size <SIZE>] [--type <TYPE>] [--status <STATUS>]
Copy to Clipboard Toggle word wrap
List tasks you can access.

Optional arguments

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

8.4.52. glance task-show (v2)
Copy link

usage: glance --os-image-api-version 2 task-show <TASK_ID>
Copy to Clipboard Toggle word wrap
Describe a specific task.

Positional arguments

<TASK_ID>
ID of task to describe.

8.5. Image Service property keys
Copy link

The following keys, together with the components to which they are specific, can be used with the property option for both the glance image-update and glance image-create commands. For example: 
$ glance image-update IMG-UUID --property architecture=x86_64
Copy to Clipboard Toggle word wrap
Note
Behavior set using image properties overrides behavior set using flavors. For more information, refer to the Red Hat OpenStack Platform Cloud Admin Guide.
Expand
Table 8.1. Property keys
Specific to Key Description Supported values
All architecture The CPU architecture that must be supported by the hypervisor. For example, x86_64, arm, or ppc64. Run uname -m to get the architecture of a machine. We strongly recommend using the architecture data vocabulary defined by the libosinfo project for this purpose.
All hypervisor_type The hypervisor type. xen, qemu, kvm, lxc, uml, vmware, or hyperv
All instance_uuid For snapshot images, this is the UUID of the server used to create this image. Valid server UUID
All kernel_id The ID of an image stored in the Image Service that should be used as the kernel when booting an AMI-style image. Valid image ID
All os_distro The common name of the operating system distribution in lowercase (uses the same data vocabulary as the libosinfo project). Specify only a recognized value for this field. Deprecated values are listed to assist you in searching for the recognized value.
  • arch—Arch Linux. Do not use archlinux or org.archlinux
  • centos—Community Enterprise Operating System. Do not use org.centos or CentOS
  • debian—Debian. Do not use Debian or org.debian
  • fedora—Fedora. Do not use Fedora, org.fedora, or org.fedoraproject
  • freebsd—FreeBSD. Do not use org.freebsd, freeBSD, or FreeBSD
  • gentoo—Gentoo Linux. Do not use Gentoo or org.gentoo
  • mandrake—Mandrakelinux (MandrakeSoft) distribution. Do not use mandrakelinux or MandrakeLinux
  • mandriva—Mandriva Linux. Do not use mandrivalinux
  • mes—Mandriva Enterprise Server. Do not use mandrivaent or mandrivaES
  • msdos—Microsoft Disc Operating System. Do not use ms-dos
  • netbsd—NetBSD. Do not use NetBSD or org.netbsd
  • netware—Novell NetWare. Do not use novell or NetWare
  • openbsd—OpenBSD. Do not use OpenBSD or org.openbsd
  • opensolaris—OpenSolaris. Do not use OpenSolaris or org.opensolaris
  • opensuse—openSUSE. Do not use suse, SuSE, or org.opensuse
  • rhel—Red Hat Enterprise Linux. Do not use redhat, RedHat, or com.redhat
  • sled—SUSE Linux Enterprise Desktop. Do not use com.suse
  • ubuntu—Ubuntu. Do not use Ubuntu, com.ubuntu, org.ubuntu, or canonical
  • windows—Microsoft Windows. Do not use com.microsoft.server
All os_version The operating system version as specified by the distributor. Version number (for example, "11.10")
All ramdisk_id The ID of image stored in the Image Service that should be used as the ramdisk when booting an AMI-style image. Valid image ID
All vm_mode The virtual machine mode. This represents the host/guest ABI (application binary interface) used for the virtual machine.
  • hvm—Fully virtualized. This is the mode used by QEMU and KVM.
  • xen—Xen 3.0 paravirtualized.
  • uml—User Mode Linux paravirtualized.
  • exe—Executables in containers. This is the mode used by LXC.
libvirt API driver hw_disk_bus Specifies the type of disk controller to attach disk devices to. One of scsi, virtio, uml, xen, ide, or usb.
libvirt API driver
hw_rng_model
Adds a random-number generator device to the image's instances. The cloud administrator can enable and control device behavior by configuring the instance's flavor. By default:
  • The generator device is disabled.
  • /dev/random is used as the default entropy source. To specify a physical HW RNG device, use the following option in the nova.conf file: 
    rng_dev_path=/dev/hwrng
    Copy to Clipboard Toggle word wrap
virtio, or other supported device.
libvirt API driver hw_machine_type Enables booting an ARM system using the specified machine type. By default, if an ARM image is used and its type is not specified, Compute uses vexpress-a15 (for ARMv7) or virt (for AArch64) machine types. Libvirt machine type. Valid types can be viewed by using the virsh capabilities command (machine types are displayed in the machine tag).
libvirt API driver hw_scsi_model Enables the use of VirtIO SCSI (virtio-scsi) to provide block device access for compute instances; by default, instances use VirtIO Block (virtio-blk). VirtIO SCSI is a para-virtualized SCSI controller device that provides improved scalability and performance, and supports advanced SCSI hardware. virtio-scsi
libvirt API driver hw_video_model The video image driver used. vga, cirrus, vmvga, xen, or qxl
libvirt API driver hw_video_ram Maximum RAM for the video image. Used only if a hw_video:ram_max_mb value has been set in the flavor's extra_specs and that value is higher than the value set in hw_video_ram. Integer in MB (for example, '64')
libvirt API driver hw_watchdog_action Enables a virtual hardware watchdog device that carries out the specified action if the server hangs. The watchdog uses the i6300esb device (emulating a PCI Intel 6300ESB). If hw_watchdog_action is not specified, the watchdog is disabled.
  • disabled—(default) The device is not attached. Allows the user to disable the watchdog for the image, even if it has been enabled using the image's flavor.
  • reset—Forcefully reset the guest.
  • poweroff—Forcefully power off the guest.
  • pause—Pause the guest.
  • none—Only enable the watchdog; do nothing if the server hangs.
libvirt API driver os_command_line The kernel command line to be used by the libvirt driver, instead of the default. For linux containers (LXC), the value is used as arguments for initialization. This key is valid only for Amazon kernel, ramdisk, or machine images (aki, ari, or ami).
libvirt API driver and VMware API driver hw_vif_model Specifies the model of virtual network interface device to use.
The valid options depend on the configured hypervisor.
  • KVM and QEMU: e1000, ne2k_pci, pcnet, rtl8139, and virtio.
  • VMware: e1000, e1000e, VirtualE1000, VirtualE1000e, VirtualPCNet32, VirtualSriovEthernetCard, and VirtualVmxnet.
  • Xen: e1000, netfront, ne2k_pci, pcnet, and rtl8139.
VMware API driver vmware_adaptertype The virtual SCSI or IDE controller used by the hypervisor. lsiLogic, busLogic, or ide
VMware API driver vmware_ostype A VMware GuestID which describes the operating system installed in the image. This value is passed to the hypervisor when creating a virtual machine. If not specified, the key defaults to otherGuest. See thinkvirt.com.
VMware API driver vmware_image_version Currently unused. 1
XenAPI driver auto_disk_config If true, the root partition on the disk is automatically resized before the instance boots. This value is only taken into account by the Compute service when using a Xen-based hypervisor with the XenAPI driver. The Compute service will only attempt to resize if there is a single partition on the image, and only if the partition is in ext3 or ext4 format. true | false
XenAPI driver os_type The operating system installed on the image. The XenAPI driver contains logic that takes different actions depending on the value of the os_type parameter of the image. For example, for os_type=windows images, it creates a FAT32-based swap partition instead of a Linux swap partition, and it limits the injected host name to less than 16 characters. linux or windows

Chapter 9. Networking service command-line client
Copy link

The neutron client is the command-line interface (CLI) for the Networking service API and its extensions. This chapter documents neutron version 4.1.1.
For help on a specific neutron command, enter: 
$ neutron help COMMAND
Copy to Clipboard Toggle word wrap

9.1. neutron usage
Copy link

usage: neutron [--version] [-v] [-q] [-h] [-r NUM] [--os-service-type <os-service-type>] [--os-endpoint-type <os-endpoint-type>] [--service-type <service-type>] [--endpoint-type <endpoint-type>] [--os-auth-strategy <auth-strategy>] [--os-cloud <cloud>] [--os-auth-url <auth-url>] [--os-tenant-name <auth-tenant-name> | --os-project-name <auth-project-name>] [--os-tenant-id <auth-tenant-id> | --os-project-id <auth-project-id>] [--os-username <auth-username>] [--os-user-id <auth-user-id>] [--os-user-domain-id <auth-user-domain-id>] [--os-user-domain-name <auth-user-domain-name>] [--os-project-domain-id <auth-project-domain-id>] [--os-project-domain-name <auth-project-domain-name>] [--os-cert <certificate>] [--os-cacert <ca-certificate>] [--os-key <key>] [--os-password <auth-password>] [--os-region-name <auth-region-name>] [--os-token <token>] [--http-timeout <seconds>] [--os-url <url>] [--insecure]
Copy to Clipboard Toggle word wrap

9.2. neutron optional arguments
Copy link

--version
show program's version number and exit
-v, --verbose, --debug
Increase verbosity of output and show tracebacks on errors. You can repeat this option.
-q, --quiet
Suppress output except warnings and errors.
-h, --help
Show this help message and exit.
-r NUM, --retries NUM
How many times the request to the Neutron server should be retried if it fails.
--os-service-type <os-service-type>
Defaults to env[OS_NETWORK_SERVICE_TYPE] or network.
--os-endpoint-type <os-endpoint-type>
Defaults to env[OS_ENDPOINT_TYPE] or public.
--service-type <service-type>
DEPRECATED! Use --os-service-type.
--endpoint-type <endpoint-type>
DEPRECATED! Use --os-endpoint-type.
--os-auth-strategy <auth-strategy>
DEPRECATED! Only keystone is supported.
--os-cloud <cloud>
Defaults to env[OS_CLOUD].
--os-auth-url <auth-url>
Authentication URL, defaults to env[OS_AUTH_URL].
--os-tenant-name <auth-tenant-name>
Authentication tenant name, defaults to env[OS_TENANT_NAME].
--os-project-name <auth-project-name>
Another way to specify tenant name. This option is mutually exclusive with --os-tenant-name. Defaults to env[OS_PROJECT_NAME].
--os-tenant-id <auth-tenant-id>
Authentication tenant ID, defaults to env[OS_TENANT_ID].
--os-project-id <auth-project-id>
Another way to specify tenant ID. This option is mutually exclusive with --os-tenant-id. Defaults to env[OS_PROJECT_ID].
--os-username <auth-username>
Authentication username, defaults to env[OS_USERNAME].
--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-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-cert <certificate>
Path of certificate file to use in SSL connection. This file can optionally be prepended with the private key. Defaults to env[OS_CERT].
--os-cacert <ca-certificate>
Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to env[OS_CACERT].
--os-key <key>
Path of client key to use in SSL connection. This option is not necessary if your key is prepended to your certificate file. Defaults to env[OS_KEY].
--os-password <auth-password>
Authentication password, defaults to env[OS_PASSWORD].
--os-region-name <auth-region-name>
Authentication region name, defaults to env[OS_REGION_NAME].
--os-token <token>
Authentication token, defaults to env[OS_TOKEN].
--http-timeout <seconds>
Timeout in seconds to wait for an HTTP response. Defaults to env[OS_NETWORK_TIMEOUT] or None if not specified.
--os-url <url>
Defaults to env[OS_URL].
--insecure
Explicitly allow neutronclient to perform "insecure" SSL (https) requests. The server's certificate will not be verified against any certificate authorities. This option should be used with caution.

9.3. neutron API v2.0 commands
Copy link

address-scope-create
Create an address scope for a given tenant.
address-scope-delete
Delete an address scope.
address-scope-list
List address scopes that belong to a given tenant.
address-scope-show
Show information about an address scope.
address-scope-update
Update an address scope.
agent-delete
Delete a given agent.
agent-list
List agents.
agent-show
Show information of a given agent.
agent-update
Updates the admin status and description for a specified agent.
auto-allocated-topology-show
Show the auto-allocated topology of a given tenant.
availability-zone-list
List availability zones.
bash-completion
Prints all of the commands and options for bash-completion.
bgp-dragent-list-hosting-speaker
List Dynamic Routing agents hosting a BGP speaker.
bgp-dragent-speaker-add
Add a BGP speaker to a Dynamic Routing agent.
bgp-dragent-speaker-remove
Removes a BGP speaker from a Dynamic Routing agent.
bgp-peer-create
Create a BGP Peer.
bgp-peer-delete
Delete a BGP peer.
bgp-peer-list
List BGP peers.
bgp-peer-show
Show information of a given BGP peer.
bgp-peer-update
Update BGP Peer's information.
bgp-speaker-advertiseroute-list
List routes advertised by a given BGP speaker.
bgp-speaker-create
Create a BGP Speaker.
bgp-speaker-delete
Delete a BGP speaker.
bgp-speaker-list
List BGP speakers.
bgp-speaker-list-on-dragent
List BGP speakers hosted by a Dynamic Routing agent.
bgp-speaker-network-add
Add a network to the BGP speaker.
bgp-speaker-network-remove
Remove a network from the BGP speaker.
bgp-speaker-peer-add
Add a peer to the BGP speaker.
bgp-speaker-peer-remove
Remove a peer from the BGP speaker.
bgp-speaker-show
Show information of a given BGP speaker.
bgp-speaker-update
Update BGP Speaker's information.
dhcp-agent-list-hosting-net
List DHCP agents hosting a network.
dhcp-agent-network-add
Add a network to a DHCP agent.
dhcp-agent-network-remove
Remove a network from a DHCP agent.
ext-list
List all extensions.
ext-show
Show information of a given resource.
firewall-create
Create a firewall.
firewall-delete
Delete a given firewall.
firewall-list
List firewalls that belong to a given tenant.
firewall-policy-create
Create a firewall policy.
firewall-policy-delete
Delete a given firewall policy.
firewall-policy-insert-rule
Insert a rule into a given firewall policy.
firewall-policy-list
List firewall policies that belong to a given tenant.
firewall-policy-remove-rule
Remove a rule from a given firewall policy.
firewall-policy-show
Show information of a given firewall policy.
firewall-policy-update
Update a given firewall policy.
firewall-rule-create
Create a firewall rule.
firewall-rule-delete
Delete a given firewall rule.
firewall-rule-list
List firewall rules that belong to a given tenant.
firewall-rule-show
Show information of a given firewall rule.
firewall-rule-update
Update a given firewall rule.
firewall-show
Show information of a given firewall.
firewall-update
Update a given firewall.
flavor-associate
Associate a Neutron service flavor with a flavor profile.
flavor-create
Create a Neutron service flavor.
flavor-delete
Delete a given Neutron service flavor.
flavor-disassociate
Disassociate a Neutron service flavor from a flavor profile.
flavor-list
List Neutron service flavors.
flavor-profile-create
Create a Neutron service flavor profile.
flavor-profile-delete
Delete a given Neutron service flavor profile.
flavor-profile-list
List Neutron service flavor profiles.
flavor-profile-show
Show information about a given Neutron service flavor profile.
flavor-profile-update
Update a given Neutron service flavor profile.
flavor-show
Show information about a given Neutron service flavor.
flavor-update
Update a Neutron service flavor.
floatingip-associate
Create a mapping between a floating IP and a fixed IP.
floatingip-create
Create a floating IP for a given tenant.
floatingip-delete
Delete a given floating IP.
floatingip-disassociate
Remove a mapping from a floating IP to a fixed IP.
floatingip-list
List floating IPs that belong to a given tenant.
floatingip-show
Show information of a given floating IP.
gateway-device-create
Create a network gateway device.
gateway-device-delete
Delete a given network gateway device.
gateway-device-list
List network gateway devices for a given tenant.
gateway-device-show
Show information for a given network gateway device.
gateway-device-update
Update a network gateway device.
help
print detailed help for another command
ipsec-site-connection-create
Create an IPsec site connection.
ipsec-site-connection-delete
Delete a given IPsec site connection.
ipsec-site-connection-list
List IPsec site connections that belong to a given tenant.
ipsec-site-connection-show
Show information of a given IPsec site connection.
ipsec-site-connection-update
Update a given IPsec site connection.
l3-agent-list-hosting-router
List L3 agents hosting a router.
l3-agent-router-add
Add a router to a L3 agent.
l3-agent-router-remove
Remove a router from a L3 agent.
lb-agent-hosting-pool
Get loadbalancer agent hosting a pool.
lb-healthmonitor-associate
Create a mapping between a health monitor and a pool.
lb-healthmonitor-create
Create a health monitor.
lb-healthmonitor-delete
Delete a given health monitor.
lb-healthmonitor-disassociate
Remove a mapping from a health monitor to a pool.
lb-healthmonitor-list
List health monitors that belong to a given tenant.
lb-healthmonitor-show
Show information of a given health monitor.
lb-healthmonitor-update
Update a given health monitor.
lb-member-create
Create a member.
lb-member-delete
Delete a given member.
lb-member-list
List members that belong to a given tenant.
lb-member-show
Show information of a given member.
lb-member-update
Update a given member.
lb-pool-create
Create a pool.
lb-pool-delete
Delete a given pool.
lb-pool-list
List pools that belong to a given tenant.
lb-pool-list-on-agent
List the pools on a loadbalancer agent.
lb-pool-show
Show information of a given pool.
lb-pool-stats
Retrieve stats for a given pool.
lb-pool-update
Update a given pool.
lb-vip-create
Create a vip.
lb-vip-delete
Delete a given vip.
lb-vip-list
List vips that belong to a given tenant.
lb-vip-show
Show information of a given vip.
lb-vip-update
Update a given vip.
lbaas-agent-hosting-loadbalancer
Get lbaas v2 agent hosting a loadbalancer.
lbaas-healthmonitor-create
LBaaS v2 Create a healthmonitor.
lbaas-healthmonitor-delete
LBaaS v2 Delete a given healthmonitor.
lbaas-healthmonitor-list
LBaaS v2 List healthmonitors that belong to a given tenant.
lbaas-healthmonitor-show
LBaaS v2 Show information of a given healthmonitor.
lbaas-healthmonitor-update
LBaaS v2 Update a given healthmonitor.
lbaas-l7policy-create
LBaaS v2 Create L7 policy.
lbaas-l7policy-delete
LBaaS v2 Delete a given L7 policy.
lbaas-l7policy-list
LBaaS v2 List L7 policies that belong to a given listener.
lbaas-l7policy-show
LBaaS v2 Show information of a given L7 policy.
lbaas-l7policy-update
LBaaS v2 Update a given L7 policy.
lbaas-l7rule-create
LBaaS v2 Create L7 rule.
lbaas-l7rule-delete
LBaaS v2 Delete a given L7 rule.
lbaas-l7rule-list
LBaaS v2 List L7 rules that belong to a given L7 policy.
lbaas-l7rule-show
LBaaS v2 Show information of a given rule.
lbaas-l7rule-update
LBaaS v2 Update a given L7 rule.
lbaas-listener-create
LBaaS v2 Create a listener.
lbaas-listener-delete
LBaaS v2 Delete a given listener.
lbaas-listener-list
LBaaS v2 List listeners that belong to a given tenant.
lbaas-listener-show
LBaaS v2 Show information of a given listener.
lbaas-listener-update
LBaaS v2 Update a given listener.
lbaas-loadbalancer-create
LBaaS v2 Create a loadbalancer.
lbaas-loadbalancer-delete
LBaaS v2 Delete a given loadbalancer.
lbaas-loadbalancer-list
LBaaS v2 List loadbalancers that belong to a given tenant.
lbaas-loadbalancer-list-on-agent
List the loadbalancers on a loadbalancer v2 agent.
lbaas-loadbalancer-show
LBaaS v2 Show information of a given loadbalancer.
lbaas-loadbalancer-stats
Retrieve stats for a given loadbalancer.
lbaas-loadbalancer-status
Retrieve status for a given loadbalancer.
lbaas-loadbalancer-update
LBaaS v2 Update a given loadbalancer.
lbaas-member-create
LBaaS v2 Create a member.
lbaas-member-delete
LBaaS v2 Delete a given member.
lbaas-member-list
LBaaS v2 List members that belong to a given pool.
lbaas-member-show
LBaaS v2 Show information of a given member.
lbaas-member-update
LBaaS v2 Update a given member.
lbaas-pool-create
LBaaS v2 Create a pool.
lbaas-pool-delete
LBaaS v2 Delete a given pool.
lbaas-pool-list
LBaaS v2 List pools that belong to a given tenant.
lbaas-pool-show
LBaaS v2 Show information of a given pool.
lbaas-pool-update
LBaaS v2 Update a given pool.
meter-label-create
Create a metering label for a given tenant.
meter-label-delete
Delete a given metering label.
meter-label-list
List metering labels that belong to a given tenant.
meter-label-rule-create
Create a metering label rule for a given label.
meter-label-rule-delete
Delete a given metering label.
meter-label-rule-list
List metering labels that belong to a given label.
meter-label-rule-show
Show information of a given metering label rule.
meter-label-show
Show information of a given metering label.
net-create
Create a network for a given tenant.
net-delete
Delete a given network.
net-external-list
List external networks that belong to a given tenant.
net-gateway-connect
Add an internal network interface to a router.
net-gateway-create
Create a network gateway.
net-gateway-delete
Delete a given network gateway.
net-gateway-disconnect
Remove a network from a network gateway.
net-gateway-list
List network gateways for a given tenant.
net-gateway-show
Show information of a given network gateway.
net-gateway-update
Update the name for a network gateway.
net-ip-availability-list
List IP usage of networks
net-ip-availability-show
Show IP usage of specific network
net-list
List networks that belong to a given tenant.
net-list-on-dhcp-agent
List the networks on a DHCP agent.
net-show
Show information of a given network.
net-update
Update network's information.
network-template-assignments-create
[bsn_extensions] Create a Network Template Assignment.
network-template-assignments-delete
[bsn_extensions] Delete a Network Template Assignment.
network-template-assignments-list
[bsn_extensions] List Network Template Assignments
network-template-assignments-show
[bsn_extensions] Show a Network Template Assignment.
network-template-assignments-update
[bsn_extensions] Update a Network Template Assignment.
network-templates-create
[bsn_extensions] Create a Network Template.
network-templates-delete
[bsn_extensions] Delete a network template.
network-templates-list
[bsn_extensions] List Network Templates
network-templates-show
[bsn_extensions] Show a network template.
network-templates-update
[bsn_extensions] Update a network template.
port-create
Create a port for a given tenant.
port-delete
Delete a given port.
port-list
List ports that belong to a given tenant.
port-show
Show information of a given port.
port-update
Update port's information.
purge
qos-available-rule-types
List available qos rule types.
qos-bandwidth-limit-rule-create
Create a qos bandwidth limit rule.
qos-bandwidth-limit-rule-delete
Delete a given qos bandwidth limit rule.
qos-bandwidth-limit-rule-list
List all qos bandwidth limit rules belonging to the specified policy.
qos-bandwidth-limit-rule-show
Show information about the given qos bandwidth limit rule.
qos-bandwidth-limit-rule-update
Update the given qos bandwidth limit rule.
qos-policy-create
Create a qos policy.
qos-policy-delete
Delete a given qos policy.
qos-policy-list
List QoS policies that belong to a given tenant connection.
qos-policy-show
Show information of a given qos policy.
qos-policy-update
Update a given qos policy.
queue-create
Create a queue.
queue-delete
Delete a given queue.
queue-list
List queues that belong to a given tenant.
queue-show
Show information of a given queue.
quota-delete
Delete defined quotas of a given tenant.
quota-list
List quotas of all tenants who have non-default quota values.
quota-show
Show quotas of a given tenant.
quota-update
Define tenant's quotas not to use defaults.
rbac-create
Create a RBAC policy for a given tenant.
rbac-delete
Delete a RBAC policy.
rbac-list
List RBAC policies that belong to a given tenant.
rbac-show
Show information of a given RBAC policy.
rbac-update
Update RBAC policy for given tenant.
reachability-quick-tests-create
[bsn_extensions] Create a Reachability Quick Test.
reachability-quick-tests-delete
[bsn_extensions] Delete a Reachability Quick Test.
reachability-quick-tests-list
[bsn_extensions] List Reachability Quick Tests.
reachability-quick-tests-run
[bsn_extensions] Run a Reachability Quick Test.
reachability-quick-tests-show
[bsn_extensions] Show a Reachability Quick Test.
reachability-quick-tests-update
[bsn_extensions] Update a Reachability Quick Test.
reachability-tests-create
[bsn_extensions] Create a Reachability Test.
reachability-tests-delete
[bsn_extensions] Delete a Reachability Test.
reachability-tests-list
[bsn_extensions] List Reachability Tests.
reachability-tests-run
[bsn_extensions] Run a Reachability Test.
reachability-tests-show
[bsn_extensions] Show a Reachability Test.
reachability-tests-update
[bsn_extensions] Update a Reachability Test.
router-create
Create a router for a given tenant.
router-delete
Delete a given router.
router-gateway-clear
Remove an external network gateway from a router.
router-gateway-set
Set the external network gateway for a router.
router-interface-add
Add an internal network interface to a router.
router-interface-delete
Remove an internal network interface from a router.
router-list
List routers that belong to a given tenant.
router-list-on-l3-agent
List the routers on a L3 agent.
router-port-list
List ports that belong to a given tenant, with specified router.
router-show
Show information of a given router.
router-update
Update router's information.
security-group-create
Create a security group.
security-group-delete
Delete a given security group.
security-group-list
List security groups that belong to a given tenant.
security-group-rule-create
Create a security group rule.
security-group-rule-delete
Delete a given security group rule.
security-group-rule-list
List security group rules that belong to a given tenant.
security-group-rule-show
Show information of a given security group rule.
security-group-show
Show information of a given security group.
security-group-update
Update a given security group.
service-provider-list
List service providers.
subnet-create
Create a subnet for a given tenant.
subnet-delete
Delete a given subnet.
subnet-list
List subnets that belong to a given tenant.
subnet-show
Show information of a given subnet.
subnet-update
Update subnet's information.
subnetpool-create
Create a subnetpool for a given tenant.
subnetpool-delete
Delete a given subnetpool.
subnetpool-list
List subnetpools that belong to a given tenant.
subnetpool-show
Show information of a given subnetpool.
subnetpool-update
Update subnetpool's information.
tag-add
Add a tag into the resource.
tag-remove
Remove a tag on the resource.
tag-replace
Replace all tags on the resource.
vpn-endpoint-group-create
Create a VPN endpoint group.
vpn-endpoint-group-delete
Delete a given VPN endpoint group.
vpn-endpoint-group-list
List VPN endpoint groups that belong to a given tenant.
vpn-endpoint-group-show
Show a specific VPN endpoint group.
vpn-endpoint-group-update
Update a given VPN endpoint group.
vpn-ikepolicy-create
Create an IKE policy.
vpn-ikepolicy-delete
Delete a given IKE policy.
vpn-ikepolicy-list
List IKE policies that belong to a tenant.
vpn-ikepolicy-show
Show information of a given IKE policy.
vpn-ikepolicy-update
Update a given IKE policy.
vpn-ipsecpolicy-create
Create an IPsec policy.
vpn-ipsecpolicy-delete
Delete a given IPsec policy.
vpn-ipsecpolicy-list
List IPsec policies that belong to a given tenant connection.
vpn-ipsecpolicy-show
Show information of a given IPsec policy.
vpn-ipsecpolicy-update
Update a given IPsec policy.
vpn-service-create
Create a VPN service.
vpn-service-delete
Delete a given VPN service.
vpn-service-list
List VPN service configurations that belong to a given tenant.
vpn-service-show
Show information of a given VPN service.
vpn-service-update
Update a given VPN service.

9.4. neutron address-scope-create
Copy link

usage: neutron address-scope-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--shared] NAME IP_VERSION
Copy to Clipboard Toggle word wrap
Create an address scope for a given tenant.

Positional arguments

NAME
Specify the name of the address scope.
IP_VERSION
Specify the address family of the address scope.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--shared
Set the address scope as shared.

9.5. neutron address-scope-delete
Copy link

usage: neutron address-scope-delete [-h] [--request-format {json}] ADDRESS_SCOPE
Copy to Clipboard Toggle word wrap
Delete an address scope.

Positional arguments

ADDRESS_SCOPE
ID or name of address_scope to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.6. neutron address-scope-show
Copy link

usage: neutron address-scope-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] ADDRESS_SCOPE
Copy to Clipboard Toggle word wrap
Show information about an address scope.

Positional arguments

ADDRESS_SCOPE
ID or name of address_scope to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.7. neutron address-scope-update
Copy link

usage: neutron address-scope-update [-h] [--request-format {json}] [--name NAME] ADDRESS_SCOPE
Copy to Clipboard Toggle word wrap
Update an address scope.

Positional arguments

ADDRESS_SCOPE
ID or name of address_scope to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--name NAME
Name of the address scope to update.

9.8. neutron agent-delete
Copy link

usage: neutron agent-delete [-h] [--request-format {json}] AGENT
Copy to Clipboard Toggle word wrap
Delete a given agent.

Positional arguments

AGENT
ID of agent to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.9. neutron agent-show
Copy link

usage: neutron agent-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] AGENT
Copy to Clipboard Toggle word wrap
Show information of a given agent.

Positional arguments

AGENT
ID of agent to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.10. neutron agent-update
Copy link

usage: neutron agent-update [-h] [--request-format {json}] [--admin-state-down] [--description DESCRIPTION] AGENT
Copy to Clipboard Toggle word wrap
Updates the admin status and description for a specified agent.

Positional arguments

AGENT
ID of agent to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--admin-state-down
Set admin state up of the agent to false.
--description DESCRIPTION
Description for the agent.

9.11. neutron bgp-dragent-list-hosting-speaker
Copy link

usage: neutron bgp-dragent-list-hosting-speaker [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] BGP_SPEAKER
Copy to Clipboard Toggle word wrap
List Dynamic Routing agents hosting a BGP speaker.

Positional arguments

BGP_SPEAKER
ID or name of the BGP speaker.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.12. neutron bgp-dragent-speaker-add
Copy link

usage: neutron bgp-dragent-speaker-add [-h] [--request-format {json}] BGP_DRAGENT_ID BGP_SPEAKER
Copy to Clipboard Toggle word wrap
Add a BGP speaker to a Dynamic Routing agent.

Positional arguments

BGP_DRAGENT_ID
ID of the Dynamic Routing agent.
BGP_SPEAKER
ID or name of the BGP speaker.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.13. neutron bgp-dragent-speaker-remove
Copy link

usage: neutron bgp-dragent-speaker-remove [-h] [--request-format {json}] BGP_DRAGENT_ID BGP_SPEAKER
Copy to Clipboard Toggle word wrap
Removes a BGP speaker from a Dynamic Routing agent.

Positional arguments

BGP_DRAGENT_ID
ID of the Dynamic Routing agent.
BGP_SPEAKER
ID or name of the BGP speaker.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.14. neutron bgp-peer-create
Copy link

usage: neutron bgp-peer-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] --peer-ip PEER_IP_ADDRESS --remote-as PEER_REMOTE_AS [--auth-type PEER_AUTH_TYPE] [--password AUTH_PASSWORD] NAME
Copy to Clipboard Toggle word wrap
Create a BGP Peer.

Positional arguments

NAME
Name of the BGP peer to create.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--peer-ip PEER_IP_ADDRESS
Peer IP address.
--remote-as PEER_REMOTE_AS
Peer AS number. (Integer in [1, 65535] is allowed.)
--auth-type PEER_AUTH_TYPE
Authentication algorithm. Supported algorithms: none(default), md5
--password AUTH_PASSWORD
Authentication password.

9.15. neutron bgp-peer-delete
Copy link

usage: neutron bgp-peer-delete [-h] [--request-format {json}] BGP_PEER
Copy to Clipboard Toggle word wrap
Delete a BGP peer.

Positional arguments

BGP_PEER
ID or name of bgp_peer to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.16. neutron bgp-peer-show
Copy link

usage: neutron bgp-peer-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] BGP_PEER
Copy to Clipboard Toggle word wrap
Show information of a given BGP peer.

Positional arguments

BGP_PEER
ID or name of bgp_peer to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.17. neutron bgp-peer-update
Copy link

usage: neutron bgp-peer-update [-h] [--request-format {json}] [--name NAME] [--password AUTH_PASSWORD] BGP_PEER
Copy to Clipboard Toggle word wrap
Update BGP Peer's information.

Positional arguments

BGP_PEER
ID or name of bgp_peer to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--name NAME
Updated name of the BGP peer.
--password AUTH_PASSWORD
Updated authentication password.

9.18. neutron bgp-speaker-advertiseroute-list
Copy link

usage: neutron bgp-speaker-advertiseroute-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}] BGP_SPEAKER
Copy to Clipboard Toggle word wrap
List routes advertised by a given BGP speaker.

Positional arguments

BGP_SPEAKER
ID or name of the BGP speaker.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can repeat this option.

9.19. neutron bgp-speaker-create
Copy link

usage: neutron bgp-speaker-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] --local-as LOCAL_AS [--ip-version {4,6}] [--advertise-floating-ip-host-routes {True,False}] [--advertise-tenant-networks {True,False}] NAME
Copy to Clipboard Toggle word wrap
Create a BGP Speaker.

Positional arguments

NAME
Name of the BGP speaker to create.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--local-as LOCAL_AS
Local AS number. (Integer in [1, 65535] is allowed.)
--ip-version {4,6} IP
version for the BGP speaker (default is 4).
--advertise-floating-ip-host-routes {True,False}
Whether to enable or disable the advertisement of floating-ip host routes by the BGP speaker. By default floating ip host routes will be advertised by the BGP speaker.
--advertise-tenant-networks {True,False}
Whether to enable or disable the advertisement of tenant network routes by the BGP speaker. By default tenant network routes will be advertised by the BGP speaker.

9.20. neutron bgp-speaker-delete
Copy link

usage: neutron bgp-speaker-delete [-h] [--request-format {json}] BGP_SPEAKER
Copy to Clipboard Toggle word wrap
Delete a BGP speaker.

Positional arguments

BGP_SPEAKER
ID or name of bgp_speaker to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.21. neutron bgp-speaker-list-on-dragent
Copy link

usage: neutron bgp-speaker-list-on-dragent [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] BGP_DRAGENT_ID
Copy to Clipboard Toggle word wrap
List BGP speakers hosted by a Dynamic Routing agent.

Positional arguments

BGP_DRAGENT_ID
ID of the Dynamic Routing agent.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.22. neutron bgp-speaker-network-add
Copy link

usage: neutron bgp-speaker-network-add [-h] [--request-format {json}] BGP_SPEAKER NETWORK
Copy to Clipboard Toggle word wrap
Add a network to the BGP speaker.

Positional arguments

BGP_SPEAKER
ID or name of the BGP speaker.
NETWORK
ID or name of the network to add.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.23. neutron bgp-speaker-network-remove
Copy link

usage: neutron bgp-speaker-network-remove [-h] [--request-format {json}] BGP_SPEAKER NETWORK
Copy to Clipboard Toggle word wrap
Remove a network from the BGP speaker.

Positional arguments

BGP_SPEAKER
ID or name of the BGP speaker.
NETWORK
ID or name of the network to remove.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.24. neutron bgp-speaker-peer-add
Copy link

usage: neutron bgp-speaker-peer-add [-h] [--request-format {json}] BGP_SPEAKER BGP_PEER
Copy to Clipboard Toggle word wrap
Add a peer to the BGP speaker.

Positional arguments

BGP_SPEAKER
ID or name of the BGP speaker.
BGP_PEER
ID or name of the BGP peer to add.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.25. neutron bgp-speaker-peer-remove
Copy link

usage: neutron bgp-speaker-peer-remove [-h] [--request-format {json}] BGP_SPEAKER BGP_PEER
Copy to Clipboard Toggle word wrap
Remove a peer from the BGP speaker.

Positional arguments

BGP_SPEAKER
ID or name of the BGP speaker.
BGP_PEER
ID or name of the BGP peer to remove.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.26. neutron bgp-speaker-show
Copy link

usage: neutron bgp-speaker-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] BGP_SPEAKER
Copy to Clipboard Toggle word wrap
Show information of a given BGP speaker.

Positional arguments

BGP_SPEAKER
ID or name of bgp_speaker to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.27. neutron bgp-speaker-update
Copy link

usage: neutron bgp-speaker-update [-h] [--request-format {json}] [--name NAME] [--advertise-floating-ip-host-routes {True,False}] [--advertise-tenant-networks {True,False}] BGP_SPEAKER
Copy to Clipboard Toggle word wrap
Update BGP Speaker's information.

Positional arguments

BGP_SPEAKER
ID or name of bgp_speaker to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--name NAME
Name of the BGP speaker to update.
--advertise-floating-ip-host-routes {True,False}
Whether to enable or disable the advertisement of floating-ip host routes by the BGP speaker. By default floating ip host routes will be advertised by the BGP speaker.
--advertise-tenant-networks {True,False}
Whether to enable or disable the advertisement of tenant network routes by the BGP speaker. By default tenant network routes will be advertised by the BGP speaker.

9.28. neutron dhcp-agent-list-hosting-net
Copy link

usage: neutron dhcp-agent-list-hosting-net [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] NETWORK
Copy to Clipboard Toggle word wrap
List DHCP agents hosting a network.

Positional arguments

NETWORK
Network to query.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.29. neutron dhcp-agent-network-add
Copy link

usage: neutron dhcp-agent-network-add [-h] [--request-format {json}] DHCP_AGENT NETWORK
Copy to Clipboard Toggle word wrap
Add a network to a DHCP agent.

Positional arguments

DHCP_AGENT
ID of the DHCP agent.
NETWORK
Network to add.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.30. neutron dhcp-agent-network-remove
Copy link

usage: neutron dhcp-agent-network-remove [-h] [--request-format {json}] DHCP_AGENT NETWORK
Copy to Clipboard Toggle word wrap
Remove a network from a DHCP agent.

Positional arguments

DHCP_AGENT
ID of the DHCP agent.
NETWORK
Network to remove.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.31. neutron ext-show
Copy link

usage: neutron ext-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] EXTENSION
Copy to Clipboard Toggle word wrap
Show information of a given resource.

Positional arguments

EXTENSION
ID of extension to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.32. neutron firewall-create
Copy link

usage: neutron firewall-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--name NAME] [--description DESCRIPTION] [--router ROUTER | --no-routers] [--admin-state-down] POLICY
Copy to Clipboard Toggle word wrap
Create a firewall.

Positional arguments

POLICY
Firewall policy name or ID.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--name NAME
Name for the firewall.
--description DESCRIPTION
Description for the firewall.
--router ROUTER
Firewall associated router name or ID (requires FWaaS router insertion extension, this option can be repeated)
--no-routers
Associate no routers with the firewall (requires FWaaS router insertion extension)
--admin-state-down
Set admin state up to false.

9.33. neutron firewall-delete
Copy link

usage: neutron firewall-delete [-h] [--request-format {json}] FIREWALL
Copy to Clipboard Toggle word wrap
Delete a given firewall.

Positional arguments

FIREWALL
ID or name of firewall to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.34. neutron firewall-policy-create
Copy link

usage: neutron firewall-policy-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--shared] [--audited] [--description DESCRIPTION] [--firewall-rules FIREWALL_RULES] NAME
Copy to Clipboard Toggle word wrap
Create a firewall policy.

Positional arguments

NAME
Name for the firewall policy.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--shared
Create a shared policy.
--audited
Sets audited to True.
--description DESCRIPTION
Description for the firewall policy.
--firewall-rules FIREWALL_RULES
Ordered list of whitespace-delimited firewall rule names or IDs; e.g., --firewall-rules "rule1 rule2"

9.35. neutron firewall-policy-delete
Copy link

usage: neutron firewall-policy-delete [-h] [--request-format {json}] FIREWALL_POLICY
Copy to Clipboard Toggle word wrap
Delete a given firewall policy.

Positional arguments

FIREWALL_POLICY
ID or name of firewall_policy to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.36. neutron firewall-policy-insert-rule
Copy link

usage: neutron firewall-policy-insert-rule [-h] [--request-format {json}] [--insert-before FIREWALL_RULE] [--insert-after FIREWALL_RULE] FIREWALL_POLICY FIREWALL_RULE
Copy to Clipboard Toggle word wrap
Insert a rule into a given firewall policy.

Positional arguments

FIREWALL_POLICY
ID or name of firewall_policy to update.
FIREWALL_RULE
New rule to insert.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--insert-before FIREWALL_RULE
Insert before this rule.
--insert-after FIREWALL_RULE
Insert after this rule.

9.37. neutron firewall-policy-remove-rule
Copy link

usage: neutron firewall-policy-remove-rule [-h] [--request-format {json}] FIREWALL_POLICY FIREWALL_RULE
Copy to Clipboard Toggle word wrap
Remove a rule from a given firewall policy.

Positional arguments

FIREWALL_POLICY
ID or name of firewall_policy to update.
FIREWALL_RULE
Firewall rule to remove from policy.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.38. neutron firewall-policy-show
Copy link

usage: neutron firewall-policy-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] FIREWALL_POLICY
Copy to Clipboard Toggle word wrap
Show information of a given firewall policy.

Positional arguments

FIREWALL_POLICY
ID or name of firewall_policy to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.39. neutron firewall-policy-update
Copy link

usage: neutron firewall-policy-update [-h] [--request-format {json}] [--description DESCRIPTION] [--firewall-rules FIREWALL_RULES] [--name NAME] [--shared {True,False}] [--audited {True,False}] FIREWALL_POLICY
Copy to Clipboard Toggle word wrap
Update a given firewall policy.

Positional arguments

FIREWALL_POLICY
ID or name of firewall_policy to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--description DESCRIPTION
Description for the firewall policy.
--firewall-rules FIREWALL_RULES
Ordered list of whitespace-delimited firewall rule names or IDs; e.g., --firewall-rules "rule1 rule2"
--name NAME
Name for the firewall policy.
--shared {True,False}
Update the sharing status of the policy. (True means shared)
--audited {True,False}
Update the audit status of the policy. (True means auditing is enabled)

9.40. neutron firewall-rule-delete
Copy link

usage: neutron firewall-rule-delete [-h] [--request-format {json}] FIREWALL_RULE
Copy to Clipboard Toggle word wrap
Delete a given firewall rule.

Positional arguments

FIREWALL_RULE
ID or name of firewall_rule to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.41. neutron firewall-rule-show
Copy link

usage: neutron firewall-rule-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] FIREWALL_RULE
Copy to Clipboard Toggle word wrap
Show information of a given firewall rule.

Positional arguments

FIREWALL_RULE
ID or name of firewall_rule to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.42. neutron firewall-rule-update
Copy link

usage: neutron firewall-rule-update [-h] [--request-format {json}] [--shared {True,False}] [--ip-version {4,6}] [--name NAME] [--description DESCRIPTION] [--source-ip-address SOURCE_IP_ADDRESS] [--destination-ip-address DESTINATION_IP_ADDRESS] [--source-port SOURCE_PORT] [--destination-port DESTINATION_PORT] [--enabled {True,False}] [--protocol {tcp,udp,icmp,any}] [--action {allow,deny,reject}] FIREWALL_RULE
Copy to Clipboard Toggle word wrap
Update a given firewall rule.

Positional arguments

FIREWALL_RULE
ID or name of firewall_rule to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--shared {True,False}
Update the shared flag for the firewall rule.
--ip-version {4,6}
Update IP version for the firewall rule.
--name NAME
Name for the firewall rule.
--description DESCRIPTION
Description for the firewall rule.
--source-ip-address SOURCE_IP_ADDRESS
Source IP address or subnet.
--destination-ip-address DESTINATION_IP_ADDRESS
Destination IP address or subnet.
--source-port SOURCE_PORT
Source port (integer in [1, 65535] or range in a:b).
--destination-port DESTINATION_PORT
Destination port (integer in [1, 65535] or range in a:b).
--enabled {True,False}
Whether to enable or disable this rule.
--protocol {tcp,udp,icmp,any}
Protocol for the firewall rule.
--action {allow,deny,reject}
Action for the firewall rule.

9.43. neutron firewall-show
Copy link

usage: neutron firewall-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] FIREWALL
Copy to Clipboard Toggle word wrap
Show information of a given firewall.

Positional arguments

FIREWALL
ID or name of firewall to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.44. neutron firewall-update
Copy link

usage: neutron firewall-update [-h] [--request-format {json}] [--name NAME] [--description DESCRIPTION] [--router ROUTER | --no-routers] [--policy POLICY] [--admin-state-up {True,False}] FIREWALL
Copy to Clipboard Toggle word wrap
Update a given firewall.

Positional arguments

FIREWALL
ID or name of firewall to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--name NAME
Name for the firewall.
--description DESCRIPTION
Description for the firewall.
--router ROUTER
Firewall associated router name or ID (requires FWaaS router insertion extension, this option can be repeated)
--no-routers
Associate no routers with the firewall (requires FWaaS router insertion extension)
--policy POLICY
Firewall policy name or ID.
--admin-state-up {True,False}
Update the admin state for the firewall(True means UP)

9.45. neutron flavor-associate
Copy link

usage: neutron flavor-associate [-h] [--request-format {json}] FLAVOR FLAVOR_PROFILE
Copy to Clipboard Toggle word wrap
Associate a Neutron service flavor with a flavor profile.

Positional arguments

FLAVOR
Name or ID of the flavor to associate.
FLAVOR_PROFILE
ID of the flavor profile to be associated with the flavor.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.46. neutron flavor-create
Copy link

usage: neutron flavor-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--description DESCRIPTION] [--enabled {True,False}] NAME SERVICE_TYPE
Copy to Clipboard Toggle word wrap
Create a Neutron service flavor.

Positional arguments

NAME
Name for the flavor.
SERVICE_TYPE
Service type to which the flavor applies to: e.g. VPN. (See service-provider-list for loaded examples.)

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--description DESCRIPTION
Description for the flavor.
--enabled {True,False}
Sets enabled flag.

9.47. neutron flavor-delete
Copy link

usage: neutron flavor-delete [-h] [--request-format {json}] FLAVOR
Copy to Clipboard Toggle word wrap
Delete a given Neutron service flavor.

Positional arguments

FLAVOR
ID or name of flavor to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.48. neutron flavor-disassociate
Copy link

usage: neutron flavor-disassociate [-h] [--request-format {json}] FLAVOR FLAVOR_PROFILE
Copy to Clipboard Toggle word wrap
Disassociate a Neutron service flavor from a flavor profile.

Positional arguments

FLAVOR
Name or ID of the flavor.
FLAVOR_PROFILE
ID of the flavor profile to be disassociated from the flavor.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.49. neutron flavor-profile-delete
Copy link

usage: neutron flavor-profile-delete [-h] [--request-format {json}] SERVICE_PROFILE
Copy to Clipboard Toggle word wrap
Delete a given Neutron service flavor profile.

Positional arguments

SERVICE_PROFILE
ID or name of service_profile to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.50. neutron flavor-profile-show
Copy link

usage: neutron flavor-profile-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] SERVICE_PROFILE
Copy to Clipboard Toggle word wrap
Show information about a given Neutron service flavor profile.

Positional arguments

SERVICE_PROFILE
ID or name of service_profile to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.51. neutron flavor-profile-update
Copy link

usage: neutron flavor-profile-update [-h] [--request-format {json}] [--description DESCRIPTION] [--driver DRIVER] [--metainfo METAINFO] [--enabled {True,False}] SERVICE_PROFILE
Copy to Clipboard Toggle word wrap
Update a given Neutron service flavor profile.

Positional arguments

SERVICE_PROFILE
ID or name of service_profile to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--description DESCRIPTION
Description for the flavor profile.
--driver DRIVER
Python module path to driver.
--metainfo METAINFO
Metainfo for the flavor profile.
--enabled {True,False}
Sets enabled flag.

9.52. neutron flavor-show
Copy link

usage: neutron flavor-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] FLAVOR
Copy to Clipboard Toggle word wrap
Show information about a given Neutron service flavor.

Positional arguments

FLAVOR
ID or name of flavor to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.53. neutron flavor-update
Copy link

usage: neutron flavor-update [-h] [--request-format {json}] [--name NAME] [--description DESCRIPTION] [--enabled {True,False}] FLAVOR
Copy to Clipboard Toggle word wrap
Update a Neutron service flavor.

Positional arguments

FLAVOR
ID or name of flavor to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--name NAME
Name for the flavor.
--description DESCRIPTION
Description for the flavor.
--enabled {True,False}
Sets enabled flag.

9.54. neutron floatingip-associate
Copy link

usage: neutron floatingip-associate [-h] [--request-format {json}] [--fixed-ip-address FIXED_IP_ADDRESS] FLOATINGIP_ID PORT
Copy to Clipboard Toggle word wrap
Create a mapping between a floating IP and a fixed IP.

Positional arguments

FLOATINGIP_ID
ID of the floating IP to associate.
PORT
ID or name of the port to be associated with the floating IP.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--fixed-ip-address FIXED_IP_ADDRESS
IP address on the port (only required if port has multiple IPs).

9.55. neutron floatingip-create
Copy link

usage: neutron floatingip-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--port-id PORT_ID] [--fixed-ip-address FIXED_IP_ADDRESS] [--floating-ip-address FLOATING_IP_ADDRESS] [--subnet SUBNET_ID] [--dns-domain DNS_DOMAIN] [--dns-name DNS_NAME] FLOATING_NETWORK
Copy to Clipboard Toggle word wrap
Create a floating IP for a given tenant.

Positional arguments

FLOATING_NETWORK
Network name or ID to allocate floating IP from.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--port-id PORT_ID
ID of the port to be associated with the floating IP.
--fixed-ip-address FIXED_IP_ADDRESS
IP address on the port (only required if port has multiple IPs).
--floating-ip-address FLOATING_IP_ADDRESS
IP address of the floating IP
--subnet SUBNET_ID
Subnet ID on which you want to create the floating IP.
--dns-domain DNS_DOMAIN
Assign DNS domain to the floatingip (requires DNS integration extension)
--dns-name DNS_NAME
Assign DNS name to the floatingip (requires DNS integration extension)

9.56. neutron floatingip-delete
Copy link

usage: neutron floatingip-delete [-h] [--request-format {json}] FLOATINGIP
Copy to Clipboard Toggle word wrap
Delete a given floating IP.

Positional arguments

FLOATINGIP
ID of floatingip to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.57. neutron floatingip-disassociate
Copy link

usage: neutron floatingip-disassociate [-h] [--request-format {json}] FLOATINGIP_ID
Copy to Clipboard Toggle word wrap
Remove a mapping from a floating IP to a fixed IP.

Positional arguments

FLOATINGIP_ID
ID of the floating IP to disassociate.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.58. neutron floatingip-show
Copy link

usage: neutron floatingip-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] FLOATINGIP
Copy to Clipboard Toggle word wrap
Show information of a given floating IP.

Positional arguments

FLOATINGIP
ID of floatingip to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.59. neutron gateway-device-create
Copy link

usage: neutron gateway-device-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--connector-type {stt,gre,ipsecgre,ipsecstt,bridge,ipsec_gre,ipsec_stt}] --connector-ip CONNECTOR_IP (--client-certificate CERT_DATA | --client-certificate-file CERT_FILE) NAME
Copy to Clipboard Toggle word wrap
Create a network gateway device.

Positional arguments

NAME
Name of network gateway device to create.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--connector-type {stt,gre,ipsecgre,ipsecstt,bridge,ipsec_gre,ipsec_stt}
Type of the transport zone connector to use for this device. Valid values are gre, stt, ipsec_gre, ipsec_stt, and bridge. Defaults to stt. ipsecgre and ipsecstt are also accepted as alternative names
--connector-ip CONNECTOR_IP
IP address for this device's transport connector. It must correspond to the IP address of the interface used for tenant traffic on the NSX gateway node.
--client-certificate CERT_DATA
PEM certificate used by the NSX gateway transport node to authenticate with the NSX controller.
--client-certificate-file CERT_FILE
File containing the PEM certificate used by the NSX gateway transport node to authenticate with the NSX controller.

9.60. neutron gateway-device-delete
Copy link

usage: neutron gateway-device-delete [-h] [--request-format {json}] GATEWAY_DEVICE
Copy to Clipboard Toggle word wrap
Delete a given network gateway device.

Positional arguments

GATEWAY_DEVICE
ID or name of gateway_device to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.61. neutron gateway-device-show
Copy link

usage: neutron gateway-device-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] GATEWAY_DEVICE
Copy to Clipboard Toggle word wrap
Show information for a given network gateway device.

Positional arguments

GATEWAY_DEVICE
ID or name of gateway_device to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.62. neutron gateway-device-update
Copy link

usage: neutron gateway-device-update [-h] [--request-format {json}] [--name NAME] [--connector-type {stt,gre,ipsecgre,ipsecstt,bridge,ipsec_gre,ipsec_stt}] [--connector-ip CONNECTOR_IP] [--client-certificate CERT_DATA | --client-certificate-file CERT_FILE] GATEWAY_DEVICE
Copy to Clipboard Toggle word wrap
Update a network gateway device.

Positional arguments

GATEWAY_DEVICE
ID or name of gateway_device to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--name NAME
New name for network gateway device.
--connector-type {stt,gre,ipsecgre,ipsecstt,bridge,ipsec_gre,ipsec_stt}
Type of the transport zone connector to use for this device. Valid values are gre, stt, ipsec_gre, ipsec_stt, and bridge. Defaults to stt. ipsecgre and ipsecstt are also accepted as alternative names
--connector-ip CONNECTOR_IP
IP address for this device's transport connector. It must correspond to the IP address of the interface used for tenant traffic on the NSX gateway node.
--client-certificate CERT_DATA
PEM certificate used by the NSX gateway transport node to authenticate with the NSX controller.
--client-certificate-file CERT_FILE
File containing the PEM certificate used by the NSX gateway transport node to authenticate with the NSX controller.

9.63. neutron ipsec-site-connection-delete
Copy link

usage: neutron ipsec-site-connection-delete [-h] [--request-format {json}] IPSEC_SITE_CONNECTION
Copy to Clipboard Toggle word wrap
Delete a given IPsec site connection.

Positional arguments

IPSEC_SITE_CONNECTION
ID or name of IPsec site connection to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.64. neutron ipsec-site-connection-show
Copy link

usage: neutron ipsec-site-connection-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] IPSEC_SITE_CONNECTION
Copy to Clipboard Toggle word wrap
Show information of a given IPsec site connection.

Positional arguments

IPSEC_SITE_CONNECTION
ID or name of IPsec site connection to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.65. neutron ipsec-site-connection-update
Copy link

usage: neutron ipsec-site-connection-update [-h] [--request-format {json}] [--dpd action=ACTION,interval=INTERVAL,timeout=TIMEOUT] [--local-ep-group LOCAL_EP_GROUP] [--peer-ep-group PEER_EP_GROUP] IPSEC_SITE_CONNECTION
Copy to Clipboard Toggle word wrap
Update a given IPsec site connection.

Positional arguments

IPSEC_SITE_CONNECTION
ID or name of IPsec site connection to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--dpd
action=ACTION,interval=INTERVAL,timeout=TIMEOUT Ipsec connection. Dead Peer Detection attributes. 'action'-hold,clear,disabled,restart,restart-by-peer. 'interval' and 'timeout' are non negative integers. 'interval' should be less than 'timeout' value. 'action', default:hold 'interval', default:30, 'timeout', default:120.
--local-ep-group LOCAL_EP_GROUP
Local endpoint group ID/name with subnet(s) for IPSec connection.
--peer-ep-group PEER_EP_GROUP
Peer endpoint group ID/name with CIDR(s) for IPsec connection.

9.66. neutron l3-agent-list-hosting-router
Copy link

usage: neutron l3-agent-list-hosting-router [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] ROUTER
Copy to Clipboard Toggle word wrap
List L3 agents hosting a router.

Positional arguments

ROUTER
Router to query.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.67. neutron l3-agent-router-add
Copy link

usage: neutron l3-agent-router-add [-h] [--request-format {json}] L3_AGENT ROUTER
Copy to Clipboard Toggle word wrap
Add a router to a L3 agent.

Positional arguments

L3_AGENT
ID of the L3 agent.
ROUTER
Router to add.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.68. neutron l3-agent-router-remove
Copy link

usage: neutron l3-agent-router-remove [-h] [--request-format {json}] L3_AGENT ROUTER
Copy to Clipboard Toggle word wrap
Remove a router from a L3 agent.

Positional arguments

L3_AGENT
ID of the L3 agent.
ROUTER
Router to remove.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.69. neutron lb-agent-hosting-pool
Copy link

usage: neutron lb-agent-hosting-pool [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] POOL
Copy to Clipboard Toggle word wrap
Get loadbalancer agent hosting a pool. Deriving from ListCommand though server will return only one agent to keep common output format for all agent schedulers

Positional arguments

POOL
Pool to query.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.70. neutron lb-healthmonitor-associate
Copy link

usage: neutron lb-healthmonitor-associate [-h] [--request-format {json}] HEALTH_MONITOR_ID POOL
Copy to Clipboard Toggle word wrap
Create a mapping between a health monitor and a pool.

Positional arguments

HEALTH_MONITOR_ID
Health monitor to associate.
POOL
ID of the pool to be associated with the health monitor.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.71. neutron lb-healthmonitor-delete
Copy link

usage: neutron lb-healthmonitor-delete [-h] [--request-format {json}] HEALTH_MONITOR
Copy to Clipboard Toggle word wrap
Delete a given health monitor.

Positional arguments

HEALTH_MONITOR
ID of health_monitor to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.72. neutron lb-healthmonitor-disassociate
Copy link

usage: neutron lb-healthmonitor-disassociate [-h] [--request-format {json}] HEALTH_MONITOR_ID POOL
Copy to Clipboard Toggle word wrap
Remove a mapping from a health monitor to a pool.

Positional arguments

HEALTH_MONITOR_ID
Health monitor to associate.
POOL
ID of the pool to be associated with the health monitor.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.73. neutron lb-healthmonitor-show
Copy link

usage: neutron lb-healthmonitor-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] HEALTH_MONITOR
Copy to Clipboard Toggle word wrap
Show information of a given health monitor.

Positional arguments

HEALTH_MONITOR
ID of health_monitor to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.74. neutron lb-healthmonitor-update
Copy link

usage: neutron lb-healthmonitor-update [-h] [--request-format {json}] HEALTH_MONITOR
Copy to Clipboard Toggle word wrap
Update a given health monitor.

Positional arguments

HEALTH_MONITOR
ID of health_monitor to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.75. neutron lb-member-create
Copy link

usage: neutron lb-member-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--admin-state-down] [--weight WEIGHT] --address ADDRESS --protocol-port PROTOCOL_PORT POOL
Copy to Clipboard Toggle word wrap
Create a member.

Positional arguments

POOL
Pool ID or name this vip belongs to.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--admin-state-down
Set admin state up to false.
--weight WEIGHT
Weight of pool member in the pool (default:1, [0..256]).
--address ADDRESS
IP address of the pool member on the pool network.
--protocol-port PROTOCOL_PORT
Port on which the pool member listens for requests or connections.

9.76. neutron lb-member-delete
Copy link

usage: neutron lb-member-delete [-h] [--request-format {json}] MEMBER
Copy to Clipboard Toggle word wrap
Delete a given member.

Positional arguments

MEMBER
ID or name of member to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.77. neutron lb-member-show
Copy link

usage: neutron lb-member-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] MEMBER
Copy to Clipboard Toggle word wrap
Show information of a given member.

Positional arguments

MEMBER
ID of member to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.78. neutron lb-member-update
Copy link

usage: neutron lb-member-update [-h] [--request-format {json}] MEMBER
Copy to Clipboard Toggle word wrap
Update a given member.

Positional arguments

MEMBER
ID or name of member to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.79. neutron lb-pool-delete
Copy link

usage: neutron lb-pool-delete [-h] [--request-format {json}] POOL
Copy to Clipboard Toggle word wrap
Delete a given pool.

Positional arguments

POOL
ID or name of pool to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.80. neutron lb-pool-list-on-agent
Copy link

usage: neutron lb-pool-list-on-agent [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] LBAAS_AGENT
Copy to Clipboard Toggle word wrap
List the pools on a loadbalancer agent.

Positional arguments

LBAAS_AGENT
ID of the loadbalancer agent to query.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.81. neutron lb-pool-show
Copy link

usage: neutron lb-pool-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] POOL
Copy to Clipboard Toggle word wrap
Show information of a given pool.

Positional arguments

POOL
ID or name of pool to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.82. neutron lb-pool-stats
Copy link

usage: neutron lb-pool-stats [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] POOL
Copy to Clipboard Toggle word wrap
Retrieve stats for a given pool.

Positional arguments

POOL
ID or name of pool to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.83. neutron lb-pool-update
Copy link

usage: neutron lb-pool-update [-h] [--request-format {json}] POOL
Copy to Clipboard Toggle word wrap
Update a given pool.

Positional arguments

POOL
ID or name of pool to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.84. neutron lb-vip-create
Copy link

usage: neutron lb-vip-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--address ADDRESS] [--admin-state-down] [--connection-limit CONNECTION_LIMIT] [--description DESCRIPTION] --name NAME --protocol-port PROTOCOL_PORT --protocol {TCP,HTTP,HTTPS} --subnet-id SUBNET POOL
Copy to Clipboard Toggle word wrap
Create a vip.

Positional arguments

POOL
Pool ID or name this vip belongs to.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--address ADDRESS
IP address of the vip.
--admin-state-down
Set admin state up to false.
--connection-limit CONNECTION_LIMIT
The maximum number of connections per second allowed for the vip. Positive integer or -1 for unlimited (default).
--description DESCRIPTION
Description of the vip.
--name NAME
Name of the vip.
--protocol-port PROTOCOL_PORT
TCP port on which to listen for client traffic that is associated with the vip address.
--protocol {TCP,HTTP,HTTPS}
Protocol for balancing.
--subnet-id SUBNET
The subnet on which to allocate the vip address.

9.85. neutron lb-vip-delete
Copy link

usage: neutron lb-vip-delete [-h] [--request-format {json}] VIP
Copy to Clipboard Toggle word wrap
Delete a given vip.

Positional arguments

VIP
ID or name of vip to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.86. neutron lb-vip-show
Copy link

usage: neutron lb-vip-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] VIP
Copy to Clipboard Toggle word wrap
Show information of a given vip.

Positional arguments

VIP
ID or name of vip to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.87. neutron lb-vip-update
Copy link

usage: neutron lb-vip-update [-h] [--request-format {json}] VIP
Copy to Clipboard Toggle word wrap
Update a given vip.

Positional arguments

VIP
ID or name of vip to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.88. neutron lbaas-agent-hosting-loadbalancer
Copy link

usage: neutron lbaas-agent-hosting-loadbalancer [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] LOADBALANCER
Copy to Clipboard Toggle word wrap
Get lbaas v2 agent hosting a loadbalancer. Deriving from ListCommand though server will return only one agent to keep common output format for all agent schedulers

Positional arguments

LOADBALANCER
LoadBalancer to query.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.89. neutron lbaas-healthmonitor-delete
Copy link

usage: neutron lbaas-healthmonitor-delete [-h] [--request-format {json}] HEALTHMONITOR
Copy to Clipboard Toggle word wrap
LBaaS v2 Delete a given healthmonitor.

Positional arguments

HEALTHMONITOR
ID or name of healthmonitor to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.90. neutron lbaas-healthmonitor-show
Copy link

usage: neutron lbaas-healthmonitor-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] HEALTHMONITOR
Copy to Clipboard Toggle word wrap
LBaaS v2 Show information of a given healthmonitor.

Positional arguments

HEALTHMONITOR
ID or name of healthmonitor to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.91. neutron lbaas-healthmonitor-update
Copy link

usage: neutron lbaas-healthmonitor-update [-h] [--request-format {json}] [--name NAME] HEALTHMONITOR
Copy to Clipboard Toggle word wrap
LBaaS v2 Update a given healthmonitor.

Positional arguments

HEALTHMONITOR
ID or name of healthmonitor to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--name NAME
Updated name of the health monitor.

9.92. neutron lbaas-l7policy-delete
Copy link

usage: neutron lbaas-l7policy-delete [-h] [--request-format {json}] L7POLICY
Copy to Clipboard Toggle word wrap
LBaaS v2 Delete a given L7 policy.

Positional arguments

L7POLICY
ID or name of l7policy to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.93. neutron lbaas-l7policy-show
Copy link

usage: neutron lbaas-l7policy-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] L7POLICY
Copy to Clipboard Toggle word wrap
LBaaS v2 Show information of a given L7 policy.

Positional arguments

L7POLICY
ID or name of l7policy to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.94. neutron lbaas-l7policy-update
Copy link

usage: neutron lbaas-l7policy-update [-h] [--request-format {json}] [--name NAME] [--description DESCRIPTION] [--action ACTION] [--redirect-pool REDIRECT_POOL] [--redirect-url REDIRECT_URL] [--position POSITION] [--admin-state-up {True,False}] L7POLICY
Copy to Clipboard Toggle word wrap
LBaaS v2 Update a given L7 policy.

Positional arguments

L7POLICY
ID or name of l7policy to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--name NAME
Name of the policy.
--description DESCRIPTION
Description of the policy.
--action ACTION
Action type of the policy.
--redirect-pool REDIRECT_POOL
ID or name of the pool for REDIRECT_TO_POOL action type.
--redirect-url REDIRECT_URL
URL for REDIRECT_TO_URL action type. This should be a valid URL string.
--position POSITION
L7 policy position in ordered policies list. This must be an integer starting from 1. Not specifying the position will place the policy at the tail of existing policies list.
--admin-state-up {True,False}
Specify the administrative state of the policy (True meaning "Up").

9.95. neutron lbaas-l7rule-create
Copy link

usage: neutron lbaas-l7rule-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] --type {HOST_NAME,PATH,FILE_TYPE,HEADER,COOKIE} --compare-type {REGEX,STARTS_WITH,ENDS_WITH,CONTAINS,EQUAL_TO} [--invert-compare] [--key KEY] --value VALUE [--admin-state-down] L7POLICY
Copy to Clipboard Toggle word wrap
LBaaS v2 Create L7 rule.

Positional arguments

L7POLICY
ID or name of L7 policy this rule belongs to.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--type {HOST_NAME,PATH,FILE_TYPE,HEADER,COOKIE}
Rule type.
--compare-type {REGEX,STARTS_WITH,ENDS_WITH,CONTAINS,EQUAL_TO}
Rule compare type.
--invert-compare
Invert the compare type.
--key KEY
Key to compare. Relevant for HEADER and COOKIE types only.
--value VALUE
Value to compare.
--admin-state-down
Set admin state up to false

9.96. neutron lbaas-l7rule-delete
Copy link

usage: neutron lbaas-l7rule-delete [-h] [--request-format {json}] RULE L7POLICY
Copy to Clipboard Toggle word wrap
LBaaS v2 Delete a given L7 rule.

Positional arguments

RULE
ID or name of rule to delete.
L7POLICY
ID or name of L7 policy this rule belongs to.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.97. neutron lbaas-l7rule-list
Copy link

usage: neutron lbaas-l7rule-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}] L7POLICY
Copy to Clipboard Toggle word wrap
LBaaS v2 List L7 rules that belong to a given L7 policy.

Positional arguments

L7POLICY
ID or name of L7 policy this rule belongs to.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can repeat this option.

9.98. neutron lbaas-l7rule-show
Copy link

usage: neutron lbaas-l7rule-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] RULE L7POLICY
Copy to Clipboard Toggle word wrap
LBaaS v2 Show information of a given rule.

Positional arguments

RULE
ID or name of rule to look up.
L7POLICY
ID or name of L7 policy this rule belongs to.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.99. neutron lbaas-l7rule-update
Copy link

usage: neutron lbaas-l7rule-update [-h] [--request-format {json}] [--type {HOST_NAME,PATH,FILE_TYPE,HEADER,COOKIE}] [--compare-type {REGEX,STARTS_WITH,ENDS_WITH,CONTAINS,EQUAL_TO}] [--invert-compare] [--key KEY] [--value VALUE] [--admin-state-up {True,False}] RULE L7POLICY
Copy to Clipboard Toggle word wrap
LBaaS v2 Update a given L7 rule.

Positional arguments

RULE
ID or name of rule to update.
L7POLICY
ID or name of L7 policy this rule belongs to.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--type {HOST_NAME,PATH,FILE_TYPE,HEADER,COOKIE}
Rule type.
--compare-type {REGEX,STARTS_WITH,ENDS_WITH,CONTAINS,EQUAL_TO}
Rule compare type.
--invert-compare
Invert the compare type.
--key KEY
Key to compare. Relevant for HEADER and COOKIE types only.
--value VALUE
Value to compare.
--admin-state-up {True,False}
Specify the administrative state of the rule (True meaning "Up").

9.100. neutron lbaas-listener-delete
Copy link

usage: neutron lbaas-listener-delete [-h] [--request-format {json}] LISTENER
Copy to Clipboard Toggle word wrap
LBaaS v2 Delete a given listener.

Positional arguments

LISTENER
ID or name of listener to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.101. neutron lbaas-listener-show
Copy link

usage: neutron lbaas-listener-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] LISTENER
Copy to Clipboard Toggle word wrap
LBaaS v2 Show information of a given listener.

Positional arguments

LISTENER
ID or name of listener to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.102. neutron lbaas-listener-update
Copy link

usage: neutron lbaas-listener-update [-h] [--request-format {json}] LISTENER
Copy to Clipboard Toggle word wrap
LBaaS v2 Update a given listener.

Positional arguments

LISTENER
ID of listener to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.103. neutron lbaas-loadbalancer-create
Copy link

usage: neutron lbaas-loadbalancer-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--description DESCRIPTION] [--admin-state-down] [--name NAME] [--provider PROVIDER] [--flavor FLAVOR] [--vip-address VIP_ADDRESS] VIP_SUBNET
Copy to Clipboard Toggle word wrap
LBaaS v2 Create a loadbalancer.

Positional arguments

VIP_SUBNET
Load balancer VIP subnet.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--description DESCRIPTION
Description of the load balancer.
--admin-state-down
Set admin state up to false.
--name NAME
Name of the load balancer.
--provider PROVIDER
Provider name of load balancer service.
--flavor FLAVOR
ID or name of flavor.
--vip-address VIP_ADDRESS
VIP address for the load balancer.

9.104. neutron lbaas-loadbalancer-delete
Copy link

usage: neutron lbaas-loadbalancer-delete [-h] [--request-format {json}] LOADBALANCER
Copy to Clipboard Toggle word wrap
LBaaS v2 Delete a given loadbalancer.

Positional arguments

LOADBALANCER
ID or name of loadbalancer to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.105. neutron lbaas-loadbalancer-list-on-agent
Copy link

usage: neutron lbaas-loadbalancer-list-on-agent [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] LBAAS_AGENT
Copy to Clipboard Toggle word wrap
List the loadbalancers on a loadbalancer v2 agent.

Positional arguments

LBAAS_AGENT
ID of the loadbalancer agent to query.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.106. neutron lbaas-loadbalancer-show
Copy link

usage: neutron lbaas-loadbalancer-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] LOADBALANCER
Copy to Clipboard Toggle word wrap
LBaaS v2 Show information of a given loadbalancer.

Positional arguments

LOADBALANCER
ID or name of loadbalancer to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.107. neutron lbaas-loadbalancer-stats
Copy link

usage: neutron lbaas-loadbalancer-stats [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] LOADBALANCER
Copy to Clipboard Toggle word wrap
Retrieve stats for a given loadbalancer.

Positional arguments

LOADBALANCER
ID or name of loadbalancer to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.108. neutron lbaas-loadbalancer-status
Copy link

usage: neutron lbaas-loadbalancer-status [-h] [--request-format {json}] LOADBALANCER
Copy to Clipboard Toggle word wrap
Retrieve status for a given loadbalancer. The only output is a formatted JSON tree, and the table format does not support this type of data.

Positional arguments

LOADBALANCER
ID or name of loadbalancer to show.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.109. neutron lbaas-loadbalancer-update
Copy link

usage: neutron lbaas-loadbalancer-update [-h] [--request-format {json}] LOADBALANCER
Copy to Clipboard Toggle word wrap
LBaaS v2 Update a given loadbalancer.

Positional arguments

LOADBALANCER
ID or name of loadbalancer to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.110. neutron lbaas-member-create
Copy link

usage: neutron lbaas-member-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--admin-state-down] [--weight WEIGHT] [--name NAME] --subnet SUBNET --address ADDRESS --protocol-port PROTOCOL_PORT POOL
Copy to Clipboard Toggle word wrap
LBaaS v2 Create a member.

Positional arguments

POOL
ID or name of the pool that this member belongs to.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--admin-state-down
Set admin state up to false
--weight WEIGHT
Weight of member in the pool (default:1, [0..256]).
--name NAME
Name of the member to be created.
--subnet SUBNET
Subnet ID or name for the member.
--address ADDRESS
IP address of the pool member in the pool.
--protocol-port PROTOCOL_PORT
Port on which the pool member listens for requests or connections.

9.111. neutron lbaas-member-delete
Copy link

usage: neutron lbaas-member-delete [-h] [--request-format {json}] MEMBER POOL
Copy to Clipboard Toggle word wrap
LBaaS v2 Delete a given member.

Positional arguments

MEMBER
ID or name of member to delete.
POOL
ID or name of the pool that this member belongs to.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.112. neutron lbaas-member-list
Copy link

usage: neutron lbaas-member-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}] POOL
Copy to Clipboard Toggle word wrap
LBaaS v2 List members that belong to a given pool.

Positional arguments

POOL
ID or name of the pool that this member belongs to.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can repeat this option.

9.113. neutron lbaas-member-show
Copy link

usage: neutron lbaas-member-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] MEMBER POOL
Copy to Clipboard Toggle word wrap
LBaaS v2 Show information of a given member.

Positional arguments

MEMBER
ID or name of member to look up.
POOL
ID or name of the pool that this member belongs to.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.114. neutron lbaas-member-update
Copy link

usage: neutron lbaas-member-update [-h] [--request-format {json}] [--admin-state-down] [--weight WEIGHT] [--name NAME] MEMBER POOL
Copy to Clipboard Toggle word wrap
LBaaS v2 Update a given member.

Positional arguments

MEMBER
ID or name of member to update.
POOL
ID or name of the pool that this member belongs to

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--admin-state-down
Set admin state up to false
--weight WEIGHT
Weight of member in the pool (default:1, [0..256])
--name NAME
Updated name of the member.

9.115. neutron lbaas-pool-delete
Copy link

usage: neutron lbaas-pool-delete [-h] [--request-format {json}] POOL
Copy to Clipboard Toggle word wrap
LBaaS v2 Delete a given pool.

Positional arguments

POOL
ID or name of pool to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.116. neutron lbaas-pool-show
Copy link

usage: neutron lbaas-pool-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] POOL
Copy to Clipboard Toggle word wrap
LBaaS v2 Show information of a given pool.

Positional arguments

POOL
ID or name of pool to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.117. neutron lbaas-pool-update
Copy link

usage: neutron lbaas-pool-update [-h] [--request-format {json}] POOL
Copy to Clipboard Toggle word wrap
LBaaS v2 Update a given pool.

Positional arguments

POOL
ID or name of pool to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.118. neutron meter-label-create
Copy link

usage: neutron meter-label-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--description DESCRIPTION] [--shared] NAME
Copy to Clipboard Toggle word wrap
Create a metering label for a given tenant.

Positional arguments

NAME
Name of metering label to create.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--description DESCRIPTION
Description of metering label to create.
--shared
Set the label as shared.

9.119. neutron meter-label-delete
Copy link

usage: neutron meter-label-delete [-h] [--request-format {json}] METERING_LABEL
Copy to Clipboard Toggle word wrap
Delete a given metering label.

Positional arguments

METERING_LABEL
ID or name of metering_label to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.120. neutron meter-label-rule-create
Copy link

usage: neutron meter-label-rule-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--direction {ingress,egress}] [--excluded] LABEL REMOTE_IP_PREFIX
Copy to Clipboard Toggle word wrap
Create a metering label rule for a given label.

Positional arguments

LABEL
Id or Name of the label.
REMOTE_IP_PREFIX
CIDR to match on.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--direction {ingress,egress}
Direction of traffic, default: ingress.
--excluded
Exclude this CIDR from the label, default: not excluded.

9.121. neutron meter-label-rule-delete
Copy link

usage: neutron meter-label-rule-delete [-h] [--request-format {json}] METERING_LABEL_RULE
Copy to Clipboard Toggle word wrap
Delete a given metering label.

Positional arguments

METERING_LABEL_RULE
ID or name of metering_label_rule to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.122. neutron meter-label-rule-show
Copy link

usage: neutron meter-label-rule-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] METERING_LABEL_RULE
Copy to Clipboard Toggle word wrap
Show information of a given metering label rule.

Positional arguments

METERING_LABEL_RULE
ID or name of metering_label_rule to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.123. neutron meter-label-show
Copy link

usage: neutron meter-label-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] METERING_LABEL
Copy to Clipboard Toggle word wrap
Show information of a given metering label.

Positional arguments

METERING_LABEL
ID or name of metering_label to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.124. neutron net-create
Copy link

usage: neutron net-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--admin-state-down] [--shared] [--provider:network_type <network_type>] [--provider:physical_network <physical_network_name>] [--provider:segmentation_id <segmentation_id>] [--vlan-transparent {True,False}] [--qos-policy QOS_POLICY] [--availability-zone-hint AVAILABILITY_ZONE] [--dns-domain DNS_DOMAIN] NAME
Copy to Clipboard Toggle word wrap
Create a network for a given tenant.

Positional arguments

NAME
Name of network to create.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--admin-state-down
Set admin state up to false.
--shared
Set the network as shared.
--provider:network_type <network_type>
The physical mechanism by which the virtual network is implemented.
--provider:physical_network <physical_network_name>
Name of the physical network over which the virtual network is implemented.
--provider:segmentation_id <segmentation_id>
VLAN ID for VLAN networks or tunnel-id for GRE/VXLAN networks.
--vlan-transparent {True,False}
Create a vlan transparent network.
--qos-policy QOS_POLICY
Attach QoS policy ID or name to the resource.
--availability-zone-hint AVAILABILITY_ZONE
Availability Zone for the network (requires availability zone extension, this option can be repeated).
--dns-domain DNS_DOMAIN
Assign DNS domain to the network (requires DNS integration extension)

9.125. neutron net-delete
Copy link

usage: neutron net-delete [-h] [--request-format {json}] NETWORK
Copy to Clipboard Toggle word wrap
Delete a given network.

Positional arguments

NETWORK
ID or name of network to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.126. neutron net-gateway-connect
Copy link

usage: neutron net-gateway-connect [-h] [--request-format {json}] [--segmentation-type SEGMENTATION_TYPE] [--segmentation-id SEGMENTATION_ID] NET-GATEWAY-ID NETWORK-ID
Copy to Clipboard Toggle word wrap
Add an internal network interface to a router.

Positional arguments

NET-GATEWAY-ID
ID of the network gateway.
NETWORK-ID
ID of the internal network to connect on the gateway.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--segmentation-type SEGMENTATION_TYPE
L2 segmentation strategy on the external side of the gateway (e.g.: VLAN, FLAT).
--segmentation-id SEGMENTATION_ID
Identifier for the L2 segment on the external side of the gateway.

9.127. neutron net-gateway-create
Copy link

usage: neutron net-gateway-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--device id=ID,interface_name=NAME_OR_ID] NAME
Copy to Clipboard Toggle word wrap
Create a network gateway.

Positional arguments

NAME
Name of network gateway to create.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--device
id=ID,interface_name=NAME_OR_ID Device info for this gateway. You can repeat this option for multiple devices for HA gateways.

9.128. neutron net-gateway-delete
Copy link

usage: neutron net-gateway-delete [-h] [--request-format {json}] NETWORK_GATEWAY
Copy to Clipboard Toggle word wrap
Delete a given network gateway.

Positional arguments

NETWORK_GATEWAY
ID or name of network_gateway to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.129. neutron net-gateway-disconnect
Copy link

usage: neutron net-gateway-disconnect [-h] [--request-format {json}] [--segmentation-type SEGMENTATION_TYPE] [--segmentation-id SEGMENTATION_ID] NET-GATEWAY-ID NETWORK-ID
Copy to Clipboard Toggle word wrap
Remove a network from a network gateway.

Positional arguments

NET-GATEWAY-ID
ID of the network gateway.
NETWORK-ID
ID of the internal network to connect on the gateway.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--segmentation-type SEGMENTATION_TYPE
L2 segmentation strategy on the external side of the gateway (e.g.: VLAN, FLAT).
--segmentation-id SEGMENTATION_ID
Identifier for the L2 segment on the external side of the gateway.

9.130. neutron net-gateway-show
Copy link

usage: neutron net-gateway-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] NETWORK_GATEWAY
Copy to Clipboard Toggle word wrap
Show information of a given network gateway.

Positional arguments

NETWORK_GATEWAY
ID or name of network_gateway to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.131. neutron net-gateway-update
Copy link

usage: neutron net-gateway-update [-h] [--request-format {json}] NETWORK_GATEWAY
Copy to Clipboard Toggle word wrap
Update the name for a network gateway.

Positional arguments

NETWORK_GATEWAY
ID or name of network_gateway to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.132. neutron net-ip-availability-show
Copy link

usage: neutron net-ip-availability-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] NETWORK
Copy to Clipboard Toggle word wrap
Show IP usage of specific network

Positional arguments

NETWORK
ID or name of network to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.133. neutron net-list-on-dhcp-agent
Copy link

usage: neutron net-list-on-dhcp-agent [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}] [--tenant-id TENANT_ID] [--name NAME] [--admin-state-up {True,False}] [--status STATUS] [--shared {True,False}] [--router:external {True,False}] [--tags TAG] [--tags-any TAG] [--not-tags TAG] [--not-tags-any TAG] DHCP_AGENT
Copy to Clipboard Toggle word wrap
List the networks on a DHCP agent.

Positional arguments

DHCP_AGENT
ID of the DHCP agent.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can repeat this option.

9.134. neutron net-show
Copy link

usage: neutron net-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] NETWORK
Copy to Clipboard Toggle word wrap
Show information of a given network.

Positional arguments

NETWORK
ID or name of network to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.135. neutron net-update
Copy link

usage: neutron net-update [-h] [--request-format {json}] [--qos-policy QOS_POLICY | --no-qos-policy] [--dns-domain DNS_DOMAIN | --no-dns-domain] NETWORK
Copy to Clipboard Toggle word wrap
Update network's information.

Positional arguments

NETWORK
ID or name of network to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--qos-policy QOS_POLICY
Attach QoS policy ID or name to the resource.
--no-qos-policy
Detach QoS policy from the resource.
--dns-domain DNS_DOMAIN
Assign DNS domain to the network (requires DNS integration extension.)
--no-dns-domain
Unassign DNS domain from the network (requires DNS integration extension.)

9.136. neutron network-template-assignments-create
Copy link

usage: neutron network-template-assignments-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] template-id stack-id
Copy to Clipboard Toggle word wrap
[bsn_extensions] Create a Network Template Assignment.

Positional arguments

template-id
ID of the network template associated with this tenant.
stack-id
ID of the heat template associated with this tenant.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.

9.137. neutron network-template-assignments-delete
Copy link

usage: neutron network-template-assignments-delete [-h] [--request-format {json}] NETWORKTEMPLATEASSIGNMENT
Copy to Clipboard Toggle word wrap
[bsn_extensions] Delete a Network Template Assignment.

Positional arguments

NETWORKTEMPLATEASSIGNMENT
ID or name of networktemplateassignment to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.138. neutron network-template-assignments-show
Copy link

usage: neutron network-template-assignments-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] NETWORKTEMPLATEASSIGNMENT
Copy to Clipboard Toggle word wrap
[bsn_extensions] Show a Network Template Assignment.

Positional arguments

NETWORKTEMPLATEASSIGNMENT
ID or name of networktemplateassignment to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.139. neutron network-template-assignments-update
Copy link

usage: neutron network-template-assignments-update [-h] [--request-format {json}] NETWORKTEMPLATEASSIGNMENT template-id stack-id
Copy to Clipboard Toggle word wrap
[bsn_extensions] Update a Network Template Assignment.

Positional arguments

NETWORKTEMPLATEASSIGNMENT
ID of networktemplateassignment to update.
template-id
ID of the network template associated with this tenant.
stack-id
ID of the heat template associated with this tenant.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.140. neutron network-templates-create
Copy link

usage: neutron network-templates-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] name body
Copy to Clipboard Toggle word wrap
[bsn_extensions] Create a Network Template.

Positional arguments

name
Name of this network template.
body
Body of this network template.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.

9.141. neutron network-templates-delete
Copy link

usage: neutron network-templates-delete [-h] [--request-format {json}] NETWORKTEMPLATE
Copy to Clipboard Toggle word wrap
[bsn_extensions] Delete a network template.

Positional arguments

NETWORKTEMPLATE
ID or name of networktemplate to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.142. neutron network-templates-show
Copy link

usage: neutron network-templates-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] NETWORKTEMPLATE
Copy to Clipboard Toggle word wrap
[bsn_extensions] Show a network template.

Positional arguments

NETWORKTEMPLATE
ID or name of networktemplate to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.143. neutron network-templates-update
Copy link

usage: neutron network-templates-update [-h] [--request-format {json}] NETWORKTEMPLATE name body
Copy to Clipboard Toggle word wrap
[bsn_extensions] Update a network template.

Positional arguments

NETWORKTEMPLATE
ID or name of networktemplate to update.
name
Name of this network template.
body
Body of this network template.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.144. neutron port-create
Copy link

usage: neutron port-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--name NAME] [--fixed-ip subnet_id=SUBNET,ip_address=IP_ADDR] [--device-id DEVICE_ID] [--device-owner DEVICE_OWNER] [--admin-state-down] [--mac-address MAC_ADDRESS] [--vnic-type <direct | direct-physical | macvtap | normal | baremetal>] [--binding-profile BINDING_PROFILE] [--security-group SECURITY_GROUP | --no-security-groups] [--extra-dhcp-opt EXTRA_DHCP_OPTS] [--qos-policy QOS_POLICY] [--allowed-address-pair ip_address=IP_ADDR[,mac_address=MAC_ADDR] | --no-allowed-address-pairs] [--dns-name DNS_NAME] NETWORK
Copy to Clipboard Toggle word wrap
Create a port for a given tenant.

Positional arguments

NETWORK
Network ID or name this port belongs to.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--name NAME
Name of this port.
--fixed-ip
subnet_id=SUBNET,ip_address=IP_ADDR Desired IP and/or subnet for this port: subnet_id=<name_or_id>,ip_address=<ip>. You can repeat this option.
--device-id DEVICE_ID
Device ID of this port.
--device-owner DEVICE_OWNER
Device owner of this port.
--admin-state-down
Set admin state up to false.
--mac-address MAC_ADDRESS
MAC address of this port.
--vnic-type <direct | direct-physical | macvtap | normal | baremetal>
VNIC type for this port.
--binding-profile BINDING_PROFILE
Custom data to be passed as binding:profile.
--security-group SECURITY_GROUP
Security group associated with the port. You can repeat this option.
--no-security-groups
Associate no security groups with the port.
--extra-dhcp-opt EXTRA_DHCP_OPTS
Extra dhcp options to be assigned to this port: opt_na me=<dhcp_option_name>,opt_value=<value>,ip_version={4, 6}. You can repeat this option.
--qos-policy QOS_POLICY
Attach QoS policy ID or name to the resource.
--allowed-address-pair
ip_address=IP_ADDR[,mac_address=MAC_ADDR] Allowed address pair associated with the port.You can repeat this option.
--no-allowed-address-pairs
Associate no allowed address pairs with the port.
--dns-name DNS_NAME
Assign DNS name to the port (requires DNS integration extension)

9.145. neutron port-delete
Copy link

usage: neutron port-delete [-h] [--request-format {json}] PORT
Copy to Clipboard Toggle word wrap
Delete a given port.

Positional arguments

PORT
ID or name of port to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.146. neutron port-show
Copy link

usage: neutron port-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] PORT
Copy to Clipboard Toggle word wrap
Show information of a given port.

Positional arguments

PORT
ID or name of port to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.147. neutron port-update
Copy link

usage: neutron port-update [-h] [--request-format {json}] [--name NAME] [--fixed-ip subnet_id=SUBNET,ip_address=IP_ADDR] [--device-id DEVICE_ID] [--device-owner DEVICE_OWNER] [--admin-state-up {True,False}] [--security-group SECURITY_GROUP | --no-security-groups] [--extra-dhcp-opt EXTRA_DHCP_OPTS] [--qos-policy QOS_POLICY | --no-qos-policy] [--allowed-address-pair ip_address=IP_ADDR[,mac_address=MAC_ADDR] | --no-allowed-address-pairs] [--dns-name DNS_NAME | --no-dns-name] PORT
Copy to Clipboard Toggle word wrap
Update port's information.

Positional arguments

PORT
ID or name of port to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--name NAME
Name of this port.
--fixed-ip
subnet_id=SUBNET,ip_address=IP_ADDR Desired IP and/or subnet for this port: subnet_id=<name_or_id>,ip_address=<ip>. You can repeat this option.
--device-id DEVICE_ID
Device ID of this port.
--device-owner DEVICE_OWNER
Device owner of this port.
--admin-state-up {True,False}
Set admin state up for the port.
--security-group SECURITY_GROUP
Security group associated with the port. You can repeat this option.
--no-security-groups
Associate no security groups with the port.
--extra-dhcp-opt EXTRA_DHCP_OPTS
Extra dhcp options to be assigned to this port: opt_na me=<dhcp_option_name>,opt_value=<value>,ip_version={4, 6}. You can repeat this option.
--qos-policy QOS_POLICY
Attach QoS policy ID or name to the resource.
--no-qos-policy
Detach QoS policy from the resource.
--allowed-address-pair
ip_address=IP_ADDR[,mac_address=MAC_ADDR] Allowed address pair associated with the port.You can repeat this option.
--no-allowed-address-pairs
Associate no allowed address pairs with the port.
--dns-name DNS_NAME
Assign DNS name to the port (requires DNS integration extension.)
--no-dns-name
Unassign DNS name from the port (requires DNS integration extension.)

9.148. neutron purge
Copy link

usage: neutron purge [-h] [--request-format {json}] TENANT
Copy to Clipboard Toggle word wrap

Positional arguments

TENANT
ID of Tenant owning the resources to be deleted.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.149. neutron qos-bandwidth-limit-rule-create
Copy link

usage: neutron qos-bandwidth-limit-rule-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--max-kbps MAX_KBPS] [--max-burst-kbps MAX_BURST_KBPS] QOS_POLICY
Copy to Clipboard Toggle word wrap
Create a qos bandwidth limit rule.

Positional arguments

QOS_POLICY
ID or name of the QoS policy.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--max-kbps MAX_KBPS
max bandwidth in kbps.
--max-burst-kbps MAX_BURST_KBPS
max burst bandwidth in kbps.

9.150. neutron qos-bandwidth-limit-rule-delete
Copy link

usage: neutron qos-bandwidth-limit-rule-delete [-h] [--request-format {json}] BANDWIDTH_LIMIT_RULE QOS_POLICY
Copy to Clipboard Toggle word wrap
Delete a given qos bandwidth limit rule.

Positional arguments

BANDWIDTH_LIMIT_RULE
ID of bandwidth_limit_rule to delete.
QOS_POLICY
ID or name of the QoS policy.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.151. neutron qos-bandwidth-limit-rule-list
Copy link

usage: neutron qos-bandwidth-limit-rule-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}] QOS_POLICY
Copy to Clipboard Toggle word wrap
List all qos bandwidth limit rules belonging to the specified policy.

Positional arguments

QOS_POLICY
ID or name of the QoS policy.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can repeat this option.

9.152. neutron qos-bandwidth-limit-rule-show
Copy link

usage: neutron qos-bandwidth-limit-rule-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] BANDWIDTH_LIMIT_RULE QOS_POLICY
Copy to Clipboard Toggle word wrap
Show information about the given qos bandwidth limit rule.

Positional arguments

BANDWIDTH_LIMIT_RULE
ID of bandwidth_limit_rule to look up.
QOS_POLICY
ID or name of the QoS policy.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.153. neutron qos-bandwidth-limit-rule-update
Copy link

usage: neutron qos-bandwidth-limit-rule-update [-h] [--request-format {json}] [--max-kbps MAX_KBPS] [--max-burst-kbps MAX_BURST_KBPS] BANDWIDTH_LIMIT_RULE QOS_POLICY
Copy to Clipboard Toggle word wrap
Update the given qos bandwidth limit rule.

Positional arguments

BANDWIDTH_LIMIT_RULE
ID of bandwidth_limit_rule to update.
QOS_POLICY
ID or name of the QoS policy.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--max-kbps MAX_KBPS
max bandwidth in kbps.
--max-burst-kbps MAX_BURST_KBPS
max burst bandwidth in kbps.

9.154. neutron qos-policy-create
Copy link

usage: neutron qos-policy-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--description DESCRIPTION] [--shared] NAME
Copy to Clipboard Toggle word wrap
Create a qos policy.

Positional arguments

NAME
Name of QoS policy to create.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--description DESCRIPTION
Description of the QoS policy.
--shared
Accessible by other tenants. Set shared to True (default is False).

9.155. neutron qos-policy-delete
Copy link

usage: neutron qos-policy-delete [-h] [--request-format {json}] POLICY
Copy to Clipboard Toggle word wrap
Delete a given qos policy.

Positional arguments

POLICY
ID or name of policy to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.156. neutron qos-policy-show
Copy link

usage: neutron qos-policy-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] POLICY
Copy to Clipboard Toggle word wrap
Show information of a given qos policy.

Positional arguments

POLICY
ID or name of policy to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.157. neutron qos-policy-update
Copy link

usage: neutron qos-policy-update [-h] [--request-format {json}] [--name NAME] [--description DESCRIPTION] [--shared] POLICY
Copy to Clipboard Toggle word wrap
Update a given qos policy.

Positional arguments

POLICY
ID or name of policy to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--name NAME
Name of QoS policy.
--description DESCRIPTION
Description of the QoS policy.
--shared
Accessible by other tenants. Set shared to True (default is False).

9.158. neutron queue-create
Copy link

usage: neutron queue-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--min MIN] [--max MAX] [--qos-marking QOS_MARKING] [--default DEFAULT] [--dscp DSCP] NAME
Copy to Clipboard Toggle word wrap
Create a queue.

Positional arguments

NAME
Name of queue.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--min MIN
Minimum rate.
--max MAX
Maximum rate.
--qos-marking QOS_MARKING
QOS marking as untrusted or trusted.
--default DEFAULT
If true all created ports will be the size of this queue, if queue is not specified
--dscp DSCP
Differentiated Services Code Point.

9.159. neutron queue-delete
Copy link

usage: neutron queue-delete [-h] [--request-format {json}] QOS_QUEUE
Copy to Clipboard Toggle word wrap
Delete a given queue.

Positional arguments

QOS_QUEUE
ID or name of qos_queue to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.160. neutron queue-show
Copy link

usage: neutron queue-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] QOS_QUEUE
Copy to Clipboard Toggle word wrap
Show information of a given queue.

Positional arguments

QOS_QUEUE
ID or name of qos_queue to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.161. neutron rbac-create
Copy link

usage: neutron rbac-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] --type {qos-policy,network} [--target-tenant TARGET_TENANT] --action {access_as_external,access_as_shared} RBAC_OBJECT
Copy to Clipboard Toggle word wrap
Create a RBAC policy for a given tenant.

Positional arguments

RBAC_OBJECT
ID or name of the RBAC object.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--type {qos-policy,network}
Type of the object that RBAC policy affects.
--target-tenant TARGET_TENANT
ID of the tenant to which the RBAC policy will be enforced.
--action {access_as_external,access_as_shared}
Action for the RBAC policy.

9.162. neutron rbac-delete
Copy link

usage: neutron rbac-delete [-h] [--request-format {json}] RBAC_POLICY
Copy to Clipboard Toggle word wrap
Delete a RBAC policy.

Positional arguments

RBAC_POLICY
ID of rbac_policy to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.163. neutron rbac-show
Copy link

usage: neutron rbac-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] RBAC_POLICY
Copy to Clipboard Toggle word wrap
Show information of a given RBAC policy.

Positional arguments

RBAC_POLICY
ID of rbac_policy to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.164. neutron rbac-update
Copy link

usage: neutron rbac-update [-h] [--request-format {json}] [--target-tenant TARGET_TENANT] RBAC_POLICY
Copy to Clipboard Toggle word wrap
Update RBAC policy for given tenant.

Positional arguments

RBAC_POLICY
ID of rbac_policy to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--target-tenant TARGET_TENANT
ID of the tenant to which the RBAC policy will be enforced.

9.165. neutron reachability-quick-tests-create
Copy link

usage: neutron reachability-quick-tests-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] name src-tenant-name src-segment-name src-ip dst-ip expected-result
Copy to Clipboard Toggle word wrap
[bsn_extensions] Create a Reachability Quick Test.

Positional arguments

name
Name of this reachability test.
src-tenant-name
Tenant name of the src-ip.
src-segment-name
Network name of the src-ip.
src-ip
Source IP of the reachability test.
dst-ip
Destination IP of the reachability test.
expected-result
Expected result of the test.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.

9.166. neutron reachability-quick-tests-delete
Copy link

usage: neutron reachability-quick-tests-delete [-h] [--request-format {json}] REACHABILITYQUICKTEST
Copy to Clipboard Toggle word wrap
[bsn_extensions] Delete a Reachability Quick Test.

Positional arguments

REACHABILITYQUICKTEST
ID or name of reachabilityquicktest to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.167. neutron reachability-quick-tests-run
Copy link

usage: neutron reachability-quick-tests-run [-h] [--request-format {json}] REACHABILITYQUICKTEST
Copy to Clipboard Toggle word wrap
[bsn_extensions] Run a Reachability Quick Test.

Positional arguments

REACHABILITYQUICKTEST
ID or name of reachabilityquicktest to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.168. neutron reachability-quick-tests-show
Copy link

usage: neutron reachability-quick-tests-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] REACHABILITYQUICKTEST
Copy to Clipboard Toggle word wrap
[bsn_extensions] Show a Reachability Quick Test.

Positional arguments

REACHABILITYQUICKTEST
ID or name of reachabilityquicktest to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.169. neutron reachability-quick-tests-update
Copy link

usage: neutron reachability-quick-tests-update [-h] [--request-format {json}] REACHABILITYQUICKTEST name src-tenant-name src-segment-name src-ip dst-ip expected-result
Copy to Clipboard Toggle word wrap
[bsn_extensions] Update a Reachability Quick Test.

Positional arguments

REACHABILITYQUICKTEST
ID or name of reachabilityquicktest to update.
name
Name of this reachability test.
src-tenant-name
Tenant name of the src-ip.
src-segment-name
Network name of the src-ip.
src-ip
Source IP of the reachability test.
dst-ip
Destination IP of the reachability test.
expected-result
Expected result of the test.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.170. neutron reachability-tests-create
Copy link

usage: neutron reachability-tests-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] name src-tenant-name src-segment-name src-ip dst-ip expected-result
Copy to Clipboard Toggle word wrap
[bsn_extensions] Create a Reachability Test.

Positional arguments

name
Name of this reachability test.
src-tenant-name
Tenant name of the src-ip.
src-segment-name
Network name of the src-ip.
src-ip
Source IP of the reachability test.
dst-ip
Destination IP of the reachability test.
expected-result
Expected result of the test.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.

9.171. neutron reachability-tests-delete
Copy link

usage: neutron reachability-tests-delete [-h] [--request-format {json}] REACHABILITYTEST
Copy to Clipboard Toggle word wrap
[bsn_extensions] Delete a Reachability Test.

Positional arguments

REACHABILITYTEST
ID or name of reachabilitytest to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.172. neutron reachability-tests-run
Copy link

usage: neutron reachability-tests-run [-h] [--request-format {json}] REACHABILITYTEST
Copy to Clipboard Toggle word wrap
[bsn_extensions] Run a Reachability Test.

Positional arguments

REACHABILITYTEST
ID or name of reachabilitytest to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.173. neutron reachability-tests-show
Copy link

usage: neutron reachability-tests-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] REACHABILITYTEST
Copy to Clipboard Toggle word wrap
[bsn_extensions] Show a Reachability Test.

Positional arguments

REACHABILITYTEST
ID or name of reachabilitytest to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.174. neutron reachability-tests-update
Copy link

usage: neutron reachability-tests-update [-h] [--request-format {json}] REACHABILITYTEST name src-tenant-name src-segment-name src-ip dst-ip expected-result
Copy to Clipboard Toggle word wrap
[bsn_extensions] Update a Reachability Test.

Positional arguments

REACHABILITYTEST
ID or name of reachabilitytest to update.
name
Name of this reachability test.
src-tenant-name
Tenant name of the src-ip.
src-segment-name
Network name of the src-ip.
src-ip
Source IP of the reachability test.
dst-ip
Destination IP of the reachability test.
expected-result
Expected result of the test.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.175. neutron router-create
Copy link

usage: neutron router-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--admin-state-down] [--distributed {True,False}] [--ha {True,False}] [--availability-zone-hint AVAILABILITY_ZONE] NAME
Copy to Clipboard Toggle word wrap
Create a router for a given tenant.

Positional arguments

NAME
Name of router to create.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--admin-state-down
Set admin state up to false.
--distributed {True,False}
Create a distributed router.
--ha {True,False}
Create a highly available router.
--availability-zone-hint AVAILABILITY_ZONE
Availability Zone for the router (requires availability zone extension, this option can be repeated).

9.176. neutron router-delete
Copy link

usage: neutron router-delete [-h] [--request-format {json}] ROUTER
Copy to Clipboard Toggle word wrap
Delete a given router.

Positional arguments

ROUTER
ID or name of router to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.177. neutron router-gateway-clear
Copy link

usage: neutron router-gateway-clear [-h] [--request-format {json}] ROUTER
Copy to Clipboard Toggle word wrap
Remove an external network gateway from a router.

Positional arguments

ROUTER
ID or name of the router.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.178. neutron router-gateway-set
Copy link

usage: neutron router-gateway-set [-h] [--request-format {json}] [--disable-snat] [--fixed-ip subnet_id=SUBNET,ip_address=IP_ADDR] ROUTER EXTERNAL-NETWORK
Copy to Clipboard Toggle word wrap
Set the external network gateway for a router.

Positional arguments

ROUTER
ID or name of the router.
EXTERNAL-NETWORK
ID or name of the external network for the gateway.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--disable-snat
Disable source NAT on the router gateway.
--fixed-ip
subnet_id=SUBNET,ip_address=IP_ADDR Desired IP and/or subnet on external network: subnet_id=<name_or_id>,ip_address=<ip>. You can specify both of subnet_id and ip_address or specify one of them as well. You can repeat this option.

9.179. neutron router-interface-add
Copy link

usage: neutron router-interface-add [-h] [--request-format {json}] ROUTER INTERFACE
Copy to Clipboard Toggle word wrap
Add an internal network interface to a router.

Positional arguments

ROUTER
ID or name of the router.
INTERFACE
The format is "SUBNET|subnet=SUBNET|port=PORT". Either a subnet or port must be specified. Both ID and name are accepted as SUBNET or PORT. Note that "subnet=" can be omitted when specifying a subnet.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.180. neutron router-interface-delete
Copy link

usage: neutron router-interface-delete [-h] [--request-format {json}] ROUTER INTERFACE
Copy to Clipboard Toggle word wrap
Remove an internal network interface from a router.

Positional arguments

ROUTER
ID or name of the router.
INTERFACE
The format is "SUBNET|subnet=SUBNET|port=PORT". Either a subnet or port must be specified. Both ID and name are accepted as SUBNET or PORT. Note that "subnet=" can be omitted when specifying a subnet.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.181. neutron router-list-on-l3-agent
Copy link

usage: neutron router-list-on-l3-agent [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] L3_AGENT
Copy to Clipboard Toggle word wrap
List the routers on a L3 agent.

Positional arguments

L3_AGENT
ID of the L3 agent to query.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.182. neutron router-port-list
Copy link

usage: neutron router-port-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--request-format {json}] [-D] [-F FIELD] [-P SIZE] [--sort-key FIELD] [--sort-dir {asc,desc}] ROUTER
Copy to Clipboard Toggle word wrap
List ports that belong to a given tenant, with specified router.

Positional arguments

ROUTER
ID or name of router to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.
-P SIZE, --page-size SIZE
Specify retrieve unit of each request, then split one request to several requests.
--sort-key FIELD
Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.
--sort-dir {asc,desc}
Sorts the list in the specified direction. You can repeat this option.

9.183. neutron router-show
Copy link

usage: neutron router-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] ROUTER
Copy to Clipboard Toggle word wrap
Show information of a given router.

Positional arguments

ROUTER
ID or name of router to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.184. neutron router-update
Copy link

usage: neutron router-update [-h] [--request-format {json}] [--name NAME] [--admin-state-up {True,False}] [--distributed {True,False}] [--route destination=CIDR,nexthop=IP_ADDR | --no-routes] ROUTER
Copy to Clipboard Toggle word wrap
Update router's information.

Positional arguments

ROUTER
ID or name of router to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--name NAME
Name of this router.
--admin-state-up {True,False}
Specify the administrative state of the router (True meaning "Up")
--distributed {True,False}
True means this router should operate in distributed mode.
--route
destination=CIDR,nexthop=IP_ADDR Route to associate with the router. You can repeat this option.
--no-routes
Remove routes associated with the router.

9.185. neutron security-group-create
Copy link

usage: neutron security-group-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--description DESCRIPTION] NAME
Copy to Clipboard Toggle word wrap
Create a security group.

Positional arguments

NAME
Name of security group.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--description DESCRIPTION
Description of security group.

9.186. neutron security-group-delete
Copy link

usage: neutron security-group-delete [-h] [--request-format {json}] SECURITY_GROUP
Copy to Clipboard Toggle word wrap
Delete a given security group.

Positional arguments

SECURITY_GROUP
ID or name of security_group to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.187. neutron security-group-rule-create
Copy link

usage: neutron security-group-rule-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--direction {ingress,egress}] [--ethertype ETHERTYPE] [--protocol PROTOCOL] [--port-range-min PORT_RANGE_MIN] [--port-range-max PORT_RANGE_MAX] [--remote-ip-prefix REMOTE_IP_PREFIX] [--remote-group-id REMOTE_GROUP] SECURITY_GROUP
Copy to Clipboard Toggle word wrap
Create a security group rule.

Positional arguments

SECURITY_GROUP
Security group name or ID to add rule.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--direction {ingress,egress}
Direction of traffic: ingress/egress.
--ethertype ETHERTYPE
IPv4/IPv6
--protocol PROTOCOL
Protocol of packet. Allowed values are [icmp, icmpv6, tcp, udp] and integer representations [0-255]
--port-range-min PORT_RANGE_MIN
Starting port range. For ICMP it is type.
--port-range-max PORT_RANGE_MAX
Ending port range. For ICMP it is code.
--remote-ip-prefix REMOTE_IP_PREFIX
CIDR to match on.
--remote-group-id REMOTE_GROUP
Remote security group name or ID to apply rule.

9.188. neutron security-group-rule-delete
Copy link

usage: neutron security-group-rule-delete [-h] [--request-format {json}] SECURITY_GROUP_RULE
Copy to Clipboard Toggle word wrap
Delete a given security group rule.

Positional arguments

SECURITY_GROUP_RULE
ID of security_group_rule to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.189. neutron security-group-rule-show
Copy link

usage: neutron security-group-rule-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] SECURITY_GROUP_RULE
Copy to Clipboard Toggle word wrap
Show information of a given security group rule.

Positional arguments

SECURITY_GROUP_RULE
ID of security_group_rule to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.190. neutron security-group-show
Copy link

usage: neutron security-group-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] SECURITY_GROUP
Copy to Clipboard Toggle word wrap
Show information of a given security group.

Positional arguments

SECURITY_GROUP
ID or name of security_group to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.191. neutron security-group-update
Copy link

usage: neutron security-group-update [-h] [--request-format {json}] [--name NAME] [--description DESCRIPTION] SECURITY_GROUP
Copy to Clipboard Toggle word wrap
Update a given security group.

Positional arguments

SECURITY_GROUP
ID or name of security_group to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--name NAME
Name of security group.
--description DESCRIPTION
Description of security group.

9.192. neutron subnet-create
Copy link

usage: neutron subnet-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--name NAME] [--gateway GATEWAY_IP | --no-gateway] [--allocation-pool start=IP_ADDR,end=IP_ADDR] [--host-route destination=CIDR,nexthop=IP_ADDR] [--dns-nameserver DNS_NAMESERVER] [--disable-dhcp] [--enable-dhcp] [--ip-version {4,6}] [--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}] [--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}] [--subnetpool SUBNETPOOL] [--use-default-subnetpool] [--prefixlen PREFIX_LENGTH] NETWORK [CIDR]
Copy to Clipboard Toggle word wrap
Create a subnet for a given tenant.

Positional arguments

NETWORK
Network ID or name this subnet belongs to.
CIDR
CIDR of subnet to create.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--name NAME
Name of this subnet.
--gateway GATEWAY_IP
Gateway IP of this subnet.
--no-gateway
No distribution of gateway.
--allocation-pool
start=IP_ADDR,end=IP_ADDR Allocation pool IP addresses for this subnet (This option can be repeated).
--host-route
destination=CIDR,nexthop=IP_ADDR Additional route (This option can be repeated).
--dns-nameserver DNS_NAMESERVER
DNS name server for this subnet (This option can be repeated).
--disable-dhcp
Disable DHCP for this subnet.
--enable-dhcp
Enable DHCP for this subnet.
--ip-version {4,6} IP
version to use, default is 4. Note that when subnetpool is specified, IP version is determined from the subnetpool and this option is ignored.
--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}
IPv6 RA (Router Advertisement) mode.
--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}
IPv6 address mode.
--subnetpool SUBNETPOOL
ID or name of subnetpool from which this subnet will obtain a CIDR.
--use-default-subnetpool
Use default subnetpool for ip_version, if it exists.
--prefixlen PREFIX_LENGTH
Prefix length for subnet allocation from subnetpool.

9.193. neutron subnet-delete
Copy link

usage: neutron subnet-delete [-h] [--request-format {json}] SUBNET
Copy to Clipboard Toggle word wrap
Delete a given subnet.

Positional arguments

SUBNET
ID or name of subnet to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.194. neutron subnet-show
Copy link

usage: neutron subnet-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] SUBNET
Copy to Clipboard Toggle word wrap
Show information of a given subnet.

Positional arguments

SUBNET
ID or name of subnet to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.195. neutron subnet-update
Copy link

usage: neutron subnet-update [-h] [--request-format {json}] [--name NAME] [--gateway GATEWAY_IP | --no-gateway] [--allocation-pool start=IP_ADDR,end=IP_ADDR] [--host-route destination=CIDR,nexthop=IP_ADDR] [--dns-nameserver DNS_NAMESERVER] [--disable-dhcp] [--enable-dhcp] SUBNET
Copy to Clipboard Toggle word wrap
Update subnet's information.

Positional arguments

SUBNET
ID or name of subnet to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--name NAME
Name of this subnet.
--gateway GATEWAY_IP
Gateway IP of this subnet.
--no-gateway
No distribution of gateway.
--allocation-pool
start=IP_ADDR,end=IP_ADDR Allocation pool IP addresses for this subnet (This option can be repeated).
--host-route
destination=CIDR,nexthop=IP_ADDR Additional route (This option can be repeated).
--dns-nameserver DNS_NAMESERVER
DNS name server for this subnet (This option can be repeated).
--disable-dhcp
Disable DHCP for this subnet.
--enable-dhcp
Enable DHCP for this subnet.

9.196. neutron subnetpool-create
Copy link

usage: neutron subnetpool-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--min-prefixlen MIN_PREFIXLEN] [--max-prefixlen MAX_PREFIXLEN] [--default-prefixlen DEFAULT_PREFIXLEN] [--pool-prefix PREFIXES] [--is-default {True,False}] [--shared] [--address-scope ADDRSCOPE] NAME
Copy to Clipboard Toggle word wrap
Create a subnetpool for a given tenant.

Positional arguments

NAME
Name of subnetpool to create.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--min-prefixlen MIN_PREFIXLEN
Subnetpool minimum prefix length.
--max-prefixlen MAX_PREFIXLEN
Subnetpool maximum prefix length.
--default-prefixlen DEFAULT_PREFIXLEN
Subnetpool default prefix length.
--pool-prefix PREFIXES
Subnetpool prefixes (This option can be repeated).
--is-default {True,False}
Specify whether this should be the default subnetpool (True meaning default).
--shared
Set the subnetpool as shared.
--address-scope ADDRSCOPE
ID or name of the address scope with which the subnetpool is associated. Prefixes must be unique across address scopes

9.197. neutron subnetpool-delete
Copy link

usage: neutron subnetpool-delete [-h] [--request-format {json}] SUBNETPOOL
Copy to Clipboard Toggle word wrap
Delete a given subnetpool.

Positional arguments

SUBNETPOOL
ID or name of subnetpool to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.198. neutron subnetpool-show
Copy link

usage: neutron subnetpool-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] SUBNETPOOL
Copy to Clipboard Toggle word wrap
Show information of a given subnetpool.

Positional arguments

SUBNETPOOL
ID or name of subnetpool to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.199. neutron subnetpool-update
Copy link

usage: neutron subnetpool-update [-h] [--request-format {json}] [--min-prefixlen MIN_PREFIXLEN] [--max-prefixlen MAX_PREFIXLEN] [--default-prefixlen DEFAULT_PREFIXLEN] [--pool-prefix PREFIXES] [--is-default {True,False}] [--name NAME] [--address-scope ADDRSCOPE | --no-address-scope] SUBNETPOOL
Copy to Clipboard Toggle word wrap
Update subnetpool's information.

Positional arguments

SUBNETPOOL
ID or name of subnetpool to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--min-prefixlen MIN_PREFIXLEN
Subnetpool minimum prefix length.
--max-prefixlen MAX_PREFIXLEN
Subnetpool maximum prefix length.
--default-prefixlen DEFAULT_PREFIXLEN
Subnetpool default prefix length.
--pool-prefix PREFIXES
Subnetpool prefixes (This option can be repeated).
--is-default {True,False}
Specify whether this should be the default subnetpool (True meaning default).
--name NAME
Name of subnetpool to update.
--address-scope ADDRSCOPE
ID or name of the address scope with which the subnetpool is associated. Prefixes must be unique across address scopes
--no-address-scope
Detach subnetpool from the address scope

9.200. neutron vpn-endpoint-group-delete
Copy link

usage: neutron vpn-endpoint-group-delete [-h] [--request-format {json}] ENDPOINT_GROUP
Copy to Clipboard Toggle word wrap
Delete a given VPN endpoint group.

Positional arguments

ENDPOINT_GROUP
ID or name of endpoint_group to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.201. neutron vpn-endpoint-group-show
Copy link

usage: neutron vpn-endpoint-group-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] ENDPOINT_GROUP
Copy to Clipboard Toggle word wrap
Show a specific VPN endpoint group.

Positional arguments

ENDPOINT_GROUP
ID or name of endpoint_group to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.202. neutron vpn-endpoint-group-update
Copy link

usage: neutron vpn-endpoint-group-update [-h] [--request-format {json}] [--name NAME] [--description DESCRIPTION] ENDPOINT_GROUP
Copy to Clipboard Toggle word wrap
Update a given VPN endpoint group.

Positional arguments

ENDPOINT_GROUP
ID or name of endpoint_group to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--name NAME
Set a name for the endpoint group.
--description DESCRIPTION
Set a description for the endpoint group.

9.203. neutron vpn-ikepolicy-create
Copy link

usage: neutron vpn-ikepolicy-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--description DESCRIPTION] [--auth-algorithm {sha1}] [--encryption-algorithm ENCRYPTION_ALGORITHM] [--phase1-negotiation-mode {main}] [--ike-version {v1,v2}] [--pfs {group2,group5,group14}] [--lifetime units=UNITS,value=VALUE] NAME
Copy to Clipboard Toggle word wrap
Create an IKE policy.

Positional arguments

NAME
Name of the IKE policy.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--description DESCRIPTION
Description of the IKE policy
--auth-algorithm {sha1}
Authentication algorithm in lowercase. Default:sha1
--encryption-algorithm ENCRYPTION_ALGORITHM
Encryption algorithm in lowercase, default:aes-128
--phase1-negotiation-mode {main}
IKE Phase1 negotiation mode in lowercase, default:main
--ike-version {v1,v2}
IKE version in lowercase, default:v1
--pfs {group2,group5,group14}
Perfect Forward Secrecy in lowercase, default:group5
--lifetime
units=UNITS,value=VALUE IKE lifetime attributes. 'units'-seconds, default:seconds. 'value'-non negative integer, default:3600.

9.204. neutron vpn-ikepolicy-delete
Copy link

usage: neutron vpn-ikepolicy-delete [-h] [--request-format {json}] IKEPOLICY
Copy to Clipboard Toggle word wrap
Delete a given IKE policy.

Positional arguments

IKEPOLICY
ID or name of IKE policy to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.205. neutron vpn-ikepolicy-show
Copy link

usage: neutron vpn-ikepolicy-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] IKEPOLICY
Copy to Clipboard Toggle word wrap
Show information of a given IKE policy.

Positional arguments

IKEPOLICY
ID or name of IKE policy to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.206. neutron vpn-ikepolicy-update
Copy link

usage: neutron vpn-ikepolicy-update [-h] [--request-format {json}] [--lifetime units=UNITS,value=VALUE] IKEPOLICY
Copy to Clipboard Toggle word wrap
Update a given IKE policy.

Positional arguments

IKEPOLICY
ID or name of IKE policy to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--lifetime
units=UNITS,value=VALUE IKE lifetime attributes. 'units'-seconds, default:seconds. 'value'-non negative integer, default:3600.

9.207. neutron vpn-ipsecpolicy-create
Copy link

usage: neutron vpn-ipsecpolicy-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--description DESCRIPTION] [--transform-protocol {esp,ah,ah-esp}] [--auth-algorithm {sha1}] [--encryption-algorithm ENCRYPTION_ALGORITHM] [--encapsulation-mode {tunnel,transport}] [--pfs {group2,group5,group14}] [--lifetime units=UNITS,value=VALUE] NAME
Copy to Clipboard Toggle word wrap
Create an IPsec policy.

Positional arguments

NAME
Name of the IPsec policy.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--description DESCRIPTION
Description of the IPsec policy.
--transform-protocol {esp,ah,ah-esp}
Transform protocol in lowercase, default:esp
--auth-algorithm {sha1}
Authentication algorithm in lowercase, default:sha1
--encryption-algorithm ENCRYPTION_ALGORITHM
Encryption algorithm in lowercase, default:aes-128
--encapsulation-mode {tunnel,transport}
Encapsulation mode in lowercase, default:tunnel
--pfs {group2,group5,group14}
Perfect Forward Secrecy in lowercase, default:group5
--lifetime
units=UNITS,value=VALUE IPsec lifetime attributes. 'units'-seconds, default:seconds. 'value'-non negative integer, default:3600.

9.208. neutron vpn-ipsecpolicy-delete
Copy link

usage: neutron vpn-ipsecpolicy-delete [-h] [--request-format {json}] IPSECPOLICY
Copy to Clipboard Toggle word wrap
Delete a given IPsec policy.

Positional arguments

IPSECPOLICY
ID or name of IPsec policy to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.209. neutron vpn-ipsecpolicy-show
Copy link

usage: neutron vpn-ipsecpolicy-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] IPSECPOLICY
Copy to Clipboard Toggle word wrap
Show information of a given IPsec policy.

Positional arguments

IPSECPOLICY
ID or name of IPsec policy to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.210. neutron vpn-ipsecpolicy-update
Copy link

usage: neutron vpn-ipsecpolicy-update [-h] [--request-format {json}] [--lifetime units=UNITS,value=VALUE] IPSECPOLICY
Copy to Clipboard Toggle word wrap
Update a given IPsec policy.

Positional arguments

IPSECPOLICY
ID or name of IPsec policy to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--lifetime
units=UNITS,value=VALUE IPsec lifetime attributes. 'units'-seconds, default:seconds. 'value'-non negative integer, default:3600.

9.211. neutron vpn-service-create
Copy link

usage: neutron vpn-service-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [--tenant-id TENANT_ID] [--admin-state-down] [--name NAME] [--description DESCRIPTION] ROUTER [SUBNET]
Copy to Clipboard Toggle word wrap
Create a VPN service.

Positional arguments

ROUTER
Router unique identifier for the VPN service.
SUBNET
[DEPRECATED in Mitaka] Unique identifier for the local private subnet.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
--tenant-id TENANT_ID
The owner tenant ID.
--admin-state-down
Set admin state up to false.
--name NAME
Set a name for the VPN service.
--description DESCRIPTION
Set a description for the VPN service.

9.212. neutron vpn-service-delete
Copy link

usage: neutron vpn-service-delete [-h] [--request-format {json}] VPNSERVICE
Copy to Clipboard Toggle word wrap
Delete a given VPN service.

Positional arguments

VPNSERVICE
ID or name of VPN service to delete.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

9.213. neutron vpn-service-show
Copy link

usage: neutron vpn-service-show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--request-format {json}] [-D] [-F FIELD] VPNSERVICE
Copy to Clipboard Toggle word wrap
Show information of a given VPN service.

Positional arguments

VPNSERVICE
ID or name of VPN service to look up.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.
-D, --show-details
Show detailed information.
-F FIELD, --field FIELD
Specify the field(s) to be returned by server. You can repeat this option.

9.214. neutron vpn-service-update
Copy link

usage: neutron vpn-service-update [-h] [--request-format {json}] VPNSERVICE
Copy to Clipboard Toggle word wrap
Update a given VPN service.

Positional arguments

VPNSERVICE
ID or name of VPN service to update.

Optional arguments

-h, --help
show this help message and exit
--request-format {json}
DEPRECATED! Only JSON request format is supported.

Chapter 10. neutron-debug command-line client
Copy link

The neutron-debug client is an extension to the neutron command-line interface (CLI) for the OpenStack neutron-debug tool. This chapter documents neutron-debug version 2.3.0.
For help on a specific neutron-debug command, enter: 
$ neutron-debug help COMMAND
Copy to Clipboard Toggle word wrap

10.1. neutron-debug usage
Copy link

 [--os-password <auth-password>] [--os-tenant-name <auth-tenant-name>] [--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>] [--os-region-name <region-name>] [--service-type <service-type>] [--service-name <service-name>] [--volume-service-name <volume-service-name>] [--endpoint-type <endpoint-type>] [--os-volume-api-version <volume-api-ver>] [--os-cacert <ca-certificate>] [--retries <retries>] <subcommand> ...
Copy to Clipboard Toggle word wrap

Subcommands

probe-create
Create probe port - create port and interface within a network namespace.
probe-list
List all probes.
probe-clear
Clear all probes.
probe-delete
Delete probe - delete port then delete the namespace.
probe-exec
Execute commands in the namespace of the probe.
ping-all
ping-all is all-in-one command to ping all fixed IP's in a specified network.

10.2. neutron-debug optional arguments
Copy link

--version
Show version number and exit.
-v, --verbose, --debug
Increase verbosity of output and show tracebacks on errors. Can be repeated.
-q, --quiet
Suppress output except warnings and errors
-h, --help
Show this help message and exit
--os-auth-strategy <auth-strategy>
Authentication strategy (Env: OS_AUTH_STRATEGY, default keystone). For now, any other value will disable the authentication
--os-auth-url <auth-url>
Authentication URL (Env: OS_AUTH_URL)
--os-tenant-name <auth-tenant-name>
Authentication tenant name (Env: OS_TENANT_NAME)
--os-tenant-id <auth-tenant-id>
Authentication tenant name (Env: OS_TENANT_ID)
--os-username <auth-username>
Authentication username (Env: OS_USERNAME)
--os-password <auth-password>
Authentication password (Env: OS_PASSWORD)
--os-region-name <auth-region-name>
Authentication region name (Env: OS_REGION_NAME)
--os-token <token>
Defaults to env[OS_TOKEN]
--endpoint-type <endpoint-type>
Defaults to env[OS_ENDPOINT_TYPE] or public URL.
--os-url <url>
Defaults to env[OS_URL]
--os-cacert <ca-certificate>
Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to env[OS_CACERT]
--insecure
Explicitly allow neutron-debug to perform "insecure" SSL (https) requests. The server's certificate will not be verified against any certificate authorities. This option should be used with caution.
--config-file CONFIG_FILE
Config file for interface driver (You may also use l3_agent.ini)

10.3. neutron-debug probe-create command
Copy link

usage: neutron-debug probe-create NET
Copy to Clipboard Toggle word wrap
Create probe port - create port and interface, then place it into the created network namespace.

Positional arguments

NET ID
ID of the network in which the probe will be created.

10.4. neutron-debug probe-list command
Copy link

usage: neutron-debug probe-list
Copy to Clipboard Toggle word wrap
List probes.

10.5. neutron-debug probe-clear command
Copy link

usage: neutron-debug probe-clear
Copy to Clipboard Toggle word wrap
Clear all probes.

10.6. neutron-debug probe-delete command
Copy link

usage: neutron-debug probe-delete <port-id>
Copy to Clipboard Toggle word wrap
Remove a probe.

Positional arguments

<port-id>
ID of the probe to delete.

10.7. neutron-debug probe-exec command
Copy link

usage: neutron-debug probe-exec <port-id> <command>
Copy to Clipboard Toggle word wrap
Execute commands in the namespace of the probe

10.8. neutron-debug ping-all command
Copy link

usage: neutron-debug ping-all <port-id> --timeout <number
Copy to Clipboard Toggle word wrap
All-in-one command to ping all fixed IP's in a specified network.

Positional arguments

<port-id>
ID of the port to use.

Optional arguments

--timeout <timeout in seconds>
Optional ping timeout.

10.9. neutron-debug example
Copy link

usage: neutron-debug create-probe < NET_ID>
Copy to Clipboard Toggle word wrap
Create a probe namespace within the network identified by NET_ID. The namespace will have the name of qprobe-<UUID of the probe port>
Note
For the following examples to function, the security group rules may need to be modified to allow the SSH (TCP port 22) or ping (ICMP) traffic into network. 
usage: neutron-debug probe-exec <probe ID> "ssh <IP of instance>"
Copy to Clipboard Toggle word wrap
SSH to an instance within the network. 
usage: neutron-debug ping-all <network ID>"
Copy to Clipboard Toggle word wrap
Ping all instances on this network to verify they are responding. 
usage: neutron-debug probe-exec <probe_ID> dhcping <VM_MAC address> -s <IP of DHCP server>"
Copy to Clipboard Toggle word wrap
Ping the DHCP server for this network using dhcping to verify it is working.
The swift client is the command-line interface (CLI) for the Object Storage service API and its extensions. This chapter documents swift version 3.0.0.
For help on a specific swift command, enter: 
$ swift COMMAND --help
Copy to Clipboard Toggle word wrap

11.1. swift usage
Copy link

 [--debug] [--info] [--quiet] [--auth <auth_url>] [--auth-version <auth_version> | --os-identity-api-version <auth_version> ] [--user <username>] [--key <api_key>] [--retries <num_retries>] [--os-username <auth-user-name>] [--os-password <auth-password>] [--os-user-id <auth-user-id>] [--os-user-domain-id <auth-user-domain-id>] [--os-user-domain-name <auth-user-domain-name>] [--os-tenant-id <auth-tenant-id>] [--os-tenant-name <auth-tenant-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-auth-url <auth-url>] [--os-auth-token <auth-token>] [--os-storage-url <storage-url>] [--os-region-name <region-name>] [--os-service-type <service-type>] [--os-endpoint-type <endpoint-type>] [--os-cacert <ca-certificate>] [--insecure] [--no-ssl-compression] <subcommand> [--help] [<subcommand options>]
Copy to Clipboard Toggle word wrap

Subcommands

delete
Delete a container or objects within a container.
download
Download objects from containers.
list
Lists the containers for the account or the objects for a container.
post
Updates meta information for the account, container, or object; creates containers if not present.
stat
Displays information for the account, container, or object.
upload
Uploads files or directories to the given container.
capabilities
List cluster capabilities.
tempurl
Create a temporary URL.
auth
Display auth related environment variables.

11.2. swift examples
Copy link

 swift download --help swift -A https://auth.api.rackspacecloud.com/v1.0 -U user -K api_key stat -v swift --os-auth-url https://api.example.com/v2.0 --os-tenant-name tenant \ --os-username user --os-password password list swift --os-auth-url https://api.example.com/v3 --auth-version 3\ --os-project-name project1 --os-project-domain-name domain1 \ --os-username user --os-user-domain-name domain1 \ --os-password password list swift --os-auth-url https://api.example.com/v3 --auth-version 3\ --os-project-id 0123456789abcdef0123456789abcdef \ --os-user-id abcdef0123456789abcdef0123456789 \ --os-password password list swift --os-auth-token 6ee5eb33efad4e45ab46806eac010566 \ --os-storage-url https://10.1.5.2:8080/v1/AUTH_ced809b6a4baea7aeab61a \ list swift list --lh
Copy to Clipboard Toggle word wrap

11.3. swift optional arguments
Copy link

--version
show program's version number and exit
-h, --help
show this help message and exit
--os-help
Show OpenStack authentication options.
-s, --snet
Use SERVICENET internal network.
-v, --verbose
Print more info.
--debug
Show the curl commands and results of all http queries regardless of result status.
--info
Show the curl commands and results of all http queries which return an error.
-q, --quiet
Suppress status output.
-A AUTH, --auth=AUTH URL
for obtaining an auth token.
-V AUTH_VERSION, --auth-version=AUTH_VERSION, --os-identity-api-version=AUTH_VERSION
Specify a version for authentication. Defaults to env[ST_AUTH_VERSION], env[OS_AUTH_VERSION], env[OS_IDENTITY_API_VERSION] or 1.0.
-U USER, --user=USER
User name for obtaining an auth token.
-K KEY, --key=KEY
Key for obtaining an auth token.
-R RETRIES, --retries=RETRIES
The number of times to retry a failed connection.
--insecure
Allow swiftclient to access servers without having to verify the SSL certificate. Defaults to env[SWIFTCLIENT_INSECURE] (set to 'true' to enable).
--no-ssl-compression
This option is deprecated and not used anymore. SSL compression should be disabled by default by the system SSL library.

11.4. swift auth
Copy link

Usage: swift auth
Copy to Clipboard Toggle word wrap
Display auth related authentication variables in shell friendly format.
Commands to run to export storage url and auth token into OS_STORAGE_URL and OS_AUTH_TOKEN:
swift auth
Copy to Clipboard Toggle word wrap
Commands to append to a runcom file (e.g. ~/.bashrc, /etc/profile) for automatic authentication:
swift auth -v -U test:tester -K testing           -A http://localhost:8080/auth/v1.0
Copy to Clipboard Toggle word wrap

11.5. swift capabilities
Copy link

Usage: swift capabilities
Copy to Clipboard Toggle word wrap
Retrieve capability of the proxy.

Optional positional arguments

<proxy_url>
Proxy URL of the cluster to retrieve capabilities.

11.6. swift delete
Copy link

Usage: swift delete
Copy to Clipboard Toggle word wrap
Delete a container or objects within a container.

Positional arguments

[<container>]
Name of container to delete from.
[<object>]
Name of object to delete. Specify multiple times for multiple objects.

Optional arguments

-a, --all
Delete all containers and objects.
--leave-segments
Do not delete segments of manifest objects.
--object-threads <threads>
Number of threads to use for deleting objects. Default is 10.
--container-threads <threads>
Number of threads to use for deleting containers. Default is 10.

11.7. swift download
Copy link

Usage: swift download
Copy to Clipboard Toggle word wrap
Download objects from containers.

Positional arguments

<container>
Name of container to download from. To download a whole account, omit this and specify --all.
<object>
Name of object to download. Specify multiple times for multiple objects. Omit this to download all objects from the container.

Optional arguments

-a, --all
Indicates that you really want to download everything in the account.
-m, --marker
Marker to use when starting a container or account download.
-p, --prefix <prefix>
Only download items beginning with <prefix>
-r, --remove-prefix
An optional flag for --prefix <prefix>, use this option to download items without <prefix>
-o, --output <out_file>
For a single file download, stream the output to <out_file>. Specifying "-" as <out_file> will redirect to stdout.
-D, --output-dir <out_directory>
An optional directory to which to store objects. By default, all objects are recreated in the current directory.
--object-threads <threads>
Number of threads to use for downloading objects. Default is 10.
--container-threads <threads>
Number of threads to use for downloading containers. Default is 10.
--no-download
Perform download(s), but don't actually write anything to disk.
-H, --header <header:value>
Adds a customized request header to the query, like "Range" or "If-Match". This option may be repeated. Example --header "content-type:text/plain"
--skip-identical
Skip downloading files that are identical on both sides.
--no-shuffle
By default, when downloading a complete account or container, download order is randomised in order to to reduce the load on individual drives when multiple clients are executed simultaneously to download the same set of objects (e.g. a nightly automated download script to multiple servers). Enable this option to submit download jobs to the thread pool in the order they are listed in the object store.

11.8. swift list
Copy link

Usage: swift list
Copy to Clipboard Toggle word wrap
Lists the containers for the account or the objects for a container.

Positional arguments

[container]
Name of container to list object in.

Optional arguments

-l, --long
Long listing format, similar to ls -l.
--lh
Report sizes in human readable format similar to ls -lh.
-t, --totals
Used with -l or --lh, only report totals.
-p <prefix>, --prefix <prefix>
Only list items beginning with the prefix.
-d <delim>, --delimiter <delim>
Roll up items with the given delimiter. For containers only. See OpenStack Swift API documentation for what this means.

11.9. swift post
Copy link

Usage: swift post
Copy to Clipboard Toggle word wrap
Updates meta information for the account, container, or object. If the container is not found, it will be created automatically.

Positional arguments

[container]
Name of container to post to.
[object]
Name of object to post.

Optional arguments

-r, --read-acl <acl>
Read ACL for containers. Quick summary of ACL syntax: .r:*, .r:-.example.com, .r:www.example.com, account1, account2:user2
-w, --write-acl <acl>
Write ACL for containers. Quick summary of ACL syntax: account1 account2:user2
-t, --sync-to <sync-to>
Sync To for containers, for multi-cluster replication.
-k, --sync-key <sync-key>
Sync Key for containers, for multi-cluster replication.
-m, --meta <name:value>
Sets a meta data item. This option may be repeated. Example: -m Color:Blue -m Size:Large
-H, --header <header:value>
Adds a customized request header. This option may be repeated. Example -H "content-type:text/plain" -H "Content-Length: 4000"

11.10. swift stat
Copy link

Usage: swift stat
Copy to Clipboard Toggle word wrap
Displays information for the account, container, or object.

Positional arguments

[container]
Name of container to stat from.
[object]
Name of object to stat.

Optional arguments

--lh
Report sizes in human readable format similar to ls -lh.

11.11. swift tempurl
Copy link

Usage: swift tempurl
Copy to Clipboard Toggle word wrap
Generates a temporary URL for a Swift object.

Positional arguments

<method>
An HTTP method to allow for this temporary URL. Usually 'GET' or 'PUT'.
<seconds>
The amount of time in seconds the temporary URL will be valid for; or, if --absolute is passed, the Unix timestamp when the temporary URL will expire.
<path>
The full path to the Swift object. Example: /v1/AUTH_account/c/o.
<key>
The secret temporary URL key set on the Swift cluster. To set a key, run 'swift post -m "Temp-URL-Key:b3968d0207b54ece87cccc06515a89d4"'

Optional arguments

--absolute
Interpret the <seconds> positional argument as a Unix timestamp rather than a number of seconds in the future.

11.12. swift upload
Copy link

Usage: swift upload
Copy to Clipboard Toggle word wrap
Uploads specified files and directories to the given container.

Positional arguments

<container>
Name of container to upload to.
<file_or_directory>
Name of file or directory to upload. Specify multiple times for multiple uploads.

Optional arguments

-c, --changed
Only upload files that have changed since the last upload.
--skip-identical
Skip uploading files that are identical on both sides.
-S, --segment-size <size>
Upload files in segments no larger than <size> (in Bytes) and then create a "manifest" file that will download all the segments as if it were the original file.
--segment-container <container>
Upload the segments into the specified container. If not specified, the segments will be uploaded to a <container>_segments container to not pollute the main <container> listings.
--leave-segments
Indicates that you want the older segments of manifest objects left alone (in the case of overwrites).
--object-threads <threads>
Number of threads to use for uploading full objects. Default is 10.
--segment-threads <threads>
Number of threads to use for uploading object segments. Default is 10.
-H, --header <header:value>
Adds a customized request header. This option may be repeated. Example -H "content-type:text/plain" -H "Content-Length: 4000".
--use-slo
When used in conjunction with --segment-size it will create a Static Large Object instead of the default Dynamic Large Object.
--object-name <object-name>
Upload file and name object to <object-name> or upload dir and use <object-name> as object prefix instead of folder name.
--ignore-checksum
Turn off checksum validation for uploads.
The heat client is the command-line interface (CLI) for the Orchestration service API and its extensions. This chapter documents heat version 1.2.0.
For help on a specific heat command, enter: 
$ heat help COMMAND
Copy to Clipboard Toggle word wrap

12.1. heat usage
Copy link

usage: heat [--version] [-d] [-v] [--api-timeout API_TIMEOUT] [--os-no-client-auth] [--heat-url HEAT_URL] [--heat-api-version HEAT_API_VERSION] [--include-password] [-k] [--os-cert OS_CERT] [--cert-file OS_CERT] [--os-key OS_KEY] [--key-file OS_KEY] [--os-cacert <ca-certificate-file>] [--ca-file OS_CACERT] [--os-username OS_USERNAME] [--os-user-id OS_USER_ID] [--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID] [--os-project-name OS_PROJECT_NAME] [--os-project-domain-id OS_PROJECT_DOMAIN_ID] [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] [--os-password OS_PASSWORD] [--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME] [--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME] [--os-auth-token OS_AUTH_TOKEN] [--os-service-type OS_SERVICE_TYPE] [--os-endpoint-type OS_ENDPOINT_TYPE] [--profile HMAC_KEY] <subcommand> ...
Copy to Clipboard Toggle word wrap

Subcommands

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

12.2. heat optional arguments
Copy link

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

12.3. heat action-check
Copy link

usage: heat action-check <NAME or ID>
Copy to Clipboard Toggle word wrap
Check that stack resources are in expected states.

Positional arguments

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

12.4. heat action-resume
Copy link

usage: heat action-resume <NAME or ID>
Copy to Clipboard Toggle word wrap
Resume the stack.

Positional arguments

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

12.5. heat action-suspend
Copy link

usage: heat action-suspend <NAME or ID>
Copy to Clipboard Toggle word wrap
Suspend the stack.

Positional arguments

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

12.6. heat build-info
Copy link

usage: heat build-info
Copy to Clipboard Toggle word wrap
Retrieve build information.

12.7. heat config-create
Copy link

usage: heat config-create [-f <FILE or URL>] [-c <FILE or URL>] [-g <GROUP_NAME>] <CONFIG_NAME>
Copy to Clipboard Toggle word wrap
Create a software configuration.

Positional arguments

<CONFIG_NAME>
Name of the configuration to create.

Optional arguments

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

12.8. heat config-delete
Copy link

usage: heat config-delete <ID> [<ID> ...]
Copy to Clipboard Toggle word wrap
Delete the software configuration(s).

Positional arguments

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

12.9. heat config-list
Copy link

usage: heat config-list [-l <LIMIT>] [-m <ID>]
Copy to Clipboard Toggle word wrap
List software configs.

Optional arguments

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

12.10. heat config-show
Copy link

usage: heat config-show [-c] <ID>
Copy to Clipboard Toggle word wrap
View details of a software configuration.

Positional arguments

<ID>
ID of the config.

Optional arguments

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

12.11. heat deployment-create
Copy link

usage: heat deployment-create [-i <KEY=VALUE>] [-a <ACTION>] [-c <CONFIG>] -s <SERVER> [-t <TRANSPORT>] [--container <CONTAINER_NAME>] [--timeout <TIMEOUT>] <DEPLOY_NAME>
Copy to Clipboard Toggle word wrap
Create a software deployment.

Positional arguments

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

Optional arguments

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

12.12. heat deployment-delete
Copy link

usage: heat deployment-delete <ID> [<ID> ...]
Copy to Clipboard Toggle word wrap
Delete the software deployment(s).

Positional arguments

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

12.13. heat deployment-list
Copy link

usage: heat deployment-list [-s <SERVER>]
Copy to Clipboard Toggle word wrap
List software deployments.

Optional arguments

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

12.14. heat deployment-metadata-show
Copy link

usage: heat deployment-metadata-show <ID>
Copy to Clipboard Toggle word wrap
Get deployment configuration metadata for the specified server.

Positional arguments

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

12.15. heat deployment-output-show
Copy link

usage: heat deployment-output-show [-a] [-F <FORMAT>] <ID> [<OUTPUT NAME>]
Copy to Clipboard Toggle word wrap
Show a specific deployment output.

Positional arguments

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

Optional arguments

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

12.16. heat deployment-show
Copy link

usage: heat deployment-show <ID>
Copy to Clipboard Toggle word wrap
Show the details of a software deployment.

Positional arguments

<ID>
ID of the deployment.

12.17. heat event-list
Copy link

usage: heat event-list [-r <RESOURCE>] [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-l <LIMIT>] [-m <ID>] [-n <DEPTH>] [-F <FORMAT>] <NAME or ID>
Copy to Clipboard Toggle word wrap
List events for a stack.

Positional arguments

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

Optional arguments

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

12.18. heat event-show
Copy link

usage: heat event-show <NAME or ID> <RESOURCE> <EVENT>
Copy to Clipboard Toggle word wrap
Describe the event.

Positional arguments

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

12.19. heat hook-clear
Copy link

usage: heat hook-clear [--pre-create] [--pre-update] <NAME or ID> <RESOURCE> [<RESOURCE> ...]
Copy to Clipboard Toggle word wrap
Clear hooks on a given stack.

Positional arguments

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

Optional arguments

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

12.20. heat hook-poll
Copy link

usage: heat hook-poll [-n <DEPTH>] <NAME or ID>
Copy to Clipboard Toggle word wrap
List resources with pending hook for a stack.

Positional arguments

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

Optional arguments

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

12.21. heat output-list
Copy link

usage: heat output-list <NAME or ID>
Copy to Clipboard Toggle word wrap
Show available outputs.

Positional arguments

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

12.22. heat output-show
Copy link

usage: heat output-show [-F <FORMAT>] [-a] [--with-detail] <NAME or ID> [<OUTPUT NAME>]
Copy to Clipboard Toggle word wrap
Show a specific stack output.

Positional arguments

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

Optional arguments

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

12.23. heat resource-list
Copy link

usage: heat resource-list [-n <DEPTH>] [--with-detail] [-f <KEY=VALUE>] <NAME or ID>
Copy to Clipboard Toggle word wrap
Show list of resources belonging to a stack.

Positional arguments

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

Optional arguments

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

12.24. heat resource-mark-unhealthy
Copy link

usage: heat resource-mark-unhealthy [--reset] <NAME or ID> <RESOURCE> [reason]
Copy to Clipboard Toggle word wrap
Set resource's health.

Positional arguments

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

Optional arguments

--reset
Set the resource as healthy.

12.25. heat resource-metadata
Copy link

usage: heat resource-metadata <NAME or ID> <RESOURCE>
Copy to Clipboard Toggle word wrap
List resource metadata.

Positional arguments

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

12.26. heat resource-show
Copy link

usage: heat resource-show [-a <ATTRIBUTE>] <NAME or ID> <RESOURCE>
Copy to Clipboard Toggle word wrap
Describe the resource.

Positional arguments

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

Optional arguments

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

12.27. heat resource-signal
Copy link

usage: heat resource-signal [-D <DATA>] [-f <FILE>] <NAME or ID> <RESOURCE>
Copy to Clipboard Toggle word wrap
Send a signal to a resource.

Positional arguments

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

Optional arguments

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

12.28. heat resource-type-list
Copy link

usage: heat resource-type-list [-f <KEY1=VALUE1;KEY2=VALUE2...>]
Copy to Clipboard Toggle word wrap
List the available resource types.

Optional arguments

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

12.29. heat resource-type-show
Copy link

usage: heat resource-type-show <RESOURCE_TYPE>
Copy to Clipboard Toggle word wrap
Show the resource type.

Positional arguments

<RESOURCE_TYPE>
Resource type to get the details for.

12.30. heat resource-type-template
Copy link

usage: heat resource-type-template [-t <TEMPLATE_TYPE>] [-F <FORMAT>] <RESOURCE_TYPE>
Copy to Clipboard Toggle word wrap
Generate a template based on a resource type.

Positional arguments

<RESOURCE_TYPE>
Resource type to generate a template for.

Optional arguments

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

12.31. heat service-list
Copy link

usage: heat service-list
Copy to Clipboard Toggle word wrap
List the Heat engines.

12.32. heat snapshot-delete
Copy link

usage: heat snapshot-delete <NAME or ID> <SNAPSHOT>
Copy to Clipboard Toggle word wrap
Delete a snapshot of a stack.

Positional arguments

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

12.33. heat snapshot-list
Copy link

usage: heat snapshot-list <NAME or ID>
Copy to Clipboard Toggle word wrap
List the snapshots of a stack.

Positional arguments

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

12.34. heat snapshot-show
Copy link

usage: heat snapshot-show <NAME or ID> <SNAPSHOT>
Copy to Clipboard Toggle word wrap
Show a snapshot of a stack.

Positional arguments

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

12.35. heat stack-abandon
Copy link

usage: heat stack-abandon [-O <FILE>] <NAME or ID>
Copy to Clipboard Toggle word wrap
Abandon the stack. This will delete the record of the stack from Heat, but will not delete any of the underlying resources. Prints an adoptable JSON representation of the stack to stdout or a file on success.

Positional arguments

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

Optional arguments

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

12.36. heat stack-adopt
Copy link

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

Positional arguments

<STACK_NAME>
Name of the stack to adopt.

Optional arguments

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

12.37. heat stack-cancel-update
Copy link

usage: heat stack-cancel-update <NAME or ID>
Copy to Clipboard Toggle word wrap
Cancel currently running update of the stack.

Positional arguments

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

12.38. heat stack-create
Copy link

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

Positional arguments

<STACK_NAME>
Name of the stack to create.

Optional arguments

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

12.39. heat stack-delete
Copy link

usage: heat stack-delete [-y] <NAME or ID> [<NAME or ID> ...]
Copy to Clipboard Toggle word wrap
Delete the stack(s).

Positional arguments

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

Optional arguments

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

12.40. heat stack-list
Copy link

usage: heat stack-list [-s] [-n] [-a] [-f <KEY1=VALUE1;KEY2=VALUE2...>] [-t <TAG1,TAG2...>] [--tags-any <TAG1,TAG2...>] [--not-tags <TAG1,TAG2...>] [--not-tags-any <TAG1,TAG2...>] [-l <LIMIT>] [-m <ID>] [-k <KEY1;KEY2...>] [-d [asc|desc]] [-g] [-o]
Copy to Clipboard Toggle word wrap
List the user's stacks.

Optional arguments

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

12.41. heat stack-preview
Copy link

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

Positional arguments

<STACK_NAME>
Name of the stack to preview.

Optional arguments

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

12.42. heat stack-restore
Copy link

usage: heat stack-restore <NAME or ID> <SNAPSHOT>
Copy to Clipboard Toggle word wrap
Restore a snapshot of a stack.

Positional arguments

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

12.43. heat stack-show
Copy link

usage: heat stack-show [--no-resolve-outputs] <NAME or ID>
Copy to Clipboard Toggle word wrap
Describe the stack.

Positional arguments

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

Optional arguments

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

12.44. heat stack-snapshot
Copy link

usage: heat stack-snapshot [-n <NAME>] <NAME or ID>
Copy to Clipboard Toggle word wrap
Make a snapshot of a stack.

Positional arguments

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

Optional arguments

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

12.45. heat stack-update
Copy link

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

Positional arguments

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

Optional arguments

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

12.46. heat template-function-list
Copy link

usage: heat template-function-list <TEMPLATE_VERSION>
Copy to Clipboard Toggle word wrap
List the available functions.

Positional arguments

<TEMPLATE_VERSION>
Template version to get the functions for.

12.47. heat template-show
Copy link

usage: heat template-show <NAME or ID>
Copy to Clipboard Toggle word wrap
Get the template for the specified stack.

Positional arguments

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

12.48. heat template-validate
Copy link

usage: heat template-validate [-u <URL>] [-f <FILE>] [-e <FILE or URL>] [-o <URL>] [-n] [-P <KEY1=VALUE1;KEY2=VALUE2...>] [-I <ERR1,ERR2...>]
Copy to Clipboard Toggle word wrap
Validate a template with parameters.

Optional arguments

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

12.49. heat template-version-list
Copy link

usage: heat template-version-list
Copy to Clipboard Toggle word wrap
List the available template versions.

Chapter 13. Telemetry service command-line client
Copy link

The ceilometer client is the command-line interface (CLI) for the Telemetry service API and its extensions. This chapter documents ceilometer version 2.3.0.
For help on a specific ceilometer command, enter: 
$ ceilometer help COMMAND
Copy to Clipboard Toggle word wrap

13.1. ceilometer usage
Copy link

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

Subcommands

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

13.2. ceilometer optional arguments
Copy link

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

13.3. ceilometer alarm-combination-create
Copy link

usage: ceilometer alarm-combination-create --name <NAME> [--project-id <ALARM_PROJECT_ID>] [--user-id <ALARM_USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--time-constraint <Time Constraint>] [--repeat-actions {True|False}] --alarm_ids <ALARM IDS> [--operator <OPERATOR>]
Copy to Clipboard Toggle word wrap
Create a new alarm based on state of other alarms.

Optional arguments

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

13.4. ceilometer alarm-combination-update
Copy link

usage: ceilometer alarm-combination-update [--name <NAME>] [--project-id <ALARM_PROJECT_ID>] [--user-id <ALARM_USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--time-constraint <Time Constraint>] [--repeat-actions {True|False}] [--remove-time-constraint <Constraint names>] [--alarm_ids <ALARM IDS>] [--operator <OPERATOR>] [<ALARM_ID>]
Copy to Clipboard Toggle word wrap
Update an existing alarm based on state of other alarms.

Positional arguments

<ALARM_ID>
ID of the alarm to update.

Optional arguments

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

13.5. ceilometer alarm-delete
Copy link

usage: ceilometer alarm-delete [<ALARM_ID>]
Copy to Clipboard Toggle word wrap
Delete an alarm.

Positional arguments

<ALARM_ID>
ID of the alarm to delete.

13.6. ceilometer alarm-event-create
Copy link

usage: ceilometer alarm-event-create --name <NAME> [--project-id <ALARM_PROJECT_ID>] [--user-id <ALARM_USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--time-constraint <Time Constraint>] [--repeat-actions {True|False}] [--event-type <EVENT_TYPE>] [-q <QUERY>]
Copy to Clipboard Toggle word wrap
Create a new alarm based on events.

Optional arguments

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

13.7. ceilometer alarm-event-update
Copy link

usage: ceilometer alarm-event-update [--name <NAME>] [--project-id <ALARM_PROJECT_ID>] [--user-id <ALARM_USER_ID>] [--description <DESCRIPTION>] [--state <STATE>] [--severity <SEVERITY>] [--enabled {True|False}] [--alarm-action <Webhook URL>] [--ok-action <Webhook URL>] [--insufficient-data-action <Webhook URL>] [--time-constraint <Time Constraint>] [--repeat-actions {True|False}] [--event-type <EVENT_TYPE>] [-q <QUERY>] [<ALARM_ID>]
Copy to Clipboard Toggle word wrap
Update an existing alarm based on events.

Positional arguments

<ALARM_ID>
ID of the alarm to update.

Optional arguments

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

Optional arguments

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

Positional arguments

<ALARM_ID>
ID of the alarm to update.

Optional arguments

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

Optional arguments

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

Positional arguments

<ALARM_ID>
ID of the alarm to update.

Optional arguments

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

Optional arguments

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

Positional arguments

<ALARM_ID>
ID of the alarm to update.

Optional arguments

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

13.14. ceilometer alarm-history
Copy link

usage: ceilometer alarm-history [-q <QUERY>] [<ALARM_ID>]
Copy to Clipboard Toggle word wrap
Display the change history of an alarm.

Positional arguments

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

Optional arguments

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

13.15. ceilometer alarm-list
Copy link

usage: ceilometer alarm-list [-q <QUERY>]
Copy to Clipboard Toggle word wrap
List the user's alarms.

Optional arguments

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

13.16. ceilometer alarm-show
Copy link

usage: ceilometer alarm-show [<ALARM_ID>]
Copy to Clipboard Toggle word wrap
Show an alarm.

Positional arguments

<ALARM_ID>
ID of the alarm to show.

13.17. ceilometer alarm-state-get
Copy link

usage: ceilometer alarm-state-get [<ALARM_ID>]
Copy to Clipboard Toggle word wrap
Get the state of an alarm.

Positional arguments

<ALARM_ID>
ID of the alarm state to show.

13.18. ceilometer alarm-state-set
Copy link

usage: ceilometer alarm-state-set --state <STATE> [<ALARM_ID>]
Copy to Clipboard Toggle word wrap
Set the state of an alarm.

Positional arguments

<ALARM_ID>
ID of the alarm state to set.

Optional arguments

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

13.19. ceilometer alarm-threshold-create
Copy link

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

Optional arguments

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

13.20. ceilometer alarm-threshold-update
Copy link

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

Positional arguments

<ALARM_ID>
ID of the alarm to update.

Optional arguments

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

13.21. ceilometer capabilities
Copy link

usage: ceilometer capabilities
Copy to Clipboard Toggle word wrap
Print Ceilometer capabilities.

13.22. ceilometer event-list
Copy link

usage: ceilometer event-list [-q <QUERY>] [--no-traits] [-l <NUMBER>]
Copy to Clipboard Toggle word wrap
List events.

Optional arguments

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

13.23. ceilometer event-show
Copy link

usage: ceilometer event-show <message_id>
Copy to Clipboard Toggle word wrap
Show a particular event.

Positional arguments

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

13.24. ceilometer event-type-list
Copy link

usage: ceilometer event-type-list
Copy to Clipboard Toggle word wrap
List event types.

13.25. ceilometer meter-list
Copy link

usage: ceilometer meter-list [-q <QUERY>] [-l <NUMBER>]
Copy to Clipboard Toggle word wrap
List the user's meters.

Optional arguments

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

13.26. ceilometer query-alarm-history
Copy link

usage: ceilometer query-alarm-history [-f <FILTER>] [-o <ORDERBY>] [-l <LIMIT>]
Copy to Clipboard Toggle word wrap
Query Alarm History.

Optional arguments

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

13.27. ceilometer query-alarms
Copy link

usage: ceilometer query-alarms [-f <FILTER>] [-o <ORDERBY>] [-l <LIMIT>]
Copy to Clipboard Toggle word wrap
Query Alarms.

Optional arguments

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

13.28. ceilometer query-samples
Copy link

usage: ceilometer query-samples [-f <FILTER>] [-o <ORDERBY>] [-l <LIMIT>]
Copy to Clipboard Toggle word wrap
Query samples.

Optional arguments

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

13.29. ceilometer resource-list
Copy link

usage: ceilometer resource-list [-q <QUERY>] [-l <NUMBER>]
Copy to Clipboard Toggle word wrap
List the resources.

Optional arguments

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

13.30. ceilometer resource-show
Copy link

usage: ceilometer resource-show <RESOURCE_ID>
Copy to Clipboard Toggle word wrap
Show the resource.

Positional arguments

<RESOURCE_ID>
ID of the resource to show.

13.31. ceilometer sample-create
Copy link

usage: ceilometer sample-create [--project-id <SAMPLE_PROJECT_ID>] [--user-id <SAMPLE_USER_ID>] -r <RESOURCE_ID> -m <METER_NAME> --meter-type <METER_TYPE> --meter-unit <METER_UNIT> --sample-volume <SAMPLE_VOLUME> [--resource-metadata <RESOURCE_METADATA>] [--timestamp <TIMESTAMP>] [--direct <DIRECT>]
Copy to Clipboard Toggle word wrap
Create a sample.

Optional arguments

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

13.32. ceilometer sample-create-list
Copy link

usage: ceilometer sample-create-list [--direct <DIRECT>] <SAMPLES_LIST>
Copy to Clipboard Toggle word wrap
Create a sample list.

Positional arguments

<SAMPLES_LIST>
Json array with samples to create.

Optional arguments

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

13.33. ceilometer sample-list
Copy link

usage: ceilometer sample-list [-q <QUERY>] [-m <NAME>] [-l <NUMBER>]
Copy to Clipboard Toggle word wrap
List the samples (return OldSample objects if -m/--meter is set).

Optional arguments

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

13.34. ceilometer sample-show
Copy link

usage: ceilometer sample-show <SAMPLE_ID>
Copy to Clipboard Toggle word wrap
Show a sample.

Positional arguments

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

13.35. ceilometer statistics
Copy link

usage: ceilometer statistics [-q <QUERY>] -m <NAME> [-p <PERIOD>] [-g <FIELD>] [-a <FUNC>[<-<PARAM>]]
Copy to Clipboard Toggle word wrap
List the statistics for a meter.

Optional arguments

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

13.36. ceilometer trait-description-list
Copy link

usage: ceilometer trait-description-list -e <EVENT_TYPE>
Copy to Clipboard Toggle word wrap
List trait info for an event type.

Optional arguments

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

13.37. ceilometer trait-list
Copy link

usage: ceilometer trait-list -e <EVENT_TYPE> -t <TRAIT_NAME>
Copy to Clipboard Toggle word wrap
List all traits with name <trait_name> for Event Type <event_type>.

Optional arguments

-e <EVENT_TYPE>, --event_type <EVENT_TYPE>
Type of the event for which traits will listed. Required.
-t <TRAIT_NAME>, --trait_name <TRAIT_NAME>
The name of the trait to list. Required.
The sahara client is the command-line interface (CLI) for the Data Processing service API and its extensions. This chapter documents sahara version 0.13.0.
For help on a specific sahara command, enter: 
$ sahara help COMMAND
Copy to Clipboard Toggle word wrap

14.1. sahara usage
Copy link

usage: sahara [--version] [--debug] [--os-cache] [--region-name <region-name>] [--service-type <service-type>] [--endpoint-type <endpoint-type>] [--sahara-api-version <sahara-api-ver>] [--bypass-url <bypass-url>] [--os-tenant-name OS_TENANT_NAME] [--os-tenant-id OS_TENANT_ID] [--os-auth-system OS_AUTH_SYSTEM] [--os-auth-token OS_AUTH_TOKEN] [--insecure] [--os-cacert <ca-certificate>] [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>] [--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID] [--os-domain-name OS_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID] [--os-project-name OS_PROJECT_NAME] [--os-project-domain-id OS_PROJECT_DOMAIN_ID] [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] [--os-trust-id OS_TRUST_ID] [--os-user-id OS_USER_ID] [--os-username OS_USERNAME] [--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-password OS_PASSWORD] <subcommand> ...
Copy to Clipboard Toggle word wrap

Subcommands

cluster-create
Create a cluster.
cluster-delete
Delete a cluster.
cluster-list
Print a list of available clusters.
cluster-scale
Scale a cluster.
cluster-show
Show details of a cluster.
cluster-template-create
Create a cluster template.
cluster-template-delete
Delete a cluster template.
cluster-template-list
Print a list of available cluster templates.
cluster-template-show
Show details of a cluster template.
cluster-template-update
Update a cluster template.
data-source-create
Create a data source that provides job input or receives job output.
data-source-delete
Delete a data source.
data-source-list
Print a list of available data sources.
data-source-show
Show details of a data source.
data-source-update
Update a data source.
image-add-tag
Add a tag to an image.
image-list
Print a list of available images.
image-register
Register an image from the Image index.
image-remove-tag
Remove a tag from an image.
image-show
Show details of an image.
image-unregister
Unregister an image.
job-binary-create
Record a job binary.
job-binary-data-create
Store data in the internal DB. Use 'swift upload' instead of this command. Use this command only if Swift is not available.
job-binary-data-delete
Delete an internally stored job binary data.
job-binary-data-list
Print a list of internally stored job binary data.
job-binary-delete
Delete a job binary.
job-binary-list
Print a list of job binaries.
job-binary-show
Show details of a job binary.
job-binary-update
Update a job binary.
job-create
Create a job.
job-delete
Delete a job.
job-list
Print a list of jobs.
job-show
Show details of a job.
job-template-create
Create a job template.
job-template-delete
Delete a job template.
job-template-list
Print a list of job templates.
job-template-show
Show details of a job template.
job-type-list
Show supported job types.
node-group-template-create
Create a node group template.
node-group-template-delete
Delete a node group template.
node-group-template-list
Print a list of available node group templates.
node-group-template-show
Show details of a node group template.
node-group-template-update
Update a node group template.
plugin-list
Print a list of available plugins.
plugin-show
Show details of a plugin.
bash-completion
Prints arguments for bash-completion. Prints all of the commands and options to stdout so that the sahara.bash_completion script doesn't have to hard code them.
help
Display help about this program or one of its subcommands.

14.2. sahara optional arguments
Copy link

--version
show program's version number and exit
--debug
Print debugging output.
--os-cache
Use the auth token cache. Defaults to False if env[OS_CACHE] is not set.
--region-name <region-name>
Defaults to env[OS_REGION_NAME].
--service-type <service-type>
Defaults to data-processing for all actions.
--endpoint-type <endpoint-type>
Defaults to env[SAHARA_ENDPOINT_TYPE] or env[OS_ENDPOINT_TYPE] or publicURL.
--sahara-api-version <sahara-api-ver>
Accepts "api", defaults to env[SAHARA_API_VERSION].
--bypass-url <bypass-url>
Use this API endpoint instead of the Service Catalog.
--os-tenant-name OS_TENANT_NAME
Defaults to env[OS_TENANT_NAME].
--os-tenant-id OS_TENANT_ID
Defaults to env[OS_TENANT_ID].
--os-auth-system OS_AUTH_SYSTEM
Defaults to env[OS_AUTH_SYSTEM].
--os-auth-token OS_AUTH_TOKEN
Defaults to env[OS_AUTH_TOKEN].
--os-auth-url OS_AUTH_URL
Authentication URL
--os-domain-id OS_DOMAIN_ID
Domain ID to scope to
--os-domain-name OS_DOMAIN_NAME
Domain name to scope to
--os-project-id OS_PROJECT_ID
Project ID to scope to
--os-project-name OS_PROJECT_NAME
Project name to scope to
--os-project-domain-id OS_PROJECT_DOMAIN_ID
Domain ID containing project
--os-project-domain-name OS_PROJECT_DOMAIN_NAME
Domain name containing project
--os-trust-id OS_TRUST_ID
Trust ID
--os-user-id OS_USER_ID
User ID
--os-username OS_USERNAME, --os-user_name OS_USERNAME
Username
--os-user-domain-id OS_USER_DOMAIN_ID
User's domain id
--os-user-domain-name OS_USER_DOMAIN_NAME
User's domain name
--os-password OS_PASSWORD
User's password

14.3. sahara cluster-create
Copy link

usage: sahara cluster-create [--json JSON] [--count COUNT]
Copy to Clipboard Toggle word wrap
Create a cluster.

Optional arguments

--json JSON
JSON representation of cluster.
--count COUNT
Number of clusters to create.

14.4. sahara cluster-delete
Copy link

usage: sahara cluster-delete [--name NAME] [--id <cluster_id>]
Copy to Clipboard Toggle word wrap
Delete a cluster.

Optional arguments

--name NAME
Name of the cluster.
--id <cluster_id>
ID of the cluster to delete.

14.5. sahara cluster-list
Copy link

usage: sahara cluster-list
Copy to Clipboard Toggle word wrap
Print a list of available clusters.

14.6. sahara cluster-scale
Copy link

usage: sahara cluster-scale [--name NAME] [--id <cluster_id>] [--json JSON]
Copy to Clipboard Toggle word wrap
Scale a cluster.

Optional arguments

--name NAME
Name of the cluster.
--id <cluster_id>
ID of the cluster.
--json JSON
JSON representation of cluster scale.

14.7. sahara cluster-show
Copy link

usage: sahara cluster-show [--name NAME] [--id <cluster_id>] [--show-progress SHOW_PROGRESS] [--json]
Copy to Clipboard Toggle word wrap
Show details of a cluster.

Optional arguments

--name NAME
Name of the cluster.
--id <cluster_id>
ID of the cluster to show.
--show-progress SHOW_PROGRESS
Show provision progress events of the cluster.
--json
Print JSON representation of the cluster.

14.8. sahara cluster-template-create
Copy link

usage: sahara cluster-template-create [--json JSON]
Copy to Clipboard Toggle word wrap
Create a cluster template.

Optional arguments

--json JSON
JSON representation of cluster template.

14.9. sahara cluster-template-delete
Copy link

usage: sahara cluster-template-delete [--name NAME] [--id <template_id>]
Copy to Clipboard Toggle word wrap
Delete a cluster template.

Optional arguments

--name NAME
Name of the cluster template.
--id <template_id>
ID of the cluster template to delete.

14.10. sahara cluster-template-list
Copy link

usage: sahara cluster-template-list
Copy to Clipboard Toggle word wrap
Print a list of available cluster templates.

14.11. sahara cluster-template-show
Copy link

usage: sahara cluster-template-show [--name NAME] [--id <template_id>] [--json]
Copy to Clipboard Toggle word wrap
Show details of a cluster template.

Optional arguments

--name NAME
Name of the cluster template.
--id <template_id>
ID of the cluster template to show.
--json
Print JSON representation of cluster template.

14.12. sahara cluster-template-update
Copy link

usage: sahara cluster-template-update [--name NAME] [--id <template_id>] [--json JSON]
Copy to Clipboard Toggle word wrap
Update a cluster template.

Optional arguments

--name NAME
Name of the cluster template to update.
--id <template_id>
ID of the cluster template to update.
--json JSON
JSON representation of cluster template update.

14.13. sahara data-source-create
Copy link

usage: sahara data-source-create --name NAME --type TYPE --url URL [--description DESCRIPTION] [--user USER] [--password PASSWORD]
Copy to Clipboard Toggle word wrap
Create a data source that provides job input or receives job output.

Optional arguments

--name NAME
Name of the data source.
--type TYPE
Type of the data source.
--url URL
URL for the data source.
--description DESCRIPTION
Description of the data source.
--user USER
Username for accessing the data source URL.
--password PASSWORD
Password for accessing the data source URL.

14.14. sahara data-source-delete
Copy link

usage: sahara data-source-delete [--name NAME] [--id ID]
Copy to Clipboard Toggle word wrap
Delete a data source.

Optional arguments

--name NAME
Name of the data source.
--id ID
ID of data source to delete.

14.15. sahara data-source-list
Copy link

usage: sahara data-source-list
Copy to Clipboard Toggle word wrap
Print a list of available data sources.

14.16. sahara data-source-show
Copy link

usage: sahara data-source-show [--name NAME] [--id ID]
Copy to Clipboard Toggle word wrap
Show details of a data source.

Optional arguments

--name NAME
Name of the data source.
--id ID
ID of the data source.

14.17. sahara data-source-update
Copy link

usage: sahara data-source-update [--name NAME] [--id ID] [--json JSON]
Copy to Clipboard Toggle word wrap
Update a data source.

Optional arguments

--name NAME
Name of the data source to update.
--id ID
ID of the data source to update.
--json JSON
JSON containing the data source fields to update.

14.18. sahara image-add-tag
Copy link

usage: sahara image-add-tag [--name NAME] [--id <image_id>] --tag <tag>
Copy to Clipboard Toggle word wrap
Add a tag to an image.

Optional arguments

--name NAME
Name of the image.
--id <image_id>
ID of image to tag.
--tag <tag>
Tag to add.

14.19. sahara image-list
Copy link

usage: sahara image-list
Copy to Clipboard Toggle word wrap
Print a list of available images.

14.20. sahara image-register
Copy link

usage: sahara image-register --id <image_id> [--username <name>] [--description <desc>]
Copy to Clipboard Toggle word wrap
Register an image from the Image index.

Optional arguments

--id <image_id>
ID of image, run "glance image-list" to see all IDs.
--username <name>
Username of privileged user in the image.
--description <desc>
Description of the image.

14.21. sahara image-remove-tag
Copy link

usage: sahara image-remove-tag [--name NAME] [--id <image_id>] --tag <tag>
Copy to Clipboard Toggle word wrap
Remove a tag from an image.

Optional arguments

--name NAME
Name of the image.
--id <image_id>
Image to tag.
--tag <tag>
Tag to remove.

14.22. sahara image-show
Copy link

usage: sahara image-show [--name NAME] [--id <image_id>]
Copy to Clipboard Toggle word wrap
Show details of an image.

Optional arguments

--name NAME
Name of the image.
--id <image_id>
ID of the image.

14.23. sahara image-unregister
Copy link

usage: sahara image-unregister [--name NAME] [--id <image_id>]
Copy to Clipboard Toggle word wrap
Unregister an image.

Optional arguments

--name NAME
Name of the image.
--id <image_id>
ID of image to unregister.

14.24. sahara job-binary-create
Copy link

usage: sahara job-binary-create --name NAME --url URL [--description DESCRIPTION] [--user USER] [--password PASSWORD]
Copy to Clipboard Toggle word wrap
Record a job binary.

Optional arguments

--name NAME
Name of the job binary.
--url URL
URL for the job binary.
--description DESCRIPTION
Description of the job binary.
--user USER
Username for accessing the job binary URL.
--password PASSWORD
Password for accessing the job binary URL.

14.25. sahara job-binary-data-create
Copy link

usage: sahara job-binary-data-create [--file FILE] [--name NAME]
Copy to Clipboard Toggle word wrap
Store data in the internal DB. Use 'swift upload' instead of this command. Use this command only if Swift is not available.

Optional arguments

--file FILE
Data to store.
--name NAME
Name of the job binary internal.

14.26. sahara job-binary-data-delete
Copy link

usage: sahara job-binary-data-delete --id ID
Copy to Clipboard Toggle word wrap
Delete an internally stored job binary data.

Optional arguments

--id ID
ID of internally stored job binary data.

14.27. sahara job-binary-data-list
Copy link

usage: sahara job-binary-data-list
Copy to Clipboard Toggle word wrap
Print a list of internally stored job binary data.

14.28. sahara job-binary-delete
Copy link

usage: sahara job-binary-delete [--name NAME] [--id ID]
Copy to Clipboard Toggle word wrap
Delete a job binary.

Optional arguments

--name NAME
Name of the job binary.
--id ID
ID of the job binary to delete.

14.29. sahara job-binary-list
Copy link

usage: sahara job-binary-list
Copy to Clipboard Toggle word wrap
Print a list of job binaries.

14.30. sahara job-binary-show
Copy link

usage: sahara job-binary-show [--name NAME] [--id ID]
Copy to Clipboard Toggle word wrap
Show details of a job binary.

Optional arguments

--name NAME
Name of the job binary.
--id ID
ID of the job binary.

14.31. sahara job-binary-update
Copy link

usage: sahara job-binary-update [--name NAME] [--id <job_binary_id>] [--json JSON]
Copy to Clipboard Toggle word wrap
Update a job binary.

Optional arguments

--name NAME
Name of the job binary to update.
--id <job_binary_id>
ID of the job binary to update.
--json JSON
JSON representation of job binary update.

14.32. sahara job-create
Copy link

usage: sahara job-create --job-template JOB_TEMPLATE [--cluster CLUSTER] [--input-data INPUT_DATA] [--output-data OUTPUT_DATA] [--param name=value] [--arg ARG] [--config name=value] [--json JSON]
Copy to Clipboard Toggle word wrap
Create a job.

Optional arguments

--job-template JOB_TEMPLATE
ID of the job template to run.
--cluster CLUSTER
ID of the cluster to run the job in.
--input-data INPUT_DATA
ID of the input data source.
--output-data OUTPUT_DATA
ID of the output data source.
--param
name=value Parameters to add to the job, repeatable.
--arg ARG
Arguments to add to the job, repeatable.
--config
name=value Config parameters to add to the job, repeatable.
--json JSON
JSON representation of the job.

14.33. sahara job-delete
Copy link

usage: sahara job-delete --id ID
Copy to Clipboard Toggle word wrap
Delete a job.

Optional arguments

--id ID
ID of a job.

14.34. sahara job-list
Copy link

usage: sahara job-list
Copy to Clipboard Toggle word wrap
Print a list of jobs.

14.35. sahara job-show
Copy link

usage: sahara job-show --id ID
Copy to Clipboard Toggle word wrap
Show details of a job.

Optional arguments

--id ID
ID of the job.

14.36. sahara job-template-create
Copy link

usage: sahara job-template-create [--name NAME] [--type TYPE] [--main MAIN] [--lib LIB] [--description DESCRIPTION] [--json JSON]
Copy to Clipboard Toggle word wrap
Create a job template.

Optional arguments

--name NAME
Name of the job template.
--type TYPE
Type of the job template.
--main MAIN
ID for job's main job-binary.
--lib LIB
ID of job's lib job-binary, repeatable.
--description DESCRIPTION
Description of the job template.
--json JSON
JSON representation of job template.

14.37. sahara job-template-delete
Copy link

usage: sahara job-template-delete [--name NAME] [--id ID]
Copy to Clipboard Toggle word wrap
Delete a job template.

Optional arguments

--name NAME
Name of the job template.
--id ID
ID of the job template.

14.38. sahara job-template-list
Copy link

usage: sahara job-template-list
Copy to Clipboard Toggle word wrap
Print a list of job templates.

14.39. sahara job-template-show
Copy link

usage: sahara job-template-show [--name NAME] [--id ID]
Copy to Clipboard Toggle word wrap
Show details of a job template.

Optional arguments

--name NAME
Name of the job template.
--id ID
ID of the job template.

14.40. sahara job-type-list
Copy link

usage: sahara job-type-list [--type <job_type>] [--plugin <plugin>] [--plugin-version <plugin_version>]
Copy to Clipboard Toggle word wrap
Show supported job types.

Optional arguments

--type <job_type>
Report only on this job type.
--plugin <plugin>
Report only job types supported by this plugin.
--plugin-version <plugin_version>
Report only on job types supported by this version of a specified plugin. Only valid with --plugin.

14.41. sahara node-group-template-create
Copy link

usage: sahara node-group-template-create [--json JSON]
Copy to Clipboard Toggle word wrap
Create a node group template.

Optional arguments

--json JSON
JSON representation of node group template.

14.42. sahara node-group-template-delete
Copy link

usage: sahara node-group-template-delete [--name NAME] [--id <template_id>]
Copy to Clipboard Toggle word wrap
Delete a node group template.

Optional arguments

--name NAME
Name of the node group template.
--id <template_id>
ID of the node group template to delete.

14.43. sahara node-group-template-list
Copy link

usage: sahara node-group-template-list
Copy to Clipboard Toggle word wrap
Print a list of available node group templates.

14.44. sahara node-group-template-show
Copy link

usage: sahara node-group-template-show [--name NAME] [--id <template_id>] [--json]
Copy to Clipboard Toggle word wrap
Show details of a node group template.

Optional arguments

--name NAME
Name of the node group template.
--id <template_id>
ID of the node group template to show.
--json
Print JSON representation of node group template.

14.45. sahara node-group-template-update
Copy link

usage: sahara node-group-template-update [--name NAME] [--id <template_id>] [--json JSON]
Copy to Clipboard Toggle word wrap
Update a node group template.

Optional arguments

--name NAME
Name of the node group template to update.
--id <template_id>
ID of the node group template to update.
--json JSON
JSON representation of the node group template update.

14.46. sahara plugin-list
Copy link

usage: sahara plugin-list
Copy to Clipboard Toggle word wrap
Print a list of available plugins.

14.47. sahara plugin-show
Copy link

usage: sahara plugin-show --name <plugin>
Copy to Clipboard Toggle word wrap
Show details of a plugin.

Optional arguments

--name <plugin>
Name of the plugin.

Chapter 15. Database service command-line client
Copy link

Warning
Beginning in Red Hat OpenStack Platform 10, the OpenStack Trove service will no longer be included in the Red Hat OpenStack Platform distribution. We are working with a trusted partner to provide our customers with a production ready DBaaS service. Please contact your sales account manager to learn more about this option.
The trove client is the command-line interface (CLI) for the Database service API and its extensions. This chapter documents trove version 2.1.1.
For help on a specific trove command, enter: 
$ trove help COMMAND
Copy to Clipboard Toggle word wrap

15.1. trove usage
Copy link

usage: trove [--version] [--debug] [--os-auth-system <auth-system>] [--service-type <service-type>] [--service-name <service-name>] [--bypass-url <bypass-url>] [--database-service-name <database-service-name>] [--endpoint-type <endpoint-type>] [--os-database-api-version <database-api-ver>] [--retries <retries>] [--json] [--profile HMAC_KEY] [--insecure] [--os-cacert <ca-certificate>] [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>] [--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID] [--os-domain-name OS_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID] [--os-project-name OS_PROJECT_NAME] [--os-project-domain-id OS_PROJECT_DOMAIN_ID] [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] [--os-trust-id OS_TRUST_ID] [--os-user-id OS_USER_ID] [--os-username OS_USERNAME] [--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-password OS_PASSWORD] [--os-tenant-name <auth-tenant-name>] [--os-tenant-id <tenant-id>] [--os-auth-token OS_AUTH_TOKEN] [--os-region-name <region-name>] <subcommand> ...
Copy to Clipboard Toggle word wrap

Subcommands

backup-copy
Creates a backup from another backup.
backup-create
Creates a backup of an instance.
backup-delete
Deletes a backup.
backup-list
Lists available backups.
backup-list-instance
Lists available backups for an instance.
backup-show
Shows details of a backup.
cluster-create
Creates a new cluster.
cluster-delete
Deletes a cluster.
cluster-grow
Adds more instances to a cluster.
cluster-instances
Lists all instances of a cluster.
cluster-list
Lists all the clusters.
cluster-show
Shows details of a cluster.
cluster-shrink
Drops instances from a cluster.
configuration-attach
Attaches a configuration group to an instance.
configuration-create
Creates a configuration group.
configuration-default
Shows the default configuration of an instance.
configuration-delete
Deletes a configuration group.
configuration-detach
Detaches a configuration group from an instance.
configuration-instances
Lists all instances associated with a configuration group.
configuration-list
Lists all configuration groups.
configuration-parameter-list
Lists available parameters for a configuration group.
configuration-parameter-show
Shows details of a configuration parameter.
configuration-patch
Patches a configuration group.
configuration-show
Shows details of a configuration group.
configuration-update
Updates a configuration group.
create
Creates a new instance.
database-create
Creates a database on an instance.
database-delete
Deletes a database from an instance.
database-list
Lists available databases on an instance.
datastore-list
Lists available datastores.
datastore-show
Shows details of a datastore.
datastore-version-list
Lists available versions for a datastore.
datastore-version-show
Shows details of a datastore version.
delete
Deletes an instance.
detach-replica
Detaches a replica instance from its replication source.
eject-replica-source
Ejects a replica source from its set.
flavor-list
Lists available flavors.
flavor-show
Shows details of a flavor.
limit-list
Lists the limits for a tenant.
list
Lists all the instances.
log-disable
Instructs Trove guest to stop collecting log details.
log-discard
Instructs Trove guest to discard the container of the published log.
log-enable
Instructs Trove guest to start collecting log details.
log-list
Lists the log files available for instance.
log-publish
Instructs Trove guest to publish latest log entries on instance.
log-save
Save log file for instance.
log-show
Instructs Trove guest to show details of log.
log-tail
Display log entries for instance.
metadata-create
Creates metadata in the database for instance <id>.
metadata-delete
Deletes metadata for instance <id>.
metadata-edit
Replaces metadata value with a new one, this is non-destructive.
metadata-list
Shows all metadata for instance <id>.
metadata-show
Shows metadata entry for key <key> and instance <id>.
metadata-update
Updates metadata, this is destructive.
module-create
Create a module.
module-delete
Delete a module.
module-list
Lists the modules available.
module-show
Shows details of a module.
module-update
Create a module.
promote-to-replica-source
Promotes a replica to be the new replica source of its set.
resize-instance
Resizes an instance with a new flavor.
resize-volume
Resizes the volume size of an instance.
restart
Restarts an instance.
root-disable
Disables root for an instance.
root-enable
Enables root for an instance and resets if already exists.
root-show
Gets status if root was ever enabled for an instance or cluster.
secgroup-add-rule
Creates a security group rule.
secgroup-delete-rule
Deletes a security group rule.
secgroup-list
Lists all security groups.
secgroup-list-rules
Lists all rules for a security group.
secgroup-show
Shows details of a security group.
show
Shows details of an instance.
update
Updates an instance: Edits name, configuration, or replica source.
user-create
Creates a user on an instance.
user-delete
Deletes a user from an instance.
user-grant-access
Grants access to a database(s) for a user.
user-list
Lists the users for an instance.
user-revoke-access
Revokes access to a database for a user.
user-show
Shows details of a user of an instance.
user-show-access
Shows access details of a user of an instance.
user-update-attributes
Updates a user's attributes on an instance.
bash-completion
Prints arguments for bash_completion.
help
Displays help about this program or one of its subcommands.

15.2. trove optional arguments
Copy link

--version
Show program's version number and exit.
--debug
Print debugging output.
--os-auth-system <auth-system>
Defaults to env[OS_AUTH_SYSTEM].
--service-type <service-type>
Defaults to database for most actions.
--service-name <service-name>
Defaults to env[TROVE_SERVICE_NAME].
--bypass-url <bypass-url>
Defaults to env[TROVE_BYPASS_URL].
--database-service-name <database-service-name>
Defaults to env[TROVE_DATABASE_SERVICE_NAME].
--endpoint-type <endpoint-type>
Defaults to env[TROVE_ENDPOINT_TYPE] or env[OS_ENDPOINT_TYPE] or publicURL.
--os-database-api-version <database-api-ver>
Accepts 1, defaults to env[OS_DATABASE_API_VERSION].
--retries <retries>
Number of retries.
--json, --os-json-output
Output JSON instead of prettyprint. Defaults to env[OS_JSON_OUTPUT].
--profile HMAC_KEY
HMAC key used to encrypt context data when profiling the performance of an operation. This key should be set to one of the HMAC keys configured in Trove (they are found in api-paste.ini, typically in /etc/trove). Without the key, profiling will not be triggered even if it is enabled on the server side. Defaults to env[OS_PROFILE_HMACKEY].
--insecure
Explicitly allow client to perform "insecure" TLS (https) requests. The server's certificate will not be verified against any certificate authorities. This option should be used with caution.
--os-cacert <ca-certificate>
Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to env[OS_CACERT].
--os-cert <certificate>
Defaults to env[OS_CERT].
--os-key <key>
Defaults to env[OS_KEY].
--timeout <seconds>
Set request timeout (in seconds).
--os-auth-url OS_AUTH_URL
Authentication URL
--os-domain-id OS_DOMAIN_ID
Domain ID to scope to
--os-domain-name OS_DOMAIN_NAME
Domain name to scope to
--os-project-id OS_PROJECT_ID
Project ID to scope to
--os-project-name OS_PROJECT_NAME
Project name to scope to
--os-project-domain-id OS_PROJECT_DOMAIN_ID
Domain ID containing project
--os-project-domain-name OS_PROJECT_DOMAIN_NAME
Domain name containing project
--os-trust-id OS_TRUST_ID
Trust ID
--os-user-id OS_USER_ID
User ID
--os-username OS_USERNAME, --os-user_name OS_USERNAME
Username
--os-user-domain-id OS_USER_DOMAIN_ID
User's domain id
--os-user-domain-name OS_USER_DOMAIN_NAME
User's domain name
--os-password OS_PASSWORD
User's password
--os-tenant-name <auth-tenant-name>
Tenant to request authorization on. Defaults to env[OS_TENANT_NAME].
--os-tenant-id <tenant-id>
Tenant to request authorization on. Defaults to env[OS_TENANT_ID].
--os-auth-token OS_AUTH_TOKEN
Defaults to env[OS_AUTH_TOKEN]
--os-region-name <region-name>
Specify the region to use. Defaults to env[OS_REGION_NAME].

15.3. trove backup-copy
Copy link

usage: trove backup-copy <name> <backup> [--region <region>] [--description <description>]
Copy to Clipboard Toggle word wrap
Creates a backup from another backup.

Positional arguments

<name>
Name of the backup.
<backup>
Backup ID of the source backup.

Optional arguments

--region <region>
Region where the source backup resides.
--description <description>
An optional description for the backup.

15.4. trove backup-create
Copy link

usage: trove backup-create <instance> <name> [--description <description>] [--parent <parent>]
Copy to Clipboard Toggle word wrap
Creates a backup of an instance.

Positional arguments

<instance>
ID or name of the instance.
<name>
Name of the backup.

Optional arguments

--description <description>
An optional description for the backup.
--parent <parent>
Optional ID of the parent backup to perform an incremental backup from.

15.5. trove backup-delete
Copy link

usage: trove backup-delete <backup>
Copy to Clipboard Toggle word wrap
Deletes a backup.

Positional arguments

<backup>
ID or name of the backup.

15.6. trove backup-list
Copy link

usage: trove backup-list [--limit <limit>] [--marker <ID>] [--datastore <datastore>]
Copy to Clipboard Toggle word wrap
Lists available backups.

Optional arguments

--limit <limit>
Return up to N number of the most recent backups.
--marker <ID>
Begin displaying the results for IDs greater than the specified marker. When used with --limit, set this to the last ID displayed in the previous run.
--datastore <datastore>
Name or ID of the datastore to list backups for.

15.7. trove backup-list-instance
Copy link

usage: trove backup-list-instance [--limit <limit>] [--marker <ID>] <instance>
Copy to Clipboard Toggle word wrap
Lists available backups for an instance.

Positional arguments

<instance>
ID or name of the instance.

Optional arguments

--limit <limit>
Return up to N number of the most recent backups.
--marker <ID>
Begin displaying the results for IDs greater than the specified marker. When used with --limit, set this to the last ID displayed in the previous run.

15.8. trove backup-show
Copy link

usage: trove backup-show <backup>
Copy to Clipboard Toggle word wrap
Shows details of a backup.

Positional arguments

<backup>
ID of the backup.

15.9. trove cluster-create
Copy link

usage: trove cluster-create <name> <datastore> <datastore_version> [--instance "<opt=value,opt=value,...>"]
Copy to Clipboard Toggle word wrap
Creates a new cluster.

Positional arguments

<name>
Name of the cluster.
<datastore>
A datastore name or ID.
<datastore_version>
A datastore version name or ID.

Optional arguments

--instance
"<opt=value,opt=value,...>" Create an instance for the cluster. Specify multiple times to create multiple instances. Valid options are: flavor=flavor_name_or_id, volume=disk_size_in_GB, volume_type=type, nic='net-id=net-uuid,v4-fixed-ip=ip-addr ,port-id=port-uuid' (where net- id=network_id, v4-fixed- ip=IPv4r_fixed_address, port-id=port_id), availability_zone=AZ_hint_for_Nova.

15.10. trove cluster-delete
Copy link

usage: trove cluster-delete <cluster>
Copy to Clipboard Toggle word wrap
Deletes a cluster.

Positional arguments

<cluster>
ID or name of the cluster.

15.11. trove cluster-grow
Copy link

usage: trove cluster-grow <cluster> [--instance <name=name,flavor=flavor_name_or_id,volume=volume>]
Copy to Clipboard Toggle word wrap
Adds more instances to a cluster.

Positional arguments

<cluster>
ID or name of the cluster.

Optional arguments

--instance <name=name,flavor=flavor_name_or_id,volume=volume>
Add an instance to the cluster. Specify multiple times to create multiple instances.

15.12. trove cluster-instances
Copy link

usage: trove cluster-instances <cluster>
Copy to Clipboard Toggle word wrap
Lists all instances of a cluster.

Positional arguments

<cluster>
ID or name of the cluster.

15.13. trove cluster-list
Copy link

usage: trove cluster-list [--limit <limit>] [--marker <ID>]
Copy to Clipboard Toggle word wrap
Lists all the clusters.

Optional arguments

--limit <limit>
Limit the number of results displayed.
--marker <ID>
Begin displaying the results for IDs greater than the specified marker. When used with --limit, set this to the last ID displayed in the previous run.

15.14. trove cluster-show
Copy link

usage: trove cluster-show <cluster>
Copy to Clipboard Toggle word wrap
Shows details of a cluster.

Positional arguments

<cluster>
ID or name of the cluster.

15.15. trove cluster-shrink
Copy link

usage: trove cluster-shrink <cluster> <instance> [<instance> ...]
Copy to Clipboard Toggle word wrap
Drops instances from a cluster.

Positional arguments

<cluster>
ID or name of the cluster.
<instance>
Drop instance(s) from the cluster. Specify multiple ids to drop multiple instances.

15.16. trove configuration-attach
Copy link

usage: trove configuration-attach <instance> <configuration>
Copy to Clipboard Toggle word wrap
Attaches a configuration group to an instance.

Positional arguments

<instance>
ID or name of the instance.
<configuration>
ID of the configuration group to attach to the instance.

15.17. trove configuration-create
Copy link

usage: trove configuration-create <name> <values> [--datastore <datastore>] [--datastore_version <datastore_version>] [--description <description>]
Copy to Clipboard Toggle word wrap
Creates a configuration group.

Positional arguments

<name>
Name of the configuration group.
<values>
Dictionary of the values to set.

Optional arguments

--datastore <datastore>
Datastore assigned to the configuration group. Required if default datastore is not configured.
--datastore_version <datastore_version>
Datastore version ID assigned to the configuration group.
--description <description>
An optional description for the configuration group.

15.18. trove configuration-default
Copy link

usage: trove configuration-default <instance>
Copy to Clipboard Toggle word wrap
Shows the default configuration of an instance.

Positional arguments

<instance>
ID or name of the instance.

15.19. trove configuration-delete
Copy link

usage: trove configuration-delete <configuration_group>
Copy to Clipboard Toggle word wrap
Deletes a configuration group.

Positional arguments

<configuration_group>
ID of the configuration group.

15.20. trove configuration-detach
Copy link

usage: trove configuration-detach <instance>
Copy to Clipboard Toggle word wrap
Detaches a configuration group from an instance.

Positional arguments

<instance>
ID or name of the instance.

15.21. trove configuration-instances
Copy link

usage: trove configuration-instances <configuration_group>
Copy to Clipboard Toggle word wrap
Lists all instances associated with a configuration group.

Positional arguments

<configuration_group>
ID of the configuration group.

15.22. trove configuration-list
Copy link

usage: trove configuration-list
Copy to Clipboard Toggle word wrap
Lists all configuration groups.

15.23. trove configuration-parameter-list
Copy link

usage: trove configuration-parameter-list <datastore_version> [--datastore <datastore>]
Copy to Clipboard Toggle word wrap
Lists available parameters for a configuration group.

Positional arguments

<datastore_version>
Datastore version name or ID assigned to the configuration group.

Optional arguments

--datastore <datastore>
ID or name of the datastore to list configuration parameters for. Optional if the ID of the datastore_version is provided.

15.24. trove configuration-parameter-show
Copy link

usage: trove configuration-parameter-show <datastore_version> <parameter> [--datastore <datastore>]
Copy to Clipboard Toggle word wrap
Shows details of a configuration parameter.

Positional arguments

<datastore_version>
Datastore version name or ID assigned to the configuration group.
<parameter>
Name of the configuration parameter.

Optional arguments

--datastore <datastore>
ID or name of the datastore to list configuration parameters for. Optional if the ID of the datastore_version is provided.

15.25. trove configuration-patch
Copy link

usage: trove configuration-patch <configuration_group> <values>
Copy to Clipboard Toggle word wrap
Patches a configuration group.

Positional arguments

<configuration_group>
ID of the configuration group.
<values>
Dictionary of the values to set.

15.26. trove configuration-show
Copy link

usage: trove configuration-show <configuration_group>
Copy to Clipboard Toggle word wrap
Shows details of a configuration group.

Positional arguments

<configuration_group>
ID of the configuration group.

15.27. trove configuration-update
Copy link

usage: trove configuration-update <configuration_group> <values> [--name <name>] [--description <description>]
Copy to Clipboard Toggle word wrap
Updates a configuration group.

Positional arguments

<configuration_group>
ID of the configuration group.
<values>
Dictionary of the values to set.

Optional arguments

--name <name>
Name of the configuration group.
--description <description>
An optional description for the configuration group.

15.28. trove create
Copy link

usage: trove create <name> <flavor> [--size <size>] [--volume_type <volume_type>] [--databases <databases> [<databases> ...]] [--users <users> [<users> ...]] [--backup <backup>] [--availability_zone <availability_zone>] [--datastore <datastore>] [--datastore_version <datastore_version>] [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,port-id=port-uuid>] [--configuration <configuration>] [--replica_of <source_instance>] [--replica_count <count>]
Copy to Clipboard Toggle word wrap
Creates a new instance.

Positional arguments

<name>
Name of the instance.
<flavor>
Flavor ID or name of the instance.

Optional arguments

--size <size>
Size of the instance disk volume in GB. Required when volume support is enabled.
--volume_type <volume_type>
Volume type. Optional when volume support is enabled.
--databases <databases> [<databases> ...]
Optional list of databases.
--users <users> [<users> ...]
Optional list of users in the form user:password.
--backup <backup>
A backup ID.
--availability_zone <availability_zone>
The Zone hint to give to nova.
--datastore <datastore>
A datastore name or ID.
--datastore_version <datastore_version>
A datastore version name or ID.
--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,port-id=port-uuid>
Create a NIC on the instance. Specify option multiple times to create multiple NICs. net- id: attach NIC to network with this ID (either port-id or net-id must be specified), v4-fixed-ip: IPv4 fixed address for NIC (optional), port-id: attach NIC to port with this ID (either port-id or net-id must be specified).
--configuration <configuration>
ID of the configuration group to attach to the instance.
--replica_of <source_instance>
ID or name of an existing instance to replicate from.
--replica_count <count>
Number of replicas to create (defaults to 1).

15.29. trove database-create
Copy link

usage: trove database-create <instance> <name> [--character_set <character_set>] [--collate <collate>]
Copy to Clipboard Toggle word wrap
Creates a database on an instance.

Positional arguments

<instance>
ID or name of the instance.
<name>
Name of the database.

Optional arguments

--character_set <character_set>
Optional character set for database.
--collate <collate>
Optional collation type for database.

15.30. trove database-delete
Copy link

usage: trove database-delete <instance> <database>
Copy to Clipboard Toggle word wrap
Deletes a database from an instance.

Positional arguments

<instance>
ID or name of the instance.
<database>
Name of the database.

15.31. trove database-list
Copy link

usage: trove database-list <instance>
Copy to Clipboard Toggle word wrap
Lists available databases on an instance.

Positional arguments

<instance>
ID or name of the instance.

15.32. trove datastore-list
Copy link

usage: trove datastore-list
Copy to Clipboard Toggle word wrap
Lists available datastores.

15.33. trove datastore-show
Copy link

usage: trove datastore-show <datastore>
Copy to Clipboard Toggle word wrap
Shows details of a datastore.

Positional arguments

<datastore>
ID of the datastore.

15.34. trove datastore-version-list
Copy link

usage: trove datastore-version-list <datastore>
Copy to Clipboard Toggle word wrap
Lists available versions for a datastore.

Positional arguments

<datastore>
ID or name of the datastore.

15.35. trove datastore-version-show
Copy link

usage: trove datastore-version-show <datastore_version> [--datastore <datastore>]
Copy to Clipboard Toggle word wrap
Shows details of a datastore version.

Positional arguments

<datastore_version>
ID or name of the datastore version.

Optional arguments

--datastore <datastore>
ID or name of the datastore. Optional if the ID of the datastore_version is provided.

15.36. trove delete
Copy link

usage: trove delete <instance>
Copy to Clipboard Toggle word wrap
Deletes an instance.

Positional arguments

<instance>
ID or name of the instance.

15.37. trove detach-replica
Copy link

usage: trove detach-replica <instance>
Copy to Clipboard Toggle word wrap
Detaches a replica instance from its replication source.

Positional arguments

<instance>
ID or name of the instance.

15.38. trove eject-replica-source
Copy link

usage: trove eject-replica-source <instance>
Copy to Clipboard Toggle word wrap
Ejects a replica source from its set.

Positional arguments

<instance>
ID or name of the instance.

15.39. trove flavor-list
Copy link

usage: trove flavor-list [--datastore_type <datastore_type>] [--datastore_version_id <datastore_version_id>]
Copy to Clipboard Toggle word wrap
Lists available flavors.

Optional arguments

--datastore_type <datastore_type>
Type of the datastore. For eg: mysql.
--datastore_version_id <datastore_version_id>
ID of the datastore version.

15.40. trove flavor-show
Copy link

usage: trove flavor-show <flavor>
Copy to Clipboard Toggle word wrap
Shows details of a flavor.

Positional arguments

<flavor>
ID or name of the flavor.

15.41. trove limit-list
Copy link

usage: trove limit-list
Copy to Clipboard Toggle word wrap
Lists the limits for a tenant.

15.42. trove list
Copy link

usage: trove list [--limit <limit>] [--marker <ID>] [--include-clustered]
Copy to Clipboard Toggle word wrap
Lists all the instances.

Optional arguments

--limit <limit>
Limit the number of results displayed.
--marker <ID>
Begin displaying the results for IDs greater than the specified marker. When used with --limit, set this to the last ID displayed in the previous run.
--include-clustered
Include instances that are part of a cluster (default false).

15.43. trove log-disable
Copy link

usage: trove log-disable [--discard] <instance> <log_name>
Copy to Clipboard Toggle word wrap
Instructs Trove guest to stop collecting log details.

Positional arguments

<instance>
Id or Name of the instance.
<log_name>
Name of log to publish.

Optional arguments

--discard
Discard published contents of specified log.

15.44. trove log-discard
Copy link

usage: trove log-discard <instance> <log_name>
Copy to Clipboard Toggle word wrap
Instructs Trove guest to discard the container of the published log.

Positional arguments

<instance>
Id or Name of the instance.
<log_name>
Name of log to publish.

15.45. trove log-enable
Copy link

usage: trove log-enable <instance> <log_name>
Copy to Clipboard Toggle word wrap
Instructs Trove guest to start collecting log details.

Positional arguments

<instance>
Id or Name of the instance.
<log_name>
Name of log to publish.

15.46. trove log-list
Copy link

usage: trove log-list <instance>
Copy to Clipboard Toggle word wrap
Lists the log files available for instance.

Positional arguments

<instance>
Id or Name of the instance.

15.47. trove log-publish
Copy link

usage: trove log-publish [--disable] [--discard] <instance> <log_name>
Copy to Clipboard Toggle word wrap
Instructs Trove guest to publish latest log entries on instance.

Positional arguments

<instance>
Id or Name of the instance.
<log_name>
Name of log to publish.

Optional arguments

--disable
Stop collection of specified log.
--discard
Discard published contents of specified log.

15.48. trove log-save
Copy link

usage: trove log-save [--publish] [--file <file>] <instance> <log_name>
Copy to Clipboard Toggle word wrap
Save log file for instance.

Positional arguments

<instance>
Id or Name of the instance.
<log_name>
Name of log to publish.

Optional arguments

--publish
Publish latest entries from guest before display.
--file <file>
Path of file to save log to for instance.

15.49. trove log-show
Copy link

usage: trove log-show <instance> <log_name>
Copy to Clipboard Toggle word wrap
Instructs Trove guest to show details of log.

Positional arguments

<instance>
Id or Name of the instance.
<log_name>
Name of log to show.

15.50. trove log-tail
Copy link

usage: trove log-tail [--publish] [--lines <lines>] <instance> <log_name>
Copy to Clipboard Toggle word wrap
Display log entries for instance.

Positional arguments

<instance>
Id or Name of the instance.
<log_name>
Name of log to publish.

Optional arguments

--publish
Publish latest entries from guest before display.
--lines <lines>
Publish latest entries from guest before display.

15.51. trove metadata-create
Copy link

usage: trove metadata-create <instance_id> <key> <value>
Copy to Clipboard Toggle word wrap
Creates metadata in the database for instance <id>.

Positional arguments

<instance_id>
UUID for instance.
<key>
Key for assignment.
<value>
Value to assign to <key>.

15.52. trove metadata-delete
Copy link

usage: trove metadata-delete <instance_id> <key>
Copy to Clipboard Toggle word wrap
Deletes metadata for instance <id>.

Positional arguments

<instance_id>
UUID for instance.
<key>
Metadata key to delete.

15.53. trove metadata-edit
Copy link

usage: trove metadata-edit <instance_id> <key> <value>
Copy to Clipboard Toggle word wrap
Replaces metadata value with a new one, this is non-destructive.

Positional arguments

<instance_id>
UUID for instance.
<key>
Key to replace.
<value>
New value to assign to <key>.

15.54. trove metadata-list
Copy link

usage: trove metadata-list <instance_id>
Copy to Clipboard Toggle word wrap
Shows all metadata for instance <id>.

Positional arguments

<instance_id>
UUID for instance.

15.55. trove metadata-show
Copy link

usage: trove metadata-show <instance_id> <key>
Copy to Clipboard Toggle word wrap
Shows metadata entry for key <key> and instance <id>.

Positional arguments

<instance_id>
UUID for instance.
<key>
Key to display.

15.56. trove metadata-update
Copy link

usage: trove metadata-update <instance_id> <key> <newkey> <value>
Copy to Clipboard Toggle word wrap
Updates metadata, this is destructive.

Positional arguments

<instance_id>
UUID for instance.
<key>
Key to update.
<newkey>
New key.
<value>
Value to assign to <newkey>.

15.57. trove module-create
Copy link

usage: trove module-create <name> <type> <filename> [--description <description>] [--datastore <datastore>] [--datastore_version <version>] [--auto_apply] [--all_tenants] [--live_update]
Copy to Clipboard Toggle word wrap
Create a module.

Positional arguments

<name>
Name of the module.
<type>
Type of the module. The type must be supported by a corresponding module plugin on the datastore it is applied to.
<filename>
File containing data contents for the module.

Optional arguments

--description <description>
Description of the module.
--datastore <datastore>
Name or ID of datastore this module can be applied to. If not specified, module can be applied to all datastores.
--datastore_version <version>
Name or ID of datastore version this module can be applied to. If not specified, module can be applied to all versions.
--auto_apply
Automatically apply this module when creating an instance or cluster.
--all_tenants
Module is valid for all tenants (Admin only).
--live_update
Allow module to be updated even if it is already applied to a current instance or cluster. Automatically attempt to reapply this module if the contents change.

15.58. trove module-delete
Copy link

usage: trove module-delete <module>
Copy to Clipboard Toggle word wrap
Delete a module.

Positional arguments

<module>
ID or name of the module.

15.59. trove module-list
Copy link

usage: trove module-list [--datastore <datastore>]
Copy to Clipboard Toggle word wrap
Lists the modules available.

Optional arguments

--datastore <datastore>
Name or ID of datastore to list modules for.

15.60. trove module-show
Copy link

usage: trove module-show <module>
Copy to Clipboard Toggle word wrap
Shows details of a module.

Positional arguments

<module>
ID or name of the module.

15.61. trove module-update
Copy link

usage: trove module-update <module> [--name <name>] [--type <type>] [--file <filename>] [--description <description>] [--datastore <datastore>] [--all_datastores] [--datastore_version <version>] [--all_datastore_versions] [--auto_apply] [--no_auto_apply] [--all_tenants] [--no_all_tenants] [--live_update] [--no_live_update]
Copy to Clipboard Toggle word wrap
Create a module.

Positional arguments

<module>
Name or ID of the module.

Optional arguments

--name <name>
Name of the module.
--type <type>
Type of the module. The type must be supported by a corresponding module plugin on the datastore it is applied to.
--file <filename>
File containing data contents for the module.
--description <description>
Description of the module.
--datastore <datastore>
Name or ID of datastore this module can be applied to. If not specified, module can be applied to all datastores.
--all_datastores
Module is valid for all datastores.
--datastore_version <version>
Name or ID of datastore version this module can be applied to. If not specified, module can be applied to all versions.
--all_datastore_versions
Module is valid for all datastore version.
--auto_apply
Automatically apply this module when creating an instance or cluster.
--no_auto_apply
Do not automatically apply this module when creating an instance or cluster.
--all_tenants
Module is valid for all tenants (Admin only).
--no_all_tenants
Module is valid for current tenant only (Admin only).
--live_update
Allow module to be updated or deleted even if it is already applied to a current instance or cluster. Automatically attempt to reapply this module if the contents change.
--no_live_update
Restricts a module from being updated or deleted if it is already applied to a current instance or cluster.

15.62. trove promote-to-replica-source
Copy link

usage: trove promote-to-replica-source <instance>
Copy to Clipboard Toggle word wrap
Promotes a replica to be the new replica source of its set.

Positional arguments

<instance>
ID or name of the instance.

15.63. trove resize-instance
Copy link

usage: trove resize-instance <instance> <flavor>
Copy to Clipboard Toggle word wrap
Resizes an instance with a new flavor.

Positional arguments

<instance>
ID or name of the instance.
<flavor>
New flavor of the instance.

15.64. trove resize-volume
Copy link

usage: trove resize-volume <instance> <size>
Copy to Clipboard Toggle word wrap
Resizes the volume size of an instance.

Positional arguments

<instance>
ID or name of the instance.
<size>
New size of the instance disk volume in GB.

15.65. trove restart
Copy link

usage: trove restart <instance>
Copy to Clipboard Toggle word wrap
Restarts an instance.

Positional arguments

<instance>
ID or name of the instance.

15.66. trove root-disable
Copy link

usage: trove root-disable <instance>
Copy to Clipboard Toggle word wrap
Disables root for an instance.

Positional arguments

<instance>
ID or name of the instance.

15.67. trove root-enable
Copy link

usage: trove root-enable <instance_or_cluster> [--root_password <root_password>]
Copy to Clipboard Toggle word wrap
Enables root for an instance and resets if already exists.

Positional arguments

<instance_or_cluster>
ID or name of the instance or cluster.

Optional arguments

--root_password <root_password>
Root password to set.

15.68. trove root-show
Copy link

usage: trove root-show <instance_or_cluster>
Copy to Clipboard Toggle word wrap
Gets status if root was ever enabled for an instance or cluster.

Positional arguments

<instance_or_cluster>
ID or name of the instance or cluster.

15.69. trove secgroup-add-rule
Copy link

usage: trove secgroup-add-rule <security_group> <cidr>
Copy to Clipboard Toggle word wrap
Creates a security group rule.

Positional arguments

<security_group>
Security group ID.
<cidr>
CIDR address.

15.70. trove secgroup-delete-rule
Copy link

usage: trove secgroup-delete-rule <security_group_rule>
Copy to Clipboard Toggle word wrap
Deletes a security group rule.

Positional arguments

<security_group_rule>
Name of security group rule.

15.71. trove secgroup-list
Copy link

usage: trove secgroup-list
Copy to Clipboard Toggle word wrap
Lists all security groups.

15.72. trove secgroup-list-rules
Copy link

usage: trove secgroup-list-rules <security_group>
Copy to Clipboard Toggle word wrap
Lists all rules for a security group.

Positional arguments

<security_group>
Security group ID.

15.73. trove secgroup-show
Copy link

usage: trove secgroup-show <security_group>
Copy to Clipboard Toggle word wrap
Shows details of a security group.

Positional arguments

<security_group>
Security group ID.

15.74. trove show
Copy link

usage: trove show <instance>
Copy to Clipboard Toggle word wrap
Shows details of an instance.

Positional arguments

<instance>
ID or name of the instance.

15.75. trove update
Copy link

usage: trove update <instance> [--name <name>] [--configuration <configuration>] [--detach-replica-source] [--remove_configuration]
Copy to Clipboard Toggle word wrap
Updates an instance: Edits name, configuration, or replica source.

Positional arguments

<instance>
ID or name of the instance.

Optional arguments

--name <name>
Name of the instance.
--configuration <configuration>
ID of the configuration reference to attach.
--detach-replica-source
Detach the replica instance from its replication source.
--remove_configuration
Drops the current configuration reference.

15.76. trove user-create
Copy link

usage: trove user-create <instance> <name> <password> [--host <host>] [--databases <databases> [<databases> ...]]
Copy to Clipboard Toggle word wrap
Creates a user on an instance.

Positional arguments

<instance>
ID or name of the instance.
<name>
Name of user.
<password>
Password of user.

Optional arguments

--host <host>
Optional host of user.
--databases <databases> [<databases> ...]
Optional list of databases.

15.77. trove user-delete
Copy link

usage: trove user-delete [--host <host>] <instance> <name>
Copy to Clipboard Toggle word wrap
Deletes a user from an instance.

Positional arguments

<instance>
ID or name of the instance.
<name>
Name of user.

Optional arguments

--host <host>
Optional host of user.

15.78. trove user-grant-access
Copy link

usage: trove user-grant-access <instance> <name> <databases> [<databases> ...] [--host <host>]
Copy to Clipboard Toggle word wrap
Grants access to a database(s) for a user.

Positional arguments

<instance>
ID or name of the instance.
<name>
Name of user.
<databases>
List of databases.

Optional arguments

--host <host>
Optional host of user.

15.79. trove user-list
Copy link

usage: trove user-list <instance>
Copy to Clipboard Toggle word wrap
Lists the users for an instance.

Positional arguments

<instance>
ID or name of the instance.

15.80. trove user-revoke-access
Copy link

usage: trove user-revoke-access [--host <host>] <instance> <name> <database>
Copy to Clipboard Toggle word wrap
Revokes access to a database for a user.

Positional arguments

<instance>
ID or name of the instance.
<name>
Name of user.
<database>
A single database.

Optional arguments

--host <host>
Optional host of user.

15.81. trove user-show
Copy link

usage: trove user-show [--host <host>] <instance> <name>
Copy to Clipboard Toggle word wrap
Shows details of a user of an instance.

Positional arguments

<instance>
ID or name of the instance.
<name>
Name of user.

Optional arguments

--host <host>
Optional host of user.

15.82. trove user-show-access
Copy link

usage: trove user-show-access [--host <host>] <instance> <name>
Copy to Clipboard Toggle word wrap
Shows access details of a user of an instance.

Positional arguments

<instance>
ID or name of the instance.
<name>
Name of user.

Optional arguments

--host <host>
Optional host of user.

15.83. trove user-update-attributes
Copy link

usage: trove user-update-attributes <instance> <name> [--host <host>] [--new_name <new_name>] [--new_password <new_password>] [--new_host <new_host>]
Copy to Clipboard Toggle word wrap
Updates a user's attributes on an instance. At least one optional argument must be provided.

Positional arguments

<instance>
ID or name of the instance.
<name>
Name of user.

Optional arguments

--host <host>
Optional host of user.
--new_name <new_name>
Optional new name of user.
--new_password <new_password>
Optional new password of user.
--new_host <new_host>
Optional new host of user.
The trove-manage client is the command-line interface (CLI) for the Database service management utility API and its extensions. This chapter documents trove-manage version 5.0.0.
For help on a specific trove-manage command, enter: 
$ trove-manage COMMAND --help
Copy to Clipboard Toggle word wrap

16.1. trove-manage usage
Copy link

usage: trove-manage [-h] [--config-dir DIR] [--config-file PATH] [--debug] [--log-config-append PATH] [--log-date-format DATE_FORMAT] [--log-dir LOG_DIR] [--log-file PATH] [--nodebug] [--nouse-syslog] [--noverbose] [--nowatch-log-file] [--syslog-log-facility SYSLOG_LOG_FACILITY] [--use-syslog] [--verbose] [--version] [--watch-log-file] {db_sync,db_upgrade,db_downgrade,datastore_update,datastore_version_update,db_recreate,db_load_datastore_config_parameters,datastore_version_flavor_add,datastore_version_flavor_delete} ...
Copy to Clipboard Toggle word wrap

16.2. trove-manage optional arguments
Copy link

-h, --help
show this help message and exit
--config-dir DIR
Path to a config directory to pull *.conf files from. This file set is sorted, so as to provide a predictable parse order if individual options are over-ridden. The set is parsed after the file(s) specified via previous --config-file, arguments hence over-ridden options in the directory take precedence.
--config-file PATH
Path to a config file to use. Multiple config files can be specified, with values in later files taking precedence. Defaults to None.
--debug, -d
If set to true, the logging level will be set to DEBUG instead of the default INFO level.
--log-config-append PATH, --log_config PATH
The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, logging_context_format_string).
--log-date-format DATE_FORMAT
Defines the format string for %(asctime)s in log records. Default: None . This option is ignored if log_config_append is set.
--log-dir LOG_DIR, --logdir LOG_DIR
(Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.
--log-file PATH, --logfile PATH
(Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set.
--nodebug
The inverse of --debug
--nouse-syslog
The inverse of --use-syslog
--noverbose
The inverse of --verbose
--nowatch-log-file
The inverse of --watch-log-file
--syslog-log-facility SYSLOG_LOG_FACILITY
Syslog facility to receive log lines. This option is ignored if log_config_append is set.
--use-syslog
Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set.
--verbose, -v
If set to false, the logging level will be set to WARNING instead of the default INFO level.
--version
show program's version number and exit
--watch-log-file
Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set.

16.3. trove-manage datastore_version_flavor_add
Copy link

usage: trove-manage datastore_version_flavor_add [-h] datastore_name datastore_version_name flavor_ids
Copy to Clipboard Toggle word wrap
Adds flavor association to a given datastore and datastore version.

Positional arguments

datastore_name
Name of the datastore.
datastore_version_name
Name of the datastore version.
flavor_ids
Comma separated list of flavor ids.

Optional arguments

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

16.4. trove-manage datastore_version_flavor_delete
Copy link

usage: trove-manage datastore_version_flavor_delete [-h] datastore_name datastore_version_name flavor_id
Copy to Clipboard Toggle word wrap
Deletes a flavor associated with a given datastore and datastore version.

Positional arguments

datastore_name
Name of the datastore.
datastore_version_name
Name of the datastore version.
flavor_id
The flavor to be deleted for a given datastore and datastore version.

Optional arguments

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

16.5. trove-manage datastore_version_update
Copy link

usage: trove-manage datastore_version_update [-h] datastore version_name manager image_id packages active
Copy to Clipboard Toggle word wrap
Add or update a datastore version. If the datastore version already exists, all values except the datastore name and version will be updated.

Positional arguments

datastore
Name of the datastore.
version_name
Name of the datastore version.
manager
Name of the manager that will administer the datastore version.
image_id
ID of the image used to create an instance of the datastore version.
packages
Packages required by the datastore version that are installed on the guest image.
active
Whether the datastore version is active or not. Accepted values are 0 and 1.

Optional arguments

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

16.6. trove-manage db_downgrade
Copy link

usage: trove-manage db_downgrade [-h] [--repo_path REPO_PATH] version
Copy to Clipboard Toggle word wrap
Downgrade the database to the specified version.

Positional arguments

version
Target version.

Optional arguments

-h, --help
show this help message and exit
--repo_path REPO_PATH
SQLAlchemy Migrate repository path. 
usage: trove-manage db_load_datastore_config_parameters [-h] datastore datastore_version config_file_location
Copy to Clipboard Toggle word wrap
Loads configuration group parameter validation rules for a datastore version into the database.

Positional arguments

datastore
Name of the datastore.
datastore_version
Name of the datastore version.
config_file_location
Fully qualified file path to the configuration group parameter validation rules.

Optional arguments

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

16.8. trove-manage db_recreate
Copy link

usage: trove-manage db_recreate [-h] [--repo_path REPO_PATH]
Copy to Clipboard Toggle word wrap
Drop the database and recreate it.

Optional arguments

-h, --help
show this help message and exit
--repo_path REPO_PATH
SQLAlchemy Migrate repository path.

16.9. trove-manage db_sync
Copy link

usage: trove-manage db_sync [-h] [--repo_path REPO_PATH]
Copy to Clipboard Toggle word wrap
Populate the database structure

Optional arguments

-h, --help
show this help message and exit
--repo_path REPO_PATH
SQLAlchemy Migrate repository path.

16.10. trove-manage db_upgrade
Copy link

usage: trove-manage db_upgrade [-h] [--version VERSION] [--repo_path REPO_PATH]
Copy to Clipboard Toggle word wrap
Upgrade the database to the specified version.

Optional arguments

-h, --help
show this help message and exit
--version VERSION
Target version. Defaults to the latest version.
--repo_path REPO_PATH
SQLAlchemy Migrate repository path.
The ironic client is the command-line interface (CLI) for the Bare Metal service API and its extensions. This chapter documents ironic version 1.3.1.
For help on a specific ironic command, enter: 
$ ironic help COMMAND
Copy to Clipboard Toggle word wrap

17.1. ironic usage
Copy link

usage: ironic [--insecure] [--os-cacert <ca-certificate>] [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>] [--version] [--debug] [--json] [-v] [--cert-file OS_CERT] [--key-file OS_KEY] [--ca-file OS_CACERT] [--os-username OS_USERNAME] [--os-password OS_PASSWORD] [--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME] [--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME] [--os-auth-token OS_AUTH_TOKEN] [--ironic-url IRONIC_URL] [--ironic-api-version IRONIC_API_VERSION] [--os-service-type OS_SERVICE_TYPE] [--os-endpoint IRONIC_URL] [--os-endpoint-type OS_ENDPOINT_TYPE] [--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID] [--os-project-name OS_PROJECT_NAME] [--os-project-domain-id OS_PROJECT_DOMAIN_ID] [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] [--max-retries MAX_RETRIES] [--retry-interval RETRY_INTERVAL] <subcommand> ...
Copy to Clipboard Toggle word wrap

Subcommands

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

17.2. ironic optional arguments
Copy link

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

17.3. ironic chassis-create
Copy link

usage: ironic chassis-create [-d <description>] [-e <key=value>] [-u <uuid>]
Copy to Clipboard Toggle word wrap
Create a new chassis.

Optional arguments

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

17.4. ironic chassis-delete
Copy link

usage: ironic chassis-delete <chassis> [<chassis> ...]
Copy to Clipboard Toggle word wrap
Delete a chassis.

Positional arguments

<chassis>
UUID of the chassis.

17.5. ironic chassis-list
Copy link

usage: ironic chassis-list [--detail] [--limit <limit>] [--marker <chassis>] [--sort-key <field>] [--sort-dir <direction>] [--fields <field> [<field> ...]]
Copy to Clipboard Toggle word wrap
List the chassis.

Optional arguments

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

17.6. ironic chassis-node-list
Copy link

usage: ironic chassis-node-list [--detail] [--limit <limit>] [--marker <node>] [--sort-key <field>] [--sort-dir <direction>] [--fields <field> [<field> ...]] [--maintenance <boolean>] [--associated <boolean>] [--provision-state <provision-state>] <chassis>
Copy to Clipboard Toggle word wrap
List the nodes contained in a chassis.

Positional arguments

<chassis>
UUID of the chassis.

Optional arguments

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

17.7. ironic chassis-show
Copy link

usage: ironic chassis-show [--fields <field> [<field> ...]] <chassis>
Copy to Clipboard Toggle word wrap
Show detailed information about a chassis.

Positional arguments

<chassis>
UUID of the chassis.

Optional arguments

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

17.8. ironic chassis-update
Copy link

usage: ironic chassis-update <chassis> <op> <path=value> [<path=value> ...]
Copy to Clipboard Toggle word wrap
Update information about a chassis.

Positional arguments

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

17.9. ironic driver-get-vendor-passthru-methods
Copy link

usage: ironic driver-get-vendor-passthru-methods <driver>
Copy to Clipboard Toggle word wrap
Get the vendor passthru methods for a driver.

Positional arguments

<driver>
Name of the driver.

17.10. ironic driver-list
Copy link

usage: ironic driver-list
Copy to Clipboard Toggle word wrap
List the enabled drivers.

17.11. ironic driver-properties
Copy link

usage: ironic driver-properties [--wrap <integer>] <driver>
Copy to Clipboard Toggle word wrap
Get properties of a driver.

Positional arguments

<driver>
Name of the driver.

Optional arguments

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

17.12. ironic driver-raid-logical-disk-properties
Copy link

usage: ironic driver-raid-logical-disk-properties [--wrap <integer>] <driver>
Copy to Clipboard Toggle word wrap
Get RAID logical disk properties for a driver.

Positional arguments

<driver>
Name of the driver.

Optional arguments

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

17.13. ironic driver-show
Copy link

usage: ironic driver-show <driver>
Copy to Clipboard Toggle word wrap
Show information about a driver.

Positional arguments

<driver>
Name of the driver.

17.14. ironic driver-vendor-passthru
Copy link

usage: ironic driver-vendor-passthru [--http-method <http-method>] <driver> <method> [<arg=value> [<arg=value> ...]]
Copy to Clipboard Toggle word wrap
Call a vendor-passthru extension for a driver.

Positional arguments

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

Optional arguments

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

17.15. ironic node-create
Copy link

usage: ironic node-create [-c <chassis>] -d <driver> [-i <key=value>] [-p <key=value>] [-e <key=value>] [-u <uuid>] [-n <name>]
Copy to Clipboard Toggle word wrap
Register a new node with the Ironic service.

Optional arguments

-c <chassis>, --chassis <chassis>
UUID of the chassis that this node belongs to.
-d <driver>, --driver <driver>
Driver used to control the node [REQUIRED].
-i <key=value>, --driver-info <key=value>
Key/value pair used by the driver, such as out-of-band management credentials. Can be specified multiple times.
-p <key=value>, --properties <key=value>
Key/value pair describing the physical characteristics of the node. This is exported to Nova and used by the scheduler. Can be specified multiple times.
-e <key=value>, --extra <key=value>
Record arbitrary key/value metadata. Can be specified multiple times.
-u <uuid>, --uuid <uuid>
Unique UUID for the node.
-n <name>, --name <name>
Unique name for the node.

17.16. ironic node-delete
Copy link

usage: ironic node-delete <node> [<node> ...]
Copy to Clipboard Toggle word wrap
Unregister node(s) from the Ironic service. :raises: ClientException, if error happens during the delete

Positional arguments

<node>
Name or UUID of the node.

17.17. ironic node-get-boot-device
Copy link

usage: ironic node-get-boot-device <node>
Copy to Clipboard Toggle word wrap
Get the current boot device for a node.

Positional arguments

<node>
Name or UUID of the node.

17.18. ironic node-get-console
Copy link

usage: ironic node-get-console <node>
Copy to Clipboard Toggle word wrap
Get the connection information for a node's console, if enabled.

Positional arguments

<node>
Name or UUID of the node.

17.19. ironic node-get-supported-boot-devices
Copy link

usage: ironic node-get-supported-boot-devices <node>
Copy to Clipboard Toggle word wrap
Get the supported boot devices for a node.

Positional arguments

<node>
Name or UUID of the node.

17.20. ironic node-get-vendor-passthru-methods
Copy link

usage: ironic node-get-vendor-passthru-methods <node>
Copy to Clipboard Toggle word wrap
Get the vendor passthru methods for a node.

Positional arguments

<node>
Name or UUID of the node.

17.21. ironic node-list
Copy link

usage: ironic node-list [--limit <limit>] [--marker <node>] [--sort-key <field>] [--sort-dir <direction>] [--maintenance <boolean>] [--associated <boolean>] [--provision-state <provision-state>] [--driver <driver>] [--detail] [--fields <field> [<field> ...]]
Copy to Clipboard Toggle word wrap
List the nodes which are registered with the Ironic service.

Optional arguments

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

17.22. ironic node-port-list
Copy link

usage: ironic node-port-list [--detail] [--limit <limit>] [--marker <port>] [--sort-key <field>] [--sort-dir <direction>] [--fields <field> [<field> ...]] <node>
Copy to Clipboard Toggle word wrap
List the ports associated with a node.

Positional arguments

<node>
Name or UUID of the node.

Optional arguments

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

17.23. ironic node-set-boot-device
Copy link

usage: ironic node-set-boot-device [--persistent] <node> <boot-device>
Copy to Clipboard Toggle word wrap
Set the boot device for a node.

Positional arguments

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

Optional arguments

--persistent
Make changes persistent for all future boots.

17.24. ironic node-set-console-mode
Copy link

usage: ironic node-set-console-mode <node> <enabled>
Copy to Clipboard Toggle word wrap
Enable or disable serial console access for a node.

Positional arguments

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

17.25. ironic node-set-maintenance
Copy link

usage: ironic node-set-maintenance [--reason <reason>] <node> <maintenance-mode>
Copy to Clipboard Toggle word wrap
Enable or disable maintenance mode for a node.

Positional arguments

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

Optional arguments

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

17.26. ironic node-set-power-state
Copy link

usage: ironic node-set-power-state <node> <power-state>
Copy to Clipboard Toggle word wrap
Power a node on or off or reboot.

Positional arguments

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

17.27. ironic node-set-provision-state
Copy link

usage: ironic node-set-provision-state [--config-drive <config-drive>] [--clean-steps <clean-steps>] <node> <provision-state>
Copy to Clipboard Toggle word wrap
Initiate a provisioning state change for a node.

Positional arguments

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

Optional arguments

--config-drive <config-drive>
A gzipped, base64-encoded configuration drive string OR the path to the configuration drive file OR the path to a directory containing the config drive files. In case it's a directory, a config drive will be generated from it. This argument is only valid when setting provision-state to 'active'.
--clean-steps <clean-steps>
The clean steps in JSON format. May be the path to a file containing the clean steps; OR '-', with the clean steps being read from standard input; OR a string. The value should be a list of clean-step dictionaries; each dictionary should have keys 'interface' and 'step', and optional key 'args'. This argument must be specified (and is only valid) when setting provision-state to 'clean'.

17.28. ironic node-set-target-raid-config
Copy link

usage: ironic node-set-target-raid-config <node> <target-raid-config>
Copy to Clipboard Toggle word wrap
Set target RAID config on a node.

Positional arguments

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

17.29. ironic node-show
Copy link

usage: ironic node-show [--instance] [--fields <field> [<field> ...]] <id>
Copy to Clipboard Toggle word wrap
Show detailed information about a node.

Positional arguments

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

Optional arguments

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

17.30. ironic node-show-states
Copy link

usage: ironic node-show-states <node>
Copy to Clipboard Toggle word wrap
Show information about the node's states.

Positional arguments

<node>
Name or UUID of the node.

17.31. ironic node-update
Copy link

usage: ironic node-update <node> <op> <path=value> [<path=value> ...]
Copy to Clipboard Toggle word wrap
Update information about a registered node.

Positional arguments

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

17.32. ironic node-validate
Copy link

usage: ironic node-validate <node>
Copy to Clipboard Toggle word wrap
Validate a node's driver interfaces.

Positional arguments

<node>
Name or UUID of the node.

17.33. ironic node-vendor-passthru
Copy link

usage: ironic node-vendor-passthru [--http-method <http-method>] <node> <method> [<arg=value> [<arg=value> ...]]
Copy to Clipboard Toggle word wrap
Call a vendor-passthru extension for a node.

Positional arguments

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

Optional arguments

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

17.34. ironic port-create
Copy link

usage: ironic port-create -a <address> -n <node> [-e <key=value>] [-u <uuid>]
Copy to Clipboard Toggle word wrap
Create a new port.

Optional arguments

-a <address>, --address <address>
MAC address for this port.
-n <node>, --node <node>, --node_uuid <node>
UUID of the node that this port belongs to.
-e <key=value>, --extra <key=value>
Record arbitrary key/value metadata. Can be specified multiple times.
-u <uuid>, --uuid <uuid>
UUID of the port.

17.35. ironic port-delete
Copy link

usage: ironic port-delete <port> [<port> ...]
Copy to Clipboard Toggle word wrap
Delete a port.

Positional arguments

<port>
UUID of the port.

17.36. ironic port-list
Copy link

usage: ironic port-list [--detail] [--address <mac-address>] [--limit <limit>] [--marker <port>] [--sort-key <field>] [--sort-dir <direction>] [--fields <field> [<field> ...]]
Copy to Clipboard Toggle word wrap
List the ports.

Optional arguments

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

17.37. ironic port-show
Copy link

usage: ironic port-show [--address] [--fields <field> [<field> ...]] <id>
Copy to Clipboard Toggle word wrap
Show detailed information about a port.

Positional arguments

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

Optional arguments

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

17.38. ironic port-update
Copy link

usage: ironic port-update <port> <op> <path=value> [<path=value> ...]
Copy to Clipboard Toggle word wrap
Update information about a port.

Positional arguments

<port>
UUID of the port.
<op>
Operation: 'add', 'replace', or 'remove'.
<path=value>
Attribute to add, replace, or remove. Can be specified multiple times. For 'remove', only <path> is necessary.
The manila client is the command-line interface (CLI) for the Shared file systems API and its extensions. This chapter documents manila version 1.8.1.
For help on a specific manila command, enter: 
$ manila help COMMAND
Copy to Clipboard Toggle word wrap

18.1. manila usage
Copy link

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

Subcommands

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

18.2. manila optional arguments
Copy link

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

18.3. manila absolute-limits
Copy link

usage: manila absolute-limits
Copy to Clipboard Toggle word wrap
Print a list of absolute limits for a user.

18.4. manila access-allow
Copy link

usage: manila access-allow [--access-level <access_level>] <share> <access_type> <access_to>
Copy to Clipboard Toggle word wrap
Allow access to the share.

Positional arguments

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

Optional arguments

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

18.5. manila access-deny
Copy link

usage: manila access-deny <share> <id>
Copy to Clipboard Toggle word wrap
Deny access to a share.

Positional arguments

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

18.6. manila access-list
Copy link

usage: manila access-list [--columns <columns>] <share>
Copy to Clipboard Toggle word wrap
Show access list for share.

Positional arguments

<share>
Name or ID of the share.

Optional arguments

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

18.7. manila api-version
Copy link

usage: manila api-version
Copy to Clipboard Toggle word wrap
Display the API version information.

18.8. manila cg-create
Copy link

usage: manila cg-create [--name <name>] [--description <description>] [--share-types <share_types>] [--share-network <share_network>] [--source-cgsnapshot-id <source_cgsnapshot_id>]
Copy to Clipboard Toggle word wrap
Creates a new consistency group (Experimental).

Optional arguments

--name <name>
Optional consistency group name. (Default=None)
--description <description>
Optional consistency group description. (Default=None)
--share-types <share_types>, --share_types <share_types>
Optional list of share types. (Default=None)
--share-network <share_network>, --share_network <share_network>
Specify share-network name or id.
--source-cgsnapshot-id <source_cgsnapshot_id>, --source_cgsnapshot_id <source_cgsnapshot_id>
Optional snapshot ID to create the share from. (Default=None)

18.9. manila cg-delete
Copy link

usage: manila cg-delete [--force] <consistency_group> [<consistency_group> ...]
Copy to Clipboard Toggle word wrap
Remove one or more consistency groups (Experimental).

Positional arguments

<consistency_group>
Name or ID of the consistency group(s).

Optional arguments

--force
Attempt to force delete the consistency group (Default=False) (Admin only).

18.10. manila cg-list
Copy link

usage: manila cg-list [--all-tenants [<0|1>]] [--limit <limit>] [--offset <offset>] [--columns <columns>]
Copy to Clipboard Toggle word wrap
List consistency groups with filters (Experimental).

Optional arguments

--all-tenants [<0|1>]
Display information from all tenants (Admin only).
--limit <limit>
Maximum number of consistency groups to return. (Default=None)
--offset <offset>
Start position of consistency group listing.
--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id,name"

18.11. manila cg-reset-state
Copy link

usage: manila cg-reset-state [--state <state>] <consistency_group>
Copy to Clipboard Toggle word wrap
Explicitly update the state of a consistency group (Admin only, Experimental).

Positional arguments

<consistency_group>
Name or ID of the consistency group state to modify.

Optional arguments

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

18.12. manila cg-show
Copy link

usage: manila cg-show <consistency_group>
Copy to Clipboard Toggle word wrap
Show details about a consistency group (Experimental).

Positional arguments

<consistency_group>
Name or ID of the consistency group.

18.13. manila cg-snapshot-create
Copy link

usage: manila cg-snapshot-create [--name <name>] [--description <description>] <consistency_group>
Copy to Clipboard Toggle word wrap
Creates a new consistency group snapshot (Experimental).

Positional arguments

<consistency_group>
Name or ID of the consistency group.

Optional arguments

--name <name>
Optional consistency group snapshot name. (Default=None)
--description <description>
Optional consistency group snapshot description. (Default=None)

18.14. manila cg-snapshot-delete
Copy link

usage: manila cg-snapshot-delete [--force] <cg_snapshot> [<cg_snapshot> ...]
Copy to Clipboard Toggle word wrap
Remove one or more consistency group snapshots (Experimental).

Positional arguments

<cg_snapshot>
Name or ID of the consistency group snapshot.

Optional arguments

--force
Attempt to force delete the cg snapshot(s) (Default=False) (Admin only).

18.15. manila cg-snapshot-list
Copy link

usage: manila cg-snapshot-list [--all-tenants [<0|1>]] [--limit <limit>] [--offset <offset>] [--detailed DETAILED] [--columns <columns>]
Copy to Clipboard Toggle word wrap
List consistency group snapshots with filters (Experimental).

Optional arguments

--all-tenants [<0|1>]
Display information from all tenants (Admin only).
--limit <limit>
Maximum number of consistency group snapshots to return.(Default=None)
--offset <offset>
Start position of consistency group snapshot listing.
--detailed DETAILED
Show detailed information about snapshots.
--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id,name"

18.16. manila cg-snapshot-members
Copy link

usage: manila cg-snapshot-members [--limit <limit>] [--offset <offset>] <cg_snapshot>
Copy to Clipboard Toggle word wrap
Get member details for a consistency group snapshot (Experimental).

Positional arguments

<cg_snapshot>
Name or ID of the consistency group snapshot.

Optional arguments

--limit <limit>
Maximum number of shares to return. (Default=None)
--offset <offset>
Start position of security services listing.

18.17. manila cg-snapshot-reset-state
Copy link

usage: manila cg-snapshot-reset-state [--state <state>] <cg_snapshot>
Copy to Clipboard Toggle word wrap
Explicitly update the state of a consistency group (Admin only, Experimental).

Positional arguments

<cg_snapshot>
Name or ID of the consistency group snapshot.

Optional arguments

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

18.18. manila cg-snapshot-show
Copy link

usage: manila cg-snapshot-show <cg_snapshot>
Copy to Clipboard Toggle word wrap
Show details about a consistency group snapshot (Experimental).

Positional arguments

<cg_snapshot>
Name or ID of the consistency group snapshot.

18.19. manila cg-snapshot-update
Copy link

usage: manila cg-snapshot-update [--name <name>] [--description <description>] <cg_snapshot>
Copy to Clipboard Toggle word wrap
Update a consistency group snapshot (Experimental).

Positional arguments

<cg_snapshot>
Name or ID of the cg snapshot to update.

Optional arguments

--name <name>
Optional new name for the cg snapshot. (Default=None
--description <description>
Optional cg snapshot description. (Default=None)

18.20. manila cg-update
Copy link

usage: manila cg-update [--name <name>] [--description <description>] <consistency_group>
Copy to Clipboard Toggle word wrap
Update a consistency group (Experimental).

Positional arguments

<consistency_group>
Name or ID of the consistency group to update.

Optional arguments

--name <name>
Optional new name for the consistency group. (Default=None)
--description <description>
Optional consistency group description. (Default=None)

18.21. manila create
Copy link

usage: manila create [--snapshot-id <snapshot-id>] [--name <name>] [--metadata [<key=value> [<key=value> ...]]] [--share-network <network-info>] [--description <description>] [--share-type <share-type>] [--public] [--availability-zone <availability-zone>] [--consistency-group <consistency-group>] <share_protocol> <size>
Copy to Clipboard Toggle word wrap
Creates a new share (NFS, CIFS, CephFS, GlusterFS or HDFS).

Positional arguments

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

Optional arguments

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

18.22. manila credentials
Copy link

usage: manila credentials
Copy to Clipboard Toggle word wrap
Show user credentials returned from auth.

18.23. manila delete
Copy link

usage: manila delete [--consistency-group <consistency-group>] <share> [<share> ...]
Copy to Clipboard Toggle word wrap
Remove one or more shares.

Positional arguments

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

Optional arguments

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

18.24. manila endpoints
Copy link

usage: manila endpoints
Copy to Clipboard Toggle word wrap
Discover endpoints that get returned from the authenticate services.

18.25. manila extend
Copy link

usage: manila extend <share> <new_size>
Copy to Clipboard Toggle word wrap
Increases the size of an existing share.

Positional arguments

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

18.26. manila extra-specs-list
Copy link

usage: manila extra-specs-list [--columns <columns>]
Copy to Clipboard Toggle word wrap
Print a list of current 'share types and extra specs' (Admin Only).

Optional arguments

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

18.27. manila force-delete
Copy link

usage: manila force-delete <share> [<share> ...]
Copy to Clipboard Toggle word wrap
Attempt force-delete of share, regardless of state (Admin only).

Positional arguments

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

18.28. manila list
Copy link

usage: manila list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] [--share-server-id <share_server_id>] [--metadata [<key=value> [<key=value> ...]]] [--extra-specs [<key=value> [<key=value> ...]]] [--share-type <share_type>] [--limit <limit>] [--offset <offset>] [--sort-key <sort_key>] [--sort-dir <sort_dir>] [--snapshot <snapshot>] [--host <host>] [--share-network <share_network>] [--project-id <project_id>] [--public] [--consistency-group <consistency_group>] [--columns <columns>]
Copy to Clipboard Toggle word wrap
List NAS shares with filters.

Optional arguments

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

18.29. manila list-extensions
Copy link

usage: manila list-extensions
Copy to Clipboard Toggle word wrap
List all the os-api extensions that are available.

18.30. manila manage
Copy link

usage: manila manage [--name <name>] [--description <description>] [--share_type <share-type>] [--driver_options [<key=value> [<key=value> ...]]] [--public] <service_host> <protocol> <export_path>
Copy to Clipboard Toggle word wrap
Manage share not handled by Manila (Admin only).

Positional arguments

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

Optional arguments

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

18.31. manila metadata
Copy link

usage: manila metadata <share> <action> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
Set or delete metadata on a share.

Positional arguments

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

18.32. manila metadata-show
Copy link

usage: manila metadata-show <share>
Copy to Clipboard Toggle word wrap
Show metadata of given share.

Positional arguments

<share>
Name or ID of the share.

18.33. manila metadata-update-all
Copy link

usage: manila metadata-update-all <share> <key=value> [<key=value> ...]
Copy to Clipboard Toggle word wrap
Update all metadata of a share.

Positional arguments

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

18.34. manila migration-cancel
Copy link

usage: manila migration-cancel <share>
Copy to Clipboard Toggle word wrap
Cancels migration of a given share when copying (Admin only, Experimental).

Positional arguments

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

18.35. manila migration-complete
Copy link

usage: manila migration-complete <share>
Copy to Clipboard Toggle word wrap
Completes migration for a given share (Admin only, Experimental).

Positional arguments

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

18.36. manila migration-get-progress
Copy link

usage: manila migration-get-progress <share>
Copy to Clipboard Toggle word wrap
Gets migration progress of a given share when copying (Admin only, Experimental).

Positional arguments

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

18.37. manila migration-start
Copy link

usage: manila migration-start [--force-host-copy <True|False>] [--notify <True|False>] <share> <host#pool>
Copy to Clipboard Toggle word wrap
Migrates share to a new host (Admin only, Experimental).

Positional arguments

<share>
Name or ID of share to migrate.
<host#pool>
Destination host and pool.

Optional arguments

--force-host-copy <True|False>, --force_host_copy <True|False>
Enables or disables generic host-based force- migration, which bypasses driver optimizations. Default=False.
--notify <True|False>
Enables or disables notification of data copying completed. Default=True.

18.38. manila pool-list
Copy link

usage: manila pool-list [--host <host>] [--backend <backend>] [--pool <pool>] [--columns <columns>]
Copy to Clipboard Toggle word wrap
List all backend storage pools known to the scheduler (Admin only).

Optional arguments

--host <host>
Filter results by host name. Regular expressions are supported.
--backend <backend>
Filter results by backend name. Regular expressions are supported.
--pool <pool>
Filter results by pool name. Regular expressions are supported.
--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "name,host"

18.39. manila quota-class-show
Copy link

usage: manila quota-class-show <class>
Copy to Clipboard Toggle word wrap
List the quotas for a quota class.

Positional arguments

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

18.40. manila quota-class-update
Copy link

usage: manila quota-class-update [--shares <shares>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--snapshot-gigabytes <snapshot_gigabytes>] [--share-networks <share-networks>] <class-name>
Copy to Clipboard Toggle word wrap
Update the quotas for a quota class (Admin only).

Positional arguments

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

Optional arguments

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

18.41. manila quota-defaults
Copy link

usage: manila quota-defaults [--tenant <tenant-id>]
Copy to Clipboard Toggle word wrap
List the default quotas for a tenant.

Optional arguments

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

18.42. manila quota-delete
Copy link

usage: manila quota-delete [--tenant <tenant-id>] [--user <user-id>]
Copy to Clipboard Toggle word wrap
Delete quota for a tenant/user. The quota will revert back to default (Admin only).

Optional arguments

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

18.43. manila quota-show
Copy link

usage: manila quota-show [--tenant <tenant-id>] [--user <user-id>]
Copy to Clipboard Toggle word wrap
List the quotas for a tenant/user.

Optional arguments

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

18.44. manila quota-update
Copy link

usage: manila quota-update [--user <user-id>] [--shares <shares>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--snapshot-gigabytes <snapshot_gigabytes>] [--share-networks <share-networks>] [--force] <tenant_id>
Copy to Clipboard Toggle word wrap
Update the quotas for a tenant/user (Admin only).

Positional arguments

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

Optional arguments

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

18.45. manila rate-limits
Copy link

usage: manila rate-limits [--columns <columns>]
Copy to Clipboard Toggle word wrap
Print a list of rate limits for a user.

Optional arguments

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

18.46. manila reset-state
Copy link

usage: manila reset-state [--state <state>] <share>
Copy to Clipboard Toggle word wrap
Explicitly update the state of a share (Admin only).

Positional arguments

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

Optional arguments

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

18.47. manila reset-task-state
Copy link

usage: manila reset-task-state [--task-state <task_state>] <share>
Copy to Clipboard Toggle word wrap
Explicitly update the task state of a share (Admin only, Experimental).

Positional arguments

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

Optional arguments

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

18.48. manila security-service-create
Copy link

usage: manila security-service-create [--dns-ip <dns_ip>] [--server <server>] [--domain <domain>] [--user <user>] [--password <password>] [--name <name>] [--description <description>] <type>
Copy to Clipboard Toggle word wrap
Create security service used by tenant.

Positional arguments

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

Optional arguments

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

18.49. manila security-service-delete
Copy link

usage: manila security-service-delete <security-service>
Copy to Clipboard Toggle word wrap
Delete security service.

Positional arguments

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

18.50. manila security-service-list
Copy link

usage: manila security-service-list [--all-tenants [<0|1>]] [--share-network <share_network>] [--status <status>] [--name <name>] [--type <type>] [--user <user>] [--dns-ip <dns_ip>] [--server <server>] [--domain <domain>] [--detailed [<0|1>]] [--offset <offset>] [--limit <limit>] [--columns <columns>]
Copy to Clipboard Toggle word wrap
Get a list of security services.

Optional arguments

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

18.51. manila security-service-show
Copy link

usage: manila security-service-show <security-service>
Copy to Clipboard Toggle word wrap
Show security service.

Positional arguments

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

18.52. manila security-service-update
Copy link

usage: manila security-service-update [--dns-ip <dns-ip>] [--server <server>] [--domain <domain>] [--user <user>] [--password <password>] [--name <name>] [--description <description>] <security-service>
Copy to Clipboard Toggle word wrap
Update security service.

Positional arguments

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

Optional arguments

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

18.53. manila service-disable
Copy link

usage: manila service-disable <hostname> <binary>
Copy to Clipboard Toggle word wrap
Disables 'manila-share' or 'manila-scheduler' services (Admin only).

Positional arguments

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

18.54. manila service-enable
Copy link

usage: manila service-enable <hostname> <binary>
Copy to Clipboard Toggle word wrap
Enables 'manila-share' or 'manila-scheduler' services (Admin only).

Positional arguments

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

18.55. manila service-list
Copy link

usage: manila service-list [--host <hostname>] [--binary <binary>] [--status <status>] [--state <state>] [--zone <zone>] [--columns <columns>]
Copy to Clipboard Toggle word wrap
List all services (Admin only).

Optional arguments

--host <hostname>
Name of host.
--binary <binary>
Service binary.
--status <status>
Filter results by status.
--state <state>
Filter results by state.
--zone <zone>
Availability zone.
--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id,host"

18.56. manila share-export-location-list
Copy link

usage: manila share-export-location-list [--columns <columns>] <share>
Copy to Clipboard Toggle word wrap
List export locations of a given share.

Positional arguments

<share>
Name or ID of the share.

Optional arguments

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

18.57. manila share-export-location-show
Copy link

usage: manila share-export-location-show <share> <export_location>
Copy to Clipboard Toggle word wrap
Show export location of the share.

Positional arguments

<share>
Name or ID of the share.
<export_location>
ID of the share export location.

18.58. manila share-instance-export-location-list
Copy link

usage: manila share-instance-export-location-list [--columns <columns>] <instance>
Copy to Clipboard Toggle word wrap
List export locations of a given share instance.

Positional arguments

<instance>
Name or ID of the share instance.

Optional arguments

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

18.59. manila share-instance-export-location-show
Copy link

usage: manila share-instance-export-location-show <instance> <export_location>
Copy to Clipboard Toggle word wrap
Show export location for the share instance.

Positional arguments

<instance>
Name or ID of the share instance.
<export_location>
ID of the share instance export location.

18.60. manila share-instance-force-delete
Copy link

usage: manila share-instance-force-delete <instance> [<instance> ...]
Copy to Clipboard Toggle word wrap
Force-delete the share instance, regardless of state (Admin only).

Positional arguments

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

18.61. manila share-instance-list
Copy link

usage: manila share-instance-list [--share-id <share_id>] [--columns <columns>]
Copy to Clipboard Toggle word wrap
List share instances (Admin only).

Optional arguments

--share-id <share_id>, --share_id <share_id>
Filter results by share ID.
--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id,host,status"

18.62. manila share-instance-reset-state
Copy link

usage: manila share-instance-reset-state [--state <state>] <instance>
Copy to Clipboard Toggle word wrap
Explicitly update the state of a share instance (Admin only).

Positional arguments

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

Optional arguments

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

18.63. manila share-instance-show
Copy link

usage: manila share-instance-show <instance>
Copy to Clipboard Toggle word wrap
Show details about a share instance (Admin only).

Positional arguments

<instance>
Name or ID of the share instance.

18.64. manila share-network-create
Copy link

usage: manila share-network-create [--nova-net-id <nova-net-id>] [--neutron-net-id <neutron-net-id>] [--neutron-subnet-id <neutron-subnet-id>] [--name <name>] [--description <description>]
Copy to Clipboard Toggle word wrap
Create description for network used by the tenant.

Optional arguments

--nova-net-id <nova-net-id>, --nova-net_id <nova-net-id>, --nova_net_id <nova-net-id>, --nova_net-id <nova-net-id>
Nova net ID. Used to set up network for share servers.
--neutron-net-id <neutron-net-id>, --neutron-net_id <neutron-net-id>, --neutron_net_id <neutron-net-id>, --neutron_net-id <neutron-net-id>
Neutron network ID. Used to set up network for share servers.
--neutron-subnet-id <neutron-subnet-id>, --neutron-subnet_id <neutron-subnet-id>, --neutron_subnet_id <neutron-subnet-id>, --neutron_subnet-id <neutron-subnet-id>
Neutron subnet ID. Used to set up network for share servers. This subnet should belong to specified neutron network.
--name <name>
Share network name.
--description <description>
Share network description.

18.65. manila share-network-delete
Copy link

usage: manila share-network-delete <share-network>
Copy to Clipboard Toggle word wrap
Delete share network.

Positional arguments

<share-network>
Name or ID of share network to be deleted.

18.66. manila share-network-list
Copy link

usage: manila share-network-list [--all-tenants [<0|1>]] [--project-id <project_id>] [--name <name>] [--created-since <created_since>] [--created-before <created_before>] [--security-service <security_service>] [--nova-net-id <nova_net_id>] [--neutron-net-id <neutron_net_id>] [--neutron-subnet-id <neutron_subnet_id>] [--network-type <network_type>] [--segmentation-id <segmentation_id>] [--cidr <cidr>] [--ip-version <ip_version>] [--offset <offset>] [--limit <limit>] [--columns <columns>]
Copy to Clipboard Toggle word wrap
Get a list of network info.

Optional arguments

--all-tenants [<0|1>]
Display information from all tenants (Admin only).
--project-id <project_id>, --project_id <project_id>
Filter results by project ID.
--name <name>
Filter results by name.
--created-since <created_since>, --created_since <created_since>
Return only share networks created since given date. The date is in the format 'yyyy-mm-dd'.
--created-before <created_before>, --created_before <created_before>
Return only share networks created until given date. The date is in the format 'yyyy-mm-dd'.
--security-service <security_service>, --security_service <security_service>
Filter results by attached security service.
--nova-net-id <nova_net_id>, --nova_net_id <nova_net_id>, --nova_net-id <nova_net_id>, --nova-net_id <nova_net_id>
Filter results by Nova net ID.
--neutron-net-id <neutron_net_id>, --neutron_net_id <neutron_net_id>, --neutron_net-id <neutron_net_id>, --neutron-net_id <neutron_net_id>
Filter results by neutron net ID.
--neutron-subnet-id <neutron_subnet_id>, --neutron_subnet_id <neutron_subnet_id>, --neutron-subnet_id <neutron_subnet_id>, --neutron_subnet-id <neutron_subnet_id>
Filter results by neutron subnet ID.
--network-type <network_type>, --network_type <network_type>
Filter results by network type.
--segmentation-id <segmentation_id>, --segmentation_id <segmentation_id>
Filter results by segmentation ID.
--cidr <cidr>
Filter results by CIDR.
--ip-version <ip_version>, --ip_version <ip_version>
Filter results by IP version.
--offset <offset>
Start position of share networks listing.
--limit <limit>
Number of share networks to return per request.
--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id"

18.67. manila share-network-security-service-add
Copy link

usage: manila share-network-security-service-add <share-network> <security-service>
Copy to Clipboard Toggle word wrap
Associate security service with share network.

Positional arguments

<share-network>
Share network name or ID.
<security-service>
Security service name or ID to associate with.

18.68. manila share-network-security-service-list
Copy link

usage: manila share-network-security-service-list [--columns <columns>] <share-network>
Copy to Clipboard Toggle word wrap
Get list of security services associated with a given share network.

Positional arguments

<share-network>
Share network name or ID.

Optional arguments

--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id,name" 
usage: manila share-network-security-service-remove <share-network> <security-service>
Copy to Clipboard Toggle word wrap
Dissociate security service from share network.

Positional arguments

<share-network>
Share network name or ID.
<security-service>
Security service name or ID to dissociate.

18.70. manila share-network-show
Copy link

usage: manila share-network-show <share-network>
Copy to Clipboard Toggle word wrap
Get a description for network used by the tenant.

Positional arguments

<share-network>
Name or ID of the share network to show.

18.71. manila share-network-update
Copy link

usage: manila share-network-update [--nova-net-id <nova-net-id>] [--neutron-net-id <neutron-net-id>] [--neutron-subnet-id <neutron-subnet-id>] [--name <name>] [--description <description>] <share-network>
Copy to Clipboard Toggle word wrap
Update share network data.

Positional arguments

<share-network>
Name or ID of share network to update.

Optional arguments

--nova-net-id <nova-net-id>, --nova-net_id <nova-net-id>, --nova_net_id <nova-net-id>, --nova_net-id <nova-net-id>
Nova net ID. Used to set up network for share servers.
--neutron-net-id <neutron-net-id>, --neutron-net_id <neutron-net-id>, --neutron_net_id <neutron-net-id>, --neutron_net-id <neutron-net-id>
Neutron network ID. Used to set up network for share servers.
--neutron-subnet-id <neutron-subnet-id>, --neutron-subnet_id <neutron-subnet-id>, --neutron_subnet_id <neutron-subnet-id>, --neutron_subnet-id <neutron-subnet-id>
Neutron subnet ID. Used to set up network for share servers. This subnet should belong to specified neutron network.
--name <name>
Share network name.
--description <description>
Share network description.

18.72. manila share-replica-create
Copy link

usage: manila share-replica-create [--availability-zone <availability-zone>] [--share-network <network-info>] <share>
Copy to Clipboard Toggle word wrap
Create a share replica (Experimental).

Positional arguments

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

Optional arguments

--availability-zone <availability-zone>, --availability_zone <availability-zone>, --az <availability-zone>
Optional Availability zone in which replica should be created.
--share-network <network-info>, --share_network <network-info>
Optional network info ID or name.

18.73. manila share-replica-delete
Copy link

usage: manila share-replica-delete [--force] <replica> [<replica> ...]
Copy to Clipboard Toggle word wrap
Remove one or more share replicas (Experimental).

Positional arguments

<replica>
ID of the share replica.

Optional arguments

--force
Attempt to force deletion of a replica on its backend. Using this option will purge the replica from Manila even if it is not cleaned up on the backend. Defaults to False.

18.74. manila share-replica-list
Copy link

usage: manila share-replica-list [--share-id <share_id>]
Copy to Clipboard Toggle word wrap
List share replicas (Experimental).

Optional arguments

--share-id <share_id>, --share_id <share_id>, --si <share_id>
List replicas belonging to share.

18.75. manila share-replica-promote
Copy link

usage: manila share-replica-promote <replica>
Copy to Clipboard Toggle word wrap
Promote specified replica to 'active' replica_state (Experimental).

Positional arguments

<replica>
ID of the share replica.

18.76. manila share-replica-reset-replica-state
Copy link

usage: manila share-replica-reset-replica-state [--replica-state <replica_state>] <replica>
Copy to Clipboard Toggle word wrap
Explicitly update the 'replica_state' of a share replica (Experimental).

Positional arguments

<replica>
ID of the share replica to modify.

Optional arguments

--replica-state <replica_state>, --replica_state <replica_state>, --state <replica_state>
Indicate which replica_state to assign the replica. Options include in_sync, out_of_sync, active, error. If no state is provided, out_of_sync will be used.

18.77. manila share-replica-reset-state
Copy link

usage: manila share-replica-reset-state [--state <state>] <replica>
Copy to Clipboard Toggle word wrap
Explicitly update the 'status' of a share replica (Experimental).

Positional arguments

<replica>
ID of the share replica to modify.

Optional arguments

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

18.78. manila share-replica-resync
Copy link

usage: manila share-replica-resync <replica>
Copy to Clipboard Toggle word wrap
Attempt to update the share replica with its 'active' mirror (Experimental).

Positional arguments

<replica>
ID of the share replica to resync.

18.79. manila share-replica-show
Copy link

usage: manila share-replica-show <replica>
Copy to Clipboard Toggle word wrap
Show details about a replica (Experimental).

Positional arguments

<replica>
ID of the share replica.

18.80. manila share-server-delete
Copy link

usage: manila share-server-delete <id>
Copy to Clipboard Toggle word wrap
Delete share server (Admin only).

Positional arguments

<id>
ID of share server.

18.81. manila share-server-details
Copy link

usage: manila share-server-details <id>
Copy to Clipboard Toggle word wrap
Show share server details (Admin only).

Positional arguments

<id>
ID of share server.

18.82. manila share-server-list
Copy link

usage: manila share-server-list [--host <hostname>] [--status <status>] [--share-network <share_network>] [--project-id <project_id>] [--columns <columns>]
Copy to Clipboard Toggle word wrap
List all share servers (Admin only).

Optional arguments

--host <hostname>
Filter results by name of host.
--status <status>
Filter results by status.
--share-network <share_network>
Filter results by share network.
--project-id <project_id>
Filter results by project ID.
--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id,host,status"

18.83. manila share-server-show
Copy link

usage: manila share-server-show <id>
Copy to Clipboard Toggle word wrap
Show share server info (Admin only).

Positional arguments

<id>
ID of share server.

18.84. manila show
Copy link

usage: manila show <share>
Copy to Clipboard Toggle word wrap
Show details about a NAS share.

Positional arguments

<share>
Name or ID of the NAS share.

18.85. manila shrink
Copy link

usage: manila shrink <share> <new_size>
Copy to Clipboard Toggle word wrap
Decreases the size of an existing share.

Positional arguments

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

18.86. manila snapshot-create
Copy link

usage: manila snapshot-create [--force <True|False>] [--name <name>] [--description <description>] <share>
Copy to Clipboard Toggle word wrap
Add a new snapshot.

Positional arguments

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

Optional arguments

--force <True|False>
Optional flag to indicate whether to snapshot a share even if it's busy. (Default=False)
--name <name>
Optional snapshot name. (Default=None)
--description <description>
Optional snapshot description. (Default=None)

18.87. manila snapshot-delete
Copy link

usage: manila snapshot-delete <snapshot>
Copy to Clipboard Toggle word wrap
Remove a snapshot.

Positional arguments

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

18.88. manila snapshot-force-delete
Copy link

usage: manila snapshot-force-delete <snapshot>
Copy to Clipboard Toggle word wrap
Attempt force-delete of snapshot, regardless of state (Admin only).

Positional arguments

<snapshot>
Name or ID of the snapshot to force delete.

18.89. manila snapshot-list
Copy link

usage: manila snapshot-list [--all-tenants [<0|1>]] [--name <name>] [--status <status>] [--share-id <share_id>] [--usage [any|used|unused]] [--limit <limit>] [--offset <offset>] [--sort-key <sort_key>] [--sort-dir <sort_dir>] [--columns <columns>]
Copy to Clipboard Toggle word wrap
List all the snapshots.

Optional arguments

--all-tenants [<0|1>]
Display information from all tenants (Admin only).
--name <name>
Filter results by name.
--status <status>
Filter results by status.
--share-id <share_id>, --share_id <share_id>
Filter results by source share ID.
--usage [any|used|unused]
Either filter or not snapshots by its usage. OPTIONAL: Default=any.
--limit <limit>
Maximum number of share snapshots to return. OPTIONAL: Default=None.
--offset <offset>
Set offset to define start point of share snapshots listing. OPTIONAL: Default=None.
--sort-key <sort_key>, --sort_key <sort_key>
Key to be sorted, available keys are ('id', 'status', 'size', 'share_id', 'user_id', 'project_id', 'progress', 'name', 'display_name'). Default=None.
--sort-dir <sort_dir>, --sort_dir <sort_dir>
Sort direction, available values are ('asc', 'desc'). OPTIONAL: Default=None.
--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id,name"

18.90. manila snapshot-manage
Copy link

usage: manila snapshot-manage [--name <name>] [--description <description>] [--driver_options [<key=value> [<key=value> ...]]] <share> <provider_location>
Copy to Clipboard Toggle word wrap
Manage share snapshot not handled by Manila (Admin only).

Positional arguments

<share>
Name or ID of the share.
<provider_location>
Provider location of the snapshot on the backend.

Optional arguments

--name <name>
Optional snapshot name (Default=None).
--description <description>
Optional snapshot description (Default=None).
--driver_options [<key=value> [<key=value> ...]], --driver-options [<key=value> [<key=value> ...]]
Optional driver options as key=value pairs (Default=None).

18.91. manila snapshot-rename
Copy link

usage: manila snapshot-rename [--description <description>] <snapshot> [<name>]
Copy to Clipboard Toggle word wrap
Rename a snapshot.

Positional arguments

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

Optional arguments

--description <description>
Optional snapshot description. (Default=None)

18.92. manila snapshot-reset-state
Copy link

usage: manila snapshot-reset-state [--state <state>] <snapshot>
Copy to Clipboard Toggle word wrap
Explicitly update the state of a snapshot (Admin only).

Positional arguments

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

Optional arguments

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

18.93. manila snapshot-show
Copy link

usage: manila snapshot-show <snapshot>
Copy to Clipboard Toggle word wrap
Show details about a snapshot.

Positional arguments

<snapshot>
Name or ID of the snapshot.

18.94. manila snapshot-unmanage
Copy link

usage: manila snapshot-unmanage <snapshot> [<snapshot> ...]
Copy to Clipboard Toggle word wrap
Unmanage one or more share snapshots (Admin only).

Positional arguments

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

18.95. manila type-access-add
Copy link

usage: manila type-access-add <share_type> <project_id>
Copy to Clipboard Toggle word wrap
Adds share type access for the given project (Admin only).

Positional arguments

<share_type>
Share type name or ID to add access for the given project.
<project_id>
Project ID to add share type access for.

18.96. manila type-access-list
Copy link

usage: manila type-access-list <share_type>
Copy to Clipboard Toggle word wrap
Print access information about the given share type (Admin only).

Positional arguments

<share_type>
Filter results by share type name or ID.

18.97. manila type-access-remove
Copy link

usage: manila type-access-remove <share_type> <project_id>
Copy to Clipboard Toggle word wrap
Removes share type access for the given project (Admin only).

Positional arguments

<share_type>
Share type name or ID to remove access for the given project.
<project_id>
Project ID to remove share type access for.

18.98. manila type-create
Copy link

usage: manila type-create [--snapshot_support <snapshot_support>] [--is_public <is_public>] <name> <spec_driver_handles_share_servers>
Copy to Clipboard Toggle word wrap
Create a new share type (Admin only).

Positional arguments

<name>
Name of the new share type.
<spec_driver_handles_share_servers>
Required extra specification. Valid values are 'true'/'1' and 'false'/'0'

Optional arguments

--snapshot_support <snapshot_support>, --snapshot-support <snapshot_support>
Boolean extra spec that used for filtering of back ends by their capability to create share snapshots. (Default is True).
--is_public <is_public>, --is-public <is_public>
Make type accessible to the public (default true).

18.99. manila type-delete
Copy link

usage: manila type-delete <id>
Copy to Clipboard Toggle word wrap
Delete a specific share type (Admin only).

Positional arguments

<id>
Name or ID of the share type to delete.

18.100. manila type-key
Copy link

usage: manila type-key <stype> <action> [<key=value> [<key=value> ...]]
Copy to Clipboard Toggle word wrap
Set or unset extra_spec for a share type (Admin only).

Positional arguments

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

18.101. manila type-list
Copy link

usage: manila type-list [--all] [--columns <columns>]
Copy to Clipboard Toggle word wrap
Print a list of available 'share types'.

Optional arguments

--all
Display all share types (Admin only).
--columns <columns>
Comma separated list of columns to be displayed e.g. --columns "id,name"

18.102. manila unmanage
Copy link

usage: manila unmanage <share>
Copy to Clipboard Toggle word wrap
Unmanage share (Admin only).

Positional arguments

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

18.103. manila update
Copy link

usage: manila update [--name <name>] [--description <description>] [--is-public <is_public>] <share>
Copy to Clipboard Toggle word wrap
Rename a share.

Positional arguments

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

Optional arguments

--name <name>
New name for the share.
--description <description>
Optional share description. (Default=None)
--is-public <is_public>, --is_public <is_public>
Public share is visible for all tenants.
The gnocchi client is the command-line interface (CLI) for the A time series storage and resources index service API and its extensions. This chapter documents gnocchi version 2.2.0.
For help on a specific gnocchi command, enter: 
$ gnocchi help COMMAND
Copy to Clipboard Toggle word wrap

19.1. gnocchi usage
Copy link

usage: gnocchi [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug] [--os-region-name <auth-region-name>] [--os-interface <interface>] [--gnocchi-api-version GNOCCHI_API_VERSION] [--insecure] [--os-cacert <ca-certificate>] [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>] [--os-auth-type <name>] [--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID] [--os-domain-name OS_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID] [--os-project-name OS_PROJECT_NAME] [--os-project-domain-id OS_PROJECT_DOMAIN_ID] [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] [--os-trust-id OS_TRUST_ID] [--os-default-domain-id OS_DEFAULT_DOMAIN_ID] [--os-default-domain-name OS_DEFAULT_DOMAIN_NAME] [--os-user-id OS_USER_ID] [--os-user-name OS_USERNAME] [--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-password OS_PASSWORD] [--endpoint ENDPOINT]
Copy to Clipboard Toggle word wrap

19.2. gnocchi optional arguments
Copy link

--version
show program's version number and exit
-v, --verbose
Increase verbosity of output. Can be repeated.
-q, --quiet
Suppress output except warnings and errors.
--log-file LOG_FILE
Specify a file to log output. Disabled by default.
-h, --help
Show help message and exit.
--debug
Show tracebacks on errors.
--os-region-name <auth-region-name>
Authentication region name (Env: OS_REGION_NAME)
--os-interface <interface>
Select an interface type. Valid interface types: [admin, public, internal]. (Env: OS_INTERFACE)
--gnocchi-api-version GNOCCHI_API_VERSION
Defaults to env[GNOCCHI_API_VERSION] or 1.
--os-auth-type <name>, --os-auth-plugin <name>
Authentication type to use
--endpoint ENDPOINT
Gnocchi endpoint (Env: GNOCCHI_ENDPOINT)

19.3. gnocchi API Connection Options
Copy link

Options controlling the HTTP API Connections
--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).

19.4. gnocchi Authentication Options
Copy link

Options specific to the password plugin.
--os-auth-url OS_AUTH_URL
Authentication URL
--os-domain-id OS_DOMAIN_ID
Domain ID to scope to
--os-domain-name OS_DOMAIN_NAME
Domain name to scope to
--os-project-id OS_PROJECT_ID, --os-tenant-id OS_PROJECT_ID
Project ID to scope to
--os-project-name OS_PROJECT_NAME, --os-tenant-name OS_PROJECT_NAME
Project name to scope to
--os-project-domain-id OS_PROJECT_DOMAIN_ID
Domain ID containing project
--os-project-domain-name OS_PROJECT_DOMAIN_NAME
Domain name containing project
--os-trust-id OS_TRUST_ID
Trust ID
--os-default-domain-id OS_DEFAULT_DOMAIN_ID
Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.
--os-default-domain-name OS_DEFAULT_DOMAIN_NAME
Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.
--os-user-id OS_USER_ID
User id
--os-user-name OS_USERNAME, --os-username OS_USERNAME
Username
--os-user-domain-id OS_USER_DOMAIN_ID
User's domain id
--os-user-domain-name OS_USER_DOMAIN_NAME
User's domain name
--os-password OS_PASSWORD
User's password

19.5. gnocchi archive-policy create
Copy link

usage: gnocchi archive-policy create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [-b BACK_WINDOW] [-m AGGREGATION_METHODS] -d <DEFINITION> name
Copy to Clipboard Toggle word wrap
Create an archive policy

Positional arguments

name
name of the archive policy

Optional arguments

-h, --help
show this help message and exit
-b BACK_WINDOW, --back-window BACK_WINDOW
back window of the archive policy
-m AGGREGATION_METHODS, --aggregation-method AGGREGATION_METHODS
aggregation method of the archive policy
-d <DEFINITION>, --definition <DEFINITION>
two attributes (separated by ',') of an archive policy definition with its name and value separated with a ':'

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

19.6. gnocchi archive-policy delete
Copy link

usage: gnocchi archive-policy delete [-h] name
Copy to Clipboard Toggle word wrap
Delete an archive policy

Positional arguments

name
Name of the archive policy

Optional arguments

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

19.7. gnocchi archive-policy list
Copy link

usage: gnocchi archive-policy list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List archive policies

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

19.8. gnocchi archive-policy-rule create
Copy link

usage: gnocchi archive-policy-rule create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] -a ARCHIVE_POLICY_NAME -m METRIC_PATTERN name
Copy to Clipboard Toggle word wrap
Create an archive policy rule

Positional arguments

name
Rule name

Optional arguments

-h, --help
show this help message and exit
-a ARCHIVE_POLICY_NAME, --archive-policy-name ARCHIVE_POLICY_NAME
Archive policy name
-m METRIC_PATTERN, --metric-pattern METRIC_PATTERN
Wildcard of metric name to match

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

19.9. gnocchi archive-policy-rule delete
Copy link

usage: gnocchi archive-policy-rule delete [-h] name
Copy to Clipboard Toggle word wrap
Delete an archive policy rule

Positional arguments

name
Name of the archive policy rule

Optional arguments

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

19.10. gnocchi archive-policy-rule list
Copy link

usage: gnocchi archive-policy-rule list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List archive policy 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

19.11. gnocchi archive-policy-rule show
Copy link

usage: gnocchi archive-policy-rule show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] name
Copy to Clipboard Toggle word wrap
Show an archive policy rule

Positional arguments

name
Name of the archive policy rule

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

19.12. gnocchi archive-policy show
Copy link

usage: gnocchi archive-policy show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] name
Copy to Clipboard Toggle word wrap
Show an archive policy

Positional arguments

name
Name of the archive policy

Optional arguments

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

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

19.13. gnocchi benchmark measures add
Copy link

usage: gnocchi benchmark measures add [-h] [--resource-id RESOURCE_ID] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--workers WORKERS] --count COUNT [--batch BATCH] [--timestamp-start TIMESTAMP_START] [--timestamp-end TIMESTAMP_END] metric
Copy to Clipboard Toggle word wrap
Do benchmark testing of adding measurements

Positional arguments

metric
ID or name of the metric

Optional arguments

-h, --help
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource
--workers WORKERS, -w WORKERS
Number of workers to use
--count COUNT, -n COUNT
Number of total measures to send
--batch BATCH, -b BATCH
Number of measures to send in each batch
--timestamp-start TIMESTAMP_START, -s TIMESTAMP_START
First timestamp to use
--timestamp-end TIMESTAMP_END, -e TIMESTAMP_END
Last timestamp to use

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

19.14. gnocchi benchmark measures show
Copy link

usage: gnocchi benchmark measures show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--resource-id RESOURCE_ID] [--aggregation AGGREGATION] [--start START] [--stop STOP] [--workers WORKERS] --count COUNT metric
Copy to Clipboard Toggle word wrap
Do benchmark testing of measurements show

Positional arguments

metric
ID or name of the metric

Optional arguments

-h, --help
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource
--aggregation AGGREGATION
aggregation to retrieve
--start START
beginning of the period
--stop STOP
end of the period
--workers WORKERS, -w WORKERS
Number of workers to use
--count COUNT, -n COUNT
Number of total measures to send

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

19.15. gnocchi benchmark metric create
Copy link

usage: gnocchi benchmark metric create [-h] [--resource-id RESOURCE_ID] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--archive-policy-name ARCHIVE_POLICY_NAME] [--workers WORKERS] --count COUNT [--keep]
Copy to Clipboard Toggle word wrap
Do benchmark testing of metric creation

Optional arguments

-h, --help
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource
--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME
name of the archive policy
--workers WORKERS, -w WORKERS
Number of workers to use
--count COUNT, -n COUNT
Number of metrics to create
--keep, -k
Keep created metrics

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

19.16. gnocchi benchmark metric show
Copy link

usage: gnocchi benchmark metric show [-h] [--resource-id RESOURCE_ID] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--workers WORKERS] --count COUNT metric [metric ...]
Copy to Clipboard Toggle word wrap
Do benchmark testing of metric show

Positional arguments

metric
ID or name of the metrics

Optional arguments

-h, --help
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource
--workers WORKERS, -w WORKERS
Number of workers to use
--count COUNT, -n COUNT
Number of metrics to get

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

19.17. gnocchi capabilities list
Copy link

usage: gnocchi capabilities list [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX]
Copy to Clipboard Toggle word wrap
List capabilities

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

19.18. gnocchi measures add
Copy link

usage: gnocchi measures add [-h] [--resource-id RESOURCE_ID] -m MEASURE metric
Copy to Clipboard Toggle word wrap
Add measurements to a metric

Positional arguments

metric
ID or name of the metric

Optional arguments

-h, --help
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource
-m MEASURE, --measure MEASURE
timestamp and value of a measure separated with a '@'

19.19. gnocchi measures aggregation
Copy link

usage: gnocchi measures aggregation [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] -m METRIC [METRIC ...] [--aggregation AGGREGATION] [--start START] [--stop STOP] [--needed-overlap NEEDED_OVERLAP] [--query QUERY]
Copy to Clipboard Toggle word wrap
Get measurements of aggregated metrics

Optional arguments

-h, --help
show this help message and exit
-m METRIC [METRIC ...], --metric METRIC [METRIC ...]
metrics IDs or metric name
--aggregation AGGREGATION
aggregation to retrieve
--start START
beginning of the period
--stop STOP
end of the period
--needed-overlap NEEDED_OVERLAP
percent of datapoints in each metrics required
--query QUERY
Query

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

CSV formatter:

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

19.20. gnocchi measures batch-metrics
Copy link

usage: gnocchi measures batch-metrics [-h] file
Copy to Clipboard Toggle word wrap

Positional arguments

file
File containing measurements to batch or - for stdin (see Gnocchi REST API docs for the format

Optional arguments

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

19.21. gnocchi measures batch-resources-metrics
Copy link

usage: gnocchi measures batch-resources-metrics [-h] file
Copy to Clipboard Toggle word wrap

Positional arguments

file
File containing measurements to batch or - for stdin (see Gnocchi REST API docs for the format

Optional arguments

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

19.22. gnocchi measures show
Copy link

usage: gnocchi measures show [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--resource-id RESOURCE_ID] [--aggregation AGGREGATION] [--start START] [--stop STOP] metric
Copy to Clipboard Toggle word wrap
Get measurements of a metric

Positional arguments

metric
ID or name of the metric

Optional arguments

-h, --help
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource
--aggregation AGGREGATION
aggregation to retrieve
--start START
beginning of the period
--stop STOP
end of the period

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

19.23. gnocchi metric create
Copy link

usage: gnocchi metric create [-h] [--resource-id RESOURCE_ID] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--archive-policy-name ARCHIVE_POLICY_NAME] [METRIC_NAME]
Copy to Clipboard Toggle word wrap
Create a metric

Positional arguments

METRIC_NAME
Name of the metric

Optional arguments

-h, --help
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource
--archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME
name of the archive policy

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

19.24. gnocchi metric delete
Copy link

usage: gnocchi metric delete [-h] [--resource-id RESOURCE_ID] metric [metric ...]
Copy to Clipboard Toggle word wrap
Delete a metric

Positional arguments

metric
IDs or names of the metric

Optional arguments

-h, --help
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource

19.25. gnocchi metric list
Copy link

usage: gnocchi metric list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List metrics

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

19.26. gnocchi metric show
Copy link

usage: gnocchi metric show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--resource-id RESOURCE_ID] metric
Copy to Clipboard Toggle word wrap
Show a metric

Positional arguments

metric
ID or name of the metric

Optional arguments

-h, --help
show this help message and exit
--resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource

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

19.27. gnocchi resource create
Copy link

usage: gnocchi resource create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--type RESOURCE_TYPE] [-a ATTRIBUTE] [-m ADD_METRIC] [-n CREATE_METRIC] [-d DELETE_METRIC] resource_id
Copy to Clipboard Toggle word wrap
Create a resource

Positional arguments

resource_id
ID of the resource

Optional arguments

-h, --help
show this help message and exit
--type RESOURCE_TYPE, -t RESOURCE_TYPE
Type of resource
-a ATTRIBUTE, --attribute ATTRIBUTE
name and value of a attribute separated with a ':'
-m ADD_METRIC, --add-metric ADD_METRIC
name:id of a metric to add
-n CREATE_METRIC, --create-metric CREATE_METRIC
name:archive_policy_name of a metric to create
-d DELETE_METRIC, --delete-metric DELETE_METRIC
Name of a metric to delete

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

19.28. gnocchi resource delete
Copy link

usage: gnocchi resource delete [-h] resource_id
Copy to Clipboard Toggle word wrap
Delete a resource

Positional arguments

resource_id
ID of the resource

Optional arguments

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

19.29. gnocchi resource history
Copy link

usage: gnocchi resource history [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--details] [--limit <LIMIT>] [--marker <MARKER>] [--sort <SORT>] [--type RESOURCE_TYPE] resource_id
Copy to Clipboard Toggle word wrap
Show the history of a resource

Positional arguments

resource_id
ID of a resource

Optional arguments

-h, --help
show this help message and exit
--details
Show all attributes of generic resources
--limit <LIMIT>
Number of resources to return (Default is server default)
--marker <MARKER>
Last item of the previous listing. Return the next results after this value
--sort <SORT>
Sort of resource attribute (example: user_id:desc- nullslast
--type RESOURCE_TYPE, -t RESOURCE_TYPE
Type of resource

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

19.30. gnocchi resource list
Copy link

usage: gnocchi resource list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--details] [--history] [--limit <LIMIT>] [--marker <MARKER>] [--sort <SORT>] [--type RESOURCE_TYPE]
Copy to Clipboard Toggle word wrap
List resources

Optional arguments

-h, --help
show this help message and exit
--details
Show all attributes of generic resources
--history
Show history of the resources
--limit <LIMIT>
Number of resources to return (Default is server default)
--marker <MARKER>
Last item of the previous listing. Return the next results after this value
--sort <SORT>
Sort of resource attribute (example: user_id:desc- nullslast
--type RESOURCE_TYPE, -t RESOURCE_TYPE
Type of resource

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

19.31. gnocchi resource list-types
Copy link

usage: gnocchi resource list-types [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List the resource types that gnocchi supports

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

19.33. gnocchi resource show
Copy link

usage: gnocchi resource show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--type RESOURCE_TYPE] resource_id
Copy to Clipboard Toggle word wrap
Show a resource

Positional arguments

resource_id
ID of a resource

Optional arguments

-h, --help
show this help message and exit
--type RESOURCE_TYPE, -t RESOURCE_TYPE
Type of resource

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

19.34. gnocchi resource update
Copy link

usage: gnocchi resource update [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--type RESOURCE_TYPE] [-a ATTRIBUTE] [-m ADD_METRIC] [-n CREATE_METRIC] [-d DELETE_METRIC] resource_id
Copy to Clipboard Toggle word wrap
Update a resource

Positional arguments

resource_id
ID of the resource

Optional arguments

-h, --help
show this help message and exit
--type RESOURCE_TYPE, -t RESOURCE_TYPE
Type of resource
-a ATTRIBUTE, --attribute ATTRIBUTE
name and value of a attribute separated with a ':'
-m ADD_METRIC, --add-metric ADD_METRIC
name:id of a metric to add
-n CREATE_METRIC, --create-metric CREATE_METRIC
name:archive_policy_name of a metric to create
-d DELETE_METRIC, --delete-metric DELETE_METRIC
Name of a metric to delete

Output formatters

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

table formatter:

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

json formatter:

--noindent
whether to disable indenting the JSON

shell formatter:

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

19.35. gnocchi status
Copy link

usage: gnocchi status [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX]
Copy to Clipboard Toggle word wrap
Show the status of measurements processing

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 20. DNS service command-line client
Copy link

The designate client is the command-line interface (CLI) for the DNS service API and its extensions. This chapter documents designate version 2.0.0.
For help on a specific designate command, enter: 
$ designate help COMMAND
Copy to Clipboard Toggle word wrap

20.1. designate usage
Copy link

usage: designate [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug] [--os-username OS_USERNAME] [--os-user-id OS_USER_ID] [--os-user-domain-id OS_USER_DOMAIN_ID] [--os-user-domain-name OS_USER_DOMAIN_NAME] [--os-password OS_PASSWORD] [--os-tenant-name OS_TENANT_NAME] [--os-tenant-id OS_TENANT_ID] [--os-project-name OS_PROJECT_NAME] [--os-domain-name OS_DOMAIN_NAME] [--os-domain-id OS_DOMAIN_ID] [--os-project-id OS_PROJECT_ID] [--os-project-domain-id OS_PROJECT_DOMAIN_ID] [--os-project-domain-name OS_PROJECT_DOMAIN_NAME] [--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME] [--os-token OS_TOKEN] [--os-endpoint OS_ENDPOINT] [--os-endpoint-type OS_ENDPOINT_TYPE] [--os-service-type OS_SERVICE_TYPE] [--os-cacert OS_CACERT] [--insecure] [--all-tenants] [--edit-managed]
Copy to Clipboard Toggle word wrap

20.2. designate optional arguments
Copy link

--version
show program's version number and exit
-v, --verbose
Increase verbosity of output. Can be repeated.
-q, --quiet
Suppress output except warnings and errors.
--log-file LOG_FILE
Specify a file to log output. Disabled by default.
-h, --help
Show this help message and exit.
--debug
Show tracebacks on errors.
--os-username OS_USERNAME
Name used for authentication with the OpenStack Identity service. Defaults to env[OS_USERNAME].
--os-user-id OS_USER_ID
User ID used for authentication with the OpenStack Identity service. Defaults to env[OS_USER_ID].
--os-user-domain-id OS_USER_DOMAIN_ID
Defaults to env[OS_USER_DOMAIN_ID].
--os-user-domain-name OS_USER_DOMAIN_NAME
Defaults to env[OS_USER_DOMAIN_NAME].
--os-password OS_PASSWORD
Password used for authentication with the OpenStack Identity service. Defaults to env[OS_PASSWORD].
--os-tenant-name OS_TENANT_NAME
Tenant to request authorization on. Defaults to env[OS_TENANT_NAME].
--os-tenant-id OS_TENANT_ID
Tenant to request authorization on. Defaults to env[OS_TENANT_ID].
--os-project-name OS_PROJECT_NAME
Project to request authorization on. Defaults to env[OS_PROJECT_NAME].
--os-domain-name OS_DOMAIN_NAME
Project to request authorization on. Defaults to env[OS_DOMAIN_NAME].
--os-domain-id OS_DOMAIN_ID
Defaults to env[OS_DOMAIN_ID].
--os-project-id OS_PROJECT_ID
Project to request authorization on. Defaults to env[OS_PROJECT_ID].
--os-project-domain-id OS_PROJECT_DOMAIN_ID
Defaults to env[OS_PROJECT_DOMAIN_ID].
--os-project-domain-name OS_PROJECT_DOMAIN_NAME
Defaults to env[OS_PROJECT_DOMAIN_NAME].
--os-auth-url OS_AUTH_URL
Specify the Identity endpoint to use for authentication. Defaults to env[OS_AUTH_URL].
--os-region-name OS_REGION_NAME
Specify the region to use. Defaults to env[OS_REGION_NAME].
--os-token OS_TOKEN
Specify an existing token to use instead of retrieving one via authentication (e.g. with username & password). Defaults to env[OS_SERVICE_TOKEN].
--os-endpoint OS_ENDPOINT
Specify an endpoint to use instead of retrieving one from the service catalog (via authentication). Defaults to env[OS_DNS_ENDPOINT].
--os-endpoint-type OS_ENDPOINT_TYPE
Defaults to env[OS_ENDPOINT_TYPE].
--os-service-type OS_SERVICE_TYPE
Defaults to env[OS_DNS_SERVICE_TYPE], or 'dns'.
--os-cacert OS_CACERT
CA certificate bundle file. Defaults to env[OS_CACERT].
--insecure
Explicitly allow 'insecure' SSL requests.
--all-tenants
Allows to list all domains from all tenants.
--edit-managed
Allows to edit records that are marked as managed.

20.3. designate diagnostics-ping
Copy link

usage: designate diagnostics-ping [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --service SERVICE --host HOST
Copy to Clipboard Toggle word wrap
Ping a service on a given host

Optional arguments

-h, --help
show this help message and exit
--service SERVICE
Service name (e.g. central)
--host HOST
Hostname

20.4. designate domain-create
Copy link

usage: designate domain-create [-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]
Copy to Clipboard Toggle word wrap
Create Domain

Optional arguments

-h, --help
show this help message and exit
--name NAME
Domain name.
--email EMAIL
Domain email.
--ttl TTL
Time to live (seconds).
--description DESCRIPTION
Description.

20.5. designate domain-delete
Copy link

usage: designate domain-delete [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id
Copy to Clipboard Toggle word wrap
Delete Domain

Positional arguments

id
Domain ID or name.

Optional arguments

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

20.6. designate domain-get
Copy link

usage: designate domain-get [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id
Copy to Clipboard Toggle word wrap
Get Domain

Positional arguments

id
Domain ID or name.

Optional arguments

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

20.7. designate domain-list
Copy link

usage: designate domain-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List Domains

Optional arguments

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

20.8. designate domain-servers-list
Copy link

usage: designate domain-servers-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] id
Copy to Clipboard Toggle word wrap
List Domain Servers

Positional arguments

id
Domain ID or name.

Optional arguments

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

20.9. designate domain-update
Copy link

usage: designate domain-update [-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] id
Copy to Clipboard Toggle word wrap
Update Domain

Positional arguments

id
Domain ID or name.

Optional arguments

-h, --help
show this help message and exit
--name NAME
Domain name.
--email EMAIL
Domain email.
--ttl TTL
Time to live (seconds).
--description DESCRIPTION
Description.
--no-description

20.10. designate quota-get
Copy link

usage: designate quota-get [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] tenant_id
Copy to Clipboard Toggle word wrap
Get Quota

Positional arguments

tenant_id
Tenant ID

Optional arguments

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

20.11. designate quota-reset
Copy link

usage: designate quota-reset [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] tenant_id
Copy to Clipboard Toggle word wrap
Reset Quota

Positional arguments

tenant_id
Tenant ID.

Optional arguments

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

20.12. designate quota-update
Copy link

usage: designate quota-update [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--domains DOMAINS] [--domain-recordsets DOMAIN_RECORDSETS] [--recordset-records RECORDSET_RECORDS] [--domain-records DOMAIN_RECORDS] [--api-export-size API_EXPORT_SIZE] tenant_id
Copy to Clipboard Toggle word wrap
Update Quota

Positional arguments

tenant_id
Tenant ID.

Optional arguments

-h, --help
show this help message and exit
--domains DOMAINS
Allowed domains.
--domain-recordsets DOMAIN_RECORDSETS
Allowed domain records.
--recordset-records RECORDSET_RECORDS
Allowed recordset records.
--domain-records DOMAIN_RECORDS
Allowed domain records.
--api-export-size API_EXPORT_SIZE
Allowed zone export recordsets.

20.13. designate record-create
Copy link

usage: designate record-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --name NAME --type TYPE --data DATA [--ttl TTL] [--priority PRIORITY] [--description DESCRIPTION] domain_id
Copy to Clipboard Toggle word wrap
Create Record

Positional arguments

domain_id
Domain ID or name.

Optional arguments

-h, --help
show this help message and exit
--name NAME
Record (relative|absolute) name.
--type TYPE
Record type.
--data DATA
Record data.
--ttl TTL
Record TTL.
--priority PRIORITY
Record priority.
--description DESCRIPTION
Description.

20.14. designate record-delete
Copy link

usage: designate record-delete [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] domain_id id
Copy to Clipboard Toggle word wrap
Delete Record

Positional arguments

domain_id
Domain ID or name.
id
Record ID.

Optional arguments

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

20.15. designate record-get
Copy link

usage: designate record-get [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] domain_id id
Copy to Clipboard Toggle word wrap
Get Record

Positional arguments

domain_id
Domain ID or name.
id
Record ID.

Optional arguments

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

20.16. designate record-list
Copy link

usage: designate record-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] domain_id
Copy to Clipboard Toggle word wrap
List Records

Positional arguments

domain_id
Domain ID or name.

Optional arguments

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

20.17. designate record-update
Copy link

usage: designate record-update [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name NAME] [--type TYPE] [--data DATA] [--description DESCRIPTION | --no-description] [--ttl TTL | --no-ttl] [--priority PRIORITY | --no-priority] domain_id id
Copy to Clipboard Toggle word wrap
Update Record

Positional arguments

domain_id
Domain ID or name.
id
Record ID.

Optional arguments

-h, --help
show this help message and exit
--name NAME
Record name.
--type TYPE
Record type.
--data DATA
Record data.
--description DESCRIPTION
Description.
--no-description
--ttl TTL
Record time to live (seconds).
--no-ttl
--priority PRIORITY
Record priority.
--no-priority

20.18. designate report-count-all
Copy link

usage: designate report-count-all [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX]
Copy to Clipboard Toggle word wrap
Get count totals for all tenants, domains and records

Optional arguments

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

20.19. designate report-count-domains
Copy link

usage: designate report-count-domains [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX]
Copy to Clipboard Toggle word wrap
Get counts for total domains

Optional arguments

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

20.20. designate report-count-records
Copy link

usage: designate report-count-records [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX]
Copy to Clipboard Toggle word wrap
Get counts for total records

Optional arguments

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

20.21. designate report-count-tenants
Copy link

usage: designate report-count-tenants [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX]
Copy to Clipboard Toggle word wrap
Get counts for total tenants

Optional arguments

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

20.22. designate report-tenant-domains
Copy link

usage: designate report-tenant-domains [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] --report-tenant-id REPORT_TENANT_ID
Copy to Clipboard Toggle word wrap
Get a list of domains for given tenant

Optional arguments

-h, --help
show this help message and exit
--report-tenant-id REPORT_TENANT_ID
The tenant_id being reported on.

20.23. designate report-tenants-all
Copy link

usage: designate report-tenants-all [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
Get list of tenants and domain count for each

Optional arguments

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

20.24. designate server-create
Copy link

usage: designate server-create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --name NAME
Copy to Clipboard Toggle word wrap
Create Server

Optional arguments

-h, --help
show this help message and exit
--name NAME
Server name.

20.25. designate server-delete
Copy link

usage: designate server-delete [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id
Copy to Clipboard Toggle word wrap
Delete Server

Positional arguments

id
Server ID.

Optional arguments

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

20.26. designate server-get
Copy link

usage: designate server-get [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id
Copy to Clipboard Toggle word wrap
Get Server

Positional arguments

id
Server ID.

Optional arguments

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

20.27. designate server-list
Copy link

usage: designate server-list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Copy to Clipboard Toggle word wrap
List Servers

Optional arguments

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

20.28. designate server-update
Copy link

usage: designate server-update [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name NAME] id
Copy to Clipboard Toggle word wrap
Update Server

Positional arguments

id
Server ID.

Optional arguments

-h, --help
show this help message and exit
--name NAME
Server name.

20.29. designate sync-all
Copy link

usage: designate sync-all [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX]
Copy to Clipboard Toggle word wrap
Sync Everything

Optional arguments

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

20.30. designate sync-domain
Copy link

usage: designate sync-domain [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] domain_id
Copy to Clipboard Toggle word wrap
Sync a single Domain

Positional arguments

domain_id
Domain ID

Optional arguments

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

20.31. designate sync-record
Copy link

usage: designate sync-record [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] domain_id record_id
Copy to Clipboard Toggle word wrap
Sync a single Record

Positional arguments

domain_id
Domain ID
record_id
Record ID

Optional arguments

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

20.32. designate touch-domain
Copy link

usage: designate touch-domain [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] domain_id
Copy to Clipboard Toggle word wrap
Touch a single Domain

Positional arguments

domain_id
Domain ID

Optional arguments

-h, --help
show this help message and exit
The barbican client is the command-line interface (CLI) for the Key Manager service API and its extensions. This chapter documents barbican version 4.0.0.
For help on a specific barbican command, enter: 
$ barbican help COMMAND
Copy to Clipboard Toggle word wrap

21.1. barbican usage
Copy link

usage: barbican [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug] [--no-auth] [--os-identity-api-version <identity-api-version>] [--os-auth-url <auth-url>] [--os-username <auth-user-name>] [--os-user-id <auth-user-id>] [--os-password <auth-password>] [--os-user-domain-id <auth-user-domain-id>] [--os-user-domain-name <auth-user-domain-name>] [--os-tenant-name <auth-tenant-name>] [--os-tenant-id <tenant-id>] [--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-auth-token <auth-token>] [--endpoint <barbican-url>] [--interface <barbican-interface>] [--service-type <barbican-service-type>] [--service-name <barbican-service-name>] [--region-name <barbican-region-name>] [--barbican-api-version <barbican-api-version>] [--insecure] [--os-cacert <ca-certificate>] [--os-cert <certificate>] [--os-key <key>] [--timeout <seconds>]
Copy to Clipboard Toggle word wrap

21.2. barbican optional arguments
Copy link

--version
show program's version number and exit
-v, --verbose
Increase verbosity of output. Can be repeated.
-q, --quiet
Suppress output except warnings and errors.
--log-file LOG_FILE
Specify a file to log output. Disabled by default.
-h, --help
Show help message and exit.
--debug
Show tracebacks on errors.
--no-auth, -N
Do not use authentication.
--os-identity-api-version <identity-api-version>
Specify Identity API version to use. Defaults to env[OS_IDENTITY_API_VERSION] or 3.
--os-auth-url <auth-url>, -A <auth-url>
Defaults to env[OS_AUTH_URL].
--os-username <auth-user-name>, -U <auth-user-name>
Defaults to env[OS_USERNAME].
--os-user-id <auth-user-id>
Defaults to env[OS_USER_ID].
--os-password <auth-password>, -P <auth-password>
Defaults to env[OS_PASSWORD].
--os-user-domain-id <auth-user-domain-id>
Defaults to env[OS_USER_DOMAIN_ID].
--os-user-domain-name <auth-user-domain-name>
Defaults to env[OS_USER_DOMAIN_NAME].
--os-tenant-name <auth-tenant-name>, -T <auth-tenant-name>
Defaults to env[OS_TENANT_NAME].
--os-tenant-id <tenant-id>, -I <tenant-id>
Defaults to env[OS_TENANT_ID].
--os-project-id <auth-project-id>
Another way to specify tenant ID. This option is mutually exclusive with --os-tenant-id. Defaults to env[OS_PROJECT_ID].
--os-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-auth-token <auth-token>
Defaults to env[OS_AUTH_TOKEN].
--endpoint <barbican-url>, -E <barbican-url>
Defaults to env[BARBICAN_ENDPOINT].
--interface <barbican-interface>
Defaults to env[BARBICAN_INTERFACE].
--service-type <barbican-service-type>
Defaults to env[BARBICAN_SERVICE_TYPE].
--service-name <barbican-service-name>
Defaults to env[BARBICAN_SERVICE_NAME].
--region-name <barbican-region-name>
Defaults to env[BARBICAN_REGION_NAME].
--barbican-api-version <barbican-api-version>
Defaults to env[BARBICAN_API_VERSION].
--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).

21.3. barbican acl delete
Copy link

usage: barbican acl delete [-h] URI
Copy to Clipboard Toggle word wrap
Delete ACLs for a secret or container as identified by its href.

Positional arguments

URI
The URI reference for the secret or container.

Optional arguments

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

21.4. barbican acl get
Copy link

usage: barbican acl get [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] URI
Copy to Clipboard Toggle word wrap
Retrieve ACLs for a secret or container by providing its href.

Positional arguments

URI
The URI reference for the secret or container.

Optional arguments

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

21.5. barbican acl submit
Copy link

usage: barbican acl submit [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--user [USERS]] [--project-access | --no-project-access] [--operation-type {read}] URI
Copy to Clipboard Toggle word wrap
Submit ACL on a secret or container as identified by its href.

Positional arguments

URI
The URI reference for the secret or container.

Optional arguments

-h, --help
show this help message and exit
--user [USERS], -u [USERS]
Keystone userid(s) for ACL.
--project-access
Flag to enable project access behavior.
--no-project-access
Flag to disable project access behavior.
--operation-type {read}, -o {read}
Type of Barbican operation ACL is set for

21.6. barbican acl user add
Copy link

usage: barbican acl user add [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--user [USERS]] [--project-access | --no-project-access] [--operation-type {read}] URI
Copy to Clipboard Toggle word wrap
Add ACL users to a secret or container as identified by its href.

Positional arguments

URI
The URI reference for the secret or container.

Optional arguments

-h, --help
show this help message and exit
--user [USERS], -u [USERS]
Keystone userid(s) for ACL.
--project-access
Flag to enable project access behavior.
--no-project-access
Flag to disable project access behavior.
--operation-type {read}, -o {read}
Type of Barbican operation ACL is set for

21.7. barbican acl user remove
Copy link

usage: barbican acl user remove [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--user [USERS]] [--project-access | --no-project-access] [--operation-type {read}] URI
Copy to Clipboard Toggle word wrap
Remove ACL users from a secret or container as identified by its href.

Positional arguments

URI
The URI reference for the secret or container.

Optional arguments

-h, --help
show this help message and exit
--user [USERS], -u [USERS]
Keystone userid(s) for ACL.
--project-access
Flag to enable project access behavior.
--no-project-access
Flag to disable project access behavior.
--operation-type {read}, -o {read}
Type of Barbican operation ACL is set for

21.8. barbican ca get
Copy link

usage: barbican ca get [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] URI
Copy to Clipboard Toggle word wrap
Retrieve a CA by providing its URI.

Positional arguments

URI
The URI reference for the CA.

Optional arguments

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

21.9. barbican ca list
Copy link

usage: barbican ca list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--limit LIMIT] [--offset OFFSET] [--name NAME]
Copy to Clipboard Toggle word wrap
List cas.

Optional arguments

-h, --help
show this help message and exit
--limit LIMIT, -l LIMIT
specify the limit to the number of items to list per page (default: 10; maximum: 100)
--offset OFFSET, -o OFFSET
specify the page offset (default: 0)
--name NAME, -n NAME
specify the secret name (default: None)

21.10. barbican secret container create
Copy link

usage: barbican secret container create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name NAME] [--type TYPE] [--secret SECRET]
Copy to Clipboard Toggle word wrap
Store a container in Barbican.

Optional arguments

-h, --help
show this help message and exit
--name NAME, -n NAME
a human-friendly name.
--type TYPE
type of container to create (default: generic).
--secret SECRET, -s SECRET
one secret to store in a container (can be set multiple times). Example: --secret "private_key=https://url.test/v1/secrets/1-2-3-4"

21.11. barbican secret container delete
Copy link

usage: barbican secret container delete [-h] URI
Copy to Clipboard Toggle word wrap
Delete a container by providing its href.

Positional arguments

URI
The URI reference for the container

Optional arguments

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

21.12. barbican secret container get
Copy link

usage: barbican secret container get [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] URI
Copy to Clipboard Toggle word wrap
Retrieve a container by providing its URI.

Positional arguments

URI
The URI reference for the container.

Optional arguments

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

21.13. barbican secret container list
Copy link

usage: barbican secret container list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--limit LIMIT] [--offset OFFSET] [--name NAME] [--type TYPE]
Copy to Clipboard Toggle word wrap
List containers.

Optional arguments

-h, --help
show this help message and exit
--limit LIMIT, -l LIMIT
specify the limit to the number of items to list per page (default: 10; maximum: 100)
--offset OFFSET, -o OFFSET
specify the page offset (default: 0)
--name NAME, -n NAME
specify the container name (default: None)
--type TYPE, -t TYPE
specify the type filter for the list (default: None).

21.14. barbican secret delete
Copy link

usage: barbican secret delete [-h] URI
Copy to Clipboard Toggle word wrap
Delete a secret by providing its URI.

Positional arguments

URI
The URI reference for the secret

Optional arguments

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

21.15. barbican secret get
Copy link

usage: barbican secret get [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--decrypt] [--payload] [--payload_content_type PAYLOAD_CONTENT_TYPE] URI
Copy to Clipboard Toggle word wrap
Retrieve a secret by providing its URI.

Positional arguments

URI
The URI reference for the secret.

Optional arguments

-h, --help
show this help message and exit
--decrypt, -d
if specified, retrieve the unencrypted secret data; the data type can be specified with --payload-content- type.
--payload, -p
if specified, retrieve the unencrypted secret data; the data type can be specified with --payload-content- type. If the user wishes to only retrieve the value of the payload they must add "-f value" to format returning only the value of the payload
--payload_content_type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE
the content type of the decrypted secret (default: text/plain.

21.16. barbican secret list
Copy link

usage: barbican secret list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--limit LIMIT] [--offset OFFSET] [--name NAME] [--algorithm ALGORITHM] [--bit-length BIT_LENGTH] [--mode MODE]
Copy to Clipboard Toggle word wrap
List secrets.

Optional arguments

-h, --help
show this help message and exit
--limit LIMIT, -l LIMIT
specify the limit to the number of items to list per page (default: 10; maximum: 100)
--offset OFFSET, -o OFFSET
specify the page offset (default: 0)
--name NAME, -n NAME
specify the secret name (default: None)
--algorithm ALGORITHM, -a ALGORITHM
the algorithm filter for the list(default: None).
--bit-length BIT_LENGTH, -b BIT_LENGTH
the bit length filter for the list (default: 0).
--mode MODE, -m MODE
the algorithm mode filter for the list (default: None).

21.17. barbican secret order create
Copy link

usage: barbican secret order create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name NAME] [--algorithm ALGORITHM] [--bit-length BIT_LENGTH] [--mode MODE] [--payload-content-type PAYLOAD_CONTENT_TYPE] [--expiration EXPIRATION] [--request-type REQUEST_TYPE] [--subject-dn SUBJECT_DN] [--source-container-ref SOURCE_CONTAINER_REF] [--ca-id CA_ID] [--profile PROFILE] [--request-file REQUEST_FILE] type
Copy to Clipboard Toggle word wrap
Create a new order.

Positional arguments

type
the type of the order to create.

Optional arguments

-h, --help
show this help message and exit
--name NAME, -n NAME
a human-friendly name.
--algorithm ALGORITHM, -a ALGORITHM
the algorithm to be used with the requested key (default: aes).
--bit-length BIT_LENGTH, -b BIT_LENGTH
the bit length of the requested secret key (default: 256).
--mode MODE, -m MODE
the algorithm mode to be used with the requested key (default: cbc).
--payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE
the type/format of the secret to be generated (default: application/octet-stream).
--expiration EXPIRATION, -x EXPIRATION
the expiration time for the secret in ISO 8601 format.
--request-type REQUEST_TYPE
the type of the certificate request.
--subject-dn SUBJECT_DN
the subject of the certificate.
--source-container-ref SOURCE_CONTAINER_REF
the source of the certificate when using stored-key requests.
--ca-id CA_ID
the identifier of the CA to use for the certificate request.
--profile PROFILE
the profile of certificate to use.
--request-file REQUEST_FILE
the file containing the CSR.

21.18. barbican secret order delete
Copy link

usage: barbican secret order delete [-h] URI
Copy to Clipboard Toggle word wrap
Delete an order by providing its href.

Positional arguments

URI
The URI reference for the order

Optional arguments

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

21.19. barbican secret order get
Copy link

usage: barbican secret order get [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] URI
Copy to Clipboard Toggle word wrap
Retrieve an order by providing its URI.

Positional arguments

URI
The URI reference order.

Optional arguments

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

21.20. barbican secret order list
Copy link

usage: barbican secret order list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--limit LIMIT] [--offset OFFSET]
Copy to Clipboard Toggle word wrap
List orders.

Optional arguments

-h, --help
show this help message and exit
--limit LIMIT, -l LIMIT
specify the limit to the number of items to list per page (default: 10; maximum: 100)
--offset OFFSET, -o OFFSET
specify the page offset (default: 0)

21.21. barbican secret store
Copy link

usage: barbican secret store [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name NAME] [--payload PAYLOAD] [--secret-type SECRET_TYPE] [--payload-content-type PAYLOAD_CONTENT_TYPE] [--payload-content-encoding PAYLOAD_CONTENT_ENCODING] [--algorithm ALGORITHM] [--bit-length BIT_LENGTH] [--mode MODE] [--expiration EXPIRATION]
Copy to Clipboard Toggle word wrap
Store a secret in Barbican.

Optional arguments

-h, --help
show this help message and exit
--name NAME, -n NAME
a human-friendly name.
--payload PAYLOAD, -p PAYLOAD
the unencrypted secret; if provided, you must also provide a payload_content_type
--secret-type SECRET_TYPE, -s SECRET_TYPE
the secret type; must be one of symmetric, public, private, certificate, passphrase, opaque (default)
--payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE
the type/format of the provided secret data; "text/plain" is assumed to be UTF-8; required when --payload is supplied.
--payload-content-encoding PAYLOAD_CONTENT_ENCODING, -e PAYLOAD_CONTENT_ENCODING
required if --payload-content-type is "application /octet-stream".
--algorithm ALGORITHM, -a ALGORITHM
the algorithm (default: aes).
--bit-length BIT_LENGTH, -b BIT_LENGTH
the bit length (default: 256).
--mode MODE, -m MODE
the algorithm mode; used only for reference (default: cbc)
--expiration EXPIRATION, -x EXPIRATION
the expiration time for the secret in ISO 8601 format.

21.22. barbican secret update
Copy link

usage: barbican secret update [-h] URI payload
Copy to Clipboard Toggle word wrap
Update a secret with no payload in Barbican.

Positional arguments

URI
The URI reference for the secret.
payload
the unencrypted secret

Optional arguments

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

Chapter 22. Benchmarking command-line client
Copy link

The rally client is a command-line interface (CLI) tool that automates and unifies multi-node OpenStack deployment, cloud verification, benchmarking, and profiling. This chapter documents rally version 0.3.3.
For help on a specific rally command, enter: 
$ rally-manage COMMAND --help
Copy to Clipboard Toggle word wrap
Or: 
$ rally COMMAND --help
Copy to Clipboard Toggle word wrap

22.1. rally usage
Copy link

usage: rally [-h] [--config-dir DIR] [--config-file PATH] [--debug] [--log-config-append PATH] [--log-date-format DATE_FORMAT] [--log-dir LOG_DIR] [--log-file PATH] [--nodebug] [--norally-debug] [--nouse-syslog] [--noverbose] [--nowatch-log-file] [--plugin-paths PLUGIN_PATHS] [--rally-debug] [--syslog-log-facility SYSLOG_LOG_FACILITY] [--use-syslog] [--verbose] [--version] [--watch-log-file] {version,bash-completion,show,task,plugin,verify,deployment} ...
Copy to Clipboard Toggle word wrap

22.2. rally optional arguments
Copy link

-h, --help
show this help message and exit
--config-dir DIR
Path to a config directory to pull *.conf files from. This file set is sorted, so as to provide a predictable parse order if individual options are over-ridden. The set is parsed after the file(s) specified via previous --config-file, arguments hence over-ridden options in the directory take precedence.
--config-file PATH
Path to a config file to use. Multiple config files can be specified, with values in later files taking precedence. Defaults to None.
--debug, -d
If set to true, the logging level will be set to DEBUG instead of the default INFO level.
--log-config-append PATH, --log_config PATH
The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, logging_context_format_string).
--log-date-format DATE_FORMAT
Defines the format string for %(asctime)s in log records. Default: None . This option is ignored if log_config_append is set.
--log-dir LOG_DIR, --logdir LOG_DIR
(Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.
--log-file PATH, --logfile PATH
(Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set.
--nodebug
The inverse of --debug
--norally-debug
The inverse of --rally-debug
--nouse-syslog
The inverse of --use-syslog
--noverbose
The inverse of --verbose
--nowatch-log-file
The inverse of --watch-log-file
--plugin-paths PLUGIN_PATHS
Additional custom plugin locations. Multiple files or directories may be specified. All plugins in the specified directories and subdirectories will be imported. Plugins in /opt/rally/plugins and ~/.rally/plugins will always be imported.
--rally-debug
Print debugging output only for Rally. Off-site components stay quiet.
--syslog-log-facility SYSLOG_LOG_FACILITY
Syslog facility to receive log lines. This option is ignored if log_config_append is set.
--use-syslog
Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set.
--verbose, -v
If set to false, the logging level will be set to WARNING instead of the default INFO level.
--version
show program's version number and exit
--watch-log-file
Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set.

22.3. Category: db
Copy link

Commands for DB management.

22.3.1. rally-manage db create
Copy link

Create Rally database.

22.3.2. rally-manage db downgrade
Copy link

Downgrade Rally database.
Command arguments:
--revision <revision>
Downgrade to specified revision UUID. Current revision of DB could be found by calling rally-manage db revision.

22.3.3. rally-manage db recreate
Copy link

Drop and create Rally database.
This will delete all existing data.

22.3.4. rally-manage db revision
Copy link

Print current Rally database revision UUID.

22.3.5. rally-manage db upgrade
Copy link

Upgrade Rally database to the latest state.

22.4. Category: deployment
Copy link

Set of commands that allow you to manage deployments.

22.4.1. rally deployment check
Copy link

Check keystone authentication and list all available services.
Command arguments:
--deployment <uuid>
Note
The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.
Tip
You can set the default value by executing rally deployment use <uuid>.
UUID or name of the deployment.
Type: str

22.4.2. rally deployment config
Copy link

Display configuration of the deployment.
Output is the configuration of the deployment in a pretty-printed JSON format.
Command arguments:
--deployment <uuid>
Note
The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.
Tip
You can set the default value by executing rally deployment use <uuid>.
UUID or name of the deployment.
Type: str

22.4.3. rally deployment create
Copy link

Create new deployment.
This command will create a new deployment record in rally database. In the case of ExistingCloud deployment engine it will use the cloud represented in the configuration. If the cloud doesn't exist, Rally can deploy a new one for you with Devstack or Fuel. Different deployment engines exist for these cases.
If you use the ExistingCloud deployment engine you can pass a deployment config by environment variables with --fromenv:
OS_USERNAME OS_PASSWORD OS_AUTH_URL OS_TENANT_NAME OS_ENDPOINT_TYPE or OS_INTERFACE OS_ENDPOINT OS_REGION_NAME OS_CACERT OS_INSECURE
All other deployment engines need more complex configuration data, so it should be stored in a configuration file.
You can use physical servers, LXC containers, KVM virtual machines or virtual machines in OpenStack for deploying the cloud. Except physical servers, Rally can create cluster nodes for you. Interaction with virtualization software, OpenStack cloud or physical servers is provided by server providers.
Command arguments:
--name <name>
Name of the deployment.
Type: str
--fromenv
Read environment variables instead of config file.
--filename <path>
Path to the configuration file of the deployment.
Type: str
Default: None
--no-use
Don't set new deployment as default for future operations.

22.4.4. rally deployment destroy
Copy link

Destroy existing deployment.
This will delete all containers, virtual machines, OpenStack instances or Fuel clusters created during Rally deployment creation. Also it will remove the deployment record from the Rally database.
Command arguments:
--deployment <uuid>
Note
The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.
Tip
You can set the default value by executing rally deployment use <uuid>.
UUID or name of the deployment.
Type: str

22.4.5. rally deployment list
Copy link

List existing deployments.

22.4.6. rally deployment recreate
Copy link

Destroy and create an existing deployment.
Unlike 'deployment destroy', the deployment database record will not be deleted, so the deployment UUID stays the same.
Command arguments:
--deployment <uuid>
Note
The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.
Tip
You can set the default value by executing rally deployment use <uuid>.
UUID or name of the deployment.
Type: str

22.4.7. rally deployment show
Copy link

Show the credentials of the deployment.
Command arguments:
--deployment <uuid>
Note
The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.
Tip
You can set the default value by executing rally deployment use <uuid>.
UUID or name of the deployment.
Type: str

22.4.8. rally deployment use
Copy link

Set active deployment.
Command arguments:
--deployment <uuid>
UUID or name of a deployment.
Type: str

22.5. Category: plugin
Copy link

Set of commands that allow you to manage Rally plugins.

22.5.1. rally plugin list
Copy link

List all Rally plugins that match name and namespace.
Command arguments:
--name <name>
List only plugins that match the given name.
Type: str
Default: None
--namespace <namespace>
List only plugins that are in the specified namespace.
Type: str
Default: None

22.5.2. rally plugin show
Copy link

Show detailed information about a Rally plugin.
Command arguments:
--name <name>
Plugin name.
Type: str
--namespace <namespace>
Plugin namespace.
Type: str
Default: None

22.6. Category: show
Copy link

Warning
Deprecated since 0.2.0
Show resources.
Set of commands that allow you to view resources, provided by OpenStack cloud represented by deployment.

22.6.1. rally show flavors
Copy link

Display available flavors.
Command arguments:
--deployment <uuid>
Note
The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.
Tip
You can set the default value by executing rally deployment use <uuid>.
UUID or name of a deployment.
Type: str

22.6.2. rally show images
Copy link

Display available images.
Command arguments:
--deployment <uuid>
Note
The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.
Tip
You can set the default value by executing rally deployment use <uuid>.
UUID or name of a deployment.
Type: str

22.6.3. rally show keypairs
Copy link

Display available ssh keypairs.
Command arguments:
--deployment <uuid>
Note
The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.
Tip
You can set the default value by executing rally deployment use <uuid>.
UUID or name of a deployment.
Type: str

22.6.4. rally show networks
Copy link

Display configured networks.
Command arguments:
--deployment <uuid>
Note
The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.
Tip
You can set the default value by executing rally deployment use <uuid>.
UUID or name of a deployment.
Type: str

22.6.5. rally show secgroups
Copy link

Display security groups.
Command arguments:
--deployment <uuid>
Note
The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.
Tip
You can set the default value by executing rally deployment use <uuid>.
UUID or name of a deployment.
Type: str

22.7. Category: task
Copy link

Set of commands that allow you to manage benchmarking tasks and results.

22.7.1. rally task abort
Copy link

Abort a running benchmarking task.
Command arguments:
--uuid <uuid>
UUID of task.
Type: str
--soft
Abort task after current scenario finishes execution.

22.7.2. rally task delete
Copy link

Delete task and its results.
Command arguments:
--force
force delete
--uuid <task-id>
UUID of task or a list of task UUIDs.
Type: str

22.7.3. rally task detailed
Copy link

Print detailed information about given task.
Command arguments:
--uuid <uuid>
UUID of task. If --uuid is "last" the results of the most recently created task will be displayed.
Type: str
--iterations-data
Print detailed results for each iteration.

22.7.4. rally task export
Copy link

Export task results to the custom task's exporting system.
Command arguments:
--uuid <uuid>
UUID of a the task.
Type: str
--connection <connection>
Connection url to the task export system.
Type: str

22.7.5. rally task list
Copy link

List tasks, started and finished.
Displayed tasks can be filtered by status or deployment. By default 'rally task list' will display tasks from the active deployment without filtering by status.
Command arguments:
--deployment <uuid>
Note
The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.
Tip
You can set the default value by executing rally deployment use <uuid>.
UUID or name of a deployment.
Type: str
--all-deployments
List tasks from all deployments.
--status <status>
List tasks with specified status. Available statuses: aborted, aborting, cleaning up, failed, finished, init, paused, running, setting up, soft_aborting, verifying
Type: str
Default: None
--uuids-only
List task UUIDs only.

22.7.6. rally task report
Copy link

Generate report file for specified task.
Command arguments:
--tasks <tasks>
UUIDs of tasks, or JSON files with task results
Default: None
--out <path>
Path to output file.
Type: str
Default: None
--open
Open the output in a browser.
--html
Generate the report in HTML.
--html-static
Generate the report in HTML with embedded JS and CSS, so it will not depend on Internet availability.
--junit
Generate the report in the JUnit format.

22.7.7. rally task results
Copy link

Display raw task results.
This will produce a lot of output data about every iteration.
Command arguments:
--uuid <uuid>
UUID of task.
Type: str

22.7.8. rally task sla_check
Copy link

Display SLA check results table.
Command arguments:
--uuid <uuid>
UUID of task.
Type: str
--json
Output in JSON format.

22.7.9. rally task start
Copy link

Start benchmark task.
If both task_args and task_args_file are specified, they will be merged. task_args has a higher priority so it will override values from task_args_file.
Command arguments:
--deployment <uuid>
Note
The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.
Tip
You can set the default value by executing rally deployment use <uuid>.
UUID or name of a deployment.
Type: str
--task <path>, --filename <path>
Note
The default value for the --task argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally task start, if the --no-use argument was not used.
Tip
You can set the default value by executing rally task use <uuid>.
Path to the input task file
--task-args <json>
Input task args (JSON dict). These args are used to render the Jinja2 template in the input task.
Default: None
--task-args-file <path>
Path to the file with input task args (dict in JSON/YAML). These args are used to render the Jinja2 template in the input task.
Default: None
--tag <tag>
Tag for this task
Default: None
--no-use
Don't set new task as default for future operations.
--abort-on-sla-failure
Abort the execution of a benchmark scenario whenany SLA check for it fails.

22.7.10. rally task status
Copy link

Display the current status of a task.
Command arguments:
--uuid <uuid>
UUID of task
Type: str

22.7.12. rally task use
Copy link

Set active task.
Command arguments:
--uuid <uuid>
UUID of the task
Type: str
--task
[Deprecated since Rally 0.2.0] Use '--uuid' instead.
Type: str

22.7.13. rally task validate
Copy link

Validate a task configuration file.
This will check that task configuration file has valid syntax and all required options of scenarios, contexts, SLA and runners are set.
If both task_args and task_args_file are specified, they will be merged. task_args has a higher priority so it will override values from task_args_file.
Command arguments:
--deployment <uuid>
Note
The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.
Hint
You can set the default value by executing rally deployment use <uuid>.
UUID or name of a deployment.
Type: str
--task <path>, --filename <path>
Note
The default value for the --task argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally task start, if the --no-use argument was not used.
Hint
You can set the default value by executing rally task use <uuid>.
Path to the input task file.
--task-args <json>
Input task args (JSON dict). These args are used to render the Jinja2 template in the input task.
Default: None
--task-args-file <path>
Path to the file with input task args (dict in JSON/YAML). These args are used to render the Jinja2 template in the input task.
Default: None

22.8. Category: verify
Copy link

Verify an OpenStack cloud via Tempest.
Set of commands that allow you to run Tempest tests.

22.8.1. rally verify compare
Copy link

Compare two verification results.
Command arguments:
--uuid-1 <uuid_1>
UUID of the first verification
Type: str
Default: None
--uuid-2 <uuid_2>
UUID of the second verification
Type: str
Default: None
--csv
Display results in CSV format
--html
Display results in HTML format
--json
Display results in JSON format
--output-file <output_file>
Path to a file to save results
Type: str
Default: None
--threshold <threshold>
If specified, timing differences must exceed this percentage threshold to be included in output
Type: int
Default: 0

22.8.2. rally verify detailed
Copy link

Display results table of a verification with detailed errors.
Command arguments:
--uuid <uuid>
Note
The default value for the --uuid argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally verify start, rally verify import_results, if the --no-use argument was not used.
Tip
You can set the default value by executing rally verify use <uuid>.
UUID of a verification.
Type: str
--sort-by <sort_by>
Sort results by 'name' or 'duration'
Default: name

22.8.3. rally verify discover
Copy link

Show a list of discovered tests.
Command arguments:
--deployment <uuid>
Note
The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.
Tip
You can set the default value by executing rally deployment use <uuid>.
UUID or name of a deployment
Type: str
--pattern <pattern>
Test name pattern which can be used to match
Type: str
Default:

22.8.4. rally verify genconfig
Copy link

Generate Tempest configuration file.
Command arguments:
--deployment <uuid>
Note
The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.
Tip
You can set the default value by executing rally deployment use <uuid>.
UUID or name of a deployment.
Type: str
--tempest-config <path>
User-specified Tempest config file location
Type: str
Default: None
--override
Override existing Tempest config file

22.8.5. rally verify import
Copy link

Import Tempest tests results into the Rally database.
Command arguments:
--deployment <uuid>
Note
The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.
Tip
You can set the default value by executing rally deployment use <uuid>.
UUID or name of a deployment.
Type: str
--set <set_name>
Name of a Tempest test set. Available sets are full, scenario, smoke, baremetal, clustering, compute, database, data_processing, identity, image, messaging, network, object_storage, orchestration, telemetry, volume
Type: str
Default:
--file <path>
User specified Tempest log file location. Note, Tempest log file needs to be in subunit format
Type: str
Default: None
--no-use
Don't set new task as default for future operations

22.8.6. rally verify install
Copy link

Install Tempest.
Command arguments:
--deployment <uuid>
Note
The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.
Tip
You can set the default value by executing rally deployment use <uuid>.
UUID or name of a deployment.
Type: str
--source <source>
Path/URL to repo to clone Tempest from
Type: str
Default: None
--version <version>
Commit ID or tag to checkout before Tempest installation
Type: str
Default: None
--system-wide
Don't create a virtual env for Tempest. Note that all Tempest requirements have to be already installed in the local env!

22.8.7. rally verify list
Copy link

List verification runs.

22.8.8. rally verify reinstall
Copy link

Uninstall Tempest and install again.
Command arguments:
--deployment <uuid>
Note
The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.
Tip
You can set the default value by executing rally deployment use <uuid>.
UUID or name of a deployment.
Type: str
--source <source>
Path/URL to repo to clone Tempest from
Type: str
Default: None
--version <version>
Commit ID or tag to checkout before Tempest installation
Type: str
Default: None
--system-wide
Don't create a virtual env for Tempest. Note that all Tempest requirements have to be already installed in the local env!

22.8.9. rally verify results
Copy link

Display results of a verification.
Command arguments:
--uuid <uuid>
Note
The default value for the --uuid argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally verify start, rally verify import_results, if the --no-use argument was not used.
Tip
You can set the default value by executing rally verify use <uuid>.
UUID of a verification.
Type: str
--html
Display results in HTML format.
--json
Display results in JSON format.
--output-file <path>
Path to a file to save results to.
Type: str
Default: None

22.8.10. rally verify show
Copy link

Display results table of a verification.
Command arguments:
--uuid <uuid>
Note
The default value for the --uuid argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally verify start, rally verify import_results, if the --no-use argument was not used.
Tip
You can set the default value by executing rally verify use <uuid>.
UUID of a verification
Type: str
--sort-by <query>
Sort results by 'name' or 'duration'
Type: str
Default: name
--detailed
Display detailed errors of failed tests

22.8.11. rally verify showconfig
Copy link

Show configuration file of Tempest.
Command arguments:
--deployment <uuid>
Note
The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.
Tip
You can set the default value by executing rally deployment use <uuid>.
UUID or name of a deployment.
Type: str

22.8.12. rally verify start
Copy link

Start verification (run Tempest tests).
Command arguments:
--deployment <uuid>
Note
The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.
Tip
You can set the default value by executing rally deployment use <uuid>.
UUID or name of a deployment.
Type: str
--set <set_name>
Name of a Tempest test set. Available sets are full, scenario, smoke, baremetal, clustering, compute, database, data_processing, identity, image, messaging, network, object_storage, orchestration, telemetry, volume
Type: str
Default:
--regex <regex>
Test name regular expression
Type: str
Default: None
--tests-file <path>
Path to a file with a list of Tempest tests
Type: str
Default: None
--tempest-config <path>
User-specified Tempest config file location
Type: str
Default: None
--xfails-file <path>
Path to a YAML file with a list of Tempest tests that are expected to fail
Type: str
Default: None
--no-use
Don't set the task as default for future operations
--system-wide
Don't create a virtual env when installing Tempest; use the local env instead of the Tempest virtual env when running the tests. Note that all Tempest requirements have to be already installed in the local env!
--concurrency N
How many processes to use to run Tempest tests. The default value (0) auto-detects your CPU count
Type: int
Default: 0
--failing
Re-run the tests that failed in the last execution

22.8.13. rally verify uninstall
Copy link

Remove the deployment's local Tempest installation.
Command arguments:
--deployment <uuid>
Note
The default value for the --deployment argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.
Tip
You can set the default value by executing rally deployment use <uuid>.
UUID or name of a deployment.
Type: str

22.8.14. rally verify use
Copy link

Set active verification.
Command arguments:
--uuid <uuid>
UUID of a verification
Type: str
The tempest client is the command-line interface (CLI) for the OpenStack integration test suite. This chapter documents tempest version 0.0.0.
For help on a specific tempest command, enter: 
$ tempest help COMMAND
Copy to Clipboard Toggle word wrap

23.1. tempest usage
Copy link

usage: tempest [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
Copy to Clipboard Toggle word wrap

23.2. tempest optional arguments
Copy link

--version
show program's version number and exit
-v, --verbose
Increase verbosity of output. Can be repeated.
-q, --quiet
Suppress output except warnings and errors.
--log-file LOG_FILE
Specify a file to log output. Disabled by default.
-h, --help
Show help message and exit.
--debug
Show tracebacks on errors.

23.3. tempest account-generator
Copy link

usage: tempest account-generator [-h] [-c /etc/tempest.conf] [--os-username <auth-user-name>] [--os-password <auth-password>] [--os-tenant-name <auth-tenant-name>] [--tag TAG] -r CONCURRENCY [--with-admin] accounts_file.yaml
Copy to Clipboard Toggle word wrap
Create accounts.yaml file for concurrent test runs. One primary user, one alt user, one swift admin, one stack owner and one admin (optionally) will be created for each concurrent thread.

Positional arguments

accounts_file.yaml
Output accounts yaml file

Optional arguments

-h, --help
show this help message and exit
-c /etc/tempest.conf, --config-file /etc/tempest.conf
path to tempest config file
--os-username <auth-user-name>
User should have permissions to create new user accounts and tenants. Defaults to env[OS_USERNAME].
--os-password <auth-password>
Defaults to env[OS_PASSWORD].
--os-tenant-name <auth-tenant-name>
Defaults to env[OS_TENANT_NAME].
--tag TAG
Resources tag
-r CONCURRENCY, --concurrency CONCURRENCY
Concurrency count
--with-admin
Creates admin for each concurrent group

23.4. tempest cleanup
Copy link

usage: tempest cleanup [-h] [--init-saved-state] [--delete-tempest-conf-objects] [--dry-run]
Copy to Clipboard Toggle word wrap
Cleanup after tempest run

Optional arguments

-h, --help
show this help message and exit
--init-saved-state
Creates JSON file: saved_state.json, representing the current state of your deployment, specifically object types tempest creates and destroys during a run. You must run with this flag prior to executing cleanup in normal mode, which is with no arguments.
--delete-tempest-conf-objects
Force deletion of the tempest and alternate tempest users and tenants.
--dry-run
Generate JSON file:dry_run.json, that reports the objects that would have been deleted had a full cleanup been run.

23.5. tempest init
Copy link

usage: tempest init [-h] [--config-dir CONFIG_DIR] [dir]
Copy to Clipboard Toggle word wrap
Setup a local working environment for running tempest

Positional arguments

dir

Optional arguments

-h, --help
show this help message and exit
--config-dir CONFIG_DIR, -c CONFIG_DIR

23.6. tempest list-plugins
Copy link

usage: tempest list-plugins [-h]
Copy to Clipboard Toggle word wrap
List all tempest plugins

Optional arguments

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

23.7. tempest run-stress
Copy link

usage: tempest run-stress [-h] [-d DURATION] [-s] [-S] [-n NUMBER] [-a] [-T TYPE] [-i] [-t [TESTS]]
Copy to Clipboard Toggle word wrap
Run tempest stress tests

Optional arguments

-h, --help
show this help message and exit
-d DURATION, --duration DURATION
Duration of test in secs
-s, --serial
Trigger running tests serially
-S, --stop
Stop on first error
-n NUMBER, --number NUMBER
How often an action is executed for each process
-a, --all
Execute all stress tests
-T TYPE, --type TYPE
Filters tests of a certain type (e.g. gate)
-i, --call-inherited
Call also inherited function with stress attribute
-t [TESTS], --tests [TESTS]
Name of the file with test description

23.8. tempest verify-config
Copy link

usage: tempest verify-config [-h] [-u] [-o OUTPUT] [-r]
Copy to Clipboard Toggle word wrap
Verify your current tempest configuration

Optional arguments

-h, --help
show this help message and exit
-u, --update
Update the config file with results from api queries. This assumes whatever is set in the config file is incorrect. In the case of endpoint checks where it could either be the incorrect catalog type or the service available option the service available option is assumed to be incorrect and is thus changed
-o OUTPUT, --output OUTPUT
Output file to write an updated config file to. This has to be a separate file from the original config file. If one isn't specified with -u the new config file will be printed to STDOUT
-r, --replace-ext
If specified the all option will be replaced with a full list of extensions

Revision History
Copy link

Revision History
Revision 9.0.0-1Wed Jun 28 2016Radek Bíba
Release for Red Hat OpenStack Platform 9.0.

Legal Notice
Copy link

Copyright © 2016 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2026 Red HatBack to top