openstack/openstack-manuals
Code Issues Proposed changes

Update of CLI reference for several clients

Browse Source 
* python-ceilometerclient 1.2.0
* python-cinderclient 1.2.0
* python-glanceclient 0.18.0
* python-heatclient 0.5.0
* python-ironicclient 0.6.0
* python-keystoneclient 1.4.0
* python-neutronclient 2.5.0
* python-novaclient 2.24.1
* python-openstackclient 1.1.0
* python-saharaclient 0.9.0
* python-troveclient 1.1.0

Change-Id: I82163d00a8c2536ef63f0fa2709127bf4180c69b
This commit is contained in:
Christian Berendt 2015-04-23 22:09:03 +02:00
parent 384d2722bd
commit 30c5da95ae
11 changed files with 788 additions and 382 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/cli-reference/generated/ch_cli_ceilometer_commands.xml
View File

@ -15,7 +15,7 @@
interface (CLI) for the Telemetry API and its extensions.
This chapter documents <command>ceilometer</command> version
<literal>1.1.0</literal>.
<literal>1.2.0</literal>.
</para>
<para>For help on a specific <command>ceilometer</command>

389
doc/cli-reference/generated/ch_cli_cinder_commands.xml
View File

@ -15,7 +15,7 @@
interface (CLI) for the OpenStack Block Storage API and its extensions.
This chapter documents <command>cinder</command> version
<literal>1.1.1</literal>.
<literal>1.2.0</literal>.
</para>
<para>For help on a specific <command>cinder</command>
@ -25,11 +25,12 @@
<section xml:id="cinderclient_command_usage">
<title>cinder usage</title>
<screen><computeroutput>usage: cinder [--version] [--debug] [--os-auth-system &lt;auth-system&gt;]
<screen><computeroutput>usage: cinder [--version] [-d] [--os-auth-system &lt;auth-system&gt;]
[--service-type &lt;service-type&gt;] [--service-name &lt;service-name&gt;]
[--volume-service-name &lt;volume-service-name&gt;]
[--endpoint-type &lt;endpoint-type&gt;]
[--os-volume-api-version &lt;volume-api-ver&gt;] [--retries &lt;retries&gt;]
[--os-volume-api-version &lt;volume-api-ver&gt;]
[--bypass-url &lt;bypass-url&gt;] [--retries &lt;retries&gt;]
[--os-auth-strategy &lt;auth-strategy&gt;]
[--os-username &lt;auth-user-name&gt;] [--os-password &lt;auth-password&gt;]
[--os-tenant-name &lt;auth-tenant-name&gt;]
@ -625,7 +626,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><command>--debug</command></term>
<term><command>-d, --debug</command></term>
<listitem>
<para>
Shows debugging output.
@ -683,6 +684,15 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--bypass-url &lt;bypass-url&gt;</command></term>
<listitem>
<para>
Use this API endpoint instead of the Service Catalog.
Defaults to <code>env[CINDERCLIENT_BYPASS_URL]</code>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--retries &lt;retries&gt;</command></term>
<listitem>
@ -1267,7 +1277,8 @@ Attempts force-delete of volume, regardless of state.
<title>cinder list</title>
<screen><computeroutput>usage: cinder list [--all-tenants [&lt;0|1&gt;]] [--display-name &lt;display-name&gt;]
[--status &lt;status&gt;]
[--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]]</computeroutput></screen>
[--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]]
[--tenant [&lt;tenant&gt;]]</computeroutput></screen>
<para>
Lists all volumes.
</para> <variablelist wordsize="10">
@ -1305,6 +1316,14 @@ Lists all volumes.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--tenant [&lt;tenant&gt;]</command></term>
<listitem>
<para>
Display information from single tenant (Admin only).
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_list-extensions">
@ -1333,7 +1352,7 @@ Sets or deletes volume metadata.
<term><command>&lt;action&gt;</command></term>
<listitem>
<para>
The action. Valid values are 'set' or 'unset.'
The action. Valid values are "set" or "unset."
</para>
</listitem>
</varlistentry>
@ -1585,7 +1604,7 @@ Sets or unsets specifications for a qos spec.
<term><command>&lt;action&gt;</command></term>
<listitem>
<para>
The action. Valid values are 'set' or 'unset.'
The action. Valid values are "set" or "unset."
</para>
</listitem>
</varlistentry>
@ -1751,7 +1770,8 @@ Lists quotas for a tenant.
<section xml:id="cinderclient_subcommand_quota-update">
<title>cinder quota-update</title>
<screen><computeroutput>usage: cinder quota-update [--volumes &lt;volumes&gt;] [--snapshots &lt;snapshots&gt;]
[--gigabytes &lt;gigabytes&gt;]
[--gigabytes &lt;gigabytes&gt;] [--backups &lt;backups&gt;]
[--backup-gigabytes &lt;backup_gigabytes&gt;]
[--volume-type &lt;volume_type_name&gt;]
&lt;tenant_id&gt;</computeroutput></screen>
<para>
@ -1793,6 +1813,22 @@ Updates quotas for a tenant.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--backups &lt;backups&gt;</command></term>
<listitem>
<para>
The new "backups" quota value. Default=None.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--backup-gigabytes &lt;backup_gigabytes&gt;</command></term>
<listitem>
<para>
The new "backup_gigabytes" quota value. Default=None.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--volume-type &lt;volume_type_name&gt;</command></term>
<listitem>
@ -1914,8 +1950,11 @@ Explicitly updates the volume state.
<listitem>
<para>
The state to assign to the volume. Valid values are
"available," "error," "creating," "deleting," or
"error_deleting." Default is "available."
"available," "error," "creating," "deleting," "in-use,"
"attaching," "detaching" and "error_deleting." NOTE: This
command simply changes the state of the Volume in the
DataBase with no regard to actual status, exercise caution
when using. Default=available.
</para>
</listitem>
</varlistentry>
@ -2180,7 +2219,7 @@ Sets or deletes snapshot metadata.
<term><command>&lt;action&gt;</command></term>
<listitem>
<para>
The action. Valid values are 'set' or 'unset.'
The action. Valid values are "set" or "unset."
</para>
</listitem>
</varlistentry>
@ -2299,8 +2338,11 @@ Explicitly updates the snapshot state.
<listitem>
<para>
The state to assign to the snapshot. Valid values are
"available," "error," "creating," "deleting," or
"error_deleting." Default is "available."
"available," "error," "creating," "deleting," and
"error_deleting." NOTE: This command simply changes the
state of the Snapshot in the DataBase with no regard to
actual status, exercise caution when using.
Default=available.
</para>
</listitem>
</varlistentry>
@ -2395,10 +2437,20 @@ Undoes a transfer.
</section>
<section xml:id="cinderclient_subcommand_transfer-list">
<title>cinder transfer-list</title>
<screen><computeroutput>usage: cinder transfer-list</computeroutput></screen>
<screen><computeroutput>usage: cinder transfer-list [--all-tenants [&lt;0|1&gt;]]</computeroutput></screen>
<para>
Lists all transfers.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--all-tenants [&lt;0|1&gt;]</command></term>
<listitem>
<para>
Shows details for all tenants. Admin only.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_transfer-show">
<title>cinder transfer-show</title>
@ -2470,7 +2522,7 @@ Sets or unsets extra_spec for a volume type.
<term><command>&lt;action&gt;</command></term>
<listitem>
<para>
The action. Valid values are 'set' or 'unset.'
The action. Valid values are "set" or "unset."
</para>
</listitem>
</varlistentry>
@ -2954,7 +3006,7 @@ Shows details of a consistency group.
[--snapshot-id &lt;snapshot-id&gt;]
[--source-volid &lt;source-volid&gt;]
[--source-replica &lt;source-replica&gt;]
[--image-id &lt;image-id&gt;] [--name &lt;name&gt;]
[--image-id &lt;image-id&gt;] [--image &lt;image&gt;] [--name &lt;name&gt;]
[--description &lt;description&gt;]
[--volume-type &lt;volume-type&gt;]
[--availability-zone &lt;availability-zone&gt;]
@ -3019,6 +3071,15 @@ Creates a volume.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--image &lt;image&gt;</command></term>
<listitem>
<para>
Creates a volume from image (ID or name).
Default=None.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--name &lt;name&gt;</command></term>
<listitem>
@ -3248,6 +3309,23 @@ Attempts force-delete of volume, regardless of state.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_get-pools_v2">
<title>cinder get-pools (v2)</title>
<screen><computeroutput>usage: cinder --os-volume-api-version 2 get-pools [--detail]</computeroutput></screen>
<para>
Show pool information for backends. Admin only.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--detail</command></term>
<listitem>
<para>
Show detailed information about pools.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_list_v2">
@ -3255,7 +3333,7 @@ Attempts force-delete of volume, regardless of state.
<screen><computeroutput>usage: cinder --os-volume-api-version 2 list [--all-tenants [&lt;0|1&gt;]] [--name &lt;name&gt;] [--status &lt;status&gt;]
[--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]]
[--marker &lt;marker&gt;] [--limit &lt;limit&gt;]
[--sort_key &lt;sort_key&gt;] [--sort_dir &lt;sort_dir&gt;]</computeroutput></screen>
[--sort &lt;key&gt;[:&lt;direction&gt;]] [--tenant [&lt;tenant&gt;]]</computeroutput></screen>
<para>
Lists all volumes.
</para> <variablelist wordsize="10">
@ -3313,21 +3391,21 @@ Lists all volumes.
</listitem>
</varlistentry>
<varlistentry>
<term><command>--sort_key &lt;sort_key&gt;</command></term>
<term><command>--sort &lt;key&gt;[:&lt;direction&gt;]</command></term>
<listitem>
<para>
Key to be sorted, should be (`id`, `status`, `size`,
`availability_zone`, `name`, `bootable`,
`created_at`). OPTIONAL: Default=None.
Comma-separated list of sort keys and directions in
the form of &lt;key&gt;[:&lt;asc|desc&gt;]. Valid keys: id,
status, size, availability_zone, name, bootable,
created_at. OPTIONAL: Default=None.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--sort_dir &lt;sort_dir&gt;</command></term>
<term><command>--tenant [&lt;tenant&gt;]</command></term>
<listitem>
<para>
Sort direction, should be `desc` or `asc`. OPTIONAL:
Default=None.
Display information from single tenant (Admin only).
</para>
</listitem>
</varlistentry>
@ -3342,12 +3420,12 @@ Lists all available os-api extensions.
</section>
<section xml:id="cinderclient_subcommand_manage_v2">
<title>cinder manage (v2)</title>
<screen><computeroutput>usage: cinder --os-volume-api-version 2 manage [--source-name &lt;source-name&gt;] [--source-id &lt;source-id&gt;]
[--name &lt;name&gt;] [--description &lt;description&gt;]
<screen><computeroutput>usage: cinder --os-volume-api-version 2 manage [--id-type &lt;id-type&gt;] [--name &lt;name&gt;]
[--description &lt;description&gt;]
[--volume-type &lt;volume-type&gt;]
[--availability-zone &lt;availability-zone&gt;]
[--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]] [--bootable]
&lt;host&gt; [&lt;key=value&gt; [&lt;key=value&gt; ...]]</computeroutput></screen>
&lt;host&gt; &lt;identifier&gt;</computeroutput></screen>
<para>
Manage an existing volume.
</para> <variablelist wordsize="10">
@ -3356,16 +3434,16 @@ Manage an existing volume.
<term><command>&lt;host&gt;</command></term>
<listitem>
<para>
Cinder host on which the existing volume resides
Cinder host on which the existing volume resides;
takes the form: host@backend-name#pool
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;key=value&gt;</command></term>
<term><command>&lt;identifier&gt;</command></term>
<listitem>
<para>
Driver-specific reference to the existing volume as
key=value pairs
Name or other Identifier for existing volume
</para>
</listitem>
</varlistentry>
@ -3373,18 +3451,11 @@ Manage an existing volume.
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--source-name &lt;source-name&gt;</command></term>
<term><command>--id-type &lt;id-type&gt;</command></term>
<listitem>
<para>
Name of the volume to manage (Optional)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--source-id &lt;source-id&gt;</command></term>
<listitem>
<para>
ID of the volume to manage (Optional)
Type of backend device identifier provided, typically
source-name or source-id (Default=source-name)
</para>
</listitem>
</varlistentry>
@ -3392,7 +3463,7 @@ Manage an existing volume.
<term><command>--name &lt;name&gt;</command></term>
<listitem>
<para>
Volume name (Optional, Default=None)
Volume name (Default=None)
</para>
</listitem>
</varlistentry>
@ -3400,7 +3471,7 @@ Manage an existing volume.
<term><command>--description &lt;description&gt;</command></term>
<listitem>
<para>
Volume description (Optional, Default=None)
Volume description (Default=None)
</para>
</listitem>
</varlistentry>
@ -3408,7 +3479,7 @@ Manage an existing volume.
<term><command>--volume-type &lt;volume-type&gt;</command></term>
<listitem>
<para>
Volume type (Optional, Default=None)
Volume type (Default=None)
</para>
</listitem>
</varlistentry>
@ -3416,7 +3487,7 @@ Manage an existing volume.
<term><command>--availability-zone &lt;availability-zone&gt;</command></term>
<listitem>
<para>
Availability zone for volume (Optional, Default=None)
Availability zone for volume (Default=None)
</para>
</listitem>
</varlistentry>
@ -3424,7 +3495,7 @@ Manage an existing volume.
<term><command>--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]</command></term>
<listitem>
<para>
Metadata key=value pairs (Optional, Default=None)
Metadata key=value pairs (Default=None)
</para>
</listitem>
</varlistentry>
@ -3458,7 +3529,7 @@ Sets or deletes volume metadata.
<term><command>&lt;action&gt;</command></term>
<listitem>
<para>
The action. Valid values are 'set' or 'unset.'
The action. Valid values are "set" or "unset."
</para>
</listitem>
</varlistentry>
@ -3712,7 +3783,7 @@ Sets or unsets specifications for a qos spec.
<term><command>&lt;action&gt;</command></term>
<listitem>
<para>
The action. Valid values are 'set' or 'unset.'
The action. Valid values are "set" or "unset."
</para>
</listitem>
</varlistentry>
@ -3878,7 +3949,9 @@ Lists quotas for a tenant.
<section xml:id="cinderclient_subcommand_quota-update_v2">
<title>cinder quota-update (v2)</title>
<screen><computeroutput>usage: cinder --os-volume-api-version 2 quota-update [--volumes &lt;volumes&gt;] [--snapshots &lt;snapshots&gt;]
[--gigabytes &lt;gigabytes&gt;]
[--gigabytes &lt;gigabytes&gt;] [--backups &lt;backups&gt;]
[--backup-gigabytes &lt;backup_gigabytes&gt;]
[--consistencygroups &lt;consistencygroups&gt;]
[--volume-type &lt;volume_type_name&gt;]
&lt;tenant_id&gt;</computeroutput></screen>
<para>
@ -3920,6 +3993,30 @@ Updates quotas for a tenant.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--backups &lt;backups&gt;</command></term>
<listitem>
<para>
The new "backups" quota value. Default=None.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--backup-gigabytes &lt;backup_gigabytes&gt;</command></term>
<listitem>
<para>
The new "backup_gigabytes" quota value. Default=None.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--consistencygroups &lt;consistencygroups&gt;</command></term>
<listitem>
<para>
The new "consistencygroups" quota value. Default=None.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--volume-type &lt;volume_type_name&gt;</command></term>
<listitem>
@ -4054,7 +4151,12 @@ Sync the secondary volume with primary for a relationship.
<title>cinder reset-state (v2)</title>
<screen><computeroutput>usage: cinder --os-volume-api-version 2 reset-state [--state &lt;state&gt;] &lt;volume&gt; [&lt;volume&gt; ...]</computeroutput></screen>
<para>
Explicitly updates the volume state.
Explicitly updates the volume state in the Cinder database. Note that this
does not affect whether the volume is actually attached to the Nova compute
host or instance and can result in an unusable volume. Being a database change
only, this has no impact on the true state of the volume and may not match the
actual state. This can render a volume unusable in the case of change to the
'available' state.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
@ -4073,8 +4175,11 @@ Explicitly updates the volume state.
<listitem>
<para>
The state to assign to the volume. Valid values are
"available," "error," "creating," "deleting," and
"error_deleting." Default=available.
"available," "error," "creating," "deleting," "in-use,"
"attaching," "detaching" and "error_deleting." NOTE: This
command simply changes the state of the Volume in the
DataBase with no regard to actual status, exercise caution
when using. Default=available.
</para>
</listitem>
</varlistentry>
@ -4249,6 +4354,7 @@ Shows volume details.
<title>cinder snapshot-create (v2)</title>
<screen><computeroutput>usage: cinder --os-volume-api-version 2 snapshot-create [--force &lt;True|False&gt;] [--name &lt;name&gt;]
[--description &lt;description&gt;]
[--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]]
&lt;volume&gt;</computeroutput></screen>
<para>
Creates a snapshot.
@ -4293,6 +4399,14 @@ Creates a snapshot.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]</command></term>
<listitem>
<para>
Snapshot metadata key and value pairs. Default=None.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_snapshot-delete_v2">
@ -4374,7 +4488,7 @@ Sets or deletes snapshot metadata.
<term><command>&lt;action&gt;</command></term>
<listitem>
<para>
The action. Valid values are 'set' or 'unset.'
The action. Valid values are "set" or "unset."
</para>
</listitem>
</varlistentry>
@ -4494,7 +4608,10 @@ Explicitly updates the snapshot state.
<para>
The state to assign to the snapshot. Valid values are
"available," "error," "creating," "deleting," and
"error_deleting." Default is "available."
"error_deleting." NOTE: This command simply changes the
state of the Snapshot in the DataBase with no regard to
actual status, exercise caution when using.
Default=available.
</para>
</listitem>
</varlistentry>
@ -4589,10 +4706,20 @@ Undoes a transfer.
</section>
<section xml:id="cinderclient_subcommand_transfer-list_v2">
<title>cinder transfer-list (v2)</title>
<screen><computeroutput>usage: cinder --os-volume-api-version 2 transfer-list</computeroutput></screen>
<screen><computeroutput>usage: cinder --os-volume-api-version 2 transfer-list [--all-tenants [&lt;0|1&gt;]]</computeroutput></screen>
<para>
Lists all transfers.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--all-tenants [&lt;0|1&gt;]</command></term>
<listitem>
<para>
Shows details for all tenants. Admin only.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_transfer-show_v2">
<title>cinder transfer-show (v2)</title>
@ -4609,11 +4736,84 @@ Shows transfer details.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_type-access-add_v2">
<title>cinder type-access-add (v2)</title>
<screen><computeroutput>usage: cinder --os-volume-api-version 2 type-access-add --volume-type &lt;volume_type&gt; --project-id
&lt;project_id&gt;</computeroutput></screen>
<para>
Adds volume type access for the given project.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--volume-type &lt;volume_type&gt;</command></term>
<listitem>
<para>
Volume type name or ID to add access for the given
project.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--project-id &lt;project_id&gt;</command></term>
<listitem>
<para>
Project ID to add volume type access for.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_type-access-list_v2">
<title>cinder type-access-list (v2)</title>
<screen><computeroutput>usage: cinder --os-volume-api-version 2 type-access-list --volume-type &lt;volume_type&gt;</computeroutput></screen>
<para>
Print access information about the given volume type.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--volume-type &lt;volume_type&gt;</command></term>
<listitem>
<para>
Filter results by volume type name or ID.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_type-access-remove_v2">
<title>cinder type-access-remove (v2)</title>
<screen><computeroutput>usage: cinder --os-volume-api-version 2 type-access-remove --volume-type &lt;volume_type&gt; --project-id
&lt;project_id&gt;</computeroutput></screen>
<para>
Removes volume type access for the given project.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--volume-type &lt;volume_type&gt;</command></term>
<listitem>
<para>
Volume type name or ID to remove access for the given
project.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--project-id &lt;project_id&gt;</command></term>
<listitem>
<para>
Project ID to remove volume type access for.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_type-create_v2">
<title>cinder type-create (v2)</title>
<screen><computeroutput>usage: cinder --os-volume-api-version 2 type-create &lt;name&gt;</computeroutput></screen>
<screen><computeroutput>usage: cinder --os-volume-api-version 2 type-create [--description &lt;description&gt;]
[--is-public &lt;is-public&gt;]
&lt;name&gt;</computeroutput></screen>
<para>
Creates a volume type.
</para> <variablelist wordsize="10">
@ -4627,6 +4827,32 @@ Creates a volume type.
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--description &lt;description&gt;</command></term>
<listitem>
<para>
Description of new volume type.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--is-public &lt;is-public&gt;</command></term>
<listitem>
<para>
Make type accessible to the public (default true).
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_type-default_v2">
<title>cinder type-default (v2)</title>
<screen><computeroutput>usage: cinder --os-volume-api-version 2 type-default</computeroutput></screen>
<para>
List the default volume type.
</para>
</section>
<section xml:id="cinderclient_subcommand_type-delete_v2">
<title>cinder type-delete (v2)</title>
@ -4664,7 +4890,7 @@ Sets or unsets extra_spec for a volume type.
<term><command>&lt;action&gt;</command></term>
<listitem>
<para>
The action. Valid values are 'set' or 'unset.'
The action. Valid values are "set" or "unset."
</para>
</listitem>
</varlistentry>
@ -4681,15 +4907,62 @@ Sets or unsets extra_spec for a volume type.
</section>
<section xml:id="cinderclient_subcommand_type-list_v2">
<title>cinder type-list (v2)</title>
<screen><computeroutput>usage: cinder --os-volume-api-version 2 type-list</computeroutput></screen>
<screen><computeroutput>usage: cinder --os-volume-api-version 2 type-list [--all]</computeroutput></screen>
<para>
Lists available 'volume types'.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--all</command></term>
<listitem>
<para>
Display all volume types (Admin only).
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_type-update_v2">
<title>cinder type-update (v2)</title>
<screen><computeroutput>usage: cinder --os-volume-api-version 2 type-update [--name &lt;name&gt;] [--description &lt;description&gt;] &lt;id&gt;</computeroutput></screen>
<para>
Updates volume type name and/or description.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;id&gt;</command></term>
<listitem>
<para>
ID of the volume type.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--name &lt;name&gt;</command></term>
<listitem>
<para>
Name of the volume type.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description &lt;description&gt;</command></term>
<listitem>
<para>
Description of the volume type.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="cinderclient_subcommand_unmanage_v2">
<title>cinder unmanage (v2)</title>
<screen><computeroutput>usage: cinder --os-volume-api-version 2 unmanage &lt;volume&gt;</computeroutput></screen>
<para>
Stop managing a volume.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>

