7d65f6c473
Regenerate documentation for openstack. Change-Id: Icd8345c583934cb041a7756ceedeb2e980dfed97
6604 lines
195 KiB
XML
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 <auth-url>]
|
|
[--os-domain-name <auth-domain-name>]
|
|
[--os-domain-id <auth-domain-id>]
|
|
[--os-project-name <auth-project-name>]
|
|
[--os-project-id <auth-project-id>]
|
|
[--os-username <auth-username>]
|
|
[--os-password <auth-password>]
|
|
[--os-user-domain-name <auth-user-domain-name>]
|
|
[--os-user-domain-id <auth-user-domain-id>]
|
|
[--os-project-domain-name <auth-project-domain-name>]
|
|
[--os-project-domain-id <auth-project-domain-id>]
|
|
[--os-region-name <auth-region-name>]
|
|
[--os-cacert <ca-bundle-file>] [--verify | --insecure]
|
|
[--os-default-domain <auth-domain>] [--os-token <token>]
|
|
[--os-url <url>] [--timing]
|
|
[--os-compute-api-version <compute-api-version>]
|
|
[--os-network-api-version <network-api-version>]
|
|
[--os-image-api-version <image-api-version>]
|
|
[--os-volume-api-version <volume-api-version>]
|
|
[--os-identity-api-version <identity-api-version>]
|
|
[--os-trust-id <trust-id>]
|
|
[--os-object-api-version <object-api-version>] [-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 <auth-url></command></term>
|
|
<listitem>
|
|
<para>
|
|
Authentication URL (Env: OS_AUTH_URL)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-domain-name <auth-domain-name></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 <auth-domain-id></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 <auth-project-name></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 <auth-project-id></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 <auth-username></command></term>
|
|
<listitem>
|
|
<para>
|
|
Authentication username (Env: OS_USERNAME)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-password <auth-password></command></term>
|
|
<listitem>
|
|
<para>
|
|
Authentication password (Env: OS_PASSWORD)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-user-domain-name <auth-user-domain-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain name of the user (Env: OS_USER_DOMAIN_NAME)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-user-domain-id <auth-user-domain-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Domain ID of the user (Env: OS_USER_DOMAIN_ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-project-domain-name <auth-project-domain-name></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 <auth-project-domain-id></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 <auth-region-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Authentication region name (Env: OS_REGION_NAME)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-cacert <ca-bundle-file></command></term>
|
|
<listitem>
|
|
<para>
|
|
CA certificate bundle file (Env: OS_CACERT)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--verify</command></term>
|
|
<listitem>
|
|
<para>
|
|
Verify server certificate (default)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--insecure</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disable server certificate verification
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-default-domain <auth-domain></command></term>
|
|
<listitem>
|
|
<para>
|
|
Default domain ID, default=default (Env:
|
|
OS_DEFAULT_DOMAIN)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-token <token></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_TOKEN]</code>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-url <url></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 <compute-api-version></command></term>
|
|
<listitem>
|
|
<para>
|
|
Compute API version, default=2 (Env:
|
|
OS_COMPUTE_API_VERSION)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-network-api-version <network-api-version></command></term>
|
|
<listitem>
|
|
<para>
|
|
Network API version, default=2 (Env:
|
|
OS_NETWORK_API_VERSION)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-image-api-version <image-api-version></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image API version, default=1 (Env:
|
|
OS_IMAGE_API_VERSION)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-volume-api-version <volume-api-version></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume API version, default=1 (Env:
|
|
OS_VOLUME_API_VERSION)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-identity-api-version <identity-api-version></command></term>
|
|
<listitem>
|
|
<para>
|
|
Identity API version, default=2.0 (Env:
|
|
OS_IDENTITY_API_VERSION)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-trust-id <trust-id></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 <object-api-version></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 <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
<aggregate> <host></computeroutput></screen>
|
|
<para>
|
|
Add host to aggregate
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><aggregate></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of aggregate
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><host></command></term>
|
|
<listitem>
|
|
<para>
|
|
Host to add to aggregate
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_aggregate_create">
|
|
<title>openstack aggregate create</title>
|
|
<screen><computeroutput>usage: openstack aggregate create [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--zone <availability-zone>]
|
|
[--property <key=value>]
|
|
<name></computeroutput></screen>
|
|
<para>
|
|
Create a new aggregate
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New aggregate name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--zone <availability-zone></command></term>
|
|
<listitem>
|
|
<para>
|
|
Availability zone name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property to add to this aggregate (repeat option to
|
|
set multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_aggregate_delete">
|
|
<title>openstack aggregate delete</title>
|
|
<screen><computeroutput>usage: openstack aggregate delete [-h] <aggregate></computeroutput></screen>
|
|
<para>
|
|
Delete an existing aggregate
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><aggregate></command></term>
|
|
<listitem>
|
|
<para>
|
|
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 <integer>]
|
|
[--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 <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
<aggregate> <host></computeroutput></screen>
|
|
<para>
|
|
Remove host from aggregate
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><aggregate></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of aggregate
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><host></command></term>
|
|
<listitem>
|
|
<para>
|
|
Host to remove from aggregate
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_aggregate_set">
|
|
<title>openstack aggregate set</title>
|
|
<screen><computeroutput>usage: openstack aggregate set [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--name <new-name>]
|
|
[--zone <availability-zone>]
|
|
[--property <key=value>]
|
|
<aggregate></computeroutput></screen>
|
|
<para>
|
|
Set aggregate properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><aggregate></command></term>
|
|
<listitem>
|
|
<para>
|
|
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 <new-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New aggregate name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--zone <availability-zone></command></term>
|
|
<listitem>
|
|
<para>
|
|
Availability zone name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property to add/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 <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
<aggregate></computeroutput></screen>
|
|
<para>
|
|
Show a specific aggregate
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><aggregate></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 <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--container <container>]
|
|
[--name <name>] [--description <description>]
|
|
<volume></computeroutput></screen>
|
|
<para>
|
|
Create backup command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></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 <container></command></term>
|
|
<listitem>
|
|
<para>
|
|
Optional backup container name.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the backup
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Description of the backup
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_backup_delete">
|
|
<title>openstack backup delete</title>
|
|
<screen><computeroutput>usage: openstack backup delete [-h] <backup></computeroutput></screen>
|
|
<para>
|
|
Delete backup command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><backup></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 <integer>]
|
|
[--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] <backup> <dest-volume></computeroutput></screen>
|
|
<para>
|
|
Restore backup command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><backup></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of backup to restore
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><dest-volume></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 <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
<backup></computeroutput></screen>
|
|
<para>
|
|
Show backup command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><backup></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 <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
<os> <architecture> <version> <url>
|
|
<md5hash> <hypervisor></computeroutput></screen>
|
|
<para>
|
|
Create compute agent command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><os></command></term>
|
|
<listitem>
|
|
<para>
|
|
Type of OS
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><architecture></command></term>
|
|
<listitem>
|
|
<para>
|
|
Type of architecture
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><version></command></term>
|
|
<listitem>
|
|
<para>
|
|
Version
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><url></command></term>
|
|
<listitem>
|
|
<para>
|
|
URL
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><md5hash></command></term>
|
|
<listitem>
|
|
<para>
|
|
MD5 hash
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><hypervisor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Type of hypervisor
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_compute_agent_delete">
|
|
<title>openstack compute agent delete</title>
|
|
<screen><computeroutput>usage: openstack compute agent delete [-h] <id></computeroutput></screen>
|
|
<para>
|
|
Delete compute agent command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of agent to delete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_compute_agent_list">
|
|
<title>openstack compute agent list</title>
|
|
<screen><computeroutput>usage: openstack compute agent list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--hypervisor <hypervisor>]</computeroutput></screen>
|
|
<para>
|
|
List compute agent command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--hypervisor <hypervisor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Type of hypervisor
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_compute_agent_set">
|
|
<title>openstack compute agent set</title>
|
|
<screen><computeroutput>usage: openstack compute agent set [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
<id> <version> <url> <md5hash></computeroutput></screen>
|
|
<para>
|
|
Set compute agent command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><id></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the agent
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><version></command></term>
|
|
<listitem>
|
|
<para>
|
|
Version of the agent
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><url></command></term>
|
|
<listitem>
|
|
<para>
|
|
URL
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><md5hash></command></term>
|
|
<listitem>
|
|
<para>
|
|
MD5 hash
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_compute_service_list">
|
|
<title>openstack compute service list</title>
|
|
<screen><computeroutput>usage: openstack compute service list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--host <host>] [--service <service>]</computeroutput></screen>
|
|
<para>
|
|
List service command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--host <host></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of host
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--service <service></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of service
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_compute_service_set">
|
|
<title>openstack compute service set</title>
|
|
<screen><computeroutput>usage: openstack compute service set [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--enable | --disable]
|
|
<host> <service></computeroutput></screen>
|
|
<para>
|
|
Set service command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><host></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of host
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><service></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of service
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--enable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Enable a service
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disable</command></term>
|
|
<listitem>
|
|
<para>
|
|
Disable a service
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_console_log_show">
|
|
<title>openstack console log show</title>
|
|
<screen><computeroutput>usage: openstack console log show [-h] [--lines <num-lines>] <server></computeroutput></screen>
|
|
<para>
|
|
Show server's console output
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--lines <num-lines></command></term>
|
|
<listitem>
|
|
<para>
|
|
Number of lines to display from the end of the log
|
|
(default=all)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_console_url_show">
|
|
<title>openstack console url show</title>
|
|
<screen><computeroutput>usage: openstack console url show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--novnc | --xvpvnc | --spice]
|
|
<server></computeroutput></screen>
|
|
<para>
|
|
Show server's remote console URL
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (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 <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
<container></computeroutput></screen>
|
|
<para>
|
|
Create a container
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container></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] <container></computeroutput></screen>
|
|
<para>
|
|
Delete a container
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container></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 <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--prefix <prefix>] [--marker <marker>]
|
|
[--end-marker <end-marker>] [--limit <limit>]
|
|
[--long] [--all]</computeroutput></screen>
|
|
<para>
|
|
List containers
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--prefix <prefix></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter list using <prefix>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--marker <marker></command></term>
|
|
<listitem>
|
|
<para>
|
|
Anchor for paging
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--end-marker <end-marker></command></term>
|
|
<listitem>
|
|
<para>
|
|
End anchor for paging
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--limit <limit></command></term>
|
|
<listitem>
|
|
<para>
|
|
Limit the number of containers returned
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--long</command></term>
|
|
<listitem>
|
|
<para>
|
|
List additional fields in output
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--all</command></term>
|
|
<listitem>
|
|
<para>
|
|
List all containers (default is 10000)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_container_show">
|
|
<title>openstack container show</title>
|
|
<screen><computeroutput>usage: openstack container show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
<container></computeroutput></screen>
|
|
<para>
|
|
Show container information
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container></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 <integer>]
|
|
[--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
[--project <project>] [--user <user>]</computeroutput></screen>
|
|
<para>
|
|
Create EC2 credentials
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify a project [admin only]
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user <user></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 <user>] <access-key></computeroutput></screen>
|
|
<para>
|
|
Delete EC2 credentials
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><access-key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Credentials access key
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user <user></command></term>
|
|
<listitem>
|
|
<para>
|
|
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 <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--user <user>]</computeroutput></screen>
|
|
<para>
|
|
List EC2 credentials
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user <user></command></term>
|
|
<listitem>
|
|
<para>
|
|
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 <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--user <user>]
|
|
<access-key></computeroutput></screen>
|
|
<para>
|
|
Show EC2 credentials
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><access-key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Credentials access key
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user <user></command></term>
|
|
<listitem>
|
|
<para>
|
|
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 <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--region <region>]
|
|
--publicurl <public-url>
|
|
[--adminurl <admin-url>]
|
|
[--internalurl <internal-url>]
|
|
<endpoint-service></computeroutput></screen>
|
|
<para>
|
|
Create endpoint command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><endpoint-service></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 <region></command></term>
|
|
<listitem>
|
|
<para>
|
|
New endpoint region
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--publicurl <public-url></command></term>
|
|
<listitem>
|
|
<para>
|
|
New endpoint public URL
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--adminurl <admin-url></command></term>
|
|
<listitem>
|
|
<para>
|
|
New endpoint admin URL
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--internalurl <internal-url></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] <endpoint-id></computeroutput></screen>
|
|
<para>
|
|
Delete endpoint command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><endpoint-id></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 <integer>]
|
|
[--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 <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
<endpoint_or_service></computeroutput></screen>
|
|
<para>
|
|
Show endpoint command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><endpoint_or_service></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 <integer>]
|
|
[--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 <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--id <id>] [--ram <size-mb>]
|
|
[--disk <size-gb>] [--ephemeral <size-gb>]
|
|
[--swap <size-gb>] [--vcpus <vcpus>]
|
|
[--rxtx-factor <factor>] [--public | --private]
|
|
<name></computeroutput></screen>
|
|
<para>
|
|
Create new flavor
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New flavor name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--id <id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Unique flavor ID; 'auto' will create a UUID (default:
|
|
auto)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ram <size-mb></command></term>
|
|
<listitem>
|
|
<para>
|
|
Memory size in MB (default 256M)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disk <size-gb></command></term>
|
|
<listitem>
|
|
<para>
|
|
Disk size in GB (default 0G)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ephemeral <size-gb></command></term>
|
|
<listitem>
|
|
<para>
|
|
Ephemeral disk size in GB (default 0G)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--swap <size-gb></command></term>
|
|
<listitem>
|
|
<para>
|
|
Swap space size in GB (default 0G)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--vcpus <vcpus></command></term>
|
|
<listitem>
|
|
<para>
|
|
Number of vcpus (default 1)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--rxtx-factor <factor></command></term>
|
|
<listitem>
|
|
<para>
|
|
RX/TX factor (default 1)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--public</command></term>
|
|
<listitem>
|
|
<para>
|
|
Flavor is 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] <flavor></computeroutput></screen>
|
|
<para>
|
|
Delete a flavor
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><flavor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Flavor to delete (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_flavor_list">
|
|
<title>openstack flavor list</title>
|
|
<screen><computeroutput>usage: openstack flavor list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--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 <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
<flavor></computeroutput></screen>
|
|
<para>
|
|
Show flavor details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><flavor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Flavor to display (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_host_list">
|
|
<title>openstack host list</title>
|
|
<screen><computeroutput>usage: openstack host list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--zone <zone>]</computeroutput></screen>
|
|
<para>
|
|
List host command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--zone <zone></command></term>
|
|
<listitem>
|
|
<para>
|
|
Only return hosts in the availability zone.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_host_show">
|
|
<title>openstack host show</title>
|
|
<screen><computeroutput>usage: openstack host show [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
<host></computeroutput></screen>
|
|
<para>
|
|
Show host command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><host></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of host
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_hypervisor_list">
|
|
<title>openstack hypervisor list</title>
|
|
<screen><computeroutput>usage: openstack hypervisor list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--matching <hostname-str>]</computeroutput></screen>
|
|
<para>
|
|
List hypervisors
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--matching <hostname-str></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter hypervisors using <hostname-str> 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 <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
<id></computeroutput></screen>
|
|
<para>
|
|
Show hypervisor details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><id></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 <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--id <id>] [--store <store>]
|
|
[--container-format <container-format>]
|
|
[--disk-format <disk-format>]
|
|
[--owner <project>] [--size <size>]
|
|
[--min-disk <disk-gb>] [--min-ram <ram-mb>]
|
|
[--location <image-url>]
|
|
[--copy-from <image-url>] [--file <file>]
|
|
[--volume <volume>] [--force]
|
|
[--checksum <checksum>]
|
|
[--protected | --unprotected]
|
|
[--public | --private] [--property <key=value>]
|
|
<name></computeroutput></screen>
|
|
<para>
|
|
Create/upload an image
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New image name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--id <id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image ID to reserve
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--store <store></command></term>
|
|
<listitem>
|
|
<para>
|
|
Upload image to this store
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--container-format <container-format></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image container format (default: bare)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--disk-format <disk-format></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image disk format (default: raw)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--owner <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image owner project name or ID
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--size <size></command></term>
|
|
<listitem>
|
|
<para>
|
|
Image size, in bytes (only used with --location and
|
|
--copy-from)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--min-disk <disk-gb></command></term>
|
|
<listitem>
|
|
<para>
|
|
Minimum disk size needed to boot image, in gigabytes
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--min-ram <ram-mb></command></term>
|
|
<listitem>
|
|
<para>
|
|
Minimum RAM size needed to boot image, in megabytes
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--location <image-url></command></term>
|
|
<listitem>
|
|
<para>
|
|
Download image from an existing URL
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--copy-from <image-url></command></term>
|
|
<listitem>
|
|
<para>
|
|
Copy image from the data store (similar to --location)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--file <file></command></term>
|
|
<listitem>
|
|
<para>
|
|
Upload image from local file
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--volume <volume></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 <checksum></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 <key=value></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] <image></computeroutput></screen>
|
|
<para>
|
|
Delete an image
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><image></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 <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--page-size <size>] [--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 <size></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 <filename>] <image></computeroutput></screen>
|
|
<para>
|
|
Save an image locally
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><image></command></term>
|
|
<listitem>
|
|
<para>
|
|
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 <filename></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 <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--name <name>]
|
|
[--owner <project>] [--min-disk <disk-gb>]
|
|
[--min-ram <disk-ram>]
|
|
[--protected | --unprotected]
|
|
[--public | --private] [--property <key=value>]
|
|
<image></computeroutput></screen>
|
|
<para>
|
|
Change image properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><image></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 <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New image name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--owner <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
New image owner project name or ID
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--min-disk <disk-gb></command></term>
|
|
<listitem>
|
|
<para>
|
|
Minimum disk size needed to boot image, in gigabytes
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--min-ram <disk-ram></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 <key=value></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 <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
<image></computeroutput></screen>
|
|
<para>
|
|
Show image details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><image></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] <network> <server></computeroutput></screen>
|
|
<para>
|
|
Add fixed-ip command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><network></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the network to fetch an IP address from
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the server to receive the IP address
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_ip_fixed_remove">
|
|
<title>openstack ip fixed remove</title>
|
|
<screen><computeroutput>usage: openstack ip fixed remove [-h] <ip-address> <server></computeroutput></screen>
|
|
<para>
|
|
Remove fixed-ip command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><ip-address></command></term>
|
|
<listitem>
|
|
<para>
|
|
IP address to remove from server
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the server to remove the IP address from
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_ip_floating_add">
|
|
<title>openstack ip floating add</title>
|
|
<screen><computeroutput>usage: openstack ip floating add [-h] <ip-address> <server></computeroutput></screen>
|
|
<para>
|
|
Add floating-ip to server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><ip-address></command></term>
|
|
<listitem>
|
|
<para>
|
|
IP address to add to server
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server to receive the IP address (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_ip_floating_create">
|
|
<title>openstack ip floating create</title>
|
|
<screen><computeroutput>usage: openstack ip floating create [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
<pool></computeroutput></screen>
|
|
<para>
|
|
Create new floating-ip
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><pool></command></term>
|
|
<listitem>
|
|
<para>
|
|
Pool to fetch floating IP from
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_ip_floating_delete">
|
|
<title>openstack ip floating delete</title>
|
|
<screen><computeroutput>usage: openstack ip floating delete [-h] <ip-address></computeroutput></screen>
|
|
<para>
|
|
Delete a floating-ip
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><ip-address></command></term>
|
|
<listitem>
|
|
<para>
|
|
IP address to delete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_ip_floating_list">
|
|
<title>openstack ip floating list</title>
|
|
<screen><computeroutput>usage: openstack ip floating list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--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 <integer>]
|
|
[--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] <ip-address> <server></computeroutput></screen>
|
|
<para>
|
|
Remove floating-ip from server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><ip-address></command></term>
|
|
<listitem>
|
|
<para>
|
|
IP address to remove from server
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server to remove the IP address from (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_keypair_create">
|
|
<title>openstack keypair create</title>
|
|
<screen><computeroutput>usage: openstack keypair create [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--public-key <file>]
|
|
<name></computeroutput></screen>
|
|
<para>
|
|
Create new keypair
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></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 <file></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] <name></computeroutput></screen>
|
|
<para>
|
|
Delete a keypair
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></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 <integer>]
|
|
[--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 <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--public-key]
|
|
<name></computeroutput></screen>
|
|
<para>
|
|
Show keypair details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></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 <integer>]
|
|
[--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 <integer>] [--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 <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--enable | --disable]
|
|
[--share | --no-share]
|
|
<network_name></computeroutput></screen>
|
|
<para>
|
|
Create a network
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><network_name></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] <network></computeroutput></screen>
|
|
<para>
|
|
Delete a network
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><network></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 <integer>]
|
|
[--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 <network_name>] [--share | --no-share]
|
|
<network></computeroutput></screen>
|
|
<para>
|
|
Set network properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><network></command></term>
|
|
<listitem>
|
|
<para>
|
|
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 <network_name></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 <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
<network></computeroutput></screen>
|
|
<para>
|
|
Show network details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><network></command></term>
|
|
<listitem>
|
|
<para>
|
|
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 <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--prefix <prefix>] [--delimiter <delimiter>]
|
|
[--marker <marker>] [--end-marker <end-marker>]
|
|
[--limit <limit>] [--long] [--all]
|
|
<container-name></computeroutput></screen>
|
|
<para>
|
|
List objects
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container-name></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 <prefix></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter list using <prefix>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--delimiter <delimiter></command></term>
|
|
<listitem>
|
|
<para>
|
|
Roll up items with <delimiter>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--marker <marker></command></term>
|
|
<listitem>
|
|
<para>
|
|
Anchor for paging
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--end-marker <end-marker></command></term>
|
|
<listitem>
|
|
<para>
|
|
End anchor for paging
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--limit <limit></command></term>
|
|
<listitem>
|
|
<para>
|
|
Limit the number of objects returned
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--long</command></term>
|
|
<listitem>
|
|
<para>
|
|
List additional fields in output
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--all</command></term>
|
|
<listitem>
|
|
<para>
|
|
List all objects in container (default is 10000)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_object_show">
|
|
<title>openstack object show</title>
|
|
<screen><computeroutput>usage: openstack object show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
<container> <object></computeroutput></screen>
|
|
<para>
|
|
Show object information
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><container></command></term>
|
|
<listitem>
|
|
<para>
|
|
Container name for object to display
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><object></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 <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
[--description <project-description>]
|
|
[--enable | --disable]
|
|
[--property <key=value>]
|
|
<project-name></computeroutput></screen>
|
|
<para>
|
|
Create new project
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><project-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New project name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <project-description></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 <key=value></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] <project></computeroutput></screen>
|
|
<para>
|
|
Delete project
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><project></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 <integer>]
|
|
[--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 <new-project-name>]
|
|
[--description <project-description>]
|
|
[--enable | --disable] [--property <key=value>]
|
|
<project></computeroutput></screen>
|
|
<para>
|
|
Set project properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Project to 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 <new-project-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New project name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <project-description></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 <key=value></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 <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
<project></computeroutput></screen>
|
|
<para>
|
|
Show project details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Project to display (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_project_usage_list">
|
|
<title>openstack project usage list</title>
|
|
<screen><computeroutput>usage: openstack project usage list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--start <start>] [--end <end>]</computeroutput></screen>
|
|
<para>
|
|
List resource usage per project.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--start <start></command></term>
|
|
<listitem>
|
|
<para>
|
|
Usage range start date, ex 2012-01-20 (default: 4
|
|
weeks ago).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--end <end></command></term>
|
|
<listitem>
|
|
<para>
|
|
Usage range end date, ex 2012-01-20 (default:
|
|
tomorrow)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_quota_set">
|
|
<title>openstack quota set</title>
|
|
<screen><computeroutput>usage: openstack quota set [-h] [--class] [--properties <new-properties>]
|
|
[--ram <new-ram>]
|
|
[--secgroup-rules <new-secgroup-rules>]
|
|
[--instances <new-instances>]
|
|
[--key-pairs <new-key-pairs>]
|
|
[--fixed-ips <new-fixed-ips>]
|
|
[--secgroups <new-secgroups>]
|
|
[--injected-file-size <new-injected-file-size>]
|
|
[--floating-ips <new-floating-ips>]
|
|
[--injected-files <new-injected-files>]
|
|
[--cores <new-cores>]
|
|
[--injected-path-size <new-injected-path-size>]
|
|
[--gigabytes <new-gigabytes>]
|
|
[--volumes <new-volumes>]
|
|
[--snapshots <new-snapshots>]
|
|
<project/class></computeroutput></screen>
|
|
<para>
|
|
Set quotas for project or class
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><project/class></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set quotas for this project or class (name/ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--class</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set quotas for <class>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--properties <new-properties></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the properties quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ram <new-ram></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the ram quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--secgroup-rules <new-secgroup-rules></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the secgroup-rules quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--instances <new-instances></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the instances quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--key-pairs <new-key-pairs></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the key-pairs quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--fixed-ips <new-fixed-ips></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the fixed-ips quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--secgroups <new-secgroups></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the secgroups quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--injected-file-size <new-injected-file-size></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the injected-file-size quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--floating-ips <new-floating-ips></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the floating-ips quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--injected-files <new-injected-files></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the injected-files quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--cores <new-cores></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the cores quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--injected-path-size <new-injected-path-size></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the injected-path-size quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--gigabytes <new-gigabytes></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the gigabytes quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--volumes <new-volumes></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value for the volumes quota
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--snapshots <new-snapshots></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 <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--class | --default]
|
|
<project/class></computeroutput></screen>
|
|
<para>
|
|
Show quotas for project or class
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><project/class></command></term>
|
|
<listitem>
|
|
<para>
|
|
Show this project or class (name/ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--class</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show quotas for <class>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--default</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show default quotas for <project>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_role_add">
|
|
<title>openstack role add</title>
|
|
<screen><computeroutput>usage: openstack role add [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] --project <project> --user <user>
|
|
<role></computeroutput></screen>
|
|
<para>
|
|
Add role to project:user
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><role></command></term>
|
|
<listitem>
|
|
<para>
|
|
Role 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 <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Include project (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user <user></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 <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
<role-name></computeroutput></screen>
|
|
<para>
|
|
Create new role
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><role-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New role name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_role_delete">
|
|
<title>openstack role delete</title>
|
|
<screen><computeroutput>usage: openstack role delete [-h] <role></computeroutput></screen>
|
|
<para>
|
|
Delete existing role
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><role></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 <integer>]
|
|
[--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 <project> --user <user> <role></computeroutput></screen>
|
|
<para>
|
|
Remove role from project:user
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><role></command></term>
|
|
<listitem>
|
|
<para>
|
|
Role 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 <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Project to include (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user <user></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 <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
<role></computeroutput></screen>
|
|
<para>
|
|
Show single role
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><role></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 <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--description <description>]
|
|
<name></computeroutput></screen>
|
|
<para>
|
|
Create a new security group
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New security group name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Security group description
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_security_group_delete">
|
|
<title>openstack security group delete</title>
|
|
<screen><computeroutput>usage: openstack security group delete [-h] <group></computeroutput></screen>
|
|
<para>
|
|
Delete a security group
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><group></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of security group to delete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_security_group_list">
|
|
<title>openstack security group list</title>
|
|
<screen><computeroutput>usage: openstack security group list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--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 <integer>]
|
|
[--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
[--proto <proto>]
|
|
[--src-ip <ip-address>]
|
|
[--dst-port <port-range>]
|
|
<group></computeroutput></screen>
|
|
<para>
|
|
Create a new security group rule
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><group></command></term>
|
|
<listitem>
|
|
<para>
|
|
Create rule in this security group
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--proto <proto> IP</command></term>
|
|
<listitem>
|
|
<para>
|
|
protocol (icmp, tcp, udp; default: tcp)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--src-ip <ip-address></command></term>
|
|
<listitem>
|
|
<para>
|
|
Source IP (may use CIDR notation; default: 0.0.0.0/0)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--dst-port <port-range></command></term>
|
|
<listitem>
|
|
<para>
|
|
Destination port, may be a range: 137:139 (default: 0;
|
|
only required for proto tcp and udp)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_security_group_rule_delete">
|
|
<title>openstack security group rule delete</title>
|
|
<screen><computeroutput>usage: openstack security group rule delete [-h] [--proto <proto>]
|
|
[--src-ip <ip-address>]
|
|
[--dst-port <port-range>]
|
|
<group></computeroutput></screen>
|
|
<para>
|
|
Delete a security group rule
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><group></command></term>
|
|
<listitem>
|
|
<para>
|
|
Create rule in this security group
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--proto <proto> IP</command></term>
|
|
<listitem>
|
|
<para>
|
|
protocol (icmp, tcp, udp; default: tcp)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--src-ip <ip-address></command></term>
|
|
<listitem>
|
|
<para>
|
|
Source IP (may use CIDR notation; default: 0.0.0.0/0)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--dst-port <port-range></command></term>
|
|
<listitem>
|
|
<para>
|
|
Destination port, may be a range: 137:139 (default: 0;
|
|
only required for proto tcp and udp)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_security_group_rule_list">
|
|
<title>openstack security group rule list</title>
|
|
<screen><computeroutput>usage: openstack security group rule list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
<group></computeroutput></screen>
|
|
<para>
|
|
List all security group rules
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><group></command></term>
|
|
<listitem>
|
|
<para>
|
|
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 <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--name <new-name>]
|
|
[--description <description>]
|
|
<group></computeroutput></screen>
|
|
<para>
|
|
Set security group properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><group></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of security group to change
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <new-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New security group name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
New security group name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_security_group_show">
|
|
<title>openstack security group show</title>
|
|
<screen><computeroutput>usage: openstack security group show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
<group></computeroutput></screen>
|
|
<para>
|
|
Show a specific security group
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><group></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of security group to change
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_add_security_group">
|
|
<title>openstack server add security group</title>
|
|
<screen><computeroutput>usage: openstack server add security group [-h] <server> <group></computeroutput></screen>
|
|
<para>
|
|
Add security group to server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server to use
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><group></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of security group to 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 <device>] <server> <volume></computeroutput></screen>
|
|
<para>
|
|
Add volume to server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume to add (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--device <device></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server internal device name for volume
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_create">
|
|
<title>openstack server create</title>
|
|
<screen><computeroutput>usage: openstack server create [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] --image <image> --flavor
|
|
<flavor>
|
|
[--security-group <security-group-name>]
|
|
[--key-name <key-name>]
|
|
[--property <key=value>]
|
|
[--file <dest-filename=source-filename>]
|
|
[--user-data <user-data>]
|
|
[--availability-zone <zone-name>]
|
|
[--block-device-mapping <dev-name=mapping>]
|
|
[--nic <nic-config-string>]
|
|
[--hint <key=value>]
|
|
[--config-drive <config-drive-volume>|True]
|
|
[--min <count>] [--max <count>] [--wait]
|
|
<server-name></computeroutput></screen>
|
|
<para>
|
|
Create a new server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New server name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--image <image></command></term>
|
|
<listitem>
|
|
<para>
|
|
Create server from this image
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--flavor <flavor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Create server with this flavor
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--security-group <security-group-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Security group to assign to this server (repeat for
|
|
multiple groups)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--key-name <key-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Keypair to inject into this server (optional
|
|
extension)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set a property on this server (repeat for multiple
|
|
values)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--file <dest-filename=source-filename></command></term>
|
|
<listitem>
|
|
<para>
|
|
File to inject into image before boot (repeat for
|
|
multiple files)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user-data <user-data></command></term>
|
|
<listitem>
|
|
<para>
|
|
User data file to serve from the metadata server
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--availability-zone <zone-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Select an availability zone for the server
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--block-device-mapping <dev-name=mapping></command></term>
|
|
<listitem>
|
|
<para>
|
|
Map block devices; map is
|
|
<id>:<type>:<size(GB)>:<delete_on_terminate> (optional
|
|
extension)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--nic <nic-config-string></command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify NIC configuration (optional extension)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--hint <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Hints for the scheduler (optional extension)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--config-drive <config-drive-volume>|True</command></term>
|
|
<listitem>
|
|
<para>
|
|
Use specified volume as the config drive, or 'True' to
|
|
use an ephemeral drive
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--min <count></command></term>
|
|
<listitem>
|
|
<para>
|
|
Minimum number of servers to launch (default=1)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--max <count></command></term>
|
|
<listitem>
|
|
<para>
|
|
Maximum number of servers to launch (default=1)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--wait</command></term>
|
|
<listitem>
|
|
<para>
|
|
Wait for build to complete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_delete">
|
|
<title>openstack server delete</title>
|
|
<screen><computeroutput>usage: openstack server delete [-h] <server></computeroutput></screen>
|
|
<para>
|
|
Delete server command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></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 <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--name <image-name>] [--wait]
|
|
<server></computeroutput></screen>
|
|
<para>
|
|
Create a new disk image from a running server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <image-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of new image (default is server name)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--wait</command></term>
|
|
<listitem>
|
|
<para>
|
|
Wait for image create to complete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_list">
|
|
<title>openstack server list</title>
|
|
<screen><computeroutput>usage: openstack server list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--reservation-id <reservation-id>]
|
|
[--ip <ip-address-regex>]
|
|
[--ip6 <ip-address-regex>] [--name <name>]
|
|
[--status <status>] [--flavor <flavor>]
|
|
[--image <image>] [--host <hostname>]
|
|
[--instance-name <server-name>] [--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 <reservation-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Only return instances that match the reservation
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ip <ip-address-regex></command></term>
|
|
<listitem>
|
|
<para>
|
|
Regular expression to match IP addresses
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--ip6 <ip-address-regex></command></term>
|
|
<listitem>
|
|
<para>
|
|
Regular expression to match IPv6 addresses
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Regular expression to match names
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--status <status></command></term>
|
|
<listitem>
|
|
<para>
|
|
Search by server status
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--flavor <flavor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Search by flavor ID
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--image <image></command></term>
|
|
<listitem>
|
|
<para>
|
|
Search by image ID
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--host <hostname></command></term>
|
|
<listitem>
|
|
<para>
|
|
Search by hostname
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--instance-name <server-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Regular expression to match instance name (admin only)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--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] <server></computeroutput></screen>
|
|
<para>
|
|
Lock server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_migrate">
|
|
<title>openstack server migrate</title>
|
|
<screen><computeroutput>usage: openstack server migrate [-h] [--wait] [--live <hostname>]
|
|
[--shared-migration | --block-migration]
|
|
[--no-disk-overcommit | --disk-overcommit]
|
|
<server></computeroutput></screen>
|
|
<para>
|
|
Migrate server to different host
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server 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 <hostname></command></term>
|
|
<listitem>
|
|
<para>
|
|
Target hostname
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--shared-migration</command></term>
|
|
<listitem>
|
|
<para>
|
|
Perform a shared live migration (default)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--block-migration</command></term>
|
|
<listitem>
|
|
<para>
|
|
Perform a block live migration
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--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] <server></computeroutput></screen>
|
|
<para>
|
|
Pause server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_reboot">
|
|
<title>openstack server reboot</title>
|
|
<screen><computeroutput>usage: openstack server reboot [-h] [--hard | --soft] [--wait] <server></computeroutput></screen>
|
|
<para>
|
|
Perform a hard or soft server reboot
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--hard</command></term>
|
|
<listitem>
|
|
<para>
|
|
Perform a hard reboot
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--soft</command></term>
|
|
<listitem>
|
|
<para>
|
|
Perform a soft reboot
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--wait</command></term>
|
|
<listitem>
|
|
<para>
|
|
Wait for reboot to complete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_rebuild">
|
|
<title>openstack server rebuild</title>
|
|
<screen><computeroutput>usage: openstack server rebuild [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] --image <image>
|
|
[--password <password>] [--wait]
|
|
<server></computeroutput></screen>
|
|
<para>
|
|
Rebuild server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--image <image></command></term>
|
|
<listitem>
|
|
<para>
|
|
Recreate server from this image
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--password <password></command></term>
|
|
<listitem>
|
|
<para>
|
|
Set the password on the rebuilt instance
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--wait</command></term>
|
|
<listitem>
|
|
<para>
|
|
Wait for rebuild to complete
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_remove_security_group">
|
|
<title>openstack server remove security group</title>
|
|
<screen><computeroutput>usage: openstack server remove security group [-h] <server> <group></computeroutput></screen>
|
|
<para>
|
|
Remove security group from server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of server to use
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><group></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name or ID of security group to remove from server
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_remove_volume">
|
|
<title>openstack server remove volume</title>
|
|
<screen><computeroutput>usage: openstack server remove volume [-h] <server> <volume></computeroutput></screen>
|
|
<para>
|
|
Remove volume from server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume to remove (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_rescue">
|
|
<title>openstack server rescue</title>
|
|
<screen><computeroutput>usage: openstack server rescue [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
<server></computeroutput></screen>
|
|
<para>
|
|
Put server in rescue mode
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_resize">
|
|
<title>openstack server resize</title>
|
|
<screen><computeroutput>usage: openstack server resize [-h] [--flavor <flavor> | --verify | --revert]
|
|
[--wait]
|
|
<server></computeroutput></screen>
|
|
<para>
|
|
Scale server to a new flavor
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--flavor <flavor></command></term>
|
|
<listitem>
|
|
<para>
|
|
Resize server to specified flavor
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--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] <server></computeroutput></screen>
|
|
<para>
|
|
Resume server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_set">
|
|
<title>openstack server set</title>
|
|
<screen><computeroutput>usage: openstack server set [-h] [--name <new-name>] [--root-password]
|
|
[--property <key=value>]
|
|
<server></computeroutput></screen>
|
|
<para>
|
|
Set server properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <new-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New server name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--root-password</command></term>
|
|
<listitem>
|
|
<para>
|
|
Set new root password (interactive only)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property to add/change for this server (repeat option
|
|
to set multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_show">
|
|
<title>openstack server show</title>
|
|
<screen><computeroutput>usage: openstack server show [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--diagnostics]
|
|
<server></computeroutput></screen>
|
|
<para>
|
|
Show server details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server 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 <login-name>] [--port <port>]
|
|
[--identity <keyfile>] [--option <config-options>]
|
|
[-4 | -6]
|
|
[--public | --private | --address-type <address-type>]
|
|
<server></computeroutput></screen>
|
|
<para>
|
|
Ssh to server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--login <login-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Login name (ssh -l option)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--port <port></command></term>
|
|
<listitem>
|
|
<para>
|
|
Destination port (ssh -p option)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--identity <keyfile></command></term>
|
|
<listitem>
|
|
<para>
|
|
Private key file (ssh -i option)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--option <config-options></command></term>
|
|
<listitem>
|
|
<para>
|
|
Options in ssh_config(5) format (ssh -o option)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-4</command></term>
|
|
<listitem>
|
|
<para>
|
|
Use only IPv4 addresses
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>-6</command></term>
|
|
<listitem>
|
|
<para>
|
|
Use only IPv6 addresses
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--public</command></term>
|
|
<listitem>
|
|
<para>
|
|
Use public IP address
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--private</command></term>
|
|
<listitem>
|
|
<para>
|
|
Use private IP address
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--address-type <address-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Use other IP address (public, private, etc)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_suspend">
|
|
<title>openstack server suspend</title>
|
|
<screen><computeroutput>usage: openstack server suspend [-h] <server></computeroutput></screen>
|
|
<para>
|
|
Suspend server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_unlock">
|
|
<title>openstack server unlock</title>
|
|
<screen><computeroutput>usage: openstack server unlock [-h] <server></computeroutput></screen>
|
|
<para>
|
|
Unlock server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_unpause">
|
|
<title>openstack server unpause</title>
|
|
<screen><computeroutput>usage: openstack server unpause [-h] <server></computeroutput></screen>
|
|
<para>
|
|
Unpause server
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_unrescue">
|
|
<title>openstack server unrescue</title>
|
|
<screen><computeroutput>usage: openstack server unrescue [-h] <server></computeroutput></screen>
|
|
<para>
|
|
Restore server from rescue mode
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_server_unset">
|
|
<title>openstack server unset</title>
|
|
<screen><computeroutput>usage: openstack server unset [-h] [--property <key>] <server></computeroutput></screen>
|
|
<para>
|
|
Unset server properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><server></command></term>
|
|
<listitem>
|
|
<para>
|
|
Server (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property key to remove from server (repeat to 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 <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] --type <service-type>
|
|
[--description <service-description>]
|
|
<service-name></computeroutput></screen>
|
|
<para>
|
|
Create new service
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><service-name></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 <service-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
New service type (compute, image, identity, volume,
|
|
etc)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <service-description></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] <service></computeroutput></screen>
|
|
<para>
|
|
Delete service
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><service></command></term>
|
|
<listitem>
|
|
<para>
|
|
Service to delete (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_service_list">
|
|
<title>openstack service list</title>
|
|
<screen><computeroutput>usage: openstack service list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--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 <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--catalog]
|
|
<service></computeroutput></screen>
|
|
<para>
|
|
Show service details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><service></command></term>
|
|
<listitem>
|
|
<para>
|
|
Service to display (type, name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--catalog</command></term>
|
|
<listitem>
|
|
<para>
|
|
Show service catalog information
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_snapshot_create">
|
|
<title>openstack snapshot create</title>
|
|
<screen><computeroutput>usage: openstack snapshot create [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] --name <name>
|
|
[--description <description>] [--force]
|
|
<volume></computeroutput></screen>
|
|
<para>
|
|
Create snapshot command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></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 <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the snapshot
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Description of the snapshot
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--force</command></term>
|
|
<listitem>
|
|
<para>
|
|
Create a snapshot attached to an instance. Default is
|
|
False
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_snapshot_delete">
|
|
<title>openstack snapshot delete</title>
|
|
<screen><computeroutput>usage: openstack snapshot delete [-h] <snapshot></computeroutput></screen>
|
|
<para>
|
|
Delete snapshot command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><snapshot></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 <integer>]
|
|
[--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 <new-snapshot-name>]
|
|
[--description <new-snapshot-description>]
|
|
<snapshot></computeroutput></screen>
|
|
<para>
|
|
Set snapshot command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><snapshot></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 <new-snapshot-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New snapshot name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <new-snapshot-description></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 <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
<snapshot></computeroutput></screen>
|
|
<para>
|
|
Show snapshot command
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><snapshot></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 <integer>] [--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] <token></computeroutput></screen>
|
|
<para>
|
|
Revoke existing token
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><token></command></term>
|
|
<listitem>
|
|
<para>
|
|
Token to be deleted
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_user_create">
|
|
<title>openstack user create</title>
|
|
<screen><computeroutput>usage: openstack user create [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] [--password <user-password>]
|
|
[--password-prompt] [--email <user-email>]
|
|
[--project <project>] [--enable | --disable]
|
|
<user-name></computeroutput></screen>
|
|
<para>
|
|
Create new user
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><user-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New user name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--password <user-password></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 <user-email></command></term>
|
|
<listitem>
|
|
<para>
|
|
New user email address
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project <project></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] <user></computeroutput></screen>
|
|
<para>
|
|
Delete user
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><user></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 <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--project <project>] [--long]</computeroutput></screen>
|
|
<para>
|
|
List users
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter users by project (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--long</command></term>
|
|
<listitem>
|
|
<para>
|
|
List additional fields in output
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_user_role_list">
|
|
<title>openstack user role list</title>
|
|
<screen><computeroutput>usage: openstack user role list [-h] [-f {csv,table}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--project <project>]
|
|
[<user>]</computeroutput></screen>
|
|
<para>
|
|
List user-role assignments
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><user></command></term>
|
|
<listitem>
|
|
<para>
|
|
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 <project></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 <new-user-name>]
|
|
[--password <user-password>] [--password-prompt]
|
|
[--email <user-email>] [--project <project>]
|
|
[--enable | --disable]
|
|
<user></computeroutput></screen>
|
|
<para>
|
|
Set user properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><user></command></term>
|
|
<listitem>
|
|
<para>
|
|
User to change (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <new-user-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New user name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--password <user-password></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 <user-email></command></term>
|
|
<listitem>
|
|
<para>
|
|
New user email address
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project <project></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 <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
<user></computeroutput></screen>
|
|
<para>
|
|
Show user details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><user></command></term>
|
|
<listitem>
|
|
<para>
|
|
User to display (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_volume_create">
|
|
<title>openstack volume create</title>
|
|
<screen><computeroutput>usage: openstack volume create [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX] --size <size>
|
|
[--snapshot-id <snapshot-id>]
|
|
[--description <description>]
|
|
[--type <volume-type>] [--user <user>]
|
|
[--project <project>]
|
|
[--availability-zone <availability-zone>]
|
|
[--property <key=value>] [--image <image>]
|
|
[--source <volume>]
|
|
<name></computeroutput></screen>
|
|
<para>
|
|
Create new volume
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></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 <size></command></term>
|
|
<listitem>
|
|
<para>
|
|
New volume size
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--snapshot-id <snapshot-id></command></term>
|
|
<listitem>
|
|
<para>
|
|
Use <snapshot-id> as source of new volume
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
Description of the volume
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--type <volume-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Type of volume
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--user <user></command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify a different user (admin only)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--project <project></command></term>
|
|
<listitem>
|
|
<para>
|
|
Specify a different project (admin only)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--availability-zone <availability-zone></command></term>
|
|
<listitem>
|
|
<para>
|
|
Create new volume in <availability-zone>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property to store for this volume (repeat option to
|
|
set multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--image <image></command></term>
|
|
<listitem>
|
|
<para>
|
|
Use <image> as source of new volume
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--source <volume></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] <volume></computeroutput></screen>
|
|
<para>
|
|
Delete a volume
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></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 <integer>]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--status <status>] [--name <name>]
|
|
[--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 <status></command></term>
|
|
<listitem>
|
|
<para>
|
|
Filter results by status
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <name></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 <new-name>]
|
|
[--description <new-description>]
|
|
[--property <key=value>]
|
|
<volume></computeroutput></screen>
|
|
<para>
|
|
Set volume properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume to change (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--name <new-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New volume name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <new-description></command></term>
|
|
<listitem>
|
|
<para>
|
|
New volume description
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></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 <integer>] [--variable VARIABLE]
|
|
[--prefix PREFIX]
|
|
<volume></computeroutput></screen>
|
|
<para>
|
|
Show volume details
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume to display (name or ID)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_volume_type_create">
|
|
<title>openstack volume type create</title>
|
|
<screen><computeroutput>usage: openstack volume type create [-h] [-f {shell,table,value}] [-c COLUMN]
|
|
[--max-width <integer>]
|
|
[--variable VARIABLE] [--prefix PREFIX]
|
|
[--property <key=value>]
|
|
<name></computeroutput></screen>
|
|
<para>
|
|
Create new volume type
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
New volume type name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>-h, --help</command></term>
|
|
<listitem>
|
|
<para>
|
|
show this help message and exit
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--property <key=value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property to add for this volume type (repeat option to
|
|
set multiple properties)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="openstackclient_subcommand_volume_type_delete">
|
|
<title>openstack volume type delete</title>
|
|
<screen><computeroutput>usage: openstack volume type delete [-h] <volume-type></computeroutput></screen>
|
|
<para>
|
|
Delete volume type
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
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 <integer>]
|
|
[--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 <key=value>] <volume-type></computeroutput></screen>
|
|
<para>
|
|
Set volume type property
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume-type></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 <key=value></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 <key>] <volume-type></computeroutput></screen>
|
|
<para>
|
|
Unset volume type property
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume-type></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 <key></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 <key>] <volume></computeroutput></screen>
|
|
<para>
|
|
Unset volume properties
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><volume></command></term>
|
|
<listitem>
|
|
<para>
|
|
Volume to 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 <key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Property key to remove from volume (repeat to set multiple
|
|
values)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
</chapter>
|