Chapter 2. OpenStack Command-line Client
3.2.0.
$openstackhelpCOMMAND
2.1. openstack Usage
usage: openstack [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
[--os-cloud <cloud-config-name>]
[--os-region-name <auth-region-name>]
[--os-cacert <ca-bundle-file>] [--os-cert <certificate-file>]
[--os-key <key-file>] [--verify | --insecure]
[--os-default-domain <auth-domain>]
[--os-interface <interface>] [--timing] [--os-beta-command]
[--os-profile hmac-key]
[--os-compute-api-version <compute-api-version>]
[--os-network-api-version <network-api-version>]
[--os-image-api-version <image-api-version>]
[--os-volume-api-version <volume-api-version>]
[--os-identity-api-version <identity-api-version>]
[--os-object-api-version <object-api-version>]
[--os-metrics-api-version <metrics-api-version>]
[--os-data-processing-api-version <data-processing-api-version>]
[--os-data-processing-url OS_DATA_PROCESSING_URL]
[--os-orchestration-api-version <orchestration-api-version>]
[--os-dns-api-version <dns-api-version>]
[--os-alarming-api-version <alarming-api-version>]
[--os-key-manager-api-version <key-manager-api-version>]
[--os-application-catalog-api-version <application-catalog-api-version>]
[--murano-url MURANO_URL]
[--inspector-api-version INSPECTOR_API_VERSION]
[--inspector-url INSPECTOR_URL]
[--os-container-infra-api-version <container-infra-api-version>]
[--os-queues-api-version <queues-api-version>]
[--os-baremetal-api-version <baremetal-api-version>]
[--os-workflow-api-version <workflow-api-version>]
[--os-auth-type <auth-type>]
[--os-authorization-code <auth-authorization-code>]
[--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-consumer-key <auth-consumer-key>]
[--os-domain-name <auth-domain-name>]
[--os-access-secret <auth-access-secret>]
[--os-user-domain-id <auth-user-domain-id>]
[--os-access-token-type <auth-access-token-type>]
[--os-identity-provider-url <auth-identity-provider-url>]
[--os-default-domain-name <auth-default-domain-name>]
[--os-access-token-endpoint <auth-access-token-endpoint>]
[--os-access-token <auth-access-token>]
[--os-domain-id <auth-domain-id>]
[--os-user-domain-name <auth-user-domain-name>]
[--os-openid-scope <auth-openid-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-default-domain-id <auth-default-domain-id>]
[--os-discovery-endpoint <auth-discovery-endpoint>]
[--os-client-id <auth-client-id>]
[--os-project-domain-name <auth-project-domain-name>]
[--os-access-key <auth-access-key>]
[--os-password <auth-password>]
[--os-redirect-uri <auth-redirect-uri>]
[--os-endpoint <auth-endpoint>]
[--os-aodh-endpoint <auth-aodh-endpoint>]
[--os-roles <auth-roles>] [--os-url <auth-url>]
[--os-consumer-secret <auth-consumer-secret>]
[--os-token <auth-token>] [--os-passcode <auth-passcode>]
[--os-project-id <auth-project-id>]2.2. openstack Optional Arguments
- --version
show program's version number and exit
- -v, --verbose
Increase verbosity of output. Can be repeated.
- -q, --quiet
Suppress output except warnings and errors.
- --log-file LOG_FILE
Specify a file to log output. Disabled by default.
- -h, --help
Show help message and exit.
- --debug
Show tracebacks on errors.
- --os-cloud <cloud-config-name>
Cloud name in clouds.yaml (Env: OS_CLOUD)
- --os-region-name <auth-region-name>
Authentication region name (Env: OS_REGION_NAME)
- --os-cacert <ca-bundle-file>
CA certificate bundle file (Env: OS_CACERT)
- --os-cert <certificate-file>
Client certificate bundle file (Env: OS_CERT)
- --os-key <key-file>
Client certificate key file (Env: OS_KEY)
- --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-beta-command
Enable beta commands which are subject to change
- --os-profile
hmac-key
HMAC key for encrypting profiling context data
- --os-compute-api-version <compute-api-version>
Compute API version, default=2 (Env:
OS_COMPUTE_API_VERSION)
- --os-network-api-version <network-api-version>
Network API version, default=2.0 (Env:
OS_NETWORK_API_VERSION)
- --os-image-api-version <image-api-version>
Image API version, default=2 (Env:
OS_IMAGE_API_VERSION)
- --os-volume-api-version <volume-api-version>
Volume API version, default=2 (Env:
OS_VOLUME_API_VERSION)
- --os-identity-api-version <identity-api-version>
Identity API version, default=3 (Env:
OS_IDENTITY_API_VERSION)
- --os-object-api-version <object-api-version>
Object API version, default=1 (Env:
OS_OBJECT_API_VERSION)
- --os-metrics-api-version <metrics-api-version>
Metrics API version, default=1 (Env:
OS_METRICS_API_VERSION)
- --os-data-processing-api-version <data-processing-api-version>
Data processing API version, default=1.1 (Env:
OS_DATA_PROCESSING_API_VERSION)
- --os-data-processing-url OS_DATA_PROCESSING_URL
Data processing API URL, (Env:
OS_DATA_PROCESSING_API_URL)
- --os-orchestration-api-version <orchestration-api-version>
Orchestration API version, default=1 (Env:
OS_ORCHESTRATION_API_VERSION)
- --os-dns-api-version <dns-api-version>
DNS API version, default=2 (Env: OS_DNS_API_VERSION)
- --os-alarming-api-version <alarming-api-version>
Queues API version, default=2 (Env:
OS_ALARMING_API_VERSION)
- --os-key-manager-api-version <key-manager-api-version>
Barbican API version, default=1 (Env:
OS_KEY_MANAGER_API_VERSION)
- --os-application-catalog-api-version <application-catalog-api-version>
Application catalog API version,
default=1(Env:OS_APPLICATION_CATALOG_API_VERSION)
- --murano-url MURANO_URL
Defaults toenv[MURANO_URL].
- --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-container-infra-api-version <container-infra-api-version>
Container-Infra API version, default=1 (Env:
OS_CONTAINER_INFRA_API_VERSION)
- --os-queues-api-version <queues-api-version>
Queues API version, default=2 (Env:
OS_QUEUES_API_VERSION)
- --os-baremetal-api-version <baremetal-api-version>
Baremetal API version, default=1.6 (Env:
OS_BAREMETAL_API_VERSION)
- --os-workflow-api-version <workflow-api-version>
Workflow API version, default=2 (Env:
OS_WORKFLOW_API_VERSION)
- --os-auth-type <auth-type>
Select an authentication type. Available types:
v2token, password, admin_token, v3oidcauthcode,
v3oidcpassword, v2password, v3samlpassword,
v3password, v3oidcaccesstoken, token_endpoint,
v3kerberos, v3totp, token, v3oidcclientcredentials,
v3tokenlessauth, gnocchi-noauth, v3token, v3oauth1,
aodh-noauth, v3fedkerb. Default: selected based on
--os-username/--os-token (Env: OS_AUTH_TYPE)
- --os-authorization-code <auth-authorization-code>
With v3oidcauthcode: OAuth 2.0 Authorization Code
(Env: OS_AUTHORIZATION_CODE)
- --os-project-domain-id <auth-project-domain-id>
With password: Domain ID containing project With
v3oidcauthcode: Domain ID containing project With
v3oidcpassword: Domain ID containing project With
v3samlpassword: Domain ID containing project With
v3password: Domain ID containing project With
v3oidcaccesstoken: Domain ID containing project With
v3kerberos: Domain ID containing project With v3totp:
Domain ID containing project With token: Domain ID
containing project With v3oidcclientcredentials:
Domain ID containing project With v3tokenlessauth:
Domain ID containing project With v3token: Domain ID
containing project With v3fedkerb: Domain ID
containing project (Env: OS_PROJECT_DOMAIN_ID)
- --os-protocol <auth-protocol>
With v3oidcauthcode: Protocol for federated plugin
With v3oidcpassword: Protocol for federated plugin
With v3samlpassword: Protocol for federated plugin
With v3oidcaccesstoken: Protocol for federated plugin
With v3oidcclientcredentials: Protocol for federated
plugin (Env: OS_PROTOCOL)
- --os-project-name <auth-project-name>
With password: Project name to scope to With
v3oidcauthcode: Project name to scope to With
v3oidcpassword: Project name to scope to With
v3samlpassword: Project name to scope to With
v3password: Project name to scope to With
v3oidcaccesstoken: Project name to scope to With
v3kerberos: Project name to scope to With v3totp:
Project name to scope to With token: Project name to
scope to With v3oidcclientcredentials: Project name to
scope to With v3tokenlessauth: Project name to scope
to With v3token: Project name to scope to With
v3fedkerb: Project name to scope to (Env:
OS_PROJECT_NAME)
- --os-trust-id <auth-trust-id>
With v2token: Trust ID With password: Trust ID With
v3oidcauthcode: Trust ID With v3oidcpassword: Trust ID
With v2password: Trust ID With v3samlpassword: Trust
ID With v3password: Trust ID With v3oidcaccesstoken:
Trust ID With v3kerberos: Trust ID With v3totp: Trust
ID With token: Trust ID With v3oidcclientcredentials:
Trust ID With v3token: Trust ID With v3fedkerb: Trust
ID (Env: OS_TRUST_ID)
- --os-consumer-key <auth-consumer-key>
With v3oauth1: OAuth Consumer ID/Key (Env:
OS_CONSUMER_KEY)
- --os-domain-name <auth-domain-name>
With password: Domain name to scope to With
v3oidcauthcode: Domain name to scope to With
v3oidcpassword: Domain name to scope to With
v3samlpassword: Domain name to scope to With
v3password: Domain name to scope to With
v3oidcaccesstoken: Domain name to scope to With
v3kerberos: Domain name to scope to With v3totp:
Domain name to scope to With token: Domain name to
scope to With v3oidcclientcredentials: Domain name to
scope to With v3tokenlessauth: Domain name to scope to
With v3token: Domain name to scope to With v3fedkerb:
Domain name to scope to (Env: OS_DOMAIN_NAME)
- --os-access-secret <auth-access-secret>
With v3oauth1: OAuth Access Secret (Env:
OS_ACCESS_SECRET)
- --os-user-domain-id <auth-user-domain-id>
With password: User's domain id With v3password:
User's domain id With v3totp: User's domain id (Env:
OS_USER_DOMAIN_ID)
- --os-access-token-type <auth-access-token-type>
With v3oidcauthcode: OAuth 2.0 Authorization Server
Introspection token type, it is used to decide which
type of token will be used when processing token
introspection. Valid values are: "access_token" or
"id_token" With v3oidcpassword: OAuth 2.0
Authorization Server Introspection token type, it is
used to decide which type of token will be used when
processing token introspection. Valid values are:
"access_token" or "id_token" With
v3oidcclientcredentials: OAuth 2.0 Authorization
Server Introspection token type, it is used to decide
which type of token will be used when processing token
introspection. Valid values are: "access_token" or
"id_token" (Env: OS_ACCESS_TOKEN_TYPE)
- --os-identity-provider-url <auth-identity-provider-url>
With v3samlpassword: An Identity Provider URL, where
the SAML2 authentication request will be sent. (Env:
OS_IDENTITY_PROVIDER_URL)
- --os-default-domain-name <auth-default-domain-name>
With password: Optional domain name to use with v3 API
and v2 parameters. It will be used for both the user
and project domain in v3 and ignored in v2
authentication. With token: Optional domain name to
use with v3 API and v2 parameters. It will be used for
both the user and project domain in v3 and ignored in
v2 authentication. (Env: OS_DEFAULT_DOMAIN_NAME)
- --os-access-token-endpoint <auth-access-token-endpoint>
With v3oidcauthcode: OpenID Connect Provider Token
Endpoint. Note that if a discovery document is being
passed this option will override the endpoint provided
by the server in the discovery document. With
v3oidcpassword: OpenID Connect Provider Token
Endpoint. Note that if a discovery document is being
passed this option will override the endpoint provided
by the server in the discovery document. With
v3oidcclientcredentials: OpenID Connect Provider Token
Endpoint. Note that if a discovery document is being
passed this option will override the endpoint provided
by the server in the discovery document. (Env:
OS_ACCESS_TOKEN_ENDPOINT)
- --os-access-token <auth-access-token>
With v3oidcaccesstoken: OAuth 2.0 Access Token (Env:
OS_ACCESS_TOKEN)
- --os-domain-id <auth-domain-id>
With password: Domain ID to scope to With
v3oidcauthcode: Domain ID to scope to With
v3oidcpassword: Domain ID to scope to With
v3samlpassword: Domain ID to scope to With v3password:
Domain ID to scope to With v3oidcaccesstoken: Domain
ID to scope to With v3kerberos: Domain ID to scope to
With v3totp: Domain ID to scope to With token: Domain
ID to scope to With v3oidcclientcredentials: Domain ID
to scope to With v3tokenlessauth: Domain ID to scope
to With v3token: Domain ID to scope to With v3fedkerb:
Domain ID to scope to (Env: OS_DOMAIN_ID)
- --os-user-domain-name <auth-user-domain-name>
With password: User's domain name With v3password:
User's domain name With v3totp: User's domain name
(Env: OS_USER_DOMAIN_NAME)
- --os-openid-scope <auth-openid-scope>
With v3oidcauthcode: OpenID Connect scope that is
requested from authorization server. Note that the
OpenID Connect specification states that "openid" must
be always specified. With v3oidcpassword: OpenID
Connect scope that is requested from authorization
server. Note that the OpenID Connect specification
states that "openid" must be always specified. With
v3oidcclientcredentials: OpenID Connect scope that is
requested from authorization server. Note that the
OpenID Connect specification states that "openid" must
be always specified. (Env: OS_OPENID_SCOPE)
- --os-user-id <auth-user-id>
With password: User id With v2password: User ID to
login with With v3password: User ID With v3totp: User
ID With gnocchi-noauth: User ID With aodh-noauth: User
ID (Env: OS_USER_ID)
- --os-identity-provider <auth-identity-provider>
With v3oidcauthcode: Identity Provider's name With
v3oidcpassword: Identity Provider's name With
v3samlpassword: Identity Provider's name With
v3oidcaccesstoken: Identity Provider's name With
v3oidcclientcredentials: Identity Provider's name
(Env: OS_IDENTITY_PROVIDER)
- --os-username <auth-username>
With password: Username With v3oidcpassword: Username
With v2password: Username to login with With
v3samlpassword: Username With v3password: Username
With v3totp: Username (Env: OS_USERNAME)
- --os-auth-url <auth-auth-url>
With v2token: Authentication URL With password:
Authentication URL With v3oidcauthcode: Authentication
URL With v3oidcpassword: Authentication URL With
v2password: Authentication URL With v3samlpassword:
Authentication URL With v3password: Authentication URL
With v3oidcaccesstoken: Authentication URL With
v3kerberos: Authentication URL With v3totp:
Authentication URL With token: Authentication URL With
v3oidcclientcredentials: Authentication URL With
v3tokenlessauth: Authentication URL With v3token:
Authentication URL With v3oauth1: Authentication URL
With v3fedkerb: Authentication URL (Env: OS_AUTH_URL)
- --os-client-secret <auth-client-secret>
With v3oidcauthcode: OAuth 2.0 Client Secret With
v3oidcpassword: OAuth 2.0 Client Secret With
v3oidcclientcredentials: OAuth 2.0 Client Secret (Env:
OS_CLIENT_SECRET)
- --os-default-domain-id <auth-default-domain-id>
With password: Optional domain ID to use with v3 and
v2 parameters. It will be used for both the user and
project domain in v3 and ignored in v2 authentication.
With token: Optional domain ID to use with v3 and v2
parameters. It will be used for both the user and
project domain in v3 and ignored in v2 authentication.
(Env: OS_DEFAULT_DOMAIN_ID)
- --os-discovery-endpoint <auth-discovery-endpoint>
With v3oidcauthcode: OpenID Connect Discovery Document
URL. The discovery document will be used to obtain the
values of the access token endpoint and the
authentication endpoint. This URL should look like
https://idp.example.org/.well-known/openid-
configuration With v3oidcpassword: OpenID Connect
Discovery Document URL. The discovery document will be
used to obtain the values of the access token endpoint
and the authentication endpoint. This URL should look
like https://idp.example.org/.well-known/openid-
configuration With v3oidcclientcredentials: OpenID
Connect Discovery Document URL. The discovery document
will be used to obtain the values of the access token
endpoint and the authentication endpoint. This URL
should look like https://idp.example.org/.well-known
/openid-configuration (Env: OS_DISCOVERY_ENDPOINT)
- --os-client-id <auth-client-id>
With v3oidcauthcode: OAuth 2.0 Client ID With
v3oidcpassword: OAuth 2.0 Client ID With
v3oidcclientcredentials: OAuth 2.0 Client ID (Env:
OS_CLIENT_ID)
- --os-project-domain-name <auth-project-domain-name>
With password: Domain name containing project With
v3oidcauthcode: Domain name containing project With
v3oidcpassword: Domain name containing project With
v3samlpassword: Domain name containing project With
v3password: Domain name containing project With
v3oidcaccesstoken: Domain name containing project With
v3kerberos: Domain name containing project With
v3totp: Domain name containing project With token:
Domain name containing project With
v3oidcclientcredentials: Domain name containing
project With v3tokenlessauth: Domain name containing
project With v3token: Domain name containing project
With v3fedkerb: Domain name containing project (Env:
OS_PROJECT_DOMAIN_NAME)
- --os-access-key <auth-access-key>
With v3oauth1: OAuth Access Key (Env: OS_ACCESS_KEY)
- --os-password <auth-password>
With password: User's password With v3oidcpassword:
Password With v2password: Password to use With
v3samlpassword: Password With v3password: User's
password (Env: OS_PASSWORD)
- --os-redirect-uri <auth-redirect-uri>
With v3oidcauthcode: OpenID Connect Redirect URL (Env:
OS_REDIRECT_URI)
- --os-endpoint <auth-endpoint>
With admin_token: The endpoint that will always be
used With gnocchi-noauth: Gnocchi endpoint (Env:
OS_ENDPOINT)
- --os-aodh-endpoint <auth-aodh-endpoint>
With aodh-noauth: Aodh endpoint (Env:
OS_AODH_ENDPOINT)
- --os-roles <auth-roles>
With gnocchi-noauth: Roles With aodh-noauth: Roles
(Env: OS_ROLES)
- --os-url <auth-url>
With token_endpoint: Specific service endpoint to use
(Env: OS_URL)
- --os-consumer-secret <auth-consumer-secret>
With v3oauth1: OAuth Consumer Secret (Env:
OS_CONSUMER_SECRET)
- --os-token <auth-token>
With v2token: Token With admin_token: The token that
will always be used With token_endpoint:
Authentication token to use With token: Token to
authenticate with With v3token: Token to authenticate
with (Env: OS_TOKEN)
- --os-passcode <auth-passcode>
With v3totp: User's TOTP passcode (Env: OS_PASSCODE)
- --os-project-id <auth-project-id>
With password: Project ID to scope to With
v3oidcauthcode: Project ID to scope to With
v3oidcpassword: Project ID to scope to With
v3samlpassword: Project ID to scope to With
v3password: Project ID to scope to With
v3oidcaccesstoken: Project ID to scope to With
v3kerberos: Project ID to scope to With v3totp:
Project ID to scope to With token: Project ID to scope
to With v3oidcclientcredentials: Project ID to scope
to With v3tokenlessauth: Project ID to scope to With
gnocchi-noauth: Project ID With v3token: Project ID to
scope to With aodh-noauth: Project ID With v3fedkerb:
Project ID to scope to (Env: OS_PROJECT_ID)
2.3. openstack acl delete
usage: openstack acl delete [-h] URI
Positional arguments
- URI
The URI reference for the secret or container.
Optional arguments
- -h, --help
show this help message and exit
2.4. openstack acl get
usage: openstack acl get [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
URIPositional arguments
- URI
The URI reference for the secret or container.
Optional arguments
- -h, --help
show this help message and exit
2.5. openstack acl submit
usage: openstack acl submit [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--user [USERS]]
[--project-access | --no-project-access]
[--operation-type {read}]
URIPositional arguments
- URI
The URI reference for the secret or container.
Optional arguments
- -h, --help
show this help message and exit
- --user [USERS], -u [USERS]
Keystone userid(s) for ACL.
- --project-access
Flag to enable project access behavior.
- --no-project-access
Flag to disable project access behavior.
- --operation-type {read}, -o {read}
Type of Barbican operation ACL is set for
2.6. openstack acl user add
usage: openstack acl user add [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--user [USERS]]
[--project-access | --no-project-access]
[--operation-type {read}]
URIPositional arguments
- URI
The URI reference for the secret or container.
Optional arguments
- -h, --help
show this help message and exit
- --user [USERS], -u [USERS]
Keystone userid(s) for ACL.
- --project-access
Flag to enable project access behavior.
- --no-project-access
Flag to disable project access behavior.
- --operation-type {read}, -o {read}
Type of Barbican operation ACL is set for
2.7. openstack acl user remove
usage: openstack acl user remove [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--user [USERS]]
[--project-access | --no-project-access]
[--operation-type {read}]
URIPositional arguments
- URI
The URI reference for the secret or container.
Optional arguments
- -h, --help
show this help message and exit
- --user [USERS], -u [USERS]
Keystone userid(s) for ACL.
- --project-access
Flag to enable project access behavior.
- --no-project-access
Flag to disable project access behavior.
- --operation-type {read}, -o {read}
Type of Barbican operation ACL is set for
2.8. openstack action definition create
usage: openstack action definition create [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--public]
definitionPositional arguments
- definition
Action definition file
Optional arguments
- -h, --help
show this help message and exit
- --public
With this flag action will be marked as "public".
2.9. openstack action definition delete
usage: openstack action definition delete [-h] action [action ...]
Positional arguments
- action
Name or ID of action(s).
Optional arguments
- -h, --help
show this help message and exit
2.10. openstack action definition list
usage: openstack action definition list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.11. openstack action definition show
usage: openstack action definition show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
actionPositional arguments
- action
Action (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.12. openstack action definition update
usage: openstack action definition update [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--id ID] [--public]
definitionPositional arguments
- definition
Action definition file
Optional arguments
- -h, --help
show this help message and exit
- --id ID
Action ID.
- --public
With this flag action will be marked as "public".
2.13. openstack action execution delete
usage: openstack action execution delete [-h]
action_execution
[action_execution ...]Positional arguments
- action_execution
Id of action execution identifier(s).
Optional arguments
- -h, --help
show this help message and exit
2.14. openstack action execution list
usage: openstack action execution list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[task_execution_id]Positional arguments
- task_execution_id
Task execution ID.
Optional arguments
- -h, --help
show this help message and exit
2.15. openstack action execution run
usage: openstack action execution run [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] [-s]
[--run-sync] [-t TARGET]
name [input]Positional arguments
- name
Action name to execute.
- input
Action input.
Optional arguments
- -h, --help
show this help message and exit
- -s, --save-result
Save the result into DB.
- --run-sync
Run the action synchronously.
- -t TARGET, --target TARGET
Action will be executed on <target> executor.
2.16. openstack action execution show
usage: openstack action execution show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
action_executionPositional arguments
- action_execution
Action execution ID.
Optional arguments
- -h, --help
show this help message and exit
2.17. openstack action execution update
usage: openstack action execution update [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--state {IDLE,RUNNING,SUCCESS,ERROR}]
[--output OUTPUT]
idPositional arguments
- id
Action execution ID.
Optional arguments
- -h, --help
show this help message and exit
- --state {IDLE,RUNNING,SUCCESS,ERROR}
Action execution state
- --output OUTPUT
Action execution output
2.18. openstack address scope create
usage: openstack address scope create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--ip-version {4,6}]
[--project <project>]
[--project-domain <project-domain>]
[--share | --no-share]
<name>Positional arguments
- <name>
New address scope name
Optional arguments
- -h, --help
show this help message and exit
- --ip-version {4,6} IP
version (default is 4)
- --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.
- --share
Share the address scope between projects
- --no-share
Do not share the address scope between projects
(default)
2.19. openstack address scope delete
usage: openstack address scope delete [-h]
<address-scope> [<address-scope> ...]Positional arguments
- <address-scope>
Address scope(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.20. openstack address scope list
usage: openstack address scope list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.21. openstack address scope set
usage: openstack address scope set [-h] [--name <name>] [--share | --no-share]
<address-scope>Positional arguments
- <address-scope>
Address scope to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Set address scope name
- --share
Share the address scope between projects
- --no-share
Do not share the address scope between projects
2.22. openstack address scope show
usage: openstack address scope show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<address-scope>Positional arguments
- <address-scope>
Address scope to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.23. openstack aggregate add host
usage: openstack aggregate add host [-h] [-f {json,shell,table,value,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
2.24. openstack aggregate create
usage: openstack aggregate create [-h] [-f {json,shell,table,value,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)
2.25. openstack aggregate delete
usage: openstack aggregate delete [-h] <aggregate> [<aggregate> ...]
Positional arguments
- <aggregate>
Aggregate(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.26. openstack aggregate list
usage: openstack aggregate list [-h] [-f {csv,json,table,value,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
2.27. openstack aggregate remove host
usage: openstack aggregate remove host [-h] [-f {json,shell,table,value,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
2.28. openstack aggregate set
usage: openstack aggregate set [-h] [--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)
2.29. openstack aggregate show
usage: openstack aggregate show [-h] [-f {json,shell,table,value,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
2.30. openstack aggregate unset
usage: openstack aggregate unset [-h] --property <key> <aggregate>
Positional arguments
- <aggregate>
Aggregate to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --property <key>
Property to remove from aggregate (repeat option to remove
multiple properties)
2.31. openstack alarm create
usage: openstack alarm create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] --name <NAME> -t <TYPE>
[--project-id <PROJECT_ID>]
[--user-id <USER_ID>]
[--description <DESCRIPTION>] [--state <STATE>]
[--severity <SEVERITY>] [--enabled {True|False}]
[--alarm-action <Webhook URL>]
[--ok-action <Webhook URL>]
[--insufficient-data-action <Webhook URL>]
[--time-constraint <Time Constraint>]
[--repeat-actions {True|False}]
[--query <QUERY>]
[--comparison-operator <OPERATOR>]
[--evaluation-periods <EVAL_PERIODS>]
[--threshold <THRESHOLD>] [--metric <METRIC>]
[-m <METER NAME>] [--period <PERIOD>]
[--statistic <STATISTIC>]
[--event-type <EVENT_TYPE>]
[--granularity <GRANULARITY>]
[--aggregation-method <AGGR_METHOD>]
[--resource-type <RESOURCE_TYPE>]
[--resource-id <RESOURCE_ID>]
[--metrics <METRICS>]
[--composite-rule <COMPOSITE_RULE>]Optional arguments
- -h, --help
show this help message and exit
- --name <NAME>
Name of the alarm
- -t <TYPE>, --type <TYPE>
Type of alarm, should be one of: threshold, event,
composite, gnocchi_resources_threshold,
gnocchi_aggregation_by_metrics_threshold,
gnocchi_aggregation_by_resources_threshold.
- --project-id <PROJECT_ID>
Project to associate with alarm (configurable by admin
users only)
- --user-id <USER_ID>
User to associate with alarm (configurable by admin
users only)
- --description <DESCRIPTION>
Free text description of the alarm
- --state <STATE>
State of the alarm, one of: ['ok', 'alarm',
'insufficient data']
- --severity <SEVERITY>
Severity of the alarm, one of: ['low', 'moderate',
'critical']
- --enabled {True|False}
True if alarm evaluation is enabled
- --alarm-action <Webhook URL>
URL to invoke when state transitions to alarm. May be
used multiple times
- --ok-action <Webhook URL>
URL to invoke when state transitions to OK. May be
used multiple times
- --insufficient-data-action <Webhook URL>
URL to invoke when state transitions to insufficient
data. May be used multiple times
- --time-constraint <Time Constraint>
Only evaluate the alarm if the time at evaluation is
within this time constraint. Start point(s) of the
constraint are specified with a cron expression,
whereas its duration is given in seconds. Can be
specified multiple times for multiple time
constraints, format is: name=<CONSTRAINT_NAME>;start=<
CRON>;duration=<SECONDS>;[description=<DESCRIPTION>;[t
imezone=<IANA Timezone>]]
- --repeat-actions {True|False}
True if actions should be repeatedly notified while
alarm remains in target state
2.32. openstack alarm delete
usage: openstack alarm delete [-h] [--name <NAME>] [<ALARM ID or NAME>]
Positional arguments
- <ALARM ID or NAME>
ID or name of an alarm.
Optional arguments
- -h, --help
show this help message and exit
- --name <NAME>
Name of the alarm
2.33. openstack alarm list
usage: openstack alarm list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--query QUERY | --filter <KEY1=VALUE1;KEY2=VALUE2...>]
[--limit <LIMIT>] [--marker <MARKER>]
[--sort <SORT_KEY:SORT_DIR>]Optional arguments
- -h, --help
show this help message and exit
- --query QUERY
Rich query supported by aodh, e.g. project_id!=my-id
user_id=foo or user_id=bar
- --filter <KEY1=VALUE1;KEY2=VALUE2...>
Filter parameters to apply on returned alarms.
- --limit <LIMIT>
Number of resources to return (Default is server
default)
- --marker <MARKER>
Last item of the previous listing. Return the next
results after this value,the supported marker is
alarm_id.
- --sort <SORT_KEY:SORT_DIR>
Sort of resource attribute, e.g. name:asc
2.34. openstack alarm show
usage: openstack alarm show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name <NAME>]
[<ALARM ID or NAME>]Positional arguments
- <ALARM ID or NAME>
ID or name of an alarm.
Optional arguments
- -h, --help
show this help message and exit
- --name <NAME>
Name of the alarm
2.35. openstack alarm state get
usage: openstack alarm state get [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--name <NAME>]
[<ALARM ID or NAME>]Positional arguments
- <ALARM ID or NAME>
ID or name of an alarm.
Optional arguments
- -h, --help
show this help message and exit
- --name <NAME>
Name of the alarm
2.36. openstack alarm state set
usage: openstack alarm state set [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--name <NAME>] --state <STATE>
[<ALARM ID or NAME>]Positional arguments
- <ALARM ID or NAME>
ID or name of an alarm.
Optional arguments
- -h, --help
show this help message and exit
- --name <NAME>
Name of the alarm
- --state <STATE>
State of the alarm, one of: ['ok', 'alarm',
'insufficient data']
2.37. openstack alarm update
usage: openstack alarm update [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name <NAME>] [-t <TYPE>]
[--project-id <PROJECT_ID>]
[--user-id <USER_ID>]
[--description <DESCRIPTION>] [--state <STATE>]
[--severity <SEVERITY>] [--enabled {True|False}]
[--alarm-action <Webhook URL>]
[--ok-action <Webhook URL>]
[--insufficient-data-action <Webhook URL>]
[--time-constraint <Time Constraint>]
[--repeat-actions {True|False}]
[--query <QUERY>]
[--comparison-operator <OPERATOR>]
[--evaluation-periods <EVAL_PERIODS>]
[--threshold <THRESHOLD>] [--metric <METRIC>]
[-m <METER NAME>] [--period <PERIOD>]
[--statistic <STATISTIC>]
[--event-type <EVENT_TYPE>]
[--granularity <GRANULARITY>]
[--aggregation-method <AGGR_METHOD>]
[--resource-type <RESOURCE_TYPE>]
[--resource-id <RESOURCE_ID>]
[--metrics <METRICS>]
[--composite-rule <COMPOSITE_RULE>]
[<ALARM ID or NAME>]Positional arguments
- <ALARM ID or NAME>
ID or name of an alarm.
Optional arguments
- -h, --help
show this help message and exit
- --name <NAME>
Name of the alarm
- -t <TYPE>, --type <TYPE>
Type of alarm, should be one of: threshold, event,
composite, gnocchi_resources_threshold,
gnocchi_aggregation_by_metrics_threshold,
gnocchi_aggregation_by_resources_threshold.
- --project-id <PROJECT_ID>
Project to associate with alarm (configurable by admin
users only)
- --user-id <USER_ID>
User to associate with alarm (configurable by admin
users only)
- --description <DESCRIPTION>
Free text description of the alarm
- --state <STATE>
State of the alarm, one of: ['ok', 'alarm',
'insufficient data']
- --severity <SEVERITY>
Severity of the alarm, one of: ['low', 'moderate',
'critical']
- --enabled {True|False}
True if alarm evaluation is enabled
- --alarm-action <Webhook URL>
URL to invoke when state transitions to alarm. May be
used multiple times
- --ok-action <Webhook URL>
URL to invoke when state transitions to OK. May be
used multiple times
- --insufficient-data-action <Webhook URL>
URL to invoke when state transitions to insufficient
data. May be used multiple times
- --time-constraint <Time Constraint>
Only evaluate the alarm if the time at evaluation is
within this time constraint. Start point(s) of the
constraint are specified with a cron expression,
whereas its duration is given in seconds. Can be
specified multiple times for multiple time
constraints, format is: name=<CONSTRAINT_NAME>;start=<
CRON>;duration=<SECONDS>;[description=<DESCRIPTION>;[t
imezone=<IANA Timezone>]]
- --repeat-actions {True|False}
True if actions should be repeatedly notified while
alarm remains in target state
2.38. openstack alarm-history search
usage: openstack alarm-history search [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--query QUERY]Optional arguments
- -h, --help
show this help message and exit
- --query QUERY
Rich query supported by aodh, e.g. project_id!=my-id
user_id=foo or user_id=bar
2.39. openstack alarm-history show
usage: openstack alarm-history show [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--limit <LIMIT>] [--marker <MARKER>]
[--sort <SORT_KEY:SORT_DIR>]
alarm_idPositional arguments
- alarm_id
ID of an alarm
Optional arguments
- -h, --help
show this help message and exit
- --limit <LIMIT>
Number of resources to return (Default is server
default)
- --marker <MARKER>
Last item of the previous listing. Return the next
results after this value,the supported marker is
event_id.
- --sort <SORT_KEY:SORT_DIR>
Sort of resource attribute. e.g. timestamp:desc
2.40. openstack alarming capabilities list
usage: openstack alarming capabilities list [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]Optional arguments
- -h, --help
show this help message and exit
2.41. openstack availability zone list
usage: openstack availability zone list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--compute] [--network] [--volume]
[--long]Optional arguments
- -h, --help
show this help message and exit
- --compute
List compute availability zones
- --network
List network availability zones
- --volume
List volume availability zones
- --long
List additional fields in output
2.42. openstack ca get
usage: openstack ca get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
URIPositional arguments
- URI
The URI reference for the CA.
Optional arguments
- -h, --help
show this help message and exit
2.43. openstack ca list
usage: openstack ca list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--limit LIMIT] [--offset OFFSET] [--name NAME]Optional arguments
- -h, --help
show this help message and exit
- --limit LIMIT, -l LIMIT
specify the limit to the number of items to list per
page (default: 10; maximum: 100)
- --offset OFFSET, -o OFFSET
specify the page offset (default: 0)
- --name NAME, -n NAME
specify the secret name (default: None)
2.44. openstack catalog list
usage: openstack catalog list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.45. openstack catalog show
usage: openstack catalog show [-h] [-f {json,shell,table,value,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
2.46. openstack command list
usage: openstack command list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.47. openstack compute agent create
usage: openstack compute agent create [-h] [-f {json,shell,table,value,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
2.48. openstack compute agent delete
usage: openstack compute agent delete [-h] <id> [<id> ...]
Positional arguments
- <id>
ID of agent(s) to delete
Optional arguments
- -h, --help
show this help message and exit
2.49. openstack compute agent list
usage: openstack compute agent list [-h] [-f {csv,json,table,value,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
2.50. openstack compute agent set
usage: openstack compute agent set [-h] [--agent-version <version>]
[--url <url>] [--md5hash <md5hash>]
<id>Positional arguments
- <id>
ID of the agent
Optional arguments
- -h, --help
show this help message and exit
- --agent-version <version>
Version of the agent
- --url <url> URL
of the agent
- --md5hash <md5hash>
MD5 hash of the agent
2.51. openstack compute service delete
usage: openstack compute service delete [-h] <service> [<service> ...]
Positional arguments
- <service>
Compute service(s) to delete (ID only)
Optional arguments
- -h, --help
show this help message and exit
2.52. openstack compute service list
usage: openstack compute service list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--host <host>] [--service <service>]
[--long]Optional arguments
- -h, --help
show this help message and exit
- --host <host>
List services on specified host (name only)
- --service <service>
List only specified service (name only)
- --long
List additional fields in output
2.53. openstack compute service set
usage: openstack compute service set [-h] [--enable | --disable]
[--disable-reason <reason>]
[--up | --down]
<host> <service>Positional arguments
- <host>
Name of host
- <service>
Name of service (Binary name)
Optional arguments
- -h, --help
show this help message and exit
- --enable
Enable service
- --disable
Disable service
- --disable-reason <reason>
Reason for disabling the service (in quotas). Should
be used with --disable option.
- --up
Force up service
- --down
Force down service
2.54. openstack configuration show
usage: openstack configuration show [-h] [-f {json,shell,table,value,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
2.55. 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)
2.56. openstack console url show
usage: openstack console url show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--novnc | --xvpvnc | --spice | --rdp | --serial | --mks]
<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 xvpvnc console URL
- --spice
Show SPICE console URL
- --rdp
Show RDP console URL
- --serial
Show serial console URL
- --mks
Show WebMKS console URL
2.57. openstack container create
usage: openstack container create [-h] [-f {csv,json,table,value,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
2.58. openstack container delete
usage: openstack container delete [-h] [--recursive]
<container> [<container> ...]Positional arguments
- <container>
Container(s) to delete
Optional arguments
- -h, --help
show this help message and exit
- --recursive, -r
Recursively delete objects and container
2.59. openstack container list
usage: openstack container list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--prefix <prefix>] [--marker <marker>]
[--end-marker <end-marker>] [--limit <limit>]
[--long] [--all]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)
2.60. 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
2.61. openstack container set
usage: openstack container set [-h] --property <key=value> <container>
Positional arguments
- <container>
Container to modify
Optional arguments
- -h, --help
show this help message and exit
- --property <key=value>
Set a property on this container (repeat option to set
multiple properties)
2.62. openstack container show
usage: openstack container show [-h] [-f {json,shell,table,value,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
2.63. openstack container unset
usage: openstack container unset [-h] --property <key> <container>
Positional arguments
- <container>
Container to modify
Optional arguments
- -h, --help
show this help message and exit
- --property <key>
Property to remove from container (repeat option to remove
multiple properties)
2.64. openstack dataprocessing cluster create
usage: openstack dataprocessing cluster create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--name <name>]
[--cluster-template <cluster-template>]
[--image <image>]
[--description <description>]
[--user-keypair <keypair>]
[--neutron-network <network>]
[--count <count>] [--public]
[--protected] [--transient]
[--json <filename>] [--wait]Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Name of the cluster [REQUIRED if JSON is not provided]
- --cluster-template <cluster-template>
Cluster template name or ID [REQUIRED if JSON is not
provided]
- --image <image>
Image that will be used for cluster deployment (Name
or ID) [REQUIRED if JSON is not provided]
- --description <description>
Description of the cluster
- --user-keypair <keypair>
User keypair to get acces to VMs after cluster
creation
- --neutron-network <network>
Instances of the cluster will get fixed IP addresses
in this network. (Name or ID should be provided)
- --count <count>
Number of clusters to be created
- --public
Make the cluster public (Visible from other tenants)
- --protected
Make the cluster protected
- --transient
Create transient cluster
- --json <filename> JSON
representation of the cluster. Other arguments
(except for --wait) will not be taken into account if
this one is provided
- --wait
Wait for the cluster creation to complete
2.65. openstack dataprocessing cluster delete
usage: openstack dataprocessing cluster delete [-h] [--wait]
<cluster> [<cluster> ...]Positional arguments
- <cluster>
Name(s) or id(s) of the cluster(s) to delete
Optional arguments
- -h, --help
show this help message and exit
- --wait
Wait for the cluster(s) delete to complete
2.66. openstack dataprocessing cluster list
usage: openstack dataprocessing cluster list [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long] [--plugin <plugin>]
[--plugin-version <plugin_version>]
[--name <name-substring>]Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
- --plugin <plugin>
List clusters with specific plugin
- --plugin-version <plugin_version>
List clusters with specific version of the plugin
- --name <name-substring>
List clusters with specific substring in the name
2.67. openstack dataprocessing cluster scale
usage: openstack dataprocessing cluster scale [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--instances <node-group-template:instances_count> [<node-group-template:instances_count> ...]]
[--json <filename>] [--wait]
<cluster>Positional arguments
- <cluster>
Name or ID of the cluster
Optional arguments
- -h, --help
show this help message and exit
- --instances <node-group-template:instances_count> [<node-group-template:instances_count> ...]
Node group templates and number of their instances to
be scale to [REQUIRED if JSON is not provided]
- --json <filename> JSON
representation of the cluster scale object. Other
arguments (except for --wait) will not be taken into
account if this one is provided
- --wait
Wait for the cluster scale to complete
2.68. openstack dataprocessing cluster show
usage: openstack dataprocessing cluster show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--verification]
[--show-progress]
[--full-dump-events]
<cluster>Positional arguments
- <cluster>
Name or id of the cluster to display
Optional arguments
- -h, --help
show this help message and exit
- --verification
List additional fields for verifications
- --show-progress
Provides ability to show brief details of event logs.
- --full-dump-events
Provides ability to make full dump with event log
details.
2.69. openstack dataprocessing cluster template create
usage: openstack dataprocessing cluster template create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[--name <name>]
[--node-groups <node-group:instances_count> [<node-group:instances_count> ...]]
[--anti-affinity <anti-affinity> [<anti-affinity> ...]]
[--description <description>]
[--autoconfig]
[--public]
[--protected]
[--json <filename>]
[--shares <filename>]
[--configs <filename>]
[--domain-name <domain-name>]Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Name of the cluster template [REQUIRED if JSON is not
provided]
- --node-groups <node-group:instances_count> [<node-group:instances_count> ...]
List of the node groups(names or IDs) and numbers of
instances for each one of them [REQUIRED if JSON is
not provided]
- --anti-affinity <anti-affinity> [<anti-affinity> ...]
List of processes that should be added to an anti-
affinity group
- --description <description>
Description of the cluster template
- --autoconfig
If enabled, instances of the cluster will be
automatically configured
- --public
Make the cluster template public (Visible from other
tenants)
- --protected
Make the cluster template protected
- --json <filename> JSON
representation of the cluster template. Other
arguments will not be taken into account if this one
is provided
- --shares <filename> JSON
representation of the manila shares
- --configs <filename> JSON
representation of the cluster template configs
- --domain-name <domain-name>
Domain name for instances of this cluster template.
This option is available if 'use_designate' config is
True
2.70. openstack dataprocessing cluster template delete
usage: openstack dataprocessing cluster template delete [-h]
<cluster-template>
[<cluster-template> ...]Positional arguments
- <cluster-template>
Name(s) or id(s) of the cluster template(s) to delete
Optional arguments
- -h, --help
show this help message and exit
2.71. openstack dataprocessing cluster template list
usage: openstack dataprocessing cluster template list [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long]
[--plugin <plugin>]
[--plugin-version <plugin_version>]
[--name <name-substring>]Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
- --plugin <plugin>
List cluster templates for specific plugin
- --plugin-version <plugin_version>
List cluster templates with specific version of the
plugin
- --name <name-substring>
List cluster templates with specific substring in the
name
2.72. openstack dataprocessing cluster template show
usage: openstack dataprocessing cluster template show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
<cluster-template>Positional arguments
- <cluster-template>
Name or id of the cluster template to display
Optional arguments
- -h, --help
show this help message and exit
2.73. openstack dataprocessing cluster template update
usage: openstack dataprocessing cluster template update [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[--name <name>]
[--node-groups <node-group:instances_count> [<node-group:instances_count> ...]]
[--anti-affinity <anti-affinity> [<anti-affinity> ...]]
[--description <description>]
[--autoconfig-enable | --autoconfig-disable]
[--public | --private]
[--protected | --unprotected]
[--json <filename>]
[--shares <filename>]
[--configs <filename>]
[--domain-name <domain-name>]
<cluster-template>Positional arguments
- <cluster-template>
Name or ID of the cluster template [REQUIRED]
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
New name of the cluster template
- --node-groups <node-group:instances_count> [<node-group:instances_count> ...]
List of the node groups(names or IDs) and numbers
ofinstances for each one of them
- --anti-affinity <anti-affinity> [<anti-affinity> ...]
List of processes that should be added to an anti-
affinity group
- --description <description>
Description of the cluster template
- --autoconfig-enable
Instances of the cluster will be automatically
configured
- --autoconfig-disable
Instances of the cluster will not be automatically
configured
- --public
Make the cluster template public (Visible from other
tenants)
- --private
Make the cluster template private (Visible only from
this tenant)
- --protected
Make the cluster template protected
- --unprotected
Make the cluster template unprotected
- --json <filename> JSON
representation of the cluster template. Other
arguments will not be taken into account if this one
is provided
- --shares <filename> JSON
representation of the manila shares
- --configs <filename> JSON
representation of the cluster template configs
- --domain-name <domain-name>
Domain name for instances of this cluster template.
This option is available if 'use_designate' config is
True
2.74. openstack dataprocessing cluster update
usage: openstack dataprocessing cluster update [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--name <name>]
[--description <description>]
[--shares <filename>]
[--public | --private]
[--protected | --unprotected]
<cluster>Positional arguments
- <cluster>
Name or ID of the cluster
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
New name of the cluster
- --description <description>
Description of the cluster
- --shares <filename> JSON
representation of the manila shares
- --public
Make the cluster public (Visible from other tenants)
- --private
Make the cluster private (Visible only from this
tenant)
- --protected
Make the cluster protected
- --unprotected
Make the cluster unprotected
2.75. openstack dataprocessing cluster verification
usage: openstack dataprocessing cluster verification [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
(--start | --show)
<cluster>Positional arguments
- <cluster>
Name or ID of the cluster
Optional arguments
- -h, --help
show this help message and exit
- --start
Start health verification for the cluster
- --show
Show health of the cluster
2.76. openstack dataprocessing data source create
usage: openstack dataprocessing data source create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX] --type
<type> --url <url>
[--username <username>]
[--password <password>]
[--description <description>]
[--public] [--protected]
<name>Positional arguments
- <name>
Name of the data source
Optional arguments
- -h, --help
show this help message and exit
- --type <type>
Type of the data source (swift, hdfs, maprfs, manila)
[REQUIRED]
- --url <url>
Url for the data source [REQUIRED]
- --username <username>
Username for accessing the data source url
- --password <password>
Password for accessing the data source url
- --description <description>
Description of the data source
- --public
Make the data source public
- --protected
Make the data source protected
2.77. openstack dataprocessing data source delete
usage: openstack dataprocessing data source delete [-h]
<data-source>
[<data-source> ...]Positional arguments
- <data-source>
Name(s) or id(s) of the data source(s) to delete
Optional arguments
- -h, --help
show this help message and exit
2.78. openstack dataprocessing data source list
usage: openstack dataprocessing data source list [-h]
[-f {csv,json,table,value,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,
maprfs, manila)
2.79. openstack dataprocessing data source show
usage: openstack dataprocessing data source show [-h]
[-f {json,shell,table,value,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
2.80. openstack dataprocessing data source update
usage: openstack dataprocessing data source update [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[--name <name>]
[--type <type>]
[--url <url>]
[--username <username>]
[--password <password>]
[--description <description>]
[--public | --private]
[--protected | --unprotected]
<data-source>Positional arguments
- <data-source>
Name or id of the data source
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
New name of the data source
- --type <type>
Type of the data source (swift, hdfs, maprfs, manila)
- --url <url>
Url for the data source
- --username <username>
Username for accessing the data source url
- --password <password>
Password for accessing the data source url
- --description <description>
Description of the data source
- --public
Make the data source public (Visible from other
tenants)
- --private
Make the data source private (Visible only from this
tenant)
- --protected
Make the data source protected
- --unprotected
Make the data source unprotected
2.81. openstack dataprocessing image list
usage: openstack dataprocessing image list [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long] [--name <name-regex>]
[--tags <tag> [<tag> ...]]
[--username <username>]Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
- --name <name-regex>
Regular expression to match image name
- --tags <tag> [<tag> ...]
List images with specific tag(s)
- --username <username>
List images with specific username
2.82. openstack dataprocessing image register
usage: openstack dataprocessing image register [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
--username <username>
[--description <description>]
<image>Positional arguments
- <image>
Name or ID of the image to register
Optional arguments
- -h, --help
show this help message and exit
- --username <username>
Username of privileged user in the image [REQUIRED]
- --description <description>
Description of the image. If not provided, description
of the image will be reset to empty
2.83. openstack dataprocessing image show
usage: openstack dataprocessing image show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<image>Positional arguments
- <image>
Name or id of the image to display
Optional arguments
- -h, --help
show this help message and exit
2.84. openstack dataprocessing image tags add
usage: openstack dataprocessing image tags add [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
--tags <tag> [<tag> ...]
<image>Positional arguments
- <image>
Name or id of the image
Optional arguments
- -h, --help
show this help message and exit
- --tags <tag> [<tag> ...]
Tag(s) to add [REQUIRED]
2.85. openstack dataprocessing image tags remove
usage: openstack dataprocessing image tags remove [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[--tags <tag> [<tag> ...] |
--all]
<image>Positional arguments
- <image>
Name or id of the image
Optional arguments
- -h, --help
show this help message and exit
- --tags <tag> [<tag> ...]
Tag(s) to remove
- --all
Remove all tags from image
2.86. openstack dataprocessing image tags set
usage: openstack dataprocessing image tags set [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
--tags <tag> [<tag> ...]
<image>Positional arguments
- <image>
Name or id of the image
Optional arguments
- -h, --help
show this help message and exit
- --tags <tag> [<tag> ...]
Tag(s) to set [REQUIRED]
2.87. openstack dataprocessing image unregister
usage: openstack dataprocessing image unregister [-h] <image> [<image> ...]
Positional arguments
- <image>
Name(s) or id(s) of the image(s) to unregister
Optional arguments
- -h, --help
show this help message and exit
2.88. openstack dataprocessing job binary create
usage: openstack dataprocessing job binary create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[--name <name>]
[--data <file> | --url <url>]
[--description <description>]
[--username <username>]
[--password <password> | --password-prompt]
[--public] [--protected]
[--json <filename>]Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Name of the job binary [REQUIRED if JSON is not
provided]
- --data <file>
File that will be stored in the internal DB [REQUIRED
if JSON and URL are not provided]
- --url <url> URL
for the job binary [REQUIRED if JSON and file are
not provided]
- --description <description>
Description of the job binary
- --username <username>
Username for accessing the job binary URL
- --password <password>
Password for accessing the job binary URL
- --password-prompt
Prompt interactively for password
- --public
Make the job binary public
- --protected
Make the job binary protected
- --json <filename> JSON
representation of the job binary. Other arguments
will not be taken into account if this one is provided
2.89. openstack dataprocessing job binary delete
usage: openstack dataprocessing job binary delete [-h]
<job-binary>
[<job-binary> ...]Positional arguments
- <job-binary>
Name(s) or id(s) of the job binary(ies) to delete
Optional arguments
- -h, --help
show this help message and exit
2.90. openstack dataprocessing job binary download
usage: openstack dataprocessing job binary download [-h] [--file <file>]
<job-binary>Positional arguments
- <job-binary>
Name or ID of the job binary to download
Optional arguments
- -h, --help
show this help message and exit
- --file <file>
Destination file (defaults to job binary name)
2.91. openstack dataprocessing job binary list
usage: openstack dataprocessing job binary list [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long]
[--name <name-substring>]Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
- --name <name-substring>
List job binaries with specific substring in the name
2.92. openstack dataprocessing job binary show
usage: openstack dataprocessing job binary show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
<job-binary>Positional arguments
- <job-binary>
Name or ID of the job binary to display
Optional arguments
- -h, --help
show this help message and exit
2.93. openstack dataprocessing job binary update
usage: openstack dataprocessing job binary update [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[--name <name>]
[--url <url>]
[--description <description>]
[--username <username>]
[--password <password> | --password-prompt]
[--public | --private]
[--protected | --unprotected]
[--json <filename>]
<job-binary>Positional arguments
- <job-binary>
Name or ID of the job binary
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
New name of the job binary
- --url <url> URL
for the job binary [Internal DB URL can not be
updated]
- --description <description>
Description of the job binary
- --username <username>
Username for accessing the job binary URL
- --password <password>
Password for accessing the job binary URL
- --password-prompt
Prompt interactively for password
- --public
Make the job binary public (Visible from other
tenants)
- --private
Make the job binary private (Visible only from this
tenant)
- --protected
Make the job binary protected
- --unprotected
Make the job binary unprotected
- --json <filename> JSON
representation of the update object. Other
arguments will not be taken into account if this one
is provided
2.94. openstack dataprocessing job delete
usage: openstack dataprocessing job delete [-h] [--wait] <job> [<job> ...]
Positional arguments
- <job>
ID(s) of the job(s) to delete
Optional arguments
- -h, --help
show this help message and exit
- --wait
Wait for the job(s) delete to complete
2.95. openstack dataprocessing job execute
usage: openstack dataprocessing job execute [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--job-template <job-template>]
[--cluster <cluster>]
[--input <input>]
[--output <output>]
[--params <name:value> [<name:value> ...]]
[--args <argument> [<argument> ...]]
[--public] [--protected]
[--config-json <filename> | --configs <name:value> [<name:value> ...]]
[--interface <filename>]
[--json <filename>]Optional arguments
- -h, --help
show this help message and exit
- --job-template <job-template>
Name or ID of the job template [REQUIRED if JSON is
not provided]
- --cluster <cluster>
Name or ID of the cluster [REQUIRED if JSON is not
provided]
- --input <input>
Name or ID of the input data source
- --output <output>
Name or ID of the output data source
- --params <name:value> [<name:value> ...]
Parameters to add to the job
- --args <argument> [<argument> ...]
Arguments to add to the job
- --public
Make the job public
- --protected
Make the job protected
- --config-json <filename>
JSON representation of the job configs
- --configs <name:value> [<name:value> ...]
Configs to add to the job
- --interface <filename>
JSON representation of the interface
- --json <filename> JSON
representation of the job. Other arguments will
not be taken into account if this one is provided
2.96. openstack dataprocessing job list
usage: openstack dataprocessing job list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long] [--status <status>]Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
- --status <status>
List jobs with specific status
2.97. openstack dataprocessing job show
usage: openstack dataprocessing job show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<job>Positional arguments
- <job>
ID of the job to display
Optional arguments
- -h, --help
show this help message and exit
2.98. openstack dataprocessing job template create
usage: openstack dataprocessing job template create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[--name <name>]
[--type <type>]
[--mains <main> [<main> ...]]
[--libs <lib> [<lib> ...]]
[--description <description>]
[--public] [--protected]
[--interface <filename>]
[--json <filename>]Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Name of the job template [REQUIRED if JSON is not
provided]
- --type <type>
Type of the job (Hive, Java, MapReduce, Storm,
Storm.Pyleus, Pig, Shell, MapReduce.Streaming, Spark)
[REQUIRED if JSON is not provided]
- --mains <main> [<main> ...]
Name(s) or ID(s) for job's main job binary(s)
- --libs <lib> [<lib> ...]
Name(s) or ID(s) for job's lib job binary(s)
- --description <description>
Description of the job template
- --public
Make the job template public
- --protected
Make the job template protected
- --interface <filename>
JSON representation of the interface
- --json <filename> JSON
representation of the job template
2.99. openstack dataprocessing job template delete
usage: openstack dataprocessing job template delete [-h]
<job-template>
[<job-template> ...]Positional arguments
- <job-template>
Name(s) or id(s) of the job template(s) to delete
Optional arguments
- -h, --help
show this help message and exit
2.100. openstack dataprocessing job template list
usage: openstack dataprocessing job template list [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long] [--type <type>]
[--name <name-substring>]Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
- --type <type>
List job templates of specific type
- --name <name-substring>
List job templates with specific substring in the name
2.101. openstack dataprocessing job template show
usage: openstack dataprocessing job template show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
<job-template>Positional arguments
- <job-template>
Name or ID of the job template to display
Optional arguments
- -h, --help
show this help message and exit
2.102. openstack dataprocessing job template update
usage: openstack dataprocessing job template update [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[--name <name>]
[--description <description>]
[--public | --private]
[--protected | --unprotected]
<job-template>Positional arguments
- <job-template>
Name or ID of the job template
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
New name of the job template
- --description <description>
Description of the job template
- --public
Make the job template public (Visible from other
tenants)
- --private
Make the job_template private (Visible only from this
tenant)
- --protected
Make the job template protected
- --unprotected
Make the job template unprotected
2.103. openstack dataprocessing job type configs get
usage: openstack dataprocessing job type configs get [-h] [--file <file>]
<job-type>Positional arguments
- <job-type>
Type of the job to provide config information about
Optional arguments
- -h, --help
show this help message and exit
- --file <file>
Destination file (defaults to job type)
2.104. openstack dataprocessing job type list
usage: openstack dataprocessing job type list [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--type <type>]
[--plugin <plugin>]
[--plugin-version <plugin_version>]Optional arguments
- -h, --help
show this help message and exit
- --type <type>
Get information about specific job type
- --plugin <plugin>
Get only job types supported by this plugin
- --plugin-version <plugin_version>
Get only job types supported by specific version of
the plugin. This parameter will be taken into account
only if plugin is provided
2.105. openstack dataprocessing job update
usage: openstack dataprocessing job update [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--public | --private]
[--protected | --unprotected]
<job>Positional arguments
- <job>
ID of the job to update
Optional arguments
- -h, --help
show this help message and exit
- --public
Make the job public (Visible from other tenants)
- --private
Make the job private (Visible only from this tenant)
- --protected
Make the job protected
- --unprotected
Make the job unprotected
2.106. openstack dataprocessing node group template create
usage: openstack dataprocessing node group template create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[--name <name>]
[--plugin <plugin>]
[--plugin-version <plugin_version>]
[--processes <processes> [<processes> ...]]
[--flavor <flavor>]
[--security-groups <security-groups> [<security-groups> ...]]
[--auto-security-group]
[--availability-zone <availability-zone>]
[--floating-ip-pool <floating-ip-pool>]
[--volumes-per-node <volumes-per-node>]
[--volumes-size <volumes-size>]
[--volumes-type <volumes-type>]
[--volumes-availability-zone <volumes-availability-zone>]
[--volumes-mount-prefix <volumes-mount-prefix>]
[--volumes-locality]
[--description <description>]
[--autoconfig]
[--proxy-gateway]
[--public]
[--protected]
[--json <filename>]
[--shares <filename>]
[--configs <filename>]Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Name of the node group template [REQUIRED if JSON is
not provided]
- --plugin <plugin>
Name of the plugin [REQUIRED if JSON is not provided]
- --plugin-version <plugin_version>
Version of the plugin [REQUIRED if JSON is not
provided]
- --processes <processes> [<processes> ...]
List of the processes that will be launched on each
instance [REQUIRED if JSON is not provided]
- --flavor <flavor>
Name or ID of the flavor [REQUIRED if JSON is not
provided]
- --security-groups <security-groups> [<security-groups> ...]
List of the security groups for the instances in this
node group
- --auto-security-group
Indicates if an additional security group should be
created for the node group
- --availability-zone <availability-zone>
Name of the availability zone where instances will be
created
- --floating-ip-pool <floating-ip-pool>
ID of the floating IP pool
- --volumes-per-node <volumes-per-node>
Number of volumes attached to every node
- --volumes-size <volumes-size>
Size of volumes attached to node (GB). This parameter
will be taken into account only if volumes-per-node is
set and non-zero
- --volumes-type <volumes-type>
Type of the volumes. This parameter will be taken into
account only if volumes-per-node is set and non-zero
- --volumes-availability-zone <volumes-availability-zone>
Name of the availability zone where volumes will be
created. This parameter will be taken into account
only if volumes-per-node is set and non-zero
- --volumes-mount-prefix <volumes-mount-prefix>
Prefix for mount point directory. This parameter will
be taken into account only if volumes-per-node is set
and non-zero
- --volumes-locality
If enabled, instance and attached volumes will be
created on the same physical host. This parameter will
be taken into account only if volumes-per-node is set
and non-zero
- --description <description>
Description of the node group template
- --autoconfig
If enabled, instances of the node group will be
automatically configured
- --proxy-gateway
If enabled, instances of the node group will be used
to access other instances in the cluster
- --public
Make the node group template public (Visible from
other tenants)
- --protected
Make the node group template protected
- --json <filename> JSON
representation of the node group template. Other
arguments will not be taken into account if this one
is provided
- --shares <filename> JSON
representation of the manila shares
- --configs <filename> JSON
representation of the node group template configs
2.107. openstack dataprocessing node group template delete
usage: openstack dataprocessing node group template delete [-h]
<node-group-template>
[<node-group-template> ...]Positional arguments
- <node-group-template>
Name(s) or id(s) of the node group template(s) to
delete
Optional arguments
- -h, --help
show this help message and exit
2.108. openstack dataprocessing node group template list
usage: openstack dataprocessing node group template list [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long]
[--plugin <plugin>]
[--plugin-version <plugin_version>]
[--name <name-substring>]Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
- --plugin <plugin>
List node group templates for specific plugin
- --plugin-version <plugin_version>
List node group templates with specific version of the
plugin
- --name <name-substring>
List node group templates with specific substring in
the name
2.109. openstack dataprocessing node group template show
usage: openstack dataprocessing node group template show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
<node-group-template>Positional arguments
- <node-group-template>
Name or id of the node group template to display
Optional arguments
- -h, --help
show this help message and exit
2.110. openstack dataprocessing node group template update
usage: openstack dataprocessing node group template update [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[--name <name>]
[--plugin <plugin>]
[--plugin-version <plugin_version>]
[--processes <processes> [<processes> ...]]
[--security-groups <security-groups> [<security-groups> ...]]
[--auto-security-group-enable | --auto-security-group-disable]
[--availability-zone <availability-zone>]
[--flavor <flavor>]
[--floating-ip-pool <floating-ip-pool>]
[--volumes-per-node <volumes-per-node>]
[--volumes-size <volumes-size>]
[--volumes-type <volumes-type>]
[--volumes-availability-zone <volumes-availability-zone>]
[--volumes-mount-prefix <volumes-mount-prefix>]
[--volumes-locality-enable | --volumes-locality-disable]
[--description <description>]
[--autoconfig-enable | --autoconfig-disable]
[--proxy-gateway-enable | --proxy-gateway-disable]
[--public | --private]
[--protected | --unprotected]
[--json <filename>]
[--shares <filename>]
[--configs <filename>]
<node-group-template>Positional arguments
- <node-group-template>
Name or ID of the node group template
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
New name of the node group template
- --plugin <plugin>
Name of the plugin
- --plugin-version <plugin_version>
Version of the plugin
- --processes <processes> [<processes> ...]
List of the processes that will be launched on each
instance
- --security-groups <security-groups> [<security-groups> ...]
List of the security groups for the instances in this
node group
- --auto-security-group-enable
Additional security group should be created for the
node group
- --auto-security-group-disable
Additional security group should not be created for
the node group
- --availability-zone <availability-zone>
Name of the availability zone where instances will be
created
- --flavor <flavor>
Name or ID of the flavor
- --floating-ip-pool <floating-ip-pool>
ID of the floating IP pool
- --volumes-per-node <volumes-per-node>
Number of volumes attached to every node
- --volumes-size <volumes-size>
Size of volumes attached to node (GB). This parameter
will be taken into account only if volumes-per-node is
set and non-zero
- --volumes-type <volumes-type>
Type of the volumes. This parameter will be taken into
account only if volumes-per-node is set and non-zero
- --volumes-availability-zone <volumes-availability-zone>
Name of the availability zone where volumes will be
created. This parameter will be taken into account
only if volumes-per-node is set and non-zero
- --volumes-mount-prefix <volumes-mount-prefix>
Prefix for mount point directory. This parameter will
be taken into account only if volumes-per-node is set
and non-zero
- --volumes-locality-enable
Instance and attached volumes will be created on the
same physical host. This parameter will be taken into
account only if volumes-per-node is set and non-zero
- --volumes-locality-disable
Instance and attached volumes creation on the same
physical host will not be regulated. This parameter
will be takeninto account only if volumes-per-node is
set and non-zero
- --description <description>
Description of the node group template
- --autoconfig-enable
Instances of the node group will be automatically
configured
- --autoconfig-disable
Instances of the node group will not be automatically
configured
- --proxy-gateway-enable
Instances of the node group will be used to access
other instances in the cluster
- --proxy-gateway-disable
Instances of the node group will not be used to access
other instances in the cluster
- --public
Make the node group template public (Visible from
other tenants)
- --private
Make the node group template private (Visible only
from this tenant)
- --protected
Make the node group template protected
- --unprotected
Make the node group template unprotected
- --json <filename> JSON
representation of the node group template update
fields. Other arguments will not be taken into account
if this one is provided
- --shares <filename> JSON
representation of the manila shares
- --configs <filename> JSON
representation of the node group template configs
2.111. openstack dataprocessing plugin configs get
usage: openstack dataprocessing plugin configs get [-h] [--file <file>]
<plugin> <plugin_version>Positional arguments
- <plugin>
Name of the plugin to provide config information about
- <plugin_version>
Version of the plugin to provide config information about
Optional arguments
- -h, --help
show this help message and exit
- --file <file>
Destination file (defaults to plugin name)
2.112. openstack dataprocessing plugin list
usage: openstack dataprocessing plugin list [-h]
[-f {csv,json,table,value,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
2.113. openstack dataprocessing plugin show
usage: openstack dataprocessing plugin show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--plugin-version <plugin_version>]
<plugin>Positional arguments
- <plugin>
Name of the plugin to display
Optional arguments
- -h, --help
show this help message and exit
- --plugin-version <plugin_version>
Version of the plugin to display
2.114. openstack dataprocessing plugin update
usage: openstack dataprocessing plugin update [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
<plugin> <json>Positional arguments
- <plugin>
Name of the plugin to provide config information about
- <json>
JSON representation of the plugin update dictionary
Optional arguments
- -h, --help
show this help message and exit
2.115. openstack dns quota list
usage: openstack dns quota list [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
[--project-id PROJECT_ID]Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
- --project-id PROJECT_ID
Project ID Default: current project
2.116. openstack dns quota reset
usage: openstack dns quota reset [-h] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
[--project-id PROJECT_ID]Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
- --project-id PROJECT_ID
Project ID
2.117. openstack dns quota set
usage: openstack dns quota set [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] [--all-projects]
[--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
[--project-id PROJECT_ID]
[--api-export-size <api-export-size>]
[--zones <zones>]
[--recordset-records <recordset-records>]
[--zone-records <zone-records>]
[--zone-recordsets <zone-recordsets>]Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
- --project-id PROJECT_ID
Project ID
- --api-export-size <api-export-size>
New value for the api-export-size quota
- --zones <zones>
New value for the zones quota
- --recordset-records <recordset-records>
New value for the recordset-records quota
- --zone-records <zone-records>
New value for the zone-records quota
- --zone-recordsets <zone-recordsets>
New value for the zone-recordsets quota
2.118. openstack dns service list
usage: openstack dns service list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--hostname HOSTNAME]
[--service_name SERVICE_NAME]
[--status STATUS] [--all-projects]
[--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]Optional arguments
- -h, --help
show this help message and exit
- --hostname HOSTNAME
Hostname
- --service_name SERVICE_NAME
Service Name
- --status STATUS
Status
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.119. openstack dns service show
usage: openstack dns service show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
idPositional arguments
- id
Service Status ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.120. openstack ec2 credentials create
usage: openstack ec2 credentials create [-h]
[-f {json,shell,table,value,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)
2.121. openstack ec2 credentials delete
usage: openstack ec2 credentials delete [-h] [--user <user>]
<access-key> [<access-key> ...]Positional arguments
- <access-key>
Credentials access key(s)
Optional arguments
- -h, --help
show this help message and exit
- --user <user>
Delete credentials for user (name or ID)
2.122. openstack ec2 credentials list
usage: openstack ec2 credentials list [-h] [-f {csv,json,table,value,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)
2.123. openstack ec2 credentials show
usage: openstack ec2 credentials show [-h] [-f {json,shell,table,value,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)
2.124. openstack endpoint create
usage: openstack endpoint create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] --publicurl
<url> [--adminurl <url>]
[--internalurl <url>] [--region <region-id>]
<service>Positional arguments
- <service>
Service to be associated with new endpoint (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
2.125. openstack endpoint delete
usage: openstack endpoint delete [-h] <endpoint-id> [<endpoint-id> ...]
Positional arguments
- <endpoint-id>
Endpoint(s) to delete (ID only)
Optional arguments
- -h, --help
show this help message and exit
2.126. openstack endpoint list
usage: openstack endpoint list [-h] [-f {csv,json,table,value,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
2.127. openstack endpoint show
usage: openstack endpoint show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<endpoint>Positional arguments
- <endpoint>
Endpoint to display (endpoint ID, service ID, service
name, service type)
Optional arguments
- -h, --help
show this help message and exit
2.128. openstack extension list
usage: openstack extension list [-h] [-f {csv,json,table,value,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 Block Storage API
- --long
List additional fields in output
2.129. openstack flavor create
usage: openstack flavor create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] [--id <id>]
[--ram <size-mb>] [--disk <size-gb>]
[--ephemeral <size-gb>] [--swap <size-gb>]
[--vcpus <vcpus>] [--rxtx-factor <factor>]
[--public | --private] [--property <key=value>]
[--project <project>]
[--project-domain <project-domain>]
<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.0)
- --public
Flavor is available to other projects (default)
- --private
Flavor is not available to other projects
- --property <key=value>
Property to add for this flavor (repeat option to set
multiple properties)
- --project <project>
Allow <project> to access private flavor (name or ID)
(Must be used with --private option)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
2.130. openstack flavor delete
usage: openstack flavor delete [-h] <flavor> [<flavor> ...]
Positional arguments
- <flavor>
Flavor(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.131. openstack flavor list
usage: openstack flavor list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--public | --private | --all] [--long]
[--marker <marker>] [--limit <limit>]Optional arguments
- -h, --help
show this help message and exit
- --public
List only public flavors (default)
- --private
List only private flavors
- --all
List all flavors, whether public or private
- --long
List additional fields in output
- --marker <marker>
The last flavor ID of the previous page
- --limit <limit>
Maximum number of flavors to display
2.132. openstack flavor set
usage: openstack flavor set [-h] [--property <key=value>]
[--project <project>]
[--project-domain <project-domain>]
<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)
- --project <project>
Set flavor access to project (name or ID) (admin only)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
2.133. openstack flavor show
usage: openstack flavor show [-h] [-f {json,shell,table,value,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
2.134. openstack flavor unset
usage: openstack flavor unset [-h] [--property <key>] [--project <project>]
[--project-domain <project-domain>]
<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)
- --project <project>
Remove flavor access from project (name or ID) (admin
only)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
2.135. openstack floating ip create
usage: openstack floating ip create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--subnet <subnet>] [--port <port>]
[--floating-ip-address <floating-ip-address>]
[--fixed-ip-address <fixed-ip-address>]
<network>Positional arguments
- <network>
Network to allocate floating IP from (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --subnet <subnet>
Subnet on which you want to create the floating IP
(name or ID)
- --port <port>
Port to be associated with the floating IP (name or
ID)
- --floating-ip-address <floating-ip-address>
Floating IP address
- --fixed-ip-address <fixed-ip-address>
Fixed IP address mapped to the floating IP
2.136. openstack floating ip delete
usage: openstack floating ip delete [-h] <floating-ip> [<floating-ip> ...]
Positional arguments
- <floating-ip>
Floating IP(s) to delete (IP address or ID)
Optional arguments
- -h, --help
show this help message and exit
2.137. openstack floating ip list
usage: openstack floating ip list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.138. openstack floating ip pool
Command "floating ip pool" matches: floating ip pool list
2.139. openstack floating ip show
usage: openstack floating ip show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<floating-ip>Positional arguments
- <floating-ip>
Floating IP to display (IP address or ID)
Optional arguments
- -h, --help
show this help message and exit
2.140. openstack host list
usage: openstack host list [-h] [-f {csv,json,table,value,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
2.141. openstack host set
usage: openstack host set [-h] [--enable | --disable]
[--enable-maintenance | --disable-maintenance]
<host>Positional arguments
- <host>
Host to modify (name only)
Optional arguments
- -h, --help
show this help message and exit
- --enable
Enable the host
- --disable
Disable the host
- --enable-maintenance
Enable maintenance mode for the host
- --disable-maintenance
Disable maintenance mode for the host
2.142. openstack host show
usage: openstack host show [-h] [-f {csv,json,table,value,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
2.143. openstack hypervisor list
usage: openstack hypervisor list [-h] [-f {csv,json,table,value,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
2.144. openstack hypervisor show
usage: openstack hypervisor show [-h] [-f {json,shell,table,value,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
2.145. openstack hypervisor stats show
usage: openstack hypervisor stats show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]Optional arguments
- -h, --help
show this help message and exit
2.146. openstack image add project
usage: openstack image add project [-h] [-f {json,shell,table,value,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.
2.147. openstack image create
usage: openstack image create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--id <id>]
[--container-format <container-format>]
[--disk-format <disk-format>]
[--min-disk <disk-gb>] [--min-ram <ram-mb>]
[--file <file>] [--volume <volume>] [--force]
[--protected | --unprotected]
[--public | --private] [--property <key=value>]
[--tag <tag>] [--project <project>]
[--project-domain <project-domain>]
<image-name>Positional arguments
- <image-name>
New image name
Optional arguments
- -h, --help
show this help message and exit
- --id <id>
Image ID to reserve
- --container-format <container-format>
Image container format (default: bare)
- --disk-format <disk-format>
Image disk format (default: raw)
- --min-disk <disk-gb>
Minimum disk size needed to boot image, in gigabytes
- --min-ram <ram-mb>
Minimum RAM size needed to boot image, in megabytes
- --file <file>
Upload image from local file
- --volume <volume>
Create image from a volume
- --force
Force image creation if volume is in use (only
meaningful with --volume)
- --protected
Prevent image from being deleted
- --unprotected
Allow image to be deleted (default)
- --public
Image is accessible to the public
- --private
Image is inaccessible to the public (default)
- --property <key=value>
Set a property on this image (repeat option to set
multiple properties)
- --tag <tag>
Set a tag on this image (repeat option to set multiple
tags)
- --project <project>
Set an alternate project on this image (name or ID)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
2.148. 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
2.149. openstack image list
usage: openstack image list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--public | --private | --shared]
[--property <key=value>] [--long]
[--sort <key>[:<direction>]] [--limit <limit>]
[--marker <marker>]Optional arguments
- -h, --help
show this help message and exit
- --public
List only public images
- --private
List only private images
- --shared
List only shared images
- --property <key=value>
Filter output based on property
- --long
List additional fields in output
- --sort <key>[:<direction>]
Sort output by selected keys and directions(asc or
desc) (default: asc), multiple keys and directions can
be specified separated by comma
- --limit <limit>
Maximum number of images to display.
- --marker <marker>
The last image (name or ID) of the previous page.
Display list of images after marker. Display all
images if not specified.
2.150. 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.
2.151. 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)
2.152. openstack image set
usage: openstack image set [-h] [--name <name>] [--min-disk <disk-gb>]
[--min-ram <ram-mb>]
[--container-format <container-format>]
[--disk-format <disk-format>]
[--protected | --unprotected]
[--public | --private] [--property <key=value>]
[--tag <tag>] [--architecture <architecture>]
[--instance-id <instance-id>]
[--kernel-id <kernel-id>] [--os-distro <os-distro>]
[--os-version <os-version>]
[--ramdisk-id <ramdisk-id>]
[--deactivate | --activate] [--project <project>]
[--project-domain <project-domain>]
<image>Positional arguments
- <image>
Image to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
New image name
- --min-disk <disk-gb>
Minimum disk size needed to boot image, in gigabytes
- --min-ram <ram-mb>
Minimum RAM size needed to boot image, in megabytes
- --container-format <container-format>
Image container format (default: bare)
- --disk-format <disk-format>
Image disk format (default: raw)
- --protected
Prevent image from being deleted
- --unprotected
Allow image to be deleted (default)
- --public
Image is accessible to the public
- --private
Image is inaccessible to the public (default)
- --property <key=value>
Set a property on this image (repeat option to set
multiple properties)
- --tag <tag>
Set a tag on this image (repeat option to set multiple
tags)
- --architecture <architecture>
Operating system architecture
- --instance-id <instance-id>
ID of server instance used to create this image
- --kernel-id <kernel-id>
ID of kernel image used to boot this disk image
- --os-distro <os-distro>
Operating system distribution name
- --os-version <os-version>
Operating system distribution version
- --ramdisk-id <ramdisk-id>
ID of ramdisk image used to boot this disk image
- --deactivate
Deactivate the image
- --activate
Activate the image
- --project <project>
Set an alternate project on this image (name or ID)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
2.153. openstack image show
usage: openstack image show [-h] [-f {json,shell,table,value,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
2.154. openstack image unset
usage: openstack image unset [-h] [--tag <tag>] [--property <property_key>]
<image>Positional arguments
- <image>
Image to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --tag <tag>
Unset a tag on this image (repeat option to set
multiple tags)
- --property <property_key>
Unset a property on this image (repeat option to set
multiple properties)
2.155. openstack ip availability list
usage: openstack ip availability list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--ip-version <ip-version>]
[--project <project>]
[--project-domain <project-domain>]Optional arguments
- -h, --help
show this help message and exit
- --ip-version <ip-version>
List IP availability of given IP version networks
(default is 4)
- --project <project>
List IP availability of given 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.
2.156. openstack ip availability show
usage: openstack ip availability show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<network>Positional arguments
- <network>
Show IP availability for a specific network (name or
ID)
Optional arguments
- -h, --help
show this help message and exit
2.157. openstack keypair create
usage: openstack keypair create [-h] [-f {json,shell,table,value,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
2.158. openstack keypair delete
usage: openstack keypair delete [-h] <key> [<key> ...]
Positional arguments
- <key>
Public key(s) to delete (name only)
Optional arguments
- -h, --help
show this help message and exit
2.159. openstack keypair list
usage: openstack keypair list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.160. openstack keypair show
usage: openstack keypair show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--public-key]
<key>Positional arguments
- <key>
Public key to display (name only)
Optional arguments
- -h, --help
show this help message and exit
- --public-key
Show only bare public key (name only)
2.161. openstack limits show
usage: openstack limits show [-h] [-f {csv,json,table,value,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 the project belongs to (name or ID) [only valid
with --absolute]
2.162. openstack metric archive-policy create
usage: openstack metric archive-policy create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
-d <DEFINITION> [-b BACK_WINDOW]
[-m AGGREGATION_METHODS]
namePositional arguments
- name
name of the archive policy
Optional arguments
- -h, --help
show this help message and exit
- -d <DEFINITION>, --definition <DEFINITION>
two attributes (separated by ',') of an archive policy
definition with its name and value separated with a
':'
- -b BACK_WINDOW, --back-window BACK_WINDOW
back window of the archive policy
- -m AGGREGATION_METHODS, --aggregation-method AGGREGATION_METHODS
aggregation method of the archive policy
2.163. openstack metric archive-policy delete
usage: openstack metric archive-policy delete [-h] name
Positional arguments
- name
Name of the archive policy
Optional arguments
- -h, --help
show this help message and exit
2.164. openstack metric archive-policy list
usage: openstack metric archive-policy list [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.165. openstack metric archive-policy show
usage: openstack metric archive-policy show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
namePositional arguments
- name
Name of the archive policy
Optional arguments
- -h, --help
show this help message and exit
2.166. openstack metric archive-policy-rule create
usage: openstack metric archive-policy-rule create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX] -a
ARCHIVE_POLICY_NAME -m
METRIC_PATTERN
namePositional arguments
- name
Rule name
Optional arguments
- -h, --help
show this help message and exit
- -a ARCHIVE_POLICY_NAME, --archive-policy-name ARCHIVE_POLICY_NAME
Archive policy name
- -m METRIC_PATTERN, --metric-pattern METRIC_PATTERN
Wildcard of metric name to match
2.167. openstack metric archive-policy-rule delete
usage: openstack metric archive-policy-rule delete [-h] name
Positional arguments
- name
Name of the archive policy rule
Optional arguments
- -h, --help
show this help message and exit
2.168. openstack metric archive-policy-rule list
usage: openstack metric archive-policy-rule list [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.169. openstack metric archive-policy-rule show
usage: openstack metric archive-policy-rule show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
namePositional arguments
- name
Name of the archive policy rule
Optional arguments
- -h, --help
show this help message and exit
2.170. openstack metric benchmark measures add
usage: openstack metric benchmark measures add [-h]
[--resource-id RESOURCE_ID]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--workers WORKERS] --count
COUNT [--batch BATCH]
[--timestamp-start TIMESTAMP_START]
[--timestamp-end TIMESTAMP_END]
[--wait]
metricPositional arguments
- metric
ID or name of the metric
Optional arguments
- -h, --help
show this help message and exit
- --resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource
- --workers WORKERS, -w WORKERS
Number of workers to use
- --count COUNT, -n COUNT
Number of total measures to send
- --batch BATCH, -b BATCH
Number of measures to send in each batch
- --timestamp-start TIMESTAMP_START, -s TIMESTAMP_START
First timestamp to use
- --timestamp-end TIMESTAMP_END, -e TIMESTAMP_END
Last timestamp to use
- --wait
Wait for all measures to be processed
2.171. openstack metric benchmark measures show
usage: openstack metric benchmark measures show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--resource-id RESOURCE_ID]
[--aggregation AGGREGATION]
[--start START] [--stop STOP]
[--granularity GRANULARITY]
[--refresh]
[--workers WORKERS] --count
COUNT
metricPositional arguments
- metric
ID or name of the metric
Optional arguments
- -h, --help
show this help message and exit
- --resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource
- --aggregation AGGREGATION
aggregation to retrieve
- --start START
beginning of the period
- --stop STOP
end of the period
- --granularity GRANULARITY
granularity to retrieve (in seconds)
- --refresh
force aggregation of all known measures
- --workers WORKERS, -w WORKERS
Number of workers to use
- --count COUNT, -n COUNT
Number of total measures to send
2.172. openstack metric benchmark metric create
usage: openstack metric benchmark metric create [-h]
[--resource-id RESOURCE_ID]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--archive-policy-name ARCHIVE_POLICY_NAME]
[--workers WORKERS] --count
COUNT [--keep]Optional arguments
- -h, --help
show this help message and exit
- --resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource
- --archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME
name of the archive policy
- --workers WORKERS, -w WORKERS
Number of workers to use
- --count COUNT, -n COUNT
Number of metrics to create
- --keep, -k
Keep created metrics
2.173. openstack metric benchmark metric show
usage: openstack metric benchmark metric show [-h] [--resource-id RESOURCE_ID]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--workers WORKERS] --count
COUNT
metric [metric ...]Positional arguments
- metric
ID or name of the metrics
Optional arguments
- -h, --help
show this help message and exit
- --resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource
- --workers WORKERS, -w WORKERS
Number of workers to use
- --count COUNT, -n COUNT
Number of metrics to get
2.174. openstack metric capabilities list
usage: openstack metric capabilities list [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]Optional arguments
- -h, --help
show this help message and exit
2.175. openstack metric measures add
usage: openstack metric measures add [-h] [--resource-id RESOURCE_ID] -m
MEASURE
metricPositional arguments
- metric
ID or name of the metric
Optional arguments
- -h, --help
show this help message and exit
- --resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource
- -m MEASURE, --measure MEASURE
timestamp and value of a measure separated with a '@'
2.176. openstack metric measures aggregation
usage: openstack metric measures aggregation [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
-m METRIC [METRIC ...]
[--aggregation AGGREGATION]
[--reaggregation REAGGREGATION]
[--start START] [--stop STOP]
[--granularity GRANULARITY]
[--needed-overlap NEEDED_OVERLAP]
[--query QUERY]
[--resource-type RESOURCE_TYPE]
[--groupby GROUPBY] [--refresh]Optional arguments
- -h, --help
show this help message and exit
- -m METRIC [METRIC ...], --metric METRIC [METRIC ...]
metrics IDs or metric name
- --aggregation AGGREGATION
granularity aggregation function to retrieve
- --reaggregation REAGGREGATION
groupby aggregation function to retrieve
- --start START
beginning of the period
- --stop STOP
end of the period
- --granularity GRANULARITY
granularity to retrieve (in seconds)
- --needed-overlap NEEDED_OVERLAP
percent of datapoints in each metrics required
- --query QUERY A
query to filter resource. The syntax is a
combination of attribute, operator and value. For
example: id=90d58eea-70d7-4294-a49a-170dcdf44c3c would
filter resource with a certain id. More complex
queries can be built, e.g.: not (flavor_id!="1" and
memory>=24). Use "" to force data to be interpreted as
string. Supported operators are: not, and, ∧ or, ∨,
>=, <=, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in,
like, ≠, ≥, ≤, like, in.
- --resource-type RESOURCE_TYPE
Resource type to query
- --groupby GROUPBY
Attribute to use to group resources
- --refresh
force aggregation of all known measures
2.177. openstack metric measures batch-metrics
usage: openstack metric measures batch-metrics [-h] file
Positional arguments
- file
File containing measurements to batch or - for stdin (see
Gnocchi REST API docs for the format
Optional arguments
- -h, --help
show this help message and exit
2.178. openstack metric measures batch-resources-metrics
usage: openstack metric measures batch-resources-metrics [-h] file
Positional arguments
- file
File containing measurements to batch or - for stdin (see
Gnocchi REST API docs for the format
Optional arguments
- -h, --help
show this help message and exit
2.179. openstack metric measures show
usage: openstack metric measures show [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--resource-id RESOURCE_ID]
[--aggregation AGGREGATION]
[--start START] [--stop STOP]
[--granularity GRANULARITY] [--refresh]
metricPositional arguments
- metric
ID or name of the metric
Optional arguments
- -h, --help
show this help message and exit
- --resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource
- --aggregation AGGREGATION
aggregation to retrieve
- --start START
beginning of the period
- --stop STOP
end of the period
- --granularity GRANULARITY
granularity to retrieve (in seconds)
- --refresh
force aggregation of all known measures
2.180. openstack metric metric create
usage: openstack metric metric create [-h] [--resource-id RESOURCE_ID]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--archive-policy-name ARCHIVE_POLICY_NAME]
[--unit UNIT]
[METRIC_NAME]Positional arguments
- METRIC_NAME
Name of the metric
Optional arguments
- -h, --help
show this help message and exit
- --resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource
- --archive-policy-name ARCHIVE_POLICY_NAME, -a ARCHIVE_POLICY_NAME
name of the archive policy
- --unit UNIT, -u UNIT
unit of the metric
2.181. openstack metric metric delete
usage: openstack metric metric delete [-h] [--resource-id RESOURCE_ID]
metric [metric ...]Positional arguments
- metric
IDs or names of the metric
Optional arguments
- -h, --help
show this help message and exit
- --resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource
2.182. openstack metric metric list
usage: openstack metric metric list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--limit <LIMIT>] [--marker <MARKER>]
[--sort <SORT>]Optional arguments
- -h, --help
show this help message and exit
- --limit <LIMIT>
Number of metrics to return (Default is server
default)
- --marker <MARKER>
Last item of the previous listing. Return the next
results after this value
- --sort <SORT>
Sort of metric attribute (example: user_id:desc-
nullslast
2.183. openstack metric metric show
usage: openstack metric metric show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--resource-id RESOURCE_ID]
metricPositional arguments
- metric
ID or name of the metric
Optional arguments
- -h, --help
show this help message and exit
- --resource-id RESOURCE_ID, -r RESOURCE_ID
ID of the resource
2.184. openstack metric resource create
usage: openstack metric resource create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--type RESOURCE_TYPE] [-a ATTRIBUTE]
[-m ADD_METRIC] [-n CREATE_METRIC]
resource_idPositional arguments
- resource_id
ID of the resource
Optional arguments
- -h, --help
show this help message and exit
- --type RESOURCE_TYPE, -t RESOURCE_TYPE
Type of resource
- -a ATTRIBUTE, --attribute ATTRIBUTE
name and value of an attribute separated with a ':'
- -m ADD_METRIC, --add-metric ADD_METRIC
name:id of a metric to add
- -n CREATE_METRIC, --create-metric CREATE_METRIC
name:archive_policy_name of a metric to create
2.185. openstack metric resource delete
usage: openstack metric resource delete [-h] resource_id
Positional arguments
- resource_id
ID of the resource
Optional arguments
- -h, --help
show this help message and exit
2.186. openstack metric resource history
usage: openstack metric resource history [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--details] [--limit <LIMIT>]
[--marker <MARKER>] [--sort <SORT>]
[--type RESOURCE_TYPE]
resource_idPositional arguments
- resource_id
ID of a resource
Optional arguments
- -h, --help
show this help message and exit
- --details
Show all attributes of generic resources
- --limit <LIMIT>
Number of resources to return (Default is server
default)
- --marker <MARKER>
Last item of the previous listing. Return the next
results after this value
- --sort <SORT>
Sort of resource attribute (example: user_id:desc-
nullslast
- --type RESOURCE_TYPE, -t RESOURCE_TYPE
Type of resource
2.187. openstack metric resource list
usage: openstack metric resource list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--details] [--history]
[--limit <LIMIT>] [--marker <MARKER>]
[--sort <SORT>] [--type RESOURCE_TYPE]Optional arguments
- -h, --help
show this help message and exit
- --details
Show all attributes of generic resources
- --history
Show history of the resources
- --limit <LIMIT>
Number of resources to return (Default is server
default)
- --marker <MARKER>
Last item of the previous listing. Return the next
results after this value
- --sort <SORT>
Sort of resource attribute (example: user_id:desc-
nullslast
- --type RESOURCE_TYPE, -t RESOURCE_TYPE
Type of resource
2.188. openstack metric resource search
usage: openstack metric resource search [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--details] [--history]
[--limit <LIMIT>] [--marker <MARKER>]
[--sort <SORT>] [--type RESOURCE_TYPE]
queryPositional arguments
- query
A query to filter resource. The syntax is a
combination of attribute, operator and value. For
example: id=90d58eea-70d7-4294-a49a-170dcdf44c3c would
filter resource with a certain id. More complex
queries can be built, e.g.: not (flavor_id!="1" and
memory>=24). Use "" to force data to be interpreted as
string. Supported operators are: not, and, ∧ or, ∨,
>=, <=, !=, >, <, =, ==, eq, ne, lt, gt, ge, le, in,
like, ≠, ≥, ≤, like, in.
Optional arguments
- -h, --help
show this help message and exit
- --details
Show all attributes of generic resources
- --history
Show history of the resources
- --limit <LIMIT>
Number of resources to return (Default is server
default)
- --marker <MARKER>
Last item of the previous listing. Return the next
results after this value
- --sort <SORT>
Sort of resource attribute (example: user_id:desc-
nullslast
- --type RESOURCE_TYPE, -t RESOURCE_TYPE
Type of resource
2.189. openstack metric resource show
usage: openstack metric resource show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--type RESOURCE_TYPE]
resource_idPositional arguments
- resource_id
ID of a resource
Optional arguments
- -h, --help
show this help message and exit
- --type RESOURCE_TYPE, -t RESOURCE_TYPE
Type of resource
2.190. openstack metric resource update
usage: openstack metric resource update [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--type RESOURCE_TYPE] [-a ATTRIBUTE]
[-m ADD_METRIC] [-n CREATE_METRIC]
[-d DELETE_METRIC]
resource_idPositional arguments
- resource_id
ID of the resource
Optional arguments
- -h, --help
show this help message and exit
- --type RESOURCE_TYPE, -t RESOURCE_TYPE
Type of resource
- -a ATTRIBUTE, --attribute ATTRIBUTE
name and value of an attribute separated with a ':'
- -m ADD_METRIC, --add-metric ADD_METRIC
name:id of a metric to add
- -n CREATE_METRIC, --create-metric CREATE_METRIC
name:archive_policy_name of a metric to create
- -d DELETE_METRIC, --delete-metric DELETE_METRIC
Name of a metric to delete
2.191. openstack metric resource-type create
usage: openstack metric resource-type create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-a ATTRIBUTE]
namePositional arguments
- name
name of the resource type
Optional arguments
- -h, --help
show this help message and exit
- -a ATTRIBUTE, --attribute ATTRIBUTE
attribute definition, attribute_name:attribute_type:at
tribute_is_required:attribute_type_option_name=attribu
te_type_option_value:… For example:
display_name:string:true:max_length=255
2.192. openstack metric resource-type delete
usage: openstack metric resource-type delete [-h] name
Positional arguments
- name
name of the resource type
Optional arguments
- -h, --help
show this help message and exit
2.193. openstack metric resource-type list
usage: openstack metric resource-type list [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.194. openstack metric resource-type show
usage: openstack metric resource-type show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
namePositional arguments
- name
name of the resource type
Optional arguments
- -h, --help
show this help message and exit
2.195. openstack metric status
usage: openstack metric status [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]Optional arguments
- -h, --help
show this help message and exit
2.196. openstack module list
usage: openstack module list [-h] [-f {json,shell,table,value,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
2.197. openstack network agent delete
usage: openstack network agent delete [-h]
<network-agent> [<network-agent> ...]Positional arguments
- <network-agent>
Network agent(s) to delete (ID only)
Optional arguments
- -h, --help
show this help message and exit
2.198. openstack network agent list
usage: openstack network agent list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.199. openstack network agent set
usage: openstack network agent set [-h] [--description <description>]
[--enable | --disable]
<network-agent>Positional arguments
- <network-agent>
Network agent to modify (ID only)
Optional arguments
- -h, --help
show this help message and exit
- --description <description>
Set network agent description
- --enable
Enable network agent
- --disable
Disable network agent
2.200. openstack network agent show
usage: openstack network agent show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<network-agent>Positional arguments
- <network-agent>
Network agent to display (ID only)
Optional arguments
- -h, --help
show this help message and exit
2.201. openstack network create
usage: openstack network create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--share | --no-share] [--enable | --disable]
[--project <project>]
[--project-domain <project-domain>]
[--availability-zone-hint <availability-zone>]
[--enable-port-security | --disable-port-security]
[--external | --internal]
[--default | --no-default]
[--provider-network-type <provider-network-type>]
[--provider-physical-network <provider-physical-network>]
[--provider-segment <provider-segment>]
[--transparent-vlan | --no-transparent-vlan]
<name>Positional arguments
- <name>
New network name
Optional arguments
- -h, --help
show this help message and exit
- --share
Share the network between projects
- --no-share
Do not share the network between projects
- --enable
Enable network (default)
- --disable
Disable network
- --project <project>
Owner's project (name or ID)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
- --availability-zone-hint <availability-zone>
Availability Zone in which to create this network
(Network Availability Zone extension required, repeat
option to set multiple availability zones)
- --enable-port-security
Enable port security by default for ports created on
this network (default)
- --disable-port-security
Disable port security by default for ports created on
this network
- --external
Set this network as an external network (external-net
extension required)
- --internal
Set this network as an internal network (default)
- --default
Specify if this network should be used as the default
external network
- --no-default
Do not use the network as the default external network
(default)
- --provider-network-type <provider-network-type>
The physical mechanism by which the virtual network is
implemented. The supported options are: flat, geneve,
gre, local, vlan, vxlan.
- --provider-physical-network <provider-physical-network>
Name of the physical network over which the virtual
network is implemented
- --provider-segment <provider-segment>
VLAN ID for VLAN networks or Tunnel ID for
GENEVE/GRE/VXLAN networks
- --transparent-vlan
Make the network VLAN transparent
- --no-transparent-vlan
Do not make the network VLAN transparent
2.202. openstack network delete
usage: openstack network delete [-h] <network> [<network> ...]
Positional arguments
- <network>
Network(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.203. openstack network list
usage: openstack network list [-h] [-f {csv,json,table,value,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
2.204. openstack network rbac create
usage: openstack network rbac create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] --type
<type> --action <action> --target-project
<target-project>
[--target-project-domain <target-project-domain>]
[--project <project>]
[--project-domain <project-domain>]
<rbac-object>Positional arguments
- <rbac-object>
The object to which this RBAC policy affects (name or
ID for network objects, ID only for QoS policy
objects)
Optional arguments
- -h, --help
show this help message and exit
- --type <type>
Type of the object that RBAC policy affects
("qos_policy" or "network")
- --action <action>
Action for the RBAC policy ("access_as_external" or
"access_as_shared")
- --target-project <target-project>
The project to which the RBAC policy will be enforced
(name or ID)
- --target-project-domain <target-project-domain>
Domain the target project belongs to (name or ID).
This can be used in case collisions between project
names exist.
- --project <project>
The owner 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.
2.205. openstack network rbac delete
usage: openstack network rbac delete [-h] <rbac-policy> [<rbac-policy> ...]
Positional arguments
- <rbac-policy>
RBAC policy(s) to delete (ID only)
Optional arguments
- -h, --help
show this help message and exit
2.206. openstack network rbac list
usage: openstack network rbac list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.207. openstack network rbac set
usage: openstack network rbac set [-h] [--target-project <target-project>]
[--target-project-domain <target-project-domain>]
<rbac-policy>Positional arguments
- <rbac-policy>
RBAC policy to be modified (ID only)
Optional arguments
- -h, --help
show this help message and exit
- --target-project <target-project>
The project to which the RBAC policy will be enforced
(name or ID)
- --target-project-domain <target-project-domain>
Domain the target project belongs to (name or ID).
This can be used in case collisions between project
names exist.
2.208. openstack network rbac show
usage: openstack network rbac show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<rbac-policy>Positional arguments
- <rbac-policy>
RBAC policy (ID only)
Optional arguments
- -h, --help
show this help message and exit
2.209. openstack network segment list
usage: openstack network segment list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long] [--network <network>]Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
- --network <network>
List network segments that belong to this network
(name or ID)
2.210. openstack network segment show
usage: openstack network segment show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<network-segment>Positional arguments
- <network-segment>
Network segment to display (ID only)
Optional arguments
- -h, --help
show this help message and exit
2.211. openstack network set
usage: openstack network set [-h] [--name <name>] [--enable | --disable]
[--share | --no-share]
[--enable-port-security | --disable-port-security]
[--external | --internal]
[--default | --no-default]
[--provider-network-type <provider-network-type>]
[--provider-physical-network <provider-physical-network>]
[--provider-segment <provider-segment>]
[--transparent-vlan | --no-transparent-vlan]
<network>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
- --enable-port-security
Enable port security by default for ports created on
this network
- --disable-port-security
Disable port security by default for ports created on
this network
- --external
Set this network as an external network (external-net
extension required)
- --internal
Set this network as an internal network
- --default
Set the network as the default external network
- --no-default
Do not use the network as the default external network
- --provider-network-type <provider-network-type>
The physical mechanism by which the virtual network is
implemented. The supported options are: flat, geneve,
gre, local, vlan, vxlan.
- --provider-physical-network <provider-physical-network>
Name of the physical network over which the virtual
network is implemented
- --provider-segment <provider-segment>
VLAN ID for VLAN networks or Tunnel ID for
GENEVE/GRE/VXLAN networks
- --transparent-vlan
Make the network VLAN transparent
- --no-transparent-vlan
Do not make the network VLAN transparent
2.212. openstack network show
usage: openstack network show [-h] [-f {json,shell,table,value,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
2.213. openstack network subport list
usage: openstack network subport list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
--trunk <trunk>Optional arguments
- -h, --help
show this help message and exit
- --trunk <trunk>
List subports belonging to this trunk (name or ID)
2.214. openstack network trunk create
usage: openstack network trunk create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--description <description>]
--parent-port <parent-port>
[--subport <port=,segmentation-type=,segmentation-id=>]
[--enable | --disable]
[--project <project>]
[--project-domain <project-domain>]
<name>Positional arguments
- <name>
Name of the trunk to create
Optional arguments
- -h, --help
show this help message and exit
- --description <description>
A description of the trunk
- --parent-port <parent-port>
Parent port belonging to this trunk (name or ID)
- --subport <port=,segmentation-type=,segmentation-id=>
Subport to add. Subport is of form 'port=<name or ID
>,segmentation-type=,segmentation-ID=' (--subport)
option can be repeated
- --enable
Enable trunk (default)
- --disable
Disable trunk
- --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.
2.215. openstack network trunk delete
usage: openstack network trunk delete [-h] <trunk> [<trunk> ...]
Positional arguments
- <trunk>
Trunk(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.216. openstack network trunk list
usage: openstack network trunk list [-h] [-f {csv,json,table,value,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
2.217. openstack network trunk set
usage: openstack network trunk set [-h] [--name <name>]
[--description <description>]
[--subport <port=,segmentation-type=,segmentation-id=>]
[--enable | --disable]
<trunk>Positional arguments
- <trunk>
Trunk to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Set trunk name
- --description <description>
A description of the trunk
- --subport <port=,segmentation-type=,segmentation-id=>
Subport to add. Subport is of form 'port=<name or ID
>,segmentation-type=,segmentation-ID='(--subport)
option can be repeated
- --enable
Enable trunk
- --disable
Disable trunk
2.218. openstack network trunk show
usage: openstack network trunk show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<trunk>Positional arguments
- <trunk>
Trunk to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.219. openstack network trunk unset
usage: openstack network trunk unset [-h] --subport <subport> <trunk>
Positional arguments
- <trunk>
Unset subports from this trunk (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --subport <subport>
Subport to delete (name or ID of the port) (--subport)
option can be repeated
2.220. openstack object create
usage: openstack object create [-h] [-f {csv,json,table,value,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
2.221. 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
2.222. openstack object list
usage: openstack object list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--prefix <prefix>] [--delimiter <delimiter>]
[--marker <marker>] [--end-marker <end-marker>]
[--limit <limit>] [--long] [--all]
<container>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)
2.223. 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)
2.224. openstack object set
usage: openstack object set [-h] --property <key=value> <container> <object>
Positional arguments
- <container>
Modify <object> from <container>
- <object>
Object to modify
Optional arguments
- -h, --help
show this help message and exit
- --property <key=value>
Set a property on this object (repeat option to set
multiple properties)
2.225. openstack object show
usage: openstack object show [-h] [-f {json,shell,table,value,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
2.226. openstack object store account set
usage: openstack object store account set [-h] --property <key=value>
Optional arguments
- -h, --help
show this help message and exit
- --property <key=value>
Set a property on this account (repeat option to set
multiple properties)
2.227. openstack object store account show
usage: openstack object store account show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]Optional arguments
- -h, --help
show this help message and exit
2.228. openstack object store account unset
usage: openstack object store account unset [-h] --property <key>
Optional arguments
- -h, --help
show this help message and exit
- --property <key>
Property to remove from account (repeat option to remove
multiple properties)
2.229. openstack object unset
usage: openstack object unset [-h] --property <key> <container> <object>
Positional arguments
- <container>
Modify <object> from <container>
- <object>
Object to modify
Optional arguments
- -h, --help
show this help message and exit
- --property <key>
Property to remove from object (repeat option to remove
multiple properties)
2.230. openstack orchestration build info
usage: openstack orchestration build info [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]Optional arguments
- -h, --help
show this help message and exit
2.231. openstack orchestration resource type list
usage: openstack orchestration resource type list [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--filter <key=value>]
[--long]Optional arguments
- -h, --help
show this help message and exit
- --filter <key=value>
Filter parameters to apply on returned resource types.
This can be specified multiple times. It can be any of
name, version or support_status
- --long
Show resource types with corresponding description of
each resource type.
2.232. openstack orchestration resource type show
usage: openstack orchestration resource type show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[--template-type <template-type>]
[--long]
<resource-type>Positional arguments
- <resource-type>
Resource type to show details for
Optional arguments
- -h, --help
show this help message and exit
- --template-type <template-type>
Optional template type to generate, hot or cfn
- --long
Show resource type with corresponding description.
2.233. openstack orchestration service list
usage: openstack orchestration service list [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.234. openstack orchestration template function list
usage: openstack orchestration template function list [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
<template-version>Positional arguments
- <template-version>
Template version to get the functions for
Optional arguments
- -h, --help
show this help message and exit
2.235. openstack orchestration template validate
usage: openstack orchestration template validate [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--prefix PREFIX]
[-e <environment>]
[--show-nested]
[--parameter <key=value>]
[--ignore-errors <error1,error2,...>]
-t <template>Optional arguments
- -h, --help
show this help message and exit
- -e <environment>, --environment <environment>
Path to the environment. Can be specified multiple
times
- --show-nested
Resolve parameters from nested templates as well
- --parameter <key=value>
Parameter values used to create the stack. This can be
specified multiple times
- --ignore-errors <error1,error2,...>
List of heat errors to ignore
- -t <template>, --template <template>
Path to the template
2.236. openstack orchestration template version list
usage: openstack orchestration template version list [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.237. openstack port create
usage: openstack port create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] --network <network>
[--device <device-id>]
[--device-owner <device-owner>]
[--vnic-type <vnic-type>] [--host <host-id>]
[--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
[--binding-profile <binding-profile>]
[--enable | --disable]
[--mac-address <mac-address>]
[--project <project>]
[--project-domain <project-domain>]
<name>Positional arguments
- <name>
Name of this port
Optional arguments
- -h, --help
show this help message and exit
- --network <network>
Network this port belongs to (name or ID)
- --device <device-id>
Port device ID
- --device-owner <device-owner>
Device owner of this port. This is the entity that
uses the port (for example, network:dhcp).
- --vnic-type <vnic-type>
VNIC type for this port (direct | direct-physical |
macvtap | normal | baremetal, default: normal)
- --host <host-id>
Allocate port on host <host-id> (ID only)
- --fixed-ip
subnet=<subnet>,ip-address=<ip-address>
Desired IP and/or subnet (name or ID) for this port:
subnet=<subnet>,ip-address=<ip-address> (repeat option
to set multiple fixed IP addresses)
- --binding-profile <binding-profile>
Custom data to be passed as binding:profile. Data may
be passed as <key>=<value> or JSON. (repeat option to
set multiple binding:profile data)
- --enable
Enable port (default)
- --disable
Disable port
- --mac-address <mac-address>
MAC address of this port
- --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.
2.238. openstack port delete
usage: openstack port delete [-h] <port> [<port> ...]
Positional arguments
- <port>
Port(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.239. openstack port list
usage: openstack port list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--device-owner <device-owner>] [--router <router>]Optional arguments
- -h, --help
show this help message and exit
- --device-owner <device-owner>
List only ports with the specified device owner. This
is the entity that uses the port (for example,
network:dhcp).
- --router <router>
List only ports attached to this router (name or ID)
2.240. openstack port set
usage: openstack port set [-h] [--device <device-id>]
[--device-owner <device-owner>]
[--vnic-type <vnic-type>] [--host <host-id>]
[--enable | --disable] [--name <name>]
[--fixed-ip subnet=<subnet>,ip-address=<ip-address> | --no-fixed-ip]
[--binding-profile <binding-profile> | --no-binding-profile]
<port>Positional arguments
- <port>
Port to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --device <device-id>
Port device ID
- --device-owner <device-owner>
Device owner of this port. This is the entity that
uses the port (for example, network:dhcp).
- --vnic-type <vnic-type>
VNIC type for this port (direct | direct-physical |
macvtap | normal | baremetal, default: normal)
- --host <host-id>
Allocate port on host <host-id> (ID only)
- --enable
Enable port
- --disable
Disable port
- --name <name>
Set port name
- --fixed-ip
subnet=<subnet>,ip-address=<ip-address>
Desired IP and/or subnet (name or ID) for this port:
subnet=<subnet>,ip-address=<ip-address> (repeat option
to set multiple fixed IP addresses)
- --no-fixed-ip
Clear existing information of fixed IP addresses
- --binding-profile <binding-profile>
Custom data to be passed as binding:profile. Data may
be passed as <key>=<value> or JSON. (repeat option to
set multiple binding:profile data)
- --no-binding-profile
Clear existing information of binding:profile
2.241. openstack port show
usage: openstack port show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
<port>Positional arguments
- <port>
Port to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.242. openstack port unset
usage: openstack port unset [-h]
[--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
[--binding-profile <binding-profile-key>]
<port>Positional arguments
- <port>
Port to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --fixed-ip
subnet=<subnet>,ip-address=<ip-address>
Desired IP and/or subnet (name or ID) which should be
removed from this port: subnet=<subnet>,ip-address
=<ip-address> (repeat option to unset multiple fixed
IP addresses)
- --binding-profile <binding-profile-key>
Desired key which should be removed from
binding:profile(repeat option to unset multiple
binding:profile data)
2.243. openstack project create
usage: openstack project create [-h] [-f {json,shell,table,value,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
2.244. 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
2.245. openstack project list
usage: openstack project list [-h] [-f {csv,json,table,value,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
2.246. 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)
2.247. openstack project show
usage: openstack project show [-h] [-f {json,shell,table,value,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
2.248. openstack project unset
usage: openstack project unset [-h] [--property <key>] <project>
Positional arguments
- <project>
Project to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --property <key>
Unset a project property (repeat option to unset multiple
properties)
2.249. openstack ptr record list
usage: openstack ptr record list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.250. openstack ptr record set
usage: openstack ptr record set [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--description DESCRIPTION | --no-description]
[--ttl TTL | --no-ttl] [--all-projects]
[--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
floatingip_id ptrdnamePositional arguments
- floatingip_id
Floating IP ID in format region:floatingip_id
- ptrdname
PTRD Name
Optional arguments
- -h, --help
show this help message and exit
- --description DESCRIPTION
Description
- --no-description
- --ttl TTL TTL
- --no-ttl
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.251. openstack ptr record show
usage: openstack ptr record show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
floatingip_idPositional arguments
- floatingip_id
Floating IP ID in format region:floatingip_id
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.252. openstack ptr record unset
usage: openstack ptr record unset [-h] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
floatingip_idPositional arguments
- floatingip_id
Floating IP ID in format region:floatingip_id
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.253. openstack quota set
usage: openstack quota set [-h] [--class] [--properties <properties>]
[--server-groups <server-groups>] [--ram <ram>]
[--key-pairs <key-pairs>] [--instances <instances>]
[--fixed-ips <fixed-ips>]
[--injected-file-size <injected-file-size>]
[--server-group-members <server-group-members>]
[--injected-files <injected-files>]
[--cores <cores>]
[--injected-path-size <injected-path-size>]
[--gigabytes <gigabytes>] [--volumes <volumes>]
[--snapshots <snapshots>]
[--subnetpools <subnetpools>] [--vips <vips>]
[--members <members>] [--ports <ports>]
[--subnets <subnets>] [--networks <networks>]
[--floating-ips <floating-ips>]
[--health-monitors <health-monitors>]
[--secgroup-rules <secgroup-rules>]
[--secgroups <secgroups>] [--routers <routers>]
[--rbac-policies <rbac-policies>]
[--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
- --server-groups <server-groups>
New value for the server-groups quota
- --ram <ram>
New value for the ram quota
- --key-pairs <key-pairs>
New value for the key-pairs quota
- --instances <instances>
New value for the instances quota
- --fixed-ips <fixed-ips>
New value for the fixed-ips quota
- --injected-file-size <injected-file-size>
New value for the injected-file-size quota
- --server-group-members <server-group-members>
New value for the server-group-members 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
- --subnetpools <subnetpools>
New value for the subnetpools quota
- --vips <vips>
New value for the vips quota
- --members <members>
New value for the members quota
- --ports <ports>
New value for the ports quota
- --subnets <subnets>
New value for the subnets quota
- --networks <networks>
New value for the networks quota
- --floating-ips <floating-ips>
New value for the floating-ips quota
- --health-monitors <health-monitors>
New value for the health-monitors quota
- --secgroup-rules <secgroup-rules>
New value for the secgroup-rules quota
- --secgroups <secgroups>
New value for the secgroups quota
- --routers <routers>
New value for the routers quota
- --rbac-policies <rbac-policies>
New value for the rbac-policies quota
- --volume-type <volume-type>
Set quotas for a specific <volume-type>
2.254. openstack quota show
usage: openstack quota show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--class | --default]
[<project/class>]Positional arguments
- <project/class>
Show quotas for this project or class (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --class
Show quotas for <class>
- --default
Show default quotas for <project>
2.255. openstack recordset create
usage: openstack recordset create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] --records
RECORDS [RECORDS ...] --type TYPE
[--ttl TTL] [--description DESCRIPTION]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
zone_id namePositional 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
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.256. openstack recordset delete
usage: openstack recordset delete [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
zone_id idPositional arguments
- zone_id
Zone ID
- id
RecordSet ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.257. openstack recordset list
usage: openstack recordset list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--name NAME] [--type TYPE] [--data DATA]
[--ttl TTL] [--description DESCRIPTION]
[--status STATUS] [--action ACTION]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
zone_idPositional arguments
- zone_id
Zone ID. To list all recordsets specify 'all'
Optional arguments
- -h, --help
show this help message and exit
- --name NAME
RecordSet Name
- --type TYPE
RecordSet Type
- --data DATA
RecordSet Record Data
- --ttl TTL
Time To Live (Seconds)
- --description DESCRIPTION
Description
- --status STATUS
RecordSet Status
- --action ACTION
RecordSet Action
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.258. openstack recordset set
usage: openstack recordset set [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--records RECORDS [RECORDS ...]]
[--description DESCRIPTION | --no-description]
[--ttl TTL | --no-ttl] [--all-projects]
[--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
zone_id idPositional arguments
- zone_id
Zone ID
- id
RecordSet ID
Optional arguments
- -h, --help
show this help message and exit
- --records RECORDS [RECORDS ...]
Records
- --description DESCRIPTION
Description
- --no-description
- --ttl TTL TTL
- --no-ttl
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.259. openstack recordset show
usage: openstack recordset show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
zone_id idPositional arguments
- zone_id
Zone ID
- id
RecordSet ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.260. openstack resource member create
usage: openstack resource member create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
resource_id resource_type member_idPositional arguments
- resource_id
Resource ID to be shared.
- resource_type
Resource type.
- member_id
Project ID to whom the resource is shared to.
Optional arguments
- -h, --help
show this help message and exit
2.261. openstack resource member delete
usage: openstack resource member delete [-h] resource resource_type member_id
Positional arguments
- resource
Resource ID to be shared.
- resource_type
Resource type.
- member_id
Project ID to whom the resource is shared to.
Optional arguments
- -h, --help
show this help message and exit
2.262. openstack resource member list
usage: openstack resource member list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
resource_id resource_typePositional arguments
- resource_id
Resource id to be shared.
- resource_type
Resource type.
Optional arguments
- -h, --help
show this help message and exit
2.263. openstack resource member show
usage: openstack resource member show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m MEMBER_ID]
resource resource_typePositional arguments
- resource
Resource ID to be shared.
- resource_type
Resource type.
Optional arguments
- -h, --help
show this help message and exit
- -m MEMBER_ID, --member-id MEMBER_ID
Project ID to whom the resource is shared to. No need
to provide this param if you are the resource member.
2.264. openstack resource member update
usage: openstack resource member update [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m MEMBER_ID]
[-s {pending,accepted,rejected}]
resource_id resource_typePositional arguments
- resource_id
Resource ID to be shared.
- resource_type
Resource type.
Optional arguments
- -h, --help
show this help message and exit
- -m MEMBER_ID, --member-id MEMBER_ID
Project ID to whom the resource is shared to. No need
to provide this param if you are the resource member.
- -s {pending,accepted,rejected}, --status {pending,accepted,rejected}
status of the sharing.
2.265. openstack role add
usage: openstack role add [-h] [-f {json,shell,table,value,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)
2.266. openstack role assignment list
usage: openstack role assignment list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--user <user>] [--project <project>]
[--names] [--auth-user] [--auth-project]Optional arguments
- -h, --help
show this help message and exit
- --user <user>
User to filter (name or ID)
- --project <project>
Project to filter (name or ID)
- --names
Display names instead of IDs
- --auth-user
Only list assignments for the authenticated user
- --auth-project
Only list assignments for the project to which the
authenticated user's token is scoped
2.267. openstack role create
usage: openstack role create [-h] [-f {json,shell,table,value,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
2.268. 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
2.269. openstack role list
usage: openstack role list [-h] [-f {csv,json,table,value,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)
2.270. 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)
2.271. openstack role show
usage: openstack role show [-h] [-f {json,shell,table,value,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
2.272. openstack router add port
usage: openstack router add port [-h] <router> <port>
Positional arguments
- <router>
Router to which port will be added (name or ID)
- <port>
Port to be added (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.273. openstack router add subnet
usage: openstack router add subnet [-h] <router> <subnet>
Positional arguments
- <router>
Router to which subnet will be added (name or ID)
- <subnet>
Subnet to be added (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.274. openstack router create
usage: openstack router create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--enable | --disable] [--distributed]
[--project <project>]
[--project-domain <project-domain>]
[--availability-zone-hint <availability-zone>]
<name>Positional arguments
- <name>
New router name
Optional arguments
- -h, --help
show this help message and exit
- --enable
Enable router (default)
- --disable
Disable router
- --distributed
Create a distributed router
- --project <project>
Owner's project (name or ID)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
- --availability-zone-hint <availability-zone>
Availability Zone in which to create this router
(Router Availability Zone extension required, repeat
option to set multiple availability zones)
2.275. openstack router delete
usage: openstack router delete [-h] <router> [<router> ...]
Positional arguments
- <router>
Router(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.276. openstack router list
usage: openstack router list [-h] [-f {csv,json,table,value,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
2.277. openstack router remove port
usage: openstack router remove port [-h] <router> <port>
Positional arguments
- <router>
Router from which port will be removed (name or ID)
- <port>
Port to be removed and deleted (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.278. openstack router remove subnet
usage: openstack router remove subnet [-h] <router> <subnet>
Positional arguments
- <router>
Router from which the subnet will be removed (name or ID)
- <subnet>
Subnet to be removed (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.279. openstack router set
usage: openstack router set [-h] [--name <name>] [--enable | --disable]
[--distributed | --centralized]
[--route destination=<subnet>,gateway=<ip-address> | --no-route]
<router>Positional arguments
- <router>
Router to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Set router name
- --enable
Enable router
- --disable
Disable router
- --distributed
Set router to distributed mode (disabled router only)
- --centralized
Set router to centralized mode (disabled router only)
- --route
destination=<subnet>,gateway=<ip-address>
Routes associated with the router destination:
destination subnet (in CIDR notation) gateway: nexthop
IP address (repeat option to set multiple routes)
- --no-route
Clear routes associated with the router
2.280. openstack router show
usage: openstack router show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<router>Positional arguments
- <router>
Router to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.281. openstack router unset
usage: openstack router unset [-h]
[--route destination=<subnet>,gateway=<ip-address>]
<router>Positional arguments
- <router>
Router to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --route
destination=<subnet>,gateway=<ip-address>
Routes to be removed from the router destination:
destination subnet (in CIDR notation) gateway: nexthop
IP address (repeat option to unset multiple routes)
2.282. openstack secret container create
usage: openstack secret container create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--name NAME] [--type TYPE]
[--secret SECRET]Optional arguments
- -h, --help
show this help message and exit
- --name NAME, -n NAME
a human-friendly name.
- --type TYPE
type of container to create (default: generic).
- --secret SECRET, -s SECRET
one secret to store in a container (can be set
multiple times). Example: --secret
"private_key=https://url.test/v1/secrets/1-2-3-4"
2.283. openstack secret container delete
usage: openstack secret container delete [-h] URI
Positional arguments
- URI
The URI reference for the container
Optional arguments
- -h, --help
show this help message and exit
2.284. openstack secret container get
usage: openstack secret container get [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
URIPositional arguments
- URI
The URI reference for the container.
Optional arguments
- -h, --help
show this help message and exit
2.285. openstack secret container list
usage: openstack secret container list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--limit LIMIT] [--offset OFFSET]
[--name NAME] [--type TYPE]Optional arguments
- -h, --help
show this help message and exit
- --limit LIMIT, -l LIMIT
specify the limit to the number of items to list per
page (default: 10; maximum: 100)
- --offset OFFSET, -o OFFSET
specify the page offset (default: 0)
- --name NAME, -n NAME
specify the container name (default: None)
- --type TYPE, -t TYPE
specify the type filter for the list (default: None).
2.286. openstack secret delete
usage: openstack secret delete [-h] URI
Positional arguments
- URI
The URI reference for the secret
Optional arguments
- -h, --help
show this help message and exit
2.287. openstack secret get
usage: openstack secret get [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--decrypt] [--payload]
[--payload_content_type PAYLOAD_CONTENT_TYPE]
URIPositional arguments
- URI
The URI reference for the secret.
Optional arguments
- -h, --help
show this help message and exit
- --decrypt, -d
if specified, retrieve the unencrypted secret data;
the data type can be specified with --payload-content-
type.
- --payload, -p
if specified, retrieve the unencrypted secret data;
the data type can be specified with --payload-content-
type. If the user wishes to only retrieve the value of
the payload they must add "-f value" to format
returning only the value of the payload
- --payload_content_type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE
the content type of the decrypted secret (default:
text/plain.
2.288. openstack secret list
usage: openstack secret list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--limit LIMIT] [--offset OFFSET] [--name NAME]
[--algorithm ALGORITHM] [--bit-length BIT_LENGTH]
[--mode MODE]Optional arguments
- -h, --help
show this help message and exit
- --limit LIMIT, -l LIMIT
specify the limit to the number of items to list per
page (default: 10; maximum: 100)
- --offset OFFSET, -o OFFSET
specify the page offset (default: 0)
- --name NAME, -n NAME
specify the secret name (default: None)
- --algorithm ALGORITHM, -a ALGORITHM
the algorithm filter for the list(default: None).
- --bit-length BIT_LENGTH, -b BIT_LENGTH
the bit length filter for the list (default: 0).
- --mode MODE, -m MODE
the algorithm mode filter for the list (default:
None).
2.289. openstack secret order create
usage: openstack secret order create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--name NAME] [--algorithm ALGORITHM]
[--bit-length BIT_LENGTH] [--mode MODE]
[--payload-content-type PAYLOAD_CONTENT_TYPE]
[--expiration EXPIRATION]
[--request-type REQUEST_TYPE]
[--subject-dn SUBJECT_DN]
[--source-container-ref SOURCE_CONTAINER_REF]
[--ca-id CA_ID] [--profile PROFILE]
[--request-file REQUEST_FILE]
typePositional arguments
- type
the type of the order to create.
Optional arguments
- -h, --help
show this help message and exit
- --name NAME, -n NAME
a human-friendly name.
- --algorithm ALGORITHM, -a ALGORITHM
the algorithm to be used with the requested key
(default: aes).
- --bit-length BIT_LENGTH, -b BIT_LENGTH
the bit length of the requested secret key (default:
256).
- --mode MODE, -m MODE
the algorithm mode to be used with the requested key
(default: cbc).
- --payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE
the type/format of the secret to be generated
(default: application/octet-stream).
- --expiration EXPIRATION, -x EXPIRATION
the expiration time for the secret in ISO 8601 format.
- --request-type REQUEST_TYPE
the type of the certificate request.
- --subject-dn SUBJECT_DN
the subject of the certificate.
- --source-container-ref SOURCE_CONTAINER_REF
the source of the certificate when using stored-key
requests.
- --ca-id CA_ID
the identifier of the CA to use for the certificate
request.
- --profile PROFILE
the profile of certificate to use.
- --request-file REQUEST_FILE
the file containing the CSR.
2.290. openstack secret order delete
usage: openstack secret order delete [-h] URI
Positional arguments
- URI
The URI reference for the order
Optional arguments
- -h, --help
show this help message and exit
2.291. openstack secret order get
usage: openstack secret order get [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
URIPositional arguments
- URI
The URI reference order.
Optional arguments
- -h, --help
show this help message and exit
2.292. openstack secret order list
usage: openstack secret order list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--limit LIMIT] [--offset OFFSET]Optional arguments
- -h, --help
show this help message and exit
- --limit LIMIT, -l LIMIT
specify the limit to the number of items to list per
page (default: 10; maximum: 100)
- --offset OFFSET, -o OFFSET
specify the page offset (default: 0)
2.293. openstack secret store
usage: openstack secret store [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--payload PAYLOAD] [--secret-type SECRET_TYPE]
[--payload-content-type PAYLOAD_CONTENT_TYPE]
[--payload-content-encoding PAYLOAD_CONTENT_ENCODING]
[--algorithm ALGORITHM]
[--bit-length BIT_LENGTH] [--mode MODE]
[--expiration EXPIRATION]Optional arguments
- -h, --help
show this help message and exit
- --name NAME, -n NAME
a human-friendly name.
- --payload PAYLOAD, -p PAYLOAD
the unencrypted secret; if provided, you must also
provide a payload_content_type
- --secret-type SECRET_TYPE, -s SECRET_TYPE
the secret type; must be one of symmetric, public,
private, certificate, passphrase, opaque (default)
- --payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE
the type/format of the provided secret data;
"text/plain" is assumed to be UTF-8; required when
--payload is supplied.
- --payload-content-encoding PAYLOAD_CONTENT_ENCODING, -e PAYLOAD_CONTENT_ENCODING
required if --payload-content-type is "application
/octet-stream".
- --algorithm ALGORITHM, -a ALGORITHM
the algorithm (default: aes).
- --bit-length BIT_LENGTH, -b BIT_LENGTH
the bit length (default: 256).
- --mode MODE, -m MODE
the algorithm mode; used only for reference (default:
cbc)
- --expiration EXPIRATION, -x EXPIRATION
the expiration time for the secret in ISO 8601 format.
2.294. openstack secret update
usage: openstack secret update [-h] URI payload
Positional arguments
- URI
The URI reference for the secret.
- payload
the unencrypted secret
Optional arguments
- -h, --help
show this help message and exit
2.295. openstack security group create
usage: openstack security group create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--description <description>]
[--project <project>]
[--project-domain <project-domain>]
<name>Positional arguments
- <name>
New security group name
Optional arguments
- -h, --help
show this help message and exit
- --description <description>
Security group description
- --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.
2.296. openstack security group delete
usage: openstack security group delete [-h] <group> [<group> ...]
Positional arguments
- <group>
Security group(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.297. openstack security group list
usage: openstack security group list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.298. openstack security group rule create
usage: openstack security group rule create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--src-ip <ip-address> | --src-group <group>]
[--dst-port <port-range>]
[--icmp-type <icmp-type>]
[--icmp-code <icmp-code>]
[--protocol <protocol>]
[--ingress | --egress]
[--ethertype <ethertype>]
[--project <project>]
[--project-domain <project-domain>]
<group>Positional arguments
- <group>
Create rule in this security group (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --src-ip <ip-address>
Source IP address block (may use CIDR notation;
default for IPv4 rule: 0.0.0.0/0)
- --src-group <group>
Source security group (name or ID)
- --dst-port <port-range>
Destination port, may be a single port or a starting
and ending port range: 137:139. Required for IP
protocols TCP and UDP. Ignored for ICMP IP protocols.
- --icmp-type <icmp-type>
ICMP type for ICMP IP protocols
- --icmp-code <icmp-code>
ICMP code for ICMP IP protocols
- --protocol <protocol>
IP protocol (ah, dccp, egp, esp, gre, icmp, igmp,
ipv6-encap, ipv6-frag, ipv6-icmp, ipv6-nonxt,
ipv6-opts, ipv6-route, ospf, pgm, rsvp, sctp, tcp,
udp, udplite, vrrp and integer representations
[0-255]; default: tcp)
- --ingress
Rule applies to incoming network traffic (default)
- --egress
Rule applies to outgoing network traffic
- --ethertype <ethertype>
Ethertype of network traffic (IPv4, IPv6; default:
based on IP protocol)
- --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.
2.299. openstack security group rule delete
usage: openstack security group rule delete [-h] <rule> [<rule> ...]
Positional arguments
- <rule>
Security group rule(s) to delete (ID only)
Optional arguments
- -h, --help
show this help message and exit
2.300. openstack security group rule list
usage: openstack security group rule list [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long]
[<group>]Positional arguments
- <group>
List all rules in this security group (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
2.301. openstack security group rule show
usage: openstack security group rule show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<rule>Positional arguments
- <rule>
Security group rule to display (ID only)
Optional arguments
- -h, --help
show this help message and exit
2.302. openstack security group set
usage: openstack security group set [-h] [--name <new-name>]
[--description <description>]
<group>Positional arguments
- <group>
Security group to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <new-name>
New security group name
- --description <description>
New security group description
2.303. openstack security group show
usage: openstack security group show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<group>Positional arguments
- <group>
Security group to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.304. openstack server add fixed ip
usage: openstack server add fixed ip [-h] <server> <network>
Positional arguments
- <server>
Server (name or ID) to receive the fixed IP address
- <network>
Network (name or ID) to allocate the fixed IP address from
Optional arguments
- -h, --help
show this help message and exit
2.305. openstack server add floating ip
usage: openstack server add floating ip [-h] <server> <ip-address>
Positional arguments
- <server>
Server (name or ID) to receive the floating IP address
- <ip-address>
Floating IP address (IP address only) to assign to server
Optional arguments
- -h, --help
show this help message and exit
2.306. 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
2.307. 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
2.308. openstack server backup create
usage: openstack server backup create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--name <image-name>]
[--type <backup-type>]
[--rotate <count>] [--wait]
<server>Positional arguments
- <server>
Server to back up (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <image-name>
Name of the backup image (default: server name)
- --type <backup-type>
Used to populate the backup_type property of the
backup image (default: empty)
- --rotate <count>
Number of backups to keep (default: 1)
- --wait
Wait for backup image create to complete
2.309. openstack server create
usage: openstack server create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
(--image <image> | --volume <volume>) --flavor
<flavor>
[--security-group <security-group-name>]
[--key-name <key-name>]
[--property <key=value>]
[--file <dest-filename=source-filename>]
[--user-data <user-data>]
[--availability-zone <zone-name>]
[--block-device-mapping <dev-name=mapping>]
[--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid>]
[--hint <key=value>]
[--config-drive <config-drive-volume>|True]
[--min <count>] [--max <count>] [--wait]
<server-name>Positional arguments
- <server-name>
New server name
Optional arguments
- -h, --help
show this help message and exit
- --image <image>
Create server from this image (name or ID)
- --volume <volume>
Create server from this volume (name or ID)
- --flavor <flavor>
Create server with this flavor (name or ID)
- --security-group <security-group-name>
Security group to assign to this server (name or ID)
(repeat option to set multiple groups)
- --key-name <key-name>
Keypair to inject into this server (optional
extension)
- --property <key=value>
Set a property on this server (repeat option to set
multiple values)
- --file <dest-filename=source-filename>
File to inject into image before boot (repeat option
to set multiple files)
- --user-data <user-data>
User data file to serve from the metadata server
- --availability-zone <zone-name>
Select an availability zone for the server
- --block-device-mapping <dev-name=mapping>
Map block devices; map is
<id>:<type>:<size(GB)>:<delete_on_terminate> (optional
extension)
- --nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid>
Create a NIC on the server. Specify option multiple
times to create multiple NICs. Either net-id or port-
id must be provided, but not both. net-id: attach NIC
to network with this UUID, port-id: attach NIC to port
with this UUID, v4-fixed-ip: IPv4 fixed address for
NIC (optional), v6-fixed-ip: IPv6 fixed address for
NIC (optional).
- --hint <key=value>
Hints for the scheduler (optional extension)
- --config-drive <config-drive-volume>|True
Use specified volume as the config drive, or 'True' to
use an ephemeral drive
- --min <count>
Minimum number of servers to launch (default=1)
- --max <count>
Maximum number of servers to launch (default=1)
- --wait
Wait for build to complete
2.310. 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
2.311. openstack server dump create
usage: openstack server dump create [-h] <server> [<server> ...]
Positional arguments
- <server>
Server(s) to create dump file (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.312. openstack server group create
usage: openstack server group create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] --policy
<policy>
<name>Positional arguments
- <name>
New server group name
Optional arguments
- -h, --help
show this help message and exit
- --policy <policy>
Add a policy to <name> (repeat option to add multiple
policies)
2.313. openstack server group delete
usage: openstack server group delete [-h] <server-group> [<server-group> ...]
Positional arguments
- <server-group>
server group(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.314. openstack server group list
usage: openstack server group list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--all-projects] [--long]Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Display information from all projects (admin only)
- --long
List additional fields in output
2.315. openstack server group show
usage: openstack server group show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<server-group>Positional arguments
- <server-group>
server group to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.316. openstack server image create
usage: openstack server image create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--name <image-name>] [--wait]
<server>Positional arguments
- <server>
Server to create image (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <image-name>
Name of new disk image (default: server name)
- --wait
Wait for operation to complete
2.317. openstack server list
usage: openstack server list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--reservation-id <reservation-id>]
[--ip <ip-address-regex>]
[--ip6 <ip-address-regex>] [--name <name-regex>]
[--instance-name <server-name>]
[--status <status>] [--flavor <flavor>]
[--image <image>] [--host <hostname>]
[--all-projects] [--project <project>]
[--project-domain <project-domain>]
[--user <user>] [--user-domain <user-domain>]
[--long] [--marker <marker>] [--limit <limit>]Optional arguments
- -h, --help
show this help message and exit
- --reservation-id <reservation-id>
Only return instances that match the reservation
- --ip <ip-address-regex>
Regular expression to match IP addresses
- --ip6 <ip-address-regex>
Regular expression to match IPv6 addresses
- --name <name-regex>
Regular expression to match names
- --instance-name <server-name>
Regular expression to match instance name (admin only)
- --status <status>
Search by server status
- --flavor <flavor>
Search by flavor (name or ID)
- --image <image>
Search by image (name or ID)
- --host <hostname>
Search by hostname
- --all-projects
Include all projects (admin only)
- --project <project>
Search by project (admin only) (name or ID)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
- --user <user>
Search by user (admin only) (name or ID)
- --user-domain <user-domain>
Domain the user belongs to (name or ID). This can be
used in case collisions between user names exist.
- --long
List additional fields in output
- --marker <marker>
The last server (name or ID) of the previous page.
Display list of servers after marker. Display all
servers if not specified.
- --limit <limit>
Maximum number of servers to display. If limit equals
-1, all servers will be displayed. If limit is greater
than 'osapi_max_limit' option of Nova API,
'osapi_max_limit' will be used instead.
2.318. openstack server lock
usage: openstack server lock [-h] <server> [<server> ...]
Positional arguments
- <server>
Server(s) to lock (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.319. 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
2.320. openstack server pause
usage: openstack server pause [-h] <server> [<server> ...]
Positional arguments
- <server>
Server(s) to pause (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.321. 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
2.322. openstack server rebuild
usage: openstack server rebuild [-h] [-f {json,shell,table,value,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 the specified image (name or ID).
Defaults to the currently used one.
- --password <password>
Set the password on the rebuilt instance
- --wait
Wait for rebuild to complete
2.323. openstack server remove fixed ip
usage: openstack server remove fixed ip [-h] <server> <ip-address>
Positional arguments
- <server>
Server (name or ID) to remove the fixed IP address from
- <ip-address>
Fixed IP address (IP address only) to remove from the server
Optional arguments
- -h, --help
show this help message and exit
2.324. openstack server remove floating ip
usage: openstack server remove floating ip [-h] <server> <ip-address>
Positional arguments
- <server>
Server (name or ID) to remove the floating IP address from
- <ip-address>
Floating IP address (IP address only) to remove from server
Optional arguments
- -h, --help
show this help message and exit
2.325. 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
2.326. 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
2.327. openstack server rescue
usage: openstack server rescue [-h] [-f {json,shell,table,value,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
2.328. 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
2.329. openstack server restore
usage: openstack server restore [-h] <server> [<server> ...]
Positional arguments
- <server>
Server(s) to restore (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.330. openstack server resume
usage: openstack server resume [-h] <server> [<server> ...]
Positional arguments
- <server>
Server(s) to resume (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.331. openstack server set
usage: openstack server set [-h] [--name <new-name>] [--root-password]
[--property <key=value>] [--state <state>]
<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)
- --state <state>
New server state (valid value: active, error)
2.332. openstack server shelve
usage: openstack server shelve [-h] <server> [<server> ...]
Positional arguments
- <server>
Server(s) to shelve (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.333. openstack server show
usage: openstack server show [-h] [-f {json,shell,table,value,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
2.334. 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)
2.335. openstack server start
usage: openstack server start [-h] <server> [<server> ...]
Positional arguments
- <server>
Server(s) to start (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.336. openstack server stop
usage: openstack server stop [-h] <server> [<server> ...]
Positional arguments
- <server>
Server(s) to stop (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.337. openstack server suspend
usage: openstack server suspend [-h] <server> [<server> ...]
Positional arguments
- <server>
Server(s) to suspend (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.338. openstack server unlock
usage: openstack server unlock [-h] <server> [<server> ...]
Positional arguments
- <server>
Server(s) to unlock (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.339. openstack server unpause
usage: openstack server unpause [-h] <server> [<server> ...]
Positional arguments
- <server>
Server(s) to unpause (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.340. 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
2.341. 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 option to
remove multiple values)
2.342. openstack server unshelve
usage: openstack server unshelve [-h] <server> [<server> ...]
Positional arguments
- <server>
Server(s) to unshelve (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.343. openstack service create
usage: openstack service create [-h] [-f {json,shell,table,value,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
2.344. openstack service delete
usage: openstack service delete [-h] <service> [<service> ...]
Positional arguments
- <service>
Service(s) to delete (type, name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.345. openstack service list
usage: openstack service list [-h] [-f {csv,json,table,value,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
2.346. openstack service show
usage: openstack service show [-h] [-f {json,shell,table,value,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
2.347. openstack snapshot create
usage: openstack snapshot create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--name <name>] [--description <description>]
[--force] [--property <key=value>]
<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
- --property <key=value>
Set a property to this snapshot (repeat option to set
multiple properties)
2.348. 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
2.349. openstack snapshot list
usage: openstack snapshot list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--all-projects] [--long] [--marker <marker>]
[--limit <limit>]Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Include all projects (admin only)
- --long
List additional fields in output
- --marker <marker>
The last snapshot ID of the previous page
- --limit <limit>
Maximum number of snapshots to display
2.350. openstack snapshot set
usage: openstack snapshot set [-h] [--name <name>]
[--description <description>]
[--property <key=value>] [--state <state>]
<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)
- --state <state>
New snapshot state. Valid values are available, error,
creating, deleting, and error-deleting.
2.351. openstack snapshot show
usage: openstack snapshot show [-h] [-f {json,shell,table,value,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
2.352. 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 option to remove
multiple properties)
2.353. openstack software config create
usage: openstack software config create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--config-file <config-file>]
[--definition-file <destination-file>]
[--group <group>]
<config-name>Positional arguments
- <config-name>
Name of the software config to create
Optional arguments
- -h, --help
show this help message and exit
- --config-file <config-file>
Path to JSON/YAML containing map defining <inputs>,
<outputs>, and <options>
- --definition-file <destination-file>
Path to software config script/data
- --group <group>
Group name of tool expected by the software config
2.354. openstack software config delete
usage: openstack software config delete [-h] <config> [<config> ...]
Positional arguments
- <config>
IDs of the software configs to delete
Optional arguments
- -h, --help
show this help message and exit
2.355. openstack software config list
usage: openstack software config list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--limit <limit>] [--marker <id>]Optional arguments
- -h, --help
show this help message and exit
- --limit <limit>
Limit the number of configs returned
- --marker <id>
Return configs that appear after the given config ID
2.356. openstack software config show
usage: openstack software config show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--config-only]
<config>Positional arguments
- <config>
ID of the config
Optional arguments
- -h, --help
show this help message and exit
- --config-only
Only display the value of the <config> property.
2.357. openstack software deployment create
usage: openstack software deployment create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--input-value <key=value>]
[--action <action>]
[--config <config>]
[--signal-transport <signal-transport>]
[--container <container>]
[--timeout <timeout>] --server
<server>
<deployment-name>Positional arguments
- <deployment-name>
Name of the derived config associated with this
deployment. This is used to apply a sort order to the
list of configurations currently deployed to the
server.
Optional arguments
- -h, --help
show this help message and exit
- --input-value <key=value>
Input value to set on the deployment. This can be
specified multiple times.
- --action <action>
Name of an action for this deployment. This can be a
custom action, or one of CREATE, UPDATE, DELETE,
SUSPEND, RESUME. Default is UPDATE
- --config <config> ID
of the configuration to deploy
- --signal-transport <signal-transport>
How the server should signal to heat with the
deployment output values. TEMP_URL_SIGNAL will create
a Swift TempURL to be signaled via HTTP PUT.
ZAQAR_SIGNAL will create a dedicated zaqar queue to be
signaled using the provided keystone
credentials.NO_SIGNAL will result in the resource
going to the COMPLETE state without waiting for any
signal
- --container <container>
Optional name of container to store TEMP_URL_SIGNAL
objects in. If not specified a container will be
created with a name derived from the DEPLOY_NAME
- --timeout <timeout>
Deployment timeout in minutes
- --server <server> ID
of the server being deployed to
2.358. openstack software deployment delete
usage: openstack software deployment delete [-h]
<deployment> [<deployment> ...]Positional arguments
- <deployment>
ID of the deployment(s) to delete.
Optional arguments
- -h, --help
show this help message and exit
2.359. openstack software deployment list
usage: openstack software deployment list [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--server <server>] [--long]Optional arguments
- -h, --help
show this help message and exit
- --server <server> ID
of the server to fetch deployments for
- --long
List more fields in output
2.360. openstack software deployment metadata show
usage: openstack software deployment metadata show [-h] <server>
Positional arguments
- <server>
ID of the server to fetch deployments for
Optional arguments
- -h, --help
show this help message and exit
2.361. openstack software deployment output show
usage: openstack software deployment output show [-h] [--all] [--long]
<deployment> [<output-name>]Positional arguments
- <deployment>
ID of deployment to show the output for
- <output-name>
Name of an output to display
Optional arguments
- -h, --help
show this help message and exit
- --all
Display all deployment outputs
- --long
Show full deployment logs in output
2.362. openstack software deployment show
usage: openstack software deployment show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--long]
<deployment>Positional arguments
- <deployment>
ID of the deployment
Optional arguments
- -h, --help
show this help message and exit
- --long
Show more fields in output
2.363. openstack stack abandon
usage: openstack stack abandon [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--output-file <output-file>]
<stack>Positional arguments
- <stack>
Name or ID of stack to abandon
Optional arguments
- -h, --help
show this help message and exit
- --output-file <output-file>
File to output abandon results
2.364. openstack stack adopt
usage: openstack stack adopt [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-e <environment>]
[--timeout <timeout>] [--enable-rollback]
[--parameter <key=value>] [--wait] --adopt-file
<adopt-file>
<stack-name>Positional arguments
- <stack-name>
Name of the stack to adopt
Optional arguments
- -h, --help
show this help message and exit
- -e <environment>, --environment <environment>
Path to the environment. Can be specified multiple
times
- --timeout <timeout>
Stack creation timeout in minutes
- --enable-rollback
Enable rollback on create/update failure
- --parameter <key=value>
Parameter values used to create the stack. Can be
specified multiple times
- --wait
Wait until stack adopt completes
- --adopt-file <adopt-file>
Path to adopt stack data file
2.365. openstack stack cancel
usage: openstack stack cancel [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--wait]
<stack> [<stack> ...]Positional arguments
- <stack>
Stack(s) to cancel (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --wait
Wait for check to complete
2.366. openstack stack check
usage: openstack stack check [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--wait]
<stack> [<stack> ...]Positional arguments
- <stack>
Stack(s) to check update (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --wait
Wait for check to complete
2.367. openstack stack create
usage: openstack stack create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-e <environment>]
[--timeout <timeout>] [--pre-create <resource>]
[--enable-rollback] [--parameter <key=value>]
[--parameter-file <key=file>] [--wait]
[--tags <tag1,tag2...>] [--dry-run] -t
<template>
<stack-name>Positional arguments
- <stack-name>
Name of the stack to create
Optional arguments
- -h, --help
show this help message and exit
- -e <environment>, --environment <environment>
Path to the environment. Can be specified multiple
times
- --timeout <timeout>
Stack creating timeout in minutes
- --pre-create <resource>
Name of a resource to set a pre-create hook to.
Resources in nested stacks can be set using slash as a
separator: nested_stack/another/my_resource. You can
use wildcards to match multiple stacks or resources:
nested_stack/an*/*_resource. This can be specified
multiple times
- --enable-rollback
Enable rollback on create/update failure
- --parameter <key=value>
Parameter values used to create the stack. This can be
specified multiple times
- --parameter-file <key=file>
Parameter values from file used to create the stack.
This can be specified multiple times. Parameter values
would be the content of the file
- --wait
Wait until stack goes to CREATE_COMPLETE or
CREATE_FAILED
- --tags <tag1,tag2...>
A list of tags to associate with the stack
- --dry-run
Do not actually perform the stack create, but show
what would be created
- -t <template>, --template <template>
Path to the template
2.368. openstack stack delete
usage: openstack stack delete [-h] [--yes] [--wait] <stack> [<stack> ...]
Positional arguments
- <stack>
Stack(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --yes
Skip yes/no prompt (assume yes)
- --wait
Wait for stack delete to complete
2.369. openstack stack environment show
usage: openstack stack environment show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<NAME or ID>Positional arguments
- <NAME or ID>
Name or ID of stack to query
Optional arguments
- -h, --help
show this help message and exit
2.370. openstack stack event list
usage: openstack stack event list [-h] [-f {csv,json,log,table,value,yaml}]
[-c COLUMN] [--noindent]
[--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--resource <resource>]
[--filter <key=value>] [--limit <limit>]
[--marker <id>] [--nested-depth <depth>]
[--sort <key>[:<direction>]] [--follow]
<stack>Positional arguments
- <stack>
Name or ID of stack to show events for
Optional arguments
- -h, --help
show this help message and exit
- --resource <resource>
Name of resource to show events for. Note: this cannot
be specified with --nested-depth
- --filter <key=value>
Filter parameters to apply on returned events
- --limit <limit>
Limit the number of events returned
- --marker <id>
Only return events that appear after the given ID
- --nested-depth <depth>
Depth of nested stacks from which to display events.
Note: this cannot be specified with --resource
- --sort <key>[:<direction>]
Sort output by selected keys and directions (asc or
desc) (default: asc). Specify multiple times to sort
on multiple keys
- --follow
Print events until process is halted
2.371. openstack stack event show
usage: openstack stack event show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<stack> <resource> <event>Positional arguments
- <stack>
Name or ID of stack to show events for
- <resource>
Name of the resource event belongs to
- <event>
ID of event to display details for
Optional arguments
- -h, --help
show this help message and exit
2.372. openstack stack failures list
usage: openstack stack failures list [-h] [--long] <stack>
Positional arguments
- <stack>
Stack to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --long
Show full deployment logs in output
2.373. openstack stack file list
usage: openstack stack file list [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<NAME or ID>Positional arguments
- <NAME or ID>
Name or ID of stack to query
Optional arguments
- -h, --help
show this help message and exit
2.374. openstack stack hook clear
usage: openstack stack hook clear [-h] [--pre-create] [--pre-update]
[--pre-delete]
<stack> <resource> [<resource> ...]Positional arguments
- <stack>
Stack to display (name or ID)
- <resource>
Resource names with hooks to clear. Resources in nested stacks
can be set using slash as a separator:
nested_stack/another/my_resource. You can use wildcards to
match multiple stacks or resources:
nested_stack/an*/*_resource
Optional arguments
- -h, --help
show this help message and exit
- --pre-create
Clear the pre-create hooks
- --pre-update
Clear the pre-update hooks
- --pre-delete
Clear the pre-delete hooks
2.375. openstack stack hook poll
usage: openstack stack hook poll [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--nested-depth <nested-depth>]
<stack>Positional arguments
- <stack>
Stack to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --nested-depth <nested-depth>
Depth of nested stacks from which to display hooks
2.376. openstack stack list
usage: openstack stack list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--deleted] [--nested] [--hidden]
[--property <key=value>] [--tags <tag1,tag2...>]
[--tag-mode <mode>] [--limit <limit>]
[--marker <id>] [--sort <key>[:<direction>]]
[--all-projects] [--short] [--long]Optional arguments
- -h, --help
show this help message and exit
- --deleted
Include soft-deleted stacks in the stack listing
- --nested
Include nested stacks in the stack listing
- --hidden
Include hidden stacks in the stack listing
- --property <key=value>
Filter properties to apply on returned stacks (repeat
to filter on multiple properties)
- --tags <tag1,tag2...>
List of tags to filter by. Can be combined with --tag-
mode to specify how to filter tags
- --tag-mode <mode>
Method of filtering tags. Must be one of "any", "not",
or "not-any". If not specified, multiple tags will be
combined with the boolean AND expression
- --limit <limit>
The number of stacks returned
- --marker <id>
Only return stacks that appear after the given ID
- --sort <key>[:<direction>]
Sort output by selected keys and directions (asc or
desc) (default: asc). Specify multiple times to sort
on multiple properties
- --all-projects
Include all projects (admin only)
- --short
List fewer fields in output
- --long
List additional fields in output, this is implied by
--all-projects
2.377. openstack stack output list
usage: openstack stack output list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
<stack>Positional arguments
- <stack>
Name or ID of stack to query
Optional arguments
- -h, --help
show this help message and exit
2.378. openstack stack output show
usage: openstack stack output show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] [--all]
<stack> [<output>]Positional arguments
- <stack>
Name or ID of stack to query
- <output>
Name of an output to display
Optional arguments
- -h, --help
show this help message and exit
- --all
Display all stack outputs
2.379. openstack stack resource list
usage: openstack stack resource list [-h] [-f {csv,dot,json,table,value,yaml}]
[-c COLUMN] [--noindent]
[--max-width <integer>]
[--quote {all,minimal,none,nonnumeric}]
[--long] [-n <nested-depth>]
[--filter <key=value>]
<stack>Positional arguments
- <stack>
Name or ID of stack to query
Optional arguments
- -h, --help
show this help message and exit
- --long
Enable detailed information presented for each
resource in resource list
- -n <nested-depth>, --nested-depth <nested-depth>
Depth of nested stacks from which to display resources
- --filter <key=value>
Filter parameters to apply on returned resources based
on their name, status, type, action, id and
physical_resource_id
2.380. openstack stack resource mark unhealthy
usage: openstack stack resource mark unhealthy [-h] [--reset]
<stack> <resource> [reason]Positional arguments
- <stack>
Name or ID of stack the resource belongs to
- <resource>
Name of the resource
- reason
Reason for state change
Optional arguments
- -h, --help
show this help message and exit
- --reset
Set the resource as healthy
2.381. openstack stack resource metadata
usage: openstack stack resource metadata [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<stack> <resource>Positional arguments
- <stack>
Stack to display (name or ID)
- <resource>
Name of the resource to show the metadata for
Optional arguments
- -h, --help
show this help message and exit
2.382. openstack stack resource show
usage: openstack stack resource show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--with-attr <attribute>]
<stack> <resource>Positional arguments
- <stack>
Name or ID of stack to query
- <resource>
Name or ID of resource
Optional arguments
- -h, --help
show this help message and exit
- --with-attr <attribute>
Attribute to show, can be specified multiple times
2.383. openstack stack resource signal
usage: openstack stack resource signal [-h] [--data <data>]
[--data-file <data-file>]
<stack> <resource>Positional arguments
- <stack>
Name or ID of stack the resource belongs to
- <resource>
Name of the resoure to signal
Optional arguments
- -h, --help
show this help message and exit
- --data <data> JSON
Data to send to the signal handler
- --data-file <data-file>
File containing JSON data to send to the signal
handler
2.384. openstack stack resume
usage: openstack stack resume [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--wait]
<stack> [<stack> ...]Positional arguments
- <stack>
Stack(s) to resume (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --wait
Wait for resume to complete
2.385. openstack stack show
usage: openstack stack show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<stack>Positional arguments
- <stack>
Stack to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.386. openstack stack snapshot create
usage: openstack stack snapshot create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--name <name>]
<stack>Positional arguments
- <stack>
Name or ID of stack
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Name of snapshot
2.387. openstack stack snapshot delete
usage: openstack stack snapshot delete [-h] <stack> <snapshot>
Positional arguments
- <stack>
Name or ID of stack
- <snapshot>
ID of stack snapshot
Optional arguments
- -h, --help
show this help message and exit
2.388. openstack stack snapshot list
usage: openstack stack snapshot list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
<stack>Positional arguments
- <stack>
Name or ID of stack containing the snapshots
Optional arguments
- -h, --help
show this help message and exit
2.389. openstack stack snapshot restore
usage: openstack stack snapshot restore [-h] <stack> <snapshot>
Positional arguments
- <stack>
Name or ID of stack containing the snapshot
- <snapshot>
ID of the snapshot to restore
Optional arguments
- -h, --help
show this help message and exit
2.390. openstack stack snapshot show
usage: openstack stack snapshot show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<stack> <snapshot>Positional arguments
- <stack>
Name or ID of stack containing the snapshot
- <snapshot>
ID of the snapshot to show
Optional arguments
- -h, --help
show this help message and exit
2.391. openstack stack suspend
usage: openstack stack suspend [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--wait]
<stack> [<stack> ...]Positional arguments
- <stack>
Stack(s) to suspend (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --wait
Wait for suspend to complete
2.392. openstack stack template show
usage: openstack stack template show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<stack>Positional arguments
- <stack>
Name or ID of stack to query
Optional arguments
- -h, --help
show this help message and exit
2.393. openstack stack update
usage: openstack stack update [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-t <template>]
[-e <environment>] [--pre-update <resource>]
[--timeout <timeout>] [--rollback <value>]
[--dry-run] [--parameter <key=value>]
[--parameter-file <key=file>] [--existing]
[--clear-parameter <parameter>]
[--tags <tag1,tag2...>] [--wait]
<stack>Positional arguments
- <stack>
Name or ID of stack to update
Optional arguments
- -h, --help
show this help message and exit
- -t <template>, --template <template>
Path to the template
- -e <environment>, --environment <environment>
Path to the environment. Can be specified multiple
times
- --pre-update <resource>
Name of a resource to set a pre-update hook to.
Resources in nested stacks can be set using slash as a
separator: nested_stack/another/my_resource. You can
use wildcards to match multiple stacks or resources:
nested_stack/an*/*_resource. This can be specified
multiple times
- --timeout <timeout>
Stack update timeout in minutes
- --rollback <value>
Set rollback on update failure. Value "enabled" sets
rollback to enabled. Value "disabled" sets rollback to
disabled. Value "keep" uses the value of existing
stack to be updated (default)
- --dry-run
Do not actually perform the stack update, but show
what would be changed
- --parameter <key=value>
Parameter values used to create the stack. This can be
specified multiple times
- --parameter-file <key=file>
Parameter values from file used to create the stack.
This can be specified multiple times. Parameter value
would be the content of the file
- --existing
Re-use the template, parameters and environment of the
current stack. If the template argument is omitted
then the existing template is used. If no
--environment is specified then the existing
environment is used. Parameters specified in
--parameter will patch over the existing values in the
current stack. Parameters omitted will keep the
existing values
- --clear-parameter <parameter>
Remove the parameters from the set of parameters of
current stack for the stack-update. The default value
in the template will be used. This can be specified
multiple times
- --tags <tag1,tag2...>
An updated list of tags to associate with the stack
- --wait
Wait until stack goes to UPDATE_COMPLETE or
UPDATE_FAILED
2.394. openstack subnet create
usage: openstack subnet create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--project <project>]
[--project-domain <project-domain>]
[--subnet-pool <subnet-pool> | --use-default-subnet-pool]
[--prefix-length <prefix-length>]
[--subnet-range <subnet-range>]
[--dhcp | --no-dhcp] [--gateway <gateway>]
[--ip-version {4,6}]
[--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
[--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
--network <network>
[--allocation-pool start=<ip-address>,end=<ip-address>]
[--dns-nameserver <dns-nameserver>]
[--host-route destination=<subnet>,gateway=<ip-address>]
namePositional arguments
- name
New subnet name
Optional arguments
- -h, --help
show this help message and exit
- --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.
- --subnet-pool <subnet-pool>
Subnet pool from which this subnet will obtain a CIDR
(Name or ID)
- --use-default-subnet-pool
Use default subnet pool for --ip-version
- --prefix-length <prefix-length>
Prefix length for subnet allocation from subnet pool
- --subnet-range <subnet-range>
Subnet range in CIDR notation (required if --subnet-
pool is not specified, optional otherwise)
- --dhcp
Enable DHCP (default)
- --no-dhcp
Disable DHCP
- --gateway <gateway>
Specify a gateway for the subnet. The three options
are: <ip-address>: Specific IP address to use as the
gateway, 'auto': Gateway address should automatically
be chosen from within the subnet itself, 'none': This
subnet will not use a gateway, e.g.: --gateway
192.168.9.1, --gateway auto, --gateway none (default
is 'auto').
- --ip-version {4,6} IP
version (default is 4). Note that when subnet pool
is specified, IP version is determined from the subnet
pool and this option is ignored.
- --ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}
IPv6 RA (Router Advertisement) mode, valid modes:
[dhcpv6-stateful, dhcpv6-stateless, slaac]
- --ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}
IPv6 address mode, valid modes: [dhcpv6-stateful,
dhcpv6-stateless, slaac]
- --network <network>
Network this subnet belongs to (name or ID)
- --allocation-pool
start=<ip-address>,end=<ip-address>
Allocation pool IP addresses for this subnet e.g.:
start=192.168.199.2,end=192.168.199.254 (repeat option
to add multiple IP addresses)
- --dns-nameserver <dns-nameserver>
DNS server for this subnet (repeat option to set
multiple DNS servers)
- --host-route
destination=<subnet>,gateway=<ip-address>
Additional route for this subnet e.g.:
destination=10.10.0.0/16,gateway=192.168.71.254
destination: destination subnet (in CIDR notation)
gateway: nexthop IP address (repeat option to add
multiple routes)
2.395. openstack subnet delete
usage: openstack subnet delete [-h] <subnet> [<subnet> ...]
Positional arguments
- <subnet>
Subnet(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.396. openstack subnet list
usage: openstack subnet list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--long]
[--ip-version <ip-version>] [--dhcp | --no-dhcp]Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
- --ip-version <ip-version>
List only subnets of given IP version in
output.Allowed values for IP version are 4 and 6.
- --dhcp
List subnets which have DHCP enabled
- --no-dhcp
List subnets which have DHCP disabled
2.397. openstack subnet pool create
usage: openstack subnet pool create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
--pool-prefix <pool-prefix>
[--default-prefix-length <default-prefix-length>]
[--min-prefix-length <min-prefix-length>]
[--max-prefix-length <max-prefix-length>]
[--project <project>]
[--project-domain <project-domain>]
[--address-scope <address-scope>]
[--default | --no-default]
[--share | --no-share]
<name>Positional arguments
- <name>
Name of the new subnet pool
Optional arguments
- -h, --help
show this help message and exit
- --pool-prefix <pool-prefix>
Set subnet pool prefixes (in CIDR notation) (repeat
option to set multiple prefixes)
- --default-prefix-length <default-prefix-length>
Set subnet pool default prefix length
- --min-prefix-length <min-prefix-length>
Set subnet pool minimum prefix length
- --max-prefix-length <max-prefix-length>
Set subnet pool maximum prefix length
- --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.
- --address-scope <address-scope>
Set address scope associated with the subnet pool
(name or ID), prefixes must be unique across address
scopes
- --default
Set this as a default subnet pool
- --no-default
Set this as a non-default subnet pool
- --share
Set this subnet pool as shared
- --no-share
Set this subnet pool as not shared
2.398. openstack subnet pool delete
usage: openstack subnet pool delete [-h] <subnet-pool> [<subnet-pool> ...]
Positional arguments
- <subnet-pool>
Subnet pool(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.399. openstack subnet pool list
usage: openstack subnet pool list [-h] [-f {csv,json,table,value,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
2.400. openstack subnet pool set
usage: openstack subnet pool set [-h] [--name <name>]
[--pool-prefix <pool-prefix>]
[--default-prefix-length <default-prefix-length>]
[--min-prefix-length <min-prefix-length>]
[--max-prefix-length <max-prefix-length>]
[--address-scope <address-scope> | --no-address-scope]
[--default | --no-default]
<subnet-pool>Positional arguments
- <subnet-pool>
Subnet pool to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Set subnet pool name
- --pool-prefix <pool-prefix>
Set subnet pool prefixes (in CIDR notation) (repeat
option to set multiple prefixes)
- --default-prefix-length <default-prefix-length>
Set subnet pool default prefix length
- --min-prefix-length <min-prefix-length>
Set subnet pool minimum prefix length
- --max-prefix-length <max-prefix-length>
Set subnet pool maximum prefix length
- --address-scope <address-scope>
Set address scope associated with the subnet pool
(name or ID), prefixes must be unique across address
scopes
- --no-address-scope
Remove address scope associated with the subnet pool
- --default
Set this as a default subnet pool
- --no-default
Set this as a non-default subnet pool
2.401. openstack subnet pool show
usage: openstack subnet pool show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<subnet-pool>Positional arguments
- <subnet-pool>
Subnet pool to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.402. openstack subnet pool unset
usage: openstack subnet pool unset [-h] [--pool-prefix <pool-prefix>]
<subnet-pool>Positional arguments
- <subnet-pool>
Subnet pool to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --pool-prefix <pool-prefix>
Remove subnet pool prefixes (in CIDR notation).
(repeat option to unset multiple prefixes).
2.403. openstack subnet set
usage: openstack subnet set [-h] [--name <name>] [--dhcp | --no-dhcp]
[--gateway <gateway>]
[--allocation-pool start=<ip-address>,end=<ip-address>]
[--dns-nameserver <dns-nameserver>]
[--host-route destination=<subnet>,gateway=<ip-address>]
<subnet>Positional arguments
- <subnet>
Subnet to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Updated name of the subnet
- --dhcp
Enable DHCP
- --no-dhcp
Disable DHCP
- --gateway <gateway>
Specify a gateway for the subnet. The options are:
<ip-address>: Specific IP address to use as the
gateway, 'none': This subnet will not use a gateway,
e.g.: --gateway 192.168.9.1, --gateway none.
- --allocation-pool
start=<ip-address>,end=<ip-address>
Allocation pool IP addresses for this subnet e.g.:
start=192.168.199.2,end=192.168.199.254 (repeat option
to add multiple IP addresses)
- --dns-nameserver <dns-nameserver>
DNS server for this subnet (repeat option to set
multiple DNS servers)
- --host-route
destination=<subnet>,gateway=<ip-address>
Additional route for this subnet e.g.:
destination=10.10.0.0/16,gateway=192.168.71.254
destination: destination subnet (in CIDR notation)
gateway: nexthop IP address (repeat option to add
multiple routes)
2.404. openstack subnet show
usage: openstack subnet show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<subnet>Positional arguments
- <subnet>
Subnet to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.405. openstack subnet unset
usage: openstack subnet unset [-h]
[--allocation-pool start=<ip-address>,end=<ip-address>]
[--dns-nameserver <dns-nameserver>]
[--host-route destination=<subnet>,gateway=<ip-address>]
<subnet>Positional arguments
- <subnet>
Subnet to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --allocation-pool
start=<ip-address>,end=<ip-address>
Allocation pool to be removed from this subnet e.g.:
start=192.168.199.2,end=192.168.199.254 (repeat option
to unset multiple Allocation pools)
- --dns-nameserver <dns-nameserver>
DNS server to be removed from this subnet (repeat
option to set multiple DNS servers)
- --host-route
destination=<subnet>,gateway=<ip-address>
Route to be removed from this subnet e.g.:
destination=10.10.0.0/16,gateway=192.168.71.254
destination: destination subnet (in CIDR notation)
gateway: nexthop IP address (repeat option to unset
multiple host routes)
2.406. openstack task execution list
usage: openstack task execution list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[workflow_execution]Positional arguments
- workflow_execution
Workflow execution ID associated with list of Tasks.
Optional arguments
- -h, --help
show this help message and exit
2.407. openstack task execution rerun
usage: openstack task execution rerun [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--resume] [-e ENV]
idPositional arguments
- id
Task identifier
Optional arguments
- -h, --help
show this help message and exit
- --resume
rerun only failed or unstarted action executions for
with-items task
- -e ENV, --env ENV
Environment variables
2.408. openstack task execution show
usage: openstack task execution show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
taskPositional arguments
- task
Task identifier
Optional arguments
- -h, --help
show this help message and exit
2.409. openstack tld create
usage: openstack tld create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] --name NAME
[--description DESCRIPTION] [--all-projects]
[--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]Optional arguments
- -h, --help
show this help message and exit
- --name NAME TLD
Name
- --description DESCRIPTION
Description
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.410. openstack tld delete
usage: openstack tld delete [-h] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
idPositional arguments
- id
TLD ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.411. openstack tld list
usage: openstack tld list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--name NAME] [--description DESCRIPTION]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]Optional arguments
- -h, --help
show this help message and exit
- --name NAME TLD NAME
- --description DESCRIPTION
TLD Description
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.412. openstack tld set
usage: openstack tld set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--name NAME]
[--description DESCRIPTION | --no-description]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
idPositional arguments
- id
TLD ID
Optional arguments
- -h, --help
show this help message and exit
- --name NAME TLD
Name
- --description DESCRIPTION
Description
- --no-description
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.413. openstack tld show
usage: openstack tld show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
idPositional arguments
- id
TLD ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.414. openstack token issue
usage: openstack token issue [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]Optional arguments
- -h, --help
show this help message and exit
2.415. 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
2.416. openstack usage list
usage: openstack usage list [-h] [-f {csv,json,table,value,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)
2.417. openstack usage show
usage: openstack usage show [-h] [-f {json,shell,table,value,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)
2.418. openstack user create
usage: openstack user create [-h] [-f {json,shell,table,value,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
2.419. 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
2.420. openstack user list
usage: openstack user list [-h] [-f {csv,json,table,value,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
2.421. openstack user role list
usage: openstack user role list [-h] [-f {csv,json,table,value,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)
2.422. 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 modify (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
2.423. openstack user show
usage: openstack user show [-h] [-f {json,shell,table,value,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
2.424. openstack volume backup create
usage: openstack volume backup create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--name <name>]
[--description <description>]
[--container <container>]
[--snapshot <snapshot>] [--force]
[--incremental]
<volume>Positional arguments
- <volume>
Volume to backup (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Name of the backup
- --description <description>
Description of the backup
- --container <container>
Optional backup container name
- --snapshot <snapshot>
Snapshot to backup (name or ID)
- --force
Allow to back up an in-use volume
- --incremental
Perform an incremental backup
2.425. openstack volume backup delete
usage: openstack volume backup delete [-h] [--force] <backup> [<backup> ...]
Positional arguments
- <backup>
Backup(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --force
Allow delete in state other than error or available
2.426. openstack volume backup list
usage: openstack volume backup list [-h] [-f {csv,json,table,value,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
2.427. openstack volume backup restore
usage: openstack volume backup restore [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<backup> <volume>Positional arguments
- <backup>
Backup to restore (name or ID)
- <volume>
Volume to restore to (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.428. openstack volume backup show
usage: openstack volume backup show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
<backup>Positional arguments
- <backup>
Backup to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.429. openstack volume create
usage: openstack volume create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX] --size <size>
[--type <volume-type>] [--image <image>]
[--snapshot <snapshot>] [--source <volume>]
[--description <description>] [--user <user>]
[--project <project>]
[--availability-zone <availability-zone>]
[--property <key=value>]
<name>Positional arguments
- <name>
Volume name
Optional arguments
- -h, --help
show this help message and exit
- --size <size>
Volume size in GB
- --type <volume-type>
Set the type of volume
- --image <image>
Use <image> as source of volume (name or ID)
- --snapshot <snapshot>
Use <snapshot> as source of volume (name or ID)
- --source <volume>
Volume to clone (name or ID)
- --description <description>
Volume description
- --user <user>
Specify an alternate user (name or ID)
- --project <project>
Specify an alternate project (name or ID)
- --availability-zone <availability-zone>
Create volume in <availability-zone>
- --property <key=value>
Set a property to this volume (repeat option to set
multiple properties)
2.430. openstack volume delete
usage: openstack volume delete [-h] [--force | --purge]
<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)
- --purge
Remove any snapshots along with volume(s) (defaults to False)
2.431. openstack volume list
usage: openstack volume list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--project <project>]
[--project-domain <project-domain>]
[--user <user>] [--user-domain <user-domain>]
[--name <name>] [--status <status>]
[--all-projects] [--long]Optional arguments
- -h, --help
show this help message and exit
- --project <project>
Filter results by project (name or ID) (admin only)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
- --user <user>
Filter results by user (name or ID) (admin only)
- --user-domain <user-domain>
Domain the user belongs to (name or ID). This can be
used in case collisions between user names exist.
- --name <name>
Filter results by volume name
- --status <status>
Filter results by status
- --all-projects
Include all projects (admin only)
- --long
List additional fields in output
2.432. 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
2.433. openstack volume qos create
usage: openstack volume qos create [-h] [-f {json,shell,table,value,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)
2.434. openstack volume qos delete
usage: openstack volume qos delete [-h] [--force] <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
- --force
Allow to delete in-use QoS specification(s)
2.435. 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
2.436. openstack volume qos list
usage: openstack volume qos list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.437. 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)
2.438. openstack volume qos show
usage: openstack volume qos show [-h] [-f {json,shell,table,value,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
2.439. 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)
2.440. openstack volume service list
usage: openstack volume service list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--host <host>] [--service <service>]
[--long]Optional arguments
- -h, --help
show this help message and exit
- --host <host>
List services on specified host (name only)
- --service <service>
List only specified service (name only)
- --long
List additional fields in output
2.441. openstack volume set
usage: openstack volume set [-h] [--name <name>] [--size <size>]
[--description <description>]
[--property <key=value>]
[--image-property <key=value>] [--state <state>]
<volume>Positional arguments
- <volume>
Volume to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
New volume name
- --size <size>
Extend volume size in GB
- --description <description>
New volume description
- --property <key=value>
Set a property on this volume (repeat option to set
multiple properties)
- --image-property <key=value>
Set an image property on this volume (repeat option to
set multiple image properties)
- --state <state>
New volume state ("available", "error", "creating",
"deleting", "in-use", "attaching", "detaching",
"error_deleting" or "maintenance")
2.442. openstack volume show
usage: openstack volume show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
<volume-id>Positional arguments
- <volume-id>
Volume to display (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.443. openstack volume transfer request list
usage: openstack volume transfer request list [-h]
[-f {csv,json,table,value,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
Shows detail for all projects. Admin only. (defaults
to False)
2.444. openstack volume type create
usage: openstack volume type create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--description <description>]
[--public | --private]
[--property <key=value>]
[--project <project>]
[--project-domain <project-domain>]
<name>Positional arguments
- <name>
Volume type name
Optional arguments
- -h, --help
show this help message and exit
- --description <description>
Volume type description
- --public
Volume type is accessible to the public
- --private
Volume type is not accessible to the public
- --property <key=value>
Set a property on this volume type (repeat option to
set multiple properties)
- --project <project>
Allow <project> to access private type (name or ID)
(Must be used with --private option)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
2.445. openstack volume type delete
usage: openstack volume type delete [-h] <volume-type> [<volume-type> ...]
Positional arguments
- <volume-type>
Volume type(s) to delete (name or ID)
Optional arguments
- -h, --help
show this help message and exit
2.446. openstack volume type list
usage: openstack volume type list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--long] [--public | --private]Optional arguments
- -h, --help
show this help message and exit
- --long
List additional fields in output
- --public
List only public types
- --private
List only private types (admin only)
2.447. openstack volume type set
usage: openstack volume type set [-h] [--name <name>] [--description <name>]
[--property <key=value>]
[--project <project>]
[--project-domain <project-domain>]
<volume-type>Positional arguments
- <volume-type>
Volume type to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --name <name>
Set volume type name
- --description <name>
Set volume type description
- --property <key=value>
Set a property on this volume type (repeat option to
set multiple properties)
- --project <project>
Set volume type access to project (name or ID) (admin
only)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
2.448. openstack volume type show
usage: openstack volume type show [-h] [-f {json,shell,table,value,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
2.449. openstack volume type unset
usage: openstack volume type unset [-h] [--property <key>]
[--project <project>]
[--project-domain <project-domain>]
<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>
Remove a property from this volume type (repeat option
to remove multiple properties)
- --project <project>
Removes volume type access to project (name or ID)
(admin only)
- --project-domain <project-domain>
Domain the project belongs to (name or ID). This can
be used in case collisions between project names
exist.
2.450. openstack volume unset
usage: openstack volume unset [-h] [--property <key>] [--image-property <key>]
<volume>Positional arguments
- <volume>
Volume to modify (name or ID)
Optional arguments
- -h, --help
show this help message and exit
- --property <key>
Remove a property from volume (repeat option to remove
multiple properties)
- --image-property <key>
Remove an image property from volume (repeat option to
remove multiple image properties)
2.451. openstack workbook create
usage: openstack workbook create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
definitionPositional arguments
- definition
Workbook definition file
Optional arguments
- -h, --help
show this help message and exit
2.452. openstack workbook delete
usage: openstack workbook delete [-h] workbook [workbook ...]
Positional arguments
- workbook
Name of workbook(s).
Optional arguments
- -h, --help
show this help message and exit
2.453. openstack workbook list
usage: openstack workbook list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.454. openstack workbook show
usage: openstack workbook show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
workbookPositional arguments
- workbook
Workbook name
Optional arguments
- -h, --help
show this help message and exit
2.455. openstack workbook update
usage: openstack workbook update [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
definitionPositional arguments
- definition
Workbook definition file
Optional arguments
- -h, --help
show this help message and exit
2.456. openstack workbook validate
usage: openstack workbook validate [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
definitionPositional arguments
- definition
Workbook definition file
Optional arguments
- -h, --help
show this help message and exit
2.457. openstack workflow create
usage: openstack workflow create [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--public]
definitionPositional arguments
- definition
Workflow definition file.
Optional arguments
- -h, --help
show this help message and exit
- --public
With this flag workflow will be marked as "public".
2.458. openstack workflow delete
usage: openstack workflow delete [-h] workflow [workflow ...]
Positional arguments
- workflow
Name or ID of workflow(s).
Optional arguments
- -h, --help
show this help message and exit
2.459. openstack workflow engine service list
usage: openstack workflow engine service list [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.460. openstack workflow env create
usage: openstack workflow env create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
filePositional arguments
- file
Environment configuration file in JSON or YAML
Optional arguments
- -h, --help
show this help message and exit
2.461. openstack workflow env delete
usage: openstack workflow env delete [-h] environment [environment ...]
Positional arguments
- environment
Name of environment(s).
Optional arguments
- -h, --help
show this help message and exit
2.462. openstack workflow env list
usage: openstack workflow env list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.463. openstack workflow env show
usage: openstack workflow env show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
environmentPositional arguments
- environment
Environment name
Optional arguments
- -h, --help
show this help message and exit
2.464. openstack workflow env update
usage: openstack workflow env update [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
filePositional arguments
- file
Environment configuration file in JSON or YAML
Optional arguments
- -h, --help
show this help message and exit
2.465. openstack workflow execution create
usage: openstack workflow execution create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-d DESCRIPTION]
workflow_identifier
[workflow_input] [params]Positional arguments
- workflow_identifier
Workflow ID or name. Workflow name will be deprecated
sinceMitaka.
- workflow_input
Workflow input
- params
Workflow additional parameters
Optional arguments
- -h, --help
show this help message and exit
- -d DESCRIPTION, --description DESCRIPTION
Execution description
2.466. openstack workflow execution delete
usage: openstack workflow execution delete [-h] execution [execution ...]
Positional arguments
- execution
Id of execution identifier(s).
Optional arguments
- -h, --help
show this help message and exit
2.467. openstack workflow execution list
usage: openstack workflow execution list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--marker [MARKER]] [--limit [LIMIT]]
[--sort_keys [SORT_KEYS]]
[--sort_dirs [SORT_DIRS]]Optional arguments
- -h, --help
show this help message and exit
- --marker [MARKER]
The last execution uuid of the previous page, displays
list of executions after "marker".
- --limit [LIMIT]
Maximum number of executions to return in a single
result.
- --sort_keys [SORT_KEYS]
Comma-separated list of sort keys to sort results by.
Default: created_at. Example: mistral execution-list
--sort_keys=id,description
- --sort_dirs [SORT_DIRS]
Comma-separated list of sort directions. Default: asc.
Example: mistral execution-list
--sort_keys=id,description --sort_dirs=asc,desc
2.468. openstack workflow execution show
usage: openstack workflow execution show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
executionPositional arguments
- execution
Execution identifier
Optional arguments
- -h, --help
show this help message and exit
2.469. openstack workflow execution update
usage: openstack workflow execution update [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-s {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}]
[-e ENV] [-d DESCRIPTION]
idPositional arguments
- id
Execution identifier
Optional arguments
- -h, --help
show this help message and exit
- -s {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}, --state {RUNNING,PAUSED,SUCCESS,ERROR,CANCELLED}
Execution state
- -e ENV, --env ENV
Environment variables
- -d DESCRIPTION, --description DESCRIPTION
Execution description
2.470. openstack workflow list
usage: openstack workflow list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]Optional arguments
- -h, --help
show this help message and exit
2.471. openstack workflow show
usage: openstack workflow show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
workflowPositional arguments
- workflow
Workflow ID or name.
Optional arguments
- -h, --help
show this help message and exit
2.472. openstack workflow update
usage: openstack workflow update [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--id ID] [--public]
definitionPositional arguments
- definition
Workflow definition
Optional arguments
- -h, --help
show this help message and exit
- --id ID
Workflow ID.
- --public
With this flag workflow will be marked as "public".
2.473. openstack workflow validate
usage: openstack workflow validate [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
definitionPositional arguments
- definition
Workflow definition file
Optional arguments
- -h, --help
show this help message and exit
2.474. openstack zone abandon
usage: openstack zone abandon [-h] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
idPositional arguments
- id
Zone ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.475. openstack zone axfr
usage: openstack zone axfr [-h] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
idPositional arguments
- id
Zone ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.476. openstack zone blacklist create
usage: openstack zone blacklist create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
--pattern PATTERN
[--description DESCRIPTION]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]Optional arguments
- -h, --help
show this help message and exit
- --pattern PATTERN
Blacklist pattern
- --description DESCRIPTION
Description
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.477. openstack zone blacklist delete
usage: openstack zone blacklist delete [-h] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
idPositional arguments
- id
Blacklist ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.478. openstack zone blacklist list
usage: openstack zone blacklist list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.479. openstack zone blacklist set
usage: openstack zone blacklist set [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--pattern PATTERN]
[--description DESCRIPTION | --no-description]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
idPositional arguments
- id
Blacklist ID
Optional arguments
- -h, --help
show this help message and exit
- --pattern PATTERN
Blacklist pattern
- --description DESCRIPTION
Description
- --no-description
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.480. openstack zone blacklist show
usage: openstack zone blacklist show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
idPositional arguments
- id
Blacklist ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.481. openstack zone create
usage: openstack zone create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--email EMAIL] [--type TYPE]
[--ttl TTL] [--description DESCRIPTION]
[--masters MASTERS [MASTERS ...]]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
namePositional 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
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.482. openstack zone delete
usage: openstack zone delete [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [--all-projects]
[--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
idPositional arguments
- id
Zone ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.483. openstack zone export create
usage: openstack zone export create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
zone_idPositional arguments
- zone_id
Zone ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.484. openstack zone export delete
usage: openstack zone export delete [-h] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
zone_export_idPositional arguments
- zone_export_id
Zone Export ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.485. openstack zone export list
usage: openstack zone export list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.486. openstack zone export show
usage: openstack zone export show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
zone_export_idPositional arguments
- zone_export_id
Zone Export ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.487. openstack zone export showfile
usage: openstack zone export showfile [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
zone_export_idPositional arguments
- zone_export_id
Zone Export ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.488. openstack zone import create
usage: openstack zone import create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
zone_file_pathPositional arguments
- zone_file_path
Path to a zone file
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.489. openstack zone import delete
usage: openstack zone import delete [-h] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
zone_import_idPositional arguments
- zone_import_id
Zone Import ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.490. openstack zone import list
usage: openstack zone import list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.491. openstack zone import show
usage: openstack zone import show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
zone_import_idPositional arguments
- zone_import_id
Zone Import ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.492. openstack zone list
usage: openstack zone list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--name NAME] [--email EMAIL] [--type TYPE]
[--ttl TTL] [--description DESCRIPTION]
[--status STATUS] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]Optional arguments
- -h, --help
show this help message and exit
- --name NAME
Zone Name
- --email EMAIL
Zone Email
- --type TYPE
Zone Type
- --ttl TTL
Time To Live (Seconds)
- --description DESCRIPTION
Description
- --status STATUS
Zone Status
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.493. openstack zone set
usage: openstack zone set [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--email EMAIL] [--ttl TTL]
[--description DESCRIPTION | --no-description]
[--masters MASTERS [MASTERS ...]] [--all-projects]
[--edit-managed] [--sudo-project-id SUDO_PROJECT_ID]
idPositional arguments
- id
Zone ID
Optional arguments
- -h, --help
show this help message and exit
- --email EMAIL
Zone Email
- --ttl TTL
Time To Live (Seconds)
- --description DESCRIPTION
Description
- --no-description
- --masters MASTERS [MASTERS ...]
Zone Masters
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.494. openstack zone show
usage: openstack zone show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
idPositional arguments
- id
Zone ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.495. openstack zone transfer accept list
usage: openstack zone transfer accept list [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.496. openstack zone transfer accept request
usage: openstack zone transfer accept request [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
--transfer-id TRANSFER_ID --key
KEY [--all-projects]
[--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]Optional arguments
- -h, --help
show this help message and exit
- --transfer-id TRANSFER_ID
Transfer ID
- --key KEY
Transfer Key
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.497. openstack zone transfer accept show
usage: openstack zone transfer accept show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
idPositional arguments
- id
Zone Tranfer Accept ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.498. openstack zone transfer request create
usage: openstack zone transfer request create [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--target-project-id TARGET_PROJECT_ID]
[--description DESCRIPTION]
[--all-projects]
[--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
zone_idPositional 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
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.499. openstack zone transfer request delete
usage: openstack zone transfer request delete [-h] [--all-projects]
[--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
idPositional arguments
- id
Zone Transfer Request ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.500. openstack zone transfer request list
usage: openstack zone transfer request list [-h]
[-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.501. openstack zone transfer request set
usage: openstack zone transfer request set [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--description DESCRIPTION | --no-description]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
idPositional arguments
- id
Zone Transfer Request ID
Optional arguments
- -h, --help
show this help message and exit
- --description DESCRIPTION
Description
- --no-description
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
2.502. openstack zone transfer request show
usage: openstack zone transfer request show [-h]
[-f {json,shell,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent] [--prefix PREFIX]
[--all-projects] [--edit-managed]
[--sudo-project-id SUDO_PROJECT_ID]
idPositional arguments
- id
Zone Tranfer Request ID
Optional arguments
- -h, --help
show this help message and exit
- --all-projects
Show results from all projects. Default: False
- --edit-managed
Edit resources marked as managed. Default: False
- --sudo-project-id SUDO_PROJECT_ID
Project ID to impersonate for this command. Default:
None