19
doc/cli-reference/generated/ch_cli_glance_commands.xml
View File

@ -15,7 +15,7 @@
interface (CLI) for the OpenStack Image Service API and its extensions.
This chapter documents <command>glance</command> version
<literal>0.17.0</literal>.
<literal>0.18.0</literal>.
</para>
<para>For help on a specific <command>glance</command>
@ -889,7 +889,8 @@ Update a specific image.
example, if the image data is stored in swift, you
could specify 'swift+http://tenant%3Aaccount:key@auth_
url/v2.0/container/obj'. (Note: '%3A' is ':' URL
encoded.)
encoded.) This option only works for images in
'queued' status.
</para>
</listitem>
</varlistentry>
@ -918,7 +919,8 @@ Update a specific image.
<para>
Similar to '--location' in usage, but this indicates
that the Glance server should immediately copy the
data and store it in its configured image store.
data and store it in its configured image store. This
option only works for images in 'queued' status.
</para>
</listitem>
</varlistentry>
@ -1300,7 +1302,8 @@ List images you can access.
</section>
<section xml:id="glanceclient_subcommand_image-show_v2">
<title>glance image-show (v2)</title>
<screen><computeroutput>usage: glance --os-image-api-version 2 image-show [--max-column-width &lt;integer&gt;] &lt;IMAGE_ID&gt;</computeroutput></screen>
<screen><computeroutput>usage: glance --os-image-api-version 2 image-show [--human-readable] [--max-column-width &lt;integer&gt;]
&lt;IMAGE_ID&gt;</computeroutput></screen>
<para>
Describe a specific image.
</para> <variablelist wordsize="10">
@ -1316,6 +1319,14 @@ Describe a specific image.
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--human-readable</command></term>
<listitem>
<para>
Print image size in a human-friendly format.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--max-column-width &lt;integer&gt;</command></term>
<listitem>

