From 510624f7878dffa6cf7af4d8873b81a7ff408354 Mon Sep 17 00:00:00 2001 From: KATO Tomoyuki Date: Mon, 5 Sep 2016 22:53:48 +0900 Subject: [PATCH] [cli-ref] change OSC ref into the link to OSC doc To reflect the discussion at docs ML: http://lists.openstack.org/pipermail/openstack-docs/2016-September/009095.html Change-Id: I0e530e93ac1ce0f273562561465794d4dc460036 --- doc/cli-reference/source/openstack.rst | 18466 +---------------------- 1 file changed, 6 insertions(+), 18460 deletions(-) diff --git a/doc/cli-reference/source/openstack.rst b/doc/cli-reference/source/openstack.rst index 3dc502cf94..89ee384391 100644 --- a/doc/cli-reference/source/openstack.rst +++ b/doc/cli-reference/source/openstack.rst @@ -1,18465 +1,11 @@ -.. ## WARNING ##################################### -.. This file is tool-generated. Do not edit manually. -.. ################################################## - ============================= OpenStack command-line client ============================= -The openstack client is a common OpenStackcommand-line interface (CLI). +OpenStackClient is a command-line client for OpenStack that brings +the command set for the various APIs together in a single shell +with a uniform command structure. -This chapter documents :command:`openstack` version ``3.2.0``. - -For help on a specific :command:`openstack` command, enter: - -.. code-block:: console - - $ openstack help COMMAND - -.. _openstack_command_usage: - -openstack usage -~~~~~~~~~~~~~~~ - -.. code-block:: console - - usage: openstack [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug] - [--os-cloud ] - [--os-region-name ] - [--os-cacert ] [--os-cert ] - [--os-key ] [--verify | --insecure] - [--os-default-domain ] - [--os-interface ] [--timing] [--os-beta-command] - [--os-profile hmac-key] - [--os-compute-api-version ] - [--os-network-api-version ] - [--os-image-api-version ] - [--os-volume-api-version ] - [--os-identity-api-version ] - [--os-object-api-version ] - [--os-baremetal-api-version ] - [--os-dns-api-version ] - [--os-queues-api-version ] - [--os-data-processing-api-version ] - [--os-data-processing-url OS_DATA_PROCESSING_URL] - [--os-key-manager-api-version ] - [--os-orchestration-api-version ] - [--inspector-api-version INSPECTOR_API_VERSION] - [--inspector-url INSPECTOR_URL] [--os-auth-type ] - [--os-authorization-code ] - [--os-project-domain-id ] - [--os-protocol ] - [--os-project-name ] - [--os-trust-id ] - [--os-domain-name ] - [--os-user-domain-id ] - [--os-access-token-type ] - [--os-identity-provider-url ] - [--os-default-domain-name ] - [--os-access-token-endpoint ] - [--os-access-token ] - [--os-domain-id ] - [--os-user-domain-name ] - [--os-openid-scope ] - [--os-user-id ] - [--os-identity-provider ] - [--os-username ] - [--os-auth-url ] - [--os-client-secret ] - [--os-default-domain-id ] - [--os-discovery-endpoint ] - [--os-client-id ] - [--os-project-domain-name ] - [--os-password ] - [--os-redirect-uri ] - [--os-endpoint ] [--os-url ] - [--os-token ] [--os-passcode ] - [--os-project-id ] - -.. _openstack_command_options: - -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 name in clouds.yaml (Env: OS_CLOUD) - -``--os-region-name `` - Authentication region name (Env: OS_REGION_NAME) - -``--os-cacert `` - CA certificate bundle file (Env: OS_CACERT) - -``--os-cert `` - Client certificate bundle file (Env: OS_CERT) - -``--os-key `` - Client certificate key file (Env: OS_KEY) - -``--verify`` - Verify server certificate (default) - -``--insecure`` - Disable server certificate verification - -``--os-default-domain `` - Default domain ID, default=default. (Env: - OS_DEFAULT_DOMAIN) - -``--os-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, default=2 (Env: - OS_COMPUTE_API_VERSION) - -``--os-network-api-version `` - Network API version, default=2.0 (Env: - OS_NETWORK_API_VERSION) - -``--os-image-api-version `` - Image API version, default=1 (Env: - OS_IMAGE_API_VERSION) - -``--os-volume-api-version `` - Volume API version, default=2 (Env: - OS_VOLUME_API_VERSION) - -``--os-identity-api-version `` - Identity API version, default=3 (Env: - OS_IDENTITY_API_VERSION) - -``--os-object-api-version `` - Object API version, default=1 (Env: - OS_OBJECT_API_VERSION) - -``--os-baremetal-api-version `` - Baremetal API version, default=1.6 (Env: - OS_BAREMETAL_API_VERSION) - -``--os-dns-api-version `` - DNS API version, default=2 (Env: OS_DNS_API_VERSION) - -``--os-queues-api-version `` - Queues API version, default=2 (Env: - OS_QUEUES_API_VERSION) - -``--os-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-key-manager-api-version `` - Barbican API version, default=1 (Env: - OS_KEY_MANAGER_API_VERSION) - -``--os-orchestration-api-version `` - Orchestration API version, default=1 (Env: - OS_ORCHESTRATION_API_VERSION) - -``--inspector-api-version INSPECTOR_API_VERSION`` - inspector API version, only 1 is supported now (env: - INSPECTOR_VERSION). - -``--inspector-url INSPECTOR_URL`` - inspector URL, defaults to localhost (env: - INSPECTOR_URL). - -``--os-auth-type `` - Select an authentication type. Available types: - v2token, admin_token, v3oidcauthcode, v2password, - v3samlpassword, v3password, v3oidcaccesstoken, - v3oidcpassword, token, v3oidcclientcredentials, - v3tokenlessauth, v3token, v3totp, password, - token_endpoint. Default: selected based on :option:`--os-` - username/:option:`--os-token` (Env: OS_AUTH_TYPE) - -``--os-authorization-code `` - With v3oidcauthcode: OAuth 2.0 Authorization Code - (Env: OS_AUTHORIZATION_CODE) - -``--os-project-domain-id `` - With v3oidcauthcode: Domain ID containing project With - v3samlpassword: Domain ID containing project With - v3password: Domain ID containing project With - v3oidcaccesstoken: Domain ID containing project With - v3oidcpassword: 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 - v3totp: Domain ID containing project With password: - Domain ID containing project (Env: - OS_PROJECT_DOMAIN_ID) - -``--os-protocol `` - With v3oidcauthcode: Protocol for federated plugin - With v3samlpassword: Protocol for federated plugin - With v3oidcaccesstoken: Protocol for federated plugin - With v3oidcpassword: Protocol for federated plugin - With v3oidcclientcredentials: Protocol for federated - plugin (Env: OS_PROTOCOL) - -``--os-project-name `` - With v3oidcauthcode: 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 - v3oidcpassword: 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 v3totp: Project name to scope to With - password: Project name to scope to (Env: - OS_PROJECT_NAME) - -``--os-trust-id `` - With v2token: Trust ID With v3oidcauthcode: Trust ID - With v2password: Trust ID With v3samlpassword: Trust - ID With v3password: Trust ID With v3oidcaccesstoken: - Trust ID With v3oidcpassword: Trust ID With token: - Trust ID With v3oidcclientcredentials: Trust ID With - v3token: Trust ID With v3totp: Trust ID With password: - Trust ID (Env: OS_TRUST_ID) - -``--os-domain-name `` - With v3oidcauthcode: 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 - v3oidcpassword: 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 v3totp: Domain name to scope to With password: - Domain name to scope to (Env: OS_DOMAIN_NAME) - -``--os-user-domain-id `` - With v3password: User's domain id With v3totp: User's - domain id With password: User's domain id (Env: - OS_USER_DOMAIN_ID) - -``--os-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 `` - With v3samlpassword: An Identity Provider URL, where - the SAML2 authentication request will be sent. (Env: - OS_IDENTITY_PROVIDER_URL) - -``--os-default-domain-name `` - 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. 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. (Env: OS_DEFAULT_DOMAIN_NAME) - -``--os-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 `` - With v3oidcaccesstoken: OAuth 2.0 Access Token (Env: - OS_ACCESS_TOKEN) - -``--os-domain-id `` - With v3oidcauthcode: 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 v3oidcpassword: 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 v3totp: Domain ID to scope - to With password: Domain ID to scope to (Env: - OS_DOMAIN_ID) - -``--os-user-domain-name `` - With v3password: User's domain name With v3totp: - User's domain name With password: User's domain name - (Env: OS_USER_DOMAIN_NAME) - -``--os-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 `` - With v2password: User ID to login with With - v3password: User ID With v3totp: User ID With - password: User id (Env: OS_USER_ID) - -``--os-identity-provider `` - With v3oidcauthcode: Identity Provider's name With - v3samlpassword: Identity Provider's name With - v3oidcaccesstoken: Identity Provider's name With - v3oidcpassword: Identity Provider's name With - v3oidcclientcredentials: Identity Provider's name - (Env: OS_IDENTITY_PROVIDER) - -``--os-username `` - With v2password: Username to login with With - v3samlpassword: Username With v3password: Username - With v3oidcpassword: Username With v3totp: Username - With password: Username (Env: OS_USERNAME) - -``--os-auth-url `` - With v2token: Authentication URL With v3oidcauthcode: - Authentication URL With v2password: Authentication URL - With v3samlpassword: Authentication URL With - v3password: Authentication URL With v3oidcaccesstoken: - Authentication URL With v3oidcpassword: Authentication - URL With token: Authentication URL With - v3oidcclientcredentials: Authentication URL With - v3tokenlessauth: Authentication URL With v3token: - Authentication URL With v3totp: Authentication URL - With password: Authentication URL (Env: OS_AUTH_URL) - -``--os-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 `` - 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. - 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. - (Env: OS_DEFAULT_DOMAIN_ID) - -``--os-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 `` - 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 `` - With v3oidcauthcode: Domain name containing project - With v3samlpassword: Domain name containing project - With v3password: Domain name containing project With - v3oidcaccesstoken: Domain name containing project With - v3oidcpassword: 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 v3totp: Domain name containing project With - password: Domain name containing project (Env: - OS_PROJECT_DOMAIN_NAME) - -``--os-password `` - With v2password: Password to use With v3samlpassword: - Password With v3password: User's password With - v3oidcpassword: Password With password: User's - password (Env: OS_PASSWORD) - -``--os-redirect-uri `` - With v3oidcauthcode: OpenID Connect Redirect URL (Env: - OS_REDIRECT_URI) - -``--os-endpoint `` - With admin_token: The endpoint that will always be - used (Env: OS_ENDPOINT) - -``--os-url `` - With token_endpoint: Specific service endpoint to use - (Env: OS_URL) - -``--os-token `` - With v2token: Token With admin_token: The token that - will always be used With token: Token to authenticate - with With v3token: Token to authenticate with With - token_endpoint: Authentication token to use (Env: - OS_TOKEN) - -``--os-passcode `` - With v3totp: User's TOTP passcode (Env: OS_PASSCODE) - -``--os-project-id `` - With v3oidcauthcode: 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 - v3oidcpassword: 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 v3token: Project ID to scope to - With v3totp: Project ID to scope to With password: - Project ID to scope to (Env: OS_PROJECT_ID) - -OpenStack with Identity API v3 commands -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. important:: - - OpenStack Identity API v2 is deprecated in - the Mitaka release and later. - - You can select the Identity API version to use - by adding the - :option:`--os-identity-api-version` - parameter or by setting the corresponding - environment variable: - - .. code-block:: console - - export OS_IDENTITY_API_VERSION=3 - -.. _openstack_access_token_create: - -openstack access token create ------------------------------ - -.. code-block:: console - - usage: openstack access token create [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - --consumer-key - --consumer-secret - --request-key - --request-secret - --verifier - -Create an access token - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--consumer-key `` - Consumer key (required) - -``--consumer-secret `` - Consumer secret (required) - -``--request-key `` - Request token to exchange for access token (required) - -``--request-secret `` - Secret associated with (required) - -``--verifier `` - Verifier associated with (required) - -.. _openstack_acl_delete: - -openstack acl delete --------------------- - -.. code-block:: console - - usage: openstack acl delete [-h] URI - -Delete ACLs for a secret or container as identified by its href. - -**Positional arguments:** - -``URI`` - The URI reference for the secret or container. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_acl_get: - -openstack acl get ------------------ - -.. code-block:: console - - usage: openstack acl get [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - URI - -Retrieve ACLs for a secret or container by providing its href. - -**Positional arguments:** - -``URI`` - The URI reference for the secret or container. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_acl_submit: - -openstack acl submit --------------------- - -.. code-block:: console - - usage: openstack acl submit [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--user [USERS]] - [--project-access | --no-project-access] - [--operation-type {read}] - URI - -Submit ACL on a secret or container as identified by its href. - -**Positional arguments:** - -``URI`` - The URI reference for the secret or container. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--user [USERS], -u [USERS]`` - Keystone userid(s) for ACL. - -``--project-access`` - Flag to enable project access behavior. - -``--no-project-access`` - Flag to disable project access behavior. - -``--operation-type {read}, -o {read}`` - Type of Barbican operation ACL is set for - -.. _openstack_acl_user_add: - -openstack acl user add ----------------------- - -.. code-block:: console - - usage: openstack acl user add [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--user [USERS]] - [--project-access | --no-project-access] - [--operation-type {read}] - URI - -Add ACL users to a secret or container as identified by its href. - -**Positional arguments:** - -``URI`` - The URI reference for the secret or container. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--user [USERS], -u [USERS]`` - Keystone userid(s) for ACL. - -``--project-access`` - Flag to enable project access behavior. - -``--no-project-access`` - Flag to disable project access behavior. - -``--operation-type {read}, -o {read}`` - Type of Barbican operation ACL is set for - -.. _openstack_acl_user_remove: - -openstack acl user remove -------------------------- - -.. code-block:: console - - usage: openstack acl user remove [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--user [USERS]] - [--project-access | --no-project-access] - [--operation-type {read}] - URI - -Remove ACL users from a secret or container as identified by its href. - -**Positional arguments:** - -``URI`` - The URI reference for the secret or container. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--user [USERS], -u [USERS]`` - Keystone userid(s) for ACL. - -``--project-access`` - Flag to enable project access behavior. - -``--no-project-access`` - Flag to disable project access behavior. - -``--operation-type {read}, -o {read}`` - Type of Barbican operation ACL is set for - -.. _openstack_address_scope_create: - -openstack address scope create ------------------------------- - -.. code-block:: console - - usage: openstack address scope create [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - [--ip-version {4,6}] - [--project ] - [--project-domain ] - [--share | --no-share] - - -Create a new Address Scope - -**Positional arguments:** - -```` - New address scope name - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--ip-version {4,6} IP`` - version (default is 4) - -``--project `` - Owner's project (name or ID) - -``--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) - -.. _openstack_address_scope_delete: - -openstack address scope delete ------------------------------- - -.. code-block:: console - - usage: openstack address scope delete [-h] - [ ...] - -Delete address scope(s) - -**Positional arguments:** - -```` - Address scope(s) to delete (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_address_scope_list: - -openstack address scope list ----------------------------- - -.. code-block:: console - - usage: openstack address scope list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List address scopes - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_address_scope_set: - -openstack address scope set ---------------------------- - -.. code-block:: console - - usage: openstack address scope set [-h] [--name ] [--share | --no-share] - - -Set address scope properties - -**Positional arguments:** - -```` - Address scope to modify (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--name `` - Set address scope name - -``--share`` - Share the address scope between projects - -``--no-share`` - Do not share the address scope between projects - -.. _openstack_address_scope_show: - -openstack address scope show ----------------------------- - -.. code-block:: console - - usage: openstack address scope show [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - - -Display address scope details - -**Positional arguments:** - -```` - Address scope to display (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_aggregate_add_host: - -openstack aggregate add host ----------------------------- - -.. code-block:: console - - usage: openstack aggregate add host [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - - -Add host to aggregate - -**Positional arguments:** - -```` - Aggregate (name or ID) - -```` - Host to add to - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_aggregate_create: - -openstack aggregate create --------------------------- - -.. code-block:: console - - usage: openstack aggregate create [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - [--zone ] - [--property ] - - -Create a new aggregate - -**Positional arguments:** - -```` - New aggregate name - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--zone `` - Availability zone name - -``--property `` - Property to add to this aggregate (repeat option to - set multiple properties) - -.. _openstack_aggregate_delete: - -openstack aggregate delete --------------------------- - -.. code-block:: console - - usage: openstack aggregate delete [-h] [ ...] - -Delete existing aggregate(s) - -**Positional arguments:** - -```` - Aggregate(s) to delete (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_aggregate_list: - -openstack aggregate list ------------------------- - -.. code-block:: console - - usage: openstack aggregate list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--long] - -List all aggregates - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--long`` - List additional fields in output - -.. _openstack_aggregate_remove_host: - -openstack aggregate remove host -------------------------------- - -.. code-block:: console - - usage: openstack aggregate remove host [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - - -Remove host from aggregate - -**Positional arguments:** - -```` - Aggregate (name or ID) - -```` - Host to remove from - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_aggregate_set: - -openstack aggregate set ------------------------ - -.. code-block:: console - - usage: openstack aggregate set [-h] [--name ] - [--zone ] - [--property ] - - -Set aggregate properties - -**Positional arguments:** - -```` - Aggregate to modify (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--name `` - Set aggregate name - -``--zone `` - Set availability zone name - -``--property `` - Property to set on (repeat option to set - multiple properties) - -.. _openstack_aggregate_show: - -openstack aggregate show ------------------------- - -.. code-block:: console - - usage: openstack aggregate show [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - - -Display aggregate details - -**Positional arguments:** - -```` - Aggregate to display (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_aggregate_unset: - -openstack aggregate unset -------------------------- - -.. code-block:: console - - usage: openstack aggregate unset [-h] --property - -Unset aggregate properties - -**Positional arguments:** - -```` - Aggregate to modify (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--property `` - Property to remove from aggregate (repeat option to remove - multiple properties) - -.. _openstack_availability_zone_list: - -openstack availability zone list --------------------------------- - -.. code-block:: console - - usage: openstack availability zone list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--compute] [--network] [--volume] - [--long] - -List availability zones and their status - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--compute`` - List compute availability zones - -``--network`` - List network availability zones - -``--volume`` - List volume availability zones - -``--long`` - List additional fields in output - -.. _openstack_backup_create: - -openstack backup create ------------------------ - -.. code-block:: console - - usage: openstack backup create [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] [--name ] - [--description ] - [--container ] - [--snapshot ] [--force] - [--incremental] - - -Create new backup - -**Positional arguments:** - -```` - Volume to backup (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--name `` - Name of the backup - -``--description `` - Description of the backup - -``--container `` - Optional backup container name - -``--snapshot `` - Snapshot to backup (name or ID) - -``--force`` - Allow to back up an in-use volume - -``--incremental`` - Perform an incremental backup - -.. _openstack_backup_delete: - -openstack backup delete ------------------------ - -.. code-block:: console - - usage: openstack backup delete [-h] [--force] [ ...] - -Delete backup(s) - -**Positional arguments:** - -```` - 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 - -.. _openstack_backup_list: - -openstack backup list ---------------------- - -.. code-block:: console - - usage: openstack backup list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--quote {all,minimal,none,nonnumeric}] [--long] - -List backups - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--long`` - List additional fields in output - -.. _openstack_backup_restore: - -openstack backup restore ------------------------- - -.. code-block:: console - - usage: openstack backup restore [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - - -Restore backup - -**Positional arguments:** - -```` - Backup to restore (name or ID) - -```` - Volume to restore to (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_backup_show: - -openstack backup show ---------------------- - -.. code-block:: console - - usage: openstack backup show [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--prefix PREFIX] - - -Display backup details - -**Positional arguments:** - -```` - Backup to display (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_baremetal_introspection_abort: - -openstack baremetal introspection abort ---------------------------------------- - -.. code-block:: console - - usage: openstack baremetal introspection abort [-h] uuid - -Abort running introspection for node. - -**Positional arguments:** - -``uuid`` - baremetal node UUID - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_baremetal_introspection_data_save: - -openstack baremetal introspection data save -------------------------------------------- - -.. code-block:: console - - usage: openstack baremetal introspection data save [-h] [--file ] - uuid - -Save or display raw introspection data. - -**Positional arguments:** - -``uuid`` - baremetal node UUID - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--file `` - downloaded introspection data filename (default: stdout) - -.. _openstack_baremetal_introspection_reprocess: - -openstack baremetal introspection reprocess -------------------------------------------- - -.. code-block:: console - - usage: openstack baremetal introspection reprocess [-h] uuid - -Reprocess stored introspection data - -**Positional arguments:** - -``uuid`` - baremetal node UUID - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_baremetal_introspection_rule_delete: - -openstack baremetal introspection rule delete ---------------------------------------------- - -.. code-block:: console - - usage: openstack baremetal introspection rule delete [-h] uuid - -Delete an introspection rule. - -**Positional arguments:** - -``uuid`` - rule UUID - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_baremetal_introspection_rule_import: - -openstack baremetal introspection rule import ---------------------------------------------- - -.. code-block:: console - - usage: openstack baremetal introspection rule import [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - file - -Import one or several introspection rules from a json file. - -**Positional arguments:** - -``file`` - JSON file to import, may contain one or several rules - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_baremetal_introspection_rule_list: - -openstack baremetal introspection rule list -------------------------------------------- - -.. code-block:: console - - usage: openstack baremetal introspection rule list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List all introspection rules. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_baremetal_introspection_rule_purge: - -openstack baremetal introspection rule purge --------------------------------------------- - -.. code-block:: console - - usage: openstack baremetal introspection rule purge [-h] - -Drop all introspection rules. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_baremetal_introspection_rule_show: - -openstack baremetal introspection rule show -------------------------------------------- - -.. code-block:: console - - usage: openstack baremetal introspection rule show [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--prefix PREFIX] - uuid - -Show an introspection rule. - -**Positional arguments:** - -``uuid`` - rule UUID - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_baremetal_introspection_start: - -openstack baremetal introspection start ---------------------------------------- - -.. code-block:: console - - usage: openstack baremetal introspection start [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--new-ipmi-username NEW_IPMI_USERNAME] - [--new-ipmi-password NEW_IPMI_PASSWORD] - [--wait] - uuid [uuid ...] - -Start the introspection. - -**Positional arguments:** - -``uuid`` - baremetal node UUID(s) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--new-ipmi-username NEW_IPMI_USERNAME`` - if set, \*Ironic Inspector\* will update IPMI user name - to this value - -``--new-ipmi-password NEW_IPMI_PASSWORD`` - if set, \*Ironic Inspector\* will update IPMI password - to this value - -``--wait`` - wait for introspection to finish; the result will be - displayed in the end - -.. _openstack_baremetal_introspection_status: - -openstack baremetal introspection status ----------------------------------------- - -.. code-block:: console - - usage: openstack baremetal introspection status [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] [--prefix PREFIX] - uuid - -Get introspection status. - -**Positional arguments:** - -``uuid`` - baremetal node UUID - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_baremetal_node_abort: - -openstack baremetal node abort ------------------------------- - -.. code-block:: console - - usage: openstack baremetal node abort [-h] - -Set provision state of baremetal node to 'abort' - -**Positional arguments:** - -```` - Name or UUID of the node. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_baremetal_node_clean: - -openstack baremetal node clean ------------------------------- - -.. code-block:: console - - usage: openstack baremetal node clean [-h] --clean-steps - -Set provision state of baremetal node to 'clean' - -**Positional arguments:** - -```` - Name or UUID of the node. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--clean-steps `` - The clean steps in JSON format. May be the path to a - file containing the clean steps; OR '-', with the - clean steps being read from standard input; OR a - string. The value should be a list of clean-step - dictionaries; each dictionary should have keys - 'interface' and 'step', and optional key 'args'. - -.. _openstack_baremetal_node_create: - -openstack baremetal node create -------------------------------- - -.. code-block:: console - - usage: openstack baremetal node create [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - [--chassis-uuid ] --driver - [--driver-info ] - [--property ] - [--extra ] [--uuid ] - [--name ] - [--network-interface ] - [--resource-class ] - -Register a new node with the baremetal service - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--chassis-uuid `` - UUID of the chassis that this node belongs to. - -``--driver `` - Driver used to control the node [REQUIRED]. - -``--driver-info `` - Key/value pair used by the driver, such as out-of-band - management credentials. Can be specified multiple - times. - -``--property `` - Key/value pair describing the physical characteristics - of the node. This is exported to Nova and used by the - scheduler. Can be specified multiple times. - -``--extra `` - Record arbitrary key/value metadata. Can be specified - multiple times. - -``--uuid `` - Unique UUID for the node. - -``--name `` - Unique name for the node. - -``--network-interface `` - Network interface used for switching node to - cleaning/provisioning networks. - -``--resource-class `` - Resource class for mapping nodes to Nova flavors - -.. _openstack_baremetal_node_delete: - -openstack baremetal node delete -------------------------------- - -.. code-block:: console - - usage: openstack baremetal node delete [-h] [ ...] - -Unregister a baremetal node - -**Positional arguments:** - -```` - Node(s) to delete (name or UUID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_baremetal_node_deploy: - -openstack baremetal node deploy -------------------------------- - -.. code-block:: console - - usage: openstack baremetal node deploy [-h] [--config-drive ] - - -Set provision state of baremetal node to 'deploy' - -**Positional arguments:** - -```` - Name or UUID of the node. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--config-drive `` - A gzipped, base64-encoded configuration drive string - OR the path to the configuration drive file OR the - path to a directory containing the config drive files. - In case it's a directory, a config drive will be - generated from it. - -.. _openstack_baremetal_node_inspect: - -openstack baremetal node inspect --------------------------------- - -.. code-block:: console - - usage: openstack baremetal node inspect [-h] - -Set provision state of baremetal node to 'inspect' - -**Positional arguments:** - -```` - Name or UUID of the node. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_baremetal_node_list: - -openstack baremetal node list ------------------------------ - -.. code-block:: console - - usage: openstack baremetal node list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--limit ] [--marker ] - [--sort [:]] - [--maintenance] [--associated] - [--provision-state ] - [--resource-class ] - [--long | --fields [ ...]] - -List baremetal nodes - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--limit `` - Maximum number of nodes to return per request, 0 for - no limit. Default is the maximum number used by the - Baremetal API Service. - -``--marker `` - Node UUID (for example, of the last node in the list - from a previous request). Returns the list of nodes - after this UUID. - -``--sort [:]`` - Sort output by specified node fields and directions - (asc or desc) (default: asc). Multiple fields and - directions can be specified, separated by comma. - -``--maintenance`` - List nodes in maintenance mode. - -``--associated`` - List only nodes associated with an instance. - -``--provision-state `` - Limit list to nodes in . One of - active, deleted, rebuild, inspect, provide, manage, - clean, abort. - -``--resource-class `` - Limit list to nodes with resource class - -``--long`` - Show detailed information about the nodes. - -``--fields [ ...]`` - One or more node fields. Only these fields will be - fetched from the server. Can not be used when ':option:`--long`' - is specified. - -.. _openstack_baremetal_node_maintenance_set: - -openstack baremetal node maintenance set ----------------------------------------- - -.. code-block:: console - - usage: openstack baremetal node maintenance set [-h] [--reason ] - - -Set baremetal node to maintenance mode - -**Positional arguments:** - -```` - Name or UUID of the node. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--reason `` - Reason for setting maintenance mode. - -.. _openstack_baremetal_node_maintenance_unset: - -openstack baremetal node maintenance unset ------------------------------------------- - -.. code-block:: console - - usage: openstack baremetal node maintenance unset [-h] - -Unset baremetal node from maintenance mode - -**Positional arguments:** - -```` - Name or UUID of the node. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_baremetal_node_manage: - -openstack baremetal node manage -------------------------------- - -.. code-block:: console - - usage: openstack baremetal node manage [-h] - -Set provision state of baremetal node to 'manage' - -**Positional arguments:** - -```` - Name or UUID of the node. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_baremetal_node_power: - -openstack baremetal node power ------------------------------- - -.. code-block:: console - - usage: openstack baremetal node power [-h] - -Set power state of baremetal node - -**Positional arguments:** - -```` - Power node on or off - -```` - Name or UUID of the node. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_baremetal_node_provide: - -openstack baremetal node provide --------------------------------- - -.. code-block:: console - - usage: openstack baremetal node provide [-h] - -Set provision state of baremetal node to 'provide' - -**Positional arguments:** - -```` - Name or UUID of the node. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_baremetal_node_reboot: - -openstack baremetal node reboot -------------------------------- - -.. code-block:: console - - usage: openstack baremetal node reboot [-h] - -Reboot baremetal node - -**Positional arguments:** - -```` - Name or UUID of the node. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_baremetal_node_rebuild: - -openstack baremetal node rebuild --------------------------------- - -.. code-block:: console - - usage: openstack baremetal node rebuild [-h] - -Set provision state of baremetal node to 'rebuild' - -**Positional arguments:** - -```` - Name or UUID of the node. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_baremetal_node_set: - -openstack baremetal node set ----------------------------- - -.. code-block:: console - - usage: openstack baremetal node set [-h] [--instance-uuid ] - [--name ] [--driver ] - [--network-interface ] - [--resource-class ] - [--property ] - [--extra ] - [--driver-info ] - [--instance-info ] - - -Set baremetal properties - -**Positional arguments:** - -```` - Name or UUID of the node. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--instance-uuid `` - Set instance UUID of node to - -``--name `` - Set the name of the node - -``--driver `` - Set the driver for the node - -``--network-interface `` - Set the network interface for the node - -``--resource-class `` - Set the resource class for the node - -``--property `` - Property to set on this baremetal node (repeat option - to set multiple properties) - -``--extra `` - Extra to set on this baremetal node (repeat option to - set multiple extras) - -``--driver-info `` - Driver information to set on this baremetal node - (repeat option to set multiple driver infos) - -``--instance-info `` - Instance information to set on this baremetal node - (repeat option to set multiple instance infos) - -.. _openstack_baremetal_node_show: - -openstack baremetal node show ------------------------------ - -.. code-block:: console - - usage: openstack baremetal node show [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - [--instance] - [--fields [ ...]] - - -Show baremetal node details - -**Positional arguments:** - -```` - Name or UUID of the node (or instance UUID if - :option:`--instance` is specified) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--instance `` - is an instance UUID. - -``--fields [ ...]`` - One or more node fields. Only these fields will be - fetched from the server. - -.. _openstack_baremetal_node_undeploy: - -openstack baremetal node undeploy ---------------------------------- - -.. code-block:: console - - usage: openstack baremetal node undeploy [-h] - -Set provision state of baremetal node to 'deleted' - -**Positional arguments:** - -```` - Name or UUID of the node. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_baremetal_node_unset: - -openstack baremetal node unset ------------------------------- - -.. code-block:: console - - usage: openstack baremetal node unset [-h] [--instance-uuid] [--name] - [--resource-class] [--property ] - [--extra ] [--driver-info ] - [--instance-info ] - - -Unset baremetal properties - -**Positional arguments:** - -```` - Name or UUID of the node. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--instance-uuid`` - Unset instance UUID on this baremetal node - -``--name`` - Unset the name of the node - -``--resource-class`` - Unset the resource class of the node - -``--property `` - Property to unset on this baremetal node (repeat - option to unset multiple properties) - -``--extra `` - Extra to unset on this baremetal node (repeat option - to unset multiple extras) - -``--driver-info `` - Driver information to unset on this baremetal node - (repeat option to unset multiple driver informations) - -``--instance-info `` - Instance information to unset on this baremetal node - (repeat option to unset multiple instance - informations) - -.. _openstack_baremetal_port_create: - -openstack baremetal port create -------------------------------- - -.. code-block:: console - - usage: openstack baremetal port create [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] --node - [--extra ] - [-l ] - [--pxe-enabled ] -
- -Create a new port - -**Positional arguments:** - -``
`` - MAC address for this port. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--node `` - UUID of the node that this port belongs to. - -``--extra `` - Record arbitrary key/value metadata. Can be specified - multiple times. - -``-l , --local-link-connection `` - Key/value metadata describing Local link connection - information. Valid keys are switch_info, switch_id, - port_id. Can be specified multiple times. - -``--pxe-enabled `` - Indicates whether this Port should be used when PXE - booting this Node. - -.. _openstack_baremetal_port_show: - -openstack baremetal port show ------------------------------ - -.. code-block:: console - - usage: openstack baremetal port show [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - [--address] - [--fields [ ...]] - - -Show baremetal port details. - -**Positional arguments:** - -```` - UUID of the port (or MAC address if :option:`--address` is - specified). - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--address `` - is the MAC address (instead of the UUID) of the - port. - -``--fields [ ...]`` - One or more port fields. Only these fields will be - fetched from the server. - -.. _openstack_ca_get: - -openstack ca get ----------------- - -.. code-block:: console - - usage: openstack ca get [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--prefix PREFIX] - URI - -Retrieve a CA by providing its URI. - -**Positional arguments:** - -``URI`` - The URI reference for the CA. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_ca_list: - -openstack ca list ------------------ - -.. code-block:: console - - usage: openstack ca list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--limit LIMIT] [--offset OFFSET] [--name NAME] - -List cas. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--limit LIMIT, -l LIMIT`` - specify the limit to the number of items to list per - page (default: 10; maximum: 100) - -``--offset OFFSET, -o OFFSET`` - specify the page offset (default: 0) - -``--name NAME, -n NAME`` - specify the secret name (default: None) - -.. _openstack_catalog_list: - -openstack catalog list ----------------------- - -.. code-block:: console - - usage: openstack catalog list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List services in the service catalog - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_catalog_show: - -openstack catalog show ----------------------- - -.. code-block:: console - - usage: openstack catalog show [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--prefix PREFIX] - - -Display service catalog details - -**Positional arguments:** - -```` - Service to display (type or name) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_claim_create: - -openstack claim create ----------------------- - -.. code-block:: console - - usage: openstack claim create [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--ttl ] [--grace ] - [--limit ] - - -Create claim and return a list of claimed messages - -**Positional arguments:** - -```` - Name of the queue to be claim - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--ttl `` - Time to live in seconds for claim - -``--grace `` - The message grace period in seconds - -``--limit `` - Claims a set of messages, up to limit - -.. _openstack_claim_query: - -openstack claim query ---------------------- - -.. code-block:: console - - usage: openstack claim query [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - - -Display claim details - -**Positional arguments:** - -```` - Name of the claimed queue - -```` - ID of the claim - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_claim_release: - -openstack claim release ------------------------ - -.. code-block:: console - - usage: openstack claim release [-h] - -Delete a claim - -**Positional arguments:** - -```` - Name of the claimed queue - -```` - Claim ID to delete - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_claim_renew: - -openstack claim renew ---------------------- - -.. code-block:: console - - usage: openstack claim renew [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--ttl ] [--grace ] - - -Renew a claim - -**Positional arguments:** - -```` - Name of the claimed queue - -```` - Claim ID - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--ttl `` - Time to live in seconds for claim - -``--grace `` - The message grace period in seconds - -.. _openstack_command_list: - -openstack command list ----------------------- - -.. code-block:: console - - usage: openstack command list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List recognized commands by group - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_compute_agent_create: - -openstack compute agent create ------------------------------- - -.. code-block:: console - - usage: openstack compute agent create [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - - - -Create compute agent - -**Positional arguments:** - -```` - Type of OS - -```` - Type of architecture - -```` - Version - -```` - URL - -```` - MD5 hash - -```` - Type of hypervisor - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_compute_agent_delete: - -openstack compute agent delete ------------------------------- - -.. code-block:: console - - usage: openstack compute agent delete [-h] [ ...] - -Delete compute agent(s) - -**Positional arguments:** - -```` - ID of agent(s) to delete - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_compute_agent_list: - -openstack compute agent list ----------------------------- - -.. code-block:: console - - usage: openstack compute agent list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--hypervisor ] - -List compute agents - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--hypervisor `` - Type of hypervisor - -.. _openstack_compute_agent_set: - -openstack compute agent set ---------------------------- - -.. code-block:: console - - usage: openstack compute agent set [-h] [--agent-version ] - [--url ] [--md5hash ] - - -Set compute agent properties - -**Positional arguments:** - -```` - ID of the agent - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--agent-version `` - Version of the agent - -``--url `` - URL of the agent - -``--md5hash `` - MD5 hash of the agent - -.. _openstack_compute_service_delete: - -openstack compute service delete --------------------------------- - -.. code-block:: console - - usage: openstack compute service delete [-h] [ ...] - -Delete compute service(s) - -**Positional arguments:** - -```` - Compute service(s) to delete (ID only) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_compute_service_list: - -openstack compute service list ------------------------------- - -.. code-block:: console - - usage: openstack compute service list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--host ] [--service ] - [--long] - -List compute services - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--host `` - List services on specified host (name only) - -``--service `` - List only specified service (name only) - -``--long`` - List additional fields in output - -.. _openstack_compute_service_set: - -openstack compute service set ------------------------------ - -.. code-block:: console - - usage: openstack compute service set [-h] [--enable | --disable] - [--disable-reason ] - [--up | --down] - - -Set compute service properties - -**Positional arguments:** - -```` - Name of host - -```` - Name of service (Binary name) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--enable`` - Enable service - -``--disable`` - Disable service - -``--disable-reason `` - Reason for disabling the service (in quotas). Should - be used with :option:`--disable` option. - -``--up`` - Force up service - -``--down`` - Force down service - -.. _openstack_configuration_show: - -openstack configuration show ----------------------------- - -.. code-block:: console - - usage: openstack configuration show [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - [--mask | --unmask] - -Display configuration details - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--mask`` - Attempt to mask passwords (default) - -``--unmask`` - Show password in clear text - -.. _openstack_console_log_show: - -openstack console log show --------------------------- - -.. code-block:: console - - usage: openstack console log show [-h] [--lines ] - -Show server's console output - -**Positional arguments:** - -```` - Server to show console log (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--lines `` - Number of lines to display from the end of the log - (default=all) - -.. _openstack_console_url_show: - -openstack console url show --------------------------- - -.. code-block:: console - - usage: openstack console url show [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - [--novnc | --xvpvnc | --spice | --rdp | --serial | --mks] - - -Show server's remote console URL - -**Positional arguments:** - -```` - 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 - -.. _openstack_consumer_create: - -openstack consumer create -------------------------- - -.. code-block:: console - - usage: openstack consumer create [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - [--description ] - -Create new consumer - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--description `` - New consumer description - -.. _openstack_consumer_delete: - -openstack consumer delete -------------------------- - -.. code-block:: console - - usage: openstack consumer delete [-h] [ ...] - -Delete consumer(s) - -**Positional arguments:** - -```` - Consumer(s) to delete - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_consumer_list: - -openstack consumer list ------------------------ - -.. code-block:: console - - usage: openstack consumer list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List consumers - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_consumer_set: - -openstack consumer set ----------------------- - -.. code-block:: console - - usage: openstack consumer set [-h] [--description ] - -Set consumer properties - -**Positional arguments:** - -```` - Consumer to modify - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--description `` - New consumer description - -.. _openstack_consumer_show: - -openstack consumer show ------------------------ - -.. code-block:: console - - usage: openstack consumer show [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - - -Display consumer details - -**Positional arguments:** - -```` - Consumer to display - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_container_create: - -openstack container create --------------------------- - -.. code-block:: console - - usage: openstack container create [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [ ...] - -Create new container - -**Positional arguments:** - -```` - New container name(s) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_container_delete: - -openstack container delete --------------------------- - -.. code-block:: console - - usage: openstack container delete [-h] [--recursive] - [ ...] - -Delete container - -**Positional arguments:** - -```` - Container(s) to delete - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--recursive, -r`` - Recursively delete objects and container - -.. _openstack_container_list: - -openstack container list ------------------------- - -.. code-block:: console - - usage: openstack container list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--prefix ] [--marker ] - [--end-marker ] [--limit ] - [--long] [--all] - -List containers - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--prefix `` - Filter list using - -``--marker `` - Anchor for paging - -``--end-marker `` - End anchor for paging - -``--limit `` - Limit the number of containers returned - -``--long`` - List additional fields in output - -``--all`` - List all containers (default is 10000) - -.. _openstack_container_save: - -openstack container save ------------------------- - -.. code-block:: console - - usage: openstack container save [-h] - -Save container contents locally - -**Positional arguments:** - -```` - Container to save - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_container_set: - -openstack container set ------------------------ - -.. code-block:: console - - usage: openstack container set [-h] --property - -Set container properties - -**Positional arguments:** - -```` - Container to modify - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--property `` - Set a property on this container (repeat option to set - multiple properties) - -.. _openstack_container_show: - -openstack container show ------------------------- - -.. code-block:: console - - usage: openstack container show [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - - -Display container details - -**Positional arguments:** - -```` - Container to display - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_container_unset: - -openstack container unset -------------------------- - -.. code-block:: console - - usage: openstack container unset [-h] --property - -Unset container properties - -**Positional arguments:** - -```` - Container to modify - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--property `` - Property to remove from container (repeat option to remove - multiple properties) - -.. _openstack_credential_create: - -openstack credential create ---------------------------- - -.. code-block:: console - - usage: openstack credential create [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - [--type ] [--project ] - - -Create new credential - -**Positional arguments:** - -```` - user that owns the credential (name or ID) - -```` - New credential data - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--type `` - New credential type - -``--project `` - Project which limits the scope of the credential (name - or ID) - -.. _openstack_credential_delete: - -openstack credential delete ---------------------------- - -.. code-block:: console - - usage: openstack credential delete [-h] [ ...] - -Delete credential(s) - -**Positional arguments:** - -```` - ID of credential(s) to delete - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_credential_list: - -openstack credential list -------------------------- - -.. code-block:: console - - usage: openstack credential list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List credentials - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_credential_set: - -openstack credential set ------------------------- - -.. code-block:: console - - usage: openstack credential set [-h] --user --type --data - [--project ] - - -Set credential properties - -**Positional arguments:** - -```` - ID of credential to change - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--user `` - User that owns the credential (name or ID) - -``--type `` - New credential type - -``--data `` - New credential data - -``--project `` - Project which limits the scope of the credential (name - or ID) - -.. _openstack_credential_show: - -openstack credential show -------------------------- - -.. code-block:: console - - usage: openstack credential show [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - - -Display credential details - -**Positional arguments:** - -```` - ID of credential to display - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_dataprocessing_cluster_create: - -openstack dataprocessing cluster create ---------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing cluster create [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] [--prefix PREFIX] - [--name ] - [--cluster-template ] - [--image ] - [--description ] - [--user-keypair ] - [--neutron-network ] - [--count ] [--public] - [--protected] [--transient] - [--json ] [--wait] - -Creates cluster - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--name `` - Name of the cluster [REQUIRED if JSON is not provided] - -``--cluster-template `` - Cluster template name or ID [REQUIRED if JSON is not - provided] - -``--image `` - Image that will be used for cluster deployment (Name - or ID) [REQUIRED if JSON is not provided] - -``--description `` - Description of the cluster - -``--user-keypair `` - User keypair to get acces to VMs after cluster - creation - -``--neutron-network `` - Instances of the cluster will get fixed IP addresses - in this network. (Name or ID should be provided) - -``--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 `` - JSON representation of the cluster. Other arguments - (except for :option:`--wait)` will not be taken into account if - this one is provided - -``--wait`` - Wait for the cluster creation to complete - -.. _openstack_dataprocessing_cluster_delete: - -openstack dataprocessing cluster delete ---------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing cluster delete [-h] [--wait] - [ ...] - -Deletes cluster - -**Positional arguments:** - -```` - 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 - -.. _openstack_dataprocessing_cluster_list: - -openstack dataprocessing cluster list -------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing cluster list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--long] [--plugin ] - [--plugin-version ] - [--name ] - -Lists clusters - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--long`` - List additional fields in output - -``--plugin `` - List clusters with specific plugin - -``--plugin-version `` - List clusters with specific version of the plugin - -``--name `` - List clusters with specific substring in the name - -.. _openstack_dataprocessing_cluster_scale: - -openstack dataprocessing cluster scale --------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing cluster scale [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] [--prefix PREFIX] - [--instances [ ...]] - [--json ] [--wait] - - -Scales cluster - -**Positional arguments:** - -```` - Name or ID of the cluster - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--instances [ ...]`` - Node group templates and number of their instances to - be scale to [REQUIRED if JSON is not provided] - -``--json `` - JSON representation of the cluster scale object. Other - arguments (except for :option:`--wait)` will not be taken into - account if this one is provided - -``--wait`` - Wait for the cluster scale to complete - -.. _openstack_dataprocessing_cluster_show: - -openstack dataprocessing cluster show -------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing cluster show [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] [--prefix PREFIX] - [--verification] - [--show-progress] - [--full-dump-events] - - -Display cluster details - -**Positional arguments:** - -```` - 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. - -.. _openstack_dataprocessing_cluster_template_create: - -openstack dataprocessing cluster template create ------------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing cluster template create [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--prefix PREFIX] - [--name ] - [--node-groups [ ...]] - [--anti-affinity [ ...]] - [--description ] - [--autoconfig] - [--public] - [--protected] - [--json ] - [--shares ] - [--configs ] - [--domain-name ] - -Creates cluster template - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--name `` - Name of the cluster template [REQUIRED if JSON is not - provided] - -``--node-groups [ ...]`` - 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 [ ...]`` - List of processes that should be added to an anti-affinity group - -``--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 `` - JSON representation of the cluster template. Other - arguments will not be taken into account if this one - is provided - -``--shares `` - JSON representation of the manila shares - -``--configs `` - JSON representation of the cluster template configs - -``--domain-name `` - Domain name for instances of this cluster template. - This option is available if 'use_designate' config is - True - -.. _openstack_dataprocessing_cluster_template_delete: - -openstack dataprocessing cluster template delete ------------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing cluster template delete [-h] - - [ ...] - -Deletes cluster template - -**Positional arguments:** - -```` - Name(s) or id(s) of the cluster template(s) to delete - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_dataprocessing_cluster_template_list: - -openstack dataprocessing cluster template list ----------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing cluster template list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--long] - [--plugin ] - [--plugin-version ] - [--name ] - -Lists cluster templates - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--long`` - List additional fields in output - -``--plugin `` - List cluster templates for specific plugin - -``--plugin-version `` - List cluster templates with specific version of the - plugin - -``--name `` - List cluster templates with specific substring in the - name - -.. _openstack_dataprocessing_cluster_template_show: - -openstack dataprocessing cluster template show ----------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing cluster template show [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--prefix PREFIX] - - -Display cluster template details - -**Positional arguments:** - -```` - Name or id of the cluster template to display - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_dataprocessing_cluster_template_update: - -openstack dataprocessing cluster template update ------------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing cluster template update [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--prefix PREFIX] - [--name ] - [--node-groups [ ...]] - [--anti-affinity [ ...]] - [--description ] - [--autoconfig-enable | --autoconfig-disable] - [--public | --private] - [--protected | --unprotected] - [--json ] - [--shares ] - [--configs ] - [--domain-name ] - - -Updates cluster template - -**Positional arguments:** - -```` - Name or ID of the cluster template [REQUIRED] - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--name `` - New name of the cluster template - -``--node-groups [ ...]`` - List of the node groups(names or IDs) and numbers - ofinstances for each one of them - -``--anti-affinity [ ...]`` - List of processes that should be added to an anti-affinity group - -``--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 `` - JSON representation of the cluster template. Other - arguments will not be taken into account if this one - is provided - -``--shares `` - JSON representation of the manila shares - -``--configs `` - JSON representation of the cluster template configs - -``--domain-name `` - Domain name for instances of this cluster template. - This option is available if 'use_designate' config is - True - -.. _openstack_dataprocessing_cluster_update: - -openstack dataprocessing cluster update ---------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing cluster update [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] [--prefix PREFIX] - [--name ] - [--description ] - [--shares ] - [--public | --private] - [--protected | --unprotected] - - -Updates cluster - -**Positional arguments:** - -```` - Name or ID of the cluster - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--name `` - New name of the cluster - -``--description `` - Description of the cluster - -``--shares `` - 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 - -.. _openstack_dataprocessing_cluster_verification: - -openstack dataprocessing cluster verification ---------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing cluster verification [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--prefix PREFIX] - (--start | --show) - - -Updates cluster verifications - -**Positional arguments:** - -```` - 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 - -.. _openstack_dataprocessing_data_source_create: - -openstack dataprocessing data source create -------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing data source create [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--prefix PREFIX] --type - --url - [--username ] - [--password ] - [--description ] - [--public] [--protected] - - -Creates data source - -**Positional arguments:** - -```` - Name of the data source - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--type `` - Type of the data source (swift, hdfs, maprfs, manila) - [REQUIRED] - -``--url `` - Url for the data source [REQUIRED] - -``--username `` - Username for accessing the data source url - -``--password `` - Password for accessing the data source url - -``--description `` - Description of the data source - -``--public`` - Make the data source public - -``--protected`` - Make the data source protected - -.. _openstack_dataprocessing_data_source_delete: - -openstack dataprocessing data source delete -------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing data source delete [-h] - - [ ...] - -Delete data source - -**Positional arguments:** - -```` - Name(s) or id(s) of the data source(s) to delete - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_dataprocessing_data_source_list: - -openstack dataprocessing data source list ------------------------------------------ - -.. code-block:: console - - usage: openstack dataprocessing data source list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--long] [--type ] - -Lists data sources - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--long`` - List additional fields in output - -``--type `` - List data sources of specific type (swift, hdfs, - maprfs, manila) - -.. _openstack_dataprocessing_data_source_show: - -openstack dataprocessing data source show ------------------------------------------ - -.. code-block:: console - - usage: openstack dataprocessing data source show [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--prefix PREFIX] - - -Display data source details - -**Positional arguments:** - -```` - Name or id of the data source to display - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_dataprocessing_data_source_update: - -openstack dataprocessing data source update -------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing data source update [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--prefix PREFIX] - [--name ] - [--type ] - [--url ] - [--username ] - [--password ] - [--description ] - [--public | --private] - [--protected | --unprotected] - - -Update data source - -**Positional arguments:** - -```` - Name or id of the data source - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--name `` - New name of the data source - -``--type `` - Type of the data source (swift, hdfs, maprfs, manila) - -``--url `` - Url for the data source - -``--username `` - Username for accessing the data source url - -``--password `` - Password for accessing the data source url - -``--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 - -.. _openstack_dataprocessing_image_list: - -openstack dataprocessing image list ------------------------------------ - -.. code-block:: console - - usage: openstack dataprocessing image list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--long] [--name ] - [--tags [ ...]] - [--username ] - -Lists registered images - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--long`` - List additional fields in output - -``--name `` - Regular expression to match image name - -``--tags [ ...]`` - List images with specific tag(s) - -``--username `` - List images with specific username - -.. _openstack_dataprocessing_image_register: - -openstack dataprocessing image register ---------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing image register [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] [--prefix PREFIX] - --username - [--description ] - - -Register an image - -**Positional arguments:** - -```` - Name or ID of the image to register - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--username `` - Username of privileged user in the image [REQUIRED] - -``--description `` - Description of the image. If not provided, description - of the image will be reset to empty - -.. _openstack_dataprocessing_image_show: - -openstack dataprocessing image show ------------------------------------ - -.. code-block:: console - - usage: openstack dataprocessing image show [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - - -Display image details - -**Positional arguments:** - -```` - Name or id of the image to display - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_dataprocessing_image_tags_add: - -openstack dataprocessing image tags add ---------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing image tags add [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] [--prefix PREFIX] - --tags [ ...] - - -Add image tags - -**Positional arguments:** - -```` - Name or id of the image - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--tags [ ...]`` - Tag(s) to add [REQUIRED] - -.. _openstack_dataprocessing_image_tags_remove: - -openstack dataprocessing image tags remove ------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing image tags remove [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--prefix PREFIX] - [--tags [ ...] | - --all] - - -Remove image tags - -**Positional arguments:** - -```` - Name or id of the image - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--tags [ ...]`` - Tag(s) to remove - -``--all`` - Remove all tags from image - -.. _openstack_dataprocessing_image_tags_set: - -openstack dataprocessing image tags set ---------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing image tags set [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] [--prefix PREFIX] - --tags [ ...] - - -Set image tags (Replace current image tags with provided ones) - -**Positional arguments:** - -```` - Name or id of the image - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--tags [ ...]`` - Tag(s) to set [REQUIRED] - -.. _openstack_dataprocessing_image_unregister: - -openstack dataprocessing image unregister ------------------------------------------ - -.. code-block:: console - - usage: openstack dataprocessing image unregister [-h] [ ...] - -Unregister image(s) - -**Positional arguments:** - -```` - Name(s) or id(s) of the image(s) to unregister - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_dataprocessing_job_binary_create: - -openstack dataprocessing job binary create ------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing job binary create [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--prefix PREFIX] - [--name ] - [--data | --url ] - [--description ] - [--username ] - [--password | --password-prompt] - [--public] [--protected] - [--json ] - -Creates job binary - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--name `` - Name of the job binary [REQUIRED if JSON is not - provided] - -``--data `` - File that will be stored in the internal DB [REQUIRED - if JSON and URL are not provided] - -``--url `` - URL for the job binary [REQUIRED if JSON and file are - not provided] - -``--description `` - Description of the job binary - -``--username `` - Username for accessing the job binary URL - -``--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 `` - JSON representation of the job binary. Other arguments - will not be taken into account if this one is provided - -.. _openstack_dataprocessing_job_binary_delete: - -openstack dataprocessing job binary delete ------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing job binary delete [-h] - - [ ...] - -Deletes job binary - -**Positional arguments:** - -```` - Name(s) or id(s) of the job binary(ies) to delete - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_dataprocessing_job_binary_download: - -openstack dataprocessing job binary download --------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing job binary download [-h] [--file ] - - -Downloads job binary - -**Positional arguments:** - -```` - Name or ID of the job binary to download - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--file `` - Destination file (defaults to job binary name) - -.. _openstack_dataprocessing_job_binary_list: - -openstack dataprocessing job binary list ----------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing job binary list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--long] - [--name ] - -Lists job binaries - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--long`` - List additional fields in output - -``--name `` - List job binaries with specific substring in the name - -.. _openstack_dataprocessing_job_binary_show: - -openstack dataprocessing job binary show ----------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing job binary show [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] [--prefix PREFIX] - - -Display job binary details - -**Positional arguments:** - -```` - Name or ID of the job binary to display - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_dataprocessing_job_binary_update: - -openstack dataprocessing job binary update ------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing job binary update [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--prefix PREFIX] - [--name ] - [--url ] - [--description ] - [--username ] - [--password | --password-prompt] - [--public | --private] - [--protected | --unprotected] - [--json ] - - -Updates job binary - -**Positional arguments:** - -```` - Name or ID of the job binary - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--name `` - New name of the job binary - -``--url `` - URL for the job binary [Internal DB URL can not be - updated] - -``--description `` - Description of the job binary - -``--username `` - Username for accessing the job binary URL - -``--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 `` - JSON representation of the update object. Other - arguments will not be taken into account if this one - is provided - -.. _openstack_dataprocessing_job_delete: - -openstack dataprocessing job delete ------------------------------------ - -.. code-block:: console - - usage: openstack dataprocessing job delete [-h] [--wait] [ ...] - -Deletes job - -**Positional arguments:** - -```` - 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 - -.. _openstack_dataprocessing_job_execute: - -openstack dataprocessing job execute ------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing job execute [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] [--prefix PREFIX] - [--job-template ] - [--cluster ] - [--input ] - [--output ] - [--params [ ...]] - [--args [ ...]] - [--public] [--protected] - [--config-json | --configs [ ...]] - [--interface ] - [--json ] - -Executes job - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--job-template `` - Name or ID of the job template [REQUIRED if JSON is - not provided] - -``--cluster `` - Name or ID of the cluster [REQUIRED if JSON is not - provided] - -``--input `` - Name or ID of the input data source - -``--output `` - Name or ID of the output data source - -``--params [ ...]`` - Parameters to add to the job - -``--args [ ...]`` - Arguments to add to the job - -``--public`` - Make the job public - -``--protected`` - Make the job protected - -``--config-json `` - JSON representation of the job configs - -``--configs [ ...]`` - Configs to add to the job - -``--interface `` - JSON representation of the interface - -``--json `` - JSON representation of the job. Other arguments will - not be taken into account if this one is provided - -.. _openstack_dataprocessing_job_list: - -openstack dataprocessing job list ---------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing job list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--long] [--status ] - -Lists jobs - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--long`` - List additional fields in output - -``--status `` - List jobs with specific status - -.. _openstack_dataprocessing_job_show: - -openstack dataprocessing job show ---------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing job show [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - - -Display job details - -**Positional arguments:** - -```` - ID of the job to display - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_dataprocessing_job_template_create: - -openstack dataprocessing job template create --------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing job template create [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--prefix PREFIX] - [--name ] - [--type ] - [--mains
[
...]] - [--libs [ ...]] - [--description ] - [--public] [--protected] - [--interface ] - [--json ] - -Creates job template - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--name `` - Name of the job template [REQUIRED if JSON is not - provided] - -``--type `` - Type of the job (Hive, Java, MapReduce, Storm, - Storm.Pyleus, Pig, Shell, MapReduce.Streaming, Spark) - [REQUIRED if JSON is not provided] - -``--mains
[
...]`` - Name(s) or ID(s) for job's main job binary(s) - -``--libs [ ...]`` - Name(s) or ID(s) for job's lib job binary(s) - -``--description `` - Description of the job template - -``--public`` - Make the job template public - -``--protected`` - Make the job template protected - -``--interface `` - JSON representation of the interface - -``--json `` - JSON representation of the job template - -.. _openstack_dataprocessing_job_template_delete: - -openstack dataprocessing job template delete --------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing job template delete [-h] - - [ ...] - -Deletes job template - -**Positional arguments:** - -```` - Name(s) or id(s) of the job template(s) to delete - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_dataprocessing_job_template_list: - -openstack dataprocessing job template list ------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing job template list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--long] [--type ] - [--name ] - -Lists job templates - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--long`` - List additional fields in output - -``--type `` - List job templates of specific type - -``--name `` - List job templates with specific substring in the name - -.. _openstack_dataprocessing_job_template_show: - -openstack dataprocessing job template show ------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing job template show [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--prefix PREFIX] - - -Display job template details - -**Positional arguments:** - -```` - Name or ID of the job template to display - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_dataprocessing_job_template_update: - -openstack dataprocessing job template update --------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing job template update [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--prefix PREFIX] - [--name ] - [--description ] - [--public | --private] - [--protected | --unprotected] - - -Updates job template - -**Positional arguments:** - -```` - Name or ID of the job template - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--name `` - New name of the job template - -``--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 - -.. _openstack_dataprocessing_job_type_configs_get: - -openstack dataprocessing job type configs get ---------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing job type configs get [-h] [--file ] - - -Get job type configs - -**Positional arguments:** - -```` - Type of the job to provide config information about - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--file `` - Destination file (defaults to job type) - -.. _openstack_dataprocessing_job_type_list: - -openstack dataprocessing job type list --------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing job type list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--type ] - [--plugin ] - [--plugin-version ] - -Lists job types supported by plugins - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--type `` - Get information about specific job type - -``--plugin `` - Get only job types supported by this plugin - -``--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 - -.. _openstack_dataprocessing_job_update: - -openstack dataprocessing job update ------------------------------------ - -.. code-block:: console - - usage: openstack dataprocessing job update [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - [--public | --private] - [--protected | --unprotected] - - -Updates job - -**Positional arguments:** - -```` - 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 - -.. _openstack_dataprocessing_node_group_template_create: - -openstack dataprocessing node group template create ---------------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing node group template create [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--prefix PREFIX] - [--name ] - [--plugin ] - [--plugin-version ] - [--processes [ ...]] - [--flavor ] - [--security-groups [ ...]] - [--auto-security-group] - [--availability-zone ] - [--floating-ip-pool ] - [--volumes-per-node ] - [--volumes-size ] - [--volumes-type ] - [--volumes-availability-zone ] - [--volumes-mount-prefix ] - [--volumes-locality] - [--description ] - [--autoconfig] - [--proxy-gateway] - [--public] - [--protected] - [--json ] - [--shares ] - [--configs ] - -Creates node group template - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--name `` - Name of the node group template [REQUIRED if JSON is - not provided] - -``--plugin `` - Name of the plugin [REQUIRED if JSON is not provided] - -``--plugin-version `` - Version of the plugin [REQUIRED if JSON is not - provided] - -``--processes [ ...]`` - List of the processes that will be launched on each - instance [REQUIRED if JSON is not provided] - -``--flavor `` - Name or ID of the flavor [REQUIRED if JSON is not - provided] - -``--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 `` - Name of the availability zone where instances will be - created - -``--floating-ip-pool `` - ID of the floating IP pool - -``--volumes-per-node `` - Number of volumes attached to every node - -``--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 `` - Type of the volumes. This parameter will be taken into - account only if volumes-per-node is set and non-zero - -``--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 `` - 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 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 `` - JSON representation of the node group template. Other - arguments will not be taken into account if this one - is provided - -``--shares `` - JSON representation of the manila shares - -``--configs `` - JSON representation of the node group template configs - -.. _openstack_dataprocessing_node_group_template_delete: - -openstack dataprocessing node group template delete ---------------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing node group template delete [-h] - - [ ...] - -Deletes node group template - -**Positional arguments:** - -```` - Name(s) or id(s) of the node group template(s) to - delete - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_dataprocessing_node_group_template_list: - -openstack dataprocessing node group template list -------------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing node group template list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--long] - [--plugin ] - [--plugin-version ] - [--name ] - -Lists node group templates - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--long`` - List additional fields in output - -``--plugin `` - List node group templates for specific plugin - -``--plugin-version `` - List node group templates with specific version of the - plugin - -``--name `` - List node group templates with specific substring in - the name - -.. _openstack_dataprocessing_node_group_template_show: - -openstack dataprocessing node group template show -------------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing node group template show [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--prefix PREFIX] - - -Display node group template details - -**Positional arguments:** - -```` - Name or id of the node group template to display - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_dataprocessing_node_group_template_update: - -openstack dataprocessing node group template update ---------------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing node group template update [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--prefix PREFIX] - [--name ] - [--plugin ] - [--plugin-version ] - [--processes [ ...]] - [--security-groups [ ...]] - [--auto-security-group-enable | --auto-security-group-disable] - [--availability-zone ] - [--flavor ] - [--floating-ip-pool ] - [--volumes-per-node ] - [--volumes-size ] - [--volumes-type ] - [--volumes-availability-zone ] - [--volumes-mount-prefix ] - [--volumes-locality-enable | --volumes-locality-disable] - [--description ] - [--autoconfig-enable | --autoconfig-disable] - [--proxy-gateway-enable | --proxy-gateway-disable] - [--public | --private] - [--protected | --unprotected] - [--json ] - [--shares ] - [--configs ] - - -Updates node group template - -**Positional arguments:** - -```` - Name or ID of the node group template - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--name `` - New name of the node group template - -``--plugin `` - Name of the plugin - -``--plugin-version `` - Version of the plugin - -``--processes [ ...]`` - List of the processes that will be launched on each - instance - -``--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 `` - Name of the availability zone where instances will be - created - -``--flavor `` - Name or ID of the flavor - -``--floating-ip-pool `` - ID of the floating IP pool - -``--volumes-per-node `` - Number of volumes attached to every node - -``--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 `` - Type of the volumes. This parameter will be taken into - account only if volumes-per-node is set and non-zero - -``--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 `` - 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 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 `` - JSON representation of the node group template update - fields. Other arguments will not be taken into account - if this one is provided - -``--shares `` - JSON representation of the manila shares - -``--configs `` - JSON representation of the node group template configs - -.. _openstack_dataprocessing_plugin_configs_get: - -openstack dataprocessing plugin configs get -------------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing plugin configs get [-h] [--file ] - - -Get plugin configs - -**Positional arguments:** - -```` - Name of the plugin to provide config information about - -```` - Version of the plugin to provide config information about - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--file `` - Destination file (defaults to plugin name) - -.. _openstack_dataprocessing_plugin_list: - -openstack dataprocessing plugin list ------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing plugin list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--long] - -Lists plugins - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--long`` - List additional fields in output - -.. _openstack_dataprocessing_plugin_show: - -openstack dataprocessing plugin show ------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing plugin show [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] [--prefix PREFIX] - [--plugin-version ] - - -Display plugin details - -**Positional arguments:** - -```` - Name of the plugin to display - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--plugin-version `` - Version of the plugin to display - -.. _openstack_dataprocessing_plugin_update: - -openstack dataprocessing plugin update --------------------------------------- - -.. code-block:: console - - usage: openstack dataprocessing plugin update [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] [--prefix PREFIX] - - - -**Positional arguments:** - -```` - Name of the plugin to provide config information about - -```` - JSON representation of the plugin update dictionary - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_dns_quota_list: - -openstack dns quota list ------------------------- - -.. code-block:: console - - usage: openstack dns quota list [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - [--all-projects] [--edit-managed] - [--sudo-project-id SUDO_PROJECT_ID] - [--project-id PROJECT_ID] - -List quotas - -**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 - -.. _openstack_dns_quota_reset: - -openstack dns quota reset -------------------------- - -.. code-block:: console - - usage: openstack dns quota reset [-h] [--all-projects] [--edit-managed] - [--sudo-project-id SUDO_PROJECT_ID] - [--project-id PROJECT_ID] - -Delete blacklist - -**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 - -.. _openstack_dns_quota_set: - -openstack dns quota set ------------------------ - -.. code-block:: console - - usage: openstack dns quota set [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] [--all-projects] - [--edit-managed] - [--sudo-project-id SUDO_PROJECT_ID] - [--project-id PROJECT_ID] - [--api-export-size ] - [--zones ] - [--recordset-records ] - [--zone-records ] - [--zone-recordsets ] - -Set blacklist properties - -**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 `` - New value for the api-export-size quota - -``--zones `` - New value for the zones quota - -``--recordset-records `` - New value for the recordset-records quota - -``--zone-records `` - New value for the zone-records quota - -``--zone-recordsets `` - New value for the zone-recordsets quota - -.. _openstack_dns_service_list: - -openstack dns service list --------------------------- - -.. code-block:: console - - usage: openstack dns service list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--hostname HOSTNAME] - [--service_name SERVICE_NAME] - [--status STATUS] [--all-projects] - [--edit-managed] - [--sudo-project-id SUDO_PROJECT_ID] - -List service statuses - -**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 - -.. _openstack_dns_service_show: - -openstack dns service show --------------------------- - -.. code-block:: console - - usage: openstack dns service show [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - [--all-projects] [--edit-managed] - [--sudo-project-id SUDO_PROJECT_ID] - id - -Show service status details - -**Positional 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 - -.. _openstack_domain_create: - -openstack domain create ------------------------ - -.. code-block:: console - - usage: openstack domain create [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - [--description ] - [--enable | --disable] [--or-show] - - -Create new domain - -**Positional arguments:** - -```` - New domain name - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--description `` - New domain description - -``--enable`` - Enable domain (default) - -``--disable`` - Disable domain - -``--or-show`` - Return existing domain - -.. _openstack_domain_delete: - -openstack domain delete ------------------------ - -.. code-block:: console - - usage: openstack domain delete [-h] [ ...] - -Delete domain(s) - -**Positional arguments:** - -```` - Domain(s) to delete (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_domain_list: - -openstack domain list ---------------------- - -.. code-block:: console - - usage: openstack domain list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List domains - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_domain_set: - -openstack domain set --------------------- - -.. code-block:: console - - usage: openstack domain set [-h] [--name ] [--description ] - [--enable | --disable] - - -Set domain properties - -**Positional arguments:** - -```` - Domain to modify (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--name `` - New domain name - -``--description `` - New domain description - -``--enable`` - Enable domain - -``--disable`` - Disable domain - -.. _openstack_domain_show: - -openstack domain show ---------------------- - -.. code-block:: console - - usage: openstack domain show [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--prefix PREFIX] - - -Display domain details - -**Positional arguments:** - -```` - Domain to display (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_ec2_credentials_create: - -openstack ec2 credentials create --------------------------------- - -.. code-block:: console - - usage: openstack ec2 credentials create [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - [--project ] [--user ] - [--user-domain ] - [--project-domain ] - -Create EC2 credentials - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--project `` - Create credentials in project (name or ID; default: - current authenticated project) - -``--user `` - Create credentials for user (name or ID; default: - current authenticated user) - -``--user-domain `` - Domain the user belongs to (name or ID). This can be - used in case collisions between user names exist. - -``--project-domain `` - Domain the project belongs to (name or ID). This can - be used in case collisions between project names - exist. - -.. _openstack_ec2_credentials_delete: - -openstack ec2 credentials delete --------------------------------- - -.. code-block:: console - - usage: openstack ec2 credentials delete [-h] [--user ] - [--user-domain ] - [ ...] - -Delete EC2 credentials - -**Positional arguments:** - -```` - Credentials access key(s) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--user `` - Delete credentials for user (name or ID) - -``--user-domain `` - Domain the user belongs to (name or ID). This can be - used in case collisions between user names exist. - -.. _openstack_ec2_credentials_list: - -openstack ec2 credentials list ------------------------------- - -.. code-block:: console - - usage: openstack ec2 credentials list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--user ] - [--user-domain ] - -List EC2 credentials - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--user `` - Filter list by user (name or ID) - -``--user-domain `` - Domain the user belongs to (name or ID). This can be - used in case collisions between user names exist. - -.. _openstack_ec2_credentials_show: - -openstack ec2 credentials show ------------------------------- - -.. code-block:: console - - usage: openstack ec2 credentials show [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - [--user ] - [--user-domain ] - - -Display EC2 credentials details - -**Positional arguments:** - -```` - Credentials access key - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--user `` - Show credentials for user (name or ID) - -``--user-domain `` - Domain the user belongs to (name or ID). This can be - used in case collisions between user names exist. - -.. _openstack_endpoint_create: - -openstack endpoint create -------------------------- - -.. code-block:: console - - usage: openstack endpoint create [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - [--region ] [--enable | --disable] - - -Create new endpoint - -**Positional arguments:** - -```` - Service to be associated with new endpoint (name or - ID) - -```` - New endpoint interface type (admin, public or - internal) - -```` - New endpoint URL - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--region `` - New endpoint region ID - -``--enable`` - Enable endpoint (default) - -``--disable`` - Disable endpoint - -.. _openstack_endpoint_delete: - -openstack endpoint delete -------------------------- - -.. code-block:: console - - usage: openstack endpoint delete [-h] [ ...] - -Delete endpoint(s) - -**Positional arguments:** - -```` - Endpoint(s) to delete (ID only) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_endpoint_list: - -openstack endpoint list ------------------------ - -.. code-block:: console - - usage: openstack endpoint list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--service ] [--interface ] - [--region ] - -List endpoints - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--service `` - Filter by service (name or ID) - -``--interface `` - Filter by interface type (admin, public or internal) - -``--region `` - Filter by region ID - -.. _openstack_endpoint_set: - -openstack endpoint set ----------------------- - -.. code-block:: console - - usage: openstack endpoint set [-h] [--region ] - [--interface ] [--url ] - [--service ] [--enable | --disable] - - -Set endpoint properties - -**Positional arguments:** - -```` - Endpoint to modify (ID only) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--region `` - New endpoint region ID - -``--interface `` - New endpoint interface type (admin, public or - internal) - -``--url `` - New endpoint URL - -``--service `` - New endpoint service (name or ID) - -``--enable`` - Enable endpoint - -``--disable`` - Disable endpoint - -.. _openstack_endpoint_show: - -openstack endpoint show ------------------------ - -.. code-block:: console - - usage: openstack endpoint show [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - - -Display endpoint details - -**Positional arguments:** - -```` - Endpoint to display (endpoint ID, service ID, service - name, service type) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_extension_list: - -openstack extension list ------------------------- - -.. code-block:: console - - usage: openstack extension list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--compute] [--identity] [--network] - [--volume] [--long] - -List API extensions - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--compute`` - List extensions for the Compute API - -``--identity`` - List extensions for the Identity API - -``--network`` - List extensions for the Network API - -``--volume`` - List extensions for the Block Storage API - -``--long`` - List additional fields in output - -.. _openstack_federation_domain_list: - -openstack federation domain list --------------------------------- - -.. code-block:: console - - usage: openstack federation domain list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List accessible domains - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_federation_project_list: - -openstack federation project list ---------------------------------- - -.. code-block:: console - - usage: openstack federation project list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List accessible projects - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_federation_protocol_create: - -openstack federation protocol create ------------------------------------- - -.. code-block:: console - - usage: openstack federation protocol create [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] [--prefix PREFIX] - --identity-provider - --mapping - - - -Create new federation protocol - -**Positional arguments:** - -```` - New federation protocol name (must be unique per - identity provider) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--identity-provider `` - Identity provider that will support the new federation - protocol (name or ID) (required) - -``--mapping `` - Mapping that is to be used (name or ID) (required) - -.. _openstack_federation_protocol_delete: - -openstack federation protocol delete ------------------------------------- - -.. code-block:: console - - usage: openstack federation protocol delete [-h] --identity-provider - - - [ ...] - -Delete federation protocol(s) - -**Positional arguments:** - -```` - Federation protocol(s) to delete (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--identity-provider `` - Identity provider that supports - (name or ID) (required) - -.. _openstack_federation_protocol_list: - -openstack federation protocol list ----------------------------------- - -.. code-block:: console - - usage: openstack federation protocol list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - --identity-provider - - -List federation protocols - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--identity-provider `` - Identity provider to list (name or ID) (required) - -.. _openstack_federation_protocol_set: - -openstack federation protocol set ---------------------------------- - -.. code-block:: console - - usage: openstack federation protocol set [-h] --identity-provider - - [--mapping ] - - -Set federation protocol properties - -**Positional arguments:** - -```` - Federation protocol to modify (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--identity-provider `` - Identity provider that supports - (name or ID) (required) - -``--mapping `` - Mapping that is to be used (name or ID) - -.. _openstack_federation_protocol_show: - -openstack federation protocol show ----------------------------------- - -.. code-block:: console - - usage: openstack federation protocol show [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - --identity-provider - - - -Display federation protocol details - -**Positional arguments:** - -```` - Federation protocol to display (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--identity-provider `` - Identity provider that supports - (name or ID) (required) - -.. _openstack_flavor_create: - -openstack flavor create ------------------------ - -.. code-block:: console - - usage: openstack flavor create [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] [--id ] - [--ram ] [--disk ] - [--ephemeral ] [--swap ] - [--vcpus ] [--rxtx-factor ] - [--public | --private] [--property ] - [--project ] - [--project-domain ] - - -Create new flavor - -**Positional arguments:** - -```` - New flavor name - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--id `` - Unique flavor ID; 'auto' creates a UUID (default: - auto) - -``--ram `` - Memory size in MB (default 256M) - -``--disk `` - Disk size in GB (default 0G) - -``--ephemeral `` - Ephemeral disk size in GB (default 0G) - -``--swap `` - Swap space size in GB (default 0G) - -``--vcpus `` - Number of vcpus (default 1) - -``--rxtx-factor `` - RX/TX factor (default 1.0) - -``--public`` - Flavor is available to other projects (default) - -``--private`` - Flavor is not available to other projects - -``--property `` - Property to add for this flavor (repeat option to set - multiple properties) - -``--project `` - Allow to access private flavor (name or ID) - (Must be used with :option:`--private` option) - -``--project-domain `` - Domain the project belongs to (name or ID). This can - be used in case collisions between project names - exist. - -.. _openstack_flavor_delete: - -openstack flavor delete ------------------------ - -.. code-block:: console - - usage: openstack flavor delete [-h] [ ...] - -Delete flavor(s) - -**Positional arguments:** - -```` - Flavor(s) to delete (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_flavor_list: - -openstack flavor list ---------------------- - -.. code-block:: console - - usage: openstack flavor list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--public | --private | --all] [--long] - [--marker ] [--limit ] - -List flavors - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--public`` - List only public flavors (default) - -``--private`` - List only private flavors - -``--all`` - List all flavors, whether public or private - -``--long`` - List additional fields in output - -``--marker `` - The last flavor ID of the previous page - -``--limit `` - Maximum number of flavors to display - -.. _openstack_flavor_set: - -openstack flavor set --------------------- - -.. code-block:: console - - usage: openstack flavor set [-h] [--property ] - [--project ] - [--project-domain ] - - -Set flavor properties - -**Positional arguments:** - -```` - Flavor to modify (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--property `` - Property to add or modify for this flavor (repeat - option to set multiple properties) - -``--project `` - Set flavor access to project (name or ID) (admin only) - -``--project-domain `` - Domain the project belongs to (name or ID). This can - be used in case collisions between project names - exist. - -.. _openstack_flavor_show: - -openstack flavor show ---------------------- - -.. code-block:: console - - usage: openstack flavor show [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--prefix PREFIX] - - -Display flavor details - -**Positional arguments:** - -```` - Flavor to display (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_flavor_unset: - -openstack flavor unset ----------------------- - -.. code-block:: console - - usage: openstack flavor unset [-h] [--property ] [--project ] - [--project-domain ] - - -Unset flavor properties - -**Positional arguments:** - -```` - Flavor to modify (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--property `` - Property to remove from flavor (repeat option to unset - multiple properties) - -``--project `` - Remove flavor access from project (name or ID) (admin - only) - -``--project-domain `` - Domain the project belongs to (name or ID). This can - be used in case collisions between project names - exist. - -.. _openstack_floating_ip_create: - -openstack floating ip create ----------------------------- - -.. code-block:: console - - usage: openstack floating ip create [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - [--subnet ] [--port ] - [--floating-ip-address ] - [--fixed-ip-address ] - - -Create floating IP - -**Positional arguments:** - -```` - Network to allocate floating IP from (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--subnet `` - Subnet on which you want to create the floating IP - (name or ID) - -``--port `` - Port to be associated with the floating IP (name or - ID) - -``--floating-ip-address `` - Floating IP address - -``--fixed-ip-address `` - Fixed IP address mapped to the floating IP - -.. _openstack_floating_ip_delete: - -openstack floating ip delete ----------------------------- - -.. code-block:: console - - usage: openstack floating ip delete [-h] [ ...] - -Delete floating IP(s) - -**Positional arguments:** - -```` - Floating IP(s) to delete (IP address or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_floating_ip_list: - -openstack floating ip list --------------------------- - -.. code-block:: console - - usage: openstack floating ip list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List floating IP(s) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_floating_ip_pool_list: - -openstack floating ip pool list -------------------------------- - -.. code-block:: console - - usage: openstack floating ip pool list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List pools of floating IP addresses - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_floating_ip_show: - -openstack floating ip show --------------------------- - -.. code-block:: console - - usage: openstack floating ip show [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - - -Display floating IP details - -**Positional arguments:** - -```` - Floating IP to display (IP address or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_group_add_user: - -openstack group add user ------------------------- - -.. code-block:: console - - usage: openstack group add user [-h] [--group-domain ] - [--user-domain ] - - -Add user to group - -**Positional arguments:** - -```` - Group to contain (name or ID) - -```` - User to add to (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--group-domain `` - Domain the group belongs to (name or ID). This can be - used in case collisions between group names exist. - -``--user-domain `` - Domain the user belongs to (name or ID). This can be - used in case collisions between user names exist. - -.. _openstack_group_contains_user: - -openstack group contains user ------------------------------ - -.. code-block:: console - - usage: openstack group contains user [-h] [--group-domain ] - [--user-domain ] - - -Check user membership in group - -**Positional arguments:** - -```` - Group to check (name or ID) - -```` - User to check (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--group-domain `` - Domain the group belongs to (name or ID). This can be - used in case collisions between group names exist. - -``--user-domain `` - Domain the user belongs to (name or ID). This can be - used in case collisions between user names exist. - -.. _openstack_group_create: - -openstack group create ----------------------- - -.. code-block:: console - - usage: openstack group create [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--prefix PREFIX] [--domain ] - [--description ] [--or-show] - - -Create new group - -**Positional arguments:** - -```` - New group name - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--domain `` - Domain to contain new group (name or ID) - -``--description `` - New group description - -``--or-show`` - Return existing group - -.. _openstack_group_delete: - -openstack group delete ----------------------- - -.. code-block:: console - - usage: openstack group delete [-h] [--domain ] [ ...] - -Delete group(s) - -**Positional arguments:** - -```` - Group(s) to delete (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--domain `` - Domain containing group(s) (name or ID) - -.. _openstack_group_list: - -openstack group list --------------------- - -.. code-block:: console - - usage: openstack group list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--domain ] [--user ] - [--user-domain ] [--long] - -List groups - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--domain `` - Filter group list by (name or ID) - -``--user `` - Filter group list by (name or ID) - -``--user-domain `` - Domain the user belongs to (name or ID). This can be - used in case collisions between user names exist. - -``--long`` - List additional fields in output - -.. _openstack_group_remove_user: - -openstack group remove user ---------------------------- - -.. code-block:: console - - usage: openstack group remove user [-h] [--group-domain ] - [--user-domain ] - - -Remove user from group - -**Positional arguments:** - -```` - Group containing (name or ID) - -```` - User to remove from (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--group-domain `` - Domain the group belongs to (name or ID). This can be - used in case collisions between group names exist. - -``--user-domain `` - Domain the user belongs to (name or ID). This can be - used in case collisions between user names exist. - -.. _openstack_group_set: - -openstack group set -------------------- - -.. code-block:: console - - usage: openstack group set [-h] [--domain ] [--name ] - [--description ] - - -Set group properties - -**Positional arguments:** - -```` - Group to modify (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--domain `` - Domain containing (name or ID) - -``--name `` - New group name - -``--description `` - New group description - -.. _openstack_group_show: - -openstack group show --------------------- - -.. code-block:: console - - usage: openstack group show [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--prefix PREFIX] [--domain ] - - -Display group details - -**Positional arguments:** - -```` - Group to display (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--domain `` - Domain containing (name or ID) - -.. _openstack_host_list: - -openstack host list -------------------- - -.. code-block:: console - - usage: openstack host list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--zone ] - -List hosts - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--zone `` - Only return hosts in the availability zone - -.. _openstack_host_set: - -openstack host set ------------------- - -.. code-block:: console - - usage: openstack host set [-h] [--enable | --disable] - [--enable-maintenance | --disable-maintenance] - - -Set host properties - -**Positional arguments:** - -```` - 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 - -.. _openstack_host_show: - -openstack host show -------------------- - -.. code-block:: console - - usage: openstack host show [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - - -Display host details - -**Positional arguments:** - -```` - Name of host - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_hypervisor_list: - -openstack hypervisor list -------------------------- - -.. code-block:: console - - usage: openstack hypervisor list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--matching ] - -List hypervisors - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--matching `` - Filter hypervisors using substring - -.. _openstack_hypervisor_show: - -openstack hypervisor show -------------------------- - -.. code-block:: console - - usage: openstack hypervisor show [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - - -Display hypervisor details - -**Positional arguments:** - -```` - Hypervisor to display (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_hypervisor_stats_show: - -openstack hypervisor stats show -------------------------------- - -.. code-block:: console - - usage: openstack hypervisor stats show [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - -Display hypervisor stats details - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_identity_provider_create: - -openstack identity provider create ----------------------------------- - -.. code-block:: console - - usage: openstack identity provider create [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - [--remote-id | --remote-id-file ] - [--description ] - [--enable | --disable] - - -Create new identity provider - -**Positional arguments:** - -```` - New identity provider name (must be unique) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--remote-id `` - Remote IDs to associate with the Identity Provider - (repeat option to provide multiple values) - -``--remote-id-file `` - Name of a file that contains many remote IDs to - associate with the identity provider, one per line - -``--description `` - New identity provider description - -``--enable`` - Enable identity provider (default) - -``--disable`` - Disable the identity provider - -.. _openstack_identity_provider_delete: - -openstack identity provider delete ----------------------------------- - -.. code-block:: console - - usage: openstack identity provider delete [-h] - - [ ...] - -Delete identity provider(s) - -**Positional arguments:** - -```` - Identity provider(s) to delete - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_identity_provider_list: - -openstack identity provider list --------------------------------- - -.. code-block:: console - - usage: openstack identity provider list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List identity providers - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_identity_provider_set: - -openstack identity provider set -------------------------------- - -.. code-block:: console - - usage: openstack identity provider set [-h] [--description ] - [--remote-id | --remote-id-file ] - [--enable | --disable] - - -Set identity provider properties - -**Positional arguments:** - -```` - Identity provider to modify - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--description `` - Set identity provider description - -``--remote-id `` - Remote IDs to associate with the Identity Provider - (repeat option to provide multiple values) - -``--remote-id-file `` - Name of a file that contains many remote IDs to - associate with the identity provider, one per line - -``--enable`` - Enable the identity provider - -``--disable`` - Disable the identity provider - -.. _openstack_identity_provider_show: - -openstack identity provider show --------------------------------- - -.. code-block:: console - - usage: openstack identity provider show [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - - -Display identity provider details - -**Positional arguments:** - -```` - Identity provider to display - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_image_add_project: - -openstack image add project ---------------------------- - -.. code-block:: console - - usage: openstack image add project [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - [--project-domain ] - - -Associate project with image - -**Positional arguments:** - -```` - Image to share (name or ID) - -```` - Project to associate with image (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--project-domain `` - Domain the project belongs to (name or ID). This can - be used in case collisions between project names - exist. - -.. _openstack_image_create: - -openstack image create ----------------------- - -.. code-block:: console - - usage: openstack image create [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--prefix PREFIX] [--id ] - [--container-format ] - [--disk-format ] - [--min-disk ] [--min-ram ] - [--file ] [--volume ] [--force] - [--protected | --unprotected] - [--public | --private] [--property ] - [--tag ] [--project ] - [--project-domain ] - - -Create/upload an image - -**Positional arguments:** - -```` - New image name - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--id `` - Image ID to reserve - -``--container-format `` - Image container format (default: bare) - -``--disk-format `` - Image disk format (default: raw) - -``--min-disk `` - Minimum disk size needed to boot image, in gigabytes - -``--min-ram `` - Minimum RAM size needed to boot image, in megabytes - -``--file `` - Upload image from local file - -``--volume `` - Create image from a volume - -``--force`` - Force image creation if volume is in use (only - meaningful with :option:`--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 `` - Set a property on this image (repeat option to set - multiple properties) - -``--tag `` - Set a tag on this image (repeat option to set multiple - tags) - -``--project `` - Set an alternate project on this image (name or ID) - -``--project-domain `` - Domain the project belongs to (name or ID). This can - be used in case collisions between project names - exist. - -.. _openstack_image_delete: - -openstack image delete ----------------------- - -.. code-block:: console - - usage: openstack image delete [-h] [ ...] - -Delete image(s) - -**Positional arguments:** - -```` - Image(s) to delete (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_image_list: - -openstack image list --------------------- - -.. code-block:: console - - usage: openstack image list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--public | --private | --shared] - [--property ] [--long] - [--sort [:]] [--limit ] - [--marker ] - -List available images - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--public`` - List only public images - -``--private`` - List only private images - -``--shared`` - List only shared images - -``--property `` - Filter output based on property - -``--long`` - List additional fields in output - -``--sort [:]`` - Sort output by selected keys and directions(asc or - desc) (default: asc), multiple keys and directions can - be specified separated by comma - -``--limit `` - Maximum number of images to display. - -``--marker `` - The last image (name or ID) of the previous page. - Display list of images after marker. Display all - images if not specified. - -.. _openstack_image_remove_project: - -openstack image remove project ------------------------------- - -.. code-block:: console - - usage: openstack image remove project [-h] [--project-domain ] - - -Disassociate project with image - -**Positional arguments:** - -```` - Image to unshare (name or ID) - -```` - Project to disassociate with image (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--project-domain `` - Domain the project belongs to (name or ID). This can - be used in case collisions between project names - exist. - -.. _openstack_image_save: - -openstack image save --------------------- - -.. code-block:: console - - usage: openstack image save [-h] [--file ] - -Save an image locally - -**Positional arguments:** - -```` - Image to save (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--file `` - Downloaded image save filename (default: stdout) - -.. _openstack_image_set: - -openstack image set -------------------- - -.. code-block:: console - - usage: openstack image set [-h] [--name ] [--min-disk ] - [--min-ram ] - [--container-format ] - [--disk-format ] - [--protected | --unprotected] - [--public | --private] [--property ] - [--tag ] [--architecture ] - [--instance-id ] - [--kernel-id ] [--os-distro ] - [--os-version ] - [--ramdisk-id ] - [--deactivate | --activate] [--project ] - [--project-domain ] - - -Set image properties - -**Positional arguments:** - -```` - Image to modify (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--name `` - New image name - -``--min-disk `` - Minimum disk size needed to boot image, in gigabytes - -``--min-ram `` - Minimum RAM size needed to boot image, in megabytes - -``--container-format `` - Image container format (default: bare) - -``--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 `` - Set a property on this image (repeat option to set - multiple properties) - -``--tag `` - Set a tag on this image (repeat option to set multiple - tags) - -``--architecture `` - Operating system architecture - -``--instance-id `` - ID of server instance used to create this image - -``--kernel-id `` - ID of kernel image used to boot this disk image - -``--os-distro `` - Operating system distribution name - -``--os-version `` - Operating system distribution version - -``--ramdisk-id `` - ID of ramdisk image used to boot this disk image - -``--deactivate`` - Deactivate the image - -``--activate`` - Activate the image - -``--project `` - Set an alternate project on this image (name or ID) - -``--project-domain `` - Domain the project belongs to (name or ID). This can - be used in case collisions between project names - exist. - -.. _openstack_image_show: - -openstack image show --------------------- - -.. code-block:: console - - usage: openstack image show [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--prefix PREFIX] - - -Display image details - -**Positional arguments:** - -```` - Image to display (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_image_unset: - -openstack image unset ---------------------- - -.. code-block:: console - - usage: openstack image unset [-h] [--tag ] [--property ] - - -Unset image tags and properties - -**Positional arguments:** - -```` - Image to modify (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--tag `` - Unset a tag on this image (repeat option to set - multiple tags) - -``--property `` - Unset a property on this image (repeat option to set - multiple properties) - -.. _openstack_ip_availability_list: - -openstack ip availability list ------------------------------- - -.. code-block:: console - - usage: openstack ip availability list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--ip-version ] - [--project ] - [--project-domain ] - -List IP availability for network - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--ip-version `` - List IP availability of given IP version networks - (default is 4) - -``--project `` - List IP availability of given project (name or ID) - -``--project-domain `` - Domain the project belongs to (name or ID). This can - be used in case collisions between project names - exist. - -.. _openstack_ip_availability_show: - -openstack ip availability show ------------------------------- - -.. code-block:: console - - usage: openstack ip availability show [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - - -Show network IP availability details - -**Positional arguments:** - -```` - Show IP availability for a specific network (name or - ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_ip_fixed_add: - -openstack ip fixed add ----------------------- - -.. code-block:: console - - usage: openstack ip fixed add [-h] - -Add fixed IP address to server - -**Positional arguments:** - -```` - Network to fetch an IP address from (name or ID) - -```` - Server to receive the IP address (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_ip_fixed_remove: - -openstack ip fixed remove -------------------------- - -.. code-block:: console - - usage: openstack ip fixed remove [-h] - -Remove fixed IP address from server - -**Positional arguments:** - -```` - IP address to remove from server (name only) - -```` - Server to remove the IP address from (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_ip_floating_add: - -openstack ip floating add -------------------------- - -.. code-block:: console - - usage: openstack ip floating add [-h] - -Add floating IP address to server - -**Positional arguments:** - -```` - IP address to add to server (name only) - -```` - Server to receive the IP address (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_ip_floating_create: - -openstack ip floating create ----------------------------- - -.. code-block:: console - - usage: openstack ip floating create [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - [--subnet ] [--port ] - [--floating-ip-address ] - [--fixed-ip-address ] - - -Create floating IP - -**Positional arguments:** - -```` - Network to allocate floating IP from (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--subnet `` - Subnet on which you want to create the floating IP - (name or ID) - -``--port `` - Port to be associated with the floating IP (name or - ID) - -``--floating-ip-address `` - Floating IP address - -``--fixed-ip-address `` - Fixed IP address mapped to the floating IP - -.. _openstack_ip_floating_delete: - -openstack ip floating delete ----------------------------- - -.. code-block:: console - - usage: openstack ip floating delete [-h] [ ...] - -Delete floating IP(s) - -**Positional arguments:** - -```` - Floating IP(s) to delete (IP address or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_ip_floating_list: - -openstack ip floating list --------------------------- - -.. code-block:: console - - usage: openstack ip floating list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List floating IP(s) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_ip_floating_pool_list: - -openstack ip floating pool list -------------------------------- - -.. code-block:: console - - usage: openstack ip floating pool list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List pools of floating IP addresses - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_ip_floating_remove: - -openstack ip floating remove ----------------------------- - -.. code-block:: console - - usage: openstack ip floating remove [-h] - -Remove floating IP address from server - -**Positional arguments:** - -```` - IP address to remove from server (name only) - -```` - Server to remove the IP address from (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_ip_floating_show: - -openstack ip floating show --------------------------- - -.. code-block:: console - - usage: openstack ip floating show [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - - -Display floating IP details - -**Positional arguments:** - -```` - Floating IP to display (IP address or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_keypair_create: - -openstack keypair create ------------------------- - -.. code-block:: console - - usage: openstack keypair create [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - [--public-key ] - - -Create new public key - -**Positional arguments:** - -```` - New public key name - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--public-key `` - Filename for public key to add - -.. _openstack_keypair_delete: - -openstack keypair delete ------------------------- - -.. code-block:: console - - usage: openstack keypair delete [-h] [ ...] - -Delete public key(s) - -**Positional arguments:** - -```` - Public key(s) to delete (name only) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_keypair_list: - -openstack keypair list ----------------------- - -.. code-block:: console - - usage: openstack keypair list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List public key fingerprints - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_keypair_show: - -openstack keypair show ----------------------- - -.. code-block:: console - - usage: openstack keypair show [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--prefix PREFIX] [--public-key] - - -Display public key details - -**Positional arguments:** - -```` - 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) - -.. _openstack_limits_show: - -openstack limits show ---------------------- - -.. code-block:: console - - usage: openstack limits show [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - (--absolute | --rate) [--reserved] - [--project ] [--domain ] - -Show compute and block storage limits - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--absolute`` - Show absolute limits - -``--rate`` - Show rate limits - -``--reserved`` - Include reservations count [only valid with - :option:`--absolute]` - -``--project `` - Show limits for a specific project (name or ID) [only - valid with :option:`--absolute]` - -``--domain `` - Domain the project belongs to (name or ID) [only valid - with :option:`--absolute]` - -.. _openstack_mapping_create: - -openstack mapping create ------------------------- - -.. code-block:: console - - usage: openstack mapping create [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] --rules - - - -Create new mapping - -**Positional arguments:** - -```` - New mapping name (must be unique) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--rules `` - Filename that contains a set of mapping rules - (required) - -.. _openstack_mapping_delete: - -openstack mapping delete ------------------------- - -.. code-block:: console - - usage: openstack mapping delete [-h] [ ...] - -Delete mapping(s) - -**Positional arguments:** - -```` - Mapping(s) to delete - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_mapping_list: - -openstack mapping list ----------------------- - -.. code-block:: console - - usage: openstack mapping list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List mappings - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_mapping_set: - -openstack mapping set ---------------------- - -.. code-block:: console - - usage: openstack mapping set [-h] [--rules ] - -Set mapping properties - -**Positional arguments:** - -```` - Mapping to modify - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--rules `` - Filename that contains a new set of mapping rules - -.. _openstack_mapping_show: - -openstack mapping show ----------------------- - -.. code-block:: console - - usage: openstack mapping show [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--prefix PREFIX] - - -Display mapping details - -**Positional arguments:** - -```` - Mapping to display - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_messaging_flavor_create: - -openstack messaging flavor create ---------------------------------- - -.. code-block:: console - - usage: openstack messaging flavor create [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - [--capabilities ] - - -Create a pool flavor - -**Positional arguments:** - -```` - Name of the flavor - -```` - Pool group for flavor - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--capabilities `` - Describes flavor-specific capabilities, This option is - only available in client api version < 2 . - -.. _openstack_messaging_flavor_delete: - -openstack messaging flavor delete ---------------------------------- - -.. code-block:: console - - usage: openstack messaging flavor delete [-h] - -Delete a flavor - -**Positional arguments:** - -```` - Name of the flavor - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_messaging_flavor_list: - -openstack messaging flavor list -------------------------------- - -.. code-block:: console - - usage: openstack messaging flavor list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--marker ] - [--limit ] - [--detailed ] - -List available flavors - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--marker `` - Flavor's paging marker - -``--limit `` - Page size limit - -``--detailed `` - If show detailed capabilities of flavor - -.. _openstack_messaging_flavor_show: - -openstack messaging flavor show -------------------------------- - -.. code-block:: console - - usage: openstack messaging flavor show [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - - -Display flavor details - -**Positional arguments:** - -```` - Flavor to display (name) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_messaging_flavor_update: - -openstack messaging flavor update ---------------------------------- - -.. code-block:: console - - usage: openstack messaging flavor update [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - [--pool_group ] - [--capabilities ] - - -Update a flavor's attributes - -**Positional arguments:** - -```` - Name of the flavor - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--pool_group `` - Pool group the flavor sits on - -``--capabilities `` - Describes flavor-specific capabilities. - -.. _openstack_messaging_health: - -openstack messaging health --------------------------- - -.. code-block:: console - - usage: openstack messaging health [-h] - -Display detailed health status of Zaqar server - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_messaging_ping: - -openstack messaging ping ------------------------- - -.. code-block:: console - - usage: openstack messaging ping [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - -Check if Zaqar server is alive or not - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_module_list: - -openstack module list ---------------------- - -.. code-block:: console - - usage: openstack module list [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--prefix PREFIX] [--all] - -List module versions - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--all`` - Show all modules that have version information - -.. _openstack_network_agent_delete: - -openstack network agent delete ------------------------------- - -.. code-block:: console - - usage: openstack network agent delete [-h] - [ ...] - -Delete network agent(s) - -**Positional arguments:** - -```` - Network agent(s) to delete (ID only) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_network_agent_list: - -openstack network agent list ----------------------------- - -.. code-block:: console - - usage: openstack network agent list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List network agents - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_network_agent_set: - -openstack network agent set ---------------------------- - -.. code-block:: console - - usage: openstack network agent set [-h] [--description ] - [--enable | --disable] - - -Set network agent properties - -**Positional arguments:** - -```` - Network agent to modify (ID only) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--description `` - Set network agent description - -``--enable`` - Enable network agent - -``--disable`` - Disable network agent - -.. _openstack_network_agent_show: - -openstack network agent show ----------------------------- - -.. code-block:: console - - usage: openstack network agent show [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - - -Display network agent details - -**Positional arguments:** - -```` - Network agent to display (ID only) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_network_create: - -openstack network create ------------------------- - -.. code-block:: console - - usage: openstack network create [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - [--share | --no-share] [--enable | --disable] - [--project ] - [--project-domain ] - [--availability-zone-hint ] - [--enable-port-security | --disable-port-security] - [--external | --internal] - [--default | --no-default] - [--provider-network-type ] - [--provider-physical-network ] - [--provider-segment ] - [--transparent-vlan | --no-transparent-vlan] - - -Create new network - -**Positional arguments:** - -```` - 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 `` - Owner's project (name or ID) - -``--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 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 `` - The physical mechanism by which the virtual network is - implemented. The supported options are: flat, geneve, - gre, local, vlan, vxlan. - -``--provider-physical-network `` - Name of the physical network over which the virtual - network is implemented - -``--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 - -.. _openstack_network_delete: - -openstack network delete ------------------------- - -.. code-block:: console - - usage: openstack network delete [-h] [ ...] - -Delete network(s) - -**Positional arguments:** - -```` - Network(s) to delete (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_network_list: - -openstack network list ----------------------- - -.. code-block:: console - - usage: openstack network list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--external] [--long] - -List networks - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--external`` - List external networks - -``--long`` - List additional fields in output - -.. _openstack_network_rbac_create: - -openstack network rbac create ------------------------------ - -.. code-block:: console - - usage: openstack network rbac create [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] --type - --action --target-project - - [--target-project-domain ] - [--project ] - [--project-domain ] - - -Create network RBAC policy - -**Positional arguments:** - -```` - 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 of the object that RBAC policy affects - ("qos_policy" or "network") - -``--action `` - Action for the RBAC policy ("access_as_external" or - "access_as_shared") - -``--target-project `` - The project to which the RBAC policy will be enforced - (name or ID) - -``--target-project-domain `` - Domain the target project belongs to (name or ID). - This can be used in case collisions between project - names exist. - -``--project `` - The owner project (name or ID) - -``--project-domain `` - Domain the project belongs to (name or ID). This can - be used in case collisions between project names - exist. - -.. _openstack_network_rbac_delete: - -openstack network rbac delete ------------------------------ - -.. code-block:: console - - usage: openstack network rbac delete [-h] [ ...] - -Delete network RBAC policy(s) - -**Positional arguments:** - -```` - RBAC policy(s) to delete (ID only) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_network_rbac_list: - -openstack network rbac list ---------------------------- - -.. code-block:: console - - usage: openstack network rbac list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List network RBAC policies - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_network_rbac_set: - -openstack network rbac set --------------------------- - -.. code-block:: console - - usage: openstack network rbac set [-h] [--target-project ] - [--target-project-domain ] - - -Set network RBAC policy properties - -**Positional arguments:** - -```` - RBAC policy to be modified (ID only) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--target-project `` - The project to which the RBAC policy will be enforced - (name or ID) - -``--target-project-domain `` - Domain the target project belongs to (name or ID). - This can be used in case collisions between project - names exist. - -.. _openstack_network_rbac_show: - -openstack network rbac show ---------------------------- - -.. code-block:: console - - usage: openstack network rbac show [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - - -Display network RBAC policy details - -**Positional arguments:** - -```` - RBAC policy (ID only) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_network_segment_list: - -openstack network segment list ------------------------------- - -.. code-block:: console - - usage: openstack network segment list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--long] [--network ] - -List network segments (Caution: This is a beta command and subject to change. -Use global option :option:`--os-beta-command` to enable this command) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--long`` - List additional fields in output - -``--network `` - List network segments that belong to this network - (name or ID) - -.. _openstack_network_segment_show: - -openstack network segment show ------------------------------- - -.. code-block:: console - - usage: openstack network segment show [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - - -Display network segment details (Caution: This is a beta command and subject -to -change. -Use -global -option -:option:`--os-beta-command` -to -enable -this -command) - -**Positional arguments:** - -```` - Network segment to display (ID only) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_network_set: - -openstack network set ---------------------- - -.. code-block:: console - - usage: openstack network set [-h] [--name ] [--enable | --disable] - [--share | --no-share] - [--enable-port-security | --disable-port-security] - [--external | --internal] - [--default | --no-default] - [--provider-network-type ] - [--provider-physical-network ] - [--provider-segment ] - [--transparent-vlan | --no-transparent-vlan] - - -Set network properties - -**Positional arguments:** - -```` - Network to modify (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--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 `` - The physical mechanism by which the virtual network is - implemented. The supported options are: flat, geneve, - gre, local, vlan, vxlan. - -``--provider-physical-network `` - Name of the physical network over which the virtual - network is implemented - -``--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 - -.. _openstack_network_show: - -openstack network show ----------------------- - -.. code-block:: console - - usage: openstack network show [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--prefix PREFIX] - - -Show network details - -**Positional arguments:** - -```` - Network to display (name or ID) - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_object_create: - -openstack object create ------------------------ - -.. code-block:: console - - usage: openstack object create [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [ ...] - -Upload object to container - -**Positional arguments:** - -```` - Container for new object - -```` - Local filename(s) to upload - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_object_delete: - -openstack object delete ------------------------ - -.. code-block:: console - - usage: openstack object delete [-h] [ ...] - -Delete object from container - -**Positional arguments:** - -```` - Delete object(s) from - -```` - Object(s) to delete - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_object_list: - -openstack object list ---------------------- - -.. code-block:: console - - usage: openstack object list [-h] [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--prefix ] [--delimiter ] - [--marker ] [--end-marker ] - [--limit ] [--long] [--all] - - -List objects - -**Positional arguments:** - -```` - Container to list - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--prefix `` - Filter list using - -``--delimiter `` - Roll up items with - -``--marker `` - Anchor for paging - -``--end-marker `` - End anchor for paging - -``--limit `` - Limit the number of objects returned - -``--long`` - List additional fields in output - -``--all`` - List all objects in container (default is 10000) - -.. _openstack_object_save: - -openstack object save ---------------------- - -.. code-block:: console - - usage: openstack object save [-h] [--file ] - -Save object locally - -**Positional arguments:** - -```` - Download from - -```` - Object to save - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--file `` - Destination filename (defaults to object name) - -.. _openstack_object_set: - -openstack object set --------------------- - -.. code-block:: console - - usage: openstack object set [-h] --property - -Set object properties - -**Positional arguments:** - -```` - Modify from - -```` - Object to modify - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--property `` - Set a property on this object (repeat option to set - multiple properties) - -.. _openstack_object_show: - -openstack object show ---------------------- - -.. code-block:: console - - usage: openstack object show [-h] [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] [--noindent] - [--prefix PREFIX] - - -Display object details - -**Positional arguments:** - -```` - Display from - -```` - Object to display - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_object_store_account_set: - -openstack object store account set ----------------------------------- - -.. code-block:: console - - usage: openstack object store account set [-h] --property - -Set account properties - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--property `` - Set a property on this account (repeat option to set - multiple properties) - -.. _openstack_object_store_account_show: - -openstack object store account show ------------------------------------ - -.. code-block:: console - - usage: openstack object store account show [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - -Display account details - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_object_store_account_unset: - -openstack object store account unset ------------------------------------- - -.. code-block:: console - - usage: openstack object store account unset [-h] --property - -Unset account properties - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--property `` - Property to remove from account (repeat option to remove - multiple properties) - -.. _openstack_object_unset: - -openstack object unset ----------------------- - -.. code-block:: console - - usage: openstack object unset [-h] --property - -Unset object properties - -**Positional arguments:** - -```` - Modify from - -```` - Object to modify - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--property `` - Property to remove from object (repeat option to remove - multiple properties) - -.. _openstack_orchestration_build_info: - -openstack orchestration build info ----------------------------------- - -.. code-block:: console - - usage: openstack orchestration build info [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] [--max-width ] - [--noindent] [--prefix PREFIX] - -Retrieve build information. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_orchestration_resource_type_list: - -openstack orchestration resource type list ------------------------------------------- - -.. code-block:: console - - usage: openstack orchestration resource type list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - [--filter ] - [--long] - -List resource types. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--filter `` - 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. - -.. _openstack_orchestration_resource_type_show: - -openstack orchestration resource type show ------------------------------------------- - -.. code-block:: console - - usage: openstack orchestration resource type show [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--prefix PREFIX] - [--template-type ] - [--long] - - -Show details and optionally generate a template for a resource type. - -**Positional arguments:** - -```` - Resource type to show details for - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -``--template-type `` - Optional template type to generate, hot or cfn - -``--long`` - Show resource type with corresponding description. - -.. _openstack_orchestration_service_list: - -openstack orchestration service list ------------------------------------- - -.. code-block:: console - - usage: openstack orchestration service list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - -List the Heat engines. - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_orchestration_template_function_list: - -openstack orchestration template function list ----------------------------------------------- - -.. code-block:: console - - usage: openstack orchestration template function list [-h] - [-f {csv,html,json,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--quote {all,minimal,none,nonnumeric}] - - -List the available functions. - -**Positional arguments:** - -```` - Template version to get the functions for - -**Optional arguments:** - -``-h, --help`` - show this help message and exit - -.. _openstack_orchestration_template_validate: - -openstack orchestration template validate ------------------------------------------ - -.. code-block:: console - - usage: openstack orchestration template validate [-h] - [-f {html,json,shell,table,value,yaml}] - [-c COLUMN] - [--max-width ] - [--noindent] - [--prefix PREFIX] - [-e ] - [--show-nested] - [--parameter ] - [--ignore-errors ] - -t