openstack-manuals/doc/cli-reference/generated/ch_cli_openstack_commands.xml
Andreas Jaeger 7d65f6c473 Update for python-openstackclient 0.4.1
Regenerate documentation for openstack.

Change-Id: Icd8345c583934cb041a7756ceedeb2e980dfed97
2014-09-09 23:49:34 +02:00

6604 lines
195 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 client</title>
<para>The <command>openstack</command> client is a common
OpenStack command-line interface (CLI).
This chapter documents <command>openstack</command> version
<literal>0.4.1</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] [--debug]
[--os-auth-url &lt;auth-url&gt;]
[--os-domain-name &lt;auth-domain-name&gt;]
[--os-domain-id &lt;auth-domain-id&gt;]
[--os-project-name &lt;auth-project-name&gt;]
[--os-project-id &lt;auth-project-id&gt;]
[--os-username &lt;auth-username&gt;]
[--os-password &lt;auth-password&gt;]
[--os-user-domain-name &lt;auth-user-domain-name&gt;]
[--os-user-domain-id &lt;auth-user-domain-id&gt;]
[--os-project-domain-name &lt;auth-project-domain-name&gt;]
[--os-project-domain-id &lt;auth-project-domain-id&gt;]
[--os-region-name &lt;auth-region-name&gt;]
[--os-cacert &lt;ca-bundle-file&gt;] [--verify | --insecure]
[--os-default-domain &lt;auth-domain&gt;] [--os-token &lt;token&gt;]
[--os-url &lt;url&gt;] [--timing]
[--os-compute-api-version &lt;compute-api-version&gt;]
[--os-network-api-version &lt;network-api-version&gt;]
[--os-image-api-version &lt;image-api-version&gt;]
[--os-volume-api-version &lt;volume-api-version&gt;]
[--os-identity-api-version &lt;identity-api-version&gt;]
[--os-trust-id &lt;trust-id&gt;]
[--os-object-api-version &lt;object-api-version&gt;] [-h]</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 this 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-auth-url &lt;auth-url&gt;</command></term>
<listitem>
<para>
Authentication URL (Env: OS_AUTH_URL)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-domain-name &lt;auth-domain-name&gt;</command></term>
<listitem>
<para>
Domain name of the requested domain-level
authorization scope (Env: OS_DOMAIN_NAME)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-domain-id &lt;auth-domain-id&gt;</command></term>
<listitem>
<para>
Domain ID of the requested domain-level authorization
scope (Env: OS_DOMAIN_ID)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-project-name &lt;auth-project-name&gt;</command></term>
<listitem>
<para>
Project name of the requested project-level
authorization scope (Env: OS_PROJECT_NAME)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-project-id &lt;auth-project-id&gt;</command></term>
<listitem>
<para>
Project ID of the requested project-level
authorization scope (Env: OS_PROJECT_ID)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-username &lt;auth-username&gt;</command></term>
<listitem>
<para>
Authentication username (Env: OS_USERNAME)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-password &lt;auth-password&gt;</command></term>
<listitem>
<para>
Authentication password (Env: OS_PASSWORD)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-user-domain-name &lt;auth-user-domain-name&gt;</command></term>
<listitem>
<para>
Domain name of the user (Env: OS_USER_DOMAIN_NAME)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-user-domain-id &lt;auth-user-domain-id&gt;</command></term>
<listitem>
<para>
Domain ID of the user (Env: OS_USER_DOMAIN_ID)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-project-domain-name &lt;auth-project-domain-name&gt;</command></term>
<listitem>
<para>
Domain name of the project which is the requested
project-level authorization scope (Env:
OS_PROJECT_DOMAIN_NAME)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-project-domain-id &lt;auth-project-domain-id&gt;</command></term>
<listitem>
<para>
Domain ID of the project which is the requested
project-level authorization scope (Env:
OS_PROJECT_DOMAIN_ID)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-region-name &lt;auth-region-name&gt;</command></term>
<listitem>
<para>
Authentication region name (Env: OS_REGION_NAME)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-cacert &lt;ca-bundle-file&gt;</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 &lt;auth-domain&gt;</command></term>
<listitem>
<para>
Default domain ID, default=default (Env:
OS_DEFAULT_DOMAIN)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-token &lt;token&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_TOKEN]</code>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-url &lt;url&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_URL]</code>
</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 &lt;compute-api-version&gt;</command></term>
<listitem>
<para>
Compute API version, default=2 (Env:
OS_COMPUTE_API_VERSION)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-network-api-version &lt;network-api-version&gt;</command></term>
<listitem>
<para>
Network API version, default=2 (Env:
OS_NETWORK_API_VERSION)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-image-api-version &lt;image-api-version&gt;</command></term>
<listitem>
<para>
Image API version, default=1 (Env:
OS_IMAGE_API_VERSION)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-volume-api-version &lt;volume-api-version&gt;</command></term>
<listitem>
<para>
Volume API version, default=1 (Env:
OS_VOLUME_API_VERSION)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-identity-api-version &lt;identity-api-version&gt;</command></term>
<listitem>
<para>
Identity API version, default=2.0 (Env:
OS_IDENTITY_API_VERSION)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-trust-id &lt;trust-id&gt;</command></term>
<listitem>
<para>
Trust ID to use when authenticating. This can only be
used with Keystone v3 API (Env: OS_TRUST_ID)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-object-api-version &lt;object-api-version&gt;</command></term>
<listitem>
<para>
Object API version, default=1 (Env:
OS_OBJECT_API_VERSION)
</para>
</listitem>
</varlistentry>
<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_add_host">
<title>openstack aggregate add host</title>
<screen><computeroutput>usage: openstack aggregate add host [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--variable VARIABLE] [--prefix PREFIX]
&lt;aggregate&gt; &lt;host&gt;</computeroutput></screen>
<para>
Add host to aggregate
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;aggregate&gt;</command></term>
<listitem>
<para>
Name or ID of aggregate
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;host&gt;</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">
<title>openstack aggregate create</title>
<screen><computeroutput>usage: openstack aggregate create [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--variable VARIABLE] [--prefix PREFIX]
[--zone &lt;availability-zone&gt;]
[--property &lt;key=value&gt;]
&lt;name&gt;</computeroutput></screen>
<para>
Create a new aggregate
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;name&gt;</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 &lt;availability-zone&gt;</command></term>
<listitem>
<para>
Availability zone name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--property &lt;key=value&gt;</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">
<title>openstack aggregate delete</title>
<screen><computeroutput>usage: openstack aggregate delete [-h] &lt;aggregate&gt;</computeroutput></screen>
<para>
Delete an existing aggregate
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;aggregate&gt;</command></term>
<listitem>
<para>
Name or ID of aggregate 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_aggregate_list">
<title>openstack aggregate list</title>
<screen><computeroutput>usage: openstack aggregate list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--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">
<title>openstack aggregate remove host</title>
<screen><computeroutput>usage: openstack aggregate remove host [-h] [-f {shell,table,value}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--variable VARIABLE] [--prefix PREFIX]
&lt;aggregate&gt; &lt;host&gt;</computeroutput></screen>
<para>
Remove host from aggregate
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;aggregate&gt;</command></term>
<listitem>
<para>
Name or ID of aggregate
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;host&gt;</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">
<title>openstack aggregate set</title>
<screen><computeroutput>usage: openstack aggregate set [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX] [--name &lt;new-name&gt;]
[--zone &lt;availability-zone&gt;]
[--property &lt;key=value&gt;]
&lt;aggregate&gt;</computeroutput></screen>
<para>
Set aggregate properties
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;aggregate&gt;</command></term>
<listitem>
<para>
Name or ID of aggregate 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>--name &lt;new-name&gt;</command></term>
<listitem>
<para>
New aggregate name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--zone &lt;availability-zone&gt;</command></term>
<listitem>
<para>
Availability zone name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--property &lt;key=value&gt;</command></term>
<listitem>
<para>
Property to add/change for this aggregate (repeat
option to set multiple properties)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_aggregate_show">
<title>openstack aggregate show</title>
<screen><computeroutput>usage: openstack aggregate show [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX]
&lt;aggregate&gt;</computeroutput></screen>
<para>
Show a specific aggregate
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;aggregate&gt;</command></term>
<listitem>
<para>
Name or ID of aggregate 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_backup_create">
<title>openstack backup create</title>
<screen><computeroutput>usage: openstack backup create [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX] [--container &lt;container&gt;]
[--name &lt;name&gt;] [--description &lt;description&gt;]
&lt;volume&gt;</computeroutput></screen>
<para>
Create backup command
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume&gt;</command></term>
<listitem>
<para>
The name or ID of the volume to backup
</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 &lt;container&gt;</command></term>
<listitem>
<para>
Optional backup container name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--name &lt;name&gt;</command></term>
<listitem>
<para>
Name of the backup
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description &lt;description&gt;</command></term>
<listitem>
<para>
Description of the backup
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_backup_delete">
<title>openstack backup delete</title>
<screen><computeroutput>usage: openstack backup delete [-h] &lt;backup&gt;</computeroutput></screen>
<para>
Delete backup command
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;backup&gt;</command></term>
<listitem>
<para>
Name or ID of backup 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_backup_list">
<title>openstack backup list</title>
<screen><computeroutput>usage: openstack backup list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
<para>
List backup 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_backup_restore">
<title>openstack backup restore</title>
<screen><computeroutput>usage: openstack backup restore [-h] &lt;backup&gt; &lt;dest-volume&gt;</computeroutput></screen>
<para>
Restore backup command
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;backup&gt;</command></term>
<listitem>
<para>
ID of backup to restore
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;dest-volume&gt;</command></term>
<listitem>
<para>
ID of volume to restore to
</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">
<title>openstack backup show</title>
<screen><computeroutput>usage: openstack backup show [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX]
&lt;backup&gt;</computeroutput></screen>
<para>
Show backup command
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;backup&gt;</command></term>
<listitem>
<para>
Name or ID of backup 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_compute_agent_create">
<title>openstack compute agent create</title>
<screen><computeroutput>usage: openstack compute agent create [-h] [-f {shell,table,value}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--variable VARIABLE] [--prefix PREFIX]
&lt;os&gt; &lt;architecture&gt; &lt;version&gt; &lt;url&gt;
&lt;md5hash&gt; &lt;hypervisor&gt;</computeroutput></screen>
<para>
Create compute agent command
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;os&gt;</command></term>
<listitem>
<para>
Type of OS
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;architecture&gt;</command></term>
<listitem>
<para>
Type of architecture
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;version&gt;</command></term>
<listitem>
<para>
Version
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;url&gt;</command></term>
<listitem>
<para>
URL
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;md5hash&gt;</command></term>
<listitem>
<para>
MD5 hash
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;hypervisor&gt;</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">
<title>openstack compute agent delete</title>
<screen><computeroutput>usage: openstack compute agent delete [-h] &lt;id&gt;</computeroutput></screen>
<para>
Delete compute agent command
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;id&gt;</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">
<title>openstack compute agent list</title>
<screen><computeroutput>usage: openstack compute agent list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]
[--hypervisor &lt;hypervisor&gt;]</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 &lt;hypervisor&gt;</command></term>
<listitem>
<para>
Type of hypervisor
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_compute_agent_set">
<title>openstack compute agent set</title>
<screen><computeroutput>usage: openstack compute agent set [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--variable VARIABLE] [--prefix PREFIX]
&lt;id&gt; &lt;version&gt; &lt;url&gt; &lt;md5hash&gt;</computeroutput></screen>
<para>
Set compute agent command
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;id&gt;</command></term>
<listitem>
<para>
ID of the agent
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;version&gt;</command></term>
<listitem>
<para>
Version of the agent
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;url&gt;</command></term>
<listitem>
<para>
URL
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;md5hash&gt;</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">
<title>openstack compute service list</title>
<screen><computeroutput>usage: openstack compute service list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]
[--host &lt;host&gt;] [--service &lt;service&gt;]</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 &lt;host&gt;</command></term>
<listitem>
<para>
Name of host
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--service &lt;service&gt;</command></term>
<listitem>
<para>
Name of service
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_compute_service_set">
<title>openstack compute service set</title>
<screen><computeroutput>usage: openstack compute service set [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]
[--enable | --disable]
&lt;host&gt; &lt;service&gt;</computeroutput></screen>
<para>
Set service command
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;host&gt;</command></term>
<listitem>
<para>
Name of host
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;service&gt;</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_console_log_show">
<title>openstack console log show</title>
<screen><computeroutput>usage: openstack console log show [-h] [--lines &lt;num-lines&gt;] &lt;server&gt;</computeroutput></screen>
<para>
Show server's console output
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server&gt;</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>--lines &lt;num-lines&gt;</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">
<title>openstack console url show</title>
<screen><computeroutput>usage: openstack console url show [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--variable VARIABLE] [--prefix PREFIX]
[--novnc | --xvpvnc | --spice]
&lt;server&gt;</computeroutput></screen>
<para>
Show server's remote console URL
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server&gt;</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>--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">
<title>openstack container create</title>
<screen><computeroutput>usage: openstack container create [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--variable VARIABLE] [--prefix PREFIX]
&lt;container&gt;</computeroutput></screen>
<para>
Create a container
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;container&gt;</command></term>
<listitem>
<para>
New container 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_container_delete">
<title>openstack container delete</title>
<screen><computeroutput>usage: openstack container delete [-h] &lt;container&gt;</computeroutput></screen>
<para>
Delete a container
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;container&gt;</command></term>
<listitem>
<para>
Container name 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">
<title>openstack container list</title>
<screen><computeroutput>usage: openstack container list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]
[--prefix &lt;prefix&gt;] [--marker &lt;marker&gt;]
[--end-marker &lt;end-marker&gt;] [--limit &lt;limit&gt;]
[--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 &lt;prefix&gt;</command></term>
<listitem>
<para>
Filter list using &lt;prefix&gt;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--marker &lt;marker&gt;</command></term>
<listitem>
<para>
Anchor for paging
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--end-marker &lt;end-marker&gt;</command></term>
<listitem>
<para>
End anchor for paging
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--limit &lt;limit&gt;</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_show">
<title>openstack container show</title>
<screen><computeroutput>usage: openstack container show [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX]
&lt;container&gt;</computeroutput></screen>
<para>
Show container information
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;container&gt;</command></term>
<listitem>
<para>
Container name 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_ec2_credentials_create">
<title>openstack ec2 credentials create</title>
<screen><computeroutput>usage: openstack ec2 credentials create [-h] [-f {shell,table,value}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--variable VARIABLE]
[--prefix PREFIX]
[--project &lt;project&gt;] [--user &lt;user&gt;]</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 &lt;project&gt;</command></term>
<listitem>
<para>
Specify a project [admin only]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--user &lt;user&gt;</command></term>
<listitem>
<para>
Specify a user [admin only]
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_ec2_credentials_delete">
<title>openstack ec2 credentials delete</title>
<screen><computeroutput>usage: openstack ec2 credentials delete [-h] [--user &lt;user&gt;] &lt;access-key&gt;</computeroutput></screen>
<para>
Delete EC2 credentials
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;access-key&gt;</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 &lt;user&gt;</command></term>
<listitem>
<para>
Specify a user [admin only]
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_ec2_credentials_list">
<title>openstack ec2 credentials list</title>
<screen><computeroutput>usage: openstack ec2 credentials list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]
[--user &lt;user&gt;]</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 &lt;user&gt;</command></term>
<listitem>
<para>
Specify a user [admin only]
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_ec2_credentials_show">
<title>openstack ec2 credentials show</title>
<screen><computeroutput>usage: openstack ec2 credentials show [-h] [-f {shell,table,value}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--variable VARIABLE] [--prefix PREFIX]
[--user &lt;user&gt;]
&lt;access-key&gt;</computeroutput></screen>
<para>
Show EC2 credentials
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;access-key&gt;</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 &lt;user&gt;</command></term>
<listitem>
<para>
Specify a user [admin only]
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_endpoint_create">
<title>openstack endpoint create</title>
<screen><computeroutput>usage: openstack endpoint create [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX] [--region &lt;region&gt;]
--publicurl &lt;public-url&gt;
[--adminurl &lt;admin-url&gt;]
[--internalurl &lt;internal-url&gt;]
&lt;endpoint-service&gt;</computeroutput></screen>
<para>
Create endpoint command
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;endpoint-service&gt;</command></term>
<listitem>
<para>
New endpoint 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>--region &lt;region&gt;</command></term>
<listitem>
<para>
New endpoint region
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--publicurl &lt;public-url&gt;</command></term>
<listitem>
<para>
New endpoint public URL
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--adminurl &lt;admin-url&gt;</command></term>
<listitem>
<para>
New endpoint admin URL
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--internalurl &lt;internal-url&gt;</command></term>
<listitem>
<para>
New endpoint internal URL
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_endpoint_delete">
<title>openstack endpoint delete</title>
<screen><computeroutput>usage: openstack endpoint delete [-h] &lt;endpoint-id&gt;</computeroutput></screen>
<para>
Delete endpoint command
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;endpoint-id&gt;</command></term>
<listitem>
<para>
ID of endpoint 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">
<title>openstack endpoint list</title>
<screen><computeroutput>usage: openstack endpoint list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]
[--long]</computeroutput></screen>
<para>
List endpoint 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>--long</command></term>
<listitem>
<para>
List additional fields in output
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_endpoint_show">
<title>openstack endpoint show</title>
<screen><computeroutput>usage: openstack endpoint show [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX]
&lt;endpoint_or_service&gt;</computeroutput></screen>
<para>
Show endpoint command
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;endpoint_or_service&gt;</command></term>
<listitem>
<para>
Endpoint ID or name, type or ID of service 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">
<title>openstack extension list</title>
<screen><computeroutput>usage: openstack extension list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]
[--long] [--identity] [--compute] [--volume]</computeroutput></screen>
<para>
List extension 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>--long</command></term>
<listitem>
<para>
List additional fields in output
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--identity</command></term>
<listitem>
<para>
List extensions for the Identity API
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--compute</command></term>
<listitem>
<para>
List extensions for the Compute API
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--volume</command></term>
<listitem>
<para>
List extensions for the Volume API
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_flavor_create">
<title>openstack flavor create</title>
<screen><computeroutput>usage: openstack flavor create [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX] [--id &lt;id&gt;] [--ram &lt;size-mb&gt;]
[--disk &lt;size-gb&gt;] [--ephemeral &lt;size-gb&gt;]
[--swap &lt;size-gb&gt;] [--vcpus &lt;vcpus&gt;]
[--rxtx-factor &lt;factor&gt;] [--public | --private]
&lt;name&gt;</computeroutput></screen>
<para>
Create new flavor
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;name&gt;</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 &lt;id&gt;</command></term>
<listitem>
<para>
Unique flavor ID; 'auto' will create a UUID (default:
auto)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--ram &lt;size-mb&gt;</command></term>
<listitem>
<para>
Memory size in MB (default 256M)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--disk &lt;size-gb&gt;</command></term>
<listitem>
<para>
Disk size in GB (default 0G)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--ephemeral &lt;size-gb&gt;</command></term>
<listitem>
<para>
Ephemeral disk size in GB (default 0G)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--swap &lt;size-gb&gt;</command></term>
<listitem>
<para>
Swap space size in GB (default 0G)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--vcpus &lt;vcpus&gt;</command></term>
<listitem>
<para>
Number of vcpus (default 1)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--rxtx-factor &lt;factor&gt;</command></term>
<listitem>
<para>
RX/TX factor (default 1)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--public</command></term>
<listitem>
<para>
Flavor is accessible to other projects (default)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--private</command></term>
<listitem>
<para>
Flavor is inaccessible to other projects
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_flavor_delete">
<title>openstack flavor delete</title>
<screen><computeroutput>usage: openstack flavor delete [-h] &lt;flavor&gt;</computeroutput></screen>
<para>
Delete a flavor
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;flavor&gt;</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">
<title>openstack flavor list</title>
<screen><computeroutput>usage: openstack flavor list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]</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>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_flavor_show">
<title>openstack flavor show</title>
<screen><computeroutput>usage: openstack flavor show [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX]
&lt;flavor&gt;</computeroutput></screen>
<para>
Show flavor details
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;flavor&gt;</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_host_list">
<title>openstack host list</title>
<screen><computeroutput>usage: openstack host list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]
[--zone &lt;zone&gt;]</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 &lt;zone&gt;</command></term>
<listitem>
<para>
Only return hosts in the availability zone.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_host_show">
<title>openstack host show</title>
<screen><computeroutput>usage: openstack host show [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]
&lt;host&gt;</computeroutput></screen>
<para>
Show host command
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;host&gt;</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">
<title>openstack hypervisor list</title>
<screen><computeroutput>usage: openstack hypervisor list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]
[--matching &lt;hostname-str&gt;]</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 &lt;hostname-str&gt;</command></term>
<listitem>
<para>
Filter hypervisors using &lt;hostname-str&gt; substring
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_hypervisor_show">
<title>openstack hypervisor show</title>
<screen><computeroutput>usage: openstack hypervisor show [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX]
&lt;id&gt;</computeroutput></screen>
<para>
Show hypervisor details
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;id&gt;</command></term>
<listitem>
<para>
ID of the hypervisor 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_image_create">
<title>openstack image create</title>
<screen><computeroutput>usage: openstack image create [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX] [--id &lt;id&gt;] [--store &lt;store&gt;]
[--container-format &lt;container-format&gt;]
[--disk-format &lt;disk-format&gt;]
[--owner &lt;project&gt;] [--size &lt;size&gt;]
[--min-disk &lt;disk-gb&gt;] [--min-ram &lt;ram-mb&gt;]
[--location &lt;image-url&gt;]
[--copy-from &lt;image-url&gt;] [--file &lt;file&gt;]
[--volume &lt;volume&gt;] [--force]
[--checksum &lt;checksum&gt;]
[--protected | --unprotected]
[--public | --private] [--property &lt;key=value&gt;]
&lt;name&gt;</computeroutput></screen>
<para>
Create/upload an image
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;name&gt;</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 &lt;id&gt;</command></term>
<listitem>
<para>
Image ID to reserve
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--store &lt;store&gt;</command></term>
<listitem>
<para>
Upload image to this store
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--container-format &lt;container-format&gt;</command></term>
<listitem>
<para>
Image container format (default: bare)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--disk-format &lt;disk-format&gt;</command></term>
<listitem>
<para>
Image disk format (default: raw)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--owner &lt;project&gt;</command></term>
<listitem>
<para>
Image owner project name or ID
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--size &lt;size&gt;</command></term>
<listitem>
<para>
Image size, in bytes (only used with --location and
--copy-from)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--min-disk &lt;disk-gb&gt;</command></term>
<listitem>
<para>
Minimum disk size needed to boot image, in gigabytes
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--min-ram &lt;ram-mb&gt;</command></term>
<listitem>
<para>
Minimum RAM size needed to boot image, in megabytes
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--location &lt;image-url&gt;</command></term>
<listitem>
<para>
Download image from an existing URL
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--copy-from &lt;image-url&gt;</command></term>
<listitem>
<para>
Copy image from the data store (similar to --location)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--file &lt;file&gt;</command></term>
<listitem>
<para>
Upload image from local file
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--volume &lt;volume&gt;</command></term>
<listitem>
<para>
Create image from a volume
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--force</command></term>
<listitem>
<para>
Force image creation if volume is in use (only
meaningful with --volume)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--checksum &lt;checksum&gt;</command></term>
<listitem>
<para>
Image hash used for verification
</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 &lt;key=value&gt;</command></term>
<listitem>
<para>
Set an image property (repeat option to set multiple
properties)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_image_delete">
<title>openstack image delete</title>
<screen><computeroutput>usage: openstack image delete [-h] &lt;image&gt;</computeroutput></screen>
<para>
Delete an image
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;image&gt;</command></term>
<listitem>
<para>
Name or ID of image 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_image_list">
<title>openstack image list</title>
<screen><computeroutput>usage: openstack image list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]
[--page-size &lt;size&gt;] [--long]</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>--page-size &lt;size&gt;</command></term>
<listitem>
<para>
Number of images to request in each paginated request
</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_image_save">
<title>openstack image save</title>
<screen><computeroutput>usage: openstack image save [-h] [--file &lt;filename&gt;] &lt;image&gt;</computeroutput></screen>
<para>
Save an image locally
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;image&gt;</command></term>
<listitem>
<para>
Name or ID of image 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>
<varlistentry>
<term><command>--file &lt;filename&gt;</command></term>
<listitem>
<para>
Downloaded image save filename [default: stdout]
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_image_set">
<title>openstack image set</title>
<screen><computeroutput>usage: openstack image set [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX] [--name &lt;name&gt;]
[--owner &lt;project&gt;] [--min-disk &lt;disk-gb&gt;]
[--min-ram &lt;disk-ram&gt;]
[--protected | --unprotected]
[--public | --private] [--property &lt;key=value&gt;]
&lt;image&gt;</computeroutput></screen>
<para>
Change image properties
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;image&gt;</command></term>
<listitem>
<para>
Image name or ID 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 &lt;name&gt;</command></term>
<listitem>
<para>
New image name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--owner &lt;project&gt;</command></term>
<listitem>
<para>
New image owner project name or ID
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--min-disk &lt;disk-gb&gt;</command></term>
<listitem>
<para>
Minimum disk size needed to boot image, in gigabytes
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--min-ram &lt;disk-ram&gt;</command></term>
<listitem>
<para>
Minimum RAM size needed to boot image, in megabytes
</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 &lt;key=value&gt;</command></term>
<listitem>
<para>
Set an image property (repeat option to set multiple
properties)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_image_show">
<title>openstack image show</title>
<screen><computeroutput>usage: openstack image show [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX]
&lt;image&gt;</computeroutput></screen>
<para>
Show image details
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;image&gt;</command></term>
<listitem>
<para>
Name or ID of image 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_ip_fixed_add">
<title>openstack ip fixed add</title>
<screen><computeroutput>usage: openstack ip fixed add [-h] &lt;network&gt; &lt;server&gt;</computeroutput></screen>
<para>
Add fixed-ip command
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;network&gt;</command></term>
<listitem>
<para>
Name of the network to fetch an IP address from
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;server&gt;</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">
<title>openstack ip fixed remove</title>
<screen><computeroutput>usage: openstack ip fixed remove [-h] &lt;ip-address&gt; &lt;server&gt;</computeroutput></screen>
<para>
Remove fixed-ip command
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;ip-address&gt;</command></term>
<listitem>
<para>
IP address to remove from server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;server&gt;</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">
<title>openstack ip floating add</title>
<screen><computeroutput>usage: openstack ip floating add [-h] &lt;ip-address&gt; &lt;server&gt;</computeroutput></screen>
<para>
Add floating-ip to server
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;ip-address&gt;</command></term>
<listitem>
<para>
IP address to add to server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;server&gt;</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">
<title>openstack ip floating create</title>
<screen><computeroutput>usage: openstack ip floating create [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--variable VARIABLE] [--prefix PREFIX]
&lt;pool&gt;</computeroutput></screen>
<para>
Create new floating-ip
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;pool&gt;</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">
<title>openstack ip floating delete</title>
<screen><computeroutput>usage: openstack ip floating delete [-h] &lt;ip-address&gt;</computeroutput></screen>
<para>
Delete a floating-ip
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;ip-address&gt;</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">
<title>openstack ip floating list</title>
<screen><computeroutput>usage: openstack ip floating list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--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">
<title>openstack ip floating pool list</title>
<screen><computeroutput>usage: openstack ip floating pool list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--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">
<title>openstack ip floating remove</title>
<screen><computeroutput>usage: openstack ip floating remove [-h] &lt;ip-address&gt; &lt;server&gt;</computeroutput></screen>
<para>
Remove floating-ip from server
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;ip-address&gt;</command></term>
<listitem>
<para>
IP address to remove from server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;server&gt;</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">
<title>openstack keypair create</title>
<screen><computeroutput>usage: openstack keypair create [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX] [--public-key &lt;file&gt;]
&lt;name&gt;</computeroutput></screen>
<para>
Create new keypair
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;name&gt;</command></term>
<listitem>
<para>
New keypair 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 &lt;file&gt;</command></term>
<listitem>
<para>
Filename for public key to add
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_keypair_delete">
<title>openstack keypair delete</title>
<screen><computeroutput>usage: openstack keypair delete [-h] &lt;name&gt;</computeroutput></screen>
<para>
Delete a keypair
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;name&gt;</command></term>
<listitem>
<para>
Name of keypair 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">
<title>openstack keypair list</title>
<screen><computeroutput>usage: openstack keypair list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
<para>
List keypairs
</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">
<title>openstack keypair show</title>
<screen><computeroutput>usage: openstack keypair show [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX] [--public-key]
&lt;name&gt;</computeroutput></screen>
<para>
Show keypair details
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;name&gt;</command></term>
<listitem>
<para>
Name of keypair 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>
Include public key in output
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_limits_show">
<title>openstack limits show</title>
<screen><computeroutput>usage: openstack limits show [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]
[--absolute | --rate] [--reserved]</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>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_module_list">
<title>openstack module list</title>
<screen><computeroutput>usage: openstack module list [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--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">
<title>openstack network create</title>
<screen><computeroutput>usage: openstack network create [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX] [--enable | --disable]
[--share | --no-share]
&lt;network_name&gt;</computeroutput></screen>
<para>
Create a network
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;network_name&gt;</command></term>
<listitem>
<para>
Name of network to create
</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>
Set administrative state up
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--disable</command></term>
<listitem>
<para>
Set administrative state down
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--share</command></term>
<listitem>
<para>
Share the network across tenants
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--no-share</command></term>
<listitem>
<para>
Do not share the network across tenants
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_network_delete">
<title>openstack network delete</title>
<screen><computeroutput>usage: openstack network delete [-h] &lt;network&gt;</computeroutput></screen>
<para>
Delete a network
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;network&gt;</command></term>
<listitem>
<para>
Name or identifier of network 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_network_list">
<title>openstack network list</title>
<screen><computeroutput>usage: openstack network list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]
[--external] [--dhcp DHCP] [--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>--dhcp DHCP ID</command></term>
<listitem>
<para>
of the DHCP agent
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--long</command></term>
<listitem>
<para>
Long listing
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_network_set">
<title>openstack network set</title>
<screen><computeroutput>usage: openstack network set [-h] [--enable | --disable]
[--name &lt;network_name&gt;] [--share | --no-share]
&lt;network&gt;</computeroutput></screen>
<para>
Set network properties
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;network&gt;</command></term>
<listitem>
<para>
Name or identifier of network to set
</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>
Set administrative state up
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--disable</command></term>
<listitem>
<para>
Set administrative state down
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--name &lt;network_name&gt;</command></term>
<listitem>
<para>
New name for the network
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--share</command></term>
<listitem>
<para>
Share the network across tenants
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--no-share</command></term>
<listitem>
<para>
Do not share the network across tenants
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_network_show">
<title>openstack network show</title>
<screen><computeroutput>usage: openstack network show [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX]
&lt;network&gt;</computeroutput></screen>
<para>
Show network details
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;network&gt;</command></term>
<listitem>
<para>
Name or identifier of network to show
</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">
<title>openstack object list</title>
<screen><computeroutput>usage: openstack object list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]
[--prefix &lt;prefix&gt;] [--delimiter &lt;delimiter&gt;]
[--marker &lt;marker&gt;] [--end-marker &lt;end-marker&gt;]
[--limit &lt;limit&gt;] [--long] [--all]
&lt;container-name&gt;</computeroutput></screen>
<para>
List objects
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;container-name&gt;</command></term>
<listitem>
<para>
List contents of container-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>--prefix &lt;prefix&gt;</command></term>
<listitem>
<para>
Filter list using &lt;prefix&gt;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--delimiter &lt;delimiter&gt;</command></term>
<listitem>
<para>
Roll up items with &lt;delimiter&gt;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--marker &lt;marker&gt;</command></term>
<listitem>
<para>
Anchor for paging
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--end-marker &lt;end-marker&gt;</command></term>
<listitem>
<para>
End anchor for paging
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--limit &lt;limit&gt;</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_show">
<title>openstack object show</title>
<screen><computeroutput>usage: openstack object show [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX]
&lt;container&gt; &lt;object&gt;</computeroutput></screen>
<para>
Show object information
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;container&gt;</command></term>
<listitem>
<para>
Container name for object to display
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;object&gt;</command></term>
<listitem>
<para>
Object name 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_project_create">
<title>openstack project create</title>
<screen><computeroutput>usage: openstack project create [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX]
[--description &lt;project-description&gt;]
[--enable | --disable]
[--property &lt;key=value&gt;]
&lt;project-name&gt;</computeroutput></screen>
<para>
Create new project
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;project-name&gt;</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 &lt;project-description&gt;</command></term>
<listitem>
<para>
New 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 &lt;key=value&gt;</command></term>
<listitem>
<para>
Property to add for this project (repeat option to set
multiple properties)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_project_delete">
<title>openstack project delete</title>
<screen><computeroutput>usage: openstack project delete [-h] &lt;project&gt;</computeroutput></screen>
<para>
Delete project
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;project&gt;</command></term>
<listitem>
<para>
Project 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">
<title>openstack project list</title>
<screen><computeroutput>usage: openstack project list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--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">
<title>openstack project set</title>
<screen><computeroutput>usage: openstack project set [-h] [--name &lt;new-project-name&gt;]
[--description &lt;project-description&gt;]
[--enable | --disable] [--property &lt;key=value&gt;]
&lt;project&gt;</computeroutput></screen>
<para>
Set project properties
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;project&gt;</command></term>
<listitem>
<para>
Project 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 &lt;new-project-name&gt;</command></term>
<listitem>
<para>
New project name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description &lt;project-description&gt;</command></term>
<listitem>
<para>
New 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 &lt;key=value&gt;</command></term>
<listitem>
<para>
Property to add for this project (repeat option to set
multiple properties)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_project_show">
<title>openstack project show</title>
<screen><computeroutput>usage: openstack project show [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX]
&lt;project&gt;</computeroutput></screen>
<para>
Show project details
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;project&gt;</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">
<title>openstack project usage list</title>
<screen><computeroutput>usage: openstack project usage list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]
[--start &lt;start&gt;] [--end &lt;end&gt;]</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 &lt;start&gt;</command></term>
<listitem>
<para>
Usage range start date, ex 2012-01-20 (default: 4
weeks ago).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--end &lt;end&gt;</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">
<title>openstack quota set</title>
<screen><computeroutput>usage: openstack quota set [-h] [--class] [--properties &lt;new-properties&gt;]
[--ram &lt;new-ram&gt;]
[--secgroup-rules &lt;new-secgroup-rules&gt;]
[--instances &lt;new-instances&gt;]
[--key-pairs &lt;new-key-pairs&gt;]
[--fixed-ips &lt;new-fixed-ips&gt;]
[--secgroups &lt;new-secgroups&gt;]
[--injected-file-size &lt;new-injected-file-size&gt;]
[--floating-ips &lt;new-floating-ips&gt;]
[--injected-files &lt;new-injected-files&gt;]
[--cores &lt;new-cores&gt;]
[--injected-path-size &lt;new-injected-path-size&gt;]
[--gigabytes &lt;new-gigabytes&gt;]
[--volumes &lt;new-volumes&gt;]
[--snapshots &lt;new-snapshots&gt;]
&lt;project/class&gt;</computeroutput></screen>
<para>
Set quotas for project or class
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;project/class&gt;</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 &lt;class&gt;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--properties &lt;new-properties&gt;</command></term>
<listitem>
<para>
New value for the properties quota
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--ram &lt;new-ram&gt;</command></term>
<listitem>
<para>
New value for the ram quota
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--secgroup-rules &lt;new-secgroup-rules&gt;</command></term>
<listitem>
<para>
New value for the secgroup-rules quota
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--instances &lt;new-instances&gt;</command></term>
<listitem>
<para>
New value for the instances quota
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--key-pairs &lt;new-key-pairs&gt;</command></term>
<listitem>
<para>
New value for the key-pairs quota
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--fixed-ips &lt;new-fixed-ips&gt;</command></term>
<listitem>
<para>
New value for the fixed-ips quota
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--secgroups &lt;new-secgroups&gt;</command></term>
<listitem>
<para>
New value for the secgroups quota
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--injected-file-size &lt;new-injected-file-size&gt;</command></term>
<listitem>
<para>
New value for the injected-file-size quota
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--floating-ips &lt;new-floating-ips&gt;</command></term>
<listitem>
<para>
New value for the floating-ips quota
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--injected-files &lt;new-injected-files&gt;</command></term>
<listitem>
<para>
New value for the injected-files quota
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--cores &lt;new-cores&gt;</command></term>
<listitem>
<para>
New value for the cores quota
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--injected-path-size &lt;new-injected-path-size&gt;</command></term>
<listitem>
<para>
New value for the injected-path-size quota
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--gigabytes &lt;new-gigabytes&gt;</command></term>
<listitem>
<para>
New value for the gigabytes quota
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--volumes &lt;new-volumes&gt;</command></term>
<listitem>
<para>
New value for the volumes quota
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--snapshots &lt;new-snapshots&gt;</command></term>
<listitem>
<para>
New value for the snapshots quota
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_quota_show">
<title>openstack quota show</title>
<screen><computeroutput>usage: openstack quota show [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX] [--class | --default]
&lt;project/class&gt;</computeroutput></screen>
<para>
Show quotas for project or class
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;project/class&gt;</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 &lt;class&gt;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--default</command></term>
<listitem>
<para>
Show default quotas for &lt;project&gt;
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_role_add">
<title>openstack role add</title>
<screen><computeroutput>usage: openstack role add [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX] --project &lt;project&gt; --user &lt;user&gt;
&lt;role&gt;</computeroutput></screen>
<para>
Add role to project:user
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;role&gt;</command></term>
<listitem>
<para>
Role name or ID to add to user
</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 &lt;project&gt;</command></term>
<listitem>
<para>
Include project (name or ID)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--user &lt;user&gt;</command></term>
<listitem>
<para>
Name or ID of user to include
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_role_create">
<title>openstack role create</title>
<screen><computeroutput>usage: openstack role create [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX]
&lt;role-name&gt;</computeroutput></screen>
<para>
Create new role
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;role-name&gt;</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>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_role_delete">
<title>openstack role delete</title>
<screen><computeroutput>usage: openstack role delete [-h] &lt;role&gt;</computeroutput></screen>
<para>
Delete existing role
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;role&gt;</command></term>
<listitem>
<para>
Name or ID of role 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_role_list">
<title>openstack role list</title>
<screen><computeroutput>usage: openstack role list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]</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>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_role_remove">
<title>openstack role remove</title>
<screen><computeroutput>usage: openstack role remove [-h] --project &lt;project&gt; --user &lt;user&gt; &lt;role&gt;</computeroutput></screen>
<para>
Remove role from project:user
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;role&gt;</command></term>
<listitem>
<para>
Role name or ID to remove from user
</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 &lt;project&gt;</command></term>
<listitem>
<para>
Project to include (name or ID)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--user &lt;user&gt;</command></term>
<listitem>
<para>
Name or ID of user
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_role_show">
<title>openstack role show</title>
<screen><computeroutput>usage: openstack role show [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX]
&lt;role&gt;</computeroutput></screen>
<para>
Show single role
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;role&gt;</command></term>
<listitem>
<para>
Name or ID of role 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_security_group_create">
<title>openstack security group create</title>
<screen><computeroutput>usage: openstack security group create [-h] [-f {shell,table,value}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--variable VARIABLE] [--prefix PREFIX]
[--description &lt;description&gt;]
&lt;name&gt;</computeroutput></screen>
<para>
Create a new security group
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;name&gt;</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 &lt;description&gt;</command></term>
<listitem>
<para>
Security group description
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_security_group_delete">
<title>openstack security group delete</title>
<screen><computeroutput>usage: openstack security group delete [-h] &lt;group&gt;</computeroutput></screen>
<para>
Delete a security group
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;group&gt;</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">
<title>openstack security group list</title>
<screen><computeroutput>usage: openstack security group list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--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">
<title>openstack security group rule create</title>
<screen><computeroutput>usage: openstack security group rule create [-h] [-f {shell,table,value}]
[-c COLUMN]
[--max-width &lt;integer&gt;]
[--variable VARIABLE]
[--prefix PREFIX]
[--proto &lt;proto&gt;]
[--src-ip &lt;ip-address&gt;]
[--dst-port &lt;port-range&gt;]
&lt;group&gt;</computeroutput></screen>
<para>
Create a new security group rule
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;group&gt;</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 &lt;proto&gt; IP</command></term>
<listitem>
<para>
protocol (icmp, tcp, udp; default: tcp)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--src-ip &lt;ip-address&gt;</command></term>
<listitem>
<para>
Source IP (may use CIDR notation; default: 0.0.0.0/0)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--dst-port &lt;port-range&gt;</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">
<title>openstack security group rule delete</title>
<screen><computeroutput>usage: openstack security group rule delete [-h] [--proto &lt;proto&gt;]
[--src-ip &lt;ip-address&gt;]
[--dst-port &lt;port-range&gt;]
&lt;group&gt;</computeroutput></screen>
<para>
Delete a security group rule
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;group&gt;</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 &lt;proto&gt; IP</command></term>
<listitem>
<para>
protocol (icmp, tcp, udp; default: tcp)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--src-ip &lt;ip-address&gt;</command></term>
<listitem>
<para>
Source IP (may use CIDR notation; default: 0.0.0.0/0)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--dst-port &lt;port-range&gt;</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_list">
<title>openstack security group rule list</title>
<screen><computeroutput>usage: openstack security group rule list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]
&lt;group&gt;</computeroutput></screen>
<para>
List all security group rules
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;group&gt;</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>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_security_group_set">
<title>openstack security group set</title>
<screen><computeroutput>usage: openstack security group set [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--variable VARIABLE] [--prefix PREFIX]
[--name &lt;new-name&gt;]
[--description &lt;description&gt;]
&lt;group&gt;</computeroutput></screen>
<para>
Set security group properties
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;group&gt;</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 &lt;new-name&gt;</command></term>
<listitem>
<para>
New security group name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description &lt;description&gt;</command></term>
<listitem>
<para>
New security group name
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_security_group_show">
<title>openstack security group show</title>
<screen><computeroutput>usage: openstack security group show [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--variable VARIABLE] [--prefix PREFIX]
&lt;group&gt;</computeroutput></screen>
<para>
Show a specific security group
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;group&gt;</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">
<title>openstack server add security group</title>
<screen><computeroutput>usage: openstack server add security group [-h] &lt;server&gt; &lt;group&gt;</computeroutput></screen>
<para>
Add security group to server
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server&gt;</command></term>
<listitem>
<para>
Name or ID of server to use
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;group&gt;</command></term>
<listitem>
<para>
Name or ID of security group to add to 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_add_volume">
<title>openstack server add volume</title>
<screen><computeroutput>usage: openstack server add volume [-h] [--device &lt;device&gt;] &lt;server&gt; &lt;volume&gt;</computeroutput></screen>
<para>
Add volume to server
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server&gt;</command></term>
<listitem>
<para>
Server (name or ID)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;volume&gt;</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 &lt;device&gt;</command></term>
<listitem>
<para>
Server internal device name for volume
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_server_create">
<title>openstack server create</title>
<screen><computeroutput>usage: openstack server create [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX] --image &lt;image&gt; --flavor
&lt;flavor&gt;
[--security-group &lt;security-group-name&gt;]
[--key-name &lt;key-name&gt;]
[--property &lt;key=value&gt;]
[--file &lt;dest-filename=source-filename&gt;]
[--user-data &lt;user-data&gt;]
[--availability-zone &lt;zone-name&gt;]
[--block-device-mapping &lt;dev-name=mapping&gt;]
[--nic &lt;nic-config-string&gt;]
[--hint &lt;key=value&gt;]
[--config-drive &lt;config-drive-volume&gt;|True]
[--min &lt;count&gt;] [--max &lt;count&gt;] [--wait]
&lt;server-name&gt;</computeroutput></screen>
<para>
Create a new server
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server-name&gt;</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 &lt;image&gt;</command></term>
<listitem>
<para>
Create server from this image
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--flavor &lt;flavor&gt;</command></term>
<listitem>
<para>
Create server with this flavor
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--security-group &lt;security-group-name&gt;</command></term>
<listitem>
<para>
Security group to assign to this server (repeat for
multiple groups)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--key-name &lt;key-name&gt;</command></term>
<listitem>
<para>
Keypair to inject into this server (optional
extension)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--property &lt;key=value&gt;</command></term>
<listitem>
<para>
Set a property on this server (repeat for multiple
values)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--file &lt;dest-filename=source-filename&gt;</command></term>
<listitem>
<para>
File to inject into image before boot (repeat for
multiple files)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--user-data &lt;user-data&gt;</command></term>
<listitem>
<para>
User data file to serve from the metadata server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--availability-zone &lt;zone-name&gt;</command></term>
<listitem>
<para>
Select an availability zone for the server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--block-device-mapping &lt;dev-name=mapping&gt;</command></term>
<listitem>
<para>
Map block devices; map is
&lt;id&gt;:&lt;type&gt;:&lt;size(GB)&gt;:&lt;delete_on_terminate&gt; (optional
extension)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--nic &lt;nic-config-string&gt;</command></term>
<listitem>
<para>
Specify NIC configuration (optional extension)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--hint &lt;key=value&gt;</command></term>
<listitem>
<para>
Hints for the scheduler (optional extension)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--config-drive &lt;config-drive-volume&gt;|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 &lt;count&gt;</command></term>
<listitem>
<para>
Minimum number of servers to launch (default=1)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--max &lt;count&gt;</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">
<title>openstack server delete</title>
<screen><computeroutput>usage: openstack server delete [-h] &lt;server&gt;</computeroutput></screen>
<para>
Delete server command
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server&gt;</command></term>
<listitem>
<para>
Name or ID of server 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_server_image_create">
<title>openstack server image create</title>
<screen><computeroutput>usage: openstack server image create [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--variable VARIABLE] [--prefix PREFIX]
[--name &lt;image-name&gt;] [--wait]
&lt;server&gt;</computeroutput></screen>
<para>
Create a new disk image from a running server
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server&gt;</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 &lt;image-name&gt;</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">
<title>openstack server list</title>
<screen><computeroutput>usage: openstack server list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]
[--reservation-id &lt;reservation-id&gt;]
[--ip &lt;ip-address-regex&gt;]
[--ip6 &lt;ip-address-regex&gt;] [--name &lt;name&gt;]
[--status &lt;status&gt;] [--flavor &lt;flavor&gt;]
[--image &lt;image&gt;] [--host &lt;hostname&gt;]
[--instance-name &lt;server-name&gt;] [--all-projects]
[--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 &lt;reservation-id&gt;</command></term>
<listitem>
<para>
Only return instances that match the reservation
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--ip &lt;ip-address-regex&gt;</command></term>
<listitem>
<para>
Regular expression to match IP addresses
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--ip6 &lt;ip-address-regex&gt;</command></term>
<listitem>
<para>
Regular expression to match IPv6 addresses
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--name &lt;name&gt;</command></term>
<listitem>
<para>
Regular expression to match names
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--status &lt;status&gt;</command></term>
<listitem>
<para>
Search by server status
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--flavor &lt;flavor&gt;</command></term>
<listitem>
<para>
Search by flavor ID
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--image &lt;image&gt;</command></term>
<listitem>
<para>
Search by image ID
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--host &lt;hostname&gt;</command></term>
<listitem>
<para>
Search by hostname
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--instance-name &lt;server-name&gt;</command></term>
<listitem>
<para>
Regular expression to match instance name (admin only)
</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_server_lock">
<title>openstack server lock</title>
<screen><computeroutput>usage: openstack server lock [-h] &lt;server&gt;</computeroutput></screen>
<para>
Lock server
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server&gt;</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">
<title>openstack server migrate</title>
<screen><computeroutput>usage: openstack server migrate [-h] [--wait] [--live &lt;hostname&gt;]
[--shared-migration | --block-migration]
[--no-disk-overcommit | --disk-overcommit]
&lt;server&gt;</computeroutput></screen>
<para>
Migrate server to different host
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server&gt;</command></term>
<listitem>
<para>
Server to migrate (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 resize to complete
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--live &lt;hostname&gt;</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>--no-disk-overcommit</command></term>
<listitem>
<para>
Do not over-commit disk on the destination host
(default)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--disk-overcommit</command></term>
<listitem>
<para>
Allow disk over-commit on the destination host
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_server_pause">
<title>openstack server pause</title>
<screen><computeroutput>usage: openstack server pause [-h] &lt;server&gt;</computeroutput></screen>
<para>
Pause server
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server&gt;</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">
<title>openstack server reboot</title>
<screen><computeroutput>usage: openstack server reboot [-h] [--hard | --soft] [--wait] &lt;server&gt;</computeroutput></screen>
<para>
Perform a hard or soft server reboot
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server&gt;</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">
<title>openstack server rebuild</title>
<screen><computeroutput>usage: openstack server rebuild [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX] --image &lt;image&gt;
[--password &lt;password&gt;] [--wait]
&lt;server&gt;</computeroutput></screen>
<para>
Rebuild server
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server&gt;</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 &lt;image&gt;</command></term>
<listitem>
<para>
Recreate server from this image
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--password &lt;password&gt;</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">
<title>openstack server remove security group</title>
<screen><computeroutput>usage: openstack server remove security group [-h] &lt;server&gt; &lt;group&gt;</computeroutput></screen>
<para>
Remove security group from server
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server&gt;</command></term>
<listitem>
<para>
Name or ID of server to use
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;group&gt;</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">
<title>openstack server remove volume</title>
<screen><computeroutput>usage: openstack server remove volume [-h] &lt;server&gt; &lt;volume&gt;</computeroutput></screen>
<para>
Remove volume from server
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server&gt;</command></term>
<listitem>
<para>
Server (name or ID)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;volume&gt;</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">
<title>openstack server rescue</title>
<screen><computeroutput>usage: openstack server rescue [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX]
&lt;server&gt;</computeroutput></screen>
<para>
Put server in rescue mode
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server&gt;</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">
<title>openstack server resize</title>
<screen><computeroutput>usage: openstack server resize [-h] [--flavor &lt;flavor&gt; | --verify | --revert]
[--wait]
&lt;server&gt;</computeroutput></screen>
<para>
Scale server to a new flavor
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server&gt;</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 &lt;flavor&gt;</command></term>
<listitem>
<para>
Resize server to specified flavor
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--verify</command></term>
<listitem>
<para>
Verify 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">
<title>openstack server resume</title>
<screen><computeroutput>usage: openstack server resume [-h] &lt;server&gt;</computeroutput></screen>
<para>
Resume server
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server&gt;</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">
<title>openstack server set</title>
<screen><computeroutput>usage: openstack server set [-h] [--name &lt;new-name&gt;] [--root-password]
[--property &lt;key=value&gt;]
&lt;server&gt;</computeroutput></screen>
<para>
Set server properties
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server&gt;</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 &lt;new-name&gt;</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 &lt;key=value&gt;</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">
<title>openstack server show</title>
<screen><computeroutput>usage: openstack server show [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX] [--diagnostics]
&lt;server&gt;</computeroutput></screen>
<para>
Show server details
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server&gt;</command></term>
<listitem>
<para>
Server to show (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 diagnostics information for a given server
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_server_ssh">
<title>openstack server ssh</title>
<screen><computeroutput>usage: openstack server ssh [-h] [--login &lt;login-name&gt;] [--port &lt;port&gt;]
[--identity &lt;keyfile&gt;] [--option &lt;config-options&gt;]
[-4 | -6]
[--public | --private | --address-type &lt;address-type&gt;]
&lt;server&gt;</computeroutput></screen>
<para>
Ssh to server
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server&gt;</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 &lt;login-name&gt;</command></term>
<listitem>
<para>
Login name (ssh -l option)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--port &lt;port&gt;</command></term>
<listitem>
<para>
Destination port (ssh -p option)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--identity &lt;keyfile&gt;</command></term>
<listitem>
<para>
Private key file (ssh -i option)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--option &lt;config-options&gt;</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 &lt;address-type&gt;</command></term>
<listitem>
<para>
Use other IP address (public, private, etc)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_server_suspend">
<title>openstack server suspend</title>
<screen><computeroutput>usage: openstack server suspend [-h] &lt;server&gt;</computeroutput></screen>
<para>
Suspend server
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server&gt;</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">
<title>openstack server unlock</title>
<screen><computeroutput>usage: openstack server unlock [-h] &lt;server&gt;</computeroutput></screen>
<para>
Unlock server
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server&gt;</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">
<title>openstack server unpause</title>
<screen><computeroutput>usage: openstack server unpause [-h] &lt;server&gt;</computeroutput></screen>
<para>
Unpause server
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server&gt;</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">
<title>openstack server unrescue</title>
<screen><computeroutput>usage: openstack server unrescue [-h] &lt;server&gt;</computeroutput></screen>
<para>
Restore server from rescue mode
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server&gt;</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">
<title>openstack server unset</title>
<screen><computeroutput>usage: openstack server unset [-h] [--property &lt;key&gt;] &lt;server&gt;</computeroutput></screen>
<para>
Unset server properties
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;server&gt;</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 &lt;key&gt;</command></term>
<listitem>
<para>
Property key to remove from server (repeat to set multiple
values)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_service_create">
<title>openstack service create</title>
<screen><computeroutput>usage: openstack service create [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX] --type &lt;service-type&gt;
[--description &lt;service-description&gt;]
&lt;service-name&gt;</computeroutput></screen>
<para>
Create new service
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;service-name&gt;</command></term>
<listitem>
<para>
New service 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>--type &lt;service-type&gt;</command></term>
<listitem>
<para>
New service type (compute, image, identity, volume,
etc)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description &lt;service-description&gt;</command></term>
<listitem>
<para>
New service description
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_service_delete">
<title>openstack service delete</title>
<screen><computeroutput>usage: openstack service delete [-h] &lt;service&gt;</computeroutput></screen>
<para>
Delete service
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;service&gt;</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">
<title>openstack service list</title>
<screen><computeroutput>usage: openstack service list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--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">
<title>openstack service show</title>
<screen><computeroutput>usage: openstack service show [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX] [--catalog]
&lt;service&gt;</computeroutput></screen>
<para>
Show service details
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;service&gt;</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">
<title>openstack snapshot create</title>
<screen><computeroutput>usage: openstack snapshot create [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX] --name &lt;name&gt;
[--description &lt;description&gt;] [--force]
&lt;volume&gt;</computeroutput></screen>
<para>
Create snapshot command
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume&gt;</command></term>
<listitem>
<para>
The name or ID of the volume to snapshot
</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 &lt;name&gt;</command></term>
<listitem>
<para>
Name of the snapshot
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description &lt;description&gt;</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">
<title>openstack snapshot delete</title>
<screen><computeroutput>usage: openstack snapshot delete [-h] &lt;snapshot&gt;</computeroutput></screen>
<para>
Delete snapshot command
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;snapshot&gt;</command></term>
<listitem>
<para>
Name or ID of snapshot 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_snapshot_list">
<title>openstack snapshot list</title>
<screen><computeroutput>usage: openstack snapshot list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
<para>
List snapshot 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_snapshot_set">
<title>openstack snapshot set</title>
<screen><computeroutput>usage: openstack snapshot set [-h] [--name &lt;new-snapshot-name&gt;]
[--description &lt;new-snapshot-description&gt;]
&lt;snapshot&gt;</computeroutput></screen>
<para>
Set snapshot command
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;snapshot&gt;</command></term>
<listitem>
<para>
Name or ID of snapshot 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 &lt;new-snapshot-name&gt;</command></term>
<listitem>
<para>
New snapshot name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description &lt;new-snapshot-description&gt;</command></term>
<listitem>
<para>
New snapshot description
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_snapshot_show">
<title>openstack snapshot show</title>
<screen><computeroutput>usage: openstack snapshot show [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX]
&lt;snapshot&gt;</computeroutput></screen>
<para>
Show snapshot command
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;snapshot&gt;</command></term>
<listitem>
<para>
Name or ID of snapshot 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_token_issue">
<title>openstack token issue</title>
<screen><computeroutput>usage: openstack token issue [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--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">
<title>openstack token revoke</title>
<screen><computeroutput>usage: openstack token revoke [-h] &lt;token&gt;</computeroutput></screen>
<para>
Revoke existing token
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;token&gt;</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_user_create">
<title>openstack user create</title>
<screen><computeroutput>usage: openstack user create [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX] [--password &lt;user-password&gt;]
[--password-prompt] [--email &lt;user-email&gt;]
[--project &lt;project&gt;] [--enable | --disable]
&lt;user-name&gt;</computeroutput></screen>
<para>
Create new user
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;user-name&gt;</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>--password &lt;user-password&gt;</command></term>
<listitem>
<para>
New 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 &lt;user-email&gt;</command></term>
<listitem>
<para>
New user email address
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--project &lt;project&gt;</command></term>
<listitem>
<para>
Set default project (name or ID)
</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_delete">
<title>openstack user delete</title>
<screen><computeroutput>usage: openstack user delete [-h] &lt;user&gt;</computeroutput></screen>
<para>
Delete user
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;user&gt;</command></term>
<listitem>
<para>
User 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">
<title>openstack user list</title>
<screen><computeroutput>usage: openstack user list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]
[--project &lt;project&gt;] [--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 &lt;project&gt;</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">
<title>openstack user role list</title>
<screen><computeroutput>usage: openstack user role list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]
[--project &lt;project&gt;]
[&lt;user&gt;]</computeroutput></screen>
<para>
List user-role assignments
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;user&gt;</command></term>
<listitem>
<para>
Name or ID of user to include
</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 &lt;project&gt;</command></term>
<listitem>
<para>
Include project (name or ID)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_user_set">
<title>openstack user set</title>
<screen><computeroutput>usage: openstack user set [-h] [--name &lt;new-user-name&gt;]
[--password &lt;user-password&gt;] [--password-prompt]
[--email &lt;user-email&gt;] [--project &lt;project&gt;]
[--enable | --disable]
&lt;user&gt;</computeroutput></screen>
<para>
Set user properties
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;user&gt;</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 &lt;new-user-name&gt;</command></term>
<listitem>
<para>
New user name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--password &lt;user-password&gt;</command></term>
<listitem>
<para>
New 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 &lt;user-email&gt;</command></term>
<listitem>
<para>
New user email address
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--project &lt;project&gt;</command></term>
<listitem>
<para>
New default project (name or ID)
</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">
<title>openstack user show</title>
<screen><computeroutput>usage: openstack user show [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX]
&lt;user&gt;</computeroutput></screen>
<para>
Show user details
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;user&gt;</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">
<title>openstack volume create</title>
<screen><computeroutput>usage: openstack volume create [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX] --size &lt;size&gt;
[--snapshot-id &lt;snapshot-id&gt;]
[--description &lt;description&gt;]
[--type &lt;volume-type&gt;] [--user &lt;user&gt;]
[--project &lt;project&gt;]
[--availability-zone &lt;availability-zone&gt;]
[--property &lt;key=value&gt;] [--image &lt;image&gt;]
[--source &lt;volume&gt;]
&lt;name&gt;</computeroutput></screen>
<para>
Create new volume
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;name&gt;</command></term>
<listitem>
<para>
Name of the new volume
</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 &lt;size&gt;</command></term>
<listitem>
<para>
New volume size
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--snapshot-id &lt;snapshot-id&gt;</command></term>
<listitem>
<para>
Use &lt;snapshot-id&gt; as source of new volume
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description &lt;description&gt;</command></term>
<listitem>
<para>
Description of the volume
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--type &lt;volume-type&gt;</command></term>
<listitem>
<para>
Type of volume
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--user &lt;user&gt;</command></term>
<listitem>
<para>
Specify a different user (admin only)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--project &lt;project&gt;</command></term>
<listitem>
<para>
Specify a different project (admin only)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--availability-zone &lt;availability-zone&gt;</command></term>
<listitem>
<para>
Create new volume in &lt;availability-zone&gt;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--property &lt;key=value&gt;</command></term>
<listitem>
<para>
Property to store for this volume (repeat option to
set multiple properties)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--image &lt;image&gt;</command></term>
<listitem>
<para>
Use &lt;image&gt; as source of new volume
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--source &lt;volume&gt;</command></term>
<listitem>
<para>
Volume to clone (name or ID)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_volume_delete">
<title>openstack volume delete</title>
<screen><computeroutput>usage: openstack volume delete [-h] [--force] &lt;volume&gt;</computeroutput></screen>
<para>
Delete a volume
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume&gt;</command></term>
<listitem>
<para>
Volume 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 a volume, regardless of state
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_volume_list">
<title>openstack volume list</title>
<screen><computeroutput>usage: openstack volume list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]
[--status &lt;status&gt;] [--name &lt;name&gt;]
[--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>--status &lt;status&gt;</command></term>
<listitem>
<para>
Filter results by status
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--name &lt;name&gt;</command></term>
<listitem>
<para>
Filter results by name
</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>
Display properties
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_volume_set">
<title>openstack volume set</title>
<screen><computeroutput>usage: openstack volume set [-h] [--name &lt;new-name&gt;]
[--description &lt;new-description&gt;]
[--property &lt;key=value&gt;]
&lt;volume&gt;</computeroutput></screen>
<para>
Set volume properties
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume&gt;</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 &lt;new-name&gt;</command></term>
<listitem>
<para>
New volume name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description &lt;new-description&gt;</command></term>
<listitem>
<para>
New volume description
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--property &lt;key=value&gt;</command></term>
<listitem>
<para>
Property to add/change for this volume (repeat option
to set multiple properties)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_volume_show">
<title>openstack volume show</title>
<screen><computeroutput>usage: openstack volume show [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--variable VARIABLE]
[--prefix PREFIX]
&lt;volume&gt;</computeroutput></screen>
<para>
Show volume details
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume&gt;</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">
<title>openstack volume type create</title>
<screen><computeroutput>usage: openstack volume type create [-h] [-f {shell,table,value}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--variable VARIABLE] [--prefix PREFIX]
[--property &lt;key=value&gt;]
&lt;name&gt;</computeroutput></screen>
<para>
Create new volume type
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;name&gt;</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 &lt;key=value&gt;</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">
<title>openstack volume type delete</title>
<screen><computeroutput>usage: openstack volume type delete [-h] &lt;volume-type&gt;</computeroutput></screen>
<para>
Delete volume type
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume-type&gt;</command></term>
<listitem>
<para>
Name or ID of volume type 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_volume_type_list">
<title>openstack volume type list</title>
<screen><computeroutput>usage: openstack volume type list [-h] [-f {csv,table}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--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">
<title>openstack volume type set</title>
<screen><computeroutput>usage: openstack volume type set [-h] [--property &lt;key=value&gt;] &lt;volume-type&gt;</computeroutput></screen>
<para>
Set volume type property
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume-type&gt;</command></term>
<listitem>
<para>
Volume type name or ID to update
</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 &lt;key=value&gt;</command></term>
<listitem>
<para>
Property to add/change for this volume type (repeat
option to set multiple properties)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_volume_type_unset">
<title>openstack volume type unset</title>
<screen><computeroutput>usage: openstack volume type unset [-h] [--property &lt;key&gt;] &lt;volume-type&gt;</computeroutput></screen>
<para>
Unset volume type property
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume-type&gt;</command></term>
<listitem>
<para>
Type ID or name to remove
</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 &lt;key&gt;</command></term>
<listitem>
<para>
Property key to remove from volume (repeat option to
remove multiple properties)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_volume_unset">
<title>openstack volume unset</title>
<screen><computeroutput>usage: openstack volume unset [-h] [--property &lt;key&gt;] &lt;volume&gt;</computeroutput></screen>
<para>
Unset volume properties
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;volume&gt;</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>--property &lt;key&gt;</command></term>
<listitem>
<para>
Property key to remove from volume (repeat to set multiple
values)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</chapter>