66
doc/cli-reference/generated/ch_cli_heat_commands.xml
View File

@ -15,7 +15,7 @@
interface (CLI) for the Orchestration API and its extensions.
This chapter documents <command>heat</command> version
<literal>0.4.0</literal>.
<literal>0.5.0</literal>.
</para>
<para>For help on a specific <command>heat</command>
@ -101,22 +101,6 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>create</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use stack-create instead.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>delete</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use stack-delete instead.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>deployment-create</command></term>
<listitem>
@ -157,14 +141,6 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>describe</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use stack-show instead.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>event</command></term>
<listitem>
@ -189,14 +165,6 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>gettemplate</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use template-show instead.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hook-clear</command></term>
<listitem>
@ -205,14 +173,6 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>list</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use stack-list instead.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>output-list</command></term>
<listitem>
@ -229,14 +189,6 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>resource</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use resource-show instead.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>resource-list</command></term>
<listitem>
@ -437,22 +389,6 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>update</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use stack-update instead.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>validate</command></term>
<listitem>
<para>
<emphasis>DEPRECATED!</emphasis> Use template-validate instead.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>bash-completion</command></term>
<listitem>

29
doc/cli-reference/generated/ch_cli_ironic_commands.xml
View File

@ -15,7 +15,7 @@
interface (CLI) for the Bare metal and its extensions.
This chapter documents <command>ironic</command> version
<literal>0.5.1</literal>.
<literal>0.6.0</literal>.
</para>
<para>For help on a specific <command>ironic</command>
@ -33,9 +33,10 @@
[--os-auth-token OS_AUTH_TOKEN] [--ironic-url IRONIC_URL]
[--ironic-api-version IRONIC_API_VERSION]
[--os-service-type OS_SERVICE_TYPE] [--os-endpoint OS_ENDPOINT]
[--os-endpoint-type OS_ENDPOINT_TYPE] [--insecure]
[--os-cacert &lt;ca-certificate&gt;] [--os-cert &lt;certificate&gt;]
[--os-key &lt;key&gt;] [--timeout &lt;seconds&gt;]
[--os-endpoint-type OS_ENDPOINT_TYPE]
[--max-retries MAX_RETRIES] [--retry-interval RETRY_INTERVAL]
[--insecure] [--os-cacert &lt;ca-certificate&gt;]
[--os-cert &lt;certificate&gt;] [--os-key &lt;key&gt;] [--timeout &lt;seconds&gt;]
[--os-user-domain-id OS_USER_DOMAIN_ID]
[--os-user-domain-name OS_USER_DOMAIN_NAME]
[--os-project-id OS_PROJECT_ID]
@ -466,6 +467,26 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--max-retries MAX_RETRIES</command></term>
<listitem>
<para>
Maximum number of retries in case of conflict error
(HTTP 409). Defaults to <code>env[IRONIC_MAX_RETRIES]</code> or 5.
Use 0 to disable retrying.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--retry-interval RETRY_INTERVAL</command></term>
<listitem>
<para>
Amount of time (in seconds) between retries in case of
conflict error (HTTP 409). Defaults to
<code>env[IRONIC_RETRY_INTERVAL]</code> or 2.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--insecure</command></term>
<listitem>

