.. ## WARNING ###################################### .. This file is automatically generated, do not edit .. ################################################# ============================= OpenStack command-line client ============================= The openstack client is a common OpenStackcommand-line interface (CLI). This chapter documents :command:`openstack` version ``2.0.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] [--log-file LOG_FILE] [-q] [-h] [--debug] [--os-cloud ] [--os-region-name ] [--os-cacert ] [--verify | --insecure] [--os-default-domain ] [--os-interface ] [--timing] [--os-compute-api-version ] [--os-network-api-version ] [--os-image-api-version ] [--os-volume-api-version ] [--os-identity-api-version ] [--os-auth-type ] [--os-project-domain-id ] [--os-protocol ] [--os-project-name ] [--os-trust-id ] [--os-service-provider-endpoint ] [--os-domain-name ] [--os-user-domain-id ] [--os-identity-provider-url ] [--os-access-token-endpoint ] [--os-domain-id ] [--os-user-domain-name ] [--os-scope ] [--os-user-id ] [--os-identity-provider ] [--os-username ] [--os-auth-url ] [--os-client-secret ] [--os-client-id ] [--os-project-domain-name ] [--os-password ] [--os-endpoint ] [--os-url ] [--os-token ] [--os-project-id ] [--os-object-api-version ] [--os-queues-api-version ] [--os-policy-api-version ] [--os-dns-api-version ] [--os-mb-api-version ] [--os-baremetal-api-version ] [--os-management-api-version ] [--os-data-processing-api-version ] [--inspector-api-version INSPECTOR_API_VERSION] [--inspector-url INSPECTOR_URL] .. _openstack_command_options: openstack optional arguments ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ``--version`` show program's version number and exit ``-v, --verbose`` Increase verbosity of output. Can be repeated. ``--log-file LOG_FILE`` Specify a file to log output. Disabled by default. ``-q, --quiet`` Suppress output except warnings and errors. ``-h, --help`` Show help message and exit. ``--debug`` Show tracebacks on errors. ``--os-cloud `` Cloud 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) ``--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-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-auth-type `` Select an authentication type. Available types: osc_password, token_endpoint, v2token, admin_token, v2password, v3password, v3scopedsaml, v3oidcpassword, v3unscopedadfs, token, v3token, password, v3unscopedsaml. Default: selected based on :option:`--os-` username/:option:`--os-token` (Env: OS_AUTH_TYPE) ``--os-project-domain-id `` With osc_password: Domain ID containing project With v3password: Domain ID containing project With v3scopedsaml: Domain ID containing project With v3oidcpassword: Domain ID containing project With v3unscopedadfs: Domain ID containing project With token: Domain ID containing project With v3token: Domain ID containing project With password: Domain ID containing project With v3unscopedsaml: Domain ID containing project (Env: OS_PROJECT_DOMAIN_ID) ``--os-protocol `` With v3oidcpassword: Name of the federated protocol used for federated authentication. Must match its counterpart name configured at the keystone service provider. Typically values would be 'saml2' or 'oidc'. (Env: OS_PROTOCOL) ``--os-project-name `` With osc_password: Project name to scope to With v3password: Project name to scope to With v3scopedsaml: Project name to scope to With v3oidcpassword: Project name to scope to With v3unscopedadfs: Project name to scope to With token: Project name to scope to With v3token: Project name to scope to With password: Project name to scope to With v3unscopedsaml: Project name to scope to (Env: OS_PROJECT_NAME) ``--os-trust-id `` With osc_password: Trust ID With v2token: Trust ID With v2password: Trust ID With v3password: Trust ID With v3scopedsaml: Trust ID With v3oidcpassword: Trust ID With v3unscopedadfs: Trust ID With token: Trust ID With v3token: Trust ID With password: Trust ID With v3unscopedsaml: Trust ID (Env: OS_TRUST_ID) ``--os-service-provider-endpoint `` With v3unscopedadfs: Service Provider's Endpoint (Env: OS_SERVICE_PROVIDER_ENDPOINT) ``--os-domain-name `` With osc_password: Domain name to scope to With v3password: Domain name to scope to With v3scopedsaml: Domain name to scope to With v3oidcpassword: Domain name to scope to With v3unscopedadfs: Domain name to scope to With token: Domain name to scope to With v3token: Domain name to scope to With password: Domain name to scope to With v3unscopedsaml: Domain name to scope to (Env: OS_DOMAIN_NAME) ``--os-user-domain-id `` With osc_password: User's domain id With v3password: User's domain id With password: User's domain id (Env: OS_USER_DOMAIN_ID) ``--os-identity-provider-url `` With v3unscopedadfs: Identity Provider's URL With v3unscopedsaml: Identity Provider's URL (Env: OS_IDENTITY_PROVIDER_URL) ``--os-access-token-endpoint `` With v3oidcpassword: OpenID Connect Provider Token Endpoint (Env: OS_ACCESS_TOKEN_ENDPOINT) ``--os-domain-id `` With osc_password: Domain ID to scope to With v3password: Domain ID to scope to With v3scopedsaml: Domain ID to scope to With v3oidcpassword: Domain ID to scope to With v3unscopedadfs: Domain ID to scope to With token: Domain ID to scope to With v3token: Domain ID to scope to With password: Domain ID to scope to With v3unscopedsaml: Domain ID to scope to (Env: OS_DOMAIN_ID) ``--os-user-domain-name `` With osc_password: User's domain name With v3password: User's domain name With password: User's domain name (Env: OS_USER_DOMAIN_NAME) ``--os-scope `` With v3oidcpassword: OpenID Connect scope that is requested from OP (Env: OS_SCOPE) ``--os-user-id `` With osc_password: User id With v2password: User ID to login with With v3password: User ID With password: User id (Env: OS_USER_ID) ``--os-identity-provider `` With v3oidcpassword: Identity Provider's name With v3unscopedadfs: Identity Provider's name With v3unscopedsaml: Identity Provider's name (Env: OS_IDENTITY_PROVIDER) ``--os-username `` With osc_password: Username With v2password: Username to login with With v3password: Username With v3oidcpassword: Username With v3unscopedadfs: Username With password: Username With v3unscopedsaml: Username (Env: OS_USERNAME) ``--os-auth-url `` With osc_password: Authentication URL With v2token: Authentication URL With v2password: Authentication URL With v3password: Authentication URL With v3scopedsaml: Authentication URL With v3oidcpassword: Authentication URL With v3unscopedadfs: Authentication URL With token: Authentication URL With v3token: Authentication URL With password: Authentication URL With v3unscopedsaml: Authentication URL (Env: OS_AUTH_URL) ``--os-client-secret `` With v3oidcpassword: OAuth 2.0 Client Secret (Env: OS_CLIENT_SECRET) ``--os-client-id `` With v3oidcpassword: OAuth 2.0 Client ID (Env: OS_CLIENT_ID) ``--os-project-domain-name `` With osc_password: Domain name containing project With v3password: Domain name containing project With v3scopedsaml: Domain name containing project With v3oidcpassword: Domain name containing project With v3unscopedadfs: Domain name containing project With token: Domain name containing project With v3token: Domain name containing project With password: Domain name containing project With v3unscopedsaml: Domain name containing project (Env: OS_PROJECT_DOMAIN_NAME) ``--os-password `` With osc_password: User's password With v2password: Password to use With v3password: User's password With v3oidcpassword: Password With v3unscopedadfs: Password With password: User's password With v3unscopedsaml: Password (Env: OS_PASSWORD) ``--os-endpoint `` With token_endpoint: The endpoint that will always be used With admin_token: The endpoint that will always be used (Env: OS_ENDPOINT) ``--os-url `` With token_endpoint: Specific service endpoint to use (Env: OS_URL) ``--os-token `` With token_endpoint: The token that will always be used With token_endpoint: Authentication token to use With v2token: Token With admin_token: The token that will always be used With v3scopedsaml: Token to authenticate with With token: Token to authenticate with With v3token: Token to authenticate with (Env: OS_TOKEN) ``--os-project-id `` With osc_password: Project ID to scope to With v3password: Project ID to scope to With v3scopedsaml: Project ID to scope to With v3oidcpassword: Project ID to scope to With v3unscopedadfs: Project ID to scope to With token: Project ID to scope to With v3token: Project ID to scope to With password: Project ID to scope to With v3unscopedsaml: Project ID to scope to (Env: OS_PROJECT_ID) ``--os-object-api-version `` Object API version, default=1 (Env: OS_OBJECT_API_VERSION) ``--os-queues-api-version `` Queues API version, default=1.1 (Env: OS_QUEUES_API_VERSION) ``--os-policy-api-version `` Policy API version, default=1 (Env: OS_POLICY_API_VERSION) ``--os-dns-api-version `` DNS API version, default=2 (Env: OS_DNS_API_VERSION) ``--os-mb-api-version `` MB API version, default=1 (Env: OS_MB_API_VERSION) ``--os-baremetal-api-version `` Baremetal API version, default=1.6 (Env: OS_BAREMETAL_API_VERSION) ``--os-management-api-version `` Management API version, default=2 (Env: OS_MANAGEMENT_API_VERSION) ``--os-data-processing-api-version `` Data processing API version, default=1.1 (Env: OS_DATA_PROCESSING_API_VERSION) ``--inspector-api-version INSPECTOR_API_VERSION`` inspector API version, only 1 is supported now (env: INSPECTOR_VERSION). ``--inspector-url INSPECTOR_URL`` inspector URL, defaults to localhost (env: INSPECTOR_URL). OpenStack with Identity API v2 commands ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. _openstack_aggregate_add_host_with_identity_api_v2: openstack aggregate add host ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate add host [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v2: openstack aggregate create ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v2: openstack aggregate delete ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate delete [-h] Delete an existing aggregate Positional arguments -------------------- ```` Aggregate to delete (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_aggregate_list_with_identity_api_v2: openstack aggregate list ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v2: openstack aggregate remove host ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate remove host [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v2: openstack aggregate set ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--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_with_identity_api_v2: openstack aggregate show ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_availability_zone_list_with_identity_api_v2: openstack availability zone list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 availability zone list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long] List availability zones and their status Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--long`` List additional fields in output .. _openstack_backup_create_with_identity_api_v2: openstack backup create ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 backup create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--container ] [--name ] [--description ] Create new backup Positional arguments -------------------- ```` Volume to backup (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--container `` Optional backup container name ``--name `` Name of the backup ``--description `` Description of the backup .. _openstack_backup_delete_with_identity_api_v2: openstack backup delete ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 backup delete [-h] [ ...] Delete backup(s) Positional arguments -------------------- ```` Backup(s) to delete (ID only) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_backup_list_with_identity_api_v2: openstack backup list ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 backup list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v2: openstack backup restore ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 backup restore [-h] Restore backup Positional arguments -------------------- ```` Backup to restore (ID only) ```` Volume to restore to (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_backup_show_with_identity_api_v2: openstack backup show ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 backup show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Display backup details Positional arguments -------------------- ```` Backup to display (ID only) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_baremetal_create_with_identity_api_v2: openstack baremetal create ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--chassis-uuid ] --driver [--driver-info ] [--property ] [--extra ] [--uuid ] [--name ] 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. .. _openstack_baremetal_delete_with_identity_api_v2: openstack baremetal delete ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal delete [-h] Unregister a baremetal node Positional arguments -------------------- ```` Node to delete (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_baremetal_introspection_rule_delete_with_identity_api_v2: openstack baremetal introspection rule delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 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_with_identity_api_v2: openstack baremetal introspection rule import ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal introspection rule import [-h] 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_with_identity_api_v2: openstack baremetal introspection rule list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal introspection rule list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v2: openstack baremetal introspection rule purge ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal introspection rule purge [-h] Drop all introspection rules. Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_baremetal_introspection_rule_show_with_identity_api_v2: openstack baremetal introspection rule show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal introspection rule show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v2: openstack baremetal introspection start ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal introspection start [-h] [--new-ipmi-username NEW_IPMI_USERNAME] [--new-ipmi-password NEW_IPMI_PASSWORD] uuid [uuid ...] Start the introspection. Positional arguments -------------------- ``uuid`` baremetal node UUID(s) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--new-ipmi-username NEW_IPMI_USERNAME`` if set, \*Ironic Inspector\* will update IPMI user name to this value ``--new-ipmi-password NEW_IPMI_PASSWORD`` if set, \*Ironic Inspector\* will update IPMI password to this value .. _openstack_baremetal_introspection_status_with_identity_api_v2: openstack baremetal introspection status ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal introspection status [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_list_with_identity_api_v2: openstack baremetal list ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--limit ] [--marker ] [--sort [:]] [--maintenance] [--associated] [--long] 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 selected keys and directions(asc or desc) (default: asc), multiple keys and directions can be specified separated by comma ``--maintenance`` List nodes in maintenance mode. ``--associated`` List only nodes associated with an instance. ``--long`` Show detailed information about the nodes. .. _openstack_baremetal_set_with_identity_api_v2: openstack baremetal set ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal set [-h] [--property ] Set baremetal properties Positional arguments -------------------- ```` Name or UUID of the node. Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--property `` Property to add to this baremetal host (repeat option to set multiple properties) .. _openstack_baremetal_show_with_identity_api_v2: openstack baremetal show ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--instance] [--long] 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. ``--long`` .. _openstack_baremetal_unset_with_identity_api_v2: openstack baremetal unset ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal unset [-h] [--property ] Unset baremetal properties Positional arguments -------------------- ```` Name or UUID of the node. Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--property `` Property to unset on this baremetal host (repeat option to unset multiple properties) .. _openstack_catalog_list_with_identity_api_v2: openstack catalog list ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 catalog list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v2: openstack catalog show ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 catalog show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_command_list_with_identity_api_v2: openstack command list ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 command list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v2: openstack compute agent create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 compute agent create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Create compute agent command 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_with_identity_api_v2: openstack compute agent delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 compute agent delete [-h] Delete compute agent command Positional arguments -------------------- ```` ID of agent to delete Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_compute_agent_list_with_identity_api_v2: openstack compute agent list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 compute agent list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--hypervisor ] List compute agent command Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--hypervisor `` Type of hypervisor .. _openstack_compute_agent_set_with_identity_api_v2: openstack compute agent set ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 compute agent set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Set compute agent command Positional arguments -------------------- ```` ID of the agent ```` Version of the agent ```` URL ```` MD5 hash Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_compute_service_delete_with_identity_api_v2: openstack compute service delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 compute service delete [-h] Delete service command Positional arguments -------------------- ```` Compute service to delete (ID only) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_compute_service_list_with_identity_api_v2: openstack compute service list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 compute service list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--host ] [--service ] List service command Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--host `` Name of host ``--service `` Name of service .. _openstack_compute_service_set_with_identity_api_v2: openstack compute service set ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 compute service set [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--enable | --disable] Set service command Positional arguments -------------------- ```` Name of host ```` Name of service Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--enable`` Enable a service ``--disable`` Disable a service .. _openstack_configuration_show_with_identity_api_v2: openstack configuration show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 configuration show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--mask | --unmask] Display configuration details Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--mask`` Attempt to mask passwords (default) ``--unmask`` Show password in clear text .. _openstack_congress_datasource_create_with_identity_api_v2: openstack congress datasource create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--description ] [--config ] Create a datasource. Positional arguments -------------------- ```` Selected datasource driver ```` Name you want to call the datasource Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--description `` Description of the datasource ``--config `` config dictionary to pass in .. _openstack_congress_datasource_delete_with_identity_api_v2: openstack congress datasource delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource delete [-h] Delete a datasource. Positional arguments -------------------- ```` Name of the datasource to delete Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_congress_datasource_list_with_identity_api_v2: openstack congress datasource list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List Datasources. Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_congress_datasource_row_list_with_identity_api_v2: openstack congress datasource row list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource row list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List datasource rows. Positional arguments -------------------- ```` Name of the datasource to show ``
`` Table to get the datasource rows from Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_congress_datasource_schema_show_with_identity_api_v2: openstack congress datasource schema show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource schema show [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] Show schema for datasource. Positional arguments -------------------- ```` Name of the datasource Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_congress_datasource_status_show_with_identity_api_v2: openstack congress datasource status show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource status show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] List status for datasource. Positional arguments -------------------- ```` Name of the datasource Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_congress_datasource_table_list_with_identity_api_v2: openstack congress datasource table list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource table list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List datasource tables. Positional arguments -------------------- ```` Name of the datasource Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_congress_datasource_table_schema_show_with_identity_api_v2: openstack congress datasource table schema show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource table schema show [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] Show schema for datasource table. Positional arguments -------------------- ```` Name of the datasource ```` Name of the table Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_congress_datasource_table_show_with_identity_api_v2: openstack congress datasource table show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 congress datasource table show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Show Datasource Table properties. Positional arguments -------------------- ```` Name of datasource ```` Table id Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_congress_driver_config_show_with_identity_api_v2: openstack congress driver config show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 congress driver config show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] List driver tables. Positional arguments -------------------- ```` Name of the datasource driver Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_congress_driver_list_with_identity_api_v2: openstack congress driver list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 congress driver list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List drivers. Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_congress_driver_schema_show_with_identity_api_v2: openstack congress driver schema show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 congress driver schema show [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List datasource tables. Positional arguments -------------------- ```` Name of the datasource driver Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_congress_policy_create_with_identity_api_v2: openstack congress policy create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--description ] [--abbreviation ] [--kind ] Create a policy. Positional arguments -------------------- ```` Name of the policy Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--description `` Policy description ``--abbreviation `` Policy abbreviation (used in traces) ``--kind `` Kind of policy: {nonrecursive, database, action, materialized} .. _openstack_congress_policy_delete_with_identity_api_v2: openstack congress policy delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy delete [-h] Delete a policy. Positional arguments -------------------- ```` ID or name of the policy to delete Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_congress_policy_list_with_identity_api_v2: openstack congress policy list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List Policy. Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_congress_policy_row_list_with_identity_api_v2: openstack congress policy row list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy row list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--trace]
List policy rows. Positional arguments -------------------- ```` Name of the policy to show ``
`` Table to get the policy rows from Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--trace`` Display explanation of result .. _openstack_congress_policy_rule_create_with_identity_api_v2: openstack congress policy rule create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy rule create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--name RULE_NAME] [--comment COMMENT] Create a policy rule. Positional arguments -------------------- ```` Name or identifier of the policy ```` Policy rule Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--name RULE_NAME`` Name of the policy rule ``--comment COMMENT`` Comment about policy rule .. _openstack_congress_policy_rule_delete_with_identity_api_v2: openstack congress policy rule delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy rule delete [-h] Delete a policy rule. Positional arguments -------------------- ```` Name of the policy to delete ```` ID/Name of the policy rule to delete Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_congress_policy_rule_list_with_identity_api_v2: openstack congress policy rule list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy rule list [-h] List policy rules. Positional arguments -------------------- ```` Name of the policy Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_congress_policy_rule_show_with_identity_api_v2: openstack congress policy rule show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy rule show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Show a policy rule. Positional arguments -------------------- ```` Name or identifier of the policy ```` Policy rule id or rule name Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_congress_policy_show_with_identity_api_v2: openstack congress policy show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Show policy properties. Positional arguments -------------------- ```` Name of policy Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_congress_policy_simulate_with_identity_api_v2: openstack congress policy simulate ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy simulate [-h] [--delta] [--trace] Show the result of simulation. Positional arguments -------------------- ```` Name of the policy ```` String representing query (policy rule or literal) ```` String representing sequence of updates/actions ```` Name of the policy with actions Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--delta`` Return difference in query caused by update sequence ``--trace`` Include trace describing computation .. _openstack_congress_policy_table_list_with_identity_api_v2: openstack congress policy table list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy table list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List policy tables. Positional arguments -------------------- ```` Name of the policy Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_congress_policy_table_show_with_identity_api_v2: openstack congress policy table show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 congress policy table show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Show policy table properties. Positional arguments -------------------- ```` Name of policy ```` Table id Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_console_log_show_with_identity_api_v2: openstack console log show ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 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_with_identity_api_v2: openstack console url show ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 console url show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--novnc | --xvpvnc | --spice] 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 xpvnc console URL ``--spice`` Show SPICE console URL .. _openstack_container_create_with_identity_api_v2: openstack container create ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 container create [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v2: openstack container delete ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 container delete [-h] [ ...] Delete container Positional arguments -------------------- ```` Container(s) to delete Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_container_list_with_identity_api_v2: openstack container list ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 container list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v2: openstack container save ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 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_with_identity_api_v2: openstack container set ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 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_with_identity_api_v2: openstack container show ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 container show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Display container details Positional arguments -------------------- ```` Container to display Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_container_unset_with_identity_api_v2: openstack container unset ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 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_dataprocessing_data_source_create_with_identity_api_v2: openstack dataprocessing data source create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 dataprocessing data source create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] --type --url [--username ] [--password ] [--description ] 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 or maprfs) [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 .. _openstack_dataprocessing_data_source_delete_with_identity_api_v2: openstack dataprocessing data source delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 dataprocessing data source delete [-h] Delete data source Positional arguments -------------------- ```` Name or id of the data source to delete Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_dataprocessing_data_source_list_with_identity_api_v2: openstack dataprocessing data source list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 dataprocessing data source list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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 or maprfs) .. _openstack_dataprocessing_data_source_show_with_identity_api_v2: openstack dataprocessing data source show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 dataprocessing data source show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_plugin_configs_get_with_identity_api_v2: openstack dataprocessing plugin configs get ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 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_with_identity_api_v2: openstack dataprocessing plugin list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 dataprocessing plugin list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v2: openstack dataprocessing plugin show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 dataprocessing plugin show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Display plugin details Positional arguments -------------------- ```` Name of the plugin to display Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_ec2_credentials_create_with_identity_api_v2: openstack ec2 credentials create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 ec2 credentials create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--project ] [--user ] 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) .. _openstack_ec2_credentials_delete_with_identity_api_v2: openstack ec2 credentials delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 ec2 credentials delete [-h] [--user ] Delete EC2 credentials Positional arguments -------------------- ```` Credentials access key Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--user `` Delete credentials for user (name or ID) .. _openstack_ec2_credentials_list_with_identity_api_v2: openstack ec2 credentials list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 ec2 credentials list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--user ] List EC2 credentials Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--user `` Filter list by user (name or ID) .. _openstack_ec2_credentials_show_with_identity_api_v2: openstack ec2 credentials show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 ec2 credentials show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--user ] 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) .. _openstack_endpoint_create_with_identity_api_v2: openstack endpoint create ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 endpoint create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] --publicurl [--adminurl ] [--internalurl ] [--region ] Create new endpoint Positional arguments -------------------- ```` New endpoint service (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--publicurl `` New endpoint public URL (required) ``--adminurl `` New endpoint admin URL ``--internalurl `` New endpoint internal URL ``--region `` New endpoint region ID .. _openstack_endpoint_delete_with_identity_api_v2: openstack endpoint delete ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 endpoint delete [-h] Delete endpoint Positional arguments -------------------- ```` Endpoint ID to delete Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_endpoint_list_with_identity_api_v2: openstack endpoint list ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 endpoint list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long] List endpoints Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--long`` List additional fields in output .. _openstack_endpoint_show_with_identity_api_v2: openstack endpoint show ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 endpoint show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Display endpoint details Positional arguments -------------------- ```` Endpoint ID to display Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_extension_list_with_identity_api_v2: openstack extension list ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 extension list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--compute] [--identity] [--network] [--volume] [--long] List API extensions Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--compute`` List extensions for the Compute API ``--identity`` List extensions for the Identity API ``--network`` List extensions for the Network API ``--volume`` List extensions for the Volume API ``--long`` List additional fields in output .. _openstack_flavor_create_with_identity_api_v2: openstack flavor create ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 flavor create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--id ] [--ram ] [--disk ] [--ephemeral ] [--swap ] [--vcpus ] [--rxtx-factor ] [--public | --private] 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) ``--public`` Flavor is available to other projects (default) ``--private`` Flavor is not available to other projects .. _openstack_flavor_delete_with_identity_api_v2: openstack flavor delete ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 flavor delete [-h] Delete flavor Positional arguments -------------------- ```` Flavor to delete (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_flavor_list_with_identity_api_v2: openstack flavor list ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 flavor list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v2: openstack flavor set ~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 flavor set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--property ] 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) .. _openstack_flavor_show_with_identity_api_v2: openstack flavor show ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 flavor show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v2: openstack flavor unset ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 flavor unset [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] --property 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) .. _openstack_host_list_with_identity_api_v2: openstack host list ~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 host list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--zone ] List host command Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--zone `` Only return hosts in the availability zone. .. _openstack_host_show_with_identity_api_v2: openstack host show ~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 host show [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] Show host command Positional arguments -------------------- ```` Name of host Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_hypervisor_list_with_identity_api_v2: openstack hypervisor list ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 hypervisor list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v2: openstack hypervisor show ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 hypervisor show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v2: openstack hypervisor stats show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 hypervisor stats show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Display hypervisor stats details Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_image_add_project_with_identity_api_v2: openstack image add project ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 image add project [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v2: openstack image create ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 image create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--id ] [--container-format ] [--disk-format ] [--owner ] [--min-disk ] [--min-ram ] [--file ] [--protected | --unprotected] [--public | --private] [--property ] [--tag ] 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) ``--owner `` Image owner project name or ID ``--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 ``--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) .. _openstack_image_delete_with_identity_api_v2: openstack image delete ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 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_with_identity_api_v2: openstack image list ~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 image list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--public | --private | --shared] [--property ] [--long] [--sort [:]] 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 .. _openstack_image_remove_project_with_identity_api_v2: openstack image remove project ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 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_with_identity_api_v2: openstack image save ~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 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_with_identity_api_v2: openstack image set ~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 image set [-h] [--name ] [--owner ] [--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 ] 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 ``--owner `` New image owner project (name or ID) ``--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 .. _openstack_image_show_with_identity_api_v2: openstack image show ~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 image show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_ip_fixed_add_with_identity_api_v2: openstack ip fixed add ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 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_with_identity_api_v2: openstack ip fixed remove ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 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_with_identity_api_v2: openstack ip floating add ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 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_with_identity_api_v2: openstack ip floating create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 ip floating create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Create new floating IP address Positional arguments -------------------- ```` Pool to fetch IP address from (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_ip_floating_delete_with_identity_api_v2: openstack ip floating delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 ip floating delete [-h] Delete a floating IP address Positional arguments -------------------- ```` IP address to delete (ID only) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_ip_floating_list_with_identity_api_v2: openstack ip floating list ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 ip floating list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List floating IP addresses Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_ip_floating_pool_list_with_identity_api_v2: openstack ip floating pool list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 ip floating pool list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v2: openstack ip floating remove ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 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_keypair_create_with_identity_api_v2: openstack keypair create ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 keypair create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v2: openstack keypair delete ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 keypair delete [-h] Delete public key Positional arguments -------------------- ```` Public key to delete Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_keypair_list_with_identity_api_v2: openstack keypair list ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 keypair list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List public key fingerprints Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_keypair_show_with_identity_api_v2: openstack keypair show ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 keypair show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--public-key] Display public key details Positional arguments -------------------- ```` Public key to display Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--public-key`` Show only bare public key .. _openstack_limits_show_with_identity_api_v2: openstack limits show ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 limits show [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] (--absolute | --rate) [--reserved] [--project ] [--domain ] Show compute and volume limits Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--absolute`` Show absolute limits ``--rate`` Show rate limits ``--reserved`` Include reservations count [only valid with :option:`--absolute]` ``--project `` Show limits for a specific project (name or ID) [only valid with :option:`--absolute]` ``--domain `` Domain that owns :option:`--project` (name or ID) [only valid with :option:`--absolute]` .. _openstack_management_plan_add_role_with_identity_api_v2: openstack management plan add role ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 management plan add role [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Add a Role to a Management Plan. Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_management_plan_create_with_identity_api_v2: openstack management plan create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 management plan create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [-d DESCRIPTION] name Create a Management Plan. Positional arguments -------------------- ``name`` Name of the plan being created. Optional arguments ------------------ ``-h, --help`` show this help message and exit ``-d DESCRIPTION, --description DESCRIPTION`` A textual description of the plan. .. _openstack_management_plan_delete_with_identity_api_v2: openstack management plan delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 management plan delete [-h] plan_uuid Delete a Management Plan. Positional arguments -------------------- ``plan_uuid`` The UUID of the plan being deleted. Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_management_plan_download_with_identity_api_v2: openstack management plan download ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 management plan download [-h] Download the a Management Plan. Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_management_plan_list_with_identity_api_v2: openstack management plan list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 management plan list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List the Management Plans. Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_management_plan_remove_role_with_identity_api_v2: openstack management plan remove role ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 management plan remove role [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Remove a Role from a Management Plan. Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_management_plan_set_with_identity_api_v2: openstack management plan set ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 management plan set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [-P ] [-F ] [-S ] plan_uuid Update a Management Plans properties. Positional arguments -------------------- ``plan_uuid`` The UUID of the plan being updated. Optional arguments ------------------ ``-h, --help`` show this help message and exit ``-P , --parameter `` Set a parameter in the Plan. This can be specified multiple times. ``-F , --flavor `` Set the flavor for a role in the Plan. This can be specified multiple times. ``-S , --scale `` Set the Scale count for a role in the Plan. This can be specified multiple times. .. _openstack_management_plan_show_with_identity_api_v2: openstack management plan show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 management plan show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Show a Management Plan. Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_management_role_list_with_identity_api_v2: openstack management role list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 management role list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List Roles. Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_message-broker_with_identity_api_v2: openstack message-broker ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console Command "message-broker" matches: message-broker cluster create message-broker cluster delete message-broker cluster list message-broker cluster set message-broker cluster show .. _openstack_message-broker_cluster_with_identity_api_v2: openstack message-broker cluster ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console Command "message-broker cluster" matches: message-broker cluster create message-broker cluster delete message-broker cluster list message-broker cluster set message-broker cluster show .. _openstack_message-broker_cluster_create_with_identity_api_v2: openstack message-broker cluster create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 message-broker cluster create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] --name NAME --nic NIC --flavor FLAVOR --size SIZE [--volume_size VOLUME_SIZE] [--auth ] Create Cluster Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--name NAME`` Cluster Name ``--nic NIC`` Network to place nodes on ``--flavor FLAVOR`` Flavor to use. ``--size SIZE`` Number of nodes ``--volume_size VOLUME_SIZE`` Volume size ``--auth `` broker authentication,type=type,user=user,pass=pass .. _openstack_message-broker_cluster_delete_with_identity_api_v2: openstack message-broker cluster delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 message-broker cluster delete [-h] id Delete Cluster Positional arguments -------------------- ``id`` Cluster ID Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_message-broker_cluster_list_with_identity_api_v2: openstack message-broker cluster list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 message-broker cluster list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List Clusters Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_message-broker_cluster_set_with_identity_api_v2: openstack message-broker cluster set ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 message-broker cluster set [-h] [--name NAME] [--email EMAIL] [--ttl TTL] [--description DESCRIPTION | --no-description] [--masters MASTERS [MASTERS ...]] id Set Cluster Positional arguments -------------------- ``id`` Cluster ID Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--name NAME`` Cluster Name ``--email EMAIL`` Cluster Email ``--ttl TTL`` Time To Live (Seconds) ``--description DESCRIPTION`` Description ``--no-description`` ``--masters MASTERS [MASTERS ...]`` Cluster Masters .. _openstack_message-broker_cluster_show_with_identity_api_v2: openstack message-broker cluster show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 message-broker cluster show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] id Show Cluster Positional arguments -------------------- ``id`` Cluster ID Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_messaging_flavor_delete_with_identity_api_v2: openstack messaging flavor delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 messaging flavor delete [-h] Delete a flavor. Positional arguments -------------------- ```` Name of the flavor Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_module_list_with_identity_api_v2: openstack module list ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 module list [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--all] List module versions Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--all`` Show all modules that have version information .. _openstack_network_create_with_identity_api_v2: openstack network create ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 network create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--enable | --disable] [--share | --no-share] [--project ] [--project-domain ] Create new network Positional arguments -------------------- ```` New network name Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--enable`` Enable network (default) ``--disable`` Disable network ``--share`` Share the network between projects ``--no-share`` Do not share the network between projects ``--project `` 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. .. _openstack_network_delete_with_identity_api_v2: openstack network delete ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 network delete [-h] [ ...] Delete network(s) Positional arguments -------------------- ```` Network to delete (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_network_list_with_identity_api_v2: openstack network list ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 network list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--external] [--long] List networks Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--external`` List external networks ``--long`` List additional fields in output .. _openstack_network_set_with_identity_api_v2: openstack network set ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 network set [-h] [--name ] [--enable | --disable] [--share | --no-share] 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 .. _openstack_network_show_with_identity_api_v2: openstack network show ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 network show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v2: openstack object create ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 object create [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v2: openstack object delete ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 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_with_identity_api_v2: openstack object list ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 object list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v2: openstack object save ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 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_with_identity_api_v2: openstack object set ~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 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_with_identity_api_v2: openstack object show ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 object show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v2: openstack object store account set ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 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_with_identity_api_v2: openstack object store account show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 object store account show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Display account details Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_object_store_account_unset_with_identity_api_v2: openstack object store account unset ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 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_with_identity_api_v2: openstack object unset ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 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_pool_create_with_identity_api_v2: openstack pool create ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 pool create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Create a pool. Positional arguments -------------------- ```` Name of the pool ```` Storage engine URI ```` weight of the pool ```` Group of the pool Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_project_create_with_identity_api_v2: openstack project create ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 project create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--description ] [--enable | --disable] [--property ] [--or-show] Create new project Positional arguments -------------------- ```` New project name Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--description `` Project description ``--enable`` Enable project (default) ``--disable`` Disable project ``--property `` Add a property to (repeat option to set multiple properties) ``--or-show`` Return existing project .. _openstack_project_delete_with_identity_api_v2: openstack project delete ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 project delete [-h] [ ...] Delete project(s) Positional arguments -------------------- ```` Project(s) to delete (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_project_list_with_identity_api_v2: openstack project list ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 project list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long] List projects Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--long`` List additional fields in output .. _openstack_project_set_with_identity_api_v2: openstack project set ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 project set [-h] [--name ] [--description ] [--enable | --disable] [--property ] Set project properties Positional arguments -------------------- ```` Project to modify (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--name `` Set project name ``--description `` Set project description ``--enable`` Enable project ``--disable`` Disable project ``--property `` Set a project property (repeat option to set multiple properties) .. _openstack_project_show_with_identity_api_v2: openstack project show ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 project show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Display project details Positional arguments -------------------- ```` Project to display (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_ptr_record_list_with_identity_api_v2: openstack ptr record list ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 ptr record list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List floatingip ptr records Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_ptr_record_set_with_identity_api_v2: openstack ptr record set ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 ptr record set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--description DESCRIPTION | --no-description] [--ttl TTL | --no-ttl] floatingip_id ptrdname Set floatingip ptr record Positional arguments -------------------- ``floatingip_id`` Floating IP ID ``ptrdname`` PTRD Name Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--description DESCRIPTION`` Description ``--no-description`` ``--ttl TTL`` TTL ``--no-ttl`` .. _openstack_ptr_record_show_with_identity_api_v2: openstack ptr record show ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 ptr record show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] floatingip_id Show floatingip ptr record details Positional arguments -------------------- ``floatingip_id`` Floating IP ID Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_ptr_record_unset_with_identity_api_v2: openstack ptr record unset ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 ptr record unset [-h] floatingip_id Unset floatingip ptr record Positional arguments -------------------- ``floatingip_id`` Floating IP ID Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_queue_create_with_identity_api_v2: openstack queue create ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 queue create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Create a queue. Positional arguments -------------------- ```` Name of the queue Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_queue_delete_with_identity_api_v2: openstack queue delete ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 queue delete [-h] Delete a queue. Positional arguments -------------------- ```` Name of the queue Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_queue_exists_with_identity_api_v2: openstack queue exists ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 queue exists [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Check queue existence. Positional arguments -------------------- ```` Name of the queue Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_queue_get_metadata_with_identity_api_v2: openstack queue get metadata ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 queue get metadata [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Get queue metadata. Positional arguments -------------------- ```` Name of the queue Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_queue_list_with_identity_api_v2: openstack queue list ~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 queue list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--marker ] [--limit ] List available queues. Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--marker `` Queue's paging marker ``--limit `` Page size limit .. _openstack_queue_set_metadata_with_identity_api_v2: openstack queue set metadata ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 queue set metadata [-h] Set queue metadata. Positional arguments -------------------- ```` Name of the queue ```` Queue metadata Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_queue_stats_with_identity_api_v2: openstack queue stats ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 queue stats [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Get queue stats. Positional arguments -------------------- ```` Name of the queue Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_quota_set_with_identity_api_v2: openstack quota set ~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 quota set [-h] [--class] [--properties ] [--ram ] [--secgroup-rules ] [--instances ] [--key-pairs ] [--fixed-ips ] [--secgroups ] [--injected-file-size ] [--floating-ips ] [--injected-files ] [--cores ] [--injected-path-size ] [--gigabytes ] [--volumes ] [--snapshots ] [--volume-type ] Set quotas for project or class Positional arguments -------------------- ```` Set quotas for this project or class (name/ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--class`` Set quotas for ``--properties `` New value for the properties quota ``--ram `` New value for the ram quota ``--secgroup-rules `` New value for the secgroup-rules quota ``--instances `` New value for the instances quota ``--key-pairs `` New value for the key-pairs quota ``--fixed-ips `` New value for the fixed-ips quota ``--secgroups `` New value for the secgroups quota ``--injected-file-size `` New value for the injected-file-size quota ``--floating-ips `` New value for the floating-ips quota ``--injected-files `` New value for the injected-files quota ``--cores `` New value for the cores quota ``--injected-path-size `` New value for the injected-path-size quota ``--gigabytes `` New value for the gigabytes quota ``--volumes `` New value for the volumes quota ``--snapshots `` New value for the snapshots quota ``--volume-type `` Set quotas for a specific .. _openstack_quota_show_with_identity_api_v2: openstack quota show ~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 quota show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--class | --default] Show quotas for project or class Positional arguments -------------------- ```` Show this project or class (name/ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--class`` Show quotas for ``--default`` Show default quotas for .. _openstack_recordset_create_with_identity_api_v2: openstack recordset create ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 recordset create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] --records RECORDS [RECORDS ...] --type TYPE [--ttl TTL] [--description DESCRIPTION] zone_id name Create new recordset Positional arguments -------------------- ``zone_id`` Zone ID ``name`` RecordSet Name Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--records RECORDS [RECORDS ...]`` RecordSet Records ``--type TYPE`` RecordSet Type ``--ttl TTL`` Time To Live (Seconds) ``--description DESCRIPTION`` Description .. _openstack_recordset_delete_with_identity_api_v2: openstack recordset delete ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 recordset delete [-h] zone_id id Delete recordset Positional arguments -------------------- ``zone_id`` Zone ID ``id`` RecordSet ID Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_recordset_list_with_identity_api_v2: openstack recordset list ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 recordset list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] zone_id List recordsets Positional arguments -------------------- ``zone_id`` Zone ID Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_recordset_set_with_identity_api_v2: openstack recordset set ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 recordset set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--name NAME] [--records RECORDS [RECORDS ...]] [--description DESCRIPTION | --no-description] [--ttl TTL | --no-ttl] zone_id id Set recordset properties Positional arguments -------------------- ``zone_id`` Zone ID ``id`` RecordSet ID Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--name NAME`` RecordSet Name ``--records RECORDS [RECORDS ...]`` Records ``--description DESCRIPTION`` Description ``--no-description`` ``--ttl TTL`` TTL ``--no-ttl`` .. _openstack_recordset_show_with_identity_api_v2: openstack recordset show ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 recordset show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] zone_id id Show recordset details Positional arguments -------------------- ``zone_id`` Zone ID ``id`` RecordSet ID Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_role_add_with_identity_api_v2: openstack role add ~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 role add [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] --project --user Add role to project:user Positional arguments -------------------- ```` Role to add to : (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--project `` Include (name or ID) ``--user `` Include (name or ID) .. _openstack_role_create_with_identity_api_v2: openstack role create ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 role create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--or-show] Create new role Positional arguments -------------------- ```` New role name Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--or-show`` Return existing role .. _openstack_role_delete_with_identity_api_v2: openstack role delete ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 role delete [-h] [ ...] Delete role(s) Positional arguments -------------------- ```` Role(s) to delete (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_role_list_with_identity_api_v2: openstack role list ~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 role list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--project ] [--user ] List roles Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--project `` Filter roles by (name or ID) ``--user `` Filter roles by (name or ID) .. _openstack_role_remove_with_identity_api_v2: openstack role remove ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 role remove [-h] --project --user Remove role from project : user Positional arguments -------------------- ```` Role to remove (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--project `` Include (name or ID) ``--user `` Include (name or ID) .. _openstack_role_show_with_identity_api_v2: openstack role show ~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 role show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Display role details Positional arguments -------------------- ```` Role to display (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_security_group_create_with_identity_api_v2: openstack security group create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 security group create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--description ] Create a new security group Positional arguments -------------------- ```` New security group name Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--description `` Security group description .. _openstack_security_group_delete_with_identity_api_v2: openstack security group delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 security group delete [-h] Delete a security group Positional arguments -------------------- ```` Security group to delete (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_security_group_list_with_identity_api_v2: openstack security group list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 security group list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--all-projects] List security groups Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--all-projects`` Display information from all projects (admin only) .. _openstack_security_group_rule_create_with_identity_api_v2: openstack security group rule create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 security group rule create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--proto ] [--src-ip ] [--dst-port ] Create a new security group rule Positional arguments -------------------- ```` Create rule in this security group (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--proto `` IP protocol (icmp, tcp, udp; default: tcp) ``--src-ip `` Source IP (may use CIDR notation; default: 0.0.0.0/0) ``--dst-port `` Destination port, may be a range: 137:139 (default: 0; only required for proto tcp and udp) .. _openstack_security_group_rule_delete_with_identity_api_v2: openstack security group rule delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 security group rule delete [-h] Delete a security group rule Positional arguments -------------------- ```` Security group rule to delete (ID only) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_security_group_rule_list_with_identity_api_v2: openstack security group rule list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 security group rule list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List security group rules Positional arguments -------------------- ```` List all rules in this security group (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_security_group_set_with_identity_api_v2: openstack security group set ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 security group set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--name ] [--description ] Set security group properties Positional arguments -------------------- ```` Security group to modify (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--name `` New security group name ``--description `` New security group description .. _openstack_security_group_show_with_identity_api_v2: openstack security group show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 security group show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Display security group details Positional arguments -------------------- ```` Security group to display (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_server_add_security_group_with_identity_api_v2: openstack server add security group ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server add security group [-h] Add security group to server Positional arguments -------------------- ```` Server (name or ID) ```` Security group to add (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_server_add_volume_with_identity_api_v2: openstack server add volume ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server add volume [-h] [--device ] Add volume to server Positional arguments -------------------- ```` Server (name or ID) ```` Volume to add (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--device `` Server internal device name for volume .. _openstack_server_create_with_identity_api_v2: openstack server create ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] (--image | --volume ) --flavor [--security-group ] [--key-name ] [--property ] [--file ] [--user-data ] [--availability-zone ] [--block-device-mapping ] [--nic ] [--hint ] [--config-drive |True] [--min ] [--max ] [--wait] Create a new server Positional arguments -------------------- ```` New server name Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--image `` Create server from this image ``--volume `` Create server from this volume ``--flavor `` Create server with this flavor ``--security-group `` Security group to assign to this server (repeat for multiple groups) ``--key-name `` Keypair to inject into this server (optional extension) ``--property `` Set a property on this server (repeat for multiple values) ``--file `` File to inject into image before boot (repeat for multiple files) ``--user-data `` User data file to serve from the metadata server ``--availability-zone `` Select an availability zone for the server ``--block-device-mapping `` Map block devices; map is ::: (optional extension) ``--nic `` Create a NIC on the server. Specify option multiple times to create multiple NICs. Either net-id or port- id must be provided, but not both. net-id: attach NIC to network with this UUID, port-id: attach NIC to port with this UUID, v4-fixed-ip: IPv4 fixed address for NIC (optional), v6-fixed-ip: IPv6 fixed address for NIC (optional). ``--hint `` Hints for the scheduler (optional extension) ``--config-drive |True`` Use specified volume as the config drive, or 'True' to use an ephemeral drive ``--min `` Minimum number of servers to launch (default=1) ``--max `` Maximum number of servers to launch (default=1) ``--wait`` Wait for build to complete .. _openstack_server_delete_with_identity_api_v2: openstack server delete ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server delete [-h] [--wait] [ ...] Delete server(s) Positional arguments -------------------- ```` Server(s) to delete (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--wait`` Wait for delete to complete .. _openstack_server_image_create_with_identity_api_v2: openstack server image create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server image create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--name ] [--wait] Create a new disk image from a running server Positional arguments -------------------- ```` Server (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--name `` Name of new image (default is server name) ``--wait`` Wait for image create to complete .. _openstack_server_list_with_identity_api_v2: openstack server list ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--reservation-id ] [--ip ] [--ip6 ] [--name ] [--instance-name ] [--status ] [--flavor ] [--image ] [--host ] [--all-projects] [--project ] [--project-domain ] [--user ] [--user-domain ] [--long] [--marker ] [--limit ] List servers Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--reservation-id `` Only return instances that match the reservation ``--ip `` Regular expression to match IP addresses ``--ip6 `` Regular expression to match IPv6 addresses ``--name `` Regular expression to match names ``--instance-name `` Regular expression to match instance name (admin only) ``--status `` Search by server status ``--flavor `` Search by flavor ``--image `` Search by image ``--host `` Search by hostname ``--all-projects`` Include all projects (admin only) ``--project `` Search by project (admin only) (name or ID) ``--project-domain `` Domain the project belongs to (name or ID). This can be used in case collisions between project names exist. ``--user `` Search by user (admin only) (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 ``--marker `` The last server (name or ID) of the previous page. Display list of servers after marker. Display all servers if not specified. ``--limit `` Maximum number of servers to display. If limit equals -1, all servers will be displayed. If limit is greater than 'osapi_max_limit' option of Nova API, 'osapi_max_limit' will be used instead. .. _openstack_server_lock_with_identity_api_v2: openstack server lock ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server lock [-h] [ ...] Lock server(s). A non-admin user will not be able to execute actions Positional arguments -------------------- ```` Server(s) to lock (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_server_migrate_with_identity_api_v2: openstack server migrate ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server migrate [-h] [--live ] [--shared-migration | --block-migration] [--disk-overcommit | --no-disk-overcommit] [--wait] Migrate server to different host Positional arguments -------------------- ```` Server (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--live `` Target hostname ``--shared-migration`` Perform a shared live migration (default) ``--block-migration`` Perform a block live migration ``--disk-overcommit`` Allow disk over-commit on the destination host ``--no-disk-overcommit`` Do not over-commit disk on the destination host (default) ``--wait`` Wait for resize to complete .. _openstack_server_pause_with_identity_api_v2: openstack server pause ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server pause [-h] [ ...] Pause server(s) Positional arguments -------------------- ```` Server(s) to pause (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_server_reboot_with_identity_api_v2: openstack server reboot ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server reboot [-h] [--hard | --soft] [--wait] Perform a hard or soft server reboot Positional arguments -------------------- ```` Server (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--hard`` Perform a hard reboot ``--soft`` Perform a soft reboot ``--wait`` Wait for reboot to complete .. _openstack_server_rebuild_with_identity_api_v2: openstack server rebuild ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server rebuild [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] --image [--password ] [--wait] Rebuild server Positional arguments -------------------- ```` Server (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--image `` Recreate server from this image ``--password `` Set the password on the rebuilt instance ``--wait`` Wait for rebuild to complete .. _openstack_server_remove_security_group_with_identity_api_v2: openstack server remove security group ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server remove security group [-h] Remove security group from server Positional arguments -------------------- ```` Name or ID of server to use ```` Name or ID of security group to remove from server Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_server_remove_volume_with_identity_api_v2: openstack server remove volume ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server remove volume [-h] Remove volume from server Positional arguments -------------------- ```` Server (name or ID) ```` Volume to remove (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_server_rescue_with_identity_api_v2: openstack server rescue ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server rescue [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Put server in rescue mode Positional arguments -------------------- ```` Server (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_server_resize_with_identity_api_v2: openstack server resize ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server resize [-h] [--flavor | --confirm | --revert] [--wait] Scale server to a new flavor Positional arguments -------------------- ```` Server (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--flavor `` Resize server to specified flavor ``--confirm`` Confirm server resize is complete ``--revert`` Restore server state before resize ``--wait`` Wait for resize to complete .. _openstack_server_resume_with_identity_api_v2: openstack server resume ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server resume [-h] [ ...] Resume server(s) Positional arguments -------------------- ```` Server(s) to resume (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_server_set_with_identity_api_v2: openstack server set ~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server set [-h] [--name ] [--root-password] [--property ] Set server properties Positional arguments -------------------- ```` Server (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--name `` New server name ``--root-password`` Set new root password (interactive only) ``--property `` Property to add/change for this server (repeat option to set multiple properties) .. _openstack_server_shelve_with_identity_api_v2: openstack server shelve ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server shelve [-h] [ ...] Shelve server(s) Positional arguments -------------------- ```` Server(s) to shelve (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_server_show_with_identity_api_v2: openstack server show ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--diagnostics] Show server details Positional arguments -------------------- ```` Server (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--diagnostics`` Display server diagnostics information .. _openstack_server_ssh_with_identity_api_v2: openstack server ssh ~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server ssh [-h] [--login ] [--port ] [--identity ] [--option ] [-4 | -6] [--public | --private | --address-type ] Ssh to server Positional arguments -------------------- ```` Server (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--login `` Login name (ssh -l option) ``--port `` Destination port (ssh -p option) ``--identity `` Private key file (ssh -i option) ``--option `` Options in ssh_config(5) format (ssh -o option) ``-4`` Use only IPv4 addresses ``-6`` Use only IPv6 addresses ``--public`` Use public IP address ``--private`` Use private IP address ``--address-type `` Use other IP address (public, private, etc) .. _openstack_server_start_with_identity_api_v2: openstack server start ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server start [-h] [ ...] Start server(s). Positional arguments -------------------- ```` Server(s) to start (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_server_stop_with_identity_api_v2: openstack server stop ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server stop [-h] [ ...] Stop server(s). Positional arguments -------------------- ```` Server(s) to stop (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_server_suspend_with_identity_api_v2: openstack server suspend ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server suspend [-h] [ ...] Suspend server(s) Positional arguments -------------------- ```` Server(s) to suspend (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_server_unlock_with_identity_api_v2: openstack server unlock ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server unlock [-h] [ ...] Unlock server(s) Positional arguments -------------------- ```` Server(s) to unlock (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_server_unpause_with_identity_api_v2: openstack server unpause ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server unpause [-h] [ ...] Unpause server(s) Positional arguments -------------------- ```` Server(s) to unpause (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_server_unrescue_with_identity_api_v2: openstack server unrescue ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server unrescue [-h] Restore server from rescue mode Positional arguments -------------------- ```` Server (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_server_unset_with_identity_api_v2: openstack server unset ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server unset [-h] [--property ] Unset server properties Positional arguments -------------------- ```` Server (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--property `` Property key to remove from server (repeat to unset multiple values) .. _openstack_server_unshelve_with_identity_api_v2: openstack server unshelve ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 server unshelve [-h] [ ...] Unshelve server(s) Positional arguments -------------------- ```` Server(s) to unshelve (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_service_create_with_identity_api_v2: openstack service create ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 service create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--name ] [--description ] Create new service Positional arguments -------------------- ```` New service type (compute, image, identity, volume, etc) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--name `` New service name ``--description `` New service description .. _openstack_service_delete_with_identity_api_v2: openstack service delete ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 service delete [-h] Delete service Positional arguments -------------------- ```` Service to delete (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_service_list_with_identity_api_v2: openstack service list ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 service list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long] List services Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--long`` List additional fields in output .. _openstack_service_show_with_identity_api_v2: openstack service show ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 service show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--catalog] Display service details Positional arguments -------------------- ```` Service to display (type, name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--catalog`` Show service catalog information .. _openstack_snapshot_create_with_identity_api_v2: openstack snapshot create ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 snapshot create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] --name [--description ] [--force] Create new snapshot Positional arguments -------------------- ```` Volume to snapshot (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--name `` Name of the snapshot ``--description `` Description of the snapshot ``--force`` Create a snapshot attached to an instance. Default is False .. _openstack_snapshot_delete_with_identity_api_v2: openstack snapshot delete ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 snapshot delete [-h] [ ...] Delete snapshot(s) Positional arguments -------------------- ```` Snapshot(s) to delete (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_snapshot_list_with_identity_api_v2: openstack snapshot list ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 snapshot list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--all-projects] [--long] List snapshots Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--all-projects`` Include all projects (admin only) ``--long`` List additional fields in output .. _openstack_snapshot_set_with_identity_api_v2: openstack snapshot set ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 snapshot set [-h] [--name ] [--description ] [--property ] Set snapshot properties Positional arguments -------------------- ```` Snapshot to modify (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--name `` New snapshot name ``--description `` New snapshot description ``--property `` Property to add/change for this snapshot (repeat option to set multiple properties) .. _openstack_snapshot_show_with_identity_api_v2: openstack snapshot show ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 snapshot show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Display snapshot details Positional arguments -------------------- ```` Snapshot to display (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_snapshot_unset_with_identity_api_v2: openstack snapshot unset ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 snapshot unset [-h] --property Unset snapshot properties Positional arguments -------------------- ```` Snapshot to modify (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--property `` Property to remove from snapshot (repeat to remove multiple values) .. _openstack_tld_create_with_identity_api_v2: openstack tld create ~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 tld create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] --name NAME [--description DESCRIPTION] Create new tld Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--name NAME`` TLD Name ``--description DESCRIPTION`` Description .. _openstack_tld_delete_with_identity_api_v2: openstack tld delete ~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 tld delete [-h] id Delete tld Positional arguments -------------------- ``id`` TLD ID Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_tld_list_with_identity_api_v2: openstack tld list ~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 tld list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List tlds Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_tld_set_with_identity_api_v2: openstack tld set ~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 tld set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--name NAME] [--description DESCRIPTION | --no-description] id Set tld properties Positional arguments -------------------- ``id`` TLD ID Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--name NAME`` TLD Name ``--description DESCRIPTION`` Description ``--no-description`` .. _openstack_tld_show_with_identity_api_v2: openstack tld show ~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 tld show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] id Show tld details Positional arguments -------------------- ``id`` TLD ID Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_token_issue_with_identity_api_v2: openstack token issue ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 token issue [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Issue new token Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_token_revoke_with_identity_api_v2: openstack token revoke ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 token revoke [-h] Revoke existing token Positional arguments -------------------- ```` Token to be deleted Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_usage_list_with_identity_api_v2: openstack usage list ~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 usage list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--start ] [--end ] List resource usage per project Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--start `` Usage range start date, ex 2012-01-20 (default: 4 weeks ago) ``--end `` Usage range end date, ex 2012-01-20 (default: tomorrow) .. _openstack_usage_show_with_identity_api_v2: openstack usage show ~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 usage show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--project ] [--start ] [--end ] Show resource usage for a single project Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--project `` Name or ID of project to show usage for ``--start `` Usage range start date, ex 2012-01-20 (default: 4 weeks ago) ``--end `` Usage range end date, ex 2012-01-20 (default: tomorrow) .. _openstack_user_create_with_identity_api_v2: openstack user create ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 user create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--project ] [--password ] [--password-prompt] [--email ] [--enable | --disable] [--or-show] Create new user Positional arguments -------------------- ```` New user name Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--project `` Default project (name or ID) ``--password `` Set user password ``--password-prompt`` Prompt interactively for password ``--email `` Set user email address ``--enable`` Enable user (default) ``--disable`` Disable user ``--or-show`` Return existing user .. _openstack_user_delete_with_identity_api_v2: openstack user delete ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 user delete [-h] [ ...] Delete user(s) Positional arguments -------------------- ```` User(s) to delete (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_user_list_with_identity_api_v2: openstack user list ~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 user list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--project ] [--long] List users Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--project `` Filter users by project (name or ID) ``--long`` List additional fields in output .. _openstack_user_role_list_with_identity_api_v2: openstack user role list ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 user role list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--project ] [] List user-role assignments Positional arguments -------------------- ```` User to list (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--project `` Filter users by (name or ID) .. _openstack_user_set_with_identity_api_v2: openstack user set ~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 user set [-h] [--name ] [--project ] [--password ] [--password-prompt] [--email ] [--enable | --disable] Set user properties Positional arguments -------------------- ```` User to change (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--name `` Set user name ``--project `` Set default project (name or ID) ``--password `` Set user password ``--password-prompt`` Prompt interactively for password ``--email `` Set user email address ``--enable`` Enable user (default) ``--disable`` Disable user .. _openstack_user_show_with_identity_api_v2: openstack user show ~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 user show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Display user details Positional arguments -------------------- ```` User to display (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_volume_create_with_identity_api_v2: openstack volume create ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 volume create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] --size [--snapshot ] [--description ] [--type ] [--user ] [--project ] [--availability-zone ] [--image ] [--source ] [--property ] Create new volume Positional arguments -------------------- ```` New volume name Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--size `` New volume size in GB ``--snapshot `` Use as source of new volume ``--description `` New volume description ``--type `` Use as the new volume type ``--user `` Specify an alternate user (name or ID) ``--project `` Specify an alternate project (name or ID) ``--availability-zone `` Create new volume in ``--image `` Use as source of new volume (name or ID) ``--source `` Volume to clone (name or ID) ``--property `` Set a property on this volume (repeat option to set multiple properties) .. _openstack_volume_delete_with_identity_api_v2: openstack volume delete ~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 volume delete [-h] [--force] [ ...] Delete volume(s) Positional arguments -------------------- ```` Volume(s) to delete (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--force`` Attempt forced removal of volume(s), regardless of state (defaults to False) .. _openstack_volume_list_with_identity_api_v2: openstack volume list ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 volume list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--name ] [--status ] [--all-projects] [--long] List volumes Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--name `` Filter results by volume name ``--status `` Filter results by status ``--all-projects`` Include all projects (admin only) ``--long`` List additional fields in output .. _openstack_volume_qos_associate_with_identity_api_v2: openstack volume qos associate ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos associate [-h] Associate a QoS specification to a volume type Positional arguments -------------------- ```` QoS specification to modify (name or ID) ```` Volume type to associate the QoS (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_volume_qos_create_with_identity_api_v2: openstack volume qos create ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--consumer ] [--property ] Create new QoS specification Positional arguments -------------------- ```` New QoS specification name Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--consumer `` Consumer of the QoS. Valid consumers: back-end, both, front-end (defaults to 'both') ``--property `` Set a QoS specification property (repeat option to set multiple properties) .. _openstack_volume_qos_delete_with_identity_api_v2: openstack volume qos delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos delete [-h] [ ...] Delete QoS specification Positional arguments -------------------- ```` QoS specification(s) to delete (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_volume_qos_disassociate_with_identity_api_v2: openstack volume qos disassociate ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos disassociate [-h] [--volume-type | --all] Disassociate a QoS specification from a volume type Positional arguments -------------------- ```` QoS specification to modify (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--volume-type `` Volume type to disassociate the QoS from (name or ID) ``--all`` Disassociate the QoS from every volume type .. _openstack_volume_qos_list_with_identity_api_v2: openstack volume qos list ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List QoS specifications Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_volume_qos_set_with_identity_api_v2: openstack volume qos set ~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos set [-h] [--property ] Set QoS specification properties Positional arguments -------------------- ```` QoS specification to modify (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--property `` Property to add or modify for this QoS specification (repeat option to set multiple properties) .. _openstack_volume_qos_show_with_identity_api_v2: openstack volume qos show ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Display QoS specification details Positional arguments -------------------- ```` QoS specification to display (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_volume_qos_unset_with_identity_api_v2: openstack volume qos unset ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos unset [-h] [--property ] Unset QoS specification properties Positional arguments -------------------- ```` QoS specification to modify (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--property `` Property to remove from the QoS specification. (repeat option to unset multiple properties) .. _openstack_volume_set_with_identity_api_v2: openstack volume set ~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 volume set [-h] [--name ] [--description ] [--size ] [--property ] Set volume properties Positional arguments -------------------- ```` Volume to change (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--name `` New volume name ``--description `` New volume description ``--size `` Extend volume size in GB ``--property `` Property to add or modify for this volume (repeat option to set multiple properties) .. _openstack_volume_show_with_identity_api_v2: openstack volume show ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 volume show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Show volume details Positional arguments -------------------- ```` Volume to display (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_volume_type_create_with_identity_api_v2: openstack volume type create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 volume type create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--property ] Create new volume type Positional arguments -------------------- ```` New volume type name Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--property `` Property to add for this volume type (repeat option to set multiple properties) .. _openstack_volume_type_delete_with_identity_api_v2: openstack volume type delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 volume type delete [-h] Delete volume type Positional arguments -------------------- ```` Volume type to delete (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_volume_type_list_with_identity_api_v2: openstack volume type list ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 volume type list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long] List volume types Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--long`` List additional fields in output .. _openstack_volume_type_set_with_identity_api_v2: openstack volume type set ~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 volume type set [-h] [--property ] Set volume type properties Positional arguments -------------------- ```` Volume type to modify (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--property `` Property to add or modify for this volume type (repeat option to set multiple properties) .. _openstack_volume_type_show_with_identity_api_v2: openstack volume type show ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 volume type show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Display volume type details Positional arguments -------------------- ```` Volume type to display (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_volume_type_unset_with_identity_api_v2: openstack volume type unset ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 volume type unset [-h] --property Unset volume type properties Positional arguments -------------------- ```` Volume type to modify (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--property `` Property to remove from volume type (repeat option to remove multiple properties) .. _openstack_volume_unset_with_identity_api_v2: openstack volume unset ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 volume unset [-h] --property Unset volume properties Positional arguments -------------------- ```` Volume to modify (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--property `` Property to remove from volume (repeat option to remove multiple properties) .. _openstack_zone_abandon_with_identity_api_v2: openstack zone abandon ~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 zone abandon [-h] id Abandon a zone Positional arguments -------------------- ``id`` Zone ID Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_zone_axfr_with_identity_api_v2: openstack zone axfr ~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 zone axfr [-h] id AXFR a zone Positional arguments -------------------- ``id`` Zone ID Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_zone_blacklist_create_with_identity_api_v2: openstack zone blacklist create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 zone blacklist create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] --pattern PATTERN [--description DESCRIPTION] Create new blacklist Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--pattern PATTERN`` Blacklist pattern ``--description DESCRIPTION`` Description .. _openstack_zone_blacklist_delete_with_identity_api_v2: openstack zone blacklist delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 zone blacklist delete [-h] id Delete blacklist Positional arguments -------------------- ``id`` Blacklist ID Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_zone_blacklist_list_with_identity_api_v2: openstack zone blacklist list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 zone blacklist list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List blacklists Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_zone_blacklist_set_with_identity_api_v2: openstack zone blacklist set ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 zone blacklist set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] --pattern PATTERN [--description DESCRIPTION | --no-description] id Set blacklist properties Positional arguments -------------------- ``id`` Blacklist ID Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--pattern PATTERN`` Blacklist pattern ``--description DESCRIPTION`` Description ``--no-description`` .. _openstack_zone_blacklist_show_with_identity_api_v2: openstack zone blacklist show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 zone blacklist show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] id Show blacklist details Positional arguments -------------------- ``id`` Blacklist ID Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_zone_create_with_identity_api_v2: openstack zone create ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 zone create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--email EMAIL] [--type TYPE] [--ttl TTL] [--description DESCRIPTION] [--masters MASTERS [MASTERS ...]] name Create new zone Positional arguments -------------------- ``name`` Zone Name Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--email EMAIL`` Zone Email ``--type TYPE`` Zone Type ``--ttl TTL`` Time To Live (Seconds) ``--description DESCRIPTION`` Description ``--masters MASTERS [MASTERS ...]`` Zone Masters .. _openstack_zone_delete_with_identity_api_v2: openstack zone delete ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 zone delete [-h] id Delete zone Positional arguments -------------------- ``id`` Zone ID Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_zone_list_with_identity_api_v2: openstack zone list ~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 zone list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--type TYPE] List zones Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--type TYPE`` Zone Type .. _openstack_zone_set_with_identity_api_v2: openstack zone set ~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 zone set [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--name NAME] [--email EMAIL] [--ttl TTL] [--description DESCRIPTION | --no-description] [--masters MASTERS [MASTERS ...]] id Set zone properties Positional arguments -------------------- ``id`` Zone ID Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--name NAME`` Zone Name ``--email EMAIL`` Zone Email ``--ttl TTL`` Time To Live (Seconds) ``--description DESCRIPTION`` Description ``--no-description`` ``--masters MASTERS [MASTERS ...]`` Zone Masters .. _openstack_zone_show_with_identity_api_v2: openstack zone show ~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 zone show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] id Show zone details Positional arguments -------------------- ``id`` Zone ID Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_zone_transfer_accept_request_with_identity_api_v2: openstack zone transfer accept request ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 zone transfer accept request [-h] --transfer-id TRANSFER_ID --key KEY Accept a Zone Transfer Request Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--transfer-id TRANSFER_ID`` Transfer ID ``--key KEY`` Transfer Key .. _openstack_zone_transfer_accept_show_with_identity_api_v2: openstack zone transfer accept show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 zone transfer accept show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] id Show Zone Transfer Accept Positional arguments -------------------- ``id`` Zone Tranfer Accept ID Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_zone_transfer_request_create_with_identity_api_v2: openstack zone transfer request create ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 zone transfer request create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] --target-project-id TARGET_PROJECT_ID [--description DESCRIPTION] zone_id Create new zone transfer request Positional arguments -------------------- ``zone_id`` Zone ID to transfer. Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--target-project-id TARGET_PROJECT_ID`` Target Project ID to transfer to. ``--description DESCRIPTION`` Description .. _openstack_zone_transfer_request_delete_with_identity_api_v2: openstack zone transfer request delete ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 zone transfer request delete [-h] id Positional arguments -------------------- ``id`` Zone Transfer ID Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_zone_transfer_request_list_with_identity_api_v2: openstack zone transfer request list ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 zone transfer request list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List zone transfer requests Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_zone_transfer_request_set_with_identity_api_v2: openstack zone transfer request set ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 zone transfer request set [-h] [--description DESCRIPTION | --no-description] id Set Transfer Positional arguments -------------------- ``id`` Zone Transfer ID Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--description DESCRIPTION`` Description ``--no-description`` .. _openstack_zone_transfer_request_show_with_identity_api_v2: openstack zone transfer request show ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 2 zone transfer request show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] id Show zonet transfer details Positional arguments -------------------- ``id`` Zone Tranfer ID Optional arguments ------------------ ``-h, --help`` show this help message and exit OpenStack with Identity API v3 commands (diff) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You can select the Identity API version to use by adding the :option:`--os-identity-api-version` parameter or by setting the corresponding environment variable: .. code-block:: console export OS_IDENTITY_API_VERSION=3 This section documents only the difference in subcommands available for the openstack client when the Identity API version is changed from v2 to v3. .. _openstack_access_token_create_with_identity_api_v3: openstack access token create (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 access token create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_consumer_create_with_identity_api_v3: openstack consumer create (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 consumer create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--description ] Create new consumer Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--description `` New consumer description .. _openstack_consumer_delete_with_identity_api_v3: openstack consumer delete (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 consumer delete [-h] Delete consumer Positional arguments -------------------- ```` Consumer to delete Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_consumer_list_with_identity_api_v3: openstack consumer list (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 consumer list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List consumers Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_consumer_set_with_identity_api_v3: openstack consumer set (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 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_with_identity_api_v3: openstack consumer show (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 consumer show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Display consumer details Positional arguments -------------------- ```` Consumer to display Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_credential_create_with_identity_api_v3: openstack credential create (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 credential create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--type ] [--project ] Create credential command Positional arguments -------------------- ```` Name or ID of user that owns the credential ```` New credential data Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--type `` New credential type ``--project `` Project name or ID which limits the scope of the credential .. _openstack_credential_delete_with_identity_api_v3: openstack credential delete (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 credential delete [-h] Delete credential command Positional arguments -------------------- ```` ID of credential to delete Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_credential_list_with_identity_api_v3: openstack credential list (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 credential list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List credential command Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_credential_set_with_identity_api_v3: openstack credential set (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 credential set [-h] --user --type --data [--project ] Set credential command Positional arguments -------------------- ```` ID of credential to change Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--user `` Name or ID of user that owns the credential ``--type `` New credential type ``--data `` New credential data ``--project `` Project name or ID which limits the scope of the credential .. _openstack_credential_show_with_identity_api_v3: openstack credential show (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 credential show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Show credential command Positional arguments -------------------- ```` ID of credential to display Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_domain_create_with_identity_api_v3: openstack domain create (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 domain create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v3: openstack domain delete (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 domain delete [-h] Delete domain Positional arguments -------------------- ```` Domain to delete (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_domain_list_with_identity_api_v3: openstack domain list (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 domain list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List domains Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_domain_set_with_identity_api_v3: openstack domain set (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 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_with_identity_api_v3: openstack domain show (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 domain show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_endpoint_set_with_identity_api_v3: openstack endpoint set (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 endpoint set [-h] [--region ] [--interface ] [--url ] [--service ] [--enable | --disable] Set endpoint properties Positional arguments -------------------- ```` Endpoint ID to modify 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_federation_domain_list_with_identity_api_v3: openstack federation domain list (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 federation domain list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List accessible domains Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_federation_project_list_with_identity_api_v3: openstack federation project list (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 federation project list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List accessible projects Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_federation_protocol_create_with_identity_api_v3: openstack federation protocol create (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 federation protocol create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v3: openstack federation protocol delete (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 federation protocol delete [-h] --identity-provider Delete federation protocol Positional arguments -------------------- ```` Federation protocol 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_with_identity_api_v3: openstack federation protocol list (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 federation protocol list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v3: openstack federation protocol set (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 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_with_identity_api_v3: openstack federation protocol show (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 federation protocol show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_group_add_user_with_identity_api_v3: openstack group add user (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 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_with_identity_api_v3: openstack group contains user (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 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_with_identity_api_v3: openstack group create (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 group create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v3: openstack group delete (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 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_with_identity_api_v3: openstack group list (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 group list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v3: openstack group remove user (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 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_with_identity_api_v3: openstack group set (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 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_with_identity_api_v3: openstack group show (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 group show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_identity_provider_create_with_identity_api_v3: openstack identity provider create (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 identity provider create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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 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_with_identity_api_v3: openstack identity provider delete (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 identity provider delete [-h] Delete identity provider Positional arguments -------------------- ```` Identity provider to delete Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_identity_provider_list_with_identity_api_v3: openstack identity provider list (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 identity provider list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List identity providers Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_identity_provider_set_with_identity_api_v3: openstack identity provider set (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 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 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_with_identity_api_v3: openstack identity provider show (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 identity provider show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Display identity provider details Positional arguments -------------------- ```` Identity provider to display Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_mapping_create_with_identity_api_v3: openstack mapping create (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 mapping create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--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_with_identity_api_v3: openstack mapping delete (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 mapping delete [-h] Delete mapping Positional arguments -------------------- ```` Mapping to delete Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_mapping_list_with_identity_api_v3: openstack mapping list (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 mapping list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List mappings Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_mapping_set_with_identity_api_v3: openstack mapping set (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 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_with_identity_api_v3: openstack mapping show (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 mapping show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Display mapping details Positional arguments -------------------- ```` Mapping to display Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_policy_create_with_identity_api_v3: openstack policy create (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 policy create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--type ] Create new policy Positional arguments -------------------- ```` New serialized policy rules file Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--type `` New MIME type of the policy rules file (defaults to application/json) .. _openstack_policy_delete_with_identity_api_v3: openstack policy delete (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 policy delete [-h] Delete policy Positional arguments -------------------- ```` Policy to delete Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_policy_list_with_identity_api_v3: openstack policy list (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 policy list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--long] List policies Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--long`` List additional fields in output .. _openstack_policy_set_with_identity_api_v3: openstack policy set (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 policy set [-h] [--type ] [--rules ] Set policy properties Positional arguments -------------------- ```` Policy to modify Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--type `` New MIME type of the policy rules file ``--rules `` New serialized policy rules file .. _openstack_policy_show_with_identity_api_v3: openstack policy show (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 policy show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Display policy details Positional arguments -------------------- ```` Policy to display Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_region_create_with_identity_api_v3: openstack region create (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 region create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] [--parent-region ] [--description ] Create new region Positional arguments -------------------- ```` New region ID Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--parent-region `` Parent region ID ``--description `` New region description .. _openstack_region_delete_with_identity_api_v3: openstack region delete (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 region delete [-h] Delete region Positional arguments -------------------- ```` Region ID to delete Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_region_list_with_identity_api_v3: openstack region list (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 region list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--parent-region ] List regions Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--parent-region `` Filter by parent region ID .. _openstack_region_set_with_identity_api_v3: openstack region set (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 region set [-h] [--parent-region ] [--description ] Set region properties Positional arguments -------------------- ```` Region to modify Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--parent-region `` New parent region ID ``--description `` New region description .. _openstack_region_show_with_identity_api_v3: openstack region show (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 region show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Display region details Positional arguments -------------------- ```` Region to display Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_request_token_authorize_with_identity_api_v3: openstack request token authorize (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 request token authorize [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] --request-key --role Authorize a request token Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--request-key `` Request token to authorize (ID only) (required) ``--role `` Roles to authorize (name or ID) (repeat to set multiple values) (required) .. _openstack_request_token_create_with_identity_api_v3: openstack request token create (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 request token create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] --consumer-key --consumer-secret --project [--domain ] Create a request token Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--consumer-key `` Consumer key (required) ``--consumer-secret `` Consumer secret (required) ``--project `` Project that consumer wants to access (name or ID) (required) ``--domain `` Domain owning (name or ID) .. _openstack_role_assignment_list_with_identity_api_v3: openstack role assignment list (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 role assignment list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] [--effective] [--role ] [--user ] [--user-domain ] [--group ] [--group-domain ] [--domain | --project ] [--project-domain ] [--inherited] List role assignments Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--effective`` Returns only effective role assignments ``--role `` Role to filter (name or ID) ``--user `` User to filter (name or ID) ``--user-domain `` Domain the user belongs to (name or ID). This can be used in case collisions between user names exist. ``--group `` Group to filter (name or ID) ``--group-domain `` Domain the group belongs to (name or ID). This can be used in case collisions between group names exist. ``--domain `` Domain to filter (name or ID) ``--project `` Project to filter (name or ID) ``--project-domain `` Domain the project belongs to (name or ID). This can be used in case collisions between project names exist. ``--inherited`` Specifies if the role grant is inheritable to the sub projects .. _openstack_role_set_with_identity_api_v3: openstack role set (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 role set [-h] [--name ] Set role properties Positional arguments -------------------- ```` Role to modify (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--name `` Set role name .. _openstack_service_provider_create_with_identity_api_v3: openstack service provider create (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 service provider create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] --auth-url [--description ] --service-provider-url [--enable | --disable] Create new service provider Positional arguments -------------------- ```` New service provider name (must be unique) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--auth-url `` Authentication URL of remote federated service provider (required) ``--description `` New service provider description ``--service-provider-url `` A service URL where SAML assertions are being sent (required) ``--enable`` Enable the service provider (default) ``--disable`` Disable the service provider .. _openstack_service_provider_delete_with_identity_api_v3: openstack service provider delete (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 service provider delete [-h] Delete service provider Positional arguments -------------------- ```` Service provider to delete Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_service_provider_list_with_identity_api_v3: openstack service provider list (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 service provider list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List service providers Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_service_provider_set_with_identity_api_v3: openstack service provider set (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 service provider set [-h] [--auth-url ] [--description ] [--service-provider-url ] [--enable | --disable] Set service provider properties Positional arguments -------------------- ```` Service provider to modify Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--auth-url `` New Authentication URL of remote federated service provider ``--description `` New service provider description ``--service-provider-url `` New service provider URL, where SAML assertions are sent ``--enable`` Enable the service provider ``--disable`` Disable the service provider .. _openstack_service_provider_show_with_identity_api_v3: openstack service provider show (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 service provider show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Display service provider details Positional arguments -------------------- ```` Service provider to display Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_service_set_with_identity_api_v3: openstack service set (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 service set [-h] [--type ] [--name ] [--description ] [--enable | --disable] Set service properties Positional arguments -------------------- ```` Service to update (type, name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--type `` New service type (compute, image, identity, volume, etc) ``--name `` New service name ``--description `` New service description ``--enable`` Enable service ``--disable`` Disable service .. _openstack_trust_create_with_identity_api_v3: openstack trust create (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 trust create [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] --project --role [--impersonate] [--expiration ] [--project-domain ] [--trustor-domain ] [--trustee-domain ] Create new trust Positional arguments -------------------- ```` User that is delegating authorization (name or ID) ```` User that is assuming authorization (name or ID) Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--project `` Project being delegated (name or ID) (required) ``--role `` Roles to authorize (name or ID) (repeat to set multiple values) (required) ``--impersonate`` Tokens generated from the trust will represent (defaults to False) ``--expiration `` Sets an expiration date for the trust (format of YYYY- mm-ddTHH:MM:SS) ``--project-domain `` Domain the project belongs to (name or ID). This can be used in case collisions between project names exist. ``--trustor-domain `` Domain that contains (name or ID) ``--trustee-domain `` Domain that contains (name or ID) .. _openstack_trust_delete_with_identity_api_v3: openstack trust delete (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 trust delete [-h] [ ...] Delete trust(s) Positional arguments -------------------- ```` Trust(s) to delete Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_trust_list_with_identity_api_v3: openstack trust list (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 trust list [-h] [-f {csv,html,json,json,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--quote {all,minimal,none,nonnumeric}] List trusts Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_trust_show_with_identity_api_v3: openstack trust show (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 trust show [-h] [-f {html,json,json,shell,table,value,yaml,yaml}] [-c COLUMN] [--max-width ] [--noindent] [--prefix PREFIX] Display trust details Positional arguments -------------------- ```` Trust to display Optional arguments ------------------ ``-h, --help`` show this help message and exit .. _openstack_user_password_set_with_identity_api_v3: openstack user password set (Identity API v3) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: console usage: openstack --os-auth-type token --os-identity-api-version 3 user password set [-h] [--password ] Change current user password Optional arguments ------------------ ``-h, --help`` show this help message and exit ``--password `` New user password