273 KiB
OpenStack command-line client
The openstack client is a common OpenStackcommand-line interface (CLI).
This chapter documents openstack version 2.0.0.
For help on a specific openstack command, enter:
$ openstack help COMMANDopenstack usage
usage: openstack [--version] [-v] [--log-file LOG_FILE] [-q] [-h] [--debug]
[--os-cloud <cloud-config-name>]
[--os-region-name <auth-region-name>]
[--os-cacert <ca-bundle-file>] [--verify | --insecure]
[--os-default-domain <auth-domain>]
[--os-interface <interface>] [--timing]
[--os-compute-api-version <compute-api-version>]
[--os-network-api-version <network-api-version>]
[--os-image-api-version <image-api-version>]
[--os-volume-api-version <volume-api-version>]
[--os-identity-api-version <identity-api-version>]
[--os-auth-type <auth-type>]
[--os-project-domain-id <auth-project-domain-id>]
[--os-protocol <auth-protocol>]
[--os-project-name <auth-project-name>]
[--os-trust-id <auth-trust-id>]
[--os-service-provider-endpoint <auth-service-provider-endpoint>]
[--os-domain-name <auth-domain-name>]
[--os-user-domain-id <auth-user-domain-id>]
[--os-identity-provider-url <auth-identity-provider-url>]
[--os-access-token-endpoint <auth-access-token-endpoint>]
[--os-domain-id <auth-domain-id>]
[--os-user-domain-name <auth-user-domain-name>]
[--os-scope <auth-scope>] [--os-user-id <auth-user-id>]
[--os-identity-provider <auth-identity-provider>]
[--os-username <auth-username>]
[--os-auth-url <auth-auth-url>]
[--os-client-secret <auth-client-secret>]
[--os-client-id <auth-client-id>]
[--os-project-domain-name <auth-project-domain-name>]
[--os-password <auth-password>]
[--os-endpoint <auth-endpoint>] [--os-url <auth-url>]
[--os-token <auth-token>] [--os-project-id <auth-project-id>]
[--os-object-api-version <object-api-version>]
[--os-queues-api-version <queues-api-version>]
[--os-policy-api-version <policy-api-version>]
[--os-dns-api-version <dns-api-version>]
[--os-mb-api-version <mb-api-version>]
[--os-baremetal-api-version <baremetal-api-version>]
[--os-management-api-version <management-api-version>]
[--os-data-processing-api-version <data-processing-api-version>]
[--inspector-api-version INSPECTOR_API_VERSION]
[--inspector-url INSPECTOR_URL]openstack optional arguments
--version-
show program's version number and exit
-v, --verbose-
Increase verbosity of output. Can be repeated.
--log-file LOG_FILE-
Specify a file to log output. Disabled by default.
-q, --quiet-
Suppress output except warnings and errors.
-h, --help-
Show help message and exit.
--debug-
Show tracebacks on errors.
--os-cloud <cloud-config-name>-
Cloud name in clouds.yaml (Env: OS_CLOUD)
--os-region-name <auth-region-name>-
Authentication region name (Env: OS_REGION_NAME)
--os-cacert <ca-bundle-file>-
CA certificate bundle file (Env: OS_CACERT)
--verify-
Verify server certificate (default)
--insecure-
Disable server certificate verification
--os-default-domain <auth-domain>-
Default domain ID, default=default (Env: OS_DEFAULT_DOMAIN)
--os-interface <interface>-
Select an interface type. Valid interface types: [admin, public, internal]. (Env: OS_INTERFACE)
--timing-
Print API call timing info
--os-compute-api-version <compute-api-version>-
Compute API version, default=2 (Env: OS_COMPUTE_API_VERSION)
--os-network-api-version <network-api-version>-
Network API version, default=2.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: osc_password, token_endpoint, v2token, admin_token, v2password, v3password, v3scopedsaml, v3oidcpassword, v3unscopedadfs, token, v3token, password, v3unscopedsaml. Default: selected based on
--os-username/--os-token(Env: OS_AUTH_TYPE) --os-project-domain-id <auth-project-domain-id>-
With osc_password: Domain ID containing project 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 (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 osc_password: Project name to scope to 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 (Env: OS_PROJECT_NAME)
--os-trust-id <auth-trust-id>-
With osc_password: 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 (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 osc_password: Domain name to scope to 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 (Env: OS_DOMAIN_NAME)
--os-user-domain-id <auth-user-domain-id>-
With osc_password: User's domain id With v3password: User's domain id With 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 osc_password: Domain ID to scope to 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 (Env: OS_DOMAIN_ID)
--os-user-domain-name <auth-user-domain-name>-
With osc_password: User's domain name With v3password: User's domain name With 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 osc_password: User id With v2password: User ID to login with With v3password: User ID With 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 osc_password: Username With v2password: Username to login with With v3password: Username With v3oidcpassword: Username With v3unscopedadfs: Username With password: Username With v3unscopedsaml: Username (Env: OS_USERNAME)
--os-auth-url <auth-auth-url>-
With osc_password: Authentication 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 (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 osc_password: Domain name containing project 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 (Env: OS_PROJECT_DOMAIN_NAME)
--os-password <auth-password>-
With osc_password: User's 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 (Env: OS_PASSWORD)
--os-endpoint <auth-endpoint>-
With token_endpoint: The endpoint that will always be used With admin_token: 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 token_endpoint: The token that will always be used With token_endpoint: Authentication token to use 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 (Env: OS_TOKEN)
--os-project-id <auth-project-id>-
With osc_password: Project ID to scope to 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 (Env: OS_PROJECT_ID)
--os-object-api-version <object-api-version>-
Object API version, default=1 (Env: OS_OBJECT_API_VERSION)
--os-queues-api-version <queues-api-version>-
Queues API version, default=1.1 (Env: OS_QUEUES_API_VERSION)
--os-policy-api-version <policy-api-version>-
Policy API version, default=1 (Env: OS_POLICY_API_VERSION)
--os-dns-api-version <dns-api-version>-
DNS API version, default=2 (Env: OS_DNS_API_VERSION)
--os-mb-api-version <mb-api-version>-
MB API version, default=1 (Env: OS_MB_API_VERSION)
--os-baremetal-api-version <baremetal-api-version>-
Baremetal API version, default=1.6 (Env: OS_BAREMETAL_API_VERSION)
--os-management-api-version <management-api-version>-
Management API version, default=2 (Env: OS_MANAGEMENT_API_VERSION)
--os-data-processing-api-version <data-processing-api-version>-
Data processing API version, default=1.1 (Env: OS_DATA_PROCESSING_API_VERSION)
--inspector-api-version INSPECTOR_API_VERSION-
inspector API version, only 1 is supported now (env: INSPECTOR_VERSION).
--inspector-url INSPECTOR_URL-
inspector URL, defaults to localhost (env: INSPECTOR_URL).
OpenStack with Identity API v2 commands
openstack aggregate add host
usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate add host [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<aggregate> <host>Add host to aggregate
Positional arguments
<aggregate>-
Aggregate (name or ID)
<host>-
Host to add to <aggregate>
Optional arguments
-h, --help-
show this help message and exit
openstack aggregate create
usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--zone <availability-zone>]
[--property <key=value>]
<name>Create a new aggregate
Positional arguments
<name>-
New aggregate name
Optional arguments
-h, --help-
show this help message and exit
--zone <availability-zone>-
Availability zone name
--property <key=value>-
Property to add to this aggregate (repeat option to set multiple properties)
openstack aggregate delete
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack aggregate list
usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long]List all aggregates
Optional arguments
-h, --help-
show this help message and exit
--long-
List additional fields in output
openstack aggregate remove host
usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate remove host [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<aggregate> <host>Remove host from aggregate
Positional arguments
<aggregate>-
Aggregate (name or ID)
<host>-
Host to remove from <aggregate>
Optional arguments
-h, --help-
show this help message and exit
openstack aggregate set
usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate set [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] [--name <name>]
[--zone <availability-zone>]
[--property <key=value>]
<aggregate>Set aggregate properties
Positional arguments
<aggregate>-
Aggregate to modify (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--name <name>-
Set aggregate name
--zone <availability-zone>-
Set availability zone name
--property <key=value>-
Property to set on <aggregate> (repeat option to set multiple properties)
openstack aggregate show
usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<aggregate>Display aggregate details
Positional arguments
<aggregate>-
Aggregate to display (name or ID)
Optional arguments
-h, --help-
show this help message and exit
openstack availability zone list
usage: openstack --os-auth-type token --os-identity-api-version 2 availability zone list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long]List availability zones and their status
Optional arguments
-h, --help-
show this help message and exit
--long-
List additional fields in output
openstack backup create
usage: openstack --os-auth-type token --os-identity-api-version 2 backup create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--container <container>] [--name <name>]
[--description <description>]
<volume>Create new backup
Positional arguments
<volume>-
Volume to backup (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--container <container>-
Optional backup container name
--name <name>-
Name of the backup
--description <description>-
Description of the backup
openstack backup delete
usage: openstack --os-auth-type token --os-identity-api-version 2 backup delete [-h] <backup> [<backup> ...]Delete backup(s)
Positional arguments
<backup>-
Backup(s) to delete (ID only)
Optional arguments
-h, --help-
show this help message and exit
openstack backup list
usage: openstack --os-auth-type token --os-identity-api-version 2 backup list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--long]List backups
Optional arguments
-h, --help-
show this help message and exit
--long-
List additional fields in output
openstack backup restore
usage: openstack --os-auth-type token --os-identity-api-version 2 backup restore [-h] <backup> <volume>Restore backup
Positional arguments
<backup>-
Backup to restore (ID only)
<volume>-
Volume to restore to (name or ID)
Optional arguments
-h, --help-
show this help message and exit
openstack backup show
usage: openstack --os-auth-type token --os-identity-api-version 2 backup show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<backup>Display backup details
Positional arguments
<backup>-
Backup to display (ID only)
Optional arguments
-h, --help-
show this help message and exit
openstack baremetal create
usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal create [-h]
[-f {html,json,json,shell,table,value,yaml,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.
openstack baremetal delete
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack baremetal introspection rule delete
usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal introspection rule delete [-h] uuidDelete an introspection rule.
Positional arguments
uuid-
rule UUID
Optional arguments
-h, --help-
show this help message and exit
openstack baremetal introspection rule import
usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal introspection rule import [-h] fileImport one or several introspection rules from a json file.
Positional arguments
file-
JSON file to import, may contain one or several rules
Optional arguments
-h, --help-
show this help message and exit
openstack baremetal introspection rule list
usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal introspection rule list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]List all introspection rules.
Optional arguments
-h, --help-
show this help message and exit
openstack baremetal introspection rule purge
usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal introspection rule purge [-h]Drop all introspection rules.
Optional arguments
-h, --help-
show this help message and exit
openstack baremetal introspection rule show
usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal introspection rule show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
uuidShow an introspection rule.
Positional arguments
uuid-
rule UUID
Optional arguments
-h, --help-
show this help message and exit
openstack baremetal introspection start
usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal introspection start [-h]
[--new-ipmi-username NEW_IPMI_USERNAME]
[--new-ipmi-password NEW_IPMI_PASSWORD]
uuid [uuid ...]Start the introspection.
Positional arguments
uuid-
baremetal node UUID(s)
Optional arguments
-h, --help-
show this help message and exit
--new-ipmi-username NEW_IPMI_USERNAME-
if set, *Ironic Inspector* will update IPMI user name to this value
--new-ipmi-password NEW_IPMI_PASSWORD-
if set, *Ironic Inspector* will update IPMI password to this value
openstack baremetal introspection status
usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal introspection status [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
uuidGet introspection status.
Positional arguments
uuid-
baremetal node UUID
Optional arguments
-h, --help-
show this help message and exit
openstack baremetal list
usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal list [-h]
[-f {csv,html,json,json,table,value,yaml,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.
openstack baremetal set
usage: openstack --os-auth-type token --os-identity-api-version 2 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)
openstack baremetal show
usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal show [-h]
[-f {html,json,json,shell,table,value,yaml,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
--instanceis specified)
Optional arguments
-h, --help-
show this help message and exit
--instance <node>-
is an instance UUID.
--long
openstack baremetal unset
usage: openstack --os-auth-type token --os-identity-api-version 2 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)
openstack catalog list
usage: openstack --os-auth-type token --os-identity-api-version 2 catalog list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]List services in the service catalog
Optional arguments
-h, --help-
show this help message and exit
openstack catalog show
usage: openstack --os-auth-type token --os-identity-api-version 2 catalog show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<service>Display service catalog details
Positional arguments
<service>-
Service to display (type or name)
Optional arguments
-h, --help-
show this help message and exit
openstack command list
usage: openstack --os-auth-type token --os-identity-api-version 2 command list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]List recognized commands by group
Optional arguments
-h, --help-
show this help message and exit
openstack compute agent create
usage: openstack --os-auth-type token --os-identity-api-version 2 compute agent create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<os> <architecture> <version> <url>
<md5hash> <hypervisor>Create compute agent command
Positional arguments
<os>-
Type of OS
<architecture>-
Type of architecture
<version>-
Version
<url>-
URL
<md5hash>-
MD5 hash
<hypervisor>-
Type of hypervisor
Optional arguments
-h, --help-
show this help message and exit
openstack compute agent delete
usage: openstack --os-auth-type token --os-identity-api-version 2 compute agent delete [-h] <id>Delete compute agent command
Positional arguments
<id>-
ID of agent to delete
Optional arguments
-h, --help-
show this help message and exit
openstack compute agent list
usage: openstack --os-auth-type token --os-identity-api-version 2 compute agent list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--hypervisor <hypervisor>]List compute agent command
Optional arguments
-h, --help-
show this help message and exit
--hypervisor <hypervisor>-
Type of hypervisor
openstack compute agent set
usage: openstack --os-auth-type token --os-identity-api-version 2 compute agent set [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<id> <version> <url> <md5hash>Set compute agent command
Positional arguments
<id>-
ID of the agent
<version>-
Version of the agent
<url>-
URL
<md5hash>-
MD5 hash
Optional arguments
-h, --help-
show this help message and exit
openstack compute service delete
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack compute service list
usage: openstack --os-auth-type token --os-identity-api-version 2 compute service list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--host <host>] [--service <service>]List service command
Optional arguments
-h, --help-
show this help message and exit
--host <host>-
Name of host
--service <service>-
Name of service
openstack compute service set
usage: openstack --os-auth-type token --os-identity-api-version 2 compute service set [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--enable | --disable]
<host> <service>Set service command
Positional arguments
<host>-
Name of host
<service>-
Name of service
Optional arguments
-h, --help-
show this help message and exit
--enable-
Enable a service
--disable-
Disable a service
openstack configuration show
usage: openstack --os-auth-type token --os-identity-api-version 2 configuration show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--mask | --unmask]Display configuration details
Optional arguments
-h, --help-
show this help message and exit
--mask-
Attempt to mask passwords (default)
--unmask-
Show password in clear text
openstack congress datasource create
usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--description <datasource-description>]
[--config <key=value>]
<datasource-driver>
<datasource-name>Create a datasource.
Positional arguments
<datasource-driver>-
Selected datasource driver
<datasource-name>-
Name you want to call the datasource
Optional arguments
-h, --help-
show this help message and exit
--description <datasource-description>-
Description of the datasource
--config <key=value>-
config dictionary to pass in
openstack congress datasource delete
usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource delete [-h] <datasource-name>Delete a datasource.
Positional arguments
<datasource-name>-
Name of the datasource to delete
Optional arguments
-h, --help-
show this help message and exit
openstack congress datasource list
usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]List Datasources.
Optional arguments
-h, --help-
show this help message and exit
openstack congress datasource row list
usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource row list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
<datasource-name> <table>List datasource rows.
Positional arguments
<datasource-name>-
Name of the datasource to show
<table>-
Table to get the datasource rows from
Optional arguments
-h, --help-
show this help message and exit
openstack congress datasource schema show
usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource schema show [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
<datasource-name>Show schema for datasource.
Positional arguments
<datasource-name>-
Name of the datasource
Optional arguments
-h, --help-
show this help message and exit
openstack congress datasource status show
usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource status show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
<datasource-name>List status for datasource.
Positional arguments
<datasource-name>-
Name of the datasource
Optional arguments
-h, --help-
show this help message and exit
openstack congress datasource table list
usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource table list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
<datasource-name>List datasource tables.
Positional arguments
<datasource-name>-
Name of the datasource
Optional arguments
-h, --help-
show this help message and exit
openstack congress datasource table schema show
usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource table schema show [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
<datasource-name>
<table-name>Show schema for datasource table.
Positional arguments
<datasource-name>-
Name of the datasource
<table-name>-
Name of the table
Optional arguments
-h, --help-
show this help message and exit
openstack congress datasource table show
usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource table show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
<datasource-name> <table-id>Show Datasource Table properties.
Positional arguments
<datasource-name>-
Name of datasource
<table-id>-
Table id
Optional arguments
-h, --help-
show this help message and exit
openstack congress driver config show
usage: openstack --os-auth-type token --os-identity-api-version 2 congress driver config show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
<datasource-driver>List driver tables.
Positional arguments
<datasource-driver>-
Name of the datasource driver
Optional arguments
-h, --help-
show this help message and exit
openstack congress driver list
usage: openstack --os-auth-type token --os-identity-api-version 2 congress driver list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]List drivers.
Optional arguments
-h, --help-
show this help message and exit
openstack congress driver schema show
usage: openstack --os-auth-type token --os-identity-api-version 2 congress driver schema show [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
<datasource-driver>List datasource tables.
Positional arguments
<datasource-driver>-
Name of the datasource driver
Optional arguments
-h, --help-
show this help message and exit
openstack congress policy create
usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--description <description>]
[--abbreviation <abbreviation>]
[--kind <kind>]
<policy_name>Create a policy.
Positional arguments
<policy_name>-
Name of the policy
Optional arguments
-h, --help-
show this help message and exit
--description <description>-
Policy description
--abbreviation <abbreviation>-
Policy abbreviation (used in traces)
--kind <kind>-
Kind of policy: {nonrecursive, database, action, materialized}
openstack congress policy delete
usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy delete [-h] <policy>Delete a policy.
Positional arguments
<policy>-
ID or name of the policy to delete
Optional arguments
-h, --help-
show this help message and exit
openstack congress policy list
usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]List Policy.
Optional arguments
-h, --help-
show this help message and exit
openstack congress policy row list
usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy row list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--trace]
<policy-name> <table>List policy rows.
Positional arguments
<policy-name>-
Name of the policy to show
<table>-
Table to get the policy rows from
Optional arguments
-h, --help-
show this help message and exit
--trace-
Display explanation of result
openstack congress policy rule create
usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy rule create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--name RULE_NAME]
[--comment COMMENT]
<policy-name> <rule>Create a policy rule.
Positional arguments
<policy-name>-
Name or identifier of the policy
<rule>-
Policy rule
Optional arguments
-h, --help-
show this help message and exit
--name RULE_NAME-
Name of the policy rule
--comment COMMENT-
Comment about policy rule
openstack congress policy rule delete
usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy rule delete [-h]
<policy-name> <rule-id/rule-name>Delete a policy rule.
Positional arguments
<policy-name>-
Name of the policy to delete
<rule-id/rule-name>-
ID/Name of the policy rule to delete
Optional arguments
-h, --help-
show this help message and exit
openstack congress policy rule list
usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy rule list [-h] <policy-name>List policy rules.
Positional arguments
<policy-name>-
Name of the policy
Optional arguments
-h, --help-
show this help message and exit
openstack congress policy rule show
usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy rule show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<policy-name> <rule-id/rule-name>Show a policy rule.
Positional arguments
<policy-name>-
Name or identifier of the policy
<rule-id/rule-name>-
Policy rule id or rule name
Optional arguments
-h, --help-
show this help message and exit
openstack congress policy show
usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<policy-name>Show policy properties.
Positional arguments
<policy-name>-
Name of policy
Optional arguments
-h, --help-
show this help message and exit
openstack congress policy simulate
usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy simulate [-h] [--delta] [--trace]
<policy> <query> <sequence>
<action_policy>Show the result of simulation.
Positional arguments
<policy>-
Name of the policy
<query>-
String representing query (policy rule or literal)
<sequence>-
String representing sequence of updates/actions
<action_policy>-
Name of the policy with actions
Optional arguments
-h, --help-
show this help message and exit
--delta-
Return difference in query caused by update sequence
--trace-
Include trace describing computation
openstack congress policy table list
usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy table list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
<policy-name>List policy tables.
Positional arguments
<policy-name>-
Name of the policy
Optional arguments
-h, --help-
show this help message and exit
openstack congress policy table show
usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy table show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
<policy-name> <table-id>Show policy table properties.
Positional arguments
<policy-name>-
Name of policy
<table-id>-
Table id
Optional arguments
-h, --help-
show this help message and exit
openstack console log show
usage: openstack --os-auth-type token --os-identity-api-version 2 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)
openstack console url show
usage: openstack --os-auth-type token --os-identity-api-version 2 console url show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--novnc | --xvpvnc | --spice]
<server>Show server's remote console URL
Positional arguments
<server>-
Server to show URL (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--novnc-
Show noVNC console URL (default)
--xvpvnc-
Show xpvnc console URL
--spice-
Show SPICE console URL
openstack container create
usage: openstack --os-auth-type token --os-identity-api-version 2 container create [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
<container-name> [<container-name> ...]Create new container
Positional arguments
<container-name>-
New container name(s)
Optional arguments
-h, --help-
show this help message and exit
openstack container delete
usage: openstack --os-auth-type token --os-identity-api-version 2 container delete [-h] <container> [<container> ...]Delete container
Positional arguments
<container>-
Container(s) to delete
Optional arguments
-h, --help-
show this help message and exit
openstack container list
usage: openstack --os-auth-type token --os-identity-api-version 2 container list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--prefix <prefix>] [--marker <marker>]
[--end-marker <end-marker>] [--limit <limit>]
[--long] [--all]List containers
Optional arguments
-h, --help-
show this help message and exit
--prefix <prefix>-
Filter list using <prefix>
--marker <marker>-
Anchor for paging
--end-marker <end-marker>-
End anchor for paging
--limit <limit>-
Limit the number of containers returned
--long-
List additional fields in output
--all-
List all containers (default is 10000)
openstack container save
usage: openstack --os-auth-type token --os-identity-api-version 2 container save [-h] <container>Save container contents locally
Positional arguments
<container>-
Container to save
Optional arguments
-h, --help-
show this help message and exit
openstack container set
usage: openstack --os-auth-type token --os-identity-api-version 2 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)
openstack container show
usage: openstack --os-auth-type token --os-identity-api-version 2 container show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<container>Display container details
Positional arguments
<container>-
Container to display
Optional arguments
-h, --help-
show this help message and exit
openstack container unset
usage: openstack --os-auth-type token --os-identity-api-version 2 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)
openstack dataprocessing data source create
usage: openstack --os-auth-type token --os-identity-api-version 2 dataprocessing data source create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX] --type
<type> --url <url>
[--username <username>]
[--password <password>]
[--description <description>]
<name>Creates data source
Positional arguments
<name>-
Name of the data source
Optional arguments
-h, --help-
show this help message and exit
--type <type>-
Type of the data source (swift, hdfs or maprfs) [REQUIRED]
--url <url>-
Url for the data source [REQUIRED]
--username <username>-
Username for accessing the data source url
--password <password>-
Password for accessing the data source url
--description <description>-
Description of the data source
openstack dataprocessing data source delete
usage: openstack --os-auth-type token --os-identity-api-version 2 dataprocessing data source delete [-h] <data-source>Delete data source
Positional arguments
<data-source>-
Name or id of the data source to delete
Optional arguments
-h, --help-
show this help message and exit
openstack dataprocessing data source list
usage: openstack --os-auth-type token --os-identity-api-version 2 dataprocessing data source list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long] [--type <type>]Lists data sources
Optional arguments
-h, --help-
show this help message and exit
--long-
List additional fields in output
--type <type>-
List data sources of specific type (swift, hdfs or maprfs)
openstack dataprocessing data source show
usage: openstack --os-auth-type token --os-identity-api-version 2 dataprocessing data source show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
<data-source>Display data source details
Positional arguments
<data-source>-
Name or id of the data source to display
Optional arguments
-h, --help-
show this help message and exit
openstack dataprocessing plugin configs get
usage: openstack --os-auth-type token --os-identity-api-version 2 dataprocessing plugin configs get [-h] [--file <file>]
<plugin> <version>Get plugin configs
Positional arguments
<plugin>-
Name of the plugin to provide config information about
<version>-
Version of the plugin to provide config information about
Optional arguments
-h, --help-
show this help message and exit
--file <file>-
Destination file (defaults to plugin name)
openstack dataprocessing plugin list
usage: openstack --os-auth-type token --os-identity-api-version 2 dataprocessing plugin list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long]Lists plugins
Optional arguments
-h, --help-
show this help message and exit
--long-
List additional fields in output
openstack dataprocessing plugin show
usage: openstack --os-auth-type token --os-identity-api-version 2 dataprocessing plugin show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
<plugin>Display plugin details
Positional arguments
<plugin>-
Name of the plugin to display
Optional arguments
-h, --help-
show this help message and exit
openstack ec2 credentials create
usage: openstack --os-auth-type token --os-identity-api-version 2 ec2 credentials create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--project <project>] [--user <user>]Create EC2 credentials
Optional arguments
-h, --help-
show this help message and exit
--project <project>-
Create credentials in project (name or ID; default: current authenticated project)
--user <user>-
Create credentials for user (name or ID; default: current authenticated user)
openstack ec2 credentials delete
usage: openstack --os-auth-type token --os-identity-api-version 2 ec2 credentials delete [-h] [--user <user>] <access-key>Delete EC2 credentials
Positional arguments
<access-key>-
Credentials access key
Optional arguments
-h, --help-
show this help message and exit
--user <user>-
Delete credentials for user (name or ID)
openstack ec2 credentials list
usage: openstack --os-auth-type token --os-identity-api-version 2 ec2 credentials list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--user <user>]List EC2 credentials
Optional arguments
-h, --help-
show this help message and exit
--user <user>-
Filter list by user (name or ID)
openstack ec2 credentials show
usage: openstack --os-auth-type token --os-identity-api-version 2 ec2 credentials show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--user <user>]
<access-key>Display EC2 credentials details
Positional arguments
<access-key>-
Credentials access key
Optional arguments
-h, --help-
show this help message and exit
--user <user>-
Show credentials for user (name or ID)
openstack endpoint create
usage: openstack --os-auth-type token --os-identity-api-version 2 endpoint create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] --publicurl
<url> [--adminurl <url>]
[--internalurl <url>] [--region <region-id>]
<service>Create new endpoint
Positional arguments
<service>-
New endpoint service (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--publicurl <url>-
New endpoint public URL (required)
--adminurl <url>-
New endpoint admin URL
--internalurl <url>-
New endpoint internal URL
--region <region-id>-
New endpoint region ID
openstack endpoint delete
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack endpoint list
usage: openstack --os-auth-type token --os-identity-api-version 2 endpoint list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long]List endpoints
Optional arguments
-h, --help-
show this help message and exit
--long-
List additional fields in output
openstack endpoint show
usage: openstack --os-auth-type token --os-identity-api-version 2 endpoint show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<endpoint-id>Display endpoint details
Positional arguments
<endpoint-id>-
Endpoint ID to display
Optional arguments
-h, --help-
show this help message and exit
openstack extension list
usage: openstack --os-auth-type token --os-identity-api-version 2 extension list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--compute] [--identity] [--network]
[--volume] [--long]List API extensions
Optional arguments
-h, --help-
show this help message and exit
--compute-
List extensions for the Compute API
--identity-
List extensions for the Identity API
--network-
List extensions for the Network API
--volume-
List extensions for the Volume API
--long-
List additional fields in output
openstack flavor create
usage: openstack --os-auth-type token --os-identity-api-version 2 flavor create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] [--id <id>]
[--ram <size-mb>] [--disk <size-gb>]
[--ephemeral <size-gb>] [--swap <size-gb>]
[--vcpus <vcpus>] [--rxtx-factor <factor>]
[--public | --private]
<flavor-name>Create new flavor
Positional arguments
<flavor-name>-
New flavor name
Optional arguments
-h, --help-
show this help message and exit
--id <id>-
Unique flavor ID; 'auto' creates a UUID (default: auto)
--ram <size-mb>-
Memory size in MB (default 256M)
--disk <size-gb>-
Disk size in GB (default 0G)
--ephemeral <size-gb>-
Ephemeral disk size in GB (default 0G)
--swap <size-gb>-
Swap space size in GB (default 0G)
--vcpus <vcpus>-
Number of vcpus (default 1)
--rxtx-factor <factor>-
RX/TX factor (default 1)
--public-
Flavor is available to other projects (default)
--private-
Flavor is not available to other projects
openstack flavor delete
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack flavor list
usage: openstack --os-auth-type token --os-identity-api-version 2 flavor list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--public | --private | --all] [--long]
[--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
openstack flavor set
usage: openstack --os-auth-type token --os-identity-api-version 2 flavor set [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--property <key=value>]
<flavor>Set flavor properties
Positional arguments
<flavor>-
Flavor to modify (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--property <key=value>-
Property to add or modify for this flavor (repeat option to set multiple properties)
openstack flavor show
usage: openstack --os-auth-type token --os-identity-api-version 2 flavor show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<flavor>Display flavor details
Positional arguments
<flavor>-
Flavor to display (name or ID)
Optional arguments
-h, --help-
show this help message and exit
openstack flavor unset
usage: openstack --os-auth-type token --os-identity-api-version 2 flavor unset [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] --property <key>
<flavor>Unset flavor properties
Positional arguments
<flavor>-
Flavor to modify (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--property <key>-
Property to remove from flavor (repeat option to unset multiple properties)
openstack host list
usage: openstack --os-auth-type token --os-identity-api-version 2 host list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--zone <zone>]List host command
Optional arguments
-h, --help-
show this help message and exit
--zone <zone>-
Only return hosts in the availability zone.
openstack host show
usage: openstack --os-auth-type token --os-identity-api-version 2 host show [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
<host>Show host command
Positional arguments
<host>-
Name of host
Optional arguments
-h, --help-
show this help message and exit
openstack hypervisor list
usage: openstack --os-auth-type token --os-identity-api-version 2 hypervisor list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--matching <hostname>]List hypervisors
Optional arguments
-h, --help-
show this help message and exit
--matching <hostname>-
Filter hypervisors using <hostname> substring
openstack hypervisor show
usage: openstack --os-auth-type token --os-identity-api-version 2 hypervisor show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<hypervisor>Display hypervisor details
Positional arguments
<hypervisor>-
Hypervisor to display (name or ID)
Optional arguments
-h, --help-
show this help message and exit
openstack hypervisor stats show
usage: openstack --os-auth-type token --os-identity-api-version 2 hypervisor stats show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]Display hypervisor stats details
Optional arguments
-h, --help-
show this help message and exit
openstack image add project
usage: openstack --os-auth-type token --os-identity-api-version 2 image add project [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--project-domain <project-domain>]
<image> <project>Associate project with image
Positional arguments
<image>-
Image to share (name or ID)
<project>-
Project to associate with image (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--project-domain <project-domain>-
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
openstack image create
usage: openstack --os-auth-type token --os-identity-api-version 2 image create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--id <id>]
[--container-format <container-format>]
[--disk-format <disk-format>] [--owner <owner>]
[--min-disk <disk-gb>] [--min-ram <ram-mb>]
[--file <file>] [--protected | --unprotected]
[--public | --private] [--property <key=value>]
[--tag <tag>]
<image-name>Create/upload an image
Positional arguments
<image-name>-
New image name
Optional arguments
-h, --help-
show this help message and exit
--id <id>-
Image ID to reserve
--container-format <container-format>-
Image container format (default: bare)
--disk-format <disk-format>-
Image disk format (default: raw)
--owner <owner>-
Image owner project name or ID
--min-disk <disk-gb>-
Minimum disk size needed to boot image, in gigabytes
--min-ram <ram-mb>-
Minimum RAM size needed to boot image, in megabytes
--file <file>-
Upload image from local file
--protected-
Prevent image from being deleted
--unprotected-
Allow image to be deleted (default)
--public-
Image is accessible to the public
--private-
Image is inaccessible to the public (default)
--property <key=value>-
Set a property on this image (repeat option to set multiple properties)
--tag <tag>-
Set a tag on this image (repeat option to set multiple tags)
openstack image delete
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack image list
usage: openstack --os-auth-type token --os-identity-api-version 2 image list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--public | --private | --shared]
[--property <key=value>] [--long]
[--sort <key>[:<direction>]]List available images
Optional arguments
-h, --help-
show this help message and exit
--public-
List only public images
--private-
List only private images
--shared-
List only shared images
--property <key=value>-
Filter output based on property
--long-
List additional fields in output
--sort <key>[:<direction>]-
Sort output by selected keys and directions(asc or desc) (default: asc), multiple keys and directions can be specified separated by comma
openstack image remove project
usage: openstack --os-auth-type token --os-identity-api-version 2 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.
openstack image save
usage: openstack --os-auth-type token --os-identity-api-version 2 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)
openstack image set
usage: openstack --os-auth-type token --os-identity-api-version 2 image set [-h] [--name <name>] [--owner <project>]
[--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>]
<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
--owner <project>-
New image owner project (name or ID)
--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
openstack image show
usage: openstack --os-auth-type token --os-identity-api-version 2 image show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<image>Display image details
Positional arguments
<image>-
Image to display (name or ID)
Optional arguments
-h, --help-
show this help message and exit
openstack ip fixed add
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack ip fixed remove
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack ip floating add
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack ip floating create
usage: openstack --os-auth-type token --os-identity-api-version 2 ip floating create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<pool>Create new floating IP address
Positional arguments
<pool>-
Pool to fetch IP address from (name or ID)
Optional arguments
-h, --help-
show this help message and exit
openstack ip floating delete
usage: openstack --os-auth-type token --os-identity-api-version 2 ip floating delete [-h] <ip-address>Delete a floating IP address
Positional arguments
<ip-address>-
IP address to delete (ID only)
Optional arguments
-h, --help-
show this help message and exit
openstack ip floating list
usage: openstack --os-auth-type token --os-identity-api-version 2 ip floating list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]List floating IP addresses
Optional arguments
-h, --help-
show this help message and exit
openstack ip floating pool list
usage: openstack --os-auth-type token --os-identity-api-version 2 ip floating pool list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]List pools of floating IP addresses
Optional arguments
-h, --help-
show this help message and exit
openstack ip floating remove
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack keypair create
usage: openstack --os-auth-type token --os-identity-api-version 2 keypair create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--public-key <file>]
<name>Create new public key
Positional arguments
<name>-
New public key name
Optional arguments
-h, --help-
show this help message and exit
--public-key <file>-
Filename for public key to add
openstack keypair delete
usage: openstack --os-auth-type token --os-identity-api-version 2 keypair delete [-h] <key>Delete public key
Positional arguments
<key>-
Public key to delete
Optional arguments
-h, --help-
show this help message and exit
openstack keypair list
usage: openstack --os-auth-type token --os-identity-api-version 2 keypair list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]List public key fingerprints
Optional arguments
-h, --help-
show this help message and exit
openstack keypair show
usage: openstack --os-auth-type token --os-identity-api-version 2 keypair show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--public-key]
<key>Display public key details
Positional arguments
<key>-
Public key to display
Optional arguments
-h, --help-
show this help message and exit
--public-key-
Show only bare public key
openstack limits show
usage: openstack --os-auth-type token --os-identity-api-version 2 limits show [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
(--absolute | --rate) [--reserved]
[--project <project>] [--domain <domain>]Show compute and volume limits
Optional arguments
-h, --help-
show this help message and exit
--absolute-
Show absolute limits
--rate-
Show rate limits
--reserved-
Include reservations count [only valid with
--absolute] --project <project>-
Show limits for a specific project (name or ID) [only valid with
--absolute] --domain <domain>-
Domain that owns
--project(name or ID) [only valid with--absolute]
openstack management plan add role
usage: openstack --os-auth-type token --os-identity-api-version 2 management plan add role [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]Add a Role to a Management Plan.
Optional arguments
-h, --help-
show this help message and exit
openstack management plan create
usage: openstack --os-auth-type token --os-identity-api-version 2 management plan create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-d DESCRIPTION]
nameCreate a Management Plan.
Positional arguments
name-
Name of the plan being created.
Optional arguments
-h, --help-
show this help message and exit
-d DESCRIPTION, --description DESCRIPTION-
A textual description of the plan.
openstack management plan delete
usage: openstack --os-auth-type token --os-identity-api-version 2 management plan delete [-h] plan_uuidDelete a Management Plan.
Positional arguments
plan_uuid-
The UUID of the plan being deleted.
Optional arguments
-h, --help-
show this help message and exit
openstack management plan download
usage: openstack --os-auth-type token --os-identity-api-version 2 management plan download [-h]Download the a Management Plan.
Optional arguments
-h, --help-
show this help message and exit
openstack management plan list
usage: openstack --os-auth-type token --os-identity-api-version 2 management plan list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]List the Management Plans.
Optional arguments
-h, --help-
show this help message and exit
openstack management plan remove role
usage: openstack --os-auth-type token --os-identity-api-version 2 management plan remove role [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]Remove a Role from a Management Plan.
Optional arguments
-h, --help-
show this help message and exit
openstack management plan set
usage: openstack --os-auth-type token --os-identity-api-version 2 management plan set [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-P <KEY1=VALUE1>] [-F <ROLE=FLAVOR>]
[-S <ROLE=SCALE-COUNT>]
plan_uuidUpdate a Management Plans properties.
Positional arguments
plan_uuid-
The UUID of the plan being updated.
Optional arguments
-h, --help-
show this help message and exit
-P <KEY1=VALUE1>, --parameter <KEY1=VALUE1>-
Set a parameter in the Plan. This can be specified multiple times.
-F <ROLE=FLAVOR>, --flavor <ROLE=FLAVOR>-
Set the flavor for a role in the Plan. This can be specified multiple times.
-S <ROLE=SCALE-COUNT>, --scale <ROLE=SCALE-COUNT>-
Set the Scale count for a role in the Plan. This can be specified multiple times.
openstack management plan show
usage: openstack --os-auth-type token --os-identity-api-version 2 management plan show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]Show a Management Plan.
Optional arguments
-h, --help-
show this help message and exit
openstack management role list
usage: openstack --os-auth-type token --os-identity-api-version 2 management role list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]List Roles.
Optional arguments
-h, --help-
show this help message and exit
openstack message-broker
Command "message-broker" matches:
message-broker cluster create
message-broker cluster delete
message-broker cluster list
message-broker cluster set
message-broker cluster showopenstack message-broker cluster
Command "message-broker cluster" matches:
message-broker cluster create
message-broker cluster delete
message-broker cluster list
message-broker cluster set
message-broker cluster showopenstack message-broker cluster create
usage: openstack --os-auth-type token --os-identity-api-version 2 message-broker cluster create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
--name NAME --nic NIC --flavor
FLAVOR --size SIZE
[--volume_size VOLUME_SIZE]
[--auth <type=type,user=user,pass=pass>]Create Cluster
Optional arguments
-h, --help-
show this help message and exit
--name NAME-
Cluster Name
--nic NIC-
Network to place nodes on
--flavor FLAVOR-
Flavor to use.
--size SIZE-
Number of nodes
--volume_size VOLUME_SIZE-
Volume size
--auth <type=type,user=user,pass=pass>-
broker authentication,type=type,user=user,pass=pass
openstack message-broker cluster delete
usage: openstack --os-auth-type token --os-identity-api-version 2 message-broker cluster delete [-h] idDelete Cluster
Positional arguments
id-
Cluster ID
Optional arguments
-h, --help-
show this help message and exit
openstack message-broker cluster list
usage: openstack --os-auth-type token --os-identity-api-version 2 message-broker cluster list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]List Clusters
Optional arguments
-h, --help-
show this help message and exit
openstack message-broker cluster set
usage: openstack --os-auth-type token --os-identity-api-version 2 message-broker cluster set [-h] [--name NAME] [--email EMAIL]
[--ttl TTL]
[--description DESCRIPTION | --no-description]
[--masters MASTERS [MASTERS ...]]
idSet Cluster
Positional arguments
id-
Cluster ID
Optional arguments
-h, --help-
show this help message and exit
--name NAME-
Cluster Name
--email EMAIL-
Cluster Email
--ttl TTL-
Time To Live (Seconds)
--description DESCRIPTION-
Description
--no-description
--masters MASTERS [MASTERS ...]-
Cluster Masters
openstack message-broker cluster show
usage: openstack --os-auth-type token --os-identity-api-version 2 message-broker cluster show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
idShow Cluster
Positional arguments
id-
Cluster ID
Optional arguments
-h, --help-
show this help message and exit
openstack messaging flavor delete
usage: openstack --os-auth-type token --os-identity-api-version 2 messaging flavor delete [-h] <flavor_name>Delete a flavor.
Positional arguments
<flavor_name>-
Name of the flavor
Optional arguments
-h, --help-
show this help message and exit
openstack module list
usage: openstack --os-auth-type token --os-identity-api-version 2 module list [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--all]List module versions
Optional arguments
-h, --help-
show this help message and exit
--all-
Show all modules that have version information
openstack network create
usage: openstack --os-auth-type token --os-identity-api-version 2 network create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--enable | --disable] [--share | --no-share]
[--project <project>]
[--project-domain <project-domain>]
<name>Create new network
Positional arguments
<name>-
New network name
Optional arguments
-h, --help-
show this help message and exit
--enable-
Enable network (default)
--disable-
Disable network
--share-
Share the network between projects
--no-share-
Do not share the network between projects
--project <project>-
Owner's project (name or ID)
--project-domain <project-domain>-
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
openstack network delete
usage: openstack --os-auth-type token --os-identity-api-version 2 network delete [-h] <network> [<network> ...]Delete network(s)
Positional arguments
<network>-
Network to delete (name or ID)
Optional arguments
-h, --help-
show this help message and exit
openstack network list
usage: openstack --os-auth-type token --os-identity-api-version 2 network list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--external] [--long]List networks
Optional arguments
-h, --help-
show this help message and exit
--external-
List external networks
--long-
List additional fields in output
openstack network set
usage: openstack --os-auth-type token --os-identity-api-version 2 network set [-h] [--name <name>] [--enable | --disable]
[--share | --no-share]
<network>Set network properties
Positional arguments
<network>-
Network to modify (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--name <name>-
Set network name
--enable-
Enable network
--disable-
Disable network
--share-
Share the network between projects
--no-share-
Do not share the network between projects
openstack network show
usage: openstack --os-auth-type token --os-identity-api-version 2 network show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<network>Show network details
Positional arguments
<network>-
Network to display (name or ID)
Optional arguments
-h, --help-
show this help message and exit
openstack object create
usage: openstack --os-auth-type token --os-identity-api-version 2 object create [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
<container> <filename> [<filename> ...]Upload object to container
Positional arguments
<container>-
Container for new object
<filename>-
Local filename(s) to upload
Optional arguments
-h, --help-
show this help message and exit
openstack object delete
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack object list
usage: openstack --os-auth-type token --os-identity-api-version 2 object list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--prefix <prefix>] [--delimiter <delimiter>]
[--marker <marker>] [--end-marker <end-marker>]
[--limit <limit>] [--long] [--all]
<container>List objects
Positional arguments
<container>-
Container to list
Optional arguments
-h, --help-
show this help message and exit
--prefix <prefix>-
Filter list using <prefix>
--delimiter <delimiter>-
Roll up items with <delimiter>
--marker <marker>-
Anchor for paging
--end-marker <end-marker>-
End anchor for paging
--limit <limit>-
Limit the number of objects returned
--long-
List additional fields in output
--all-
List all objects in container (default is 10000)
openstack object save
usage: openstack --os-auth-type token --os-identity-api-version 2 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)
openstack object set
usage: openstack --os-auth-type token --os-identity-api-version 2 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)
openstack object show
usage: openstack --os-auth-type token --os-identity-api-version 2 object show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<container> <object>Display object details
Positional arguments
<container>-
Display <object> from <container>
<object>-
Object to display
Optional arguments
-h, --help-
show this help message and exit
openstack object store account set
usage: openstack --os-auth-type token --os-identity-api-version 2 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)
openstack object store account show
usage: openstack --os-auth-type token --os-identity-api-version 2 object store account show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]Display account details
Optional arguments
-h, --help-
show this help message and exit
openstack object store account unset
usage: openstack --os-auth-type token --os-identity-api-version 2 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)
openstack object unset
usage: openstack --os-auth-type token --os-identity-api-version 2 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)
openstack pool create
usage: openstack --os-auth-type token --os-identity-api-version 2 pool create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<pool_name> <pool_uri> <pool_weight> <pool_group>Create a pool.
Positional arguments
<pool_name>-
Name of the pool
<pool_uri>-
Storage engine URI
<pool_weight>-
weight of the pool
<pool_group>-
Group of the pool
Optional arguments
-h, --help-
show this help message and exit
openstack project create
usage: openstack --os-auth-type token --os-identity-api-version 2 project create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--description <description>]
[--enable | --disable]
[--property <key=value>] [--or-show]
<project-name>Create new project
Positional arguments
<project-name>-
New project name
Optional arguments
-h, --help-
show this help message and exit
--description <description>-
Project description
--enable-
Enable project (default)
--disable-
Disable project
--property <key=value>-
Add a property to <name> (repeat option to set multiple properties)
--or-show-
Return existing project
openstack project delete
usage: openstack --os-auth-type token --os-identity-api-version 2 project delete [-h] <project> [<project> ...]Delete project(s)
Positional arguments
<project>-
Project(s) to delete (name or ID)
Optional arguments
-h, --help-
show this help message and exit
openstack project list
usage: openstack --os-auth-type token --os-identity-api-version 2 project list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--long]List projects
Optional arguments
-h, --help-
show this help message and exit
--long-
List additional fields in output
openstack project set
usage: openstack --os-auth-type token --os-identity-api-version 2 project set [-h] [--name <name>]
[--description <description>]
[--enable | --disable] [--property <key=value>]
<project>Set project properties
Positional arguments
<project>-
Project to modify (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--name <name>-
Set project name
--description <description>-
Set project description
--enable-
Enable project
--disable-
Disable project
--property <key=value>-
Set a project property (repeat option to set multiple properties)
openstack project show
usage: openstack --os-auth-type token --os-identity-api-version 2 project show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<project>Display project details
Positional arguments
<project>-
Project to display (name or ID)
Optional arguments
-h, --help-
show this help message and exit
openstack ptr record list
usage: openstack --os-auth-type token --os-identity-api-version 2 ptr record list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]List floatingip ptr records
Optional arguments
-h, --help-
show this help message and exit
openstack ptr record set
usage: openstack --os-auth-type token --os-identity-api-version 2 ptr record set [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--description DESCRIPTION | --no-description]
[--ttl TTL | --no-ttl]
floatingip_id ptrdnameSet 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
openstack ptr record show
usage: openstack --os-auth-type token --os-identity-api-version 2 ptr record show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
floatingip_idShow floatingip ptr record details
Positional arguments
floatingip_id-
Floating IP ID
Optional arguments
-h, --help-
show this help message and exit
openstack ptr record unset
usage: openstack --os-auth-type token --os-identity-api-version 2 ptr record unset [-h] floatingip_idUnset floatingip ptr record
Positional arguments
floatingip_id-
Floating IP ID
Optional arguments
-h, --help-
show this help message and exit
openstack queue create
usage: openstack --os-auth-type token --os-identity-api-version 2 queue create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<queue_name>Create a queue.
Positional arguments
<queue_name>-
Name of the queue
Optional arguments
-h, --help-
show this help message and exit
openstack queue delete
usage: openstack --os-auth-type token --os-identity-api-version 2 queue delete [-h] <queue_name>Delete a queue.
Positional arguments
<queue_name>-
Name of the queue
Optional arguments
-h, --help-
show this help message and exit
openstack queue exists
usage: openstack --os-auth-type token --os-identity-api-version 2 queue exists [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<queue_name>Check queue existence.
Positional arguments
<queue_name>-
Name of the queue
Optional arguments
-h, --help-
show this help message and exit
openstack queue get metadata
usage: openstack --os-auth-type token --os-identity-api-version 2 queue get metadata [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<queue_name>Get queue metadata.
Positional arguments
<queue_name>-
Name of the queue
Optional arguments
-h, --help-
show this help message and exit
openstack queue list
usage: openstack --os-auth-type token --os-identity-api-version 2 queue list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--marker <queue_id>] [--limit <limit>]List available queues.
Optional arguments
-h, --help-
show this help message and exit
--marker <queue_id>-
Queue's paging marker
--limit <limit>-
Page size limit
openstack queue set metadata
usage: openstack --os-auth-type token --os-identity-api-version 2 queue set metadata [-h] <queue_name> <queue_metadata>Set queue metadata.
Positional arguments
<queue_name>-
Name of the queue
<queue_metadata>-
Queue metadata
Optional arguments
-h, --help-
show this help message and exit
openstack queue stats
usage: openstack --os-auth-type token --os-identity-api-version 2 queue stats [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<queue_name>Get queue stats.
Positional arguments
<queue_name>-
Name of the queue
Optional arguments
-h, --help-
show this help message and exit
openstack quota set
usage: openstack --os-auth-type token --os-identity-api-version 2 quota set [-h] [--class] [--properties <properties>]
[--ram <ram>] [--secgroup-rules <secgroup-rules>]
[--instances <instances>] [--key-pairs <key-pairs>]
[--fixed-ips <fixed-ips>] [--secgroups <secgroups>]
[--injected-file-size <injected-file-size>]
[--floating-ips <floating-ips>]
[--injected-files <injected-files>]
[--cores <cores>]
[--injected-path-size <injected-path-size>]
[--gigabytes <gigabytes>] [--volumes <volumes>]
[--snapshots <snapshots>]
[--volume-type <volume-type>]
<project/class>Set quotas for project or class
Positional arguments
<project/class>-
Set quotas for this project or class (name/ID)
Optional arguments
-h, --help-
show this help message and exit
--class-
Set quotas for <class>
--properties <properties>-
New value for the properties quota
--ram <ram>-
New value for the ram quota
--secgroup-rules <secgroup-rules>-
New value for the secgroup-rules quota
--instances <instances>-
New value for the instances quota
--key-pairs <key-pairs>-
New value for the key-pairs quota
--fixed-ips <fixed-ips>-
New value for the fixed-ips quota
--secgroups <secgroups>-
New value for the secgroups quota
--injected-file-size <injected-file-size>-
New value for the injected-file-size quota
--floating-ips <floating-ips>-
New value for the floating-ips quota
--injected-files <injected-files>-
New value for the injected-files quota
--cores <cores>-
New value for the cores quota
--injected-path-size <injected-path-size>-
New value for the injected-path-size quota
--gigabytes <gigabytes>-
New value for the gigabytes quota
--volumes <volumes>-
New value for the volumes quota
--snapshots <snapshots>-
New value for the snapshots quota
--volume-type <volume-type>-
Set quotas for a specific <volume-type>
openstack quota show
usage: openstack --os-auth-type token --os-identity-api-version 2 quota show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--class | --default]
<project/class>Show quotas for project or class
Positional arguments
<project/class>-
Show this project or class (name/ID)
Optional arguments
-h, --help-
show this help message and exit
--class-
Show quotas for <class>
--default-
Show default quotas for <project>
openstack recordset create
usage: openstack --os-auth-type token --os-identity-api-version 2 recordset create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] --records
RECORDS [RECORDS ...] --type TYPE
[--ttl TTL] [--description DESCRIPTION]
zone_id nameCreate 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
openstack recordset delete
usage: openstack --os-auth-type token --os-identity-api-version 2 recordset delete [-h] zone_id idDelete recordset
Positional arguments
zone_id-
Zone ID
id-
RecordSet ID
Optional arguments
-h, --help-
show this help message and exit
openstack recordset list
usage: openstack --os-auth-type token --os-identity-api-version 2 recordset list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
zone_idList recordsets
Positional arguments
zone_id-
Zone ID
Optional arguments
-h, --help-
show this help message and exit
openstack recordset set
usage: openstack --os-auth-type token --os-identity-api-version 2 recordset set [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] [--name NAME]
[--records RECORDS [RECORDS ...]]
[--description DESCRIPTION | --no-description]
[--ttl TTL | --no-ttl]
zone_id idSet recordset properties
Positional arguments
zone_id-
Zone ID
id-
RecordSet ID
Optional arguments
-h, --help-
show this help message and exit
--name NAME-
RecordSet Name
--records RECORDS [RECORDS ...]-
Records
--description DESCRIPTION-
Description
--no-description
--ttl TTL-
TTL
--no-ttl
openstack recordset show
usage: openstack --os-auth-type token --os-identity-api-version 2 recordset show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
zone_id idShow recordset details
Positional arguments
zone_id-
Zone ID
id-
RecordSet ID
Optional arguments
-h, --help-
show this help message and exit
openstack role add
usage: openstack --os-auth-type token --os-identity-api-version 2 role add [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] --project <project> --user <user>
<role>Add role to project:user
Positional arguments
<role>-
Role to add to <project>:<user> (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--project <project>-
Include <project> (name or ID)
--user <user>-
Include <user> (name or ID)
openstack role create
usage: openstack --os-auth-type token --os-identity-api-version 2 role create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--or-show]
<name>Create new role
Positional arguments
<name>-
New role name
Optional arguments
-h, --help-
show this help message and exit
--or-show-
Return existing role
openstack role delete
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack role list
usage: openstack --os-auth-type token --os-identity-api-version 2 role list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--project <project>] [--user <user>]List roles
Optional arguments
-h, --help-
show this help message and exit
--project <project>-
Filter roles by <project> (name or ID)
--user <user>-
Filter roles by <user> (name or ID)
openstack role remove
usage: openstack --os-auth-type token --os-identity-api-version 2 role remove [-h] --project <project> --user <user> <role>Remove role from project : user
Positional arguments
<role>-
Role to remove (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--project <project>-
Include <project> (name or ID)
--user <user>-
Include <user> (name or ID)
openstack role show
usage: openstack --os-auth-type token --os-identity-api-version 2 role show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<role>Display role details
Positional arguments
<role>-
Role to display (name or ID)
Optional arguments
-h, --help-
show this help message and exit
openstack security group create
usage: openstack --os-auth-type token --os-identity-api-version 2 security group create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--description <description>]
<name>Create a new security group
Positional arguments
<name>-
New security group name
Optional arguments
-h, --help-
show this help message and exit
--description <description>-
Security group description
openstack security group delete
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack security group list
usage: openstack --os-auth-type token --os-identity-api-version 2 security group list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--all-projects]List security groups
Optional arguments
-h, --help-
show this help message and exit
--all-projects-
Display information from all projects (admin only)
openstack security group rule create
usage: openstack --os-auth-type token --os-identity-api-version 2 security group rule create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--proto <proto>]
[--src-ip <ip-address>]
[--dst-port <port-range>]
<group>Create a new security group rule
Positional arguments
<group>-
Create rule in this security group (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--proto <proto>-
IP protocol (icmp, tcp, udp; default: tcp)
--src-ip <ip-address>-
Source IP (may use CIDR notation; default: 0.0.0.0/0)
--dst-port <port-range>-
Destination port, may be a range: 137:139 (default: 0; only required for proto tcp and udp)
openstack security group rule delete
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack security group rule list
usage: openstack --os-auth-type token --os-identity-api-version 2 security group rule list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
<group>List 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
openstack security group set
usage: openstack --os-auth-type token --os-identity-api-version 2 security group set [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--name <new-name>]
[--description <description>]
<group>Set security group properties
Positional arguments
<group>-
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
openstack security group show
usage: openstack --os-auth-type token --os-identity-api-version 2 security group show [-h]
[-f {html,json,json,shell,table,value,yaml,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
openstack server add security group
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack server add volume
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack server create
usage: openstack --os-auth-type token --os-identity-api-version 2 server create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
(--image <image> | --volume <volume>) --flavor
<flavor>
[--security-group <security-group-name>]
[--key-name <key-name>]
[--property <key=value>]
[--file <dest-filename=source-filename>]
[--user-data <user-data>]
[--availability-zone <zone-name>]
[--block-device-mapping <dev-name=mapping>]
[--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid>]
[--hint <key=value>]
[--config-drive <config-drive-volume>|True]
[--min <count>] [--max <count>] [--wait]
<server-name>Create a new server
Positional arguments
<server-name>-
New server name
Optional arguments
-h, --help-
show this help message and exit
--image <image>-
Create server from this image
--volume <volume>-
Create server from this volume
--flavor <flavor>-
Create server with this flavor
--security-group <security-group-name>-
Security group to assign to this server (repeat for multiple groups)
--key-name <key-name>-
Keypair to inject into this server (optional extension)
--property <key=value>-
Set a property on this server (repeat for multiple values)
--file <dest-filename=source-filename>-
File to inject into image before boot (repeat for multiple files)
--user-data <user-data>-
User data file to serve from the metadata server
--availability-zone <zone-name>-
Select an availability zone for the server
--block-device-mapping <dev-name=mapping>-
Map block devices; map is <id>:<type>:<size(GB)>:<delete_on_terminate> (optional extension)
--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,
v6-fixed-ip=ip-addr,port-id=port-uuid>-
Create a NIC on the server. Specify option multiple times to create multiple NICs. Either net-id or port-id must be provided, but not both. net-id: attach NIC to network with this UUID, port-id: attach NIC to port with this UUID, v4-fixed-ip: IPv4 fixed address for NIC (optional), v6-fixed-ip: IPv6 fixed address for NIC (optional).
--hint <key=value>-
Hints for the scheduler (optional extension)
--config-drive <config-drive-volume>|True-
Use specified volume as the config drive, or 'True' to use an ephemeral drive
--min <count>-
Minimum number of servers to launch (default=1)
--max <count>-
Maximum number of servers to launch (default=1)
--wait-
Wait for build to complete
openstack server delete
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack server image create
usage: openstack --os-auth-type token --os-identity-api-version 2 server image create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--name <image-name>] [--wait]
<server>Create a new disk image from a running server
Positional arguments
<server>-
Server (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--name <image-name>-
Name of new image (default is server name)
--wait-
Wait for image create to complete
openstack server list
usage: openstack --os-auth-type token --os-identity-api-version 2 server list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--reservation-id <reservation-id>]
[--ip <ip-address-regex>]
[--ip6 <ip-address-regex>] [--name <name-regex>]
[--instance-name <server-name>]
[--status <status>] [--flavor <flavor>]
[--image <image>] [--host <hostname>]
[--all-projects] [--project <project>]
[--project-domain <project-domain>]
[--user <user>] [--user-domain <user-domain>]
[--long] [--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
--image <image>-
Search by image
--host <hostname>-
Search by hostname
--all-projects-
Include all projects (admin only)
--project <project>-
Search by project (admin only) (name or ID)
--project-domain <project-domain>-
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
--user <user>-
Search by user (admin only) (name or ID)
--user-domain <user-domain>-
Domain the user belongs to (name or ID). This can be used in case collisions between user names exist.
--long-
List additional fields in output
--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.
openstack server lock
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack server migrate
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack server pause
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack server reboot
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack server rebuild
usage: openstack --os-auth-type token --os-identity-api-version 2 server rebuild [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] --image <image>
[--password <password>] [--wait]
<server>Rebuild server
Positional arguments
<server>-
Server (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--image <image>-
Recreate server from this image
--password <password>-
Set the password on the rebuilt instance
--wait-
Wait for rebuild to complete
openstack server remove security group
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack server remove volume
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack server rescue
usage: openstack --os-auth-type token --os-identity-api-version 2 server rescue [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<server>Put server in rescue mode
Positional arguments
<server>-
Server (name or ID)
Optional arguments
-h, --help-
show this help message and exit
openstack server resize
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack server resume
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack server set
usage: openstack --os-auth-type token --os-identity-api-version 2 server set [-h] [--name <new-name>] [--root-password]
[--property <key=value>]
<server>Set server properties
Positional arguments
<server>-
Server (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--name <new-name>-
New server name
--root-password-
Set new root password (interactive only)
--property <key=value>-
Property to add/change for this server (repeat option to set multiple properties)
openstack server shelve
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack server show
usage: openstack --os-auth-type token --os-identity-api-version 2 server show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--diagnostics]
<server>Show server details
Positional arguments
<server>-
Server (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--diagnostics-
Display server diagnostics information
openstack server ssh
usage: openstack --os-auth-type token --os-identity-api-version 2 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)
openstack server start
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack server stop
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack server suspend
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack server unlock
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack server unpause
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack server unrescue
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack server unset
usage: openstack --os-auth-type token --os-identity-api-version 2 server unset [-h] [--property <key>] <server>Unset server properties
Positional arguments
<server>-
Server (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--property <key>-
Property key to remove from server (repeat to unset multiple values)
openstack server unshelve
usage: openstack --os-auth-type token --os-identity-api-version 2 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
openstack service create
usage: openstack --os-auth-type token --os-identity-api-version 2 service create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] [--name <name>]
[--description <description>]
<type>Create new service
Positional arguments
<type>-
New service type (compute, image, identity, volume, etc)
Optional arguments
-h, --help-
show this help message and exit
--name <name>-
New service name
--description <description>-
New service description
openstack service delete
usage: openstack --os-auth-type token --os-identity-api-version 2 service delete [-h] <service>Delete service
Positional arguments
<service>-
Service to delete (name or ID)
Optional arguments
-h, --help-
show this help message and exit
openstack service list
usage: openstack --os-auth-type token --os-identity-api-version 2 service list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--long]List services
Optional arguments
-h, --help-
show this help message and exit
--long-
List additional fields in output
openstack service show
usage: openstack --os-auth-type token --os-identity-api-version 2 service show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--catalog]
<service>Display service details
Positional arguments
<service>-
Service to display (type, name or ID)
Optional arguments
-h, --help-
show this help message and exit
--catalog-
Show service catalog information
openstack snapshot create
usage: openstack --os-auth-type token --os-identity-api-version 2 snapshot create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] --name <name>
[--description <description>] [--force]
<volume>Create new snapshot
Positional arguments
<volume>-
Volume to snapshot (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--name <name>-
Name of the snapshot
--description <description>-
Description of the snapshot
--force-
Create a snapshot attached to an instance. Default is False
openstack snapshot delete
usage: openstack --os-auth-type token --os-identity-api-version 2 snapshot delete [-h] <snapshot> [<snapshot> ...]Delete snapshot(s)
Positional arguments
<snapshot>-
Snapshot(s) to delete (name or ID)
Optional arguments
-h, --help-
show this help message and exit
openstack snapshot list
usage: openstack --os-auth-type token --os-identity-api-version 2 snapshot list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--all-projects] [--long]List snapshots
Optional arguments
-h, --help-
show this help message and exit
--all-projects-
Include all projects (admin only)
--long-
List additional fields in output
openstack snapshot set
usage: openstack --os-auth-type token --os-identity-api-version 2 snapshot set [-h] [--name <name>]
[--description <description>]
[--property <key=value>]
<snapshot>Set snapshot properties
Positional arguments
<snapshot>-
Snapshot to modify (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--name <name>-
New snapshot name
--description <description>-
New snapshot description
--property <key=value>-
Property to add/change for this snapshot (repeat option to set multiple properties)
openstack snapshot show
usage: openstack --os-auth-type token --os-identity-api-version 2 snapshot show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<snapshot>Display snapshot details
Positional arguments
<snapshot>-
Snapshot to display (name or ID)
Optional arguments
-h, --help-
show this help message and exit
openstack snapshot unset
usage: openstack --os-auth-type token --os-identity-api-version 2 snapshot unset [-h] --property <key> <snapshot>Unset snapshot properties
Positional arguments
<snapshot>-
Snapshot to modify (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--property <key>-
Property to remove from snapshot (repeat to remove multiple values)
openstack tld create
usage: openstack --os-auth-type token --os-identity-api-version 2 tld create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] --name NAME
[--description DESCRIPTION]Create new tld
Optional arguments
-h, --help-
show this help message and exit
--name NAME-
TLD Name
--description DESCRIPTION-
Description
openstack tld delete
usage: openstack --os-auth-type token --os-identity-api-version 2 tld delete [-h] idDelete tld
Positional arguments
id-
TLD ID
Optional arguments
-h, --help-
show this help message and exit
openstack tld list
usage: openstack --os-auth-type token --os-identity-api-version 2 tld list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]List tlds
Optional arguments
-h, --help-
show this help message and exit
openstack tld set
usage: openstack --os-auth-type token --os-identity-api-version 2 tld set [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION | --no-description]
idSet tld properties
Positional arguments
id-
TLD ID
Optional arguments
-h, --help-
show this help message and exit
--name NAME-
TLD Name
--description DESCRIPTION-
Description
--no-description
openstack tld show
usage: openstack --os-auth-type token --os-identity-api-version 2 tld show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
idShow tld details
Positional arguments
id-
TLD ID
Optional arguments
-h, --help-
show this help message and exit
openstack token issue
usage: openstack --os-auth-type token --os-identity-api-version 2 token issue [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]Issue new token
Optional arguments
-h, --help-
show this help message and exit
openstack token revoke
usage: openstack --os-auth-type token --os-identity-api-version 2 token revoke [-h] <token>Revoke existing token
Positional arguments
<token>-
Token to be deleted
Optional arguments
-h, --help-
show this help message and exit
openstack usage list
usage: openstack --os-auth-type token --os-identity-api-version 2 usage list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--start <start>] [--end <end>]List resource usage per project
Optional arguments
-h, --help-
show this help message and exit
--start <start>-
Usage range start date, ex 2012-01-20 (default: 4 weeks ago)
--end <end>-
Usage range end date, ex 2012-01-20 (default: tomorrow)
openstack usage show
usage: openstack --os-auth-type token --os-identity-api-version 2 usage show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--project <project>]
[--start <start>] [--end <end>]Show resource usage for a single project
Optional arguments
-h, --help-
show this help message and exit
--project <project>-
Name or ID of project to show usage for
--start <start>-
Usage range start date, ex 2012-01-20 (default: 4 weeks ago)
--end <end>-
Usage range end date, ex 2012-01-20 (default: tomorrow)
openstack user create
usage: openstack --os-auth-type token --os-identity-api-version 2 user create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--project <project>]
[--password <password>] [--password-prompt]
[--email <email-address>] [--enable | --disable]
[--or-show]
<name>Create new user
Positional arguments
<name>-
New user name
Optional arguments
-h, --help-
show this help message and exit
--project <project>-
Default project (name or ID)
--password <password>-
Set user password
--password-prompt-
Prompt interactively for password
--email <email-address>-
Set user email address
--enable-
Enable user (default)
--disable-
Disable user
--or-show-
Return existing user
openstack user delete
usage: openstack --os-auth-type token --os-identity-api-version 2 user delete [-h] <user> [<user> ...]Delete user(s)
Positional arguments
<user>-
User(s) to delete (name or ID)
Optional arguments
-h, --help-
show this help message and exit
openstack user list
usage: openstack --os-auth-type token --os-identity-api-version 2 user list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--project <project>] [--long]List users
Optional arguments
-h, --help-
show this help message and exit
--project <project>-
Filter users by project (name or ID)
--long-
List additional fields in output
openstack user role list
usage: openstack --os-auth-type token --os-identity-api-version 2 user role list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--project <project>]
[<user>]List user-role assignments
Positional arguments
<user>-
User to list (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--project <project>-
Filter users by <project> (name or ID)
openstack user set
usage: openstack --os-auth-type token --os-identity-api-version 2 user set [-h] [--name <name>] [--project <project>]
[--password <user-password>] [--password-prompt]
[--email <email-address>] [--enable | --disable]
<user>Set user properties
Positional arguments
<user>-
User to change (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--name <name>-
Set user name
--project <project>-
Set default project (name or ID)
--password <user-password>-
Set user password
--password-prompt-
Prompt interactively for password
--email <email-address>-
Set user email address
--enable-
Enable user (default)
--disable-
Disable user
openstack user show
usage: openstack --os-auth-type token --os-identity-api-version 2 user show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<user>Display user details
Positional arguments
<user>-
User to display (name or ID)
Optional arguments
-h, --help-
show this help message and exit
openstack volume create
usage: openstack --os-auth-type token --os-identity-api-version 2 volume create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] --size <size>
[--snapshot <snapshot>]
[--description <description>]
[--type <volume-type>] [--user <user>]
[--project <project>]
[--availability-zone <availability-zone>]
[--image <image>] [--source <volume>]
[--property <key=value>]
<name>Create new volume
Positional arguments
<name>-
New volume name
Optional arguments
-h, --help-
show this help message and exit
--size <size>-
New volume size in GB
--snapshot <snapshot>-
Use <snapshot> as source of new volume
--description <description>-
New volume description
--type <volume-type>-
Use <volume-type> as the new volume type
--user <user>-
Specify an alternate user (name or ID)
--project <project>-
Specify an alternate project (name or ID)
--availability-zone <availability-zone>-
Create new volume in <availability-zone>
--image <image>-
Use <image> as source of new volume (name or ID)
--source <volume>-
Volume to clone (name or ID)
--property <key=value>-
Set a property on this volume (repeat option to set multiple properties)
openstack volume delete
usage: openstack --os-auth-type token --os-identity-api-version 2 volume delete [-h] [--force] <volume> [<volume> ...]Delete volume(s)
Positional arguments
<volume>-
Volume(s) to delete (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--force-
Attempt forced removal of volume(s), regardless of state (defaults to False)
openstack volume list
usage: openstack --os-auth-type token --os-identity-api-version 2 volume list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--name <name>] [--status <status>]
[--all-projects] [--long]List volumes
Optional arguments
-h, --help-
show this help message and exit
--name <name>-
Filter results by volume name
--status <status>-
Filter results by status
--all-projects-
Include all projects (admin only)
--long-
List additional fields in output
openstack volume qos associate
usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos associate [-h] <qos-spec> <volume-type>Associate a QoS specification to a volume type
Positional arguments
<qos-spec>-
QoS specification to modify (name or ID)
<volume-type>-
Volume type to associate the QoS (name or ID)
Optional arguments
-h, --help-
show this help message and exit
openstack volume qos create
usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--consumer <consumer>]
[--property <key=value>]
<name>Create new QoS specification
Positional arguments
<name>-
New QoS specification name
Optional arguments
-h, --help-
show this help message and exit
--consumer <consumer>-
Consumer of the QoS. Valid consumers: back-end, both, front-end (defaults to 'both')
--property <key=value>-
Set a QoS specification property (repeat option to set multiple properties)
openstack volume qos delete
usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos delete [-h] <qos-spec> [<qos-spec> ...]Delete QoS specification
Positional arguments
<qos-spec>-
QoS specification(s) to delete (name or ID)
Optional arguments
-h, --help-
show this help message and exit
openstack volume qos disassociate
usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos disassociate [-h]
[--volume-type <volume-type> | --all]
<qos-spec>Disassociate a QoS specification from a volume type
Positional arguments
<qos-spec>-
QoS specification to modify (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--volume-type <volume-type>-
Volume type to disassociate the QoS from (name or ID)
--all-
Disassociate the QoS from every volume type
openstack volume qos list
usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]List QoS specifications
Optional arguments
-h, --help-
show this help message and exit
openstack volume qos set
usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos set [-h] [--property <key=value>] <qos-spec>Set QoS specification properties
Positional arguments
<qos-spec>-
QoS specification to modify (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--property <key=value>-
Property to add or modify for this QoS specification (repeat option to set multiple properties)
openstack volume qos show
usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<qos-spec>Display QoS specification details
Positional arguments
<qos-spec>-
QoS specification to display (name or ID)
Optional arguments
-h, --help-
show this help message and exit
openstack volume qos unset
usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos unset [-h] [--property <key>] <qos-spec>Unset QoS specification properties
Positional arguments
<qos-spec>-
QoS specification to modify (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--property <key>-
Property to remove from the QoS specification. (repeat option to unset multiple properties)
openstack volume set
usage: openstack --os-auth-type token --os-identity-api-version 2 volume set [-h] [--name <name>] [--description <description>]
[--size <size>] [--property <key=value>]
<volume>Set volume properties
Positional arguments
<volume>-
Volume to change (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--name <name>-
New volume name
--description <description>-
New volume description
--size <size>-
Extend volume size in GB
--property <key=value>-
Property to add or modify for this volume (repeat option to set multiple properties)
openstack volume show
usage: openstack --os-auth-type token --os-identity-api-version 2 volume show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<volume>Show volume details
Positional arguments
<volume>-
Volume to display (name or ID)
Optional arguments
-h, --help-
show this help message and exit
openstack volume type create
usage: openstack --os-auth-type token --os-identity-api-version 2 volume type create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--property <key=value>]
<name>Create new volume type
Positional arguments
<name>-
New volume type name
Optional arguments
-h, --help-
show this help message and exit
--property <key=value>-
Property to add for this volume type (repeat option to set multiple properties)
openstack volume type delete
usage: openstack --os-auth-type token --os-identity-api-version 2 volume type delete [-h] <volume-type>Delete volume type
Positional arguments
<volume-type>-
Volume type to delete (name or ID)
Optional arguments
-h, --help-
show this help message and exit
openstack volume type list
usage: openstack --os-auth-type token --os-identity-api-version 2 volume type list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long]List volume types
Optional arguments
-h, --help-
show this help message and exit
--long-
List additional fields in output
openstack volume type set
usage: openstack --os-auth-type token --os-identity-api-version 2 volume type set [-h] [--property <key=value>] <volume-type>Set volume type properties
Positional arguments
<volume-type>-
Volume type to modify (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--property <key=value>-
Property to add or modify for this volume type (repeat option to set multiple properties)
openstack volume type show
usage: openstack --os-auth-type token --os-identity-api-version 2 volume type show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<volume-type>Display volume type details
Positional arguments
<volume-type>-
Volume type to display (name or ID)
Optional arguments
-h, --help-
show this help message and exit
openstack volume type unset
usage: openstack --os-auth-type token --os-identity-api-version 2 volume type unset [-h] --property <key> <volume-type>Unset volume type properties
Positional arguments
<volume-type>-
Volume type to modify (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--property <key>-
Property to remove from volume type (repeat option to remove multiple properties)
openstack volume unset
usage: openstack --os-auth-type token --os-identity-api-version 2 volume unset [-h] --property <key> <volume>Unset volume properties
Positional arguments
<volume>-
Volume to modify (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--property <key>-
Property to remove from volume (repeat option to remove multiple properties)
openstack zone abandon
usage: openstack --os-auth-type token --os-identity-api-version 2 zone abandon [-h] idAbandon a zone
Positional arguments
id-
Zone ID
Optional arguments
-h, --help-
show this help message and exit
openstack zone axfr
usage: openstack --os-auth-type token --os-identity-api-version 2 zone axfr [-h] idAXFR a zone
Positional arguments
id-
Zone ID
Optional arguments
-h, --help-
show this help message and exit
openstack zone blacklist create
usage: openstack --os-auth-type token --os-identity-api-version 2 zone blacklist create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
--pattern PATTERN
[--description DESCRIPTION]Create new blacklist
Optional arguments
-h, --help-
show this help message and exit
--pattern PATTERN-
Blacklist pattern
--description DESCRIPTION-
Description
openstack zone blacklist delete
usage: openstack --os-auth-type token --os-identity-api-version 2 zone blacklist delete [-h] idDelete blacklist
Positional arguments
id-
Blacklist ID
Optional arguments
-h, --help-
show this help message and exit
openstack zone blacklist list
usage: openstack --os-auth-type token --os-identity-api-version 2 zone blacklist list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]List blacklists
Optional arguments
-h, --help-
show this help message and exit
openstack zone blacklist set
usage: openstack --os-auth-type token --os-identity-api-version 2 zone blacklist set [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] --pattern
PATTERN
[--description DESCRIPTION | --no-description]
idSet blacklist properties
Positional arguments
id-
Blacklist ID
Optional arguments
-h, --help-
show this help message and exit
--pattern PATTERN-
Blacklist pattern
--description DESCRIPTION-
Description
--no-description
openstack zone blacklist show
usage: openstack --os-auth-type token --os-identity-api-version 2 zone blacklist show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
idShow blacklist details
Positional arguments
id-
Blacklist ID
Optional arguments
-h, --help-
show this help message and exit
openstack zone create
usage: openstack --os-auth-type token --os-identity-api-version 2 zone create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--email EMAIL] [--type TYPE]
[--ttl TTL] [--description DESCRIPTION]
[--masters MASTERS [MASTERS ...]]
nameCreate new zone
Positional arguments
name-
Zone Name
Optional arguments
-h, --help-
show this help message and exit
--email EMAIL-
Zone Email
--type TYPE-
Zone Type
--ttl TTL-
Time To Live (Seconds)
--description DESCRIPTION-
Description
--masters MASTERS [MASTERS ...]-
Zone Masters
openstack zone delete
usage: openstack --os-auth-type token --os-identity-api-version 2 zone delete [-h] idDelete zone
Positional arguments
id-
Zone ID
Optional arguments
-h, --help-
show this help message and exit
openstack zone list
usage: openstack --os-auth-type token --os-identity-api-version 2 zone list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--type TYPE]List zones
Optional arguments
-h, --help-
show this help message and exit
--type TYPE-
Zone Type
openstack zone set
usage: openstack --os-auth-type token --os-identity-api-version 2 zone set [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME] [--email EMAIL]
[--ttl TTL]
[--description DESCRIPTION | --no-description]
[--masters MASTERS [MASTERS ...]]
idSet zone properties
Positional arguments
id-
Zone ID
Optional arguments
-h, --help-
show this help message and exit
--name NAME-
Zone Name
--email EMAIL-
Zone Email
--ttl TTL-
Time To Live (Seconds)
--description DESCRIPTION-
Description
--no-description
--masters MASTERS [MASTERS ...]-
Zone Masters
openstack zone show
usage: openstack --os-auth-type token --os-identity-api-version 2 zone show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
idShow zone details
Positional arguments
id-
Zone ID
Optional arguments
-h, --help-
show this help message and exit
openstack zone transfer accept request
usage: openstack --os-auth-type token --os-identity-api-version 2 zone transfer accept request [-h] --transfer-id TRANSFER_ID
--key KEYAccept a Zone Transfer Request
Optional arguments
-h, --help-
show this help message and exit
--transfer-id TRANSFER_ID-
Transfer ID
--key KEY-
Transfer Key
openstack zone transfer accept show
usage: openstack --os-auth-type token --os-identity-api-version 2 zone transfer accept show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
idShow Zone Transfer Accept
Positional arguments
id-
Zone Tranfer Accept ID
Optional arguments
-h, --help-
show this help message and exit
openstack zone transfer request create
usage: openstack --os-auth-type token --os-identity-api-version 2 zone transfer request create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
--target-project-id
TARGET_PROJECT_ID
[--description DESCRIPTION]
zone_idCreate new zone transfer request
Positional arguments
zone_id-
Zone ID to transfer.
Optional arguments
-h, --help-
show this help message and exit
--target-project-id TARGET_PROJECT_ID-
Target Project ID to transfer to.
--description DESCRIPTION-
Description
openstack zone transfer request delete
usage: openstack --os-auth-type token --os-identity-api-version 2 zone transfer request delete [-h] idPositional arguments
id-
Zone Transfer ID
Optional arguments
-h, --help-
show this help message and exit
openstack zone transfer request list
usage: openstack --os-auth-type token --os-identity-api-version 2 zone transfer request list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]List zone transfer requests
Optional arguments
-h, --help-
show this help message and exit
openstack zone transfer request set
usage: openstack --os-auth-type token --os-identity-api-version 2 zone transfer request set [-h]
[--description DESCRIPTION | --no-description]
idSet Transfer
Positional arguments
id-
Zone Transfer ID
Optional arguments
-h, --help-
show this help message and exit
--description DESCRIPTION-
Description
--no-description
openstack zone transfer request show
usage: openstack --os-auth-type token --os-identity-api-version 2 zone transfer request show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
idShow zonet transfer details
Positional arguments
id-
Zone Tranfer ID
Optional arguments
-h, --help-
show this help message and exit
OpenStack with Identity API v3 commands (diff)
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=3This section documents only the difference in subcommands available for the openstack client when the Identity API version is changed from v2 to v3.
openstack access token create (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 access token create [-h]
[-f {html,json,json,shell,table,value,yaml,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)
openstack consumer create (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 consumer create [-h]
[-f {html,json,json,shell,table,value,yaml,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
openstack consumer delete (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 consumer delete [-h] <consumer>Delete consumer
Positional arguments
<consumer>-
Consumer to delete
Optional arguments
-h, --help-
show this help message and exit
openstack consumer list (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 consumer list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]List consumers
Optional arguments
-h, --help-
show this help message and exit
openstack consumer set (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 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
openstack consumer show (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 consumer show [-h]
[-f {html,json,json,shell,table,value,yaml,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
openstack credential create (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 credential create [-h]
[-f {html,json,json,shell,table,value,yaml,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
openstack credential delete (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 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
openstack credential list (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 credential list [-h]
[-f {csv,html,json,json,table,value,yaml,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
openstack credential set (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 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
openstack credential show (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 credential show [-h]
[-f {html,json,json,shell,table,value,yaml,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
openstack domain create (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 domain create [-h]
[-f {html,json,json,shell,table,value,yaml,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
openstack domain delete (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 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
openstack domain list (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 domain list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]List domains
Optional arguments
-h, --help-
show this help message and exit
openstack domain set (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 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
openstack domain show (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 domain show [-h]
[-f {html,json,json,shell,table,value,yaml,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
openstack endpoint set (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 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
openstack federation domain list (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 federation domain list [-h]
[-f {csv,html,json,json,table,value,yaml,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
openstack federation project list (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 federation project list [-h]
[-f {csv,html,json,json,table,value,yaml,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
openstack federation protocol create (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 federation protocol create [-h]
[-f {html,json,json,shell,table,value,yaml,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)
openstack federation protocol delete (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 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)
openstack federation protocol list (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 federation protocol list [-h]
[-f {csv,html,json,json,table,value,yaml,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)
openstack federation protocol set (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 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)
openstack federation protocol show (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 federation protocol show [-h]
[-f {html,json,json,shell,table,value,yaml,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)
openstack group add user (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 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.
openstack group contains user (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 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.
openstack group create (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 group create [-h]
[-f {html,json,json,shell,table,value,yaml,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
openstack group delete (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 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)
openstack group list (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 group list [-h]
[-f {csv,html,json,json,table,value,yaml,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
openstack group remove user (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 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.
openstack group set (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 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
openstack group show (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 group show [-h]
[-f {html,json,json,shell,table,value,yaml,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)
openstack identity provider create (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 identity provider create [-h]
[-f {html,json,json,shell,table,value,yaml,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 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
openstack identity provider delete (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 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
openstack identity provider list (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 identity provider list [-h]
[-f {csv,html,json,json,table,value,yaml,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
openstack identity provider set (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 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 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
openstack identity provider show (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 identity provider show [-h]
[-f {html,json,json,shell,table,value,yaml,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
openstack mapping create (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 mapping create [-h]
[-f {html,json,json,shell,table,value,yaml,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)
openstack mapping delete (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 mapping delete [-h] <mapping>Delete mapping
Positional arguments
<mapping>-
Mapping to delete
Optional arguments
-h, --help-
show this help message and exit
openstack mapping list (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 mapping list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]List mappings
Optional arguments
-h, --help-
show this help message and exit
openstack mapping set (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 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
openstack mapping show (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 mapping show [-h]
[-f {html,json,json,shell,table,value,yaml,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
openstack policy create (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 policy create [-h]
[-f {html,json,json,shell,table,value,yaml,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)
openstack policy delete (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 policy delete [-h] <policy>Delete policy
Positional arguments
<policy>-
Policy to delete
Optional arguments
-h, --help-
show this help message and exit
openstack policy list (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 policy list [-h]
[-f {csv,html,json,json,table,value,yaml,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
openstack policy set (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 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
openstack policy show (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 policy show [-h]
[-f {html,json,json,shell,table,value,yaml,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
openstack region create (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 region create [-h]
[-f {html,json,json,shell,table,value,yaml,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
openstack region delete (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 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
openstack region list (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 region list [-h]
[-f {csv,html,json,json,table,value,yaml,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
openstack region set (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 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
openstack region show (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 region show [-h]
[-f {html,json,json,shell,table,value,yaml,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
openstack request token authorize (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 request token authorize [-h]
[-f {html,json,json,shell,table,value,yaml,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 to set multiple values) (required)
openstack request token create (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 request token create [-h]
[-f {html,json,json,shell,table,value,yaml,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)
openstack role assignment list (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 role assignment list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--effective] [--role <role>]
[--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)
--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
openstack role set (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 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
openstack service provider create (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 service provider create [-h]
[-f {html,json,json,shell,table,value,yaml,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
openstack service provider delete (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 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
openstack service provider list (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 service provider list [-h]
[-f {csv,html,json,json,table,value,yaml,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
openstack service provider set (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 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
openstack service provider show (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 service provider show [-h]
[-f {html,json,json,shell,table,value,yaml,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
openstack service set (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 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
openstack trust create (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 trust create [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] --project <project> --role
<role> [--impersonate]
[--expiration <expiration>]
[--project-domain <project-domain>]
[--trustor-domain <trustor-domain>]
[--trustee-domain <trustee-domain>]
<trustor-user> <trustee-user>Create new trust
Positional arguments
<trustor-user>-
User that is delegating authorization (name or ID)
<trustee-user>-
User that is assuming authorization (name or ID)
Optional arguments
-h, --help-
show this help message and exit
--project <project>-
Project being delegated (name or ID) (required)
--role <role>-
Roles to authorize (name or ID) (repeat to set multiple values) (required)
--impersonate-
Tokens generated from the trust will represent <trustor> (defaults to False)
--expiration <expiration>-
Sets an expiration date for the trust (format of YYYY-mm-ddTHH:MM:SS)
--project-domain <project-domain>-
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
--trustor-domain <trustor-domain>-
Domain that contains <trustor> (name or ID)
--trustee-domain <trustee-domain>-
Domain that contains <trustee> (name or ID)
openstack trust delete (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 trust delete [-h] <trust> [<trust> ...]Delete trust(s)
Positional arguments
<trust>-
Trust(s) to delete
Optional arguments
-h, --help-
show this help message and exit
openstack trust list (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 trust list [-h]
[-f {csv,html,json,json,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]List trusts
Optional arguments
-h, --help-
show this help message and exit
openstack trust show (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 trust show [-h]
[-f {html,json,json,shell,table,value,yaml,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<trust>Display trust details
Positional arguments
<trust>-
Trust to display
Optional arguments
-h, --help-
show this help message and exit
openstack user password set (Identity API v3)
usage: openstack --os-auth-type token --os-identity-api-version 3 user password set [-h] [--password <new-password>]Change current user password
Optional arguments
-h, --help-
show this help message and exit
--password <new-password>-
New user password