2
doc/cli-reference/generated/ch_cli_keystone_commands.xml
View File

@ -21,7 +21,7 @@
interface (CLI) for the OpenStack Identity API and its extensions.
This chapter documents <command>keystone</command> version
<literal>1.3.0</literal>.
<literal>1.4.0</literal>.
</para>
<para>For help on a specific <command>keystone</command>

2
doc/cli-reference/generated/ch_cli_neutron_commands.xml
View File

@ -15,7 +15,7 @@
interface (CLI) for the OpenStack Networking API and its extensions.
This chapter documents <command>neutron</command> version
<literal>2.4.0</literal>.
<literal>2.5.0</literal>.
</para>
<para>For help on a specific <command>neutron</command>

150
doc/cli-reference/generated/ch_cli_nova_commands.xml
View File

@ -15,7 +15,7 @@
interface (CLI) for the OpenStack Compute API and its extensions.
This chapter documents <command>nova</command> version
<literal>2.23.0</literal>.
<literal>2.24.1</literal>.
</para>
<para>For help on a specific <command>nova</command>
@ -1460,11 +1460,60 @@
</listitem>
</varlistentry>
<varlistentry>
<term><command>host-servers-migrate</command></term>
<term><command>instance-action</command></term>
<listitem>
<para>
Migrate all instances of the specified host to
other available hosts.
Show an action.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>instance-action-list</command></term>
<listitem>
<para>
List actions on a server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>host-meta</command></term>
<listitem>
<para>
Set or Delete metadata on all instances of a
host.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>host-evacuate-live</command></term>
<listitem>
<para>
Live migrate all instances of the specified
host to other available hosts.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>force-delete</command></term>
<listitem>
<para>
Force delete a server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>restore</command></term>
<listitem>
<para>
Restore a soft-deleted server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>migration-list</command></term>
<listitem>
<para>
Print a list of migrations.
</para>
</listitem>
</varlistentry>
@ -1533,61 +1582,11 @@
</listitem>
</varlistentry>
<varlistentry>
<term><command>host-evacuate</command></term>
<term><command>list-extensions</command></term>
<listitem>
<para>
Evacuate all instances from failed host.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cell-capacities</command></term>
<listitem>
<para>
Get cell capacities for all cells or a given
cell.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cell-show</command></term>
<listitem>
<para>
Show details of a given cell.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>host-meta</command></term>
<listitem>
<para>
Set or Delete metadata on all instances of a
host.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>host-evacuate-live</command></term>
<listitem>
<para>
Live migrate all instances of the specified
host to other available hosts.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>instance-action</command></term>
<listitem>
<para>
Show an action.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>instance-action-list</command></term>
<listitem>
<para>
List actions on a server.
List all the os-api extensions that are
available.
</para>
</listitem>
</varlistentry>
@ -1651,35 +1650,36 @@
</listitem>
</varlistentry>
<varlistentry>
<term><command>migration-list</command></term>
<term><command>cell-capacities</command></term>
<listitem>
<para>
Print a list of migrations.
Get cell capacities for all cells or a given
cell.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>force-delete</command></term>
<term><command>cell-show</command></term>
<listitem>
<para>
Force delete a server.
Show details of a given cell.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>restore</command></term>
<term><command>host-servers-migrate</command></term>
<listitem>
<para>
Restore a soft-deleted server.
Migrate all instances of the specified host to
other available hosts.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>list-extensions</command></term>
<term><command>host-evacuate</command></term>
<listitem>
<para>
List all the os-api extensions that are
available.
Evacuate all instances from failed host.
</para>
</listitem>
</varlistentry>
@ -2791,15 +2791,15 @@ Boot a new server.
(e.g. vda, xda, ...; if omitted, hypervisor
driver chooses suitable device depending on
selected bus), size=size of the block device
in GB (if omitted, hypervisor driver
calculates size), format=device will be
formatted (e.g. swap, ntfs, ...; optional),
bootindex=integer used for ordering the boot
disks (for image backed instances it is equal
to 0, for others need to be specified) and
shutdown=shutdown behaviour (either preserve
or remove, for local destination set to
remove).
in MB(for swap) and in GB(for other formats)
(if omitted, hypervisor driver calculates
size), format=device will be formatted (e.g.
swap, ntfs, ...; optional), bootindex=integer
used for ordering the boot disks (for image
backed instances it is equal to 0, for others
need to be specified) and shutdown=shutdown
behaviour (either preserve or remove, for
local destination set to remove).
</para>
</listitem>
</varlistentry>

