3e96eac73d
message period addition work for python-openstackclient is suspended now. Please see Patch Set 2 comment. https://review.openstack.org/#/c/227243/ Change-Id: Ia6e053142858a51b892e9e6f10efabe0b4894680
11546 lines
371 KiB
XML
11546 lines
371 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<chapter xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
|
version="5.0"
|
|
xml:id="openstackclient_commands">
|
|
|
|
<!-- This file is automatically generated, do not edit -->
|
|
|
|
<?dbhtml stop-chunking?>
|
|
|
|
<title>OpenStack</title>
|
|
|
|
<para>The <command>openstack</command> client is a common
|
|
OpenStack command-line interface (CLI).
|
|
|
|
This chapter documents <command>openstack</command> version
|
|
<literal>1.8.0</literal>.
|
|
</para>
|
|
|
|
<para>For help on a specific <command>openstack</command>
|
|
command, enter:
|
|
</para>
|
|
<screen><prompt>$</prompt> <userinput><command>openstack</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
|
|
|
|
<section xml:id="openstackclient_command_usage">
|
|
<title>openstack usage</title>
|
|
<screen><computeroutput>usage: openstack [--version] [-v] [--log-file LOG_FILE] [-q] [-h] [--debug]
|
|
[--os-cloud <cloud-config-name>]
|
|
[--os-region-name <auth-region-name>]
|
|
[--os-cacert <ca-bundle-file>] [--verify | --insecure]
|
|
[--os-default-domain <auth-domain>]
|
|
[--os-interface <interface>] [--timing]
|
|
[--os-compute-api-version <compute-api-version>]
|
|
[--os-network-api-version <network-api-version>]
|
|
[--os-image-api-version <image-api-version>]
|
|
[--os-volume-api-version <volume-api-version>]
|
|
[--os-identity-api-version <identity-api-version>]
|
|
[--os-auth-type <auth-type>]
|
|
[--os-project-domain-id <auth-project-domain-id>]
|
|
[--os-protocol <auth-protocol>]
|
|
[--os-project-name <auth-project-name>]
|
|
[--os-trust-id <auth-trust-id>]
|
|
[--os-service-provider-endpoint <auth-service-provider-endpoint>]
|
|
[--os-domain-name <auth-domain-name>]
|
|
[--os-user-domain-id <auth-user-domain-id>]
|
|
[--os-identity-provider-url <auth-identity-provider-url>]
|
|
[--os-access-token-endpoint <auth-access-token-endpoint>]
|
|
[--os-domain-id <auth-domain-id>]
|
|
[--os-user-domain-name <auth-user-domain-name>]
|
|
[--os-scope <auth-scope>] [--os-user-id <auth-user-id>]
|
|
[--os-identity-provider <auth-identity-provider>]
|
|
[--os-username <auth-username>]
|
|
[--os-auth-url <auth-auth-url>]
|
|
[--os-client-secret <auth-client-secret>]
|
|
[--os-client-id <auth-client-id>]
|
|
[--os-project-domain-name <auth-project-domain-name>]
|
|
[--os-password <auth-password>]
|
|
[--os-endpoint <auth-endpoint>] [--os-url <auth-url>]
|
|
[--os-token <auth-token>] [--os-project-id <auth-project-id>]
|
|
[--os-object-api-version <object-api-version>]
|
|
[--os-baremetal-api-version <baremetal-api-version>]</computeroutput></screen>
|
|
</section>
|
|
<section xml:id="openstackclient_command_optional">
|
|
<title>openstack optional arguments</title>
|
|
<variablelist wordsize="10">
|
|
<varlistentry>
|
|
<term><command>--version</command></term>
|
|
<listitem>
|
|
<para>
|
|
show program's version number and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-v, --verbose</command></term>
|
|
<listitem>
|
|
<para>
|
|
Increase verbosity of output. Can be repeated.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--log-file LOG_FILE</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify a file to log output. Disabled by default.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-q, --quiet</command></term>
|
|
<listitem>
|
|
<para>
|
|
Suppress output except warnings and errors.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show help message and exit.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--debug</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show tracebacks on errors.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-cloud <cloud-config-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Cloud name in clouds.yaml (Env: OS_CLOUD)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-region-name <auth-region-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Authentication region name (Env: OS_REGION_NAME)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-cacert <ca-bundle-file></command></term>
|
|
<listitem>
|
|
<para>
|
|
CA certificate bundle file (Env: OS_CACERT)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--verify</command></term>
|
|
<listitem>
|
|
<para>
|
|
Verify server certificate (default)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--insecure</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disable server certificate verification
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-default-domain <auth-domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Default domain ID, default=default (Env:
|
|
OS_DEFAULT_DOMAIN)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-interface <interface></command></term>
|
|
<listitem>
|
|
<para>
|
|
Select an interface type. Valid interface types:
|
|
[admin, public, internal]. (Env: OS_INTERFACE)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--timing</command></term>
|
|
<listitem>
|
|
<para>
|
|
Print API call timing info
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-compute-api-version <compute-api-version></command></term>
|
|
<listitem>
|
|
<para>
|
|
Compute API version, default=2 (Env:
|
|
OS_COMPUTE_API_VERSION)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-network-api-version <network-api-version></command></term>
|
|
<listitem>
|
|
<para>
|
|
Network API version, default=2 (Env:
|
|
OS_NETWORK_API_VERSION)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-image-api-version <image-api-version></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image API version, default=1 (Env:
|
|
OS_IMAGE_API_VERSION)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-volume-api-version <volume-api-version></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume API version, default=2 (Env:
|
|
OS_VOLUME_API_VERSION)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-identity-api-version <identity-api-version></command></term>
|
|
<listitem>
|
|
<para>
|
|
Identity API version, default=2 (Env:
|
|
OS_IDENTITY_API_VERSION)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-auth-type <auth-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Select an authentication type. Available types:
|
|
v2token, admin_token, v2password, v3password,
|
|
v3scopedsaml, v3oidcpassword, v3unscopedadfs, token,
|
|
v3token, password, v3unscopedsaml, osc_password,
|
|
token_endpoint. Default: selected based on --os-
|
|
username/--os-token (Env: OS_AUTH_TYPE)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-project-domain-id <auth-project-domain-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
With v3password: Domain ID containing project With
|
|
v3scopedsaml: Domain ID containing project With
|
|
v3oidcpassword: Domain ID containing project With
|
|
v3unscopedadfs: Domain ID containing project With
|
|
token: Domain ID containing project With v3token:
|
|
Domain ID containing project With password: Domain ID
|
|
containing project With v3unscopedsaml: Domain ID
|
|
containing project With osc_password: Domain ID
|
|
containing project (Env: OS_PROJECT_DOMAIN_ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-protocol <auth-protocol></command></term>
|
|
<listitem>
|
|
<para>
|
|
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)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-project-name <auth-project-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
With v3password: Project name to scope to With
|
|
v3scopedsaml: Project name to scope to With
|
|
v3oidcpassword: Project name to scope to With
|
|
v3unscopedadfs: Project name to scope to With token:
|
|
Project name to scope to With v3token: Project name to
|
|
scope to With password: Project name to scope to With
|
|
v3unscopedsaml: Project name to scope to With
|
|
osc_password: Project name to scope to (Env:
|
|
OS_PROJECT_NAME)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-trust-id <auth-trust-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
With v2token: Trust ID With v2password: Trust ID With
|
|
v3password: Trust ID With v3scopedsaml: Trust ID With
|
|
v3oidcpassword: Trust ID With v3unscopedadfs: Trust ID
|
|
With token: Trust ID With v3token: Trust ID With
|
|
password: Trust ID With v3unscopedsaml: Trust ID With
|
|
osc_password: Trust ID (Env: OS_TRUST_ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-service-provider-endpoint <auth-service-provider-endpoint></command></term>
|
|
<listitem>
|
|
<para>
|
|
With v3unscopedadfs: Service Provider's Endpoint (Env:
|
|
OS_SERVICE_PROVIDER_ENDPOINT)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-domain-name <auth-domain-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
With v3password: Domain name to scope to With
|
|
v3scopedsaml: Domain name to scope to With
|
|
v3oidcpassword: Domain name to scope to With
|
|
v3unscopedadfs: Domain name to scope to With token:
|
|
Domain name to scope to With v3token: Domain name to
|
|
scope to With password: Domain name to scope to With
|
|
v3unscopedsaml: Domain name to scope to With
|
|
osc_password: Domain name to scope to (Env:
|
|
OS_DOMAIN_NAME)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-user-domain-id <auth-user-domain-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
With v3password: User's domain id With password:
|
|
User's domain id With osc_password: User's domain id
|
|
(Env: OS_USER_DOMAIN_ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-identity-provider-url <auth-identity-provider-url></command></term>
|
|
<listitem>
|
|
<para>
|
|
With v3unscopedadfs: Identity Provider's URL With
|
|
v3unscopedsaml: Identity Provider's URL (Env:
|
|
OS_IDENTITY_PROVIDER_URL)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-access-token-endpoint <auth-access-token-endpoint></command></term>
|
|
<listitem>
|
|
<para>
|
|
With v3oidcpassword: OpenID Connect Provider Token
|
|
Endpoint (Env: OS_ACCESS_TOKEN_ENDPOINT)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-domain-id <auth-domain-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
With v3password: Domain ID to scope to With
|
|
v3scopedsaml: Domain ID to scope to With
|
|
v3oidcpassword: Domain ID to scope to With
|
|
v3unscopedadfs: Domain ID to scope to With token:
|
|
Domain ID to scope to With v3token: Domain ID to scope
|
|
to With password: Domain ID to scope to With
|
|
v3unscopedsaml: Domain ID to scope to With
|
|
osc_password: Domain ID to scope to (Env:
|
|
OS_DOMAIN_ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-user-domain-name <auth-user-domain-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
With v3password: User's domain name With password:
|
|
User's domain name With osc_password: User's domain
|
|
name (Env: OS_USER_DOMAIN_NAME)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-scope <auth-scope></command></term>
|
|
<listitem>
|
|
<para>
|
|
With v3oidcpassword: OpenID Connect scope that is
|
|
requested from OP (Env: OS_SCOPE)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-user-id <auth-user-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
With v2password: User ID to login with With
|
|
v3password: User ID With password: User id With
|
|
osc_password: User id (Env: OS_USER_ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-identity-provider <auth-identity-provider></command></term>
|
|
<listitem>
|
|
<para>
|
|
With v3oidcpassword: Identity Provider's name With
|
|
v3unscopedadfs: Identity Provider's name With
|
|
v3unscopedsaml: Identity Provider's name (Env:
|
|
OS_IDENTITY_PROVIDER)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-username <auth-username></command></term>
|
|
<listitem>
|
|
<para>
|
|
With v2password: Username to login with With
|
|
v3password: Username With v3oidcpassword: Username
|
|
With v3unscopedadfs: Username With password: Username
|
|
With v3unscopedsaml: Username With osc_password:
|
|
Username (Env: OS_USERNAME)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-auth-url <auth-auth-url></command></term>
|
|
<listitem>
|
|
<para>
|
|
With v2token: Authentication URL With v2password:
|
|
Authentication URL With v3password: Authentication URL
|
|
With v3scopedsaml: Authentication URL With
|
|
v3oidcpassword: Authentication URL With
|
|
v3unscopedadfs: Authentication URL With token:
|
|
Authentication URL With v3token: Authentication URL
|
|
With password: Authentication URL With v3unscopedsaml:
|
|
Authentication URL With osc_password: Authentication
|
|
URL (Env: OS_AUTH_URL)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-client-secret <auth-client-secret></command></term>
|
|
<listitem>
|
|
<para>
|
|
With v3oidcpassword: OAuth 2.0 Client Secret (Env:
|
|
OS_CLIENT_SECRET)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-client-id <auth-client-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
With v3oidcpassword: OAuth 2.0 Client ID (Env:
|
|
OS_CLIENT_ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-project-domain-name <auth-project-domain-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
With v3password: Domain name containing project With
|
|
v3scopedsaml: Domain name containing project With
|
|
v3oidcpassword: Domain name containing project With
|
|
v3unscopedadfs: Domain name containing project With
|
|
token: Domain name containing project With v3token:
|
|
Domain name containing project With password: Domain
|
|
name containing project With v3unscopedsaml: Domain
|
|
name containing project With osc_password: Domain name
|
|
containing project (Env: OS_PROJECT_DOMAIN_NAME)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-password <auth-password></command></term>
|
|
<listitem>
|
|
<para>
|
|
With v2password: Password to use With v3password:
|
|
User's password With v3oidcpassword: Password With
|
|
v3unscopedadfs: Password With password: User's
|
|
password With v3unscopedsaml: Password With
|
|
osc_password: User's password (Env: OS_PASSWORD)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-endpoint <auth-endpoint></command></term>
|
|
<listitem>
|
|
<para>
|
|
With admin_token: The endpoint that will always be
|
|
used With token_endpoint: The endpoint that will
|
|
always be used (Env: OS_ENDPOINT)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-url <auth-url></command></term>
|
|
<listitem>
|
|
<para>
|
|
With token_endpoint: Specific service endpoint to use
|
|
(Env: OS_URL)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-token <auth-token></command></term>
|
|
<listitem>
|
|
<para>
|
|
With v2token: Token With admin_token: The token that
|
|
will always be used With v3scopedsaml: Token to
|
|
authenticate with With token: Token to authenticate
|
|
with With v3token: Token to authenticate with With
|
|
token_endpoint: The token that will always be used
|
|
With token_endpoint: Authentication token to use (Env:
|
|
OS_TOKEN)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-project-id <auth-project-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
With v3password: Project ID to scope to With
|
|
v3scopedsaml: Project ID to scope to With
|
|
v3oidcpassword: Project ID to scope to With
|
|
v3unscopedadfs: Project ID to scope to With token:
|
|
Project ID to scope to With v3token: Project ID to
|
|
scope to With password: Project ID to scope to With
|
|
v3unscopedsaml: Project ID to scope to With
|
|
osc_password: Project ID to scope to (Env:
|
|
OS_PROJECT_ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-object-api-version <object-api-version></command></term>
|
|
<listitem>
|
|
<para>
|
|
Object API version, default=1 (Env:
|
|
OS_OBJECT_API_VERSION)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-baremetal-api-version <baremetal-api-version></command></term>
|
|
<listitem>
|
|
<para>
|
|
Baremetal API version, default=1.6 (Env:
|
|
OS_BAREMETAL_API_VERSION)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
|
|
<section xml:id="openstack_cli_identity_api_v2">
|
|
<title>OpenStack with Identity API v2 commands</title>
|
|
<section xml:id="openstackclient_subcommand_aggregate_add_host_with_identity_api_v2">
|
|
<title>openstack aggregate add host</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate add host [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
<aggregate> <host></computeroutput></screen>
|
|
<para>
|
|
Add host to aggregate
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><aggregate></command></term>
|
|
<listitem>
|
|
<para>
|
|
Aggregate (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><host></command></term>
|
|
<listitem>
|
|
<para>
|
|
Host to add to <aggregate>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_aggregate_create_with_identity_api_v2">
|
|
<title>openstack aggregate create</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
[--zone <availability-zone>]
|
|
[--property <key=value>]
|
|
<name></computeroutput></screen>
|
|
<para>
|
|
Create a new aggregate
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New aggregate name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--zone <availability-zone></command></term>
|
|
<listitem>
|
|
<para>
|
|
Availability zone name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property to add to this aggregate (repeat option to
|
|
set multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_aggregate_delete_with_identity_api_v2">
|
|
<title>openstack aggregate delete</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate delete [-h] <aggregate></computeroutput></screen>
|
|
<para>
|
|
Delete an existing aggregate
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><aggregate></command></term>
|
|
<listitem>
|
|
<para>
|
|
Aggregate to delete (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_aggregate_list_with_identity_api_v2">
|
|
<title>openstack aggregate list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--long]</computeroutput></screen>
|
|
<para>
|
|
List all aggregates
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--long</command></term>
|
|
<listitem>
|
|
<para>
|
|
List additional fields in output
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_aggregate_remove_host_with_identity_api_v2">
|
|
<title>openstack aggregate remove host</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate remove host [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
<aggregate> <host></computeroutput></screen>
|
|
<para>
|
|
Remove host from aggregate
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><aggregate></command></term>
|
|
<listitem>
|
|
<para>
|
|
Aggregate (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><host></command></term>
|
|
<listitem>
|
|
<para>
|
|
Host to remove from <aggregate>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_aggregate_set_with_identity_api_v2">
|
|
<title>openstack aggregate set</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate set [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX] [--name <name>]
|
|
[--zone <availability-zone>]
|
|
[--property <key=value>]
|
|
<aggregate></computeroutput></screen>
|
|
<para>
|
|
Set aggregate properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><aggregate></command></term>
|
|
<listitem>
|
|
<para>
|
|
Aggregate to modify (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set aggregate name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--zone <availability-zone></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set availability zone name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property to set on <aggregate> (repeat option to set
|
|
multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_aggregate_show_with_identity_api_v2">
|
|
<title>openstack aggregate show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 aggregate show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
<aggregate></computeroutput></screen>
|
|
<para>
|
|
Display aggregate details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><aggregate></command></term>
|
|
<listitem>
|
|
<para>
|
|
Aggregate to display (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_availability_zone_list_with_identity_api_v2">
|
|
<title>openstack availability zone list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 availability zone list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--long]</computeroutput></screen>
|
|
<para>
|
|
List availability zones and their status
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--long</command></term>
|
|
<listitem>
|
|
<para>
|
|
List additional fields in output
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_backup_create_with_identity_api_v2">
|
|
<title>openstack backup create</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 backup create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
[--container <container>] [--name <name>]
|
|
[--description <description>]
|
|
<volume></computeroutput></screen>
|
|
<para>
|
|
Create new backup
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume to backup (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--container <container></command></term>
|
|
<listitem>
|
|
<para>
|
|
Optional backup container name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the backup
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Description of the backup
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_backup_delete_with_identity_api_v2">
|
|
<title>openstack backup delete</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 backup delete [-h] <backup> [<backup> ...]</computeroutput></screen>
|
|
<para>
|
|
Delete backup(s)
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><backup></command></term>
|
|
<listitem>
|
|
<para>
|
|
Backup(s) to delete (ID only)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_backup_list_with_identity_api_v2">
|
|
<title>openstack backup list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 backup list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}] [--long]</computeroutput></screen>
|
|
<para>
|
|
List backups
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--long</command></term>
|
|
<listitem>
|
|
<para>
|
|
List additional fields in output
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_backup_restore_with_identity_api_v2">
|
|
<title>openstack backup restore</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 backup restore [-h] <backup> <volume></computeroutput></screen>
|
|
<para>
|
|
Restore backup
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><backup></command></term>
|
|
<listitem>
|
|
<para>
|
|
Backup to restore (ID only)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume to restore to (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_backup_show_with_identity_api_v2">
|
|
<title>openstack backup show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 backup show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX]
|
|
<backup></computeroutput></screen>
|
|
<para>
|
|
Display backup details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><backup></command></term>
|
|
<listitem>
|
|
<para>
|
|
Backup to display (ID only)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_baremetal_create_with_identity_api_v2">
|
|
<title>openstack baremetal create</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
[--chassis-uuid <chassis>] --driver <driver>
|
|
[--driver-info <key=value>]
|
|
[--property <key=value>]
|
|
[--extra <key=value>] [--uuid <uuid>]
|
|
[--name <name>]</computeroutput></screen>
|
|
<para>
|
|
Register a new node with the baremetal service
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--chassis-uuid <chassis></command></term>
|
|
<listitem>
|
|
<para>
|
|
UUID of the chassis that this node belongs to.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--driver <driver></command></term>
|
|
<listitem>
|
|
<para>
|
|
Driver used to control the node [REQUIRED].
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--driver-info <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Key/value pair used by the driver, such as out-of-band
|
|
management credentials. Can be specified multiple
|
|
times.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
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.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--extra <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Record arbitrary key/value metadata. Can be specified
|
|
multiple times.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--uuid <uuid></command></term>
|
|
<listitem>
|
|
<para>
|
|
Unique UUID for the node.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Unique name for the node.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_baremetal_delete_with_identity_api_v2">
|
|
<title>openstack baremetal delete</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal delete [-h] <node></computeroutput></screen>
|
|
<para>
|
|
Unregister a baremetal node
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><node></command></term>
|
|
<listitem>
|
|
<para>
|
|
Node to delete (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_baremetal_list_with_identity_api_v2">
|
|
<title>openstack baremetal list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--limit <limit>] [--marker <node>]
|
|
[--sort <key>[:<direction>]] [--maintenance]
|
|
[--associated] [--long]</computeroutput></screen>
|
|
<para>
|
|
List baremetal nodes
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--limit <limit></command></term>
|
|
<listitem>
|
|
<para>
|
|
Maximum number of nodes to return per request, 0 for
|
|
no limit. Default is the maximum number used by the
|
|
Baremetal API Service.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--marker <node></command></term>
|
|
<listitem>
|
|
<para>
|
|
Node UUID (for example, of the last node in the list
|
|
from a previous request). Returns the list of nodes
|
|
after this UUID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort <key>[:<direction>]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sort output by selected keys and directions(asc or
|
|
desc) (default: asc), multiple keys and directions can
|
|
be specified separated by comma
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--maintenance</command></term>
|
|
<listitem>
|
|
<para>
|
|
List nodes in maintenance mode.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--associated</command></term>
|
|
<listitem>
|
|
<para>
|
|
List only nodes associated with an instance.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--long</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show detailed information about the nodes.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_baremetal_set_with_identity_api_v2">
|
|
<title>openstack baremetal set</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal set [-h] [--property <path=value>] <node></computeroutput></screen>
|
|
<para>
|
|
Set baremetal properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><node></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or UUID of the node.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <path=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property to add to this baremetal host (repeat option
|
|
to set multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_baremetal_show_with_identity_api_v2">
|
|
<title>openstack baremetal show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX] [--instance]
|
|
[--long]
|
|
<node></computeroutput></screen>
|
|
<para>
|
|
Show baremetal node details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><node></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or UUID of the node (or instance UUID if
|
|
--instance is specified)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--instance <node></command></term>
|
|
<listitem>
|
|
<para>
|
|
is an instance UUID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--long</command></term>
|
|
<listitem>
|
|
<para>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_baremetal_unset_with_identity_api_v2">
|
|
<title>openstack baremetal unset</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 baremetal unset [-h] [--property <path>] <node></computeroutput></screen>
|
|
<para>
|
|
Unset baremetal properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><node></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or UUID of the node.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <path></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property to unset on this baremetal host (repeat option
|
|
to unset multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_catalog_list_with_identity_api_v2">
|
|
<title>openstack catalog list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 catalog list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
|
|
<para>
|
|
List services in the service catalog
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_catalog_show_with_identity_api_v2">
|
|
<title>openstack catalog show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 catalog show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX]
|
|
<service></computeroutput></screen>
|
|
<para>
|
|
Display service catalog details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><service></command></term>
|
|
<listitem>
|
|
<para>
|
|
Service to display (type or name)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_command_list_with_identity_api_v2">
|
|
<title>openstack command list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 command list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
|
|
<para>
|
|
List recognized commands by group
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_compute_agent_create_with_identity_api_v2">
|
|
<title>openstack compute agent create</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 compute agent create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
<os> <architecture> <version> <url>
|
|
<md5hash> <hypervisor></computeroutput></screen>
|
|
<para>
|
|
Create compute agent command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><os></command></term>
|
|
<listitem>
|
|
<para>
|
|
Type of OS
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><architecture></command></term>
|
|
<listitem>
|
|
<para>
|
|
Type of architecture
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><version></command></term>
|
|
<listitem>
|
|
<para>
|
|
Version
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><url></command></term>
|
|
<listitem>
|
|
<para>
|
|
URL
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><md5hash></command></term>
|
|
<listitem>
|
|
<para>
|
|
MD5 hash
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><hypervisor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Type of hypervisor
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_compute_agent_delete_with_identity_api_v2">
|
|
<title>openstack compute agent delete</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 compute agent delete [-h] <id></computeroutput></screen>
|
|
<para>
|
|
Delete compute agent command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of agent to delete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_compute_agent_list_with_identity_api_v2">
|
|
<title>openstack compute agent list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 compute agent list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--hypervisor <hypervisor>]</computeroutput></screen>
|
|
<para>
|
|
List compute agent command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--hypervisor <hypervisor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Type of hypervisor
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_compute_agent_set_with_identity_api_v2">
|
|
<title>openstack compute agent set</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 compute agent set [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
<id> <version> <url> <md5hash></computeroutput></screen>
|
|
<para>
|
|
Set compute agent command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the agent
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><version></command></term>
|
|
<listitem>
|
|
<para>
|
|
Version of the agent
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><url></command></term>
|
|
<listitem>
|
|
<para>
|
|
URL
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><md5hash></command></term>
|
|
<listitem>
|
|
<para>
|
|
MD5 hash
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_compute_service_list_with_identity_api_v2">
|
|
<title>openstack compute service list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 compute service list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--host <host>] [--service <service>]</computeroutput></screen>
|
|
<para>
|
|
List service command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--host <host></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of host
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--service <service></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of service
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_compute_service_set_with_identity_api_v2">
|
|
<title>openstack compute service set</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 compute service set [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--enable | --disable]
|
|
<host> <service></computeroutput></screen>
|
|
<para>
|
|
Set service command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><host></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of host
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><service></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of service
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--enable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Enable a service
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disable a service
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_configuration_show_with_identity_api_v2">
|
|
<title>openstack configuration show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 configuration show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
[--mask | --unmask]</computeroutput></screen>
|
|
<para>
|
|
Display configuration details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--mask</command></term>
|
|
<listitem>
|
|
<para>
|
|
Attempt to mask passwords (default)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--unmask</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show password in clear text
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_console_log_show_with_identity_api_v2">
|
|
<title>openstack console log show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 console log show [-h] [--lines <num-lines>] <server></computeroutput></screen>
|
|
<para>
|
|
Show server's console output
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server to show console log (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--lines <num-lines></command></term>
|
|
<listitem>
|
|
<para>
|
|
Number of lines to display from the end of the log
|
|
(default=all)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_console_url_show_with_identity_api_v2">
|
|
<title>openstack console url show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 console url show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
[--novnc | --xvpvnc | --spice]
|
|
<server></computeroutput></screen>
|
|
<para>
|
|
Show server's remote console URL
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server to show URL (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--novnc</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show noVNC console URL (default)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--xvpvnc</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show xpvnc console URL
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--spice</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show SPICE console URL
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_container_create_with_identity_api_v2">
|
|
<title>openstack container create</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 container create [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
<container-name> [<container-name> ...]</computeroutput></screen>
|
|
<para>
|
|
Create new container
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New container name(s)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_container_delete_with_identity_api_v2">
|
|
<title>openstack container delete</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 container delete [-h] <container> [<container> ...]</computeroutput></screen>
|
|
<para>
|
|
Delete container
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container></command></term>
|
|
<listitem>
|
|
<para>
|
|
Container(s) to delete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_container_list_with_identity_api_v2">
|
|
<title>openstack container list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 container list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--prefix <prefix>] [--marker <marker>]
|
|
[--end-marker <end-marker>] [--limit <limit>]
|
|
[--long] [--all]</computeroutput></screen>
|
|
<para>
|
|
List containers
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--prefix <prefix></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter list using <prefix>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--marker <marker></command></term>
|
|
<listitem>
|
|
<para>
|
|
Anchor for paging
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--end-marker <end-marker></command></term>
|
|
<listitem>
|
|
<para>
|
|
End anchor for paging
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--limit <limit></command></term>
|
|
<listitem>
|
|
<para>
|
|
Limit the number of containers returned
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--long</command></term>
|
|
<listitem>
|
|
<para>
|
|
List additional fields in output
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--all</command></term>
|
|
<listitem>
|
|
<para>
|
|
List all containers (default is 10000)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_container_save_with_identity_api_v2">
|
|
<title>openstack container save</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 container save [-h] <container></computeroutput></screen>
|
|
<para>
|
|
Save container contents locally
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container></command></term>
|
|
<listitem>
|
|
<para>
|
|
Container to save
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_container_set_with_identity_api_v2">
|
|
<title>openstack container set</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 container set [-h] --property <key=value> <container></computeroutput></screen>
|
|
<para>
|
|
Set container properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container></command></term>
|
|
<listitem>
|
|
<para>
|
|
Container to modify
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set a property on this container (repeat option to set
|
|
multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_container_show_with_identity_api_v2">
|
|
<title>openstack container show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 container show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
<container></computeroutput></screen>
|
|
<para>
|
|
Display container details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container></command></term>
|
|
<listitem>
|
|
<para>
|
|
Container to display
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_container_unset_with_identity_api_v2">
|
|
<title>openstack container unset</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 container unset [-h] --property <key> <container></computeroutput></screen>
|
|
<para>
|
|
Unset container properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container></command></term>
|
|
<listitem>
|
|
<para>
|
|
Container to modify
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property to remove from container (repeat option to remove
|
|
multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_ec2_credentials_create_with_identity_api_v2">
|
|
<title>openstack ec2 credentials create</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 ec2 credentials create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
[--project <project>] [--user <user>]</computeroutput></screen>
|
|
<para>
|
|
Create EC2 credentials
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Create credentials in project (name or ID; default:
|
|
current authenticated project)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user <user></command></term>
|
|
<listitem>
|
|
<para>
|
|
Create credentials for user (name or ID; default:
|
|
current authenticated user)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_ec2_credentials_delete_with_identity_api_v2">
|
|
<title>openstack ec2 credentials delete</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 ec2 credentials delete [-h] [--user <user>] <access-key></computeroutput></screen>
|
|
<para>
|
|
Delete EC2 credentials
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><access-key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Credentials access key
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user <user></command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete credentials for user (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_ec2_credentials_list_with_identity_api_v2">
|
|
<title>openstack ec2 credentials list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 ec2 credentials list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--user <user>]</computeroutput></screen>
|
|
<para>
|
|
List EC2 credentials
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user <user></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter list by user (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_ec2_credentials_show_with_identity_api_v2">
|
|
<title>openstack ec2 credentials show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 ec2 credentials show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
[--user <user>]
|
|
<access-key></computeroutput></screen>
|
|
<para>
|
|
Display EC2 credentials details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><access-key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Credentials access key
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user <user></command></term>
|
|
<listitem>
|
|
<para>
|
|
Show credentials for user (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_endpoint_create_with_identity_api_v2">
|
|
<title>openstack endpoint create</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 endpoint create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX] --publicurl
|
|
<url> [--adminurl <url>]
|
|
[--internalurl <url>] [--region <region-id>]
|
|
<service></computeroutput></screen>
|
|
<para>
|
|
Create new endpoint
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><service></command></term>
|
|
<listitem>
|
|
<para>
|
|
New endpoint service (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--publicurl <url></command></term>
|
|
<listitem>
|
|
<para>
|
|
New endpoint public URL (required)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--adminurl <url></command></term>
|
|
<listitem>
|
|
<para>
|
|
New endpoint admin URL
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--internalurl <url></command></term>
|
|
<listitem>
|
|
<para>
|
|
New endpoint internal URL
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--region <region-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
New endpoint region ID
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_endpoint_delete_with_identity_api_v2">
|
|
<title>openstack endpoint delete</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 endpoint delete [-h] <endpoint-id></computeroutput></screen>
|
|
<para>
|
|
Delete endpoint
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><endpoint-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Endpoint ID to delete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_endpoint_list_with_identity_api_v2">
|
|
<title>openstack endpoint list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 endpoint list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--long]</computeroutput></screen>
|
|
<para>
|
|
List endpoints
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--long</command></term>
|
|
<listitem>
|
|
<para>
|
|
List additional fields in output
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_endpoint_show_with_identity_api_v2">
|
|
<title>openstack endpoint show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 endpoint show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
<endpoint-id></computeroutput></screen>
|
|
<para>
|
|
Display endpoint details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><endpoint-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Endpoint ID to display
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_extension_list_with_identity_api_v2">
|
|
<title>openstack extension list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 extension list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--compute] [--identity] [--network]
|
|
[--volume] [--long]</computeroutput></screen>
|
|
<para>
|
|
List API extensions
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--compute</command></term>
|
|
<listitem>
|
|
<para>
|
|
List extensions for the Compute API
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--identity</command></term>
|
|
<listitem>
|
|
<para>
|
|
List extensions for the Identity API
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--network</command></term>
|
|
<listitem>
|
|
<para>
|
|
List extensions for the Network API
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--volume</command></term>
|
|
<listitem>
|
|
<para>
|
|
List extensions for the Volume API
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--long</command></term>
|
|
<listitem>
|
|
<para>
|
|
List additional fields in output
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_flavor_create_with_identity_api_v2">
|
|
<title>openstack flavor create</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 flavor create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX] [--id <id>]
|
|
[--ram <size-mb>] [--disk <size-gb>]
|
|
[--ephemeral <size-gb>] [--swap <size-gb>]
|
|
[--vcpus <vcpus>] [--rxtx-factor <factor>]
|
|
[--public | --private]
|
|
<flavor-name></computeroutput></screen>
|
|
<para>
|
|
Create new flavor
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><flavor-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New flavor name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--id <id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Unique flavor ID; 'auto' creates a UUID (default:
|
|
auto)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ram <size-mb></command></term>
|
|
<listitem>
|
|
<para>
|
|
Memory size in MB (default 256M)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disk <size-gb></command></term>
|
|
<listitem>
|
|
<para>
|
|
Disk size in GB (default 0G)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ephemeral <size-gb></command></term>
|
|
<listitem>
|
|
<para>
|
|
Ephemeral disk size in GB (default 0G)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--swap <size-gb></command></term>
|
|
<listitem>
|
|
<para>
|
|
Swap space size in GB (default 0G)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--vcpus <vcpus></command></term>
|
|
<listitem>
|
|
<para>
|
|
Number of vcpus (default 1)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--rxtx-factor <factor></command></term>
|
|
<listitem>
|
|
<para>
|
|
RX/TX factor (default 1)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--public</command></term>
|
|
<listitem>
|
|
<para>
|
|
Flavor is available to other projects (default)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--private</command></term>
|
|
<listitem>
|
|
<para>
|
|
Flavor is not available to other projects
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_flavor_delete_with_identity_api_v2">
|
|
<title>openstack flavor delete</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 flavor delete [-h] <flavor></computeroutput></screen>
|
|
<para>
|
|
Delete flavor
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><flavor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Flavor to delete (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_flavor_list_with_identity_api_v2">
|
|
<title>openstack flavor list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 flavor list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--public | --private | --all] [--long]</computeroutput></screen>
|
|
<para>
|
|
List flavors
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--public</command></term>
|
|
<listitem>
|
|
<para>
|
|
List only public flavors (default)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--private</command></term>
|
|
<listitem>
|
|
<para>
|
|
List only private flavors
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--all</command></term>
|
|
<listitem>
|
|
<para>
|
|
List all flavors, whether public or private
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--long</command></term>
|
|
<listitem>
|
|
<para>
|
|
List additional fields in output
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_flavor_set_with_identity_api_v2">
|
|
<title>openstack flavor set</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 flavor set [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX] [--property <key=value>]
|
|
<flavor></computeroutput></screen>
|
|
<para>
|
|
Set flavor properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><flavor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Flavor to modify (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property to add or modify for this flavor (repeat
|
|
option to set multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_flavor_show_with_identity_api_v2">
|
|
<title>openstack flavor show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 flavor show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX]
|
|
<flavor></computeroutput></screen>
|
|
<para>
|
|
Display flavor details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><flavor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Flavor to display (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_flavor_unset_with_identity_api_v2">
|
|
<title>openstack flavor unset</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 flavor unset [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX] --property <key>
|
|
<flavor></computeroutput></screen>
|
|
<para>
|
|
Unset flavor properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><flavor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Flavor to modify (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property to remove from flavor (repeat option to unset
|
|
multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_host_list_with_identity_api_v2">
|
|
<title>openstack host list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 host list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--zone <zone>]</computeroutput></screen>
|
|
<para>
|
|
List host command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--zone <zone></command></term>
|
|
<listitem>
|
|
<para>
|
|
Only return hosts in the availability zone.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_host_show_with_identity_api_v2">
|
|
<title>openstack host show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 host show [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
<host></computeroutput></screen>
|
|
<para>
|
|
Show host command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><host></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of host
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_hypervisor_list_with_identity_api_v2">
|
|
<title>openstack hypervisor list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 hypervisor list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--matching <hostname>]</computeroutput></screen>
|
|
<para>
|
|
List hypervisors
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--matching <hostname></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter hypervisors using <hostname> substring
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_hypervisor_show_with_identity_api_v2">
|
|
<title>openstack hypervisor show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 hypervisor show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
<hypervisor></computeroutput></screen>
|
|
<para>
|
|
Display hypervisor details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><hypervisor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Hypervisor to display (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_hypervisor_stats_show_with_identity_api_v2">
|
|
<title>openstack hypervisor stats show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 hypervisor stats show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]</computeroutput></screen>
|
|
<para>
|
|
Display hypervisor stats details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_image_add_project_with_identity_api_v2">
|
|
<title>openstack image add project</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 image add project [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
[--project-domain <project-domain>]
|
|
<image> <project></computeroutput></screen>
|
|
<para>
|
|
Associate project with image
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><image></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image to share (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Project to associate with image (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project-domain <project-domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain the project belongs to (name or ID). This can
|
|
be used in case collisions between project names
|
|
exist.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_image_create_with_identity_api_v2">
|
|
<title>openstack image create</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 image create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX] [--id <id>]
|
|
[--container-format <container-format>]
|
|
[--disk-format <disk-format>]
|
|
[--min-disk <disk-gb>] [--min-ram <ram-mb>]
|
|
[--file <file>] [--protected | --unprotected]
|
|
[--public | --private] [--property <key=value>]
|
|
[--tag <tag>]
|
|
<image-name></computeroutput></screen>
|
|
<para>
|
|
Create/upload an image
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><image-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New image name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--id <id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image ID to reserve
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--container-format <container-format></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image container format (default: bare)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disk-format <disk-format></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image disk format (default: raw)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--min-disk <disk-gb></command></term>
|
|
<listitem>
|
|
<para>
|
|
Minimum disk size needed to boot image, in gigabytes
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--min-ram <ram-mb></command></term>
|
|
<listitem>
|
|
<para>
|
|
Minimum RAM size needed to boot image, in megabytes
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--file <file></command></term>
|
|
<listitem>
|
|
<para>
|
|
Upload image from local file
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--protected</command></term>
|
|
<listitem>
|
|
<para>
|
|
Prevent image from being deleted
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--unprotected</command></term>
|
|
<listitem>
|
|
<para>
|
|
Allow image to be deleted (default)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--public</command></term>
|
|
<listitem>
|
|
<para>
|
|
Image is accessible to the public
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--private</command></term>
|
|
<listitem>
|
|
<para>
|
|
Image is inaccessible to the public (default)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set a property on this image (repeat option to set
|
|
multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tag <tag></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set a tag on this image (repeat option to set multiple
|
|
tags)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_image_delete_with_identity_api_v2">
|
|
<title>openstack image delete</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 image delete [-h] <image> [<image> ...]</computeroutput></screen>
|
|
<para>
|
|
Delete image(s)
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><image></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image(s) to delete (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_image_list_with_identity_api_v2">
|
|
<title>openstack image list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 image list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--public | --private | --shared]
|
|
[--property <key=value>] [--long]
|
|
[--sort <key>[:<direction>]]</computeroutput></screen>
|
|
<para>
|
|
List available images
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--public</command></term>
|
|
<listitem>
|
|
<para>
|
|
List only public images
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--private</command></term>
|
|
<listitem>
|
|
<para>
|
|
List only private images
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--shared</command></term>
|
|
<listitem>
|
|
<para>
|
|
List only shared images
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter output based on property
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--long</command></term>
|
|
<listitem>
|
|
<para>
|
|
List additional fields in output
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--sort <key>[:<direction>]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Sort output by selected keys and directions(asc or
|
|
desc) (default: asc), multiple keys and directions can
|
|
be specified separated by comma
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_image_remove_project_with_identity_api_v2">
|
|
<title>openstack image remove project</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 image remove project [-h] [--project-domain <project-domain>]
|
|
<image> <project></computeroutput></screen>
|
|
<para>
|
|
Disassociate project with image
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><image></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image to unshare (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Project to disassociate with image (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project-domain <project-domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain the project belongs to (name or ID). This can
|
|
be used in case collisions between project names
|
|
exist.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_image_save_with_identity_api_v2">
|
|
<title>openstack image save</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 image save [-h] [--file <filename>] <image></computeroutput></screen>
|
|
<para>
|
|
Save an image locally
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><image></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image to save (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--file <filename></command></term>
|
|
<listitem>
|
|
<para>
|
|
Downloaded image save filename (default: stdout)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_image_set_with_identity_api_v2">
|
|
<title>openstack image set</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 image set [-h] [--name <name>] [--owner <project>]
|
|
[--min-disk <disk-gb>] [--min-ram <ram-mb>]
|
|
[--container-format <container-format>]
|
|
[--disk-format <disk-format>]
|
|
[--protected | --unprotected]
|
|
[--public | --private] [--property <key=value>]
|
|
[--tag <tag>] [--architecture <architecture>]
|
|
[--instance-id <instance-id>]
|
|
[--kernel-id <kernel-id>] [--os-distro <os-distro>]
|
|
[--os-version <os-version>]
|
|
[--ramdisk-id <ramdisk-id>]
|
|
<image></computeroutput></screen>
|
|
<para>
|
|
Set image properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><image></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image to modify (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New image name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--owner <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
New image owner project (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--min-disk <disk-gb></command></term>
|
|
<listitem>
|
|
<para>
|
|
Minimum disk size needed to boot image, in gigabytes
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--min-ram <ram-mb></command></term>
|
|
<listitem>
|
|
<para>
|
|
Minimum RAM size needed to boot image, in megabytes
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--container-format <container-format></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image container format (default: bare)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disk-format <disk-format></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image disk format (default: raw)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--protected</command></term>
|
|
<listitem>
|
|
<para>
|
|
Prevent image from being deleted
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--unprotected</command></term>
|
|
<listitem>
|
|
<para>
|
|
Allow image to be deleted (default)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--public</command></term>
|
|
<listitem>
|
|
<para>
|
|
Image is accessible to the public
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--private</command></term>
|
|
<listitem>
|
|
<para>
|
|
Image is inaccessible to the public (default)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set a property on this image (repeat option to set
|
|
multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--tag <tag></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set a tag on this image (repeat option to set multiple
|
|
tags)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--architecture <architecture></command></term>
|
|
<listitem>
|
|
<para>
|
|
Operating system architecture
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--instance-id <instance-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of server instance used to create this image
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--kernel-id <kernel-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of kernel image used to boot this disk image
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-distro <os-distro></command></term>
|
|
<listitem>
|
|
<para>
|
|
Operating system distribution name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-version <os-version></command></term>
|
|
<listitem>
|
|
<para>
|
|
Operating system distribution version
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ramdisk-id <ramdisk-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of ramdisk image used to boot this disk image
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_image_show_with_identity_api_v2">
|
|
<title>openstack image show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 image show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX]
|
|
<image></computeroutput></screen>
|
|
<para>
|
|
Display image details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><image></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image to display (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_ip_fixed_add_with_identity_api_v2">
|
|
<title>openstack ip fixed add</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 ip fixed add [-h] <network> <server></computeroutput></screen>
|
|
<para>
|
|
Add fixed-ip command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><network></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the network to fetch an IP address from
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the server to receive the IP address
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_ip_fixed_remove_with_identity_api_v2">
|
|
<title>openstack ip fixed remove</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 ip fixed remove [-h] <ip-address> <server></computeroutput></screen>
|
|
<para>
|
|
Remove fixed-ip command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><ip-address></command></term>
|
|
<listitem>
|
|
<para>
|
|
IP address to remove from server
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the server to remove the IP address from
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_ip_floating_add_with_identity_api_v2">
|
|
<title>openstack ip floating add</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 ip floating add [-h] <ip-address> <server></computeroutput></screen>
|
|
<para>
|
|
Add floating-ip to server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><ip-address></command></term>
|
|
<listitem>
|
|
<para>
|
|
IP address to add to server
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server to receive the IP address (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_ip_floating_create_with_identity_api_v2">
|
|
<title>openstack ip floating create</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 ip floating create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
<pool></computeroutput></screen>
|
|
<para>
|
|
Create new floating-ip
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><pool></command></term>
|
|
<listitem>
|
|
<para>
|
|
Pool to fetch floating IP from
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_ip_floating_delete_with_identity_api_v2">
|
|
<title>openstack ip floating delete</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 ip floating delete [-h] <ip-address></computeroutput></screen>
|
|
<para>
|
|
Delete a floating-ip
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><ip-address></command></term>
|
|
<listitem>
|
|
<para>
|
|
IP address to delete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_ip_floating_list_with_identity_api_v2">
|
|
<title>openstack ip floating list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 ip floating list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
|
|
<para>
|
|
List floating-ips
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_ip_floating_pool_list_with_identity_api_v2">
|
|
<title>openstack ip floating pool list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 ip floating pool list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
|
|
<para>
|
|
List floating-ip-pools
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_ip_floating_remove_with_identity_api_v2">
|
|
<title>openstack ip floating remove</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 ip floating remove [-h] <ip-address> <server></computeroutput></screen>
|
|
<para>
|
|
Remove floating-ip from server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><ip-address></command></term>
|
|
<listitem>
|
|
<para>
|
|
IP address to remove from server
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server to remove the IP address from (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_keypair_create_with_identity_api_v2">
|
|
<title>openstack keypair create</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 keypair create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
[--public-key <file>]
|
|
<name></computeroutput></screen>
|
|
<para>
|
|
Create new public key
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New public key name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--public-key <file></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filename for public key to add
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_keypair_delete_with_identity_api_v2">
|
|
<title>openstack keypair delete</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 keypair delete [-h] <key></computeroutput></screen>
|
|
<para>
|
|
Delete public key
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Public key to delete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_keypair_list_with_identity_api_v2">
|
|
<title>openstack keypair list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 keypair list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
|
|
<para>
|
|
List public key fingerprints
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_keypair_show_with_identity_api_v2">
|
|
<title>openstack keypair show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 keypair show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX] [--public-key]
|
|
<key></computeroutput></screen>
|
|
<para>
|
|
Display public key details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Public key to display
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--public-key</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show only bare public key
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_limits_show_with_identity_api_v2">
|
|
<title>openstack limits show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 limits show [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
(--absolute | --rate) [--reserved]
|
|
[--project <project>] [--domain <domain>]</computeroutput></screen>
|
|
<para>
|
|
Show compute and volume limits
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--absolute</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show absolute limits
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--rate</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show rate limits
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--reserved</command></term>
|
|
<listitem>
|
|
<para>
|
|
Include reservations count [only valid with
|
|
--absolute]
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Show limits for a specific project (name or ID) [only
|
|
valid with --absolute]
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--domain <domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain that owns --project (name or ID) [only valid
|
|
with --absolute]
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_module_list_with_identity_api_v2">
|
|
<title>openstack module list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 module list [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX] [--all]</computeroutput></screen>
|
|
<para>
|
|
List module versions
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--all</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show all modules that have version information
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_network_create_with_identity_api_v2">
|
|
<title>openstack network create</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 network create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
[--enable | --disable] [--share | --no-share]
|
|
[--project <project>]
|
|
[--project-domain <project-domain>]
|
|
<name></computeroutput></screen>
|
|
<para>
|
|
Create new network
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New network name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--enable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Enable network (default)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disable network
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--share</command></term>
|
|
<listitem>
|
|
<para>
|
|
Share the network between projects
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--no-share</command></term>
|
|
<listitem>
|
|
<para>
|
|
Do not share the network between projects
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Owner's project (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project-domain <project-domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain the project belongs to (name or ID). This can
|
|
be used in case collisions between project names
|
|
exist.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_network_delete_with_identity_api_v2">
|
|
<title>openstack network delete</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 network delete [-h] <network> [<network> ...]</computeroutput></screen>
|
|
<para>
|
|
Delete network(s)
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><network></command></term>
|
|
<listitem>
|
|
<para>
|
|
Network to delete (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_network_list_with_identity_api_v2">
|
|
<title>openstack network list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 network list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--external] [--long]</computeroutput></screen>
|
|
<para>
|
|
List networks
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--external</command></term>
|
|
<listitem>
|
|
<para>
|
|
List external networks
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--long</command></term>
|
|
<listitem>
|
|
<para>
|
|
List additional fields in output
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_network_set_with_identity_api_v2">
|
|
<title>openstack network set</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 network set [-h] [--name <name>] [--enable | --disable]
|
|
[--share | --no-share]
|
|
<network></computeroutput></screen>
|
|
<para>
|
|
Set network properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><network></command></term>
|
|
<listitem>
|
|
<para>
|
|
Network to modify (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set network name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--enable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Enable network
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disable network
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--share</command></term>
|
|
<listitem>
|
|
<para>
|
|
Share the network between projects
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--no-share</command></term>
|
|
<listitem>
|
|
<para>
|
|
Do not share the network between projects
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_network_show_with_identity_api_v2">
|
|
<title>openstack network show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 network show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX]
|
|
<network></computeroutput></screen>
|
|
<para>
|
|
Show network details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><network></command></term>
|
|
<listitem>
|
|
<para>
|
|
Network to display (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_object_create_with_identity_api_v2">
|
|
<title>openstack object create</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 object create [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
<container> <filename> [<filename> ...]</computeroutput></screen>
|
|
<para>
|
|
Upload object to container
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container></command></term>
|
|
<listitem>
|
|
<para>
|
|
Container for new object
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><filename></command></term>
|
|
<listitem>
|
|
<para>
|
|
Local filename(s) to upload
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_object_delete_with_identity_api_v2">
|
|
<title>openstack object delete</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 object delete [-h] <container> <object> [<object> ...]</computeroutput></screen>
|
|
<para>
|
|
Delete object from container
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container></command></term>
|
|
<listitem>
|
|
<para>
|
|
Delete object(s) from <container>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><object></command></term>
|
|
<listitem>
|
|
<para>
|
|
Object(s) to delete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_object_list_with_identity_api_v2">
|
|
<title>openstack object list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 object list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--prefix <prefix>] [--delimiter <delimiter>]
|
|
[--marker <marker>] [--end-marker <end-marker>]
|
|
[--limit <limit>] [--long] [--all]
|
|
<container></computeroutput></screen>
|
|
<para>
|
|
List objects
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container></command></term>
|
|
<listitem>
|
|
<para>
|
|
Container to list
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--prefix <prefix></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter list using <prefix>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--delimiter <delimiter></command></term>
|
|
<listitem>
|
|
<para>
|
|
Roll up items with <delimiter>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--marker <marker></command></term>
|
|
<listitem>
|
|
<para>
|
|
Anchor for paging
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--end-marker <end-marker></command></term>
|
|
<listitem>
|
|
<para>
|
|
End anchor for paging
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--limit <limit></command></term>
|
|
<listitem>
|
|
<para>
|
|
Limit the number of objects returned
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--long</command></term>
|
|
<listitem>
|
|
<para>
|
|
List additional fields in output
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--all</command></term>
|
|
<listitem>
|
|
<para>
|
|
List all objects in container (default is 10000)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_object_save_with_identity_api_v2">
|
|
<title>openstack object save</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 object save [-h] [--file <filename>] <container> <object></computeroutput></screen>
|
|
<para>
|
|
Save object locally
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container></command></term>
|
|
<listitem>
|
|
<para>
|
|
Download <object> from <container>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><object></command></term>
|
|
<listitem>
|
|
<para>
|
|
Object to save
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--file <filename></command></term>
|
|
<listitem>
|
|
<para>
|
|
Destination filename (defaults to object name)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_object_set_with_identity_api_v2">
|
|
<title>openstack object set</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 object set [-h] --property <key=value> <container> <object></computeroutput></screen>
|
|
<para>
|
|
Set object properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container></command></term>
|
|
<listitem>
|
|
<para>
|
|
Modify <object> from <container>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><object></command></term>
|
|
<listitem>
|
|
<para>
|
|
Object to modify
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set a property on this object (repeat option to set
|
|
multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_object_show_with_identity_api_v2">
|
|
<title>openstack object show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 object show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX]
|
|
<container> <object></computeroutput></screen>
|
|
<para>
|
|
Display object details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container></command></term>
|
|
<listitem>
|
|
<para>
|
|
Display <object> from <container>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><object></command></term>
|
|
<listitem>
|
|
<para>
|
|
Object to display
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_object_store_account_set_with_identity_api_v2">
|
|
<title>openstack object store account set</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 object store account set [-h] --property <key=value></computeroutput></screen>
|
|
<para>
|
|
Set account properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set a property on this account (repeat option to set
|
|
multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_object_store_account_show_with_identity_api_v2">
|
|
<title>openstack object store account show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 object store account show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]</computeroutput></screen>
|
|
<para>
|
|
Display account details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_object_store_account_unset_with_identity_api_v2">
|
|
<title>openstack object store account unset</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 object store account unset [-h] --property <key></computeroutput></screen>
|
|
<para>
|
|
Unset account properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property to remove from account (repeat option to remove
|
|
multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_object_unset_with_identity_api_v2">
|
|
<title>openstack object unset</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 object unset [-h] --property <key> <container> <object></computeroutput></screen>
|
|
<para>
|
|
Unset object properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container></command></term>
|
|
<listitem>
|
|
<para>
|
|
Modify <object> from <container>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><object></command></term>
|
|
<listitem>
|
|
<para>
|
|
Object to modify
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property to remove from object (repeat option to remove
|
|
multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_project_create_with_identity_api_v2">
|
|
<title>openstack project create</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 project create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
[--description <description>]
|
|
[--enable | --disable]
|
|
[--property <key=value>] [--or-show]
|
|
<project-name></computeroutput></screen>
|
|
<para>
|
|
Create new project
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><project-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New project name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Project description
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--enable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Enable project (default)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disable project
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Add a property to <name> (repeat option to set
|
|
multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--or-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Return existing project
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_project_delete_with_identity_api_v2">
|
|
<title>openstack project delete</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 project delete [-h] <project> [<project> ...]</computeroutput></screen>
|
|
<para>
|
|
Delete project(s)
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Project(s) to delete (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_project_list_with_identity_api_v2">
|
|
<title>openstack project list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 project list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}] [--long]</computeroutput></screen>
|
|
<para>
|
|
List projects
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--long</command></term>
|
|
<listitem>
|
|
<para>
|
|
List additional fields in output
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_project_set_with_identity_api_v2">
|
|
<title>openstack project set</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 project set [-h] [--name <name>]
|
|
[--description <description>]
|
|
[--enable | --disable] [--property <key=value>]
|
|
<project></computeroutput></screen>
|
|
<para>
|
|
Set project properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Project to modify (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set project name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set project description
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--enable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Enable project
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disable project
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set a project property (repeat option to set multiple
|
|
properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_project_show_with_identity_api_v2">
|
|
<title>openstack project show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 project show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX]
|
|
<project></computeroutput></screen>
|
|
<para>
|
|
Display project details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Project to display (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_project_usage_list_with_identity_api_v2">
|
|
<title>openstack project usage list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 project usage list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--start <start>] [--end <end>]</computeroutput></screen>
|
|
<para>
|
|
List resource usage per project
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--start <start></command></term>
|
|
<listitem>
|
|
<para>
|
|
Usage range start date, ex 2012-01-20 (default: 4
|
|
weeks ago)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--end <end></command></term>
|
|
<listitem>
|
|
<para>
|
|
Usage range end date, ex 2012-01-20 (default:
|
|
tomorrow)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_quota_set_with_identity_api_v2">
|
|
<title>openstack quota set</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 quota set [-h] [--class] [--properties <properties>]
|
|
[--ram <ram>] [--secgroup-rules <secgroup-rules>]
|
|
[--instances <instances>] [--key-pairs <key-pairs>]
|
|
[--fixed-ips <fixed-ips>] [--secgroups <secgroups>]
|
|
[--injected-file-size <injected-file-size>]
|
|
[--floating-ips <floating-ips>]
|
|
[--injected-files <injected-files>]
|
|
[--cores <cores>]
|
|
[--injected-path-size <injected-path-size>]
|
|
[--gigabytes <gigabytes>] [--volumes <volumes>]
|
|
[--snapshots <snapshots>]
|
|
[--volume-type <volume-type>]
|
|
<project/class></computeroutput></screen>
|
|
<para>
|
|
Set quotas for project or class
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><project/class></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set quotas for this project or class (name/ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--class</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set quotas for <class>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--properties <properties></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the properties quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ram <ram></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the ram quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--secgroup-rules <secgroup-rules></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the secgroup-rules quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--instances <instances></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the instances quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--key-pairs <key-pairs></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the key-pairs quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--fixed-ips <fixed-ips></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the fixed-ips quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--secgroups <secgroups></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the secgroups quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--injected-file-size <injected-file-size></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the injected-file-size quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--floating-ips <floating-ips></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the floating-ips quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--injected-files <injected-files></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the injected-files quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--cores <cores></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the cores quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--injected-path-size <injected-path-size></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the injected-path-size quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--gigabytes <gigabytes></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the gigabytes quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--volumes <volumes></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the volumes quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--snapshots <snapshots></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the snapshots quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--volume-type <volume-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set quotas for a specific <volume-type>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_quota_show_with_identity_api_v2">
|
|
<title>openstack quota show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 quota show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX] [--class | --default]
|
|
<project/class></computeroutput></screen>
|
|
<para>
|
|
Show quotas for project or class
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><project/class></command></term>
|
|
<listitem>
|
|
<para>
|
|
Show this project or class (name/ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--class</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show quotas for <class>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--default</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show default quotas for <project>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_role_add_with_identity_api_v2">
|
|
<title>openstack role add</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 role add [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX] --project <project> --user <user>
|
|
<role></computeroutput></screen>
|
|
<para>
|
|
Add role to project:user
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><role></command></term>
|
|
<listitem>
|
|
<para>
|
|
Role to add to <project>:<user> (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Include <project> (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user <user></command></term>
|
|
<listitem>
|
|
<para>
|
|
Include <user> (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_role_create_with_identity_api_v2">
|
|
<title>openstack role create</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 role create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX] [--or-show]
|
|
<name></computeroutput></screen>
|
|
<para>
|
|
Create new role
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New role name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--or-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Return existing role
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_role_delete_with_identity_api_v2">
|
|
<title>openstack role delete</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 role delete [-h] <role> [<role> ...]</computeroutput></screen>
|
|
<para>
|
|
Delete role(s)
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><role></command></term>
|
|
<listitem>
|
|
<para>
|
|
Role(s) to delete (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_role_list_with_identity_api_v2">
|
|
<title>openstack role list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 role list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--project <project>] [--user <user>]</computeroutput></screen>
|
|
<para>
|
|
List roles
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter roles by <project> (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user <user></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter roles by <user> (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_role_remove_with_identity_api_v2">
|
|
<title>openstack role remove</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 role remove [-h] --project <project> --user <user> <role></computeroutput></screen>
|
|
<para>
|
|
Remove role from project : user
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><role></command></term>
|
|
<listitem>
|
|
<para>
|
|
Role to remove (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Include <project> (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user <user></command></term>
|
|
<listitem>
|
|
<para>
|
|
Include <user> (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_role_show_with_identity_api_v2">
|
|
<title>openstack role show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 role show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX]
|
|
<role></computeroutput></screen>
|
|
<para>
|
|
Display role details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><role></command></term>
|
|
<listitem>
|
|
<para>
|
|
Role to display (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_security_group_create_with_identity_api_v2">
|
|
<title>openstack security group create</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 security group create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
[--description <description>]
|
|
<name></computeroutput></screen>
|
|
<para>
|
|
Create a new security group
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New security group name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Security group description
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_security_group_delete_with_identity_api_v2">
|
|
<title>openstack security group delete</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 security group delete [-h] <group></computeroutput></screen>
|
|
<para>
|
|
Delete a security group
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><group></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of security group to delete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_security_group_list_with_identity_api_v2">
|
|
<title>openstack security group list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 security group list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--all-projects]</computeroutput></screen>
|
|
<para>
|
|
List all security groups
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--all-projects</command></term>
|
|
<listitem>
|
|
<para>
|
|
Display information from all projects (admin only)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_security_group_rule_create_with_identity_api_v2">
|
|
<title>openstack security group rule create</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 security group rule create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
[--proto <proto>]
|
|
[--src-ip <ip-address>]
|
|
[--dst-port <port-range>]
|
|
<group></computeroutput></screen>
|
|
<para>
|
|
Create a new security group rule
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><group></command></term>
|
|
<listitem>
|
|
<para>
|
|
Create rule in this security group
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--proto <proto></command></term>
|
|
<listitem>
|
|
<para>
|
|
IP protocol (icmp, tcp, udp; default: tcp)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--src-ip <ip-address></command></term>
|
|
<listitem>
|
|
<para>
|
|
Source IP (may use CIDR notation; default: 0.0.0.0/0)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--dst-port <port-range></command></term>
|
|
<listitem>
|
|
<para>
|
|
Destination port, may be a range: 137:139 (default: 0;
|
|
only required for proto tcp and udp)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_security_group_rule_delete_with_identity_api_v2">
|
|
<title>openstack security group rule delete</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 security group rule delete [-h] <rule></computeroutput></screen>
|
|
<para>
|
|
Delete a security group rule
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><rule></command></term>
|
|
<listitem>
|
|
<para>
|
|
Security group rule ID to delete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_security_group_rule_list_with_identity_api_v2">
|
|
<title>openstack security group rule list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 security group rule list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
<group></computeroutput></screen>
|
|
<para>
|
|
List all security group rules
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><group></command></term>
|
|
<listitem>
|
|
<para>
|
|
List all rules in this security group
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_security_group_set_with_identity_api_v2">
|
|
<title>openstack security group set</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 security group set [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
[--name <new-name>]
|
|
[--description <description>]
|
|
<group></computeroutput></screen>
|
|
<para>
|
|
Set security group properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><group></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of security group to change
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <new-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New security group name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
New security group name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_security_group_show_with_identity_api_v2">
|
|
<title>openstack security group show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 security group show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
<group></computeroutput></screen>
|
|
<para>
|
|
Show a specific security group
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><group></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of security group to change
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_add_security_group_with_identity_api_v2">
|
|
<title>openstack server add security group</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 server add security group [-h] <server> <group></computeroutput></screen>
|
|
<para>
|
|
Add security group to server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><group></command></term>
|
|
<listitem>
|
|
<para>
|
|
Security group to add (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_add_volume_with_identity_api_v2">
|
|
<title>openstack server add volume</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 server add volume [-h] [--device <device>] <server> <volume></computeroutput></screen>
|
|
<para>
|
|
Add volume to server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume to add (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--device <device></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server internal device name for volume
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_create_with_identity_api_v2">
|
|
<title>openstack server create</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 server create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
(--image <image> | --volume <volume>) --flavor
|
|
<flavor>
|
|
[--security-group <security-group-name>]
|
|
[--key-name <key-name>]
|
|
[--property <key=value>]
|
|
[--file <dest-filename=source-filename>]
|
|
[--user-data <user-data>]
|
|
[--availability-zone <zone-name>]
|
|
[--block-device-mapping <dev-name=mapping>]
|
|
[--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid>]
|
|
[--hint <key=value>]
|
|
[--config-drive <config-drive-volume>|True]
|
|
[--min <count>] [--max <count>] [--wait]
|
|
<server-name></computeroutput></screen>
|
|
<para>
|
|
Create a new server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New server name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--image <image></command></term>
|
|
<listitem>
|
|
<para>
|
|
Create server from this image
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--volume <volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Create server from this volume
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--flavor <flavor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Create server with this flavor
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--security-group <security-group-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Security group to assign to this server (repeat for
|
|
multiple groups)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--key-name <key-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Keypair to inject into this server (optional
|
|
extension)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set a property on this server (repeat for multiple
|
|
values)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--file <dest-filename=source-filename></command></term>
|
|
<listitem>
|
|
<para>
|
|
File to inject into image before boot (repeat for
|
|
multiple files)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user-data <user-data></command></term>
|
|
<listitem>
|
|
<para>
|
|
User data file to serve from the metadata server
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--availability-zone <zone-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Select an availability zone for the server
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--block-device-mapping <dev-name=mapping></command></term>
|
|
<listitem>
|
|
<para>
|
|
Map block devices; map is
|
|
<id>:<type>:<size(GB)>:<delete_on_terminate> (optional
|
|
extension)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid></command></term>
|
|
<listitem>
|
|
<para>
|
|
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).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--hint <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Hints for the scheduler (optional extension)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--config-drive <config-drive-volume>|True</command></term>
|
|
<listitem>
|
|
<para>
|
|
Use specified volume as the config drive, or 'True' to
|
|
use an ephemeral drive
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--min <count></command></term>
|
|
<listitem>
|
|
<para>
|
|
Minimum number of servers to launch (default=1)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--max <count></command></term>
|
|
<listitem>
|
|
<para>
|
|
Maximum number of servers to launch (default=1)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--wait</command></term>
|
|
<listitem>
|
|
<para>
|
|
Wait for build to complete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_delete_with_identity_api_v2">
|
|
<title>openstack server delete</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 server delete [-h] [--wait] <server> [<server> ...]</computeroutput></screen>
|
|
<para>
|
|
Delete server(s)
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server(s) to delete (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--wait</command></term>
|
|
<listitem>
|
|
<para>
|
|
Wait for delete to complete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_image_create_with_identity_api_v2">
|
|
<title>openstack server image create</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 server image create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
[--name <image-name>] [--wait]
|
|
<server></computeroutput></screen>
|
|
<para>
|
|
Create a new disk image from a running server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <image-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of new image (default is server name)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--wait</command></term>
|
|
<listitem>
|
|
<para>
|
|
Wait for image create to complete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_list_with_identity_api_v2">
|
|
<title>openstack server list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 server list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--reservation-id <reservation-id>]
|
|
[--ip <ip-address-regex>]
|
|
[--ip6 <ip-address-regex>] [--name <name-regex>]
|
|
[--instance-name <server-name>]
|
|
[--status <status>] [--flavor <flavor>]
|
|
[--image <image>] [--host <hostname>]
|
|
[--all-projects] [--project <project>]
|
|
[--project-domain <project-domain>]
|
|
[--user <user>] [--user-domain <user-domain>]
|
|
[--long]</computeroutput></screen>
|
|
<para>
|
|
List servers
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--reservation-id <reservation-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Only return instances that match the reservation
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ip <ip-address-regex></command></term>
|
|
<listitem>
|
|
<para>
|
|
Regular expression to match IP addresses
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ip6 <ip-address-regex></command></term>
|
|
<listitem>
|
|
<para>
|
|
Regular expression to match IPv6 addresses
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name-regex></command></term>
|
|
<listitem>
|
|
<para>
|
|
Regular expression to match names
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--instance-name <server-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Regular expression to match instance name (admin only)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--status <status></command></term>
|
|
<listitem>
|
|
<para>
|
|
Search by server status
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--flavor <flavor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Search by flavor
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--image <image></command></term>
|
|
<listitem>
|
|
<para>
|
|
Search by image
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--host <hostname></command></term>
|
|
<listitem>
|
|
<para>
|
|
Search by hostname
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--all-projects</command></term>
|
|
<listitem>
|
|
<para>
|
|
Include all projects (admin only)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Search by project (admin only) (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project-domain <project-domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain the project belongs to (name or ID). This can
|
|
be used in case collisions between project names
|
|
exist.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user <user></command></term>
|
|
<listitem>
|
|
<para>
|
|
Search by user (admin only) (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user-domain <user-domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain the user belongs to (name or ID). This can be
|
|
used in case collisions between user names exist.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--long</command></term>
|
|
<listitem>
|
|
<para>
|
|
List additional fields in output
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_lock_with_identity_api_v2">
|
|
<title>openstack server lock</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 server lock [-h] <server></computeroutput></screen>
|
|
<para>
|
|
Lock a server. A non-admin user will not be able to execute actions
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_migrate_with_identity_api_v2">
|
|
<title>openstack server migrate</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 server migrate [-h] [--live <hostname>]
|
|
[--shared-migration | --block-migration]
|
|
[--disk-overcommit | --no-disk-overcommit]
|
|
[--wait]
|
|
<server></computeroutput></screen>
|
|
<para>
|
|
Migrate server to different host
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--live <hostname></command></term>
|
|
<listitem>
|
|
<para>
|
|
Target hostname
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--shared-migration</command></term>
|
|
<listitem>
|
|
<para>
|
|
Perform a shared live migration (default)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--block-migration</command></term>
|
|
<listitem>
|
|
<para>
|
|
Perform a block live migration
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disk-overcommit</command></term>
|
|
<listitem>
|
|
<para>
|
|
Allow disk over-commit on the destination host
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--no-disk-overcommit</command></term>
|
|
<listitem>
|
|
<para>
|
|
Do not over-commit disk on the destination host
|
|
(default)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--wait</command></term>
|
|
<listitem>
|
|
<para>
|
|
Wait for resize to complete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_pause_with_identity_api_v2">
|
|
<title>openstack server pause</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 server pause [-h] <server></computeroutput></screen>
|
|
<para>
|
|
Pause server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_reboot_with_identity_api_v2">
|
|
<title>openstack server reboot</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 server reboot [-h] [--hard | --soft] [--wait] <server></computeroutput></screen>
|
|
<para>
|
|
Perform a hard or soft server reboot
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--hard</command></term>
|
|
<listitem>
|
|
<para>
|
|
Perform a hard reboot
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--soft</command></term>
|
|
<listitem>
|
|
<para>
|
|
Perform a soft reboot
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--wait</command></term>
|
|
<listitem>
|
|
<para>
|
|
Wait for reboot to complete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_rebuild_with_identity_api_v2">
|
|
<title>openstack server rebuild</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 server rebuild [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX] --image <image>
|
|
[--password <password>] [--wait]
|
|
<server></computeroutput></screen>
|
|
<para>
|
|
Rebuild server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--image <image></command></term>
|
|
<listitem>
|
|
<para>
|
|
Recreate server from this image
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--password <password></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set the password on the rebuilt instance
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--wait</command></term>
|
|
<listitem>
|
|
<para>
|
|
Wait for rebuild to complete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_remove_security_group_with_identity_api_v2">
|
|
<title>openstack server remove security group</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 server remove security group [-h] <server> <group></computeroutput></screen>
|
|
<para>
|
|
Remove security group from server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server to use
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><group></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of security group to remove from server
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_remove_volume_with_identity_api_v2">
|
|
<title>openstack server remove volume</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 server remove volume [-h] <server> <volume></computeroutput></screen>
|
|
<para>
|
|
Remove volume from server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume to remove (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_rescue_with_identity_api_v2">
|
|
<title>openstack server rescue</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 server rescue [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
<server></computeroutput></screen>
|
|
<para>
|
|
Put server in rescue mode
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_resize_with_identity_api_v2">
|
|
<title>openstack server resize</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 server resize [-h] [--flavor <flavor> | --confirm | --revert]
|
|
[--wait]
|
|
<server></computeroutput></screen>
|
|
<para>
|
|
Scale server to a new flavor
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--flavor <flavor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Resize server to specified flavor
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--confirm</command></term>
|
|
<listitem>
|
|
<para>
|
|
Confirm server resize is complete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--revert</command></term>
|
|
<listitem>
|
|
<para>
|
|
Restore server state before resize
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--wait</command></term>
|
|
<listitem>
|
|
<para>
|
|
Wait for resize to complete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_resume_with_identity_api_v2">
|
|
<title>openstack server resume</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 server resume [-h] <server></computeroutput></screen>
|
|
<para>
|
|
Resume server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_set_with_identity_api_v2">
|
|
<title>openstack server set</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 server set [-h] [--name <new-name>] [--root-password]
|
|
[--property <key=value>]
|
|
<server></computeroutput></screen>
|
|
<para>
|
|
Set server properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <new-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New server name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--root-password</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set new root password (interactive only)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property to add/change for this server (repeat option
|
|
to set multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_show_with_identity_api_v2">
|
|
<title>openstack server show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 server show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX] [--diagnostics]
|
|
<server></computeroutput></screen>
|
|
<para>
|
|
Show server details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--diagnostics</command></term>
|
|
<listitem>
|
|
<para>
|
|
Display server diagnostics information
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_ssh_with_identity_api_v2">
|
|
<title>openstack server ssh</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 server ssh [-h] [--login <login-name>] [--port <port>]
|
|
[--identity <keyfile>] [--option <config-options>]
|
|
[-4 | -6]
|
|
[--public | --private | --address-type <address-type>]
|
|
<server></computeroutput></screen>
|
|
<para>
|
|
Ssh to server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--login <login-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Login name (ssh -l option)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--port <port></command></term>
|
|
<listitem>
|
|
<para>
|
|
Destination port (ssh -p option)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--identity <keyfile></command></term>
|
|
<listitem>
|
|
<para>
|
|
Private key file (ssh -i option)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--option <config-options></command></term>
|
|
<listitem>
|
|
<para>
|
|
Options in ssh_config(5) format (ssh -o option)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-4</command></term>
|
|
<listitem>
|
|
<para>
|
|
Use only IPv4 addresses
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-6</command></term>
|
|
<listitem>
|
|
<para>
|
|
Use only IPv6 addresses
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--public</command></term>
|
|
<listitem>
|
|
<para>
|
|
Use public IP address
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--private</command></term>
|
|
<listitem>
|
|
<para>
|
|
Use private IP address
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--address-type <address-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Use other IP address (public, private, etc)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_suspend_with_identity_api_v2">
|
|
<title>openstack server suspend</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 server suspend [-h] <server></computeroutput></screen>
|
|
<para>
|
|
Suspend server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_unlock_with_identity_api_v2">
|
|
<title>openstack server unlock</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 server unlock [-h] <server></computeroutput></screen>
|
|
<para>
|
|
Unlock server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_unpause_with_identity_api_v2">
|
|
<title>openstack server unpause</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 server unpause [-h] <server></computeroutput></screen>
|
|
<para>
|
|
Unpause server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_unrescue_with_identity_api_v2">
|
|
<title>openstack server unrescue</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 server unrescue [-h] <server></computeroutput></screen>
|
|
<para>
|
|
Restore server from rescue mode
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_unset_with_identity_api_v2">
|
|
<title>openstack server unset</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 server unset [-h] [--property <key>] <server></computeroutput></screen>
|
|
<para>
|
|
Unset server properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property key to remove from server (repeat to unset
|
|
multiple values)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_service_create_with_identity_api_v2">
|
|
<title>openstack service create</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 service create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX] [--name <name>]
|
|
[--description <description>]
|
|
<type></computeroutput></screen>
|
|
<para>
|
|
Create new service
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><type></command></term>
|
|
<listitem>
|
|
<para>
|
|
New service type (compute, image, identity, volume,
|
|
etc)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New service name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
New service description
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_service_delete_with_identity_api_v2">
|
|
<title>openstack service delete</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 service delete [-h] <service></computeroutput></screen>
|
|
<para>
|
|
Delete service
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><service></command></term>
|
|
<listitem>
|
|
<para>
|
|
Service to delete (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_service_list_with_identity_api_v2">
|
|
<title>openstack service list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 service list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}] [--long]</computeroutput></screen>
|
|
<para>
|
|
List services
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--long</command></term>
|
|
<listitem>
|
|
<para>
|
|
List additional fields in output
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_service_show_with_identity_api_v2">
|
|
<title>openstack service show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 service show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX] [--catalog]
|
|
<service></computeroutput></screen>
|
|
<para>
|
|
Display service details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><service></command></term>
|
|
<listitem>
|
|
<para>
|
|
Service to display (type, name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--catalog</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show service catalog information
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_snapshot_create_with_identity_api_v2">
|
|
<title>openstack snapshot create</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 snapshot create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX] --name <name>
|
|
[--description <description>] [--force]
|
|
<volume></computeroutput></screen>
|
|
<para>
|
|
Create new snapshot
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume to snapshot (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the snapshot
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Description of the snapshot
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--force</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a snapshot attached to an instance. Default is
|
|
False
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_snapshot_delete_with_identity_api_v2">
|
|
<title>openstack snapshot delete</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 snapshot delete [-h] <snapshot> [<snapshot> ...]</computeroutput></screen>
|
|
<para>
|
|
Delete snapshot(s)
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><snapshot></command></term>
|
|
<listitem>
|
|
<para>
|
|
Snapshot(s) to delete (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_snapshot_list_with_identity_api_v2">
|
|
<title>openstack snapshot list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 snapshot list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--long]</computeroutput></screen>
|
|
<para>
|
|
List snapshots
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--long</command></term>
|
|
<listitem>
|
|
<para>
|
|
List additional fields in output
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_snapshot_set_with_identity_api_v2">
|
|
<title>openstack snapshot set</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 snapshot set [-h] [--name <name>]
|
|
[--description <description>]
|
|
[--property <key=value>]
|
|
<snapshot></computeroutput></screen>
|
|
<para>
|
|
Set snapshot properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><snapshot></command></term>
|
|
<listitem>
|
|
<para>
|
|
Snapshot to modify (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New snapshot name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
New snapshot description
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property to add/change for this snapshot (repeat
|
|
option to set multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_snapshot_show_with_identity_api_v2">
|
|
<title>openstack snapshot show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 snapshot show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
<snapshot></computeroutput></screen>
|
|
<para>
|
|
Display snapshot details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><snapshot></command></term>
|
|
<listitem>
|
|
<para>
|
|
Snapshot to display (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_snapshot_unset_with_identity_api_v2">
|
|
<title>openstack snapshot unset</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 snapshot unset [-h] --property <key> <snapshot></computeroutput></screen>
|
|
<para>
|
|
Unset snapshot properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><snapshot></command></term>
|
|
<listitem>
|
|
<para>
|
|
Snapshot to modify (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property to remove from snapshot (repeat to remove
|
|
multiple values)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_token_issue_with_identity_api_v2">
|
|
<title>openstack token issue</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 token issue [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX]</computeroutput></screen>
|
|
<para>
|
|
Issue new token
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_token_revoke_with_identity_api_v2">
|
|
<title>openstack token revoke</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 token revoke [-h] <token></computeroutput></screen>
|
|
<para>
|
|
Revoke existing token
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><token></command></term>
|
|
<listitem>
|
|
<para>
|
|
Token to be deleted
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_usage_list_with_identity_api_v2">
|
|
<title>openstack usage list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 usage list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--start <start>] [--end <end>]</computeroutput></screen>
|
|
<para>
|
|
List resource usage per project
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--start <start></command></term>
|
|
<listitem>
|
|
<para>
|
|
Usage range start date, ex 2012-01-20 (default: 4
|
|
weeks ago)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--end <end></command></term>
|
|
<listitem>
|
|
<para>
|
|
Usage range end date, ex 2012-01-20 (default:
|
|
tomorrow)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_usage_show_with_identity_api_v2">
|
|
<title>openstack usage show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 usage show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX] [--project <project>]
|
|
[--start <start>] [--end <end>]</computeroutput></screen>
|
|
<para>
|
|
Show resource usage for a single project
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of project to show usage for
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--start <start></command></term>
|
|
<listitem>
|
|
<para>
|
|
Usage range start date, ex 2012-01-20 (default: 4
|
|
weeks ago)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--end <end></command></term>
|
|
<listitem>
|
|
<para>
|
|
Usage range end date, ex 2012-01-20 (default:
|
|
tomorrow)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_user_create_with_identity_api_v2">
|
|
<title>openstack user create</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 user create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX] [--project <project>]
|
|
[--password <password>] [--password-prompt]
|
|
[--email <email-address>] [--enable | --disable]
|
|
[--or-show]
|
|
<name></computeroutput></screen>
|
|
<para>
|
|
Create new user
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New user name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Default project (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--password <password></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set user password
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--password-prompt</command></term>
|
|
<listitem>
|
|
<para>
|
|
Prompt interactively for password
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--email <email-address></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set user email address
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--enable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Enable user (default)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disable user
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--or-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Return existing user
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_user_delete_with_identity_api_v2">
|
|
<title>openstack user delete</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 user delete [-h] <user> [<user> ...]</computeroutput></screen>
|
|
<para>
|
|
Delete user(s)
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><user></command></term>
|
|
<listitem>
|
|
<para>
|
|
User(s) to delete (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_user_list_with_identity_api_v2">
|
|
<title>openstack user list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 user list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--project <project>] [--long]</computeroutput></screen>
|
|
<para>
|
|
List users
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter users by project (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--long</command></term>
|
|
<listitem>
|
|
<para>
|
|
List additional fields in output
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_user_role_list_with_identity_api_v2">
|
|
<title>openstack user role list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 user role list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--project <project>]
|
|
[<user>]</computeroutput></screen>
|
|
<para>
|
|
List user-role assignments
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><user></command></term>
|
|
<listitem>
|
|
<para>
|
|
User to list (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter users by <project> (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_user_set_with_identity_api_v2">
|
|
<title>openstack user set</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 user set [-h] [--name <name>] [--project <project>]
|
|
[--password <user-password>] [--password-prompt]
|
|
[--email <email-address>] [--enable | --disable]
|
|
<user></computeroutput></screen>
|
|
<para>
|
|
Set user properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><user></command></term>
|
|
<listitem>
|
|
<para>
|
|
User to change (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set user name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set default project (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--password <user-password></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set user password
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--password-prompt</command></term>
|
|
<listitem>
|
|
<para>
|
|
Prompt interactively for password
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--email <email-address></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set user email address
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--enable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Enable user (default)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disable user
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_user_show_with_identity_api_v2">
|
|
<title>openstack user show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 user show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX]
|
|
<user></computeroutput></screen>
|
|
<para>
|
|
Display user details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><user></command></term>
|
|
<listitem>
|
|
<para>
|
|
User to display (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_volume_create_with_identity_api_v2">
|
|
<title>openstack volume create</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 volume create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX] --size <size>
|
|
[--snapshot <snapshot>]
|
|
[--description <description>]
|
|
[--type <volume-type>] [--user <user>]
|
|
[--project <project>]
|
|
[--availability-zone <availability-zone>]
|
|
[--image <image>] [--source <volume>]
|
|
[--property <key=value>]
|
|
<name></computeroutput></screen>
|
|
<para>
|
|
Create new volume
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New volume name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--size <size></command></term>
|
|
<listitem>
|
|
<para>
|
|
New volume size in GB
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--snapshot <snapshot></command></term>
|
|
<listitem>
|
|
<para>
|
|
Use <snapshot> as source of new volume
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
New volume description
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--type <volume-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Use <volume-type> as the new volume type
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user <user></command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify an alternate user (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify an alternate project (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--availability-zone <availability-zone></command></term>
|
|
<listitem>
|
|
<para>
|
|
Create new volume in <availability-zone>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--image <image></command></term>
|
|
<listitem>
|
|
<para>
|
|
Use <image> as source of new volume (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--source <volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume to clone (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set a property on this volume (repeat option to set
|
|
multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_volume_delete_with_identity_api_v2">
|
|
<title>openstack volume delete</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 volume delete [-h] [--force] <volume> [<volume> ...]</computeroutput></screen>
|
|
<para>
|
|
Delete volume(s)
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume(s) to delete (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--force</command></term>
|
|
<listitem>
|
|
<para>
|
|
Attempt forced removal of volume(s), regardless of state
|
|
(defaults to False)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_volume_list_with_identity_api_v2">
|
|
<title>openstack volume list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 volume list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--name <name>] [--status <status>]
|
|
[--all-projects] [--long]</computeroutput></screen>
|
|
<para>
|
|
List volumes
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter results by volume name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--status <status></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter results by status
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--all-projects</command></term>
|
|
<listitem>
|
|
<para>
|
|
Include all projects (admin only)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--long</command></term>
|
|
<listitem>
|
|
<para>
|
|
List additional fields in output
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_volume_qos_associate_with_identity_api_v2">
|
|
<title>openstack volume qos associate</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos associate [-h] <qos-spec> <volume-type></computeroutput></screen>
|
|
<para>
|
|
Associate a QoS specification to a volume type
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><qos-spec></command></term>
|
|
<listitem>
|
|
<para>
|
|
QoS specification to modify (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><volume-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume type to associate the QoS (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_volume_qos_create_with_identity_api_v2">
|
|
<title>openstack volume qos create</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
[--consumer <consumer>]
|
|
[--property <key=value>]
|
|
<name></computeroutput></screen>
|
|
<para>
|
|
Create new QoS specification
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New QoS specification name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--consumer <consumer></command></term>
|
|
<listitem>
|
|
<para>
|
|
Consumer of the QoS. Valid consumers: back-end, both,
|
|
front-end (defaults to 'both')
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set a QoS specification property (repeat option to set
|
|
multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_volume_qos_delete_with_identity_api_v2">
|
|
<title>openstack volume qos delete</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos delete [-h] <qos-spec> [<qos-spec> ...]</computeroutput></screen>
|
|
<para>
|
|
Delete QoS specification
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><qos-spec></command></term>
|
|
<listitem>
|
|
<para>
|
|
QoS specification(s) to delete (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_volume_qos_disassociate_with_identity_api_v2">
|
|
<title>openstack volume qos disassociate</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos disassociate [-h]
|
|
[--volume-type <volume-type> | --all]
|
|
<qos-spec></computeroutput></screen>
|
|
<para>
|
|
Disassociate a QoS specification from a volume type
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><qos-spec></command></term>
|
|
<listitem>
|
|
<para>
|
|
QoS specification to modify (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--volume-type <volume-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume type to disassociate the QoS from (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--all</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disassociate the QoS from every volume type
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_volume_qos_list_with_identity_api_v2">
|
|
<title>openstack volume qos list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
|
|
<para>
|
|
List QoS specifications
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_volume_qos_set_with_identity_api_v2">
|
|
<title>openstack volume qos set</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos set [-h] [--property <key=value>] <qos-spec></computeroutput></screen>
|
|
<para>
|
|
Set QoS specification properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><qos-spec></command></term>
|
|
<listitem>
|
|
<para>
|
|
QoS specification to modify (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property to add or modify for this QoS specification
|
|
(repeat option to set multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_volume_qos_show_with_identity_api_v2">
|
|
<title>openstack volume qos show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
<qos-spec></computeroutput></screen>
|
|
<para>
|
|
Display QoS specification details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><qos-spec></command></term>
|
|
<listitem>
|
|
<para>
|
|
QoS specification to display (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_volume_qos_unset_with_identity_api_v2">
|
|
<title>openstack volume qos unset</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 volume qos unset [-h] [--property <key>] <qos-spec></computeroutput></screen>
|
|
<para>
|
|
Unset QoS specification properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><qos-spec></command></term>
|
|
<listitem>
|
|
<para>
|
|
QoS specification to modify (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property to remove from the QoS specification. (repeat
|
|
option to unset multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_volume_set_with_identity_api_v2">
|
|
<title>openstack volume set</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 volume set [-h] [--name <name>] [--description <description>]
|
|
[--size <size>] [--property <key=value>]
|
|
<volume></computeroutput></screen>
|
|
<para>
|
|
Set volume properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume to change (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New volume name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
New volume description
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--size <size></command></term>
|
|
<listitem>
|
|
<para>
|
|
Extend volume size in GB
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property to add or modify for this volume (repeat
|
|
option to set multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_volume_show_with_identity_api_v2">
|
|
<title>openstack volume show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 volume show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX]
|
|
<volume></computeroutput></screen>
|
|
<para>
|
|
Show volume details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume to display (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_volume_type_create_with_identity_api_v2">
|
|
<title>openstack volume type create</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 volume type create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
[--property <key=value>]
|
|
<name></computeroutput></screen>
|
|
<para>
|
|
Create new volume type
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New volume type name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property to add for this volume type (repeat option to
|
|
set multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_volume_type_delete_with_identity_api_v2">
|
|
<title>openstack volume type delete</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 volume type delete [-h] <volume-type></computeroutput></screen>
|
|
<para>
|
|
Delete volume type
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume type to delete (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_volume_type_list_with_identity_api_v2">
|
|
<title>openstack volume type list</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 volume type list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--long]</computeroutput></screen>
|
|
<para>
|
|
List volume types
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--long</command></term>
|
|
<listitem>
|
|
<para>
|
|
List additional fields in output
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_volume_type_set_with_identity_api_v2">
|
|
<title>openstack volume type set</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 volume type set [-h] [--property <key=value>] <volume-type></computeroutput></screen>
|
|
<para>
|
|
Set volume type properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume type to modify (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property to add or modify for this volume type (repeat
|
|
option to set multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_volume_type_show_with_identity_api_v2">
|
|
<title>openstack volume type show</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 volume type show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
<volume-type></computeroutput></screen>
|
|
<para>
|
|
Display volume type details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume type to display (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_volume_type_unset_with_identity_api_v2">
|
|
<title>openstack volume type unset</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 volume type unset [-h] --property <key> <volume-type></computeroutput></screen>
|
|
<para>
|
|
Unset volume type properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume type to modify (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property to remove from volume type (repeat option to
|
|
remove multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_volume_unset_with_identity_api_v2">
|
|
<title>openstack volume unset</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 2 volume unset [-h] --property <key> <volume></computeroutput></screen>
|
|
<para>
|
|
Unset volume properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume to modify (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property to remove from volume (repeat option to remove
|
|
multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
<section xml:id="openstack_cli_with_identity_api_v3">
|
|
<title>OpenStack with Identity API v3 commands (diff)</title>
|
|
<para>
|
|
You can select the Identity API version to use by adding the
|
|
<parameter>--os-identity-api-version</parameter> parameter or by setting
|
|
the corresponding environment variable:
|
|
<screen><prompt>$</prompt> <userinput>export OS_IDENTITY_API_VERSION=3</userinput></screen>
|
|
</para>
|
|
<para>
|
|
This section documents only the difference in subcommands available for the openstack client when the identity API version is changed from v2 to v3.
|
|
</para>
|
|
<section xml:id="openstackclient_subcommand_access_token_create_with_identity_api_v3">
|
|
<title>openstack access token create (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 access token create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
--consumer-key <consumer-key>
|
|
--consumer-secret <consumer-secret>
|
|
--request-key <request-key>
|
|
--request-secret <request-secret>
|
|
--verifier <verifier></computeroutput></screen>
|
|
<para>
|
|
Create an access token
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--consumer-key <consumer-key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Consumer key (required)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--consumer-secret <consumer-secret></command></term>
|
|
<listitem>
|
|
<para>
|
|
Consumer secret (required)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-key <request-key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Request token to exchange for access token (required)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-secret <request-secret></command></term>
|
|
<listitem>
|
|
<para>
|
|
Secret associated with <request-key> (required)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--verifier <verifier></command></term>
|
|
<listitem>
|
|
<para>
|
|
Verifier associated with <request-key> (required)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_consumer_create_with_identity_api_v3">
|
|
<title>openstack consumer create (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 consumer create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
[--description <description>]</computeroutput></screen>
|
|
<para>
|
|
Create new consumer
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
New consumer description
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_consumer_delete_with_identity_api_v3">
|
|
<title>openstack consumer delete (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 consumer delete [-h] <consumer></computeroutput></screen>
|
|
<para>
|
|
Delete consumer
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><consumer></command></term>
|
|
<listitem>
|
|
<para>
|
|
Consumer to delete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_consumer_list_with_identity_api_v3">
|
|
<title>openstack consumer list (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 consumer list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
|
|
<para>
|
|
List consumers
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_consumer_set_with_identity_api_v3">
|
|
<title>openstack consumer set (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 consumer set [-h] [--description <description>] <consumer></computeroutput></screen>
|
|
<para>
|
|
Set consumer properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><consumer></command></term>
|
|
<listitem>
|
|
<para>
|
|
Consumer to modify
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
New consumer description
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_consumer_show_with_identity_api_v3">
|
|
<title>openstack consumer show (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 consumer show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
<consumer></computeroutput></screen>
|
|
<para>
|
|
Display consumer details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><consumer></command></term>
|
|
<listitem>
|
|
<para>
|
|
Consumer to display
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_credential_create_with_identity_api_v3">
|
|
<title>openstack credential create (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 credential create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
[--type <type>] [--project <project>]
|
|
<user> <data></computeroutput></screen>
|
|
<para>
|
|
Create credential command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><user></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of user that owns the credential
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><data></command></term>
|
|
<listitem>
|
|
<para>
|
|
New credential data
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--type <type></command></term>
|
|
<listitem>
|
|
<para>
|
|
New credential type
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Project name or ID which limits the scope of the
|
|
credential
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_credential_delete_with_identity_api_v3">
|
|
<title>openstack credential delete (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 credential delete [-h] <credential-id></computeroutput></screen>
|
|
<para>
|
|
Delete credential command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><credential-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of credential to delete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_credential_list_with_identity_api_v3">
|
|
<title>openstack credential list (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 credential list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
|
|
<para>
|
|
List credential command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_credential_set_with_identity_api_v3">
|
|
<title>openstack credential set (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 credential set [-h] [--user <user>] [--type <type>]
|
|
[--data <data>] [--project <project>]
|
|
<credential-id></computeroutput></screen>
|
|
<para>
|
|
Set credential command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><credential-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of credential to change
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user <user></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of user that owns the credential
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--type <type></command></term>
|
|
<listitem>
|
|
<para>
|
|
New credential type
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--data <data></command></term>
|
|
<listitem>
|
|
<para>
|
|
New credential data
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Project name or ID which limits the scope of the
|
|
credential
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_credential_show_with_identity_api_v3">
|
|
<title>openstack credential show (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 credential show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
<credential-id></computeroutput></screen>
|
|
<para>
|
|
Show credential command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><credential-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of credential to display
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_domain_create_with_identity_api_v3">
|
|
<title>openstack domain create (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 domain create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
[--description <description>]
|
|
[--enable | --disable] [--or-show]
|
|
<domain-name></computeroutput></screen>
|
|
<para>
|
|
Create new domain
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><domain-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New domain name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
New domain description
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--enable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Enable domain (default)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disable domain
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--or-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Return existing domain
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_domain_delete_with_identity_api_v3">
|
|
<title>openstack domain delete (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 domain delete [-h] <domain></computeroutput></screen>
|
|
<para>
|
|
Delete domain
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain to delete (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_domain_list_with_identity_api_v3">
|
|
<title>openstack domain list (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 domain list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
|
|
<para>
|
|
List domains
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_domain_set_with_identity_api_v3">
|
|
<title>openstack domain set (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 domain set [-h] [--name <name>] [--description <description>]
|
|
[--enable | --disable]
|
|
<domain></computeroutput></screen>
|
|
<para>
|
|
Set domain properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain to modify (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New domain name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
New domain description
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--enable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Enable domain
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disable domain
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_domain_show_with_identity_api_v3">
|
|
<title>openstack domain show (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 domain show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX]
|
|
<domain></computeroutput></screen>
|
|
<para>
|
|
Display domain details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain to display (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_endpoint_set_with_identity_api_v3">
|
|
<title>openstack endpoint set (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 endpoint set [-h] [--region <region-id>]
|
|
[--interface <interface>] [--url <url>]
|
|
[--service <service>] [--enable | --disable]
|
|
<endpoint-id></computeroutput></screen>
|
|
<para>
|
|
Set endpoint properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><endpoint-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Endpoint ID to modify
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--region <region-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
New endpoint region ID
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--interface <interface></command></term>
|
|
<listitem>
|
|
<para>
|
|
New endpoint interface type (admin, public or
|
|
internal)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--url <url></command></term>
|
|
<listitem>
|
|
<para>
|
|
New endpoint URL
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--service <service></command></term>
|
|
<listitem>
|
|
<para>
|
|
New endpoint service (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--enable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Enable endpoint
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disable endpoint
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_federation_domain_list_with_identity_api_v3">
|
|
<title>openstack federation domain list (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 federation domain list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
|
|
<para>
|
|
List accessible domains
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_federation_project_list_with_identity_api_v3">
|
|
<title>openstack federation project list (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 federation project list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
|
|
<para>
|
|
List accessible projects
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_federation_protocol_create_with_identity_api_v3">
|
|
<title>openstack federation protocol create (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 federation protocol create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
--identity-provider
|
|
<identity-provider> --mapping
|
|
<mapping>
|
|
<name></computeroutput></screen>
|
|
<para>
|
|
Create new federation protocol
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New federation protocol name (must be unique per
|
|
identity provider)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--identity-provider <identity-provider></command></term>
|
|
<listitem>
|
|
<para>
|
|
Identity provider that will support the new federation
|
|
protocol (name or ID) (required)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--mapping <mapping></command></term>
|
|
<listitem>
|
|
<para>
|
|
Mapping that is to be used (name or ID) (required)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_federation_protocol_delete_with_identity_api_v3">
|
|
<title>openstack federation protocol delete (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 federation protocol delete [-h] --identity-provider
|
|
<identity-provider>
|
|
<federation-protocol></computeroutput></screen>
|
|
<para>
|
|
Delete federation protocol
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><federation-protocol></command></term>
|
|
<listitem>
|
|
<para>
|
|
Federation protocol to delete (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--identity-provider <identity-provider></command></term>
|
|
<listitem>
|
|
<para>
|
|
Identity provider that supports <federation-protocol>
|
|
(name or ID) (required)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_federation_protocol_list_with_identity_api_v3">
|
|
<title>openstack federation protocol list (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 federation protocol list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
--identity-provider
|
|
<identity-provider></computeroutput></screen>
|
|
<para>
|
|
List federation protocols
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--identity-provider <identity-provider></command></term>
|
|
<listitem>
|
|
<para>
|
|
Identity provider to list (name or ID) (required)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_federation_protocol_set_with_identity_api_v3">
|
|
<title>openstack federation protocol set (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 federation protocol set [-h] --identity-provider
|
|
<identity-provider>
|
|
[--mapping <mapping>]
|
|
<name></computeroutput></screen>
|
|
<para>
|
|
Set federation protocol properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Federation protocol to modify (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--identity-provider <identity-provider></command></term>
|
|
<listitem>
|
|
<para>
|
|
Identity provider that supports <federation-protocol>
|
|
(name or ID) (required)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--mapping <mapping></command></term>
|
|
<listitem>
|
|
<para>
|
|
Mapping that is to be used (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_federation_protocol_show_with_identity_api_v3">
|
|
<title>openstack federation protocol show (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 federation protocol show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
--identity-provider
|
|
<identity-provider>
|
|
<federation-protocol></computeroutput></screen>
|
|
<para>
|
|
Display federation protocol details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><federation-protocol></command></term>
|
|
<listitem>
|
|
<para>
|
|
Federation protocol to display (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--identity-provider <identity-provider></command></term>
|
|
<listitem>
|
|
<para>
|
|
Identity provider that supports <federation-protocol>
|
|
(name or ID) (required)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_group_add_user_with_identity_api_v3">
|
|
<title>openstack group add user (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 group add user [-h] [--group-domain <group-domain>]
|
|
[--user-domain <user-domain>]
|
|
<group> <user></computeroutput></screen>
|
|
<para>
|
|
Add user to group
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><group></command></term>
|
|
<listitem>
|
|
<para>
|
|
Group to contain <user> (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><user></command></term>
|
|
<listitem>
|
|
<para>
|
|
User to add to <group> (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--group-domain <group-domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain the group belongs to (name or ID). This can be
|
|
used in case collisions between group names exist.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user-domain <user-domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain the user belongs to (name or ID). This can be
|
|
used in case collisions between user names exist.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_group_contains_user_with_identity_api_v3">
|
|
<title>openstack group contains user (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 group contains user [-h] [--group-domain <group-domain>]
|
|
[--user-domain <user-domain>]
|
|
<group> <user></computeroutput></screen>
|
|
<para>
|
|
Check user membership in group
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><group></command></term>
|
|
<listitem>
|
|
<para>
|
|
Group to check (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><user></command></term>
|
|
<listitem>
|
|
<para>
|
|
User to check (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--group-domain <group-domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain the group belongs to (name or ID). This can be
|
|
used in case collisions between group names exist.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user-domain <user-domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain the user belongs to (name or ID). This can be
|
|
used in case collisions between user names exist.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_group_create_with_identity_api_v3">
|
|
<title>openstack group create (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 group create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX] [--domain <domain>]
|
|
[--description <description>] [--or-show]
|
|
<group-name></computeroutput></screen>
|
|
<para>
|
|
Create new group
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><group-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New group name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--domain <domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain to contain new group (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
New group description
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--or-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Return existing group
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_group_delete_with_identity_api_v3">
|
|
<title>openstack group delete (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 group delete [-h] [--domain <domain>] <group> [<group> ...]</computeroutput></screen>
|
|
<para>
|
|
Delete group(s)
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><group></command></term>
|
|
<listitem>
|
|
<para>
|
|
Group(s) to delete (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--domain <domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain containing group(s) (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_group_list_with_identity_api_v3">
|
|
<title>openstack group list (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 group list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--domain <domain>] [--user <user>]
|
|
[--user-domain <user-domain>] [--long]</computeroutput></screen>
|
|
<para>
|
|
List groups
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--domain <domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter group list by <domain> (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user <user></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter group list by <user> (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user-domain <user-domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain the user belongs to (name or ID). This can be
|
|
used in case collisions between user names exist.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--long</command></term>
|
|
<listitem>
|
|
<para>
|
|
List additional fields in output
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_group_remove_user_with_identity_api_v3">
|
|
<title>openstack group remove user (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 group remove user [-h] [--group-domain <group-domain>]
|
|
[--user-domain <user-domain>]
|
|
<group> <user></computeroutput></screen>
|
|
<para>
|
|
Remove user from group
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><group></command></term>
|
|
<listitem>
|
|
<para>
|
|
Group containing <user> (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><user></command></term>
|
|
<listitem>
|
|
<para>
|
|
User to remove from <group> (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--group-domain <group-domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain the group belongs to (name or ID). This can be
|
|
used in case collisions between group names exist.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user-domain <user-domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain the user belongs to (name or ID). This can be
|
|
used in case collisions between user names exist.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_group_set_with_identity_api_v3">
|
|
<title>openstack group set (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 group set [-h] [--domain <domain>] [--name <name>]
|
|
[--description <description>]
|
|
<group></computeroutput></screen>
|
|
<para>
|
|
Set group properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><group></command></term>
|
|
<listitem>
|
|
<para>
|
|
Group to modify (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--domain <domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain containing <group> (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New group name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
New group description
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_group_show_with_identity_api_v3">
|
|
<title>openstack group show (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 group show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX] [--domain <domain>]
|
|
<group></computeroutput></screen>
|
|
<para>
|
|
Display group details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><group></command></term>
|
|
<listitem>
|
|
<para>
|
|
Group to display (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--domain <domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain containing <group> (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_identity_provider_create_with_identity_api_v3">
|
|
<title>openstack identity provider create (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 identity provider create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
[--remote-id <remote-id> | --remote-id-file <file-name>]
|
|
[--description <description>]
|
|
[--enable | --disable]
|
|
<name></computeroutput></screen>
|
|
<para>
|
|
Create new identity provider
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New identity provider name (must be unique)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--remote-id <remote-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Remote IDs to associate with the Identity Provider
|
|
(repeat to provide multiple values)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--remote-id-file <file-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of a file that contains many remote IDs to
|
|
associate with the identity provider, one per line
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
New identity provider description
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--enable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Enable identity provider (default)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disable the identity provider
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_identity_provider_delete_with_identity_api_v3">
|
|
<title>openstack identity provider delete (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 identity provider delete [-h] <identity-provider></computeroutput></screen>
|
|
<para>
|
|
Delete identity provider
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><identity-provider></command></term>
|
|
<listitem>
|
|
<para>
|
|
Identity provider to delete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_identity_provider_list_with_identity_api_v3">
|
|
<title>openstack identity provider list (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 identity provider list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
|
|
<para>
|
|
List identity providers
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_identity_provider_set_with_identity_api_v3">
|
|
<title>openstack identity provider set (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 identity provider set [-h]
|
|
[--remote-id <remote-id> | --remote-id-file <file-name>]
|
|
[--enable | --disable]
|
|
<identity-provider></computeroutput></screen>
|
|
<para>
|
|
Set identity provider properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><identity-provider></command></term>
|
|
<listitem>
|
|
<para>
|
|
Identity provider to modify
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--remote-id <remote-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Remote IDs to associate with the Identity Provider
|
|
(repeat to provide multiple values)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--remote-id-file <file-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of a file that contains many remote IDs to
|
|
associate with the identity provider, one per line
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--enable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Enable the identity provider
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disable the identity provider
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_identity_provider_show_with_identity_api_v3">
|
|
<title>openstack identity provider show (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 identity provider show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
<identity-provider></computeroutput></screen>
|
|
<para>
|
|
Display identity provider details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><identity-provider></command></term>
|
|
<listitem>
|
|
<para>
|
|
Identity provider to display
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_mapping_create_with_identity_api_v3">
|
|
<title>openstack mapping create (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 mapping create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX] --rules
|
|
<filename>
|
|
<name></computeroutput></screen>
|
|
<para>
|
|
Create new mapping
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New mapping name (must be unique)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--rules <filename></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filename that contains a set of mapping rules
|
|
(required)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_mapping_delete_with_identity_api_v3">
|
|
<title>openstack mapping delete (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 mapping delete [-h] <mapping></computeroutput></screen>
|
|
<para>
|
|
Delete mapping
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><mapping></command></term>
|
|
<listitem>
|
|
<para>
|
|
Mapping to delete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_mapping_list_with_identity_api_v3">
|
|
<title>openstack mapping list (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 mapping list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
|
|
<para>
|
|
List mappings
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_mapping_set_with_identity_api_v3">
|
|
<title>openstack mapping set (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 mapping set [-h] [--rules <filename>] <name></computeroutput></screen>
|
|
<para>
|
|
Set mapping properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Mapping to modify
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--rules <filename></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filename that contains a new set of mapping rules
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_mapping_show_with_identity_api_v3">
|
|
<title>openstack mapping show (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 mapping show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX]
|
|
<mapping></computeroutput></screen>
|
|
<para>
|
|
Display mapping details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><mapping></command></term>
|
|
<listitem>
|
|
<para>
|
|
Mapping to display
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_policy_create_with_identity_api_v3">
|
|
<title>openstack policy create (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 policy create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX] [--type <type>]
|
|
<filename></computeroutput></screen>
|
|
<para>
|
|
Create new policy
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><filename></command></term>
|
|
<listitem>
|
|
<para>
|
|
New serialized policy rules file
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--type <type></command></term>
|
|
<listitem>
|
|
<para>
|
|
New MIME type of the policy rules file (defaults to
|
|
application/json)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_policy_delete_with_identity_api_v3">
|
|
<title>openstack policy delete (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 policy delete [-h] <policy></computeroutput></screen>
|
|
<para>
|
|
Delete policy
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><policy></command></term>
|
|
<listitem>
|
|
<para>
|
|
Policy to delete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_policy_list_with_identity_api_v3">
|
|
<title>openstack policy list (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 policy list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}] [--long]</computeroutput></screen>
|
|
<para>
|
|
List policies
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--long</command></term>
|
|
<listitem>
|
|
<para>
|
|
List additional fields in output
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_policy_set_with_identity_api_v3">
|
|
<title>openstack policy set (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 policy set [-h] [--type <type>] [--rules <filename>] <policy></computeroutput></screen>
|
|
<para>
|
|
Set policy properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><policy></command></term>
|
|
<listitem>
|
|
<para>
|
|
Policy to modify
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--type <type></command></term>
|
|
<listitem>
|
|
<para>
|
|
New MIME type of the policy rules file
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--rules <filename></command></term>
|
|
<listitem>
|
|
<para>
|
|
New serialized policy rules file
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_policy_show_with_identity_api_v3">
|
|
<title>openstack policy show (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 policy show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX]
|
|
<policy></computeroutput></screen>
|
|
<para>
|
|
Display policy details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><policy></command></term>
|
|
<listitem>
|
|
<para>
|
|
Policy to display
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_region_create_with_identity_api_v3">
|
|
<title>openstack region create (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 region create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
[--parent-region <region-id>]
|
|
[--description <description>] [--url <url>]
|
|
<region-id></computeroutput></screen>
|
|
<para>
|
|
Create new region
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><region-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
New region ID
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--parent-region <region-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Parent region ID
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
New region description
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--url <url></command></term>
|
|
<listitem>
|
|
<para>
|
|
New region url
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_region_delete_with_identity_api_v3">
|
|
<title>openstack region delete (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 region delete [-h] <region-id></computeroutput></screen>
|
|
<para>
|
|
Delete region
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><region-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Region ID to delete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_region_list_with_identity_api_v3">
|
|
<title>openstack region list (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 region list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--parent-region <region-id>]</computeroutput></screen>
|
|
<para>
|
|
List regions
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--parent-region <region-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter by parent region ID
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_region_set_with_identity_api_v3">
|
|
<title>openstack region set (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 region set [-h] [--parent-region <region-id>]
|
|
[--description <description>] [--url <url>]
|
|
<region-id></computeroutput></screen>
|
|
<para>
|
|
Set region properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><region-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Region to modify
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--parent-region <region-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
New parent region ID
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
New region description
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--url <url></command></term>
|
|
<listitem>
|
|
<para>
|
|
New region url
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_region_show_with_identity_api_v3">
|
|
<title>openstack region show (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 region show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX]
|
|
<region-id></computeroutput></screen>
|
|
<para>
|
|
Display region details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><region-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Region to display
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_request_token_authorize_with_identity_api_v3">
|
|
<title>openstack request token authorize (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 request token authorize [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
--request-key <request-key> --role
|
|
<role></computeroutput></screen>
|
|
<para>
|
|
Authorize a request token
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--request-key <request-key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Request token to authorize (ID only) (required)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--role <role></command></term>
|
|
<listitem>
|
|
<para>
|
|
Roles to authorize (name or ID) (repeat to set
|
|
multiple values) (required)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_request_token_create_with_identity_api_v3">
|
|
<title>openstack request token create (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 request token create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
--consumer-key <consumer-key>
|
|
--consumer-secret <consumer-secret>
|
|
--project <project> [--domain <domain>]</computeroutput></screen>
|
|
<para>
|
|
Create a request token
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--consumer-key <consumer-key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Consumer key (required)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--consumer-secret <consumer-secret></command></term>
|
|
<listitem>
|
|
<para>
|
|
Consumer secret (required)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Project that consumer wants to access (name or ID)
|
|
(required)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--domain <domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain owning <project> (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_role_assignment_list_with_identity_api_v3">
|
|
<title>openstack role assignment list (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 role assignment list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--effective] [--role <role>]
|
|
[--user <user>]
|
|
[--user-domain <user-domain>]
|
|
[--group <group>]
|
|
[--group-domain <group-domain>]
|
|
[--domain <domain> | --project <project>]
|
|
[--project-domain <project-domain>]
|
|
[--inherited]</computeroutput></screen>
|
|
<para>
|
|
List role assignments
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--effective</command></term>
|
|
<listitem>
|
|
<para>
|
|
Returns only effective role assignments
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--role <role></command></term>
|
|
<listitem>
|
|
<para>
|
|
Role to filter (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user <user></command></term>
|
|
<listitem>
|
|
<para>
|
|
User to filter (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user-domain <user-domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain the user belongs to (name or ID). This can be
|
|
used in case collisions between user names exist.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--group <group></command></term>
|
|
<listitem>
|
|
<para>
|
|
Group to filter (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--group-domain <group-domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain the group belongs to (name or ID). This can be
|
|
used in case collisions between group names exist.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--domain <domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain to filter (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Project to filter (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project-domain <project-domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain the project belongs to (name or ID). This can
|
|
be used in case collisions between project names
|
|
exist.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--inherited</command></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies if the role grant is inheritable to the sub
|
|
projects
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_role_set_with_identity_api_v3">
|
|
<title>openstack role set (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 role set [-h] [--name <name>] <role></computeroutput></screen>
|
|
<para>
|
|
Set role properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><role></command></term>
|
|
<listitem>
|
|
<para>
|
|
Role to modify (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set role name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_service_provider_create_with_identity_api_v3">
|
|
<title>openstack service provider create (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 service provider create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
--auth-url <auth-url>
|
|
[--description <description>]
|
|
--service-provider-url <sp-url>
|
|
[--enable | --disable]
|
|
<name></computeroutput></screen>
|
|
<para>
|
|
Create new service provider
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New service provider name (must be unique)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--auth-url <auth-url></command></term>
|
|
<listitem>
|
|
<para>
|
|
Authentication URL of remote federated service
|
|
provider (required)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
New service provider description
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--service-provider-url <sp-url></command></term>
|
|
<listitem>
|
|
<para>
|
|
A service URL where SAML assertions are being sent
|
|
(required)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--enable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Enable the service provider (default)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disable the service provider
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_service_provider_delete_with_identity_api_v3">
|
|
<title>openstack service provider delete (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 service provider delete [-h] <service-provider></computeroutput></screen>
|
|
<para>
|
|
Delete service provider
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><service-provider></command></term>
|
|
<listitem>
|
|
<para>
|
|
Service provider to delete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_service_provider_list_with_identity_api_v3">
|
|
<title>openstack service provider list (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 service provider list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
|
|
<para>
|
|
List service providers
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_service_provider_set_with_identity_api_v3">
|
|
<title>openstack service provider set (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 service provider set [-h] [--auth-url <auth-url>]
|
|
[--description <description>]
|
|
[--service-provider-url <sp-url>]
|
|
[--enable | --disable]
|
|
<service-provider></computeroutput></screen>
|
|
<para>
|
|
Set service provider properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><service-provider></command></term>
|
|
<listitem>
|
|
<para>
|
|
Service provider to modify
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--auth-url <auth-url></command></term>
|
|
<listitem>
|
|
<para>
|
|
New Authentication URL of remote federated service
|
|
provider
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
New service provider description
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--service-provider-url <sp-url></command></term>
|
|
<listitem>
|
|
<para>
|
|
New service provider URL, where SAML assertions are
|
|
sent
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--enable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Enable the service provider
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disable the service provider
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_service_provider_show_with_identity_api_v3">
|
|
<title>openstack service provider show (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 service provider show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
<service-provider></computeroutput></screen>
|
|
<para>
|
|
Display service provider details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><service-provider></command></term>
|
|
<listitem>
|
|
<para>
|
|
Service provider to display
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_service_set_with_identity_api_v3">
|
|
<title>openstack service set (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 service set [-h] [--type <type>] [--name <service-name>]
|
|
[--description <description>]
|
|
[--enable | --disable]
|
|
<service></computeroutput></screen>
|
|
<para>
|
|
Set service properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><service></command></term>
|
|
<listitem>
|
|
<para>
|
|
Service to update (type, name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--type <type></command></term>
|
|
<listitem>
|
|
<para>
|
|
New service type (compute, image, identity, volume,
|
|
etc)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <service-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New service name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
New service description
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--enable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Enable service
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disable service
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_trust_create_with_identity_api_v3">
|
|
<title>openstack trust create (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 trust create [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX] --project <project> --role
|
|
<role> [--impersonate]
|
|
[--expiration <expiration>]
|
|
[--project-domain <project-domain>]
|
|
[--trustor-domain <trustor-domain>]
|
|
[--trustee-domain <trustee-domain>]
|
|
<trustor-user> <trustee-user></computeroutput></screen>
|
|
<para>
|
|
Create new trust
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><trustor-user></command></term>
|
|
<listitem>
|
|
<para>
|
|
User that is delegating authorization (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><trustee-user></command></term>
|
|
<listitem>
|
|
<para>
|
|
User that is assuming authorization (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Project being delegated (name or ID) (required)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--role <role></command></term>
|
|
<listitem>
|
|
<para>
|
|
Roles to authorize (name or ID) (repeat to set
|
|
multiple values) (required)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--impersonate</command></term>
|
|
<listitem>
|
|
<para>
|
|
Tokens generated from the trust will represent
|
|
<trustor> (defaults to False)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--expiration <expiration></command></term>
|
|
<listitem>
|
|
<para>
|
|
Sets an expiration date for the trust (format of YYYY-
|
|
mm-ddTHH:MM:SS)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project-domain <project-domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain the project belongs to (name or ID). This can
|
|
be used in case collisions between project names
|
|
exist.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--trustor-domain <trustor-domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain that contains <trustor> (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--trustee-domain <trustee-domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain that contains <trustee> (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_trust_delete_with_identity_api_v3">
|
|
<title>openstack trust delete (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 trust delete [-h] <trust> [<trust> ...]</computeroutput></screen>
|
|
<para>
|
|
Delete trust(s)
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><trust></command></term>
|
|
<listitem>
|
|
<para>
|
|
Trust(s) to delete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_trust_list_with_identity_api_v3">
|
|
<title>openstack trust list (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 trust list [-h]
|
|
[-f {csv,html,json,json,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
|
|
<para>
|
|
List trusts
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_trust_show_with_identity_api_v3">
|
|
<title>openstack trust show (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 trust show [-h]
|
|
[-f {html,json,json,shell,table,value,yaml,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX]
|
|
<trust></computeroutput></screen>
|
|
<para>
|
|
Display trust details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><trust></command></term>
|
|
<listitem>
|
|
<para>
|
|
Trust to display
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_user_password_set_with_identity_api_v3">
|
|
<title>openstack user password set (Identity API v3)</title>
|
|
<screen><computeroutput>usage: openstack --os-auth-type token --os-identity-api-version 3 user password set [-h] [--password <new-password>]</computeroutput></screen>
|
|
<para>
|
|
Change current user password
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--password <new-password></command></term>
|
|
<listitem>
|
|
<para>
|
|
New user password
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
</section>
|
|
</chapter>
|