Red Hat Training

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

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

1.1. Overview

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

Table 1.1. OpenStack services and clients

Service Client Package Description
Block Storage cinder python-cinderclient Create and manage volumes.
Compute nova python-novaclient Create and manage images, instances, and flavors.
Database Service trove python-troveclient Create and manage databases.
Identity keystone python-keystoneclient Create and manage users, tenants, roles, endpoints, and credentials.
Image Service glance python-glanceclient Create and manage images.
Networking neutron python-neutronclient Configure networks for guest servers. This client was previously called quantum.
Object Storage swift python-swiftclient Gather statistics, list items, update metadata, and upload, download, and delete files stored by the Object Storage service. Gain access to an Object Storage installation for ad hoc processing.
Orchestration heat python-heatclient Launch stacks from templates, view details of running stacks including events and resources, and update and delete stacks.
Telemetry ceilometer python-ceilometerclient Create and collect measurements across OpenStack.
An OpenStack common client is in development.
For client installation instructions, see Section 1.2, “Install the OpenStack command-line clients”. For information about the OpenStack RC file, see the Red Hat OpenStack Platform End User Guide.

1.2. Install the OpenStack command-line clients

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

1.2.1. Install the prerequisite software

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

Table 1.2. Prerequisite software

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

1.2.2. Install the clients

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

1.2.2.1. Installing from packages

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

1.2.3. Upgrade or remove clients

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

1.2.4. What's next

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

1.3. Discover the version number for a client

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

1.4. Set environment variables using the OpenStack RC file

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

1.4.1. Download and source the OpenStack RC file

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

1.4.2. Create and source the OpenStack RC file

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

1.4.3. Override environment variable values

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

Chapter 2. Packstack command-line client

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

2.1. packstack usage

Usage: packstack [options] [--help]

2.2. packstack optional arguments

--version
show program's version number and exit
-h, --help
show this help message and exit
--gen-answer-file=GEN_ANSWER_FILE
Generate a template of an answer file.
--answer-file=ANSWER_FILE
Runs the configuration in non-interactive mode, extracting all information from theconfiguration file. using this option excludes all other options
--install-hosts=INSTALL_HOSTS
Install on a set of hosts in a single step. The format should be a comma separated list of hosts, the first is setup as a controller, and the others are setup as compute nodes.if only a single host is supplied then it is setup as an all in one installation. An answerfile will also be generated and should be used if Packstack needs to be run a second time
--allinone
Shorthand for --install-hosts=<local ipaddr> --novanetwork-pubif=<dev> --novacompute-privif=lo --novanetwork-privif=lo --os-swift-install=y --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

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

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

2.5. packstack Server Prepare Configs

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

2.6. packstack RHEL config

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

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

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

2.9. packstack AMQP Config parameters

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

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

2.11. packstack AMQP Config Athentication parameters

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

2.12. packstack Keystone Config parameters

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

2.13. packstack Glance Config parameters

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

2.14. packstack Cinder Config parameters

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

2.15. packstack Cinder volume create Config parameters

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

2.16. packstack Cinder volume size Config parameters

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

2.17. packstack Cinder gluster Config parameters

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

2.18. packstack Cinder NFS Config parameters

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

2.19. packstack Nova Options

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

2.20. packstack Nova Network Options

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

2.21. packstack Nova Network VLAN Options

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

2.22. packstack Neutron config

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

2.23. packstack Neutron LB agent config

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

2.24. packstack Neutron OVS agent config

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

2.25. packstack Neutron OVS agent config for tunnels

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

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

2.27. packstack Manila Config parameters

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

--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 '(.*)'.

2.29. packstack Manila NetApp multi-SVM configuration

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

2.30. packstack Manila NetApp single-SVM configuration

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

2.31. packstack Manila generic driver configuration

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

2.32. packstack Manila general network configuration

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

2.33. packstack Manila standalone network configuration

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

2.34. packstack Manila GlusterFS native configuration

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

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

2.37. packstack OpenStack Horizon Config parameters

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

2.38. packstack SSL Config parameters

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

2.39. packstack OpenStack Swift Config parameters

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

2.40. packstack Heat Config parameters

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

2.41. packstack Provisioning demo config

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