385
doc/cli-reference/generated/ch_cli_openstack_commands.xml
View File

@ -15,7 +15,7 @@
OpenStack command-line interface (CLI).
This chapter documents <command>openstack</command> version
<literal>1.0.3</literal>.
<literal>1.1.0</literal>.
</para>
<para>For help on a specific <command>openstack</command>
@ -25,7 +25,8 @@
<section xml:id="openstackclient_command_usage">
<title>openstack usage</title>
<screen><computeroutput>usage: openstack [--version] [-v] [--log-file LOG_FILE] [-q] [--debug]
<screen><computeroutput>usage: openstack [--version] [-v] [--log-file LOG_FILE] [-q] [-h] [--debug]
[--os-cloud &lt;cloud-config-name&gt;]
[--os-region-name &lt;auth-region-name&gt;]
[--os-cacert &lt;ca-bundle-file&gt;] [--verify | --insecure]
[--os-default-domain &lt;auth-domain&gt;] [--timing]
@ -40,17 +41,18 @@
[--os-project-domain-id &lt;auth-project-domain-id&gt;]
[--os-project-name &lt;auth-project-name&gt;]
[--os-auth-url &lt;auth-auth-url&gt;]
[--os-identity-provider-url &lt;auth-identity-provider-url&gt;]
[--os-trust-id &lt;auth-trust-id&gt;]
[--os-service-provider-endpoint &lt;auth-service-provider-endpoint&gt;]
[--os-user-domain-id &lt;auth-user-domain-id&gt;]
[--os-url &lt;auth-url&gt;] [--os-token &lt;auth-token&gt;]
[--os-domain-name &lt;auth-domain-name&gt;]
[--os-identity-provider-url &lt;auth-identity-provider-url&gt;]
[--os-token &lt;auth-token&gt;] [--os-domain-id &lt;auth-domain-id&gt;]
[--os-url &lt;auth-url&gt;]
[--os-user-domain-name &lt;auth-user-domain-name&gt;]
[--os-domain-id &lt;auth-domain-id&gt;]
[--os-user-id &lt;auth-user-id&gt;] [--os-password &lt;auth-password&gt;]
[--os-endpoint &lt;auth-endpoint&gt;]
[--os-project-id &lt;auth-project-id&gt;]
[--os-object-api-version &lt;object-api-version&gt;] [-h]</computeroutput></screen>
[--os-object-api-version &lt;object-api-version&gt;]</computeroutput></screen>
</section>
<section xml:id="openstackclient_command_optional">
<title>openstack optional arguments</title>
@ -103,6 +105,14 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-cloud &lt;cloud-config-name&gt;</command></term>
<listitem>
<para>
Cloud name in clouds.yaml (Env: OS_CLOUD)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-region-name &lt;auth-region-name&gt;</command></term>
<listitem>
@ -202,11 +212,10 @@
<listitem>
<para>
Select an auhentication type. Available types:
v2token, v2password, v3password, v3scopedsaml,
v3unscopedadfs, token, v3token, password,
v3unscopedsaml, osc_password, token_endpoint. Default:
selected based on --os-username/--os-token (Env:
OS_AUTH_TYPE)
osc_password, token_endpoint, v2token, v2password,
v3password, v3scopedsaml, v3unscopedadfs, token,
v3token, password, v3unscopedsaml. Default: selected
based on --os-username/--os-token (Env: OS_AUTH_TYPE)
</para>
</listitem>
</varlistentry>
@ -214,10 +223,10 @@
<term><command>--os-username &lt;auth-username&gt;</command></term>
<listitem>
<para>
With v2password: Username to login with With
v3password: Username With v3unscopedadfs: Username
With password: Username With v3unscopedsaml: Username
With osc_password: Username (Env: OS_USERNAME)
With osc_password: Username With v2password: Username
to login with With v3password: Username With
v3unscopedadfs: Username With password: Username With
v3unscopedsaml: Username (Env: OS_USERNAME)
</para>
</listitem>
</varlistentry>
@ -235,14 +244,14 @@
<term><command>--os-project-domain-name &lt;auth-project-domain-name&gt;</command></term>
<listitem>
<para>
With v3password: Domain name containing project With
With osc_password: Domain name containing project With
v3password: Domain name containing project With
v3scopedsaml: Domain name containing project With
v3unscopedadfs: Domain name containing project With
token: Domain name containing project With v3token:
Domain name containing project With password: Domain
name containing project With v3unscopedsaml: Domain
name containing project With osc_password: Domain name
containing project (Env: OS_PROJECT_DOMAIN_NAME)
name containing project (Env: OS_PROJECT_DOMAIN_NAME)
</para>
</listitem>
</varlistentry>
@ -250,13 +259,13 @@
<term><command>--os-project-domain-id &lt;auth-project-domain-id&gt;</command></term>
<listitem>
<para>
With v3password: Domain ID containing project With
With osc_password: Domain ID containing project With
v3password: Domain ID containing project With
v3scopedsaml: Domain ID containing project With
v3unscopedadfs: Domain ID containing project With
token: Domain ID containing project With v3token:
Domain ID containing project With password: Domain ID
containing project With v3unscopedsaml: Domain ID
containing project With osc_password: Domain ID
containing project (Env: OS_PROJECT_DOMAIN_ID)
</para>
</listitem>
@ -265,13 +274,13 @@
<term><command>--os-project-name &lt;auth-project-name&gt;</command></term>
<listitem>
<para>
With v3password: Project name to scope to With
With osc_password: Project name to scope to With
v3password: Project name to scope to With
v3scopedsaml: Project name to scope to With
v3unscopedadfs: Project name to scope to With token:
Project name to scope to With v3token: Project name to
scope to With password: Project name to scope to With
v3unscopedsaml: Project name to scope to With
osc_password: Project name to scope to (Env:
v3unscopedsaml: Project name to scope to (Env:
OS_PROJECT_NAME)
</para>
</listitem>
@ -280,14 +289,24 @@
<term><command>--os-auth-url &lt;auth-auth-url&gt;</command></term>
<listitem>
<para>
With v2token: Authentication URL With v2password:
Authentication URL With v3password: Authentication URL
With v3scopedsaml: Authentication URL With
v3unscopedadfs: Authentication URL With token:
Authentication URL With v3token: Authentication URL
With password: Authentication URL With v3unscopedsaml:
Authentication URL With osc_password: Authentication
URL (Env: OS_AUTH_URL)
With osc_password: Authentication URL With v2token:
Authentication URL With v2password: Authentication URL
With v3password: Authentication URL With v3scopedsaml:
Authentication URL With v3unscopedadfs: Authentication
URL With token: Authentication URL With v3token:
Authentication URL With password: Authentication URL
With v3unscopedsaml: Authentication URL (Env:
OS_AUTH_URL)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-identity-provider-url &lt;auth-identity-provider-url&gt;</command></term>
<listitem>
<para>
With v3unscopedadfs: Identity Provider's URL With
v3unscopedsaml: Identity Provider's URL (Env:
OS_IDENTITY_PROVIDER_URL)
</para>
</listitem>
</varlistentry>
@ -295,12 +314,12 @@
<term><command>--os-trust-id &lt;auth-trust-id&gt;</command></term>
<listitem>
<para>
With v2token: Trust ID With v2password: Trust ID With
v3password: Trust ID With v3scopedsaml: Trust ID With
v3unscopedadfs: Trust ID With token: Trust ID With
v3token: Trust ID With password: Trust ID With
v3unscopedsaml: Trust ID With osc_password: Trust ID
(Env: OS_TRUST_ID)
With osc_password: Trust ID With v2token: Trust ID
With v2password: Trust ID With v3password: Trust ID
With v3scopedsaml: Trust ID With v3unscopedadfs: Trust
ID With token: Trust ID With v3token: Trust ID With
password: Trust ID With v3unscopedsaml: Trust ID (Env:
OS_TRUST_ID)
</para>
</listitem>
</varlistentry>
@ -317,61 +336,9 @@
<term><command>--os-user-domain-id &lt;auth-user-domain-id&gt;</command></term>
<listitem>
<para>
With v3password: User's domain id With password:
User's domain id With osc_password: User's domain id
(Env: OS_USER_DOMAIN_ID)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-domain-name &lt;auth-domain-name&gt;</command></term>
<listitem>
<para>
With v3password: Domain name to scope to With
v3scopedsaml: Domain name to scope to With
v3unscopedadfs: Domain name to scope to With token:
Domain name to scope to With v3token: Domain name to
scope to With password: Domain name to scope to With
v3unscopedsaml: Domain name to scope to With
osc_password: Domain name to scope to (Env:
OS_DOMAIN_NAME)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-identity-provider-url &lt;auth-identity-provider-url&gt;</command></term>
<listitem>
<para>
With v3unscopedadfs: Identity Provider's URL With
v3unscopedsaml: Identity Provider's URL (Env:
OS_IDENTITY_PROVIDER_URL)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-token &lt;auth-token&gt;</command></term>
<listitem>
<para>
With v2token: Token With v3scopedsaml: Token to
authenticate with With token: Token to authenticate
with With v3token: Token to authenticate with With
token_endpoint: Authentication token to use (Env:
OS_TOKEN)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-domain-id &lt;auth-domain-id&gt;</command></term>
<listitem>
<para>
With v3password: Domain ID to scope to With
v3scopedsaml: Domain ID to scope to With
v3unscopedadfs: Domain ID to scope to With token:
Domain ID to scope to With v3token: Domain ID to scope
to With password: Domain ID to scope to With
v3unscopedsaml: Domain ID to scope to With
osc_password: Domain ID to scope to (Env:
OS_DOMAIN_ID)
With osc_password: User's domain id With v3password:
User's domain id With password: User's domain id (Env:
OS_USER_DOMAIN_ID)
</para>
</listitem>
</varlistentry>
@ -384,13 +351,54 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-token &lt;auth-token&gt;</command></term>
<listitem>
<para>
With token_endpoint: The token that will always be
used With token_endpoint: Authentication token to use
With v2token: Token With v3scopedsaml: Token to
authenticate with With token: Token to authenticate
with With v3token: Token to authenticate with (Env:
OS_TOKEN)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-domain-name &lt;auth-domain-name&gt;</command></term>
<listitem>
<para>
With osc_password: Domain name to scope to With
v3password: Domain name to scope to With v3scopedsaml:
Domain name to scope to With v3unscopedadfs: Domain
name to scope to With token: Domain name to scope to
With v3token: Domain name to scope to With password:
Domain name to scope to With v3unscopedsaml: Domain
name to scope to (Env: OS_DOMAIN_NAME)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-user-domain-name &lt;auth-user-domain-name&gt;</command></term>
<listitem>
<para>
With v3password: User's domain name With password:
User's domain name With osc_password: User's domain
name (Env: OS_USER_DOMAIN_NAME)
With osc_password: User's domain name With v3password:
User's domain name With password: User's domain name
(Env: OS_USER_DOMAIN_NAME)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-domain-id &lt;auth-domain-id&gt;</command></term>
<listitem>
<para>
With osc_password: Domain ID to scope to With
v3password: Domain ID to scope to With v3scopedsaml:
Domain ID to scope to With v3unscopedadfs: Domain ID
to scope to With token: Domain ID to scope to With
v3token: Domain ID to scope to With password: Domain
ID to scope to With v3unscopedsaml: Domain ID to scope
to (Env: OS_DOMAIN_ID)
</para>
</listitem>
</varlistentry>
@ -398,9 +406,9 @@
<term><command>--os-user-id &lt;auth-user-id&gt;</command></term>
<listitem>
<para>
With v2password: User ID to longin with With
v3password: User ID With password: User id With
osc_password: User id (Env: OS_USER_ID)
With osc_password: User id With v2password: User ID to
longin with With v3password: User ID With password:
User id (Env: OS_USER_ID)
</para>
</listitem>
</varlistentry>
@ -408,26 +416,34 @@
<term><command>--os-password &lt;auth-password&gt;</command></term>
<listitem>
<para>
With v2password: Password to use With v3password:
User's password With v3unscopedadfs: Password With
password: User's password With v3unscopedsaml:
Password With osc_password: User's password (Env:
With osc_password: User's password With v2password:
Password to use With v3password: User's password With
v3unscopedadfs: Password With password: User's
password With v3unscopedsaml: Password (Env:
OS_PASSWORD)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-endpoint &lt;auth-endpoint&gt;</command></term>
<listitem>
<para>
With token_endpoint: The endpoint that will always be
used (Env: OS_ENDPOINT)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-project-id &lt;auth-project-id&gt;</command></term>
<listitem>
<para>
With v3password: Project ID to scope to With
v3scopedsaml: Project ID to scope to With
v3unscopedadfs: Project ID to scope to With token:
Project ID to scope to With v3token: Project ID to
scope to With password: Project ID to scope to With
v3unscopedsaml: Project ID to scope to With
osc_password: Project ID to scope to (Env:
OS_PROJECT_ID)
With osc_password: Project ID to scope to With
v3password: Project ID to scope to With v3scopedsaml:
Project ID to scope to With v3unscopedadfs: Project ID
to scope to With token: Project ID to scope to With
v3token: Project ID to scope to With password: Project
ID to scope to With v3unscopedsaml: Project ID to
scope to (Env: OS_PROJECT_ID)
</para>
</listitem>
</varlistentry>
@ -440,14 +456,6 @@
</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">
@ -2002,6 +2010,46 @@ List flavors
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_flavor_set">
<title>openstack flavor set</title>
<screen><computeroutput>usage: openstack flavor set [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--prefix PREFIX] [--property &lt;key=value&gt;]
&lt;flavor&gt;</computeroutput></screen>
<para>
Set flavor properties
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;flavor&gt;</command></term>
<listitem>
<para>
Flavor to modify (name or ID)
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--property &lt;key=value&gt;</command></term>
<listitem>
<para>
Property to add or modify for this flavor (repeat
option to set multiple properties)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_flavor_show">
@ -2033,6 +2081,46 @@ Display flavor details
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_flavor_unset">
<title>openstack flavor unset</title>
<screen><computeroutput>usage: openstack flavor unset [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--prefix PREFIX] [--property &lt;key&gt;]
&lt;flavor&gt;</computeroutput></screen>
<para>
Unset flavor properties
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;flavor&gt;</command></term>
<listitem>
<para>
Flavor to modify (name or ID)
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--property &lt;key&gt;</command></term>
<listitem>
<para>
Property to remove from flavor (repeat option to unset
multiple properties)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_host_list">
@ -3007,7 +3095,8 @@ Display public key details
<screen><computeroutput>usage: openstack limits show [-h] [-f {csv,html,json,table,yaml}] [-c COLUMN]
[--max-width &lt;integer&gt;]
[--quote {all,minimal,none,nonnumeric}]
[--absolute | --rate] [--reserved]</computeroutput></screen>
[--absolute | --rate] [--reserved]
[--project &lt;project&gt;] [--domain &lt;domain&gt;]</computeroutput></screen>
<para>
Show compute and volume limits
</para> <variablelist wordsize="10">
@ -3045,6 +3134,24 @@ Show compute and volume limits
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--project &lt;project&gt;</command></term>
<listitem>
<para>
Show limits for a specific project (name or ID) [only
valid with --absolute]
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--domain &lt;domain&gt;</command></term>
<listitem>
<para>
Domain that owns --project (name or ID) [only valid
with --absolute]
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_module_list">
@ -3079,7 +3186,8 @@ List module versions
<screen><computeroutput>usage: openstack network create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--prefix PREFIX] [--enable | --disable]
[--share | --no-share]
[--share | --no-share] [--project &lt;project&gt;]
[--domain &lt;domain&gt;]
&lt;name&gt;</computeroutput></screen>
<para>
Create new network
@ -3136,6 +3244,22 @@ Create new network
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--project &lt;project&gt;</command></term>
<listitem>
<para>
Owner's project (name or ID)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--domain &lt;domain&gt;</command></term>
<listitem>
<para>
Owner's domain (name or ID)
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_network_delete">
@ -3843,6 +3967,7 @@ List resource usage per project
[--injected-path-size &lt;injected-path-size&gt;]
[--gigabytes &lt;gigabytes&gt;] [--volumes &lt;volumes&gt;]
[--snapshots &lt;snapshots&gt;]
[--volume-type &lt;volume-type&gt;]
&lt;project/class&gt;</computeroutput></screen>
<para>
Set quotas for project or class
@ -3995,6 +4120,14 @@ Set quotas for project or class
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--volume-type &lt;volume-type&gt;</command></term>
<listitem>
<para>
Set quotas for a specific &lt;volume-type&gt;
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="openstackclient_subcommand_quota_show">
@ -4689,7 +4822,7 @@ Add volume to server
[--user-data &lt;user-data&gt;]
[--availability-zone &lt;zone-name&gt;]
[--block-device-mapping &lt;dev-name=mapping&gt;]
[--nic &lt;nic-config-string&gt;]
[--nic &lt;net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid&gt;]
[--hint &lt;key=value&gt;]
[--config-drive &lt;config-drive-volume&gt;|True]
[--min &lt;count&gt;] [--max &lt;count&gt;] [--wait]
@ -4804,10 +4937,16 @@ Create a new server
</listitem>
</varlistentry>
<varlistentry>
<term><command>--nic &lt;nic-config-string&gt;</command></term>
<term><command>--nic &lt;net-id=net-uuid,v4-fixed-ip=ip-addr,v6-fixed-ip=ip-addr,port-id=port-uuid&gt;</command></term>
<listitem>
<para>
Specify NIC configuration (optional extension)
Create a NIC on the server. Specify option multiple
times to create multiple NICs. Either net-id or port-
id must be provided, but not both. net-id: attach NIC
to network with this UUID, port-id: attach NIC to port
with this UUID, v4-fixed-ip: IPv4 fixed address for
NIC (optional), v6-fixed-ip: IPv6 fixed address for
NIC (optional).
</para>
</listitem>
</varlistentry>

