-
Language:
English
-
Language:
English
Red Hat Training
A Red Hat training course is available for Red Hat OpenStack Platform
Chapter 3. OpenStack command-line client
1.7.2
.
$
openstack
help
COMMAND
3.1. openstack usage
usage: openstack [--version] [-v] [--log-file LOG_FILE] [-q] [-h] [--debug] [--os-cloud <cloud-config-name>] [--os-region-name <auth-region-name>] [--os-cacert <ca-bundle-file>] [--verify | --insecure] [--os-default-domain <auth-domain>] [--os-interface <interface>] [--timing] [--os-compute-api-version <compute-api-version>] [--os-network-api-version <network-api-version>] [--os-image-api-version <image-api-version>] [--os-volume-api-version <volume-api-version>] [--os-identity-api-version <identity-api-version>] [--os-auth-type <auth-type>] [--os-project-domain-id <auth-project-domain-id>] [--os-protocol <auth-protocol>] [--os-project-name <auth-project-name>] [--os-trust-id <auth-trust-id>] [--os-service-provider-endpoint <auth-service-provider-endpoint>] [--os-domain-name <auth-domain-name>] [--os-user-domain-id <auth-user-domain-id>] [--os-identity-provider-url <auth-identity-provider-url>] [--os-access-token-endpoint <auth-access-token-endpoint>] [--os-domain-id <auth-domain-id>] [--os-user-domain-name <auth-user-domain-name>] [--os-scope <auth-scope>] [--os-user-id <auth-user-id>] [--os-identity-provider <auth-identity-provider>] [--os-username <auth-username>] [--os-auth-url <auth-auth-url>] [--os-client-secret <auth-client-secret>] [--os-client-id <auth-client-id>] [--os-project-domain-name <auth-project-domain-name>] [--os-password <auth-password>] [--os-endpoint <auth-endpoint>] [--os-url <auth-url>] [--os-token <auth-token>] [--os-project-id <auth-project-id>] [--os-object-api-version <object-api-version>] [--inspector-api-version INSPECTOR_API_VERSION] [--inspector-url INSPECTOR_URL] [--os-tripleoclient-api-version <tripleoclient-api-version>] [--os-data-processing-api-version <data-processing-api-version>] [--os-dns-api-version <dns-api-version>]
3.2. openstack optional arguments
- --version
- show program's version number and exit
- -v, --verbose
- Increase verbosity of output. Can be repeated.
- --log-file LOG_FILE
- Specify a file to log output. Disabled by default.
- -q, --quiet
- Suppress output except warnings and errors.
- -h, --help
- Show help message and exit.
- --debug
- Show tracebacks on errors.
- --os-cloud <cloud-config-name>
- Cloud name in clouds.yaml (Env: OS_CLOUD)
- --os-region-name <auth-region-name>
- Authentication region name (Env: OS_REGION_NAME)
- --os-cacert <ca-bundle-file>
- CA certificate bundle file (Env: OS_CACERT)
- --verify
- Verify server certificate (default)
- --insecure
- Disable server certificate verification
- --os-default-domain <auth-domain>
- Default domain ID, default=default (Env: OS_DEFAULT_DOMAIN)
- --os-interface <interface>
- Select an interface type. Valid interface types: [admin, public, internal]. (Env: OS_INTERFACE)
- --timing
- Print API call timing info
- --os-compute-api-version <compute-api-version>
- Compute API version, default=2 (Env: OS_COMPUTE_API_VERSION)
- --os-network-api-version <network-api-version>
- Network API version, default=2 (Env: OS_NETWORK_API_VERSION)
- --os-image-api-version <image-api-version>
- Image API version, default=1 (Env: OS_IMAGE_API_VERSION)
- --os-volume-api-version <volume-api-version>
- Volume API version, default=2 (Env: OS_VOLUME_API_VERSION)
- --os-identity-api-version <identity-api-version>
- Identity API version, default=2 (Env: OS_IDENTITY_API_VERSION)
- --os-auth-type <auth-type>
- Select an authentication type. Available types: v2token, admin_token, v2password, v3password, v3scopedsaml, v3oidcpassword, v3unscopedadfs, token, v3token, password, v3unscopedsaml, osc_password, token_endpoint. Default: selected based on --os- username/--os-token (Env: OS_AUTH_TYPE)
- --os-project-domain-id <auth-project-domain-id>
- With v3password: Domain ID containing project With v3scopedsaml: Domain ID containing project With v3oidcpassword: Domain ID containing project With v3unscopedadfs: Domain ID containing project With token: Domain ID containing project With v3token: Domain ID containing project With password: Domain ID containing project With v3unscopedsaml: Domain ID containing project With osc_password: Domain ID containing project (Env: OS_PROJECT_DOMAIN_ID)
- --os-protocol <auth-protocol>
- With v3oidcpassword: Name of the federated protocol used for federated authentication. Must match its counterpart name configured at the keystone service provider. Typically values would be 'saml2' or 'oidc'. (Env: OS_PROTOCOL)
- --os-project-name <auth-project-name>
- With v3password: Project name to scope to With v3scopedsaml: Project name to scope to With v3oidcpassword: Project name to scope to With v3unscopedadfs: Project name to scope to With token: Project name to scope to With v3token: Project name to scope to With password: Project name to scope to With v3unscopedsaml: Project name to scope to With osc_password: Project name to scope to (Env: OS_PROJECT_NAME)
- --os-trust-id <auth-trust-id>
- With v2token: Trust ID With v2password: Trust ID With v3password: Trust ID With v3scopedsaml: Trust ID With v3oidcpassword: Trust ID With v3unscopedadfs: Trust ID With token: Trust ID With v3token: Trust ID With password: Trust ID With v3unscopedsaml: Trust ID With osc_password: Trust ID (Env: OS_TRUST_ID)
- --os-service-provider-endpoint <auth-service-provider-endpoint>
- With v3unscopedadfs: Service Provider's Endpoint (Env: OS_SERVICE_PROVIDER_ENDPOINT)
- --os-domain-name <auth-domain-name>
- With v3password: Domain name to scope to With v3scopedsaml: Domain name to scope to With v3oidcpassword: Domain name to scope to With v3unscopedadfs: Domain name to scope to With token: Domain name to scope to With v3token: Domain name to scope to With password: Domain name to scope to With v3unscopedsaml: Domain name to scope to With osc_password: Domain name to scope to (Env: OS_DOMAIN_NAME)
- --os-user-domain-id <auth-user-domain-id>
- With v3password: User's domain id With password: User's domain id With osc_password: User's domain id (Env: OS_USER_DOMAIN_ID)
- --os-identity-provider-url <auth-identity-provider-url>
- With v3unscopedadfs: Identity Provider's URL With v3unscopedsaml: Identity Provider's URL (Env: OS_IDENTITY_PROVIDER_URL)
- --os-access-token-endpoint <auth-access-token-endpoint>
- With v3oidcpassword: OpenID Connect Provider Token Endpoint (Env: OS_ACCESS_TOKEN_ENDPOINT)
- --os-domain-id <auth-domain-id>
- With v3password: Domain ID to scope to With v3scopedsaml: Domain ID to scope to With v3oidcpassword: Domain ID to scope to With v3unscopedadfs: Domain ID to scope to With token: Domain ID to scope to With v3token: Domain ID to scope to With password: Domain ID to scope to With v3unscopedsaml: Domain ID to scope to With osc_password: Domain ID to scope to (Env: OS_DOMAIN_ID)
- --os-user-domain-name <auth-user-domain-name>
- With v3password: User's domain name With password: User's domain name With osc_password: User's domain name (Env: OS_USER_DOMAIN_NAME)
- --os-scope <auth-scope>
- With v3oidcpassword: OpenID Connect scope that is requested from OP (Env: OS_SCOPE)
- --os-user-id <auth-user-id>
- With v2password: User ID to login with With v3password: User ID With password: User id With osc_password: User id (Env: OS_USER_ID)
- --os-identity-provider <auth-identity-provider>
- With v3oidcpassword: Identity Provider's name With v3unscopedadfs: Identity Provider's name With v3unscopedsaml: Identity Provider's name (Env: OS_IDENTITY_PROVIDER)
- --os-username <auth-username>
- With v2password: Username to login with With v3password: Username With v3oidcpassword: Username With v3unscopedadfs: Username With password: Username With v3unscopedsaml: Username With osc_password: Username (Env: OS_USERNAME)
- --os-auth-url <auth-auth-url>
- With v2token: Authentication URL With v2password: Authentication URL With v3password: Authentication URL With v3scopedsaml: Authentication URL With v3oidcpassword: Authentication URL With v3unscopedadfs: Authentication URL With token: Authentication URL With v3token: Authentication URL With password: Authentication URL With v3unscopedsaml: Authentication URL With osc_password: Authentication URL (Env: OS_AUTH_URL)
- --os-client-secret <auth-client-secret>
- With v3oidcpassword: OAuth 2.0 Client Secret (Env: OS_CLIENT_SECRET)
- --os-client-id <auth-client-id>
- With v3oidcpassword: OAuth 2.0 Client ID (Env: OS_CLIENT_ID)
- --os-project-domain-name <auth-project-domain-name>
- With v3password: Domain name containing project With v3scopedsaml: Domain name containing project With v3oidcpassword: Domain name containing project With v3unscopedadfs: Domain name containing project With token: Domain name containing project With v3token: Domain name containing project With password: Domain name containing project With v3unscopedsaml: Domain name containing project With osc_password: Domain name containing project (Env: OS_PROJECT_DOMAIN_NAME)
- --os-password <auth-password>
- With v2password: Password to use With v3password: User's password With v3oidcpassword: Password With v3unscopedadfs: Password With password: User's password With v3unscopedsaml: Password With osc_password: User's password (Env: OS_PASSWORD)
- --os-endpoint <auth-endpoint>
- With admin_token: The endpoint that will always be used With token_endpoint: The endpoint that will always be used (Env: OS_ENDPOINT)
- --os-url <auth-url>
- With token_endpoint: Specific service endpoint to use (Env: OS_URL)
- --os-token <auth-token>
- With v2token: Token With admin_token: The token that will always be used With v3scopedsaml: Token to authenticate with With token: Token to authenticate with With v3token: Token to authenticate with With token_endpoint: The token that will always be used With token_endpoint: Authentication token to use (Env: OS_TOKEN)
- --os-project-id <auth-project-id>
- With v3password: Project ID to scope to With v3scopedsaml: Project ID to scope to With v3oidcpassword: Project ID to scope to With v3unscopedadfs: Project ID to scope to With token: Project ID to scope to With v3token: Project ID to scope to With password: Project ID to scope to With v3unscopedsaml: Project ID to scope to With osc_password: Project ID to scope to (Env: OS_PROJECT_ID)
- --os-object-api-version <object-api-version>
- Object API version, default=1 (Env: OS_OBJECT_API_VERSION)
- --inspector-api-version INSPECTOR_API_VERSION
- inspector API version, only 1 is supported now (env: INSPECTOR_VERSION).
- --inspector-url INSPECTOR_URL
- inspector URL, defaults to localhost (env: INSPECTOR_URL).
- --os-tripleoclient-api-version <tripleoclient-api-version>
- TripleO Client API version, default=1 (Env: OS_TRIPLEOCLIENT_API_VERSION)
- --os-data-processing-api-version <data-processing-api-version>
- Data processing API version, default=1.1 (Env: OS_DATA_PROCESSING_API_VERSION)
- --os-dns-api-version <dns-api-version>
- DNS API version, default=2 (Env: OS_DNS_API_VERSION)
3.3. Subcommands
3.3.1. openstack aggregate add host
usage: openstack aggregate add host [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <aggregate> <host>
Positional arguments
- <aggregate>
- Aggregate (name or ID)
- <host>
- Host to add to <aggregate>
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.2. openstack aggregate create
usage: openstack aggregate create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--zone <availability-zone>] [--property <key=value>] <name>
Positional arguments
- <name>
- New aggregate name
Optional arguments
- -h, --help
- show this help message and exit
- --zone <availability-zone>
- Availability zone name
- --property <key=value>
- Property to add to this aggregate (repeat option to set multiple properties)
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.3. openstack aggregate delete
usage: openstack aggregate delete [-h] <aggregate>
Positional arguments
- <aggregate>
- Aggregate to delete (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
3.3.4. openstack aggregate list
usage: openstack aggregate list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long]
Optional arguments
- -h, --help
- show this help message and exit
- --long
- List additional fields in output
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.5. openstack aggregate remove host
usage: openstack aggregate remove host [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <aggregate> <host>
Positional arguments
- <aggregate>
- Aggregate (name or ID)
- <host>
- Host to remove from <aggregate>
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.6. openstack aggregate set
usage: openstack aggregate set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name <name>] [--zone <availability-zone>] [--property <key=value>] <aggregate>
Positional arguments
- <aggregate>
- Aggregate to modify (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --name <name>
- Set aggregate name
- --zone <availability-zone>
- Set availability zone name
- --property <key=value>
- Property to set on <aggregate> (repeat option to set multiple properties)
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.7. openstack aggregate show
usage: openstack aggregate show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <aggregate>
Positional arguments
- <aggregate>
- Aggregate to display (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.8. openstack availability zone list
usage: openstack availability zone list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long]
Optional arguments
- -h, --help
- show this help message and exit
- --long
- List additional fields in output
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.9. openstack backup create
usage: openstack backup create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--container <container>] [--name <name>] [--description <description>] <volume>
Positional arguments
- <volume>
- Volume to backup (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --container <container>
- Optional backup container name
- --name <name>
- Name of the backup
- --description <description>
- Description of the backup
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.10. openstack backup delete
usage: openstack backup delete [-h] <backup> [<backup> ...]
Positional arguments
- <backup>
- Backup(s) to delete (ID only)
Optional arguments
- -h, --help
- show this help message and exit
3.3.11. openstack backup list
usage: openstack backup list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long]
Optional arguments
- -h, --help
- show this help message and exit
- --long
- List additional fields in output
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.12. openstack backup restore
usage: openstack backup restore [-h] <backup> <volume>
Positional arguments
- <backup>
- Backup to restore (ID only)
- <volume>
- Volume to restore to (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
3.3.13. openstack backup show
usage: openstack backup show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <backup>
Positional arguments
- <backup>
- Backup to display (ID only)
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.14. openstack baremetal introspection rule delete
usage: openstack baremetal introspection rule delete [-h] uuid
Positional arguments
- uuid
- rule UUID
Optional arguments
- -h, --help
- show this help message and exit
3.3.15. openstack baremetal introspection rule import
usage: openstack baremetal introspection rule import [-h] file
Positional arguments
- file
- JSON file to import, may contain one or several rules
Optional arguments
- -h, --help
- show this help message and exit
3.3.16. openstack baremetal introspection rule list
usage: openstack baremetal introspection rule list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.17. openstack baremetal introspection rule purge
usage: openstack baremetal introspection rule purge [-h]
Optional arguments
- -h, --help
- show this help message and exit
3.3.18. openstack baremetal introspection rule show
usage: openstack baremetal introspection rule show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] uuid
Positional arguments
- uuid
- rule UUID
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.19. openstack baremetal introspection start
usage: openstack baremetal introspection start [-h] [--new-ipmi-username NEW_IPMI_USERNAME] [--new-ipmi-password NEW_IPMI_PASSWORD] uuid
Positional arguments
- uuid
- baremetal node UUID
Optional arguments
- -h, --help
- show this help message and exit
- --new-ipmi-username NEW_IPMI_USERNAME
- if set, *Ironic Inspector* will update IPMI user name to this value
- --new-ipmi-password NEW_IPMI_PASSWORD
- if set, *Ironic Inspector* will update IPMI password to this value
3.3.20. openstack baremetal introspection status
usage: openstack baremetal introspection status [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] uuid
Positional arguments
- uuid
- baremetal node UUID
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.21. openstack catalog list
usage: openstack catalog list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.22. openstack catalog show
usage: openstack catalog show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <service>
Positional arguments
- <service>
- Service to display (type or name)
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.23. openstack command list
usage: openstack command list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.24. openstack compute agent create
usage: openstack compute agent create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <os> <architecture> <version> <url> <md5hash> <hypervisor>
Positional arguments
- <os>
- Type of OS
- <architecture>
- Type of architecture
- <version>
- Version
- <url>
- URL
- <md5hash>
- MD5 hash
- <hypervisor>
- Type of hypervisor
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.25. openstack compute agent delete
usage: openstack compute agent delete [-h] <id>
Positional arguments
- <id>
- ID of agent to delete
Optional arguments
- -h, --help
- show this help message and exit
3.3.26. openstack compute agent list
usage: openstack compute agent list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--hypervisor <hypervisor>]
Optional arguments
- -h, --help
- show this help message and exit
- --hypervisor <hypervisor>
- Type of hypervisor
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.27. openstack compute agent set
usage: openstack compute agent set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <id> <version> <url> <md5hash>
Positional arguments
- <id>
- ID of the agent
- <version>
- Version of the agent
- <url>
- URL
- <md5hash>
- MD5 hash
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.28. openstack compute service list
usage: openstack compute service list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--host <host>] [--service <service>]
Optional arguments
- -h, --help
- show this help message and exit
- --host <host>
- Name of host
- --service <service>
- Name of service
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.29. openstack compute service set
usage: openstack compute service set [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--enable | --disable] <host> <service>
Positional arguments
- <host>
- Name of host
- <service>
- Name of service
Optional arguments
- -h, --help
- show this help message and exit
- --enable
- Enable a service
- --disable
- Disable a service
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.30. openstack configuration show
usage: openstack configuration show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--mask | --unmask]
Optional arguments
- -h, --help
- show this help message and exit
- --mask
- Attempt to mask passwords (default)
- --unmask
- Show password in clear text
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.31. openstack console log show
usage: openstack console log show [-h] [--lines <num-lines>] <server>
Positional arguments
- <server>
- Server to show console log (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --lines <num-lines>
- Number of lines to display from the end of the log (default=all)
3.3.32. openstack console url show
usage: openstack console url show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--novnc | --xvpvnc | --spice] <server>
Positional arguments
- <server>
- Server to show URL (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --novnc
- Show noVNC console URL (default)
- --xvpvnc
- Show xpvnc console URL
- --spice
- Show SPICE console URL
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.33. openstack container create
usage: openstack container create [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] <container-name> [<container-name> ...]
Positional arguments
- <container-name>
- New container name(s)
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.34. openstack container delete
usage: openstack container delete [-h] <container> [<container> ...]
Positional arguments
- <container>
- Container(s) to delete
Optional arguments
- -h, --help
- show this help message and exit
3.3.35. openstack container list
usage: openstack container list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--prefix <prefix>] [--marker <marker>] [--end-marker <end-marker>] [--limit <limit>] [--long] [--all]
Optional arguments
- -h, --help
- show this help message and exit
- --prefix <prefix>
- Filter list using <prefix>
- --marker <marker>
- Anchor for paging
- --end-marker <end-marker>
- End anchor for paging
- --limit <limit>
- Limit the number of containers returned
- --long
- List additional fields in output
- --all
- List all containers (default is 10000)
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.36. openstack container save
usage: openstack container save [-h] <container>
Positional arguments
- <container>
- Container to save
Optional arguments
- -h, --help
- show this help message and exit
3.3.37. openstack container show
usage: openstack container show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <container>
Positional arguments
- <container>
- Container to display
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.38. openstack dataprocessing data source create
usage: openstack dataprocessing data source create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --type <type> --url <url> [--username <username>] [--password <password>] [--description <description>] <name>
Positional arguments
- <name>
- Name of the data source
Optional arguments
- -h, --help
- show this help message and exit
- --type <type>
- Type of the data source (swift, hdfs or maprfs) [REQUIRED]
- --url <url>
- Url for the data source [REQUIRED]
- --username <username>
- Username for accessing the data source url
- --password <password>
- Password for accessing the data source url
- --description <description>
- Description of the data source
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.39. openstack dataprocessing data source delete
usage: openstack dataprocessing data source delete [-h] <data-source>
Positional arguments
- <data-source>
- Name or id of the data source to delete
Optional arguments
- -h, --help
- show this help message and exit
3.3.40. openstack dataprocessing data source list
usage: openstack dataprocessing data source list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long] [--type <type>]
Optional arguments
- -h, --help
- show this help message and exit
- --long
- List additional fields in output
- --type <type>
- List data sources of specific type (swift, hdfs or maprfs)
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.41. openstack dataprocessing data source show
usage: openstack dataprocessing data source show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <data-source>
Positional arguments
- <data-source>
- Name or id of the data source to display
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.42. openstack dataprocessing plugin configs get
usage: openstack dataprocessing plugin configs get [-h] [--file <file>] <plugin> <version>
Positional arguments
- <plugin>
- Name of the plugin to provide config information about
- <version>
- Version of the plugin to provide config information about
Optional arguments
- -h, --help
- show this help message and exit
- --file <file>
- Destination file (defaults to plugin name)
3.3.43. openstack dataprocessing plugin list
usage: openstack dataprocessing plugin list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long]
Optional arguments
- -h, --help
- show this help message and exit
- --long
- List additional fields in output
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.44. openstack dataprocessing plugin show
usage: openstack dataprocessing plugin show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <plugin>
Positional arguments
- <plugin>
- Name of the plugin to display
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.45. openstack ec2 credentials create
usage: openstack ec2 credentials create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--project <project>] [--user <user>]
Optional arguments
- -h, --help
- show this help message and exit
- --project <project>
- Create credentials in project (name or ID; default: current authenticated project)
- --user <user>
- Create credentials for user (name or ID; default: current authenticated user)
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.46. openstack ec2 credentials delete
usage: openstack ec2 credentials delete [-h] [--user <user>] <access-key>
Positional arguments
- <access-key>
- Credentials access key
Optional arguments
- -h, --help
- show this help message and exit
- --user <user>
- Delete credentials for user (name or ID)
3.3.47. openstack ec2 credentials list
usage: openstack ec2 credentials list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--user <user>]
Optional arguments
- -h, --help
- show this help message and exit
- --user <user>
- Filter list by user (name or ID)
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.48. openstack ec2 credentials show
usage: openstack ec2 credentials show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--user <user>] <access-key>
Positional arguments
- <access-key>
- Credentials access key
Optional arguments
- -h, --help
- show this help message and exit
- --user <user>
- Show credentials for user (name or ID)
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.49. openstack endpoint create
usage: openstack endpoint create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --publicurl <url> [--adminurl <url>] [--internalurl <url>] [--region <region-id>] <service>
Positional arguments
- <service>
- New endpoint service (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --publicurl <url>
- New endpoint public URL (required)
- --adminurl <url>
- New endpoint admin URL
- --internalurl <url>
- New endpoint internal URL
- --region <region-id>
- New endpoint region ID
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.50. openstack endpoint delete
usage: openstack endpoint delete [-h] <endpoint-id>
Positional arguments
- <endpoint-id>
- Endpoint ID to delete
Optional arguments
- -h, --help
- show this help message and exit
3.3.51. openstack endpoint list
usage: openstack endpoint list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long]
Optional arguments
- -h, --help
- show this help message and exit
- --long
- List additional fields in output
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.52. openstack endpoint show
usage: openstack endpoint show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <endpoint-id>
Positional arguments
- <endpoint-id>
- Endpoint ID to display
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.53. openstack extension list
usage: openstack extension list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--compute] [--identity] [--network] [--volume] [--long]
Optional arguments
- -h, --help
- show this help message and exit
- --compute
- List extensions for the Compute API
- --identity
- List extensions for the Identity API
- --network
- List extensions for the Network API
- --volume
- List extensions for the Volume API
- --long
- List additional fields in output
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.54. openstack flavor create
usage: openstack flavor create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--id <id>] [--ram <size-mb>] [--disk <size-gb>] [--ephemeral <size-gb>] [--swap <size-gb>] [--vcpus <vcpus>] [--rxtx-factor <factor>] [--public | --private] <flavor-name>
Positional arguments
- <flavor-name>
- New flavor name
Optional arguments
- -h, --help
- show this help message and exit
- --id <id>
- Unique flavor ID; 'auto' creates a UUID (default: auto)
- --ram <size-mb>
- Memory size in MB (default 256M)
- --disk <size-gb>
- Disk size in GB (default 0G)
- --ephemeral <size-gb>
- Ephemeral disk size in GB (default 0G)
- --swap <size-gb>
- Swap space size in GB (default 0G)
- --vcpus <vcpus>
- Number of vcpus (default 1)
- --rxtx-factor <factor>
- RX/TX factor (default 1)
- --public
- Flavor is available to other projects (default)
- --private
- Flavor is not available to other projects
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.55. openstack flavor delete
usage: openstack flavor delete [-h] <flavor>
Positional arguments
- <flavor>
- Flavor to delete (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
3.3.56. openstack flavor list
usage: openstack flavor list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--public | --private | --all] [--long]
Optional arguments
- -h, --help
- show this help message and exit
- --public
- List only public flavors (default)
- --private
- List only private flavors
- --all
- List all flavors, whether public or private
- --long
- List additional fields in output
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.57. openstack flavor set
usage: openstack flavor set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--property <key=value>] <flavor>
Positional arguments
- <flavor>
- Flavor to modify (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --property <key=value>
- Property to add or modify for this flavor (repeat option to set multiple properties)
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.58. openstack flavor show
usage: openstack flavor show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <flavor>
Positional arguments
- <flavor>
- Flavor to display (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.59. openstack flavor unset
usage: openstack flavor unset [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --property <key> <flavor>
Positional arguments
- <flavor>
- Flavor to modify (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --property <key>
- Property to remove from flavor (repeat option to unset multiple properties)
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.60. openstack host list
usage: openstack host list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--zone <zone>]
Optional arguments
- -h, --help
- show this help message and exit
- --zone <zone>
- Only return hosts in the availability zone.
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.61. openstack host show
usage: openstack host show [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] <host>
Positional arguments
- <host>
- Name of host
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.62. openstack hypervisor list
usage: openstack hypervisor list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--matching <hostname>]
Optional arguments
- -h, --help
- show this help message and exit
- --matching <hostname>
- Filter hypervisors using <hostname> substring
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.63. openstack hypervisor show
usage: openstack hypervisor show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <hypervisor>
Positional arguments
- <hypervisor>
- Hypervisor to display (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.64. openstack hypervisor stats show
usage: openstack hypervisor stats show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX]
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.65. openstack image add project
usage: openstack image add project [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--project-domain <project-domain>] <image> <project>
Positional arguments
- <image>
- Image to share (name or ID)
- <project>
- Project to associate with image (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --project-domain <project-domain>
- Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.66. openstack image create
usage: openstack image create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--id <id>] [--container-format <container-format>] [--disk-format <disk-format>] [--min-disk <disk-gb>] [--min-ram <ram-mb>] [--file <file>] [--protected | --unprotected] [--public | --private] [--property <key=value>] [--tag <tag>] <image-name>
Positional arguments
- <image-name>
- New image name
Optional arguments
- -h, --help
- show this help message and exit
- --id <id>
- Image ID to reserve
- --container-format <container-format>
- Image container format (default: bare)
- --disk-format <disk-format>
- Image disk format (default: raw)
- --min-disk <disk-gb>
- Minimum disk size needed to boot image, in gigabytes
- --min-ram <ram-mb>
- Minimum RAM size needed to boot image, in megabytes
- --file <file>
- Upload image from local file
- --protected
- Prevent image from being deleted
- --unprotected
- Allow image to be deleted (default)
- --public
- Image is accessible to the public
- --private
- Image is inaccessible to the public (default)
- --property <key=value>
- Set a property on this image (repeat option to set multiple properties)
- --tag <tag>
- Set a tag on this image (repeat option to set multiple tags)
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.67. openstack image delete
usage: openstack image delete [-h] <image> [<image> ...]
Positional arguments
- <image>
- Image(s) to delete (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
3.3.68. openstack image list
usage: openstack image list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--public | --private | --shared] [--property <key=value>] [--long] [--sort <key>[:<direction>]]
Optional arguments
- -h, --help
- show this help message and exit
- --public
- List only public images
- --private
- List only private images
- --shared
- List only shared images
- --property <key=value>
- Filter output based on property
- --long
- List additional fields in output
- --sort <key>[:<direction>]
- Sort output by selected keys and directions(asc or desc) (default: asc), multiple keys and directions can be specified separated by comma
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.69. openstack image remove project
usage: openstack image remove project [-h] [--project-domain <project-domain>] <image> <project>
Positional arguments
- <image>
- Image to unshare (name or ID)
- <project>
- Project to disassociate with image (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --project-domain <project-domain>
- Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
3.3.70. openstack image save
usage: openstack image save [-h] [--file <filename>] <image>
Positional arguments
- <image>
- Image to save (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --file <filename>
- Downloaded image save filename (default: stdout)
3.3.71. openstack image set
usage: openstack image set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name <name>] [--architecture <architecture>] [--protected | --unprotected] [--public] [--private] [--instance-uuid <instance_uuid>] [--min-disk <disk-gb>] [--kernel-id <kernel-id>] [--os-version <os-version>] [--disk-format <disk-format>] [--os-distro <os-distro>] [--owner <owner>] [--ramdisk-id <ramdisk-id>] [--min-ram <ram-mb>] [--container-format <container-format>] <image>
Positional arguments
- <image>
- Image to modify (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --name <name>
- New image name
- --architecture <architecture>
- Operating system Architecture
- --protected
- Prevent image from being deleted
- --unprotected
- Allow image to be deleted (default)
- --public
- Image is accessible to the public
- --private
- Image is inaccessible to the public (default)
- --instance-uuid <instance_uuid>
- ID of instance used to create this image
- --min-disk <disk-gb>
- Minimum disk size needed to boot image, in gigabytes
- --kernel-id <kernel-id>
- ID of image in Glance that should be used as the kernel when booting an AMI-style image
- --os-version <os-version>
- Operating system version as specified by the distributor
- --disk-format <disk-format>
- Format of the disk. Valid values: ['None', 'ami', 'ari', 'aki', 'vhd', 'vmdk', 'raw', 'qcow2', 'vdi', 'iso']
- --os-distro <os-distro>
- Common name of operating system distribution
- --owner <owner>
- New Owner of the image
- --ramdisk-id <ramdisk-id>
- ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image
- --min-ram <ram-mb>
- Amount of RAM (in MB) required to boot image
- --container-format <container-format>
- Format of the container. Valid values: ['None', 'ami', 'ari', 'aki', 'bare', 'ovf', 'ova']
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.72. openstack image show
usage: openstack image show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <image>
Positional arguments
- <image>
- Image to display (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.73. openstack ip fixed add
usage: openstack ip fixed add [-h] <network> <server>
Positional arguments
- <network>
- Name of the network to fetch an IP address from
- <server>
- Name of the server to receive the IP address
Optional arguments
- -h, --help
- show this help message and exit
3.3.74. openstack ip fixed remove
usage: openstack ip fixed remove [-h] <ip-address> <server>
Positional arguments
- <ip-address>
- IP address to remove from server
- <server>
- Name of the server to remove the IP address from
Optional arguments
- -h, --help
- show this help message and exit
3.3.75. openstack ip floating add
usage: openstack ip floating add [-h] <ip-address> <server>
Positional arguments
- <ip-address>
- IP address to add to server
- <server>
- Server to receive the IP address (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
3.3.76. openstack ip floating create
usage: openstack ip floating create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <pool>
Positional arguments
- <pool>
- Pool to fetch floating IP from
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.77. openstack ip floating delete
usage: openstack ip floating delete [-h] <ip-address>
Positional arguments
- <ip-address>
- IP address to delete
Optional arguments
- -h, --help
- show this help message and exit
3.3.78. openstack ip floating list
usage: openstack ip floating list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.79. openstack ip floating pool list
usage: openstack ip floating pool list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.80. openstack ip floating remove
usage: openstack ip floating remove [-h] <ip-address> <server>
Positional arguments
- <ip-address>
- IP address to remove from server
- <server>
- Server to remove the IP address from (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
3.3.81. openstack keypair create
usage: openstack keypair create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--public-key <file>] <name>
Positional arguments
- <name>
- New public key name
Optional arguments
- -h, --help
- show this help message and exit
- --public-key <file>
- Filename for public key to add
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.82. openstack keypair delete
usage: openstack keypair delete [-h] <key>
Positional arguments
- <key>
- Public key to delete
Optional arguments
- -h, --help
- show this help message and exit
3.3.83. openstack keypair list
usage: openstack keypair list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.84. openstack keypair show
usage: openstack keypair show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--public-key] <key>
Positional arguments
- <key>
- Public key to display
Optional arguments
- -h, --help
- show this help message and exit
- --public-key
- Show only bare public key
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.85. openstack limits show
usage: openstack limits show [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] (--absolute | --rate) [--reserved] [--project <project>] [--domain <domain>]
Optional arguments
- -h, --help
- show this help message and exit
- --absolute
- Show absolute limits
- --rate
- Show rate limits
- --reserved
- Include reservations count [only valid with --absolute]
- --project <project>
- Show limits for a specific project (name or ID) [only valid with --absolute]
- --domain <domain>
- Domain that owns --project (name or ID) [only valid with --absolute]
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.86. openstack module list
usage: openstack module list [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--all]
Optional arguments
- -h, --help
- show this help message and exit
- --all
- Show all modules that have version information
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.87. openstack network create
usage: openstack network create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--enable | --disable] [--share | --no-share] [--project <project>] [--project-domain <project-domain>] <name>
Positional arguments
- <name>
- New network name
Optional arguments
- -h, --help
- show this help message and exit
- --enable
- Enable network (default)
- --disable
- Disable network
- --share
- Share the network between projects
- --no-share
- Do not share the network between projects
- --project <project>
- Owner's project (name or ID)
- --project-domain <project-domain>
- Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.88. openstack network delete
usage: openstack network delete [-h] <network> [<network> ...]
Positional arguments
- <network>
- Network to delete (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
3.3.89. openstack network list
usage: openstack network list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--external] [--long]
Optional arguments
- -h, --help
- show this help message and exit
- --external
- List external networks
- --long
- List additional fields in output
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.90. openstack network set
usage: openstack network set [-h] [--name <name>] [--enable | --disable] [--share | --no-share] <network>
Positional arguments
- <network>
- Network to modify (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --name <name>
- Set network name
- --enable
- Enable network
- --disable
- Disable network
- --share
- Share the network between projects
- --no-share
- Do not share the network between projects
3.3.91. openstack network show
usage: openstack network show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <network>
Positional arguments
- <network>
- Network to display (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.92. openstack object create
usage: openstack object create [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] <container> <filename> [<filename> ...]
Positional arguments
- <container>
- Container for new object
- <filename>
- Local filename(s) to upload
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.93. openstack object delete
usage: openstack object delete [-h] <container> <object> [<object> ...]
Positional arguments
- <container>
- Delete object(s) from <container>
- <object>
- Object(s) to delete
Optional arguments
- -h, --help
- show this help message and exit
3.3.94. openstack object list
usage: openstack object list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--prefix <prefix>] [--delimiter <delimiter>] [--marker <marker>] [--end-marker <end-marker>] [--limit <limit>] [--long] [--all] <container>
Positional arguments
- <container>
- Container to list
Optional arguments
- -h, --help
- show this help message and exit
- --prefix <prefix>
- Filter list using <prefix>
- --delimiter <delimiter>
- Roll up items with <delimiter>
- --marker <marker>
- Anchor for paging
- --end-marker <end-marker>
- End anchor for paging
- --limit <limit>
- Limit the number of objects returned
- --long
- List additional fields in output
- --all
- List all objects in container (default is 10000)
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.95. openstack object save
usage: openstack object save [-h] [--file <filename>] <container> <object>
Positional arguments
- <container>
- Download <object> from <container>
- <object>
- Object to save
Optional arguments
- -h, --help
- show this help message and exit
- --file <filename>
- Destination filename (defaults to object name)
3.3.96. openstack object show
usage: openstack object show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <container> <object>
Positional arguments
- <container>
- Display <object> from <container>
- <object>
- Object to display
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.97. openstack overcloud image build
usage: openstack overcloud image build [-h] [--all] [--type <image type>] [--base-image BASE_IMAGE] [--instack-undercloud-elements INSTACK_UNDERCLOUD_ELEMENTS] [--tripleo-puppet-elements TRIPLEO_PUPPET_ELEMENTS] [--elements-path ELEMENTS_PATH] [--tmp-dir TMP_DIR] [--node-arch NODE_ARCH] [--node-dist NODE_DIST] [--registration-method REG_METHOD] [--use-delorean-trunk] [--delorean-trunk-repo DELOREAN_TRUNK_REPO] [--delorean-repo-file DELOREAN_REPO_FILE] [--overcloud-full-dib-extra-args OVERCLOUD_FULL_DIB_EXTRA_ARGS] [--overcloud-full-name OVERCLOUD_FULL_NAME] [--fedora-user-name FEDORA_USER_NAME] [--agent-name AGENT_NAME] [--deploy-name DEPLOY_NAME] [--discovery-name DISCOVERY_NAME] [--agent-image-element AGENT_IMAGE_ELEMENT] [--deploy-image-element DEPLOY_IMAGE_ELEMENT] [--discovery-image-element DISCOVERY_IMAGE_ELEMENT] [--builder <builder>]
Optional arguments
- -h, --help
- show this help message and exit
- --all
- Build all images
- --type <image type>
- Build image by name. One of agent-ramdisk, deploy- ramdisk, discovery-ramdisk, fedora-user, overcloud- full
- --base-image BASE_IMAGE
- Image file to use as a base for new images
- --instack-undercloud-elements INSTACK_UNDERCLOUD_ELEMENTS
- Path to Instack Undercloud elements
- --tripleo-puppet-elements TRIPLEO_PUPPET_ELEMENTS
- Path to TripleO Puppet elements
- --elements-path ELEMENTS_PATH
- Full elements path, separated by :
- --tmp-dir TMP_DIR
- Path to a temporary directory for creating images
- --node-arch NODE_ARCH
- Architecture of image to build
- --node-dist NODE_DIST
- Distribution of image to build
- --registration-method REG_METHOD
- Registration method
- --use-delorean-trunk
- Use Delorean trunk repo
- --delorean-trunk-repo DELOREAN_TRUNK_REPO
- URL to Delorean trunk repo
- --delorean-repo-file DELOREAN_REPO_FILE
- Filename for delorean repo config file
- --overcloud-full-dib-extra-args OVERCLOUD_FULL_DIB_EXTRA_ARGS
- Extra args for Overcloud Full
- --overcloud-full-name OVERCLOUD_FULL_NAME
- Name of overcloud full image
- --fedora-user-name FEDORA_USER_NAME
- Name of Fedora user image
- --agent-name AGENT_NAME
- Name of the IPA ramdisk image
- --deploy-name DEPLOY_NAME
- Name of deployment ramdisk image
- --discovery-name DISCOVERY_NAME
- Name of discovery ramdisk image
- --agent-image-element AGENT_IMAGE_ELEMENT
- DIB elements for the IPA image
- --deploy-image-element DEPLOY_IMAGE_ELEMENT
- DIB elements for deploy image
- --discovery-image-element DISCOVERY_IMAGE_ELEMENT
- DIB elements for discovery image
- --builder <builder>
- Image builder. One of dib
3.3.98. openstack overcloud image upload
usage: openstack overcloud image upload [-h] [--image-path IMAGE_PATH] [--os-image OS_IMAGE] [--http-boot HTTP_BOOT] [--update-existing]
Optional arguments
- -h, --help
- show this help message and exit
- --image-path IMAGE_PATH
- Path to directory containing image files
- --os-image OS_IMAGE
- OpenStack disk image filename
- --http-boot HTTP_BOOT
- Root directory for discovery images
- --update-existing
- Update images if already exist
3.3.99. openstack overcloud netenv validate
usage: openstack overcloud netenv validate [-h] [-f NETENV]
Optional arguments
- -h, --help
- show this help message and exit
- -f NETENV, --file NETENV
- Path to the network environment file
3.3.100. openstack overcloud node delete
usage: openstack overcloud node delete [-h] [--stack STACK] [--templates [TEMPLATES]] [-e <HEAT ENVIRONMENT FILE>] <node> [<node> ...]
Positional arguments
- <node>
- Node ID(s) to delete
Optional arguments
- -h, --help
- show this help message and exit
- --stack STACK
- Name or ID of heat stack to scale (default=Env: OVERCLOUD_STACK_NAME)
- --templates [TEMPLATES]
- The directory containing the Heat templates to deploy
- -e <HEAT ENVIRONMENT FILE>, --environment-file <HEAT ENVIRONMENT FILE>
- Environment files to be passed to the heat stack- create or heat stack-update command. (Can be specified more than once.)
3.3.101. openstack overcloud update stack
usage: openstack overcloud update stack [-h] --templates [TEMPLATES] [-i] [-a] [-e <HEAT ENVIRONMENT FILE>] [stack]
Positional arguments
- stack
- Name or ID of heat stack to scale (default=Env: OVERCLOUD_STACK_NAME)
Optional arguments
- -h, --help
- show this help message and exit
- --templates [TEMPLATES]
- The directory containing the Heat templates to deploy
- -i, --interactive
- -a, --abort
- -e <HEAT ENVIRONMENT FILE>, --environment-file <HEAT ENVIRONMENT FILE>
- Environment files to be passed to the heat stack- create or heat stack-update command. (Can be specified more than once.)
3.3.102. openstack project create
usage: openstack project create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--description <description>] [--enable | --disable] [--property <key=value>] [--or-show] <project-name>
Positional arguments
- <project-name>
- New project name
Optional arguments
- -h, --help
- show this help message and exit
- --description <description>
- Project description
- --enable
- Enable project (default)
- --disable
- Disable project
- --property <key=value>
- Add a property to <name> (repeat option to set multiple properties)
- --or-show
- Return existing project
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.103. openstack project delete
usage: openstack project delete [-h] <project> [<project> ...]
Positional arguments
- <project>
- Project(s) to delete (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
3.3.104. openstack project list
usage: openstack project list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long]
Optional arguments
- -h, --help
- show this help message and exit
- --long
- List additional fields in output
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.105. openstack project set
usage: openstack project set [-h] [--name <name>] [--description <description>] [--enable | --disable] [--property <key=value>] <project>
Positional arguments
- <project>
- Project to modify (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --name <name>
- Set project name
- --description <description>
- Set project description
- --enable
- Enable project
- --disable
- Disable project
- --property <key=value>
- Set a project property (repeat option to set multiple properties)
3.3.106. openstack project show
usage: openstack project show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <project>
Positional arguments
- <project>
- Project to display (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.107. openstack ptr record list
usage: openstack ptr record list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.108. openstack ptr record set
usage: openstack ptr record set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--description DESCRIPTION | --no-description] [--ttl TTL | --no-ttl] floatingip_id ptrdname
Positional arguments
- floatingip_id
- Floating IP ID
- ptrdname
- PTRD Name
Optional arguments
- -h, --help
- show this help message and exit
- --description DESCRIPTION
- Description
- --no-description
- --ttl TTL TTL
- --no-ttl
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.109. openstack ptr record show
usage: openstack ptr record show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] floatingip_id
Positional arguments
- floatingip_id
- Floating IP ID
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.110. openstack ptr record unset
usage: openstack ptr record unset [-h] floatingip_id
Positional arguments
- floatingip_id
- Floating IP ID
Optional arguments
- -h, --help
- show this help message and exit
3.3.111. openstack quota set
usage: openstack quota set [-h] [--class] [--properties <properties>] [--ram <ram>] [--secgroup-rules <secgroup-rules>] [--instances <instances>] [--key-pairs <key-pairs>] [--fixed-ips <fixed-ips>] [--secgroups <secgroups>] [--injected-file-size <injected-file-size>] [--floating-ips <floating-ips>] [--injected-files <injected-files>] [--cores <cores>] [--injected-path-size <injected-path-size>] [--gigabytes <gigabytes>] [--volumes <volumes>] [--snapshots <snapshots>] [--volume-type <volume-type>] <project/class>
Positional arguments
- <project/class>
- Set quotas for this project or class (name/ID)
Optional arguments
- -h, --help
- show this help message and exit
- --class
- Set quotas for <class>
- --properties <properties>
- New value for the properties quota
- --ram <ram>
- New value for the ram quota
- --secgroup-rules <secgroup-rules>
- New value for the secgroup-rules quota
- --instances <instances>
- New value for the instances quota
- --key-pairs <key-pairs>
- New value for the key-pairs quota
- --fixed-ips <fixed-ips>
- New value for the fixed-ips quota
- --secgroups <secgroups>
- New value for the secgroups quota
- --injected-file-size <injected-file-size>
- New value for the injected-file-size quota
- --floating-ips <floating-ips>
- New value for the floating-ips quota
- --injected-files <injected-files>
- New value for the injected-files quota
- --cores <cores>
- New value for the cores quota
- --injected-path-size <injected-path-size>
- New value for the injected-path-size quota
- --gigabytes <gigabytes>
- New value for the gigabytes quota
- --volumes <volumes>
- New value for the volumes quota
- --snapshots <snapshots>
- New value for the snapshots quota
- --volume-type <volume-type>
- Set quotas for a specific <volume-type>
3.3.112. openstack quota show
usage: openstack quota show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--class | --default] <project/class>
Positional arguments
- <project/class>
- Show this project or class (name/ID)
Optional arguments
- -h, --help
- show this help message and exit
- --class
- Show quotas for <class>
- --default
- Show default quotas for <project>
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.113. openstack recordset create
usage: openstack recordset create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --records RECORDS [RECORDS ...] --type TYPE [--ttl TTL] [--description DESCRIPTION] zone_id name
Positional arguments
- zone_id
- Zone ID
- name
- RecordSet Name
Optional arguments
- -h, --help
- show this help message and exit
- --records RECORDS [RECORDS ...]
- RecordSet Records
- --type TYPE
- RecordSet Type
- --ttl TTL
- Time To Live (Seconds)
- --description DESCRIPTION
- Description
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.114. openstack recordset delete
usage: openstack recordset delete [-h] zone_id id
Positional arguments
- zone_id
- Zone ID
- id
- RecordSet ID
Optional arguments
- -h, --help
- show this help message and exit
3.3.115. openstack recordset list
usage: openstack recordset list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] zone_id
Positional arguments
- zone_id
- Zone ID
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.116. openstack recordset set
usage: openstack recordset set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name NAME] [--records RECORDS [RECORDS ...]] [--description DESCRIPTION | --no-description] [--ttl TTL | --no-ttl] zone_id id
Positional arguments
- zone_id
- Zone ID
- id
- RecordSet ID
Optional arguments
- -h, --help
- show this help message and exit
- --name NAME
- RecordSet Name
- --records RECORDS [RECORDS ...]
- Records
- --description DESCRIPTION
- Description
- --no-description
- --ttl TTL TTL
- --no-ttl
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.117. openstack recordset show
usage: openstack recordset show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] zone_id id
Positional arguments
- zone_id
- Zone ID
- id
- RecordSet ID
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.118. openstack role add
usage: openstack role add [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --project <project> --user <user> <role>
Positional arguments
- <role>
- Role to add to <project>:<user> (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --project <project>
- Include <project> (name or ID)
- --user <user>
- Include <user> (name or ID)
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.119. openstack role create
usage: openstack role create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--or-show] <name>
Positional arguments
- <name>
- New role name
Optional arguments
- -h, --help
- show this help message and exit
- --or-show
- Return existing role
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.120. openstack role delete
usage: openstack role delete [-h] <role> [<role> ...]
Positional arguments
- <role>
- Role(s) to delete (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
3.3.121. openstack role list
usage: openstack role list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--project <project>] [--user <user>]
Optional arguments
- -h, --help
- show this help message and exit
- --project <project>
- Filter roles by <project> (name or ID)
- --user <user>
- Filter roles by <user> (name or ID)
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.122. openstack role remove
usage: openstack role remove [-h] --project <project> --user <user> <role>
Positional arguments
- <role>
- Role to remove (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --project <project>
- Include <project> (name or ID)
- --user <user>
- Include <user> (name or ID)
3.3.123. openstack role show
usage: openstack role show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <role>
Positional arguments
- <role>
- Role to display (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.124. openstack security group create
usage: openstack security group create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--description <description>] <name>
Positional arguments
- <name>
- New security group name
Optional arguments
- -h, --help
- show this help message and exit
- --description <description>
- Security group description
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.125. openstack security group delete
usage: openstack security group delete [-h] <group>
Positional arguments
- <group>
- Name or ID of security group to delete
Optional arguments
- -h, --help
- show this help message and exit
3.3.126. openstack security group list
usage: openstack security group list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--all-projects]
Optional arguments
- -h, --help
- show this help message and exit
- --all-projects
- Display information from all projects (admin only)
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.127. openstack security group rule create
usage: openstack security group rule create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--proto <proto>] [--src-ip <ip-address>] [--dst-port <port-range>] <group>
Positional arguments
- <group>
- Create rule in this security group
Optional arguments
- -h, --help
- show this help message and exit
- --proto <proto> IP
- protocol (icmp, tcp, udp; default: tcp)
- --src-ip <ip-address>
- Source IP (may use CIDR notation; default: 0.0.0.0/0)
- --dst-port <port-range>
- Destination port, may be a range: 137:139 (default: 0; only required for proto tcp and udp)
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.128. openstack security group rule delete
usage: openstack security group rule delete [-h] <rule>
Positional arguments
- <rule>
- Security group rule ID to delete
Optional arguments
- -h, --help
- show this help message and exit
3.3.129. openstack security group rule list
usage: openstack security group rule list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] <group>
Positional arguments
- <group>
- List all rules in this security group
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.130. openstack security group set
usage: openstack security group set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name <new-name>] [--description <description>] <group>
Positional arguments
- <group>
- Name or ID of security group to change
Optional arguments
- -h, --help
- show this help message and exit
- --name <new-name>
- New security group name
- --description <description>
- New security group name
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.131. openstack security group show
usage: openstack security group show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <group>
Positional arguments
- <group>
- Name or ID of security group to change
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.132. openstack server add security group
usage: openstack server add security group [-h] <server> <group>
Positional arguments
- <server>
- Server (name or ID)
- <group>
- Security group to add (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
3.3.133. openstack server add volume
usage: openstack server add volume [-h] [--device <device>] <server> <volume>
Positional arguments
- <server>
- Server (name or ID)
- <volume>
- Volume to add (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --device <device>
- Server internal device name for volume
3.3.134. openstack server create
usage: openstack server create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] (--image <image> | --volume <volume>) --flavor <flavor> [--security-group <security-group-name>] [--key-name <key-name>] [--property <key=value>] [--file <dest-filename=source-filename>] [--user-data <user-data>] [--availability-zone <zone-name>] [--block-device-mapping <dev-name=mapping>] [--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid>] [--hint <key=value>] [--config-drive <config-drive-volume>|True] [--min <count>] [--max <count>] [--wait] <server-name>
Positional arguments
- <server-name>
- New server name
Optional arguments
- -h, --help
- show this help message and exit
- --image <image>
- Create server from this image
- --volume <volume>
- Create server from this volume
- --flavor <flavor>
- Create server with this flavor
- --security-group <security-group-name>
- Security group to assign to this server (repeat for multiple groups)
- --key-name <key-name>
- Keypair to inject into this server (optional extension)
- --property <key=value>
- Set a property on this server (repeat for multiple values)
- --file <dest-filename=source-filename>
- File to inject into image before boot (repeat for multiple files)
- --user-data <user-data>
- User data file to serve from the metadata server
- --availability-zone <zone-name>
- Select an availability zone for the server
- --block-device-mapping <dev-name=mapping>
- Map block devices; map is <id>:<type>:<size(GB)>:<delete_on_terminate> (optional extension)
- --nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid>
- Create a NIC on the server. Specify option multiple times to create multiple NICs. Either net-id or port- id must be provided, but not both. net-id: attach NIC to network with this UUID, port-id: attach NIC to port with this UUID, v4-fixed-ip: IPv4 fixed address for NIC (optional), v6-fixed-ip: IPv6 fixed address for NIC (optional).
- --hint <key=value>
- Hints for the scheduler (optional extension)
- --config-drive <config-drive-volume>|True
- Use specified volume as the config drive, or 'True' to use an ephemeral drive
- --min <count>
- Minimum number of servers to launch (default=1)
- --max <count>
- Maximum number of servers to launch (default=1)
- --wait
- Wait for build to complete
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.135. openstack server delete
usage: openstack server delete [-h] [--wait] <server> [<server> ...]
Positional arguments
- <server>
- Server(s) to delete (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --wait
- Wait for delete to complete
3.3.136. openstack server image create
usage: openstack server image create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name <image-name>] [--wait] <server>
Positional arguments
- <server>
- Server (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --name <image-name>
- Name of new image (default is server name)
- --wait
- Wait for image create to complete
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.137. openstack server list
usage: openstack server list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--reservation-id <reservation-id>] [--ip <ip-address-regex>] [--ip6 <ip-address-regex>] [--name <name-regex>] [--instance-name <server-name>] [--status <status>] [--flavor <flavor>] [--image <image>] [--host <hostname>] [--all-projects] [--project <project>] [--project-domain <project-domain>] [--user <user>] [--user-domain <user-domain>] [--long]
Optional arguments
- -h, --help
- show this help message and exit
- --reservation-id <reservation-id>
- Only return instances that match the reservation
- --ip <ip-address-regex>
- Regular expression to match IP addresses
- --ip6 <ip-address-regex>
- Regular expression to match IPv6 addresses
- --name <name-regex>
- Regular expression to match names
- --instance-name <server-name>
- Regular expression to match instance name (admin only)
- --status <status>
- Search by server status
- --flavor <flavor>
- Search by flavor
- --image <image>
- Search by image
- --host <hostname>
- Search by hostname
- --all-projects
- Include all projects (admin only)
- --project <project>
- Search by project (admin only) (name or ID)
- --project-domain <project-domain>
- Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
- --user <user>
- Search by user (admin only) (name or ID)
- --user-domain <user-domain>
- Domain the user belongs to (name or ID). This can be used in case collisions between user names exist.
- --long
- List additional fields in output
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.138. openstack server lock
usage: openstack server lock [-h] <server>
Positional arguments
- <server>
- Server (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
3.3.139. openstack server migrate
usage: openstack server migrate [-h] [--live <hostname>] [--shared-migration | --block-migration] [--disk-overcommit | --no-disk-overcommit] [--wait] <server>
Positional arguments
- <server>
- Server (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --live <hostname>
- Target hostname
- --shared-migration
- Perform a shared live migration (default)
- --block-migration
- Perform a block live migration
- --disk-overcommit
- Allow disk over-commit on the destination host
- --no-disk-overcommit
- Do not over-commit disk on the destination host (default)
- --wait
- Wait for resize to complete
3.3.140. openstack server pause
usage: openstack server pause [-h] <server>
Positional arguments
- <server>
- Server (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
3.3.141. openstack server reboot
usage: openstack server reboot [-h] [--hard | --soft] [--wait] <server>
Positional arguments
- <server>
- Server (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --hard
- Perform a hard reboot
- --soft
- Perform a soft reboot
- --wait
- Wait for reboot to complete
3.3.142. openstack server rebuild
usage: openstack server rebuild [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --image <image> [--password <password>] [--wait] <server>
Positional arguments
- <server>
- Server (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --image <image>
- Recreate server from this image
- --password <password>
- Set the password on the rebuilt instance
- --wait
- Wait for rebuild to complete
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.143. openstack server remove security group
usage: openstack server remove security group [-h] <server> <group>
Positional arguments
- <server>
- Name or ID of server to use
- <group>
- Name or ID of security group to remove from server
Optional arguments
- -h, --help
- show this help message and exit
3.3.144. openstack server remove volume
usage: openstack server remove volume [-h] <server> <volume>
Positional arguments
- <server>
- Server (name or ID)
- <volume>
- Volume to remove (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
3.3.145. openstack server rescue
usage: openstack server rescue [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <server>
Positional arguments
- <server>
- Server (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.146. openstack server resize
usage: openstack server resize [-h] [--flavor <flavor> | --confirm | --revert] [--wait] <server>
Positional arguments
- <server>
- Server (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --flavor <flavor>
- Resize server to specified flavor
- --confirm
- Confirm server resize is complete
- --revert
- Restore server state before resize
- --wait
- Wait for resize to complete
3.3.147. openstack server resume
usage: openstack server resume [-h] <server>
Positional arguments
- <server>
- Server (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
3.3.148. openstack server set
usage: openstack server set [-h] [--name <new-name>] [--root-password] [--property <key=value>] <server>
Positional arguments
- <server>
- Server (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --name <new-name>
- New server name
- --root-password
- Set new root password (interactive only)
- --property <key=value>
- Property to add/change for this server (repeat option to set multiple properties)
3.3.149. openstack server show
usage: openstack server show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--diagnostics] <server>
Positional arguments
- <server>
- Server (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --diagnostics
- Display server diagnostics information
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.150. openstack server ssh
usage: openstack server ssh [-h] [--login <login-name>] [--port <port>] [--identity <keyfile>] [--option <config-options>] [-4 | -6] [--public | --private | --address-type <address-type>] <server>
Positional arguments
- <server>
- Server (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --login <login-name>
- Login name (ssh -l option)
- --port <port>
- Destination port (ssh -p option)
- --identity <keyfile>
- Private key file (ssh -i option)
- --option <config-options>
- Options in ssh_config(5) format (ssh -o option)
- -4
- Use only IPv4 addresses
- -6
- Use only IPv6 addresses
- --public
- Use public IP address
- --private
- Use private IP address
- --address-type <address-type>
- Use other IP address (public, private, etc)
3.3.151. openstack server suspend
usage: openstack server suspend [-h] <server>
Positional arguments
- <server>
- Server (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
3.3.152. openstack server unlock
usage: openstack server unlock [-h] <server>
Positional arguments
- <server>
- Server (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
3.3.153. openstack server unpause
usage: openstack server unpause [-h] <server>
Positional arguments
- <server>
- Server (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
3.3.154. openstack server unrescue
usage: openstack server unrescue [-h] <server>
Positional arguments
- <server>
- Server (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
3.3.155. openstack server unset
usage: openstack server unset [-h] [--property <key>] <server>
Positional arguments
- <server>
- Server (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --property <key>
- Property key to remove from server (repeat to unset multiple values)
3.3.156. openstack service create
usage: openstack service create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name <name>] [--description <description>] <type>
Positional arguments
- <type>
- New service type (compute, image, identity, volume, etc)
Optional arguments
- -h, --help
- show this help message and exit
- --name <name>
- New service name
- --description <description>
- New service description
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.157. openstack service delete
usage: openstack service delete [-h] <service>
Positional arguments
- <service>
- Service to delete (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
3.3.158. openstack service list
usage: openstack service list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long]
Optional arguments
- -h, --help
- show this help message and exit
- --long
- List additional fields in output
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.159. openstack service show
usage: openstack service show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--catalog] <service>
Positional arguments
- <service>
- Service to display (type, name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --catalog
- Show service catalog information
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.160. openstack snapshot create
usage: openstack snapshot create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --name <name> [--description <description>] [--force] <volume>
Positional arguments
- <volume>
- Volume to snapshot (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --name <name>
- Name of the snapshot
- --description <description>
- Description of the snapshot
- --force
- Create a snapshot attached to an instance. Default is False
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.161. openstack snapshot delete
usage: openstack snapshot delete [-h] <snapshot> [<snapshot> ...]
Positional arguments
- <snapshot>
- Snapshot(s) to delete (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
3.3.162. openstack snapshot list
usage: openstack snapshot list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long]
Optional arguments
- -h, --help
- show this help message and exit
- --long
- List additional fields in output
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.163. openstack snapshot set
usage: openstack snapshot set [-h] [--name <name>] [--description <description>] [--property <key=value>] <snapshot>
Positional arguments
- <snapshot>
- Snapshot to modify (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --name <name>
- New snapshot name
- --description <description>
- New snapshot description
- --property <key=value>
- Property to add/change for this snapshot (repeat option to set multiple properties)
3.3.164. openstack snapshot show
usage: openstack snapshot show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <snapshot>
Positional arguments
- <snapshot>
- Snapshot to display (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.165. openstack snapshot unset
usage: openstack snapshot unset [-h] --property <key> <snapshot>
Positional arguments
- <snapshot>
- Snapshot to modify (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --property <key>
- Property to remove from snapshot (repeat to remove multiple values)
3.3.166. openstack tld create
usage: openstack tld create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --name NAME [--description DESCRIPTION]
Optional arguments
- -h, --help
- show this help message and exit
- --name NAME TLD
- Name
- --description DESCRIPTION
- Description
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.167. openstack tld delete
usage: openstack tld delete [-h] id
Positional arguments
- id
- TLD ID
Optional arguments
- -h, --help
- show this help message and exit
3.3.168. openstack tld list
usage: openstack tld list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.169. openstack tld set
usage: openstack tld set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name NAME] [--description DESCRIPTION | --no-description] id
Positional arguments
- id
- TLD ID
Optional arguments
- -h, --help
- show this help message and exit
- --name NAME TLD
- Name
- --description DESCRIPTION
- Description
- --no-description
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.170. openstack tld show
usage: openstack tld show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id
Positional arguments
- id
- TLD ID
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.171. openstack token issue
usage: openstack token issue [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX]
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.172. openstack token revoke
usage: openstack token revoke [-h] <token>
Positional arguments
- <token>
- Token to be deleted
Optional arguments
- -h, --help
- show this help message and exit
3.3.173. openstack undercloud install
usage: openstack undercloud install [-h]
Optional arguments
- -h, --help
- show this help message and exit
3.3.174. openstack usage list
usage: openstack usage list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--start <start>] [--end <end>]
Optional arguments
- -h, --help
- show this help message and exit
- --start <start>
- Usage range start date, ex 2012-01-20 (default: 4 weeks ago)
- --end <end>
- Usage range end date, ex 2012-01-20 (default: tomorrow)
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.175. openstack usage show
usage: openstack usage show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--project <project>] [--start <start>] [--end <end>]
Optional arguments
- -h, --help
- show this help message and exit
- --project <project>
- Name or ID of project to show usage for
- --start <start>
- Usage range start date, ex 2012-01-20 (default: 4 weeks ago)
- --end <end>
- Usage range end date, ex 2012-01-20 (default: tomorrow)
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.176. openstack user create
usage: openstack user create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--project <project>] [--password <password>] [--password-prompt] [--email <email-address>] [--enable | --disable] [--or-show] <name>
Positional arguments
- <name>
- New user name
Optional arguments
- -h, --help
- show this help message and exit
- --project <project>
- Default project (name or ID)
- --password <password>
- Set user password
- --password-prompt
- Prompt interactively for password
- --email <email-address>
- Set user email address
- --enable
- Enable user (default)
- --disable
- Disable user
- --or-show
- Return existing user
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.177. openstack user delete
usage: openstack user delete [-h] <user> [<user> ...]
Positional arguments
- <user>
- User(s) to delete (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
3.3.178. openstack user list
usage: openstack user list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--project <project>] [--long]
Optional arguments
- -h, --help
- show this help message and exit
- --project <project>
- Filter users by project (name or ID)
- --long
- List additional fields in output
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.179. openstack user role list
usage: openstack user role list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--project <project>] [<user>]
Positional arguments
- <user>
- User to list (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --project <project>
- Filter users by <project> (name or ID)
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.180. openstack user set
usage: openstack user set [-h] [--name <name>] [--project <project>] [--password <user-password>] [--password-prompt] [--email <email-address>] [--enable | --disable] <user>
Positional arguments
- <user>
- User to change (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --name <name>
- Set user name
- --project <project>
- Set default project (name or ID)
- --password <user-password>
- Set user password
- --password-prompt
- Prompt interactively for password
- --email <email-address>
- Set user email address
- --enable
- Enable user (default)
- --disable
- Disable user
3.3.181. openstack user show
usage: openstack user show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <user>
Positional arguments
- <user>
- User to display (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.182. openstack volume create
usage: openstack volume create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --size <size> [--snapshot <snapshot>] [--description <description>] [--type <volume-type>] [--user <user>] [--project <project>] [--availability-zone <availability-zone>] [--image <image>] [--source <volume>] [--property <key=value>] <name>
Positional arguments
- <name>
- New volume name
Optional arguments
- -h, --help
- show this help message and exit
- --size <size>
- New volume size in GB
- --snapshot <snapshot>
- Use <snapshot> as source of new volume
- --description <description>
- New volume description
- --type <volume-type>
- Use <volume-type> as the new volume type
- --user <user>
- Specify an alternate user (name or ID)
- --project <project>
- Specify an alternate project (name or ID)
- --availability-zone <availability-zone>
- Create new volume in <availability-zone>
- --image <image>
- Use <image> as source of new volume (name or ID)
- --source <volume>
- Volume to clone (name or ID)
- --property <key=value>
- Set a property on this volume (repeat option to set multiple properties)
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.183. openstack volume delete
usage: openstack volume delete [-h] [--force] <volume> [<volume> ...]
Positional arguments
- <volume>
- Volume(s) to delete (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --force
- Attempt forced removal of volume(s), regardless of state (defaults to False)
3.3.184. openstack volume list
usage: openstack volume list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--status <status>] [--name <name>] [--all-projects] [--long]
Optional arguments
- -h, --help
- show this help message and exit
- --status <status>
- Filter results by status
- --name <name>
- Filter results by name
- --all-projects
- Include all projects (admin only)
- --long
- List additional fields in output
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.185. openstack volume qos associate
usage: openstack volume qos associate [-h] <qos-spec> <volume-type>
Positional arguments
- <qos-spec>
- QoS specification to modify (name or ID)
- <volume-type>
- Volume type to associate the QoS (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
3.3.186. openstack volume qos create
usage: openstack volume qos create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--consumer <consumer>] [--property <key=value>] <name>
Positional arguments
- <name>
- New QoS specification name
Optional arguments
- -h, --help
- show this help message and exit
- --consumer <consumer>
- Consumer of the QoS. Valid consumers: back-end, both, front-end (defaults to 'both')
- --property <key=value>
- Set a QoS specification property (repeat option to set multiple properties)
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.187. openstack volume qos delete
usage: openstack volume qos delete [-h] <qos-spec> [<qos-spec> ...]
Positional arguments
- <qos-spec>
- QoS specification(s) to delete (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
3.3.188. openstack volume qos disassociate
usage: openstack volume qos disassociate [-h] [--volume-type <volume-type> | --all] <qos-spec>
Positional arguments
- <qos-spec>
- QoS specification to modify (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --volume-type <volume-type>
- Volume type to disassociate the QoS from (name or ID)
- --all
- Disassociate the QoS from every volume type
3.3.189. openstack volume qos list
usage: openstack volume qos list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.190. openstack volume qos set
usage: openstack volume qos set [-h] [--property <key=value>] <qos-spec>
Positional arguments
- <qos-spec>
- QoS specification to modify (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --property <key=value>
- Property to add or modify for this QoS specification (repeat option to set multiple properties)
3.3.191. openstack volume qos show
usage: openstack volume qos show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <qos-spec>
Positional arguments
- <qos-spec>
- QoS specification to display (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.192. openstack volume qos unset
usage: openstack volume qos unset [-h] [--property <key>] <qos-spec>
Positional arguments
- <qos-spec>
- QoS specification to modify (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --property <key>
- Property to remove from the QoS specification. (repeat option to unset multiple properties)
3.3.193. openstack volume set
usage: openstack volume set [-h] [--name <name>] [--description <description>] [--size <size>] [--property <key=value>] <volume>
Positional arguments
- <volume>
- Volume to change (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --name <name>
- New volume name
- --description <description>
- New volume description
- --size <size>
- Extend volume size in GB
- --property <key=value>
- Property to add or modify for this volume (repeat option to set multiple properties)
3.3.194. openstack volume show
usage: openstack volume show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <volume>
Positional arguments
- <volume>
- Volume to display (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.195. openstack volume type create
usage: openstack volume type create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--property <key=value>] <name>
Positional arguments
- <name>
- New volume type name
Optional arguments
- -h, --help
- show this help message and exit
- --property <key=value>
- Property to add for this volume type (repeat option to set multiple properties)
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.196. openstack volume type delete
usage: openstack volume type delete [-h] <volume-type>
Positional arguments
- <volume-type>
- Volume type to delete (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
3.3.197. openstack volume type list
usage: openstack volume type list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long]
Optional arguments
- -h, --help
- show this help message and exit
- --long
- List additional fields in output
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.198. openstack volume type set
usage: openstack volume type set [-h] [--property <key=value>] <volume-type>
Positional arguments
- <volume-type>
- Volume type to modify (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --property <key=value>
- Property to add or modify for this volume type (repeat option to set multiple properties)
3.3.199. openstack volume type show
usage: openstack volume type show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] <volume-type>
Positional arguments
- <volume-type>
- Volume type to display (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.200. openstack volume type unset
usage: openstack volume type unset [-h] --property <key> <volume-type>
Positional arguments
- <volume-type>
- Volume type to modify (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --property <key>
- Property to remove from volume type (repeat option to remove multiple properties)
3.3.201. openstack volume unset
usage: openstack volume unset [-h] --property <key> <volume>
Positional arguments
- <volume>
- Volume to modify (name or ID)
Optional arguments
- -h, --help
- show this help message and exit
- --property <key>
- Property to remove from volume (repeat option to remove multiple properties)
3.3.202. openstack zone abandon
usage: openstack zone abandon [-h] id
Positional arguments
- id
- Zone ID
Optional arguments
- -h, --help
- show this help message and exit
3.3.203. openstack zone axfr
usage: openstack zone axfr [-h] id
Positional arguments
- id
- Zone ID
Optional arguments
- -h, --help
- show this help message and exit
3.3.204. openstack zone blacklist create
usage: openstack zone blacklist create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --pattern PATTERN [--description DESCRIPTION]
Optional arguments
- -h, --help
- show this help message and exit
- --pattern PATTERN
- Blacklist pattern
- --description DESCRIPTION
- Description
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.205. openstack zone blacklist delete
usage: openstack zone blacklist delete [-h] id
Positional arguments
- id
- Blacklist ID
Optional arguments
- -h, --help
- show this help message and exit
3.3.206. openstack zone blacklist list
usage: openstack zone blacklist list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.207. openstack zone blacklist set
usage: openstack zone blacklist set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --pattern PATTERN [--description DESCRIPTION | --no-description] id
Positional arguments
- id
- Blacklist ID
Optional arguments
- -h, --help
- show this help message and exit
- --pattern PATTERN
- Blacklist pattern
- --description DESCRIPTION
- Description
- --no-description
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.208. openstack zone blacklist show
usage: openstack zone blacklist show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id
Positional arguments
- id
- Blacklist ID
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.209. openstack zone create
usage: openstack zone create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--email EMAIL] [--type TYPE] [--ttl TTL] [--description DESCRIPTION] [--masters MASTERS [MASTERS ...]] name
Positional arguments
- name
- Zone Name
Optional arguments
- -h, --help
- show this help message and exit
- --email EMAIL
- Zone Email
- --type TYPE
- Zone Type
- --ttl TTL
- Time To Live (Seconds)
- --description DESCRIPTION
- Description
- --masters MASTERS [MASTERS ...]
- Zone Masters
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.210. openstack zone delete
usage: openstack zone delete [-h] id
Positional arguments
- id
- Zone ID
Optional arguments
- -h, --help
- show this help message and exit
3.3.211. openstack zone list
usage: openstack zone list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--type TYPE]
Optional arguments
- -h, --help
- show this help message and exit
- --type TYPE
- Zone Type
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.212. openstack zone set
usage: openstack zone set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] [--name NAME] [--email EMAIL] [--ttl TTL] [--description DESCRIPTION | --no-description] [--masters MASTERS [MASTERS ...]] id
Positional arguments
- id
- Zone ID
Optional arguments
- -h, --help
- show this help message and exit
- --name NAME
- Zone Name
- --email EMAIL
- Zone Email
- --ttl TTL
- Time To Live (Seconds)
- --description DESCRIPTION
- Description
- --no-description
- --masters MASTERS [MASTERS ...]
- Zone Masters
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.213. openstack zone show
usage: openstack zone show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id
Positional arguments
- id
- Zone ID
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.214. openstack zone transfer accept request
usage: openstack zone transfer accept request [-h] --transfer-id TRANSFER_ID --key KEY
Optional arguments
- -h, --help
- show this help message and exit
- --transfer-id TRANSFER_ID
- Transfer ID
- --key KEY
- Transfer Key
3.3.215. openstack zone transfer accept show
usage: openstack zone transfer accept show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id
Positional arguments
- id
- Zone Tranfer Accept ID
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.216. openstack zone transfer request create
usage: openstack zone transfer request create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] --target-project-id TARGET_PROJECT_ID [--description DESCRIPTION] zone_id
Positional arguments
- zone_id
- Zone ID to transfer.
Optional arguments
- -h, --help
- show this help message and exit
- --target-project-id TARGET_PROJECT_ID
- Target Project ID to transfer to.
- --description DESCRIPTION
- Description
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names
3.3.217. openstack zone transfer request delete
usage: openstack zone transfer request delete [-h] id
Positional arguments
- id
- Zone Transfer ID
Optional arguments
- -h, --help
- show this help message and exit
3.3.218. openstack zone transfer request list
usage: openstack zone transfer request list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--quote {all,minimal,none,nonnumeric}]
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {csv,html,json,json,table,value,yaml,yaml}, --format {csv,html,json,json,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
CSV formatter:
- --quote {all,minimal,none,nonnumeric}
- when to include quotes, defaults to nonnumeric
3.3.219. openstack zone transfer request set
usage: openstack zone transfer request set [-h] [--description DESCRIPTION | --no-description] id
Positional arguments
- id
- Zone Transfer ID
Optional arguments
- -h, --help
- show this help message and exit
- --description DESCRIPTION
- Description
- --no-description
3.3.220. openstack zone transfer request show
usage: openstack zone transfer request show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent] [--prefix PREFIX] id
Positional arguments
- id
- Zone Tranfer ID
Optional arguments
- -h, --help
- show this help message and exit
Output formatters
- Output formatter options
- -f {html,json,json,shell,table,value,yaml,yaml}, --format {html,json,json,shell,table,value,yaml,yaml}
- the output format, defaults to table
- -c COLUMN, --column COLUMN
- specify the column(s) to include, can be repeated
table formatter:
- --max-width <integer>
- Maximum display width, 0 to disable
json formatter:
- --noindent
- whether to disable indenting the JSON
shell formatter:
- a format a UNIX shell can parse (variable="value")
- --prefix PREFIX
- add a prefix to all variable names