2.42. packstack Provisioning demo config

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

2.43. packstack Provisioning tempest config

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

2.44. packstack Provisioning all-in-one ovs bridge config

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

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

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

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

2.48. packstack Redis Config parameters

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

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

2.50. packstack Trove config parameters

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

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

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

2.53. packstack Puppet Config parameters

2.54. packstack POSTSCRIPT Config parameters

Chapter 3. OpenStack command-line client

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

3.1. openstack usage

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

3.2. openstack optional arguments

--version
show program's version number and exit
-v, --verbose
Increase verbosity of output. Can be repeated.
-q, --quiet
Suppress output except warnings and errors.
--log-file LOG_FILE
Specify a file to log output. Disabled by default.
-h, --help
Show help message and exit.
--debug
Show tracebacks on errors.
--os-cloud <cloud-config-name>
Cloud name in clouds.yaml (Env: OS_CLOUD)
--os-region-name <auth-region-name>
Authentication region name (Env: OS_REGION_NAME)
--os-cacert <ca-bundle-file>
CA certificate bundle file (Env: OS_CACERT)
--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

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

3.3.1. openstack access token create

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

usage: openstack acl delete [-h] URI
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

usage: openstack acl get [-h] [-f {csv,html,json,table,value,yaml}]
                         [-c COLUMN] [--max-width <integer>] [--noindent]
                         [--quote {all,minimal,none,nonnumeric}]
                         URI
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

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

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

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