118
doc/cli-reference/generated/ch_cli_sahara_commands.xml
View File

@ -15,7 +15,7 @@
interface (CLI) for the Data processing API and its extensions.
This chapter documents <command>sahara</command> version
<literal>0.8.0</literal>.
<literal>0.9.0</literal>.
</para>
<para>For help on a specific <command>sahara</command>
@ -25,7 +25,7 @@
<section xml:id="saharaclient_command_usage">
<title>sahara usage</title>
<screen><computeroutput>usage: sahara [--version] [--debug] [--os-cache]
<screen><computeroutput>usage: sahara [--version] [--debug] [--os-cache] [--region-name &lt;region-name&gt;]
[--service-type &lt;service-type&gt;]
[--endpoint-type &lt;endpoint-type&gt;]
[--sahara-api-version &lt;sahara-api-ver&gt;]
@ -145,14 +145,6 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>event-list</command></term>
<listitem>
<para>
Show events of a cluster.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>image-add-tag</command></term>
<listitem>
@ -323,6 +315,14 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>job-type-list</command></term>
<listitem>
<para>
Show supported job types.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>node-group-template-create</command></term>
<listitem>
@ -421,6 +421,14 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--region-name &lt;region-name&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_REGION_NAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--service-type &lt;service-type&gt;</command></term>
<listitem>
@ -687,7 +695,8 @@ Print a list of available clusters.
</section>
<section xml:id="saharaclient_subcommand_cluster-show">
<title>sahara cluster-show</title>
<screen><computeroutput>usage: sahara cluster-show [--name NAME] [--id &lt;cluster_id&gt;] [--json]</computeroutput></screen>
<screen><computeroutput>usage: sahara cluster-show [--name NAME] [--id &lt;cluster_id&gt;]
[--show-progress SHOW_PROGRESS] [--json]</computeroutput></screen>
<para>
Show details of a cluster.
</para> <variablelist wordsize="10">
@ -708,6 +717,14 @@ Show details of a cluster.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--show-progress SHOW_PROGRESS</command></term>
<listitem>
<para>
Show provision progress events of the cluster.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--json</command></term>
<listitem>
@ -915,40 +932,6 @@ Show details of a data source.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="saharaclient_subcommand_event-list">
<title>sahara event-list</title>
<screen><computeroutput>usage: sahara event-list [--name &lt;cluster_name&gt;] [--id &lt;cluster_id&gt;]
[--step &lt;step_id&gt;]</computeroutput></screen>
<para>
Show events of a cluster.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--name &lt;cluster_name&gt;</command></term>
<listitem>
<para>
Name of the cluster to show events.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--id &lt;cluster_id&gt; ID</command></term>
<listitem>
<para>
of the cluster to show events.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--step &lt;step_id&gt; ID</command></term>
<listitem>
<para>
of provision step to show events.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="saharaclient_subcommand_image-add-tag">
@ -1161,7 +1144,7 @@ Record a job binary.
</section>
<section xml:id="saharaclient_subcommand_job-binary-data-create">
<title>sahara job-binary-data-create</title>
<screen><computeroutput>usage: sahara job-binary-data-create [--file FILE]</computeroutput></screen>
<screen><computeroutput>usage: sahara job-binary-data-create [--file FILE] [--name NAME]</computeroutput></screen>
<para>
Store data in the internal DB. Use 'swift upload' instead of this command. Use
this command only if Swift is not available.
@ -1175,6 +1158,14 @@ this command only if Swift is not available.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--name NAME</command></term>
<listitem>
<para>
Name of the job binary internal.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="saharaclient_subcommand_job-binary-data-delete">
@ -1472,6 +1463,41 @@ Show details of a job template.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="saharaclient_subcommand_job-type-list">
<title>sahara job-type-list</title>
<screen><computeroutput>usage: sahara job-type-list [--type &lt;job_type&gt;] [--plugin &lt;plugin&gt;]
[--plugin-version &lt;plugin_version&gt;]</computeroutput></screen>
<para>
Show supported job types.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--type &lt;job_type&gt;</command></term>
<listitem>
<para>
Report only on this job type
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--plugin &lt;plugin&gt;</command></term>
<listitem>
<para>
Report only job types supported by this plugin.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--plugin-version &lt;plugin_version&gt;</command></term>
<listitem>
<para>
Report only on job types supported by this version of
a specified plugin. Only valid with --plugin.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="saharaclient_subcommand_node-group-template-create">

2
doc/cli-reference/generated/ch_cli_trove_commands.xml
View File

@ -15,7 +15,7 @@
interface (CLI) for the Database API and its extensions.
This chapter documents <command>trove</command> version
<literal>1.0.9</literal>.
<literal>1.1.0</literal>.
</para>
<para>For help on a specific <command>trove</command>