usage: openstack aggregate add host [-h]
                                    [-f {html,json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--noindent] [--prefix PREFIX]
                                    <aggregate> <host>
Add host to aggregate
Positional arguments:
<aggregate>
Aggregate (name or ID)
<host>
Host to add to <aggregate>
Optional arguments:
-h, --help
show this help message and exit

3.3.8. openstack aggregate create

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

usage: openstack aggregate delete [-h] <aggregate>
Delete an existing aggregate
Positional arguments:
<aggregate>
Aggregate to delete (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.10. openstack aggregate list

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

3.3.11. openstack aggregate remove host

usage: openstack aggregate remove host [-h]
                                       [-f {html,json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--noindent] [--prefix PREFIX]
                                       <aggregate> <host>
Remove host from aggregate
Positional arguments:
<aggregate>
Aggregate (name or ID)
<host>
Host to remove from <aggregate>
Optional arguments:
-h, --help
show this help message and exit

3.3.12. openstack aggregate set

usage: openstack aggregate set [-h] [--name <name>]
                               [--zone <availability-zone>]
                               [--property <key=value>]
                               <aggregate>
Set aggregate properties
Positional arguments:
<aggregate>
Aggregate to modify (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--name <name>
Set aggregate name
--zone <availability-zone>
Set availability zone name
--property <key=value>
Property to set on <aggregate> (repeat option to set multiple properties)

3.3.13. openstack aggregate show

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

3.3.14. openstack availability zone list

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

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

usage: openstack backup delete [-h] <backup> [<backup> ...]
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

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

3.3.18. openstack backup restore

usage: openstack backup restore [-h] [-f {html,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent] [--prefix PREFIX]
                                <backup> <volume>
Restore backup
Positional arguments:
<backup>
Backup to restore (ID only)
<volume>
Volume to restore to (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.19. openstack backup show

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

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

usage: openstack baremetal delete [-h] <node>
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

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

usage: openstack baremetal set [-h] [--property <path=value>] <node>
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

usage: openstack baremetal show [-h] [-f {html,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent] [--prefix PREFIX] [--instance]
                                [--long]
                                <node>
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

usage: openstack baremetal unset [-h] [--property <path>] <node>
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

usage: openstack ca get [-h] [-f {html,json,shell,table,value,yaml}]
                        [-c COLUMN] [--max-width <integer>] [--noindent]
                        [--prefix PREFIX]
                        URI
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

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

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

3.3.29. openstack catalog show

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

3.3.30. openstack command list

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

3.3.31. openstack compute agent create

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

usage: openstack compute agent delete [-h] <id> [<id> ...]
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

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

usage: openstack compute agent set [-h] <id> <version> <url> <md5hash>
Set compute agent command
Positional arguments:
<id>
ID of the agent
<version>
Version of the agent
<url>
URL
<md5hash>
MD5 hash
Optional arguments:
-h, --help
show this help message and exit

3.3.35. openstack compute service delete

usage: openstack compute service delete [-h] <service>
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

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

usage: openstack compute service set [-h] [--enable | --disable]
                                     [--disable-reason <reason>]
                                     <host> <service>
Set service command
Positional arguments:
<host>
Name of host
<service>
Name of service
Optional arguments:
-h, --help
show this help message and exit
--enable
Enable 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

usage: openstack configuration show [-h]
                                    [-f {html,json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--noindent] [--prefix PREFIX]
                                    [--mask | --unmask]
Display configuration details
Optional arguments:
-h, --help
show this help message and exit
--mask
Attempt to mask passwords (default)
--unmask
Show password in clear text

3.3.39. openstack console log show

usage: openstack console log show [-h] [--lines <num-lines>] <server>
Show server's console output
Positional arguments:
<server>
Server to show console log (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--lines <num-lines>
Number of lines to display from the end of the log (default=all)

3.3.40. openstack console url show

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

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

3.3.42. openstack consumer delete

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

3.3.43. openstack consumer list

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

3.3.44. openstack consumer set

usage: openstack consumer set [-h] [--description <description>] <consumer>
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

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

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

usage: openstack container delete [-h] [--recursive]
                                  <container> [<container> ...]
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

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

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

3.3.50. openstack container set

usage: openstack container set [-h] --property <key=value> <container>
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

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

3.3.52. openstack container unset

usage: openstack container unset [-h] --property <key> <container>
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

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

usage: openstack credential delete [-h] <credential-id>
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

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

3.3.56. openstack credential set

usage: openstack credential set [-h] --user <user> --type <type> --data <data>
                                [--project <project>]
                                <credential-id>
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

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

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

usage: openstack dataprocessing cluster delete [-h] [--wait]
                                               <cluster> [<cluster> ...]
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

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

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

usage: openstack dataprocessing cluster show [-h]
                                             [-f {html,json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--noindent] [--prefix PREFIX]
                                             [--verification]
                                             <cluster>
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

3.3.63. openstack dataprocessing cluster template create

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

3.3.64. openstack dataprocessing cluster template delete

usage: openstack dataprocessing cluster template delete [-h]
                                                        <cluster-template>
                                                        [<cluster-template> ...]
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

3.3.65. openstack dataprocessing cluster template list

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

3.3.66. openstack dataprocessing cluster template show

usage: openstack dataprocessing cluster template show [-h]
                                                      [-f {html,json,shell,table,value,yaml}]
                                                      [-c COLUMN]
                                                      [--max-width <integer>]
                                                      [--noindent]
                                                      [--prefix PREFIX]
                                                      <cluster-template>
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

3.3.67. openstack dataprocessing cluster template update

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

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

3.3.69. openstack dataprocessing cluster verification

usage: openstack dataprocessing cluster verification [-h]
                                                     [-f {html,json,shell,table,value,yaml}]
                                                     [-c COLUMN]
                                                     [--max-width <integer>]
                                                     [--noindent]
                                                     [--prefix PREFIX]
                                                     (--start | --show)
                                                     <cluster>
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

3.3.70. openstack dataprocessing data source create

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

3.3.71. openstack dataprocessing data source delete

usage: openstack dataprocessing data source delete [-h]
                                                   <data-source>
                                                   [<data-source> ...]
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

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

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

3.3.74. openstack dataprocessing data source update

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

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

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

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

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

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

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

usage: openstack dataprocessing image unregister [-h] <image> [<image> ...]
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

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

usage: openstack dataprocessing job binary delete [-h]
                                                  <job-binary>
                                                  [<job-binary> ...]
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

3.3.84. openstack dataprocessing job binary download

usage: openstack dataprocessing job binary download [-h] [--file <file>]
                                                    <job-binary>
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

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

usage: openstack dataprocessing job binary show [-h]
                                                [-f {html,json,shell,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--noindent] [--prefix PREFIX]
                                                <job-binary>
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

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

usage: openstack dataprocessing job delete [-h] [--wait] <job> [<job> ...]
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

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

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

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

3.3.92. openstack dataprocessing job template create

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

3.3.93. openstack dataprocessing job template delete

usage: openstack dataprocessing job template delete [-h]
                                                    <job-template>
                                                    [<job-template> ...]
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

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

usage: openstack dataprocessing job template show [-h]
                                                  [-f {html,json,shell,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--noindent]
                                                  [--prefix PREFIX]
                                                  <job-template>
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

3.3.96. openstack dataprocessing job template update

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

3.3.97. openstack dataprocessing job type configs get

usage: openstack dataprocessing job type configs get [-h] [--file <file>]
                                                     <job-type>
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

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

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

3.3.100. openstack dataprocessing node group template create

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

3.3.101. openstack dataprocessing node group template delete

usage: openstack dataprocessing node group template delete [-h]
                                                           <node-group-template>
                                                           [<node-group-template> ...]
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

3.3.102. openstack dataprocessing node group template list

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

3.3.103. openstack dataprocessing node group template show

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

3.3.104. openstack dataprocessing node group template update

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

3.3.105. openstack dataprocessing plugin configs get

usage: openstack dataprocessing plugin configs get [-h] [--file <file>]
                                                   <plugin> <plugin_version>
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

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

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

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

usage: openstack domain delete [-h] <domain>
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

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

3.3.111. openstack domain set

usage: openstack domain set [-h] [--name <name>] [--description <description>]
                            [--enable | --disable]
                            <domain>
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

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

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

usage: openstack ec2 credentials delete [-h] [--user <user>]
                                        [--user-domain <user-domain>]
                                        <access-key>
Delete EC2 credentials
Positional arguments:
<access-key>
Credentials access key
Optional arguments:
-h, --help
show this help message and exit
--user <user>
Delete credentials for user (name or ID)
--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

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

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

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

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

3.3.119. openstack endpoint list

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

usage: openstack endpoint set [-h] [--region <region-id>]
                              [--interface <interface>] [--url <url>]
                              [--service <service>] [--enable | --disable]
                              <endpoint-id>
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

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

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

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

3.3.124. openstack federation project list

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

3.3.125. openstack federation protocol create

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

usage: openstack federation protocol delete [-h] --identity-provider
                                            <identity-provider>
                                            <federation-protocol>
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

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

usage: openstack federation protocol set [-h] --identity-provider
                                         <identity-provider>
                                         [--mapping <mapping>]
                                         <name>
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

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

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

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

3.3.132. openstack flavor list

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

usage: openstack flavor set [-h] [--property <key=value>]
                            [--project <project>]
                            [--project-domain <project-domain>]
                            <flavor>
Set flavor properties
Positional arguments:
<flavor>
Flavor to modify (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--property <key=value>
Property to add or modify for this flavor (repeat option to set multiple properties)
--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

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

3.3.135. openstack flavor unset

usage: openstack flavor unset [-h] [--property <key>] [--project <project>]
                              [--project-domain <project-domain>]
                              <flavor>
Unset flavor properties
Positional arguments:
<flavor>
Flavor to modify (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--property <key>
Property to remove from flavor (repeat option to unset multiple properties)
--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

usage: openstack group add user [-h] [--group-domain <group-domain>]
                                [--user-domain <user-domain>]
                                <group> <user>
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

usage: openstack group contains user [-h] [--group-domain <group-domain>]
                                     [--user-domain <user-domain>]
                                     <group> <user>
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

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

usage: openstack group delete [-h] [--domain <domain>] <group> [<group> ...]
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

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

usage: openstack group remove user [-h] [--group-domain <group-domain>]
                                   [--user-domain <user-domain>]
                                   <group> <user>
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

usage: openstack group set [-h] [--domain <domain>] [--name <name>]
                           [--description <description>]
                           <group>
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

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

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

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

3.3.146. openstack hypervisor list

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

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

3.3.148. openstack hypervisor stats show

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

3.3.149. openstack identity provider create

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

usage: openstack identity provider delete [-h] <identity-provider>
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

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

3.3.152. openstack identity provider set

usage: openstack identity provider set [-h] [--description <description>]
                                       [--remote-id <remote-id> | --remote-id-file <file-name>]
                                       [--enable | --disable]
                                       <identity-provider>
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

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

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

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

usage: openstack image delete [-h] <image> [<image> ...]
Delete image(s)
Positional arguments:
<image>
Image(s) to delete (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.157. openstack image list

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

usage: openstack image remove project [-h] [--project-domain <project-domain>]
                                      <image> <project>
Disassociate project with image
Positional arguments:
<image>
Image to unshare (name or ID)
<project>
Project to disassociate with image (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--project-domain <project-domain>
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.

3.3.159. openstack image save

usage: openstack image save [-h] [--file <filename>] <image>
Save an image locally
Positional arguments:
<image>
Image to save (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--file <filename>
Downloaded image save filename (default: stdout)

3.3.160. openstack image set

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

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

3.3.162. openstack ip fixed add

usage: openstack ip fixed add [-h] <network> <server>
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

usage: openstack ip fixed remove [-h] <ip-address> <server>
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

usage: openstack ip floating add [-h] <ip-address> <server>
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

usage: openstack ip floating create [-h]
                                    [-f {html,json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--noindent] [--prefix PREFIX]
                                    <network>
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

usage: openstack ip floating delete [-h] <floating-ip>
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

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

3.3.168. openstack ip floating pool list

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}]
List pools of floating IP addresses
Optional arguments:
-h, --help
show this help message and exit

3.3.169. openstack ip floating remove

usage: openstack ip floating remove [-h] <ip-address> <server>
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

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

usage: openstack keypair create [-h] [-f {html,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent] [--prefix PREFIX]
                                [--public-key <file>]
                                <name>
Create new public key
Positional arguments:
<name>
New public key name
Optional arguments:
-h, --help
show this help message and exit
--public-key <file>
Filename for public key to add

3.3.172. openstack keypair delete

usage: openstack keypair delete [-h] <key>
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

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

3.3.174. openstack keypair show

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

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

usage: openstack mapping create [-h] [-f {html,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent] [--prefix PREFIX] --rules
                                <filename>
                                <name>
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

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

3.3.178. openstack mapping list

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

3.3.179. openstack mapping set

usage: openstack mapping set [-h] [--rules <filename>] <name>
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

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

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

3.3.182. openstack network create

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

usage: openstack network delete [-h] <network> [<network> ...]
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

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

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

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

3.3.187. openstack object create

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

usage: openstack object delete [-h] <container> <object> [<object> ...]
Delete object from container
Positional arguments:
<container>
Delete object(s) from <container>
<object>
Object(s) to delete
Optional arguments:
-h, --help
show this help message and exit

3.3.189. openstack object list

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

usage: openstack object save [-h] [--file <filename>] <container> <object>
Save object locally
Positional arguments:
<container>
Download <object> from <container>
<object>
Object to save
Optional arguments:
-h, --help
show this help message and exit
--file <filename>
Destination filename (defaults to object name)

3.3.191. openstack object set

usage: openstack object set [-h] --property <key=value> <container> <object>
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

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

3.3.193. openstack object store account set

usage: openstack object store account set [-h] --property <key=value>
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

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

3.3.195. openstack object store account unset

usage: openstack object store account unset [-h] --property <key>
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

usage: openstack object unset [-h] --property <key> <container> <object>
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

usage: openstack orchestration build info [-h]
                                          [-f {html,json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent] [--prefix PREFIX]
Retrieve build information.
Optional arguments:
-h, --help
show this help message and exit

3.3.198. openstack orchestration resource type list

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

3.3.199. openstack orchestration resource type show

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

usage: openstack orchestration service list [-h]
                                            [-f {csv,html,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--noindent]
                                            [--quote {all,minimal,none,nonnumeric}]
List the Heat engines.
Optional arguments:
-h, --help
show this help message and exit

3.3.201. openstack orchestration template function list

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

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

3.3.203. openstack orchestration template version list

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}]
List the available template versions.
Optional arguments:
-h, --help
show this help message and exit

3.3.204. openstack policy create

usage: openstack policy create [-h] [-f {html,json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent] [--prefix PREFIX] [--type <type>]
                               <filename>
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

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

3.3.206. openstack policy list

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

3.3.207. openstack policy set

usage: openstack policy set [-h] [--type <type>] [--rules <filename>] <policy>
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

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

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

usage: openstack pool delete [-h] <pool_name>
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

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

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

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

usage: openstack port delete [-h] <port> [<port> ...]
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

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

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

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

3.3.218. openstack project list

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

usage: openstack project set [-h] [--name <name>] [--domain <domain>]
                             [--description <description>]
                             [--enable | --disable] [--property <key=value>]
                             <project>
Set project properties
Positional arguments:
<project>
Project to modify (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--name <name>
Set project name
--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

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

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

3.3.222. openstack ptr record set

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

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

3.3.224. openstack ptr record unset

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

3.3.225. openstack quota set

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

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

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

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

3.3.229. openstack recordset list

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

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

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

3.3.232. openstack region create

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

usage: openstack region delete [-h] <region-id>
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

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

usage: openstack region set [-h] [--parent-region <region-id>]
                            [--description <description>]
                            <region-id>
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

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

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

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

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

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

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

usage: openstack role delete [-h] <role> [<role> ...]
Delete role(s)
Positional arguments:
<role>
Role(s) to delete (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.243. openstack role list

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

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

usage: openstack role set [-h] [--name <name>] <role>
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

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

3.3.247. openstack router create

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

usage: openstack router delete [-h] <router> [<router> ...]
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

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

3.3.250. openstack router set

usage: openstack router set [-h] [--name <name>] [--enable | --disable]
                            [--distributed | --centralized]
                            [--route destination=<subnet>,gateway=<ip-address> | --no-route]
                            <router>
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

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

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

usage: openstack secret container delete [-h] URI
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

usage: openstack secret container get [-h]
                                      [-f {html,json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--noindent] [--prefix PREFIX]
                                      URI
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

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

usage: openstack secret delete [-h] URI
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

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

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

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

usage: openstack secret order delete [-h] URI
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

usage: openstack secret order get [-h] [-f {html,json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent] [--prefix PREFIX]
                                  URI
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

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

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

usage: openstack secret update [-h] URI payload
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

usage: openstack security group create [-h]
                                       [-f {html,json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--noindent] [--prefix PREFIX]
                                       [--description <description>]
                                       <name>
Create a new security group
Positional arguments:
<name>
New security group name
Optional arguments:
-h, --help
show this help message and exit
--description <description>
Security group description

3.3.266. openstack security group delete

usage: openstack security group delete [-h] <group>
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

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

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

usage: openstack security group rule delete [-h] <rule>
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

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

usage: openstack security group rule show [-h]
                                          [-f {html,json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent] [--prefix PREFIX]
                                          <rule>
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

usage: openstack security group set [-h] [--name <new-name>]
                                    [--description <description>]
                                    <group>
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

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

usage: openstack server add security group [-h] <server> <group>
Add security group to server
Positional arguments:
<server>
Server (name or ID)
<group>
Security group to add (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.275. openstack server add volume

usage: openstack server add volume [-h] [--device <device>] <server> <volume>
Add volume to server
Positional arguments:
<server>
Server (name or ID)
<volume>
Volume to add (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--device <device>
Server internal device name for volume

3.3.276. openstack server create

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

usage: openstack server delete [-h] [--wait] <server> [<server> ...]
Delete server(s)
Positional arguments:
<server>
Server(s) to delete (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--wait
Wait for delete to complete

3.3.278. openstack server dump create

usage: openstack server dump create [-h] <server> [<server> ...]
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

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

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

usage: openstack server lock [-h] <server> [<server> ...]
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

usage: openstack server migrate [-h] [--live <hostname>]
                                [--shared-migration | --block-migration]
                                [--disk-overcommit | --no-disk-overcommit]
                                [--wait]
                                <server>
Migrate server to different host
Positional arguments:
<server>
Server (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--live <hostname>
Target hostname
--shared-migration
Perform a shared live migration (default)
--block-migration
Perform a block live migration
--disk-overcommit
Allow disk over-commit on the destination host
--no-disk-overcommit
Do not over-commit disk on the destination host (default)
--wait
Wait for resize to complete

3.3.283. openstack server pause

usage: openstack server pause [-h] <server> [<server> ...]
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

usage: openstack server reboot [-h] [--hard | --soft] [--wait] <server>
Perform a hard or soft server reboot
Positional arguments:
<server>
Server (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--hard
Perform a hard reboot
--soft
Perform a soft reboot
--wait
Wait for reboot to complete

3.3.285. openstack server rebuild

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

usage: openstack server remove security group [-h] <server> <group>
Remove security group from server
Positional arguments:
<server>
Name or ID of server to use
<group>
Name or ID of security group to remove from server
Optional arguments:
-h, --help
show this help message and exit

3.3.287. openstack server remove volume

usage: openstack server remove volume [-h] <server> <volume>
Remove volume from server
Positional arguments:
<server>
Server (name or ID)
<volume>
Volume to remove (name or ID)
Optional arguments:
-h, --help
show this help message and exit

3.3.288. openstack server rescue

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

3.3.289. openstack server resize

usage: openstack server resize [-h] [--flavor <flavor> | --confirm | --revert]
                               [--wait]
                               <server>
Scale server to a new flavor
Positional arguments:
<server>
Server (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--flavor <flavor>
Resize server to specified flavor
--confirm
Confirm server resize is complete
--revert
Restore server state before resize
--wait
Wait for resize to complete

3.3.290. openstack server resume

usage: openstack server resume [-h] <server> [<server> ...]
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

usage: openstack server set [-h] [--name <new-name>] [--root-password]
                            [--property <key=value>] [--state <state>]
                            <server>
Set server properties
Positional arguments:
<server>
Server (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--name <new-name>
New server name
--root-password
Set new root password (interactive only)
--property <key=value>
Property to add/change for this server (repeat option to set multiple properties)
--state <state>
New server state (valid value: active, error)

3.3.292. openstack server shelve

usage: openstack server shelve [-h] <server> [<server> ...]
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

usage: openstack server show [-h] [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX] [--diagnostics]
                             <server>
Show server details
Positional arguments:
<server>
Server (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--diagnostics
Display server diagnostics information

3.3.294. openstack server ssh

usage: openstack server ssh [-h] [--login <login-name>] [--port <port>]
                            [--identity <keyfile>] [--option <config-options>]
                            [-4 | -6]
                            [--public | --private | --address-type <address-type>]
                            <server>
SSH to server
Positional arguments:
<server>
Server (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--login <login-name>
Login name (ssh -l option)
--port <port>
Destination port (ssh -p option)
--identity <keyfile>
Private key file (ssh -i option)
--option <config-options>
Options in ssh_config(5) format (ssh -o option)
-4
Use only IPv4 addresses
-6
Use only IPv6 addresses
--public
Use public IP address
--private
Use private IP address
--address-type <address-type>
Use other IP address (public, private, etc)

3.3.295. openstack server start

usage: openstack server start [-h] <server> [<server> ...]
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

usage: openstack server stop [-h] <server> [<server> ...]
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

usage: openstack server suspend [-h] <server> [<server> ...]
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

usage: openstack server unlock [-h] <server> [<server> ...]
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

usage: openstack server unpause [-h] <server> [<server> ...]
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

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

3.3.301. openstack server unset

usage: openstack server unset [-h] [--property <key>] <server>
Unset server properties
Positional arguments:
<server>
Server (name or ID)
Optional arguments:
-h, --help
show this help message and exit
--property <key>
Property key to remove from server (repeat option to remove multiple values)

3.3.302. openstack server unshelve

usage: openstack server unshelve [-h] <server> [<server> ...]
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

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

usage: openstack service delete [-h] <service>
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

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

3.3.306. openstack service provider create

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

usage: openstack service provider delete [-h] <service-provider>
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

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

3.3.309. openstack service provider set

usage: openstack service provider set [-h] [--auth-url <auth-url>]
                                      [--description <description>]
                                      [--service-provider-url <sp-url>]
                                      [--enable | --disable]
                                      <service-provider>
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

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

usage: openstack service set [-h] [--type <type>] [--name <service-name>]
                             [--description <description>]
                             [--enable | --disable]
                             <service>
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

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

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

usage: openstack snapshot delete [-h] <snapshot> [<snapshot> ...]
Delete volume snapshot(s)
Positional arguments:
<snapshot>
Snapshot(s) to delete (name or ID)