openstack/openstack-manuals
Code Issues Proposed changes

Merge "Update cli commands with updated auto-command"

Browse Source
This commit is contained in:
Jenkins 2014-05-01 15:30:36 +00:00 committed by Gerrit Code Review
commit 013c6c9334
9 changed files with 650 additions and 1149 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
doc/common/ch_cli_ceilometer_commands.xml
View File

@ -33,8 +33,7 @@
[--ceilometer-api-version CEILOMETER_API_VERSION]
[--os-service-type OS_SERVICE_TYPE]
[--os-endpoint-type OS_ENDPOINT_TYPE]
<subcommand> ...
</computeroutput></screen>
&lt;subcommand&gt; ...</computeroutput></screen>
<variablelist wordsize="10">
<title>Subcommands</title>
<varlistentry>
@ -456,8 +455,7 @@
[--time-constraint &lt;Time Constraint&gt;]
--alarm_ids &lt;ALARM IDS&gt;
[--operator &lt;OPERATOR&gt;]
[--repeat-actions {True|False}]
</computeroutput></screen>
[--repeat-actions {True|False}]</computeroutput></screen>
<para>
Create a new alarm based on state of other alarms.
</para> <variablelist wordsize="10">
@ -599,8 +597,7 @@ Create a new alarm based on state of other alarms.
[--remove-time-constraint &lt;Constraint names&gt;]
[--alarm_ids &lt;ALARM IDS&gt;]
[--operator &lt;OPERATOR&gt;]
[--repeat-actions {True|False}]
</computeroutput></screen>
[--repeat-actions {True|False}]</computeroutput></screen>
<para>
Update an existing alarm based on state of other alarms.
</para> <variablelist wordsize="10">
@ -745,8 +742,7 @@ Update an existing alarm based on state of other alarms.
</section>
<section xml:id="ceilometerclient_subcommand_alarm-delete">
<title>ceilometer alarm-delete command</title>
<screen><computeroutput>usage: ceilometer alarm-delete -a &lt;ALARM_ID&gt;
</computeroutput></screen>
<screen><computeroutput>usage: ceilometer alarm-delete -a &lt;ALARM_ID&gt;</computeroutput></screen>
<para>
Delete an alarm.
</para> <variablelist wordsize="10">
@ -763,8 +759,7 @@ Delete an alarm.
</section>
<section xml:id="ceilometerclient_subcommand_alarm-history">
<title>ceilometer alarm-history command</title>
<screen><computeroutput>usage: ceilometer alarm-history -a &lt;ALARM_ID&gt; [-q &lt;QUERY&gt;]
</computeroutput></screen>
<screen><computeroutput>usage: ceilometer alarm-history -a &lt;ALARM_ID&gt; [-q &lt;QUERY&gt;]</computeroutput></screen>
<para>
Display the change history of an alarm.
</para> <variablelist wordsize="10">
@ -791,8 +786,7 @@ Display the change history of an alarm.
</section>
<section xml:id="ceilometerclient_subcommand_alarm-list">
<title>ceilometer alarm-list command</title>
<screen><computeroutput>usage: ceilometer alarm-list [-q &lt;QUERY&gt;]
</computeroutput></screen>
<screen><computeroutput>usage: ceilometer alarm-list [-q &lt;QUERY&gt;]</computeroutput></screen>
<para>
List the user's alarms.
</para> <variablelist wordsize="10">
@ -811,8 +805,7 @@ List the user's alarms.
</section>
<section xml:id="ceilometerclient_subcommand_alarm-show">
<title>ceilometer alarm-show command</title>
<screen><computeroutput>usage: ceilometer alarm-show -a &lt;ALARM_ID&gt;
</computeroutput></screen>
<screen><computeroutput>usage: ceilometer alarm-show -a &lt;ALARM_ID&gt;</computeroutput></screen>
<para>
Show an alarm.
</para> <variablelist wordsize="10">
@ -829,8 +822,7 @@ Show an alarm.
</section>
<section xml:id="ceilometerclient_subcommand_alarm-state-get">
<title>ceilometer alarm-state-get command</title>
<screen><computeroutput>usage: ceilometer alarm-state-get -a &lt;ALARM_ID&gt;
</computeroutput></screen>
<screen><computeroutput>usage: ceilometer alarm-state-get -a &lt;ALARM_ID&gt;</computeroutput></screen>
<para>
Get the state of an alarm.
</para> <variablelist wordsize="10">
@ -847,8 +839,7 @@ Get the state of an alarm.
</section>
<section xml:id="ceilometerclient_subcommand_alarm-state-set">
<title>ceilometer alarm-state-set command</title>
<screen><computeroutput>usage: ceilometer alarm-state-set -a &lt;ALARM_ID&gt; --state &lt;STATE&gt;
</computeroutput></screen>
<screen><computeroutput>usage: ceilometer alarm-state-set -a &lt;ALARM_ID&gt; --state &lt;STATE&gt;</computeroutput></screen>
<para>
Set the state of an alarm.
</para> <variablelist wordsize="10">
@ -889,8 +880,7 @@ Set the state of an alarm.
[--statistic &lt;STATISTIC&gt;]
[--comparison-operator &lt;OPERATOR&gt;]
--threshold &lt;THRESHOLD&gt; [-q &lt;QUERY&gt;]
[--repeat-actions {True|False}]
</computeroutput></screen>
[--repeat-actions {True|False}]</computeroutput></screen>
<para>
Create a new alarm based on computed statistics.
</para> <variablelist wordsize="10">
@ -1080,8 +1070,7 @@ Create a new alarm based on computed statistics.
[--comparison-operator &lt;OPERATOR&gt;]
[--threshold &lt;THRESHOLD&gt;]
[-q &lt;QUERY&gt;]
[--repeat-actions {True|False}]
</computeroutput></screen>
[--repeat-actions {True|False}]</computeroutput></screen>
<para>
Update an existing alarm based on computed statistics.
</para> <variablelist wordsize="10">
@ -1286,8 +1275,7 @@ Update an existing alarm based on computed statistics.
[--comparison-operator &lt;OPERATOR&gt;]
[--threshold &lt;THRESHOLD&gt;]
[--matching-metadata &lt;Matching Metadata&gt;]
[--repeat-actions {True|False}]
</computeroutput></screen>
[--repeat-actions {True|False}]</computeroutput></screen>
<para>
Update an existing alarm (Deprecated).
</para> <variablelist wordsize="10">
@ -1476,8 +1464,7 @@ Update an existing alarm (Deprecated).
</section>
<section xml:id="ceilometerclient_subcommand_event-list">
<title>ceilometer event-list command</title>
<screen><computeroutput>usage: ceilometer event-list [-q &lt;QUERY&gt;]
</computeroutput></screen>
<screen><computeroutput>usage: ceilometer event-list [-q &lt;QUERY&gt;]</computeroutput></screen>
<para>
List events.
</para> <variablelist wordsize="10">
@ -1496,8 +1483,7 @@ List events.
</section>
<section xml:id="ceilometerclient_subcommand_event-show">
<title>ceilometer event-show command</title>
<screen><computeroutput>usage: ceilometer event-show -m &lt;message_id&gt;
</computeroutput></screen>
<screen><computeroutput>usage: ceilometer event-show -m &lt;message_id&gt;</computeroutput></screen>
<para>
Show a particular event.
</para> <variablelist wordsize="10">
@ -1514,15 +1500,14 @@ Show a particular event.
</section>
<section xml:id="ceilometerclient_subcommand_event-type-list">
<title>ceilometer event-type-list command</title>
<screen><computeroutput>usage: ceilometer event-type-list
</computeroutput></screen>
<screen><computeroutput>usage: ceilometer event-type-list</computeroutput></screen>
<para>
List event types.
</para> </section>
</para>
</section>
<section xml:id="ceilometerclient_subcommand_meter-list">
<title>ceilometer meter-list command</title>
<screen><computeroutput>usage: ceilometer meter-list [-q &lt;QUERY&gt;]
</computeroutput></screen>
<screen><computeroutput>usage: ceilometer meter-list [-q &lt;QUERY&gt;]</computeroutput></screen>
<para>
List the user's meters.
</para> <variablelist wordsize="10">
@ -1542,8 +1527,7 @@ List the user's meters.
<section xml:id="ceilometerclient_subcommand_query-alarm-history">
<title>ceilometer query-alarm-history command</title>
<screen><computeroutput>usage: ceilometer query-alarm-history [-f &lt;FILTER&gt;] [-o &lt;ORDERBY&gt;]
[-l &lt;LIMIT&gt;]
</computeroutput></screen>
[-l &lt;LIMIT&gt;]</computeroutput></screen>
<para>
Query Alarm History.
</para> <variablelist wordsize="10">
@ -1579,8 +1563,7 @@ Query Alarm History.
</section>
<section xml:id="ceilometerclient_subcommand_query-alarms">
<title>ceilometer query-alarms command</title>
<screen><computeroutput>usage: ceilometer query-alarms [-f &lt;FILTER&gt;] [-o &lt;ORDERBY&gt;] [-l &lt;LIMIT&gt;]
</computeroutput></screen>
<screen><computeroutput>usage: ceilometer query-alarms [-f &lt;FILTER&gt;] [-o &lt;ORDERBY&gt;] [-l &lt;LIMIT&gt;]</computeroutput></screen>
<para>
Query Alarms.
</para> <variablelist wordsize="10">
@ -1616,8 +1599,7 @@ Query Alarms.
</section>
<section xml:id="ceilometerclient_subcommand_query-samples">
<title>ceilometer query-samples command</title>
<screen><computeroutput>usage: ceilometer query-samples [-f &lt;FILTER&gt;] [-o &lt;ORDERBY&gt;] [-l &lt;LIMIT&gt;]
</computeroutput></screen>
<screen><computeroutput>usage: ceilometer query-samples [-f &lt;FILTER&gt;] [-o &lt;ORDERBY&gt;] [-l &lt;LIMIT&gt;]</computeroutput></screen>
<para>
Query samples.
</para> <variablelist wordsize="10">
@ -1653,8 +1635,7 @@ Query samples.
</section>
<section xml:id="ceilometerclient_subcommand_resource-list">
<title>ceilometer resource-list command</title>
<screen><computeroutput>usage: ceilometer resource-list [-q &lt;QUERY&gt;]
</computeroutput></screen>
<screen><computeroutput>usage: ceilometer resource-list [-q &lt;QUERY&gt;]</computeroutput></screen>
<para>
List the resources.
</para> <variablelist wordsize="10">
@ -1673,8 +1654,7 @@ List the resources.
</section>
<section xml:id="ceilometerclient_subcommand_resource-show">
<title>ceilometer resource-show command</title>
<screen><computeroutput>usage: ceilometer resource-show -r &lt;RESOURCE_ID&gt;
</computeroutput></screen>
<screen><computeroutput>usage: ceilometer resource-show -r &lt;RESOURCE_ID&gt;</computeroutput></screen>
<para>
Show the resource.
</para> <variablelist wordsize="10">
@ -1697,8 +1677,7 @@ Show the resource.
--meter-unit &lt;METER_UNIT&gt; --sample-volume
&lt;SAMPLE_VOLUME&gt;
[--resource-metadata &lt;RESOURCE_METADATA&gt;]
[--timestamp &lt;TIMESTAMP&gt;]
</computeroutput></screen>
[--timestamp &lt;TIMESTAMP&gt;]</computeroutput></screen>
<para>
Create a sample.
</para> <variablelist wordsize="10">
@ -1781,8 +1760,7 @@ Create a sample.
</section>
<section xml:id="ceilometerclient_subcommand_sample-list">
<title>ceilometer sample-list command</title>
<screen><computeroutput>usage: ceilometer sample-list [-q &lt;QUERY&gt;] -m &lt;NAME&gt; [-l &lt;NUMBER&gt;]
</computeroutput></screen>
<screen><computeroutput>usage: ceilometer sample-list [-q &lt;QUERY&gt;] -m &lt;NAME&gt; [-l &lt;NUMBER&gt;]</computeroutput></screen>
<para>
List the samples for a meter.
</para> <variablelist wordsize="10">
@ -1818,8 +1796,7 @@ List the samples for a meter.
<section xml:id="ceilometerclient_subcommand_statistics">
<title>ceilometer statistics command</title>
<screen><computeroutput>usage: ceilometer statistics [-q &lt;QUERY&gt;] -m &lt;NAME&gt; [-p &lt;PERIOD&gt;] [-g &lt;FIELD&gt;]
[-a &lt;FUNC&gt;[&lt;-&lt;PARAM&gt;]]
</computeroutput></screen>
[-a &lt;FUNC&gt;[&lt;-&lt;PARAM&gt;]]</computeroutput></screen>
<para>
List the statistics for a meter.
</para> <variablelist wordsize="10">
@ -1872,8 +1849,7 @@ List the statistics for a meter.
</section>
<section xml:id="ceilometerclient_subcommand_trait-description-list">
<title>ceilometer trait-description-list command</title>
<screen><computeroutput>usage: ceilometer trait-description-list -e &lt;EVENT_TYPE&gt;
</computeroutput></screen>
<screen><computeroutput>usage: ceilometer trait-description-list -e &lt;EVENT_TYPE&gt;</computeroutput></screen>
<para>
List trait info for an event type.
</para> <variablelist wordsize="10">
@ -1891,8 +1867,7 @@ List trait info for an event type.
</section>
<section xml:id="ceilometerclient_subcommand_trait-list">
<title>ceilometer trait-list command</title>
<screen><computeroutput>usage: ceilometer trait-list -e &lt;EVENT_TYPE&gt; -t &lt;TRAIT_NAME&gt;
</computeroutput></screen>
<screen><computeroutput>usage: ceilometer trait-list -e &lt;EVENT_TYPE&gt; -t &lt;TRAIT_NAME&gt;</computeroutput></screen>
<para>
List trait all traits with name &lt;trait_name&gt; for Event Type &lt;event_type&gt;.
</para> <variablelist wordsize="10">

237
doc/common/ch_cli_cinder_commands.xml
View File

@ -30,8 +30,7 @@
[--endpoint-type &lt;endpoint-type&gt;]
[--os-volume-api-version &lt;volume-api-ver&gt;]
[--os-cacert &lt;ca-certificate&gt;] [--retries &lt;retries&gt;]
&lt;subcommand&gt; ...
</computeroutput></screen>
&lt;subcommand&gt; ...</computeroutput></screen>
<variablelist wordsize="10">
<title>Subcommands</title>
<varlistentry>
@ -717,25 +716,24 @@
</section>
<section xml:id="cinderclient_subcommand_absolute-limits">
<title>cinder absolute-limits command</title>
<screen><computeroutput>usage: cinder absolute-limits
</computeroutput></screen>
<screen><computeroutput>usage: cinder absolute-limits</computeroutput></screen>
<para>
Print a list of absolute limits for a user
</para> </section>
</para>
</section>
<section xml:id="cinderclient_subcommand_availability-zone-list">
<title>cinder availability-zone-list command</title>
<screen><computeroutput>usage: cinder availability-zone-list
</computeroutput></screen>
<screen><computeroutput>usage: cinder availability-zone-list</computeroutput></screen>
<para>
List all the availability zones.
</para> </section>
</para>
</section>
<section xml:id="cinderclient_subcommand_backup-create">
<title>cinder backup-create command</title>
<screen><computeroutput>usage: cinder backup-create [--container &lt;container&gt;]
[--display-name &lt;display-name&gt;]
[--display-description &lt;display-description&gt;]
&lt;volume&gt;
</computeroutput></screen>
&lt;volume&gt;</computeroutput></screen>
<para>
Creates a backup.
</para> <variablelist wordsize="10">
@ -779,8 +777,7 @@ Creates a backup.
</section>
<section xml:id="cinderclient_subcommand_backup-delete">
<title>cinder backup-delete command</title>
<screen><computeroutput>usage: cinder backup-delete &lt;backup&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder backup-delete &lt;backup&gt;</computeroutput></screen>
<para>
Remove a backup.
</para> <variablelist wordsize="10">
@ -797,15 +794,14 @@ Remove a backup.
</section>
<section xml:id="cinderclient_subcommand_backup-list">
<title>cinder backup-list command</title>
<screen><computeroutput>usage: cinder backup-list
</computeroutput></screen>
<screen><computeroutput>usage: cinder backup-list</computeroutput></screen>
<para>
List all the backups.
</para> </section>
</para>
</section>
<section xml:id="cinderclient_subcommand_backup-restore">
<title>cinder backup-restore command</title>
<screen><computeroutput>usage: cinder backup-restore [--volume-id &lt;volume&gt;] &lt;backup&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder backup-restore [--volume-id &lt;volume&gt;] &lt;backup&gt;</computeroutput></screen>
<para>
Restore a backup.
</para> <variablelist wordsize="10">
@ -833,8 +829,7 @@ Restore a backup.
</section>
<section xml:id="cinderclient_subcommand_backup-show">
<title>cinder backup-show command</title>
<screen><computeroutput>usage: cinder backup-show &lt;backup&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder backup-show &lt;backup&gt;</computeroutput></screen>
<para>
Show details about a backup.
</para> <variablelist wordsize="10">
@ -858,8 +853,7 @@ Show details about a backup.
[--volume-type &lt;volume-type&gt;]
[--availability-zone &lt;availability-zone&gt;]
[--metadata [&lt;key=value&gt; [&lt;key=value&gt; ...]]]
&lt;size&gt;
</computeroutput></screen>
&lt;size&gt;</computeroutput></screen>
<para>
Add a new volume.
</para> <variablelist wordsize="10">
@ -944,15 +938,14 @@ Add a new volume.
</section>
<section xml:id="cinderclient_subcommand_credentials">
<title>cinder credentials command</title>
<screen><computeroutput>usage: cinder credentials
</computeroutput></screen>
<screen><computeroutput>usage: cinder credentials</computeroutput></screen>
<para>
Show user credentials returned from auth.
</para> </section>
</para>
</section>
<section xml:id="cinderclient_subcommand_delete">
<title>cinder delete command</title>
<screen><computeroutput>usage: cinder delete &lt;volume&gt; [&lt;volume&gt; ...]
</computeroutput></screen>
<screen><computeroutput>usage: cinder delete &lt;volume&gt; [&lt;volume&gt; ...]</computeroutput></screen>
<para>
Remove volume(s).
</para> <variablelist wordsize="10">
@ -972,8 +965,7 @@ Remove volume(s).
<screen><computeroutput>usage: cinder encryption-type-create [--cipher &lt;cipher&gt;]
[--key_size &lt;key_size&gt;]
[--control_location &lt;control_location&gt;]
&lt;volume_type&gt; &lt;provider&gt;
</computeroutput></screen>
&lt;volume_type&gt; &lt;provider&gt;</computeroutput></screen>
<para>
Create a new encryption type for a volume type (Admin Only).
</para> <variablelist wordsize="10">
@ -1030,8 +1022,7 @@ Create a new encryption type for a volume type (Admin Only).
</section>
<section xml:id="cinderclient_subcommand_encryption-type-delete">
<title>cinder encryption-type-delete command</title>
<screen><computeroutput>usage: cinder encryption-type-delete &lt;volume_type&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder encryption-type-delete &lt;volume_type&gt;</computeroutput></screen>
<para>
Delete the encryption type for a volume type (Admin Only).
</para> <variablelist wordsize="10">
@ -1048,15 +1039,14 @@ Delete the encryption type for a volume type (Admin Only).
</section>
<section xml:id="cinderclient_subcommand_encryption-type-list">
<title>cinder encryption-type-list command</title>
<screen><computeroutput>usage: cinder encryption-type-list
</computeroutput></screen>
<screen><computeroutput>usage: cinder encryption-type-list</computeroutput></screen>
<para>
List encryption type information for all volume types (Admin Only).
</para> </section>
</para>
</section>
<section xml:id="cinderclient_subcommand_encryption-type-show">
<title>cinder encryption-type-show command</title>
<screen><computeroutput>usage: cinder encryption-type-show &lt;volume_type&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder encryption-type-show &lt;volume_type&gt;</computeroutput></screen>
<para>
Show the encryption type information for a volume type (Admin Only).
</para> <variablelist wordsize="10">
@ -1073,15 +1063,14 @@ Show the encryption type information for a volume type (Admin Only).
</section>
<section xml:id="cinderclient_subcommand_endpoints">
<title>cinder endpoints command</title>
<screen><computeroutput>usage: cinder endpoints
</computeroutput></screen>
<screen><computeroutput>usage: cinder endpoints</computeroutput></screen>
<para>
Discover endpoints that get returned from the authenticate services.
</para> </section>
</para>
</section>
<section xml:id="cinderclient_subcommand_extend">
<title>cinder extend command</title>
<screen><computeroutput>usage: cinder extend &lt;volume&gt; &lt;new-size&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder extend &lt;volume&gt; &lt;new-size&gt;</computeroutput></screen>
<para>
Attempt to extend the size of an existing volume.
</para> <variablelist wordsize="10">
@ -1106,15 +1095,14 @@ Attempt to extend the size of an existing volume.
</section>
<section xml:id="cinderclient_subcommand_extra-specs-list">
<title>cinder extra-specs-list command</title>
<screen><computeroutput>usage: cinder extra-specs-list
</computeroutput></screen>
<screen><computeroutput>usage: cinder extra-specs-list</computeroutput></screen>
<para>
Print a list of current 'volume types and extra specs' (Admin Only).
</para> </section>
</para>
</section>
<section xml:id="cinderclient_subcommand_force-delete">
<title>cinder force-delete command</title>
<screen><computeroutput>usage: cinder force-delete &lt;volume&gt; [&lt;volume&gt; ...]
</computeroutput></screen>
<screen><computeroutput>usage: cinder force-delete &lt;volume&gt; [&lt;volume&gt; ...]</computeroutput></screen>
<para>
Attempt forced removal of volume(s), regardless of the state(s).
</para> <variablelist wordsize="10">
@ -1133,8 +1121,7 @@ Attempt forced removal of volume(s), regardless of the state(s).
<title>cinder list command</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; ...]]]</computeroutput></screen>
<para>
List all the volumes.
</para> <variablelist wordsize="10">
@ -1175,15 +1162,14 @@ List all the volumes.
</section>
<section xml:id="cinderclient_subcommand_list-extensions">
<title>cinder list-extensions command</title>
<screen><computeroutput>usage: cinder list-extensions
</computeroutput></screen>
<screen><computeroutput>usage: cinder list-extensions</computeroutput></screen>
<para>
List all the os-api extensions that are available.
</para> </section>
</para>
</section>
<section xml:id="cinderclient_subcommand_metadata">
<title>cinder metadata command</title>
<screen><computeroutput>usage: cinder metadata &lt;volume&gt; &lt;action&gt; &lt;key=value&gt; [&lt;key=value&gt; ...]
</computeroutput></screen>
<screen><computeroutput>usage: cinder metadata &lt;volume&gt; &lt;action&gt; &lt;key=value&gt; [&lt;key=value&gt; ...]</computeroutput></screen>
<para>
Set or Delete metadata on a volume.
</para> <variablelist wordsize="10">
@ -1216,8 +1202,7 @@ Set or Delete metadata on a volume.
</section>
<section xml:id="cinderclient_subcommand_metadata-show">
<title>cinder metadata-show command</title>
<screen><computeroutput>usage: cinder metadata-show &lt;volume&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder metadata-show &lt;volume&gt;</computeroutput></screen>
<para>
Show metadata of given volume.
</para> <variablelist wordsize="10">
@ -1234,8 +1219,7 @@ Show metadata of given volume.
</section>
<section xml:id="cinderclient_subcommand_metadata-update-all">
<title>cinder metadata-update-all command</title>
<screen><computeroutput>usage: cinder metadata-update-all &lt;volume&gt; &lt;key=value&gt; [&lt;key=value&gt; ...]
</computeroutput></screen>
<screen><computeroutput>usage: cinder metadata-update-all &lt;volume&gt; &lt;key=value&gt; [&lt;key=value&gt; ...]</computeroutput></screen>
<para>
Update all metadata of a volume.
</para> <variablelist wordsize="10">
@ -1260,8 +1244,7 @@ Update all metadata of a volume.
</section>
<section xml:id="cinderclient_subcommand_migrate">
<title>cinder migrate command</title>
<screen><computeroutput>usage: cinder migrate [--force-host-copy &lt;True|False&gt;] &lt;volume&gt; &lt;host&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder migrate [--force-host-copy &lt;True|False&gt;] &lt;volume&gt; &lt;host&gt;</computeroutput></screen>
<para>
Migrate the volume to the new host.
</para> <variablelist wordsize="10">
@ -1299,8 +1282,7 @@ Migrate the volume to the new host.
</section>
<section xml:id="cinderclient_subcommand_qos-associate">
<title>cinder qos-associate command</title>
<screen><computeroutput>usage: cinder qos-associate &lt;qos_specs&gt; &lt;volume_type_id&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder qos-associate &lt;qos_specs&gt; &lt;volume_type_id&gt;</computeroutput></screen>
<para>
Associate qos specs with specific volume type.
</para> <variablelist wordsize="10">
@ -1325,8 +1307,7 @@ Associate qos specs with specific volume type.
</section>
<section xml:id="cinderclient_subcommand_qos-create">
<title>cinder qos-create command</title>
<screen><computeroutput>usage: cinder qos-create &lt;name&gt; &lt;key=value&gt; [&lt;key=value&gt; ...]
</computeroutput></screen>
<screen><computeroutput>usage: cinder qos-create &lt;name&gt; &lt;key=value&gt; [&lt;key=value&gt; ...]</computeroutput></screen>
<para>
Create a new qos specs.
</para> <variablelist wordsize="10">
@ -1351,8 +1332,7 @@ Create a new qos specs.
</section>
<section xml:id="cinderclient_subcommand_qos-delete">
<title>cinder qos-delete command</title>
<screen><computeroutput>usage: cinder qos-delete [--force &lt;True|False&gt;] &lt;qos_specs&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder qos-delete [--force &lt;True|False&gt;] &lt;qos_specs&gt;</computeroutput></screen>
<para>
Delete a specific qos specs.
</para> <variablelist wordsize="10">
@ -1381,8 +1361,7 @@ Delete a specific qos specs.
</section>
<section xml:id="cinderclient_subcommand_qos-disassociate">
<title>cinder qos-disassociate command</title>
<screen><computeroutput>usage: cinder qos-disassociate &lt;qos_specs&gt; &lt;volume_type_id&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder qos-disassociate &lt;qos_specs&gt; &lt;volume_type_id&gt;</computeroutput></screen>
<para>
Disassociate qos specs from specific volume type.
</para> <variablelist wordsize="10">
@ -1407,8 +1386,7 @@ Disassociate qos specs from specific volume type.
</section>
<section xml:id="cinderclient_subcommand_qos-disassociate-all">
<title>cinder qos-disassociate-all command</title>
<screen><computeroutput>usage: cinder qos-disassociate-all &lt;qos_specs&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder qos-disassociate-all &lt;qos_specs&gt;</computeroutput></screen>
<para>
Disassociate qos specs from all of its associations.
</para> <variablelist wordsize="10">
@ -1425,8 +1403,7 @@ Disassociate qos specs from all of its associations.
</section>
<section xml:id="cinderclient_subcommand_qos-get-association">
<title>cinder qos-get-association command</title>
<screen><computeroutput>usage: cinder qos-get-association &lt;qos_specs&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder qos-get-association &lt;qos_specs&gt;</computeroutput></screen>
<para>
Get all associations of specific qos specs.
</para> <variablelist wordsize="10">
@ -1443,8 +1420,7 @@ Get all associations of specific qos specs.
</section>
<section xml:id="cinderclient_subcommand_qos-key">
<title>cinder qos-key command</title>
<screen><computeroutput>usage: cinder qos-key &lt;qos_specs&gt; &lt;action&gt; key=value [key=value ...]
</computeroutput></screen>
<screen><computeroutput>usage: cinder qos-key &lt;qos_specs&gt; &lt;action&gt; key=value [key=value ...]</computeroutput></screen>
<para>
Set or unset specifications for a qos spec.
</para> <variablelist wordsize="10">
@ -1477,15 +1453,14 @@ Set or unset specifications for a qos spec.
</section>
<section xml:id="cinderclient_subcommand_qos-list">
<title>cinder qos-list command</title>
<screen><computeroutput>usage: cinder qos-list
</computeroutput></screen>
<screen><computeroutput>usage: cinder qos-list</computeroutput></screen>
<para>
Get full list of qos specs.
</para> </section>
</para>
</section>
<section xml:id="cinderclient_subcommand_qos-show">
<title>cinder qos-show command</title>
<screen><computeroutput>usage: cinder qos-show &lt;qos_specs&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder qos-show &lt;qos_specs&gt;</computeroutput></screen>
<para>
Get a specific qos specs.
</para> <variablelist wordsize="10">
@ -1502,8 +1477,7 @@ Get a specific qos specs.
</section>
<section xml:id="cinderclient_subcommand_quota-class-show">
<title>cinder quota-class-show command</title>
<screen><computeroutput>usage: cinder quota-class-show &lt;class&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder quota-class-show &lt;class&gt;</computeroutput></screen>
<para>
List the quotas for a quota class.
</para> <variablelist wordsize="10">
@ -1524,8 +1498,7 @@ List the quotas for a quota class.
[--snapshots &lt;snapshots&gt;]
[--gigabytes &lt;gigabytes&gt;]
[--volume-type &lt;volume_type_name&gt;]
&lt;class&gt;
</computeroutput></screen>
&lt;class&gt;</computeroutput></screen>
<para>
Update the quotas for a quota class.
</para> <variablelist wordsize="10">
@ -1577,8 +1550,7 @@ Update the quotas for a quota class.
</section>
<section xml:id="cinderclient_subcommand_quota-defaults">
<title>cinder quota-defaults command</title>
<screen><computeroutput>usage: cinder quota-defaults &lt;tenant_id&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder quota-defaults &lt;tenant_id&gt;</computeroutput></screen>
<para>
List the default quotas for a tenant.
</para> <variablelist wordsize="10">
@ -1595,8 +1567,7 @@ List the default quotas for a tenant.
</section>
<section xml:id="cinderclient_subcommand_quota-show">
<title>cinder quota-show command</title>
<screen><computeroutput>usage: cinder quota-show &lt;tenant_id&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder quota-show &lt;tenant_id&gt;</computeroutput></screen>
<para>
List the quotas for a tenant.
</para> <variablelist wordsize="10">
@ -1616,8 +1587,7 @@ List the quotas for a tenant.
<screen><computeroutput>usage: cinder quota-update [--volumes &lt;volumes&gt;] [--snapshots &lt;snapshots&gt;]
[--gigabytes &lt;gigabytes&gt;]
[--volume-type &lt;volume_type_name&gt;]
&lt;tenant_id&gt;
</computeroutput></screen>
&lt;tenant_id&gt;</computeroutput></screen>
<para>
Update the quotas for a tenant.
</para> <variablelist wordsize="10">
@ -1669,8 +1639,7 @@ Update the quotas for a tenant.
</section>
<section xml:id="cinderclient_subcommand_quota-usage">
<title>cinder quota-usage command</title>
<screen><computeroutput>usage: cinder quota-usage &lt;tenant_id&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder quota-usage &lt;tenant_id&gt;</computeroutput></screen>
<para>
List the quota usage for a tenant.
</para> <variablelist wordsize="10">
@ -1687,15 +1656,14 @@ List the quota usage for a tenant.
</section>
<section xml:id="cinderclient_subcommand_rate-limits">
<title>cinder rate-limits command</title>
<screen><computeroutput>usage: cinder rate-limits
</computeroutput></screen>
<screen><computeroutput>usage: cinder rate-limits</computeroutput></screen>
<para>
Print a list of rate limits for a user
</para> </section>
</para>
</section>
<section xml:id="cinderclient_subcommand_readonly-mode-update">
<title>cinder readonly-mode-update command</title>
<screen><computeroutput>usage: cinder readonly-mode-update &lt;volume&gt; &lt;True|true|False|false&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder readonly-mode-update &lt;volume&gt; &lt;True|true|False|false&gt;</computeroutput></screen>
<para>
Update volume read-only access mode read_only.
</para> <variablelist wordsize="10">
@ -1722,8 +1690,7 @@ Update volume read-only access mode read_only.
<section xml:id="cinderclient_subcommand_rename">
<title>cinder rename command</title>
<screen><computeroutput>usage: cinder rename [--display-description &lt;display-description&gt;]
&lt;volume&gt; [&lt;display-name&gt;]
</computeroutput></screen>
&lt;volume&gt; [&lt;display-name&gt;]</computeroutput></screen>
<para>
Rename a volume.
</para> <variablelist wordsize="10">
@ -1759,8 +1726,7 @@ Rename a volume.
</section>
<section xml:id="cinderclient_subcommand_reset-state">
<title>cinder reset-state command</title>
<screen><computeroutput>usage: cinder reset-state [--state &lt;state&gt;] &lt;volume&gt; [&lt;volume&gt; ...]
</computeroutput></screen>
<screen><computeroutput>usage: cinder reset-state [--state &lt;state&gt;] &lt;volume&gt; [&lt;volume&gt; ...]</computeroutput></screen>
<para>
Explicitly update the state of a volume.
</para> <variablelist wordsize="10">
@ -1790,8 +1756,7 @@ Explicitly update the state of a volume.
</section>
<section xml:id="cinderclient_subcommand_service-disable">
<title>cinder service-disable command</title>
<screen><computeroutput>usage: cinder service-disable &lt;hostname&gt; &lt;binary&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder service-disable &lt;hostname&gt; &lt;binary&gt;</computeroutput></screen>
<para>
Disable the service.
</para> <variablelist wordsize="10">
@ -1816,8 +1781,7 @@ Disable the service.
</section>
<section xml:id="cinderclient_subcommand_service-enable">
<title>cinder service-enable command</title>
<screen><computeroutput>usage: cinder service-enable &lt;hostname&gt; &lt;binary&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder service-enable &lt;hostname&gt; &lt;binary&gt;</computeroutput></screen>
<para>
Enable the service.
</para> <variablelist wordsize="10">
@ -1842,8 +1806,7 @@ Enable the service.
</section>
<section xml:id="cinderclient_subcommand_service-list">
<title>cinder service-list command</title>
<screen><computeroutput>usage: cinder service-list [--host &lt;hostname&gt;] [--binary &lt;binary&gt;]
</computeroutput></screen>
<screen><computeroutput>usage: cinder service-list [--host &lt;hostname&gt;] [--binary &lt;binary&gt;]</computeroutput></screen>
<para>
List all the services. Filter by host &amp; service binary.
</para> <variablelist wordsize="10">
@ -1868,8 +1831,7 @@ List all the services. Filter by host &amp; service binary.
</section>
<section xml:id="cinderclient_subcommand_show">
<title>cinder show command</title>
<screen><computeroutput>usage: cinder show &lt;volume&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder show &lt;volume&gt;</computeroutput></screen>
<para>
Show details about a volume.
</para> <variablelist wordsize="10">
@ -1889,8 +1851,7 @@ Show details about a volume.
<screen><computeroutput>usage: cinder snapshot-create [--force &lt;True|False&gt;]
[--display-name &lt;display-name&gt;]
[--display-description &lt;display-description&gt;]
&lt;volume&gt;
</computeroutput></screen>
&lt;volume&gt;</computeroutput></screen>
<para>
Add a new snapshot.
</para> <variablelist wordsize="10">
@ -1935,8 +1896,7 @@ Add a new snapshot.
</section>
<section xml:id="cinderclient_subcommand_snapshot-delete">
<title>cinder snapshot-delete command</title>
<screen><computeroutput>usage: cinder snapshot-delete &lt;snapshot&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder snapshot-delete &lt;snapshot&gt;</computeroutput></screen>
<para>
Remove a snapshot.
</para> <variablelist wordsize="10">
@ -1955,8 +1915,7 @@ Remove a snapshot.
<title>cinder snapshot-list command</title>
<screen><computeroutput>usage: cinder snapshot-list [--all-tenants [&lt;0|1&gt;]]
[--display-name &lt;display-name&gt;]
[--status &lt;status&gt;] [--volume-id &lt;volume-id&gt;]
</computeroutput></screen>
[--status &lt;status&gt;] [--volume-id &lt;volume-id&gt;]</computeroutput></screen>
<para>
List all the snapshots.
</para> <variablelist wordsize="10">
@ -1998,8 +1957,7 @@ List all the snapshots.
<section xml:id="cinderclient_subcommand_snapshot-metadata">
<title>cinder snapshot-metadata command</title>
<screen><computeroutput>usage: cinder snapshot-metadata &lt;snapshot&gt; &lt;action&gt; &lt;key=value&gt;
[&lt;key=value&gt; ...]
</computeroutput></screen>
[&lt;key=value&gt; ...]</computeroutput></screen>
<para>
Set or Delete metadata of a snapshot.
</para> <variablelist wordsize="10">
@ -2032,8 +1990,7 @@ Set or Delete metadata of a snapshot.
</section>
<section xml:id="cinderclient_subcommand_snapshot-metadata-show">
<title>cinder snapshot-metadata-show command</title>
<screen><computeroutput>usage: cinder snapshot-metadata-show &lt;snapshot&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder snapshot-metadata-show &lt;snapshot&gt;</computeroutput></screen>
<para>
Show metadata of given snapshot.
</para> <variablelist wordsize="10">
@ -2051,8 +2008,7 @@ Show metadata of given snapshot.
<section xml:id="cinderclient_subcommand_snapshot-metadata-update-all">
<title>cinder snapshot-metadata-update-all command</title>
<screen><computeroutput>usage: cinder snapshot-metadata-update-all &lt;snapshot&gt; &lt;key=value&gt;
[&lt;key=value&gt; ...]
</computeroutput></screen>
[&lt;key=value&gt; ...]</computeroutput></screen>
<para>
Update all metadata of a snapshot.
</para> <variablelist wordsize="10">
@ -2078,8 +2034,7 @@ Update all metadata of a snapshot.
<section xml:id="cinderclient_subcommand_snapshot-rename">
<title>cinder snapshot-rename command</title>
<screen><computeroutput>usage: cinder snapshot-rename [--display-description &lt;display-description&gt;]
&lt;snapshot&gt; [&lt;display-name&gt;]
</computeroutput></screen>
&lt;snapshot&gt; [&lt;display-name&gt;]</computeroutput></screen>
<para>
Rename a snapshot.
</para> <variablelist wordsize="10">
@ -2116,8 +2071,7 @@ Rename a snapshot.
<section xml:id="cinderclient_subcommand_snapshot-reset-state">
<title>cinder snapshot-reset-state command</title>
<screen><computeroutput>usage: cinder snapshot-reset-state [--state &lt;state&gt;]
&lt;snapshot&gt; [&lt;snapshot&gt; ...]
</computeroutput></screen>
&lt;snapshot&gt; [&lt;snapshot&gt; ...]</computeroutput></screen>
<para>
Explicitly update the state of a snapshot.
</para> <variablelist wordsize="10">
@ -2148,8 +2102,7 @@ Explicitly update the state of a snapshot.
</section>
<section xml:id="cinderclient_subcommand_snapshot-show">
<title>cinder snapshot-show command</title>
<screen><computeroutput>usage: cinder snapshot-show &lt;snapshot&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder snapshot-show &lt;snapshot&gt;</computeroutput></screen>
<para>
Show details about a snapshot.
</para> <variablelist wordsize="10">
@ -2166,8 +2119,7 @@ Show details about a snapshot.
</section>
<section xml:id="cinderclient_subcommand_transfer-accept">
<title>cinder transfer-accept command</title>
<screen><computeroutput>usage: cinder transfer-accept &lt;transfer&gt; &lt;auth_key&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder transfer-accept &lt;transfer&gt; &lt;auth_key&gt;</computeroutput></screen>
<para>
Accepts a volume transfer.
</para> <variablelist wordsize="10">
@ -2192,8 +2144,7 @@ Accepts a volume transfer.
</section>
<section xml:id="cinderclient_subcommand_transfer-create">
<title>cinder transfer-create command</title>
<screen><computeroutput>usage: cinder transfer-create [--display-name &lt;display-name&gt;] &lt;volume&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder transfer-create [--display-name &lt;display-name&gt;] &lt;volume&gt;</computeroutput></screen>
<para>
Creates a volume transfer.
</para> <variablelist wordsize="10">
@ -2221,8 +2172,7 @@ Creates a volume transfer.
</section>
<section xml:id="cinderclient_subcommand_transfer-delete">
<title>cinder transfer-delete command</title>
<screen><computeroutput>usage: cinder transfer-delete &lt;transfer&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder transfer-delete &lt;transfer&gt;</computeroutput></screen>
<para>
Undo a transfer.
</para> <variablelist wordsize="10">
@ -2239,15 +2189,14 @@ Undo a transfer.
</section>
<section xml:id="cinderclient_subcommand_transfer-list">
<title>cinder transfer-list command</title>
<screen><computeroutput>usage: cinder transfer-list
</computeroutput></screen>
<screen><computeroutput>usage: cinder transfer-list</computeroutput></screen>
<para>
List all the transfers.
</para> </section>
</para>
</section>
<section xml:id="cinderclient_subcommand_transfer-show">
<title>cinder transfer-show command</title>
<screen><computeroutput>usage: cinder transfer-show &lt;transfer&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder transfer-show &lt;transfer&gt;</computeroutput></screen>
<para>
Show details about a transfer.
</para> <variablelist wordsize="10">
@ -2264,8 +2213,7 @@ Show details about a transfer.
</section>
<section xml:id="cinderclient_subcommand_type-create">
<title>cinder type-create command</title>
<screen><computeroutput>usage: cinder type-create &lt;name&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder type-create &lt;name&gt;</computeroutput></screen>
<para>
Create a new volume type.
</para> <variablelist wordsize="10">
@ -2282,8 +2230,7 @@ Create a new volume type.
</section>
<section xml:id="cinderclient_subcommand_type-delete">
<title>cinder type-delete command</title>
<screen><computeroutput>usage: cinder type-delete &lt;id&gt;
</computeroutput></screen>
<screen><computeroutput>usage: cinder type-delete &lt;id&gt;</computeroutput></screen>
<para>
Delete a specific volume type.
</para> <variablelist wordsize="10">
@ -2300,8 +2247,7 @@ Delete a specific volume type.
</section>
<section xml:id="cinderclient_subcommand_type-key">
<title>cinder type-key command</title>
<screen><computeroutput>usage: cinder type-key &lt;vtype&gt; &lt;action&gt; [&lt;key=value&gt; [&lt;key=value&gt; ...]]
</computeroutput></screen>
<screen><computeroutput>usage: cinder type-key &lt;vtype&gt; &lt;action&gt; [&lt;key=value&gt; [&lt;key=value&gt; ...]]</computeroutput></screen>
<para>
Set or unset extra_spec for a volume type.
</para> <variablelist wordsize="10">
@ -2334,18 +2280,17 @@ Set or unset extra_spec for a volume type.
</section>
<section xml:id="cinderclient_subcommand_type-list">
<title>cinder type-list command</title>
<screen><computeroutput>usage: cinder type-list
</computeroutput></screen>
<screen><computeroutput>usage: cinder type-list</computeroutput></screen>
<para>
Print a list of available 'volume types'.
</para> </section>
</para>
</section>
<section xml:id="cinderclient_subcommand_upload-to-image">
<title>cinder upload-to-image command</title>
<screen><computeroutput>usage: cinder upload-to-image [--force &lt;True|False&gt;]
[--container-format &lt;container-format&gt;]
[--disk-format &lt;disk-format&gt;]
&lt;volume&gt; &lt;image-name&gt;
</computeroutput></screen>
&lt;volume&gt; &lt;image-name&gt;</computeroutput></screen>
<para>
Upload volume to image service as image.
</para> <variablelist wordsize="10">

27
doc/common/ch_cli_glance_commands.xml
View File

@ -34,8 +34,7 @@
[--os-image-api-version OS_IMAGE_API_VERSION]
[--os-service-type OS_SERVICE_TYPE]
[--os-endpoint-type OS_ENDPOINT_TYPE] [-S OS_AUTH_STRATEGY]
&lt;subcommand&gt; ...
</computeroutput></screen>
&lt;subcommand&gt; ...</computeroutput></screen>
<variablelist wordsize="10">
<title>Subcommands</title>
<varlistentry>
@ -521,8 +520,7 @@
[--is-public {True,False}]
[--is-protected {True,False}]
[--property &lt;key=value&gt;] [--human-readable]
[--progress]
</computeroutput></screen>
[--progress]</computeroutput></screen>
<para>
Create a new image.
</para> <variablelist wordsize="10">
@ -689,8 +687,7 @@ Create a new image.
</section>
<section xml:id="glanceclient_subcommand_image-delete">
<title>glance image-delete command</title>
<screen><computeroutput>usage: glance image-delete &lt;IMAGE&gt; [&lt;IMAGE&gt; ...]
</computeroutput></screen>
<screen><computeroutput>usage: glance image-delete &lt;IMAGE&gt; [&lt;IMAGE&gt; ...]</computeroutput></screen>
<para>
Delete specified image(s).
</para> <variablelist wordsize="10">
@ -714,8 +711,7 @@ Delete specified image(s).
[--page-size &lt;SIZE&gt;] [--human-readable]
[--sort-key {name,status,container_format,disk_format,size,id,created_at,updated_at}]
[--sort-dir {asc,desc}] [--is-public {True,False}]
[--owner &lt;TENANT_ID&gt;] [--all-tenants]
</computeroutput></screen>
[--owner &lt;TENANT_ID&gt;] [--all-tenants]</computeroutput></screen>
<para>
List images you can access.
</para> <variablelist wordsize="10">
@ -848,8 +844,7 @@ List images you can access.
</section>
<section xml:id="glanceclient_subcommand_image-show">
<title>glance image-show command</title>
<screen><computeroutput>usage: glance image-show [--human-readable] &lt;IMAGE&gt;
</computeroutput></screen>
<screen><computeroutput>usage: glance image-show [--human-readable] &lt;IMAGE&gt;</computeroutput></screen>
<para>
Describe a specific image.
</para> <variablelist wordsize="10">
@ -887,8 +882,7 @@ Describe a specific image.
[--is-protected {True,False}]
[--property &lt;key=value&gt;] [--purge-props]
[--human-readable] [--progress]
&lt;IMAGE&gt;
</computeroutput></screen>
&lt;IMAGE&gt;</computeroutput></screen>
<para>
Update a specific image.
</para> <variablelist wordsize="10">
@ -1059,8 +1053,7 @@ Update a specific image.
</section>
<section xml:id="glanceclient_subcommand_member-create">
<title>glance member-create command</title>
<screen><computeroutput>usage: glance member-create [--can-share] &lt;IMAGE&gt; &lt;TENANT_ID&gt;
</computeroutput></screen>
<screen><computeroutput>usage: glance member-create [--can-share] &lt;IMAGE&gt; &lt;TENANT_ID&gt;</computeroutput></screen>
<para>
Share a specific image with a tenant.
</para> <variablelist wordsize="10">
@ -1096,8 +1089,7 @@ Share a specific image with a tenant.
</section>
<section xml:id="glanceclient_subcommand_member-delete">
<title>glance member-delete command</title>
<screen><computeroutput>usage: glance member-delete &lt;IMAGE&gt; &lt;TENANT_ID&gt;
</computeroutput></screen>
<screen><computeroutput>usage: glance member-delete &lt;IMAGE&gt; &lt;TENANT_ID&gt;</computeroutput></screen>
<para>
Remove a shared image from a tenant.
</para> <variablelist wordsize="10">
@ -1122,8 +1114,7 @@ Remove a shared image from a tenant.
</section>
<section xml:id="glanceclient_subcommand_member-list">
<title>glance member-list command</title>
<screen><computeroutput>usage: glance member-list [--image-id &lt;IMAGE_ID&gt;] [--tenant-id &lt;TENANT_ID&gt;]
</computeroutput></screen>
<screen><computeroutput>usage: glance member-list [--image-id &lt;IMAGE_ID&gt;] [--tenant-id &lt;TENANT_ID&gt;]</computeroutput></screen>
<para>
Describe sharing permissions by image or tenant.
</para> <variablelist wordsize="10">

81
doc/common/ch_cli_heat_commands.xml
View File

@ -30,8 +30,7 @@
[--heat-api-version HEAT_API_VERSION]
[--os-service-type OS_SERVICE_TYPE]
[--os-endpoint-type OS_ENDPOINT_TYPE] [--include-password]
&lt;subcommand&gt; ...
</computeroutput></screen>
&lt;subcommand&gt; ...</computeroutput></screen>
<variablelist wordsize="10">
<title>Subcommands</title>
<varlistentry>
@ -503,8 +502,7 @@
</section>
<section xml:id="heatclient_subcommand_action-resume">
<title>heat action-resume command</title>
<screen><computeroutput>usage: heat action-resume &lt;NAME or ID&gt;
</computeroutput></screen>
<screen><computeroutput>usage: heat action-resume &lt;NAME or ID&gt;</computeroutput></screen>
<para>
Resume the stack.
</para> <variablelist wordsize="10">
@ -521,8 +519,7 @@ Resume the stack.
</section>
<section xml:id="heatclient_subcommand_action-suspend">
<title>heat action-suspend command</title>
<screen><computeroutput>usage: heat action-suspend &lt;NAME or ID&gt;
</computeroutput></screen>
<screen><computeroutput>usage: heat action-suspend &lt;NAME or ID&gt;</computeroutput></screen>
<para>
Suspend the stack.
</para> <variablelist wordsize="10">
@ -539,15 +536,14 @@ Suspend the stack.
</section>
<section xml:id="heatclient_subcommand_build-info">
<title>heat build-info command</title>
<screen><computeroutput>usage: heat build-info
</computeroutput></screen>
<screen><computeroutput>usage: heat build-info</computeroutput></screen>
<para>
Retrieve build information.
</para> </section>
</para>
</section>
<section xml:id="heatclient_subcommand_event-list">
<title>heat event-list command</title>
<screen><computeroutput>usage: heat event-list [-r &lt;RESOURCE&gt;] &lt;NAME or ID&gt;
</computeroutput></screen>
<screen><computeroutput>usage: heat event-list [-r &lt;RESOURCE&gt;] &lt;NAME or ID&gt;</computeroutput></screen>
<para>
List events for a stack.
</para> <variablelist wordsize="10">
@ -575,8 +571,7 @@ List events for a stack.
</section>
<section xml:id="heatclient_subcommand_event-show">
<title>heat event-show command</title>
<screen><computeroutput>usage: heat event-show &lt;NAME or ID&gt; &lt;RESOURCE&gt; &lt;EVENT&gt;
</computeroutput></screen>
<screen><computeroutput>usage: heat event-show &lt;NAME or ID&gt; &lt;RESOURCE&gt; &lt;EVENT&gt;</computeroutput></screen>
<para>
Describe the event.
</para> <variablelist wordsize="10">
@ -609,8 +604,7 @@ Describe the event.
</section>
<section xml:id="heatclient_subcommand_output-list">
<title>heat output-list command</title>
<screen><computeroutput>usage: heat output-list &lt;NAME or ID&gt;
</computeroutput></screen>
<screen><computeroutput>usage: heat output-list &lt;NAME or ID&gt;</computeroutput></screen>
<para>
Show available outputs.
</para> <variablelist wordsize="10">
@ -627,8 +621,7 @@ Show available outputs.
</section>
<section xml:id="heatclient_subcommand_output-show">
<title>heat output-show command</title>
<screen><computeroutput>usage: heat output-show &lt;NAME or ID&gt; &lt;OUTPUT NAME&gt;
</computeroutput></screen>
<screen><computeroutput>usage: heat output-show &lt;NAME or ID&gt; &lt;OUTPUT NAME&gt;</computeroutput></screen>
<para>
Show a specific stack output.
</para> <variablelist wordsize="10">
@ -653,8 +646,7 @@ Show a specific stack output.
</section>
<section xml:id="heatclient_subcommand_resource-list">
<title>heat resource-list command</title>
<screen><computeroutput>usage: heat resource-list &lt;NAME or ID&gt;
</computeroutput></screen>
<screen><computeroutput>usage: heat resource-list &lt;NAME or ID&gt;</computeroutput></screen>
<para>
Show list of resources belonging to a stack.
</para> <variablelist wordsize="10">
@ -671,8 +663,7 @@ Show list of resources belonging to a stack.
</section>
<section xml:id="heatclient_subcommand_resource-metadata">
<title>heat resource-metadata command</title>
<screen><computeroutput>usage: heat resource-metadata &lt;NAME or ID&gt; &lt;RESOURCE&gt;
</computeroutput></screen>
<screen><computeroutput>usage: heat resource-metadata &lt;NAME or ID&gt; &lt;RESOURCE&gt;</computeroutput></screen>
<para>
List resource metadata.
</para> <variablelist wordsize="10">
@ -697,8 +688,7 @@ List resource metadata.
</section>
<section xml:id="heatclient_subcommand_resource-show">
<title>heat resource-show command</title>
<screen><computeroutput>usage: heat resource-show &lt;NAME or ID&gt; &lt;RESOURCE&gt;
</computeroutput></screen>
<screen><computeroutput>usage: heat resource-show &lt;NAME or ID&gt; &lt;RESOURCE&gt;</computeroutput></screen>
<para>
Describe the resource.
</para> <variablelist wordsize="10">
@ -723,8 +713,7 @@ Describe the resource.
</section>
<section xml:id="heatclient_subcommand_resource-signal">
<title>heat resource-signal command</title>
<screen><computeroutput>usage: heat resource-signal [-D &lt;DATA&gt;] [-f &lt;FILE&gt;] &lt;NAME or ID&gt; &lt;RESOURCE&gt;
</computeroutput></screen>
<screen><computeroutput>usage: heat resource-signal [-D &lt;DATA&gt;] [-f &lt;FILE&gt;] &lt;NAME or ID&gt; &lt;RESOURCE&gt;</computeroutput></screen>
<para>
Send a signal to a resource.
</para> <variablelist wordsize="10">
@ -769,8 +758,7 @@ Send a signal to a resource.
</section>
<section xml:id="heatclient_subcommand_resource-template">
<title>heat resource-template command</title>
<screen><computeroutput>usage: heat resource-template [-F &lt;FORMAT&gt;] &lt;RESOURCE&gt;
</computeroutput></screen>
<screen><computeroutput>usage: heat resource-template [-F &lt;FORMAT&gt;] &lt;RESOURCE&gt;</computeroutput></screen>
<para>
Generate a template based on a resource.
</para> <variablelist wordsize="10">
@ -798,15 +786,14 @@ Generate a template based on a resource.
</section>
<section xml:id="heatclient_subcommand_resource-type-list">
<title>heat resource-type-list command</title>
<screen><computeroutput>usage: heat resource-type-list
</computeroutput></screen>
<screen><computeroutput>usage: heat resource-type-list</computeroutput></screen>
<para>
List the available resource types.
</para> </section>
</para>
</section>
<section xml:id="heatclient_subcommand_resource-type-show">
<title>heat resource-type-show command</title>
<screen><computeroutput>usage: heat resource-type-show &lt;RESOURCE_TYPE&gt;
</computeroutput></screen>
<screen><computeroutput>usage: heat resource-type-show &lt;RESOURCE_TYPE&gt;</computeroutput></screen>
<para>
Show the resource type.
</para> <variablelist wordsize="10">
@ -823,8 +810,7 @@ Show the resource type.
</section>
<section xml:id="heatclient_subcommand_stack-abandon">
<title>heat stack-abandon command</title>
<screen><computeroutput>usage: heat stack-abandon &lt;NAME or ID&gt;
</computeroutput></screen>
<screen><computeroutput>usage: heat stack-abandon &lt;NAME or ID&gt;</computeroutput></screen>
<para>
Abandon the stack.
</para> <variablelist wordsize="10">
@ -844,8 +830,7 @@ Abandon the stack.
<screen><computeroutput>usage: heat stack-adopt [-f &lt;FILE&gt;] [-e &lt;FILE or URL&gt;] [-u &lt;URL&gt;] [-o &lt;URL&gt;]
[-c &lt;TIMEOUT&gt;] [-t &lt;TIMEOUT&gt;] [-a &lt;FILE or URL&gt;] [-r]
[-P &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;]
&lt;STACK_NAME&gt;
</computeroutput></screen>
&lt;STACK_NAME&gt;</computeroutput></screen>
<para>
Adopt a stack.
</para> <variablelist wordsize="10">
@ -943,8 +928,7 @@ Adopt a stack.
<screen><computeroutput>usage: heat stack-create [-f &lt;FILE&gt;] [-e &lt;FILE or URL&gt;] [-u &lt;URL&gt;] [-o &lt;URL&gt;]
[-c &lt;TIMEOUT&gt;] [-t &lt;TIMEOUT&gt;] [-r]
[-P &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;]
&lt;STACK_NAME&gt;
</computeroutput></screen>
&lt;STACK_NAME&gt;</computeroutput></screen>
<para>
Create the stack.
</para> <variablelist wordsize="10">
@ -1031,8 +1015,7 @@ Create the stack.
</section>
<section xml:id="heatclient_subcommand_stack-delete">
<title>heat stack-delete command</title>
<screen><computeroutput>usage: heat stack-delete &lt;NAME or ID&gt; [&lt;NAME or ID&gt; ...]
</computeroutput></screen>
<screen><computeroutput>usage: heat stack-delete &lt;NAME or ID&gt; [&lt;NAME or ID&gt; ...]</computeroutput></screen>
<para>
Delete the stack(s).
</para> <variablelist wordsize="10">
@ -1050,8 +1033,7 @@ Delete the stack(s).
<section xml:id="heatclient_subcommand_stack-list">
<title>heat stack-list command</title>
<screen><computeroutput>usage: heat stack-list [-f &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;] [-l &lt;LIMIT&gt;]
[-m &lt;ID&gt;]
</computeroutput></screen>
[-m &lt;ID&gt;]</computeroutput></screen>
<para>
List the user's stacks.
</para> <variablelist wordsize="10">
@ -1090,8 +1072,7 @@ List the user's stacks.
<screen><computeroutput>usage: heat stack-preview [-f &lt;FILE&gt;] [-e &lt;FILE or URL&gt;] [-u &lt;URL&gt;] [-o &lt;URL&gt;]
[-c &lt;TIMEOUT&gt;] [-r]
[-P &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;]
&lt;STACK_NAME&gt;
</computeroutput></screen>
&lt;STACK_NAME&gt;</computeroutput></screen>
<para>
Preview the stack.
</para> <variablelist wordsize="10">
@ -1169,8 +1150,7 @@ Preview the stack.
</section>
<section xml:id="heatclient_subcommand_stack-show">
<title>heat stack-show command</title>
<screen><computeroutput>usage: heat stack-show &lt;NAME or ID&gt;
</computeroutput></screen>
<screen><computeroutput>usage: heat stack-show &lt;NAME or ID&gt;</computeroutput></screen>
<para>
Describe the stack.
</para> <variablelist wordsize="10">
@ -1189,8 +1169,7 @@ Describe the stack.
<title>heat stack-update command</title>
<screen><computeroutput>usage: heat stack-update [-f &lt;FILE&gt;] [-e &lt;FILE or URL&gt;] [-u &lt;URL&gt;] [-o &lt;URL&gt;]
[-t &lt;TIMEOUT&gt;] [-P &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;]
&lt;NAME or ID&gt;
</computeroutput></screen>
&lt;NAME or ID&gt;</computeroutput></screen>
<para>
Update the stack.
</para> <variablelist wordsize="10">
@ -1260,8 +1239,7 @@ Update the stack.
</section>
<section xml:id="heatclient_subcommand_template-show">
<title>heat template-show command</title>
<screen><computeroutput>usage: heat template-show &lt;NAME or ID&gt;
</computeroutput></screen>
<screen><computeroutput>usage: heat template-show &lt;NAME or ID&gt;</computeroutput></screen>
<para>
Get the template for the specified stack.
</para> <variablelist wordsize="10">
@ -1279,8 +1257,7 @@ Get the template for the specified stack.
<section xml:id="heatclient_subcommand_template-validate">
<title>heat template-validate command</title>
<screen><computeroutput>usage: heat template-validate [-u &lt;URL&gt;] [-f &lt;FILE&gt;] [-e &lt;FILE or URL&gt;]
[-o &lt;URL&gt;] [-P &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;]
</computeroutput></screen>
[-o &lt;URL&gt;] [-P &lt;KEY1=VALUE1;KEY2=VALUE2...&gt;]</computeroutput></screen>
<para>
Validate a template with parameters.
</para> <variablelist wordsize="10">

123
doc/common/ch_cli_keystone_commands.xml
View File

@ -32,8 +32,7 @@
[--os-cacert &lt;ca-certificate&gt;] [--insecure]
[--os-cert &lt;certificate&gt;] [--os-key &lt;key&gt;] [--os-cache]
[--force-new-token] [--stale-duration &lt;seconds&gt;]
&lt;subcommand&gt; ...
</computeroutput></screen>
&lt;subcommand&gt; ...</computeroutput></screen>
<variablelist wordsize="10">
<title>Subcommands</title>
<varlistentry>
@ -513,8 +512,7 @@
<title>keystone bootstrap command</title>
<screen><computeroutput>usage: keystone bootstrap [--user-name &lt;user-name&gt;] --pass &lt;password&gt;
[--role-name &lt;role-name&gt;]
[--tenant-name &lt;tenant-name&gt;]
</computeroutput></screen>
[--tenant-name &lt;tenant-name&gt;]</computeroutput></screen>
<para>
Grants a new role to a new user on a new tenant, after creating each.
</para> <variablelist wordsize="10">
@ -557,8 +555,7 @@ Grants a new role to a new user on a new tenant, after creating each.
</section>
<section xml:id="keystoneclient_subcommand_catalog">
<title>keystone catalog command</title>
<screen><computeroutput>usage: keystone catalog [--service &lt;service-type&gt;]
</computeroutput></screen>
<screen><computeroutput>usage: keystone catalog [--service &lt;service-type&gt;]</computeroutput></screen>
<para>
List service catalog, possibly filtered by service.
</para> <variablelist wordsize="10">
@ -575,16 +572,15 @@ List service catalog, possibly filtered by service.
</section>
<section xml:id="keystoneclient_subcommand_discover">
<title>keystone discover command</title>
<screen><computeroutput>usage: keystone discover
</computeroutput></screen>
<screen><computeroutput>usage: keystone discover</computeroutput></screen>
<para>
Discover Keystone servers, supported API versions and extensions.
</para> </section>
</para>
</section>
<section xml:id="keystoneclient_subcommand_ec2-credentials-create">
<title>keystone ec2-credentials-create command</title>
<screen><computeroutput>usage: keystone ec2-credentials-create [--user-id &lt;user-id&gt;]
[--tenant-id &lt;tenant-id&gt;]
</computeroutput></screen>
[--tenant-id &lt;tenant-id&gt;]</computeroutput></screen>
<para>
Create EC2-compatible credentials for user per tenant.
</para> <variablelist wordsize="10">
@ -612,8 +608,7 @@ Create EC2-compatible credentials for user per tenant.
<section xml:id="keystoneclient_subcommand_ec2-credentials-delete">
<title>keystone ec2-credentials-delete command</title>
<screen><computeroutput>usage: keystone ec2-credentials-delete [--user-id &lt;user-id&gt;] --access
&lt;access-key&gt;
</computeroutput></screen>
&lt;access-key&gt;</computeroutput></screen>
<para>
Delete EC2-compatible credentials.
</para> <variablelist wordsize="10">
@ -639,8 +634,7 @@ Delete EC2-compatible credentials.
<section xml:id="keystoneclient_subcommand_ec2-credentials-get">
<title>keystone ec2-credentials-get command</title>
<screen><computeroutput>usage: keystone ec2-credentials-get [--user-id &lt;user-id&gt;] --access
&lt;access-key&gt;
</computeroutput></screen>
&lt;access-key&gt;</computeroutput></screen>
<para>
Display EC2-compatible credentials.
</para> <variablelist wordsize="10">
@ -665,8 +659,7 @@ Display EC2-compatible credentials.
</section>
<section xml:id="keystoneclient_subcommand_ec2-credentials-list">
<title>keystone ec2-credentials-list command</title>
<screen><computeroutput>usage: keystone ec2-credentials-list [--user-id &lt;user-id&gt;]
</computeroutput></screen>
<screen><computeroutput>usage: keystone ec2-credentials-list [--user-id &lt;user-id&gt;]</computeroutput></screen>
<para>
List EC2-compatible credentials for a user.
</para> <variablelist wordsize="10">
@ -686,8 +679,7 @@ List EC2-compatible credentials for a user.
<screen><computeroutput>usage: keystone endpoint-create [--region &lt;endpoint-region&gt;] --service
&lt;service&gt; --publicurl &lt;public-url&gt;
[--adminurl &lt;admin-url&gt;]
[--internalurl &lt;internal-url&gt;]
</computeroutput></screen>
[--internalurl &lt;internal-url&gt;]</computeroutput></screen>
<para>
Create a new endpoint associated with a service.
</para> <variablelist wordsize="10">
@ -736,8 +728,7 @@ Create a new endpoint associated with a service.
</section>
<section xml:id="keystoneclient_subcommand_endpoint-delete">
<title>keystone endpoint-delete command</title>
<screen><computeroutput>usage: keystone endpoint-delete &lt;endpoint-id&gt;
</computeroutput></screen>
<screen><computeroutput>usage: keystone endpoint-delete &lt;endpoint-id&gt;</computeroutput></screen>
<para>
Delete a service endpoint.
</para> <variablelist wordsize="10">
@ -756,8 +747,7 @@ Delete a service endpoint.
<title>keystone endpoint-get command</title>
<screen><computeroutput>usage: keystone endpoint-get --service &lt;service-type&gt;
[--endpoint-type &lt;endpoint-type&gt;]
[--attr &lt;service-attribute&gt;] [--value &lt;value&gt;]
</computeroutput></screen>
[--attr &lt;service-attribute&gt;] [--value &lt;value&gt;]</computeroutput></screen>
<para>
Find endpoint filtered by a specific attribute or service type.
</para> <variablelist wordsize="10">
@ -798,16 +788,15 @@ Find endpoint filtered by a specific attribute or service type.
</section>
<section xml:id="keystoneclient_subcommand_endpoint-list">
<title>keystone endpoint-list command</title>
<screen><computeroutput>usage: keystone endpoint-list
</computeroutput></screen>
<screen><computeroutput>usage: keystone endpoint-list</computeroutput></screen>
<para>
List configured service endpoints.
</para> </section>
</para>
</section>
<section xml:id="keystoneclient_subcommand_password-update">
<title>keystone password-update command</title>
<screen><computeroutput>usage: keystone password-update [--current-password &lt;current-password&gt;]
[--new-password &lt;new-password&gt;]
</computeroutput></screen>
[--new-password &lt;new-password&gt;]</computeroutput></screen>
<para>
Update own password.
</para> <variablelist wordsize="10">
@ -833,8 +822,7 @@ Update own password.
</section>
<section xml:id="keystoneclient_subcommand_role-create">
<title>keystone role-create command</title>
<screen><computeroutput>usage: keystone role-create --name &lt;role-name&gt;
</computeroutput></screen>
<screen><computeroutput>usage: keystone role-create --name &lt;role-name&gt;</computeroutput></screen>
<para>
Create new role.
</para> <variablelist wordsize="10">
@ -851,8 +839,7 @@ Create new role.
</section>
<section xml:id="keystoneclient_subcommand_role-delete">
<title>keystone role-delete command</title>
<screen><computeroutput>usage: keystone role-delete &lt;role&gt;
</computeroutput></screen>
<screen><computeroutput>usage: keystone role-delete &lt;role&gt;</computeroutput></screen>
<para>
Delete role.
</para> <variablelist wordsize="10">
@ -869,8 +856,7 @@ Delete role.
</section>
<section xml:id="keystoneclient_subcommand_role-get">
<title>keystone role-get command</title>
<screen><computeroutput>usage: keystone role-get &lt;role&gt;
</computeroutput></screen>
<screen><computeroutput>usage: keystone role-get &lt;role&gt;</computeroutput></screen>
<para>
Display role details.
</para> <variablelist wordsize="10">
@ -887,16 +873,15 @@ Display role details.
</section>
<section xml:id="keystoneclient_subcommand_role-list">
<title>keystone role-list command</title>
<screen><computeroutput>usage: keystone role-list
</computeroutput></screen>
<screen><computeroutput>usage: keystone role-list</computeroutput></screen>
<para>
List all roles.
</para> </section>
</para>
</section>
<section xml:id="keystoneclient_subcommand_service-create">
<title>keystone service-create command</title>
<screen><computeroutput>usage: keystone service-create --name &lt;name&gt; --type &lt;type&gt;
[--description &lt;service-description&gt;]
</computeroutput></screen>
[--description &lt;service-description&gt;]</computeroutput></screen>
<para>
Add service to Service Catalog.
</para> <variablelist wordsize="10">
@ -931,8 +916,7 @@ Add service to Service Catalog.
</section>
<section xml:id="keystoneclient_subcommand_service-delete">
<title>keystone service-delete command</title>
<screen><computeroutput>usage: keystone service-delete &lt;service&gt;
</computeroutput></screen>
<screen><computeroutput>usage: keystone service-delete &lt;service&gt;</computeroutput></screen>
<para>
Delete service from Service Catalog.
</para> <variablelist wordsize="10">
@ -949,8 +933,7 @@ Delete service from Service Catalog.
</section>
<section xml:id="keystoneclient_subcommand_service-get">
<title>keystone service-get command</title>
<screen><computeroutput>usage: keystone service-get &lt;service&gt;
</computeroutput></screen>
<screen><computeroutput>usage: keystone service-get &lt;service&gt;</computeroutput></screen>
<para>
Display service from Service Catalog.
</para> <variablelist wordsize="10">
@ -967,17 +950,16 @@ Display service from Service Catalog.
</section>
<section xml:id="keystoneclient_subcommand_service-list">
<title>keystone service-list command</title>
<screen><computeroutput>usage: keystone service-list
</computeroutput></screen>
<screen><computeroutput>usage: keystone service-list</computeroutput></screen>
<para>
List all services in Service Catalog.
</para> </section>
</para>
</section>
<section xml:id="keystoneclient_subcommand_tenant-create">
<title>keystone tenant-create command</title>
<screen><computeroutput>usage: keystone tenant-create --name &lt;tenant-name&gt;
[--description &lt;tenant-description&gt;]
[--enabled &lt;true|false&gt;]
</computeroutput></screen>
[--enabled &lt;true|false&gt;]</computeroutput></screen>
<para>
Create new tenant.
</para> <variablelist wordsize="10">
@ -1010,8 +992,7 @@ Create new tenant.
</section>
<section xml:id="keystoneclient_subcommand_tenant-delete">
<title>keystone tenant-delete command</title>
<screen><computeroutput>usage: keystone tenant-delete &lt;tenant&gt;
</computeroutput></screen>
<screen><computeroutput>usage: keystone tenant-delete &lt;tenant&gt;</computeroutput></screen>
<para>
Delete tenant.
</para> <variablelist wordsize="10">
@ -1028,8 +1009,7 @@ Delete tenant.
</section>
<section xml:id="keystoneclient_subcommand_tenant-get">
<title>keystone tenant-get command</title>
<screen><computeroutput>usage: keystone tenant-get &lt;tenant&gt;
</computeroutput></screen>
<screen><computeroutput>usage: keystone tenant-get &lt;tenant&gt;</computeroutput></screen>
<para>
Display tenant details.
</para> <variablelist wordsize="10">
@ -1046,18 +1026,17 @@ Display tenant details.
</section>
<section xml:id="keystoneclient_subcommand_tenant-list">
<title>keystone tenant-list command</title>
<screen><computeroutput>usage: keystone tenant-list
</computeroutput></screen>
<screen><computeroutput>usage: keystone tenant-list</computeroutput></screen>
<para>
List all tenants.
</para> </section>
</para>
</section>
<section xml:id="keystoneclient_subcommand_tenant-update">
<title>keystone tenant-update command</title>
<screen><computeroutput>usage: keystone tenant-update [--name &lt;tenant_name&gt;]
[--description &lt;tenant-description&gt;]
[--enabled &lt;true|false&gt;]
&lt;tenant&gt;
</computeroutput></screen>
&lt;tenant&gt;</computeroutput></screen>
<para>
Update tenant name, description, enabled status.
</para> <variablelist wordsize="10">
@ -1098,8 +1077,7 @@ Update tenant name, description, enabled status.
</section>
<section xml:id="keystoneclient_subcommand_token-get">
<title>keystone token-get command</title>
<screen><computeroutput>usage: keystone token-get [--wrap &lt;integer&gt;]
</computeroutput></screen>
<screen><computeroutput>usage: keystone token-get [--wrap &lt;integer&gt;]</computeroutput></screen>
<para>
Display the current user token.
</para> <variablelist wordsize="10">
@ -1118,8 +1096,7 @@ Display the current user token.
<title>keystone user-create command</title>
<screen><computeroutput>usage: keystone user-create --name &lt;user-name&gt; [--tenant &lt;tenant&gt;]
[--pass [&lt;pass&gt;]] [--email &lt;email&gt;]
[--enabled &lt;true|false&gt;]
</computeroutput></screen>
[--enabled &lt;true|false&gt;]</computeroutput></screen>
<para>
Create new user
</para> <variablelist wordsize="10">
@ -1168,8 +1145,7 @@ Create new user
</section>
<section xml:id="keystoneclient_subcommand_user-delete">
<title>keystone user-delete command</title>
<screen><computeroutput>usage: keystone user-delete &lt;user&gt;
</computeroutput></screen>
<screen><computeroutput>usage: keystone user-delete &lt;user&gt;</computeroutput></screen>
<para>
Delete user.
</para> <variablelist wordsize="10">
@ -1186,8 +1162,7 @@ Delete user.
</section>
<section xml:id="keystoneclient_subcommand_user-get">
<title>keystone user-get command</title>
<screen><computeroutput>usage: keystone user-get &lt;user&gt;
</computeroutput></screen>
<screen><computeroutput>usage: keystone user-get &lt;user&gt;</computeroutput></screen>
<para>
Display user details.
</para> <variablelist wordsize="10">
@ -1204,8 +1179,7 @@ Display user details.
</section>
<section xml:id="keystoneclient_subcommand_user-list">
<title>keystone user-list command</title>
<screen><computeroutput>usage: keystone user-list [--tenant &lt;tenant&gt;]
</computeroutput></screen>
<screen><computeroutput>usage: keystone user-list [--tenant &lt;tenant&gt;]</computeroutput></screen>
<para>
List users.
</para> <variablelist wordsize="10">
@ -1222,8 +1196,7 @@ List users.
</section>
<section xml:id="keystoneclient_subcommand_user-password-update">
<title>keystone user-password-update command</title>
<screen><computeroutput>usage: keystone user-password-update [--pass &lt;password&gt;] &lt;user&gt;
</computeroutput></screen>
<screen><computeroutput>usage: keystone user-password-update [--pass &lt;password&gt;] &lt;user&gt;</computeroutput></screen>
<para>
Update user password.
</para> <variablelist wordsize="10">
@ -1248,8 +1221,7 @@ Update user password.
</section>
<section xml:id="keystoneclient_subcommand_user-role-add">
<title>keystone user-role-add command</title>
<screen><computeroutput>usage: keystone user-role-add --user &lt;user&gt; --role &lt;role&gt; [--tenant &lt;tenant&gt;]
</computeroutput></screen>
<screen><computeroutput>usage: keystone user-role-add --user &lt;user&gt; --role &lt;role&gt; [--tenant &lt;tenant&gt;]</computeroutput></screen>
<para>
Add role to user.
</para> <variablelist wordsize="10">
@ -1282,8 +1254,7 @@ Add role to user.
</section>
<section xml:id="keystoneclient_subcommand_user-role-list">
<title>keystone user-role-list command</title>
<screen><computeroutput>usage: keystone user-role-list [--user &lt;user&gt;] [--tenant &lt;tenant&gt;]
</computeroutput></screen>
<screen><computeroutput>usage: keystone user-role-list [--user &lt;user&gt;] [--tenant &lt;tenant&gt;]</computeroutput></screen>
<para>
List roles granted to a user.
</para> <variablelist wordsize="10">
@ -1309,8 +1280,7 @@ List roles granted to a user.
<section xml:id="keystoneclient_subcommand_user-role-remove">
<title>keystone user-role-remove command</title>
<screen><computeroutput>usage: keystone user-role-remove --user &lt;user&gt; --role &lt;role&gt;
[--tenant &lt;tenant&gt;]
</computeroutput></screen>
[--tenant &lt;tenant&gt;]</computeroutput></screen>
<para>
Remove role from user.
</para> <variablelist wordsize="10">
@ -1345,8 +1315,7 @@ Remove role from user.
<title>keystone user-update command</title>
<screen><computeroutput>usage: keystone user-update [--name &lt;user-name&gt;] [--email &lt;email&gt;]
[--enabled &lt;true|false&gt;]
&lt;user&gt;
</computeroutput></screen>
&lt;user&gt;</computeroutput></screen>
<para>
Update user's name, email, and enabled status.
</para> <variablelist wordsize="10">

462
doc/common/ch_cli_neutron_commands.xml
View File

File diff suppressed because it is too large Load Diff

585
doc/common/ch_cli_nova_commands.xml
View File

File diff suppressed because it is too large Load Diff

38
doc/common/ch_cli_swift_commands.xml
View File

@ -32,8 +32,7 @@
[--os-endpoint-type &lt;endpoint-type&gt;]
[--os-cacert &lt;ca-certificate&gt;] [--insecure]
[--no-ssl-compression]
&lt;subcommand&gt; ...
</computeroutput></screen>
&lt;subcommand&gt; ...</computeroutput></screen>
<variablelist wordsize="10">
<title>Subcommands</title>
<varlistentry>
@ -105,8 +104,7 @@
swift --os-auth-token 6ee5eb33efad4e45ab46806eac010566 \
--os-storage-url https://10.1.5.2:8080/v1/AUTH_ced809b6a4baea7aeab61a \
list
swift list --lh
</computeroutput></screen>
swift list --lh</computeroutput></screen>
</section>
<section xml:id="swiftclient_command_optional">
<title>swift optional arguments</title>
@ -330,9 +328,10 @@
</section>
<section xml:id="swiftclient_subcommand_delete">
<title>swift delete command</title>
<screen><computeroutput>Usage: Delete a container or objects within a container
</computeroutput></screen>
<screen><computeroutput>Usage: swift delete</computeroutput></screen>
<para>
Delete a container or objects within a container
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
@ -393,9 +392,10 @@
</section>
<section xml:id="swiftclient_subcommand_download">
<title>swift download command</title>
<screen><computeroutput>Usage: Download objects from containers
</computeroutput></screen>
<screen><computeroutput>Usage: swift download</computeroutput></screen>
<para>
Download objects from containers
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
@ -505,9 +505,10 @@
</section>
<section xml:id="swiftclient_subcommand_list">
<title>swift list command</title>
<screen><computeroutput>Usage: Lists the containers for the account or the objects for a container
</computeroutput></screen>
<screen><computeroutput>Usage: swift list</computeroutput></screen>
<para>
Lists the containers for the account or the objects for a container
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
@ -567,10 +568,11 @@
</section>
<section xml:id="swiftclient_subcommand_post">
<title>swift post command</title>
<screen><computeroutput>Usage: Updates meta information for the account, container, or object.
If the container is not found, it will be created automatically.
</computeroutput></screen>
<screen><computeroutput>Usage: swift post</computeroutput></screen>
<para>
Updates meta information for the account, container, or object.
If the container is not found, it will be created automatically.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
@ -650,9 +652,10 @@ If the container is not found, it will be created automatically.
</section>
<section xml:id="swiftclient_subcommand_stat">
<title>swift stat command</title>
<screen><computeroutput>Usage: Displays information for the account, container, or object
</computeroutput></screen>
<screen><computeroutput>Usage: swift stat</computeroutput></screen>
<para>
Displays information for the account, container, or object
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
@ -687,9 +690,10 @@ If the container is not found, it will be created automatically.
</section>
<section xml:id="swiftclient_subcommand_upload">
<title>swift upload command</title>
<screen><computeroutput>Usage: Uploads specified files and directories to the given container
</computeroutput></screen>
<screen><computeroutput>Usage: swift upload</computeroutput></screen>
<para>
Uploads specified files and directories to the given container
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>

165
doc/common/ch_cli_trove_commands.xml
View File

@ -30,8 +30,7 @@
[--endpoint-type &lt;endpoint-type&gt;]
[--os-database-api-version &lt;database-api-ver&gt;]
[--os-cacert &lt;ca-certificate&gt;] [--retries &lt;retries&gt;] [--json]
&lt;subcommand&gt; ...
</computeroutput></screen>
&lt;subcommand&gt; ...</computeroutput></screen>
<variablelist wordsize="10">
<title>Subcommands</title>
<varlistentry>
@ -585,8 +584,7 @@
<section xml:id="troveclient_subcommand_backup-create">
<title>trove backup-create command</title>
<screen><computeroutput>usage: trove backup-create &lt;name&gt; &lt;instance&gt;
[--description &lt;description&gt;] [--parent &lt;parent&gt;]
</computeroutput></screen>
[--description &lt;description&gt;] [--parent &lt;parent&gt;]</computeroutput></screen>
<para>
Creates a backup.
</para> <variablelist wordsize="10">
@ -631,8 +629,7 @@ Creates a backup.
</section>
<section xml:id="troveclient_subcommand_backup-delete">
<title>trove backup-delete command</title>
<screen><computeroutput>usage: trove backup-delete &lt;backup&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove backup-delete &lt;backup&gt;</computeroutput></screen>
<para>
Deletes a backup.
</para> <variablelist wordsize="10">
@ -649,8 +646,7 @@ Deletes a backup.
</section>
<section xml:id="troveclient_subcommand_backup-list">
<title>trove backup-list command</title>
<screen><computeroutput>usage: trove backup-list [--limit &lt;limit&gt;]
</computeroutput></screen>
<screen><computeroutput>usage: trove backup-list [--limit &lt;limit&gt;]</computeroutput></screen>
<para>
Lists available backups.
</para> <variablelist wordsize="10">
@ -667,8 +663,7 @@ Lists available backups.
</section>
<section xml:id="troveclient_subcommand_backup-list-instance">
<title>trove backup-list-instance command</title>
<screen><computeroutput>usage: trove backup-list-instance [--limit &lt;limit&gt;] &lt;instance&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove backup-list-instance [--limit &lt;limit&gt;] &lt;instance&gt;</computeroutput></screen>
<para>
Lists available backups for an instance.
</para> <variablelist wordsize="10">
@ -696,8 +691,7 @@ Lists available backups for an instance.
</section>
<section xml:id="troveclient_subcommand_backup-show">
<title>trove backup-show command</title>
<screen><computeroutput>usage: trove backup-show &lt;backup&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove backup-show &lt;backup&gt;</computeroutput></screen>
<para>
Shows details of a backup.
</para> <variablelist wordsize="10">
@ -714,8 +708,7 @@ Shows details of a backup.
</section>
<section xml:id="troveclient_subcommand_configuration-attach">
<title>trove configuration-attach command</title>
<screen><computeroutput>usage: trove configuration-attach &lt;configuration&gt; &lt;instance&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove configuration-attach &lt;configuration&gt; &lt;instance&gt;</computeroutput></screen>
<para>
Attaches a configuration group to an instance.
</para> <variablelist wordsize="10">
@ -743,8 +736,7 @@ Attaches a configuration group to an instance.
<screen><computeroutput>usage: trove configuration-create &lt;name&gt; &lt;values&gt;
[--datastore &lt;datastore&gt;]
[--datastore_version &lt;datastore_version&gt;]
[--description &lt;description&gt;]
</computeroutput></screen>
[--description &lt;description&gt;]</computeroutput></screen>
<para>
Creates a configuration group.
</para> <variablelist wordsize="10">
@ -797,8 +789,7 @@ Creates a configuration group.
</section>
<section xml:id="troveclient_subcommand_configuration-default">
<title>trove configuration-default command</title>
<screen><computeroutput>usage: trove configuration-default &lt;instance&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove configuration-default &lt;instance&gt;</computeroutput></screen>
<para>
Shows the default configuration of an instance.
</para> <variablelist wordsize="10">
@ -815,8 +806,7 @@ Shows the default configuration of an instance.
</section>
<section xml:id="troveclient_subcommand_configuration-delete">
<title>trove configuration-delete command</title>
<screen><computeroutput>usage: trove configuration-delete &lt;configuration_group&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove configuration-delete &lt;configuration_group&gt;</computeroutput></screen>
<para>
Deletes a configuration group.
</para> <variablelist wordsize="10">
@ -833,8 +823,7 @@ Deletes a configuration group.
</section>
<section xml:id="troveclient_subcommand_configuration-detach">
<title>trove configuration-detach command</title>
<screen><computeroutput>usage: trove configuration-detach &lt;instance&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove configuration-detach &lt;instance&gt;</computeroutput></screen>
<para>
Detaches a configuration group from an instance.
</para> <variablelist wordsize="10">
@ -851,8 +840,7 @@ Detaches a configuration group from an instance.
</section>
<section xml:id="troveclient_subcommand_configuration-instances">
<title>trove configuration-instances command</title>
<screen><computeroutput>usage: trove configuration-instances &lt;configuration_group&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove configuration-instances &lt;configuration_group&gt;</computeroutput></screen>
<para>
Lists all instances associated with a configuration group.
</para> <variablelist wordsize="10">
@ -869,16 +857,15 @@ Lists all instances associated with a configuration group.
</section>
<section xml:id="troveclient_subcommand_configuration-list">
<title>trove configuration-list command</title>
<screen><computeroutput>usage: trove configuration-list
</computeroutput></screen>
<screen><computeroutput>usage: trove configuration-list</computeroutput></screen>
<para>
Lists all configuration groups.
</para> </section>
</para>
</section>
<section xml:id="troveclient_subcommand_configuration-parameter-list">
<title>trove configuration-parameter-list command</title>
<screen><computeroutput>usage: trove configuration-parameter-list &lt;datastore_version&gt;
[--datastore &lt;datastore&gt;]
</computeroutput></screen>
[--datastore &lt;datastore&gt;]</computeroutput></screen>
<para>
Lists available parameters for a configuration group.
</para> <variablelist wordsize="10">
@ -910,8 +897,7 @@ Lists available parameters for a configuration group.
<section xml:id="troveclient_subcommand_configuration-parameter-show">
<title>trove configuration-parameter-show command</title>
<screen><computeroutput>usage: trove configuration-parameter-show &lt;datastore_version&gt; &lt;parameter&gt;
[--datastore &lt;datastore&gt;]
</computeroutput></screen>
[--datastore &lt;datastore&gt;]</computeroutput></screen>
<para>
Shows details of a configuration parameter.
</para> <variablelist wordsize="10">
@ -950,8 +936,7 @@ Shows details of a configuration parameter.
</section>
<section xml:id="troveclient_subcommand_configuration-patch">
<title>trove configuration-patch command</title>
<screen><computeroutput>usage: trove configuration-patch &lt;configuration_group&gt; &lt;values&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove configuration-patch &lt;configuration_group&gt; &lt;values&gt;</computeroutput></screen>
<para>
Patches a configuration group.
</para> <variablelist wordsize="10">
@ -976,8 +961,7 @@ Patches a configuration group.
</section>
<section xml:id="troveclient_subcommand_configuration-show">
<title>trove configuration-show command</title>
<screen><computeroutput>usage: trove configuration-show &lt;configuration_group&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove configuration-show &lt;configuration_group&gt;</computeroutput></screen>
<para>
Shows details of a configuration group.
</para> <variablelist wordsize="10">
@ -996,8 +980,7 @@ Shows details of a configuration group.
<title>trove configuration-update command</title>
<screen><computeroutput>usage: trove configuration-update &lt;configuration_group&gt; &lt;values&gt;
[--name &lt;name&gt;]
[--description &lt;description&gt;]
</computeroutput></screen>
[--description &lt;description&gt;]</computeroutput></screen>
<para>
Updates a configuration group.
</para> <variablelist wordsize="10">
@ -1049,8 +1032,7 @@ Updates a configuration group.
[--datastore &lt;datastore&gt;]
[--datastore_version &lt;datastore_version&gt;]
[--nic &lt;net-id=net-uuid,v4-fixed-ip=ip-addr,port-id=port-uuid&gt;]
[--configuration &lt;configuration&gt;]
</computeroutput></screen>
[--configuration &lt;configuration&gt;]</computeroutput></screen>
<para>
Creates a new instance.
</para> <variablelist wordsize="10">
@ -1158,8 +1140,7 @@ Creates a new instance.
<title>trove database-create command</title>
<screen><computeroutput>usage: trove database-create &lt;instance&gt; &lt;name&gt;
[--character_set &lt;character_set&gt;]
[--collate &lt;collate&gt;]
</computeroutput></screen>
[--collate &lt;collate&gt;]</computeroutput></screen>
<para>
Creates a database on an instance.
</para> <variablelist wordsize="10">
@ -1203,8 +1184,7 @@ Creates a database on an instance.
</section>
<section xml:id="troveclient_subcommand_database-delete">
<title>trove database-delete command</title>
<screen><computeroutput>usage: trove database-delete &lt;instance&gt; &lt;database&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove database-delete &lt;instance&gt; &lt;database&gt;</computeroutput></screen>
<para>
Deletes a database.
</para> <variablelist wordsize="10">
@ -1229,8 +1209,7 @@ Deletes a database.
</section>
<section xml:id="troveclient_subcommand_database-list">
<title>trove database-list command</title>
<screen><computeroutput>usage: trove database-list &lt;instance&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove database-list &lt;instance&gt;</computeroutput></screen>
<para>
Lists available databases on an instance.
</para> <variablelist wordsize="10">
@ -1247,15 +1226,14 @@ Lists available databases on an instance.
</section>
<section xml:id="troveclient_subcommand_datastore-list">
<title>trove datastore-list command</title>
<screen><computeroutput>usage: trove datastore-list
</computeroutput></screen>
<screen><computeroutput>usage: trove datastore-list</computeroutput></screen>
<para>
Lists available datastores.
</para> </section>
</para>
</section>
<section xml:id="troveclient_subcommand_datastore-show">
<title>trove datastore-show command</title>
<screen><computeroutput>usage: trove datastore-show &lt;datastore&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove datastore-show &lt;datastore&gt;</computeroutput></screen>
<para>
Shows details of a datastore.
</para> <variablelist wordsize="10">
@ -1272,8 +1250,7 @@ Shows details of a datastore.
</section>
<section xml:id="troveclient_subcommand_datastore-version-list">
<title>trove datastore-version-list command</title>
<screen><computeroutput>usage: trove datastore-version-list &lt;datastore&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove datastore-version-list &lt;datastore&gt;</computeroutput></screen>
<para>
Lists available versions for a datastore.
</para> <variablelist wordsize="10">
@ -1291,8 +1268,7 @@ Lists available versions for a datastore.
<section xml:id="troveclient_subcommand_datastore-version-show">
<title>trove datastore-version-show command</title>
<screen><computeroutput>usage: trove datastore-version-show &lt;datastore_version&gt;
[--datastore &lt;datastore&gt;]
</computeroutput></screen>
[--datastore &lt;datastore&gt;]</computeroutput></screen>
<para>
Shows details of a datastore version.
</para> <variablelist wordsize="10">
@ -1321,8 +1297,7 @@ Shows details of a datastore version.
</section>
<section xml:id="troveclient_subcommand_delete">
<title>trove delete command</title>
<screen><computeroutput>usage: trove delete &lt;instance&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove delete &lt;instance&gt;</computeroutput></screen>
<para>
Deletes an instance.
</para> <variablelist wordsize="10">
@ -1339,15 +1314,14 @@ Deletes an instance.
</section>
<section xml:id="troveclient_subcommand_flavor-list">
<title>trove flavor-list command</title>
<screen><computeroutput>usage: trove flavor-list
</computeroutput></screen>
<screen><computeroutput>usage: trove flavor-list</computeroutput></screen>
<para>
Lists available flavors.
</para> </section>
</para>
</section>
<section xml:id="troveclient_subcommand_flavor-show">
<title>trove flavor-show command</title>
<screen><computeroutput>usage: trove flavor-show &lt;flavor&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove flavor-show &lt;flavor&gt;</computeroutput></screen>
<para>
Shows details of a flavor.
</para> <variablelist wordsize="10">
@ -1364,22 +1338,21 @@ Shows details of a flavor.
</section>
<section xml:id="troveclient_subcommand_limit-list">
<title>trove limit-list command</title>
<screen><computeroutput>usage: trove limit-list
</computeroutput></screen>
<screen><computeroutput>usage: trove limit-list</computeroutput></screen>
<para>
Lists the limits for a tenant.
</para> </section>
</para>
</section>
<section xml:id="troveclient_subcommand_list">
<title>trove list command</title>
<screen><computeroutput>usage: trove list
</computeroutput></screen>
<screen><computeroutput>usage: trove list</computeroutput></screen>
<para>
Lists all the instances.
</para> </section>
</para>
</section>
<section xml:id="troveclient_subcommand_resize-flavor">
<title>trove resize-flavor command</title>
<screen><computeroutput>usage: trove resize-flavor &lt;instance&gt; &lt;flavor_id&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove resize-flavor &lt;instance&gt; &lt;flavor_id&gt;</computeroutput></screen>
<para>
Resizes the flavor of an instance.
</para> <variablelist wordsize="10">
@ -1404,8 +1377,7 @@ Resizes the flavor of an instance.
</section>
<section xml:id="troveclient_subcommand_resize-volume">
<title>trove resize-volume command</title>
<screen><computeroutput>usage: trove resize-volume &lt;instance&gt; &lt;size&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove resize-volume &lt;instance&gt; &lt;size&gt;</computeroutput></screen>
<para>
Resizes the volume size of an instance.
</para> <variablelist wordsize="10">
@ -1430,8 +1402,7 @@ Resizes the volume size of an instance.
</section>
<section xml:id="troveclient_subcommand_restart">
<title>trove restart command</title>
<screen><computeroutput>usage: trove restart &lt;instance&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove restart &lt;instance&gt;</computeroutput></screen>
<para>
Restarts the instance.
</para> <variablelist wordsize="10">
@ -1448,8 +1419,7 @@ Restarts the instance.
</section>
<section xml:id="troveclient_subcommand_root-enable">
<title>trove root-enable command</title>
<screen><computeroutput>usage: trove root-enable &lt;instance&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove root-enable &lt;instance&gt;</computeroutput></screen>
<para>
Enables root for a instance.
</para> <variablelist wordsize="10">
@ -1466,8 +1436,7 @@ Enables root for a instance.
</section>
<section xml:id="troveclient_subcommand_root-show">
<title>trove root-show command</title>
<screen><computeroutput>usage: trove root-show &lt;instance&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove root-show &lt;instance&gt;</computeroutput></screen>
<para>
Gets root enabled status for a instance.
</para> <variablelist wordsize="10">
@ -1484,8 +1453,7 @@ Gets root enabled status for a instance.
</section>
<section xml:id="troveclient_subcommand_secgroup-add-rule">
<title>trove secgroup-add-rule command</title>
<screen><computeroutput>usage: trove secgroup-add-rule &lt;security_group&gt; &lt;cidr&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove secgroup-add-rule &lt;security_group&gt; &lt;cidr&gt;</computeroutput></screen>
<para>
Creates a security group rule.
</para> <variablelist wordsize="10">
@ -1510,8 +1478,7 @@ Creates a security group rule.
</section>
<section xml:id="troveclient_subcommand_secgroup-delete-rule">
<title>trove secgroup-delete-rule command</title>
<screen><computeroutput>usage: trove secgroup-delete-rule &lt;security_group_rule&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove secgroup-delete-rule &lt;security_group_rule&gt;</computeroutput></screen>
<para>
Deletes a security group rule.
</para> <variablelist wordsize="10">
@ -1528,15 +1495,14 @@ Deletes a security group rule.
</section>
<section xml:id="troveclient_subcommand_secgroup-list">
<title>trove secgroup-list command</title>
<screen><computeroutput>usage: trove secgroup-list
</computeroutput></screen>
<screen><computeroutput>usage: trove secgroup-list</computeroutput></screen>
<para>
Lists all security groups.
</para> </section>
</para>
</section>
<section xml:id="troveclient_subcommand_secgroup-show">
<title>trove secgroup-show command</title>
<screen><computeroutput>usage: trove secgroup-show &lt;security_group&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove secgroup-show &lt;security_group&gt;</computeroutput></screen>
<para>
Shows details about a security group.
</para> <variablelist wordsize="10">
@ -1553,8 +1519,7 @@ Shows details about a security group.
</section>
<section xml:id="troveclient_subcommand_show">
<title>trove show command</title>
<screen><computeroutput>usage: trove show &lt;instance&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove show &lt;instance&gt;</computeroutput></screen>
<para>
Shows details of an instance.
</para> <variablelist wordsize="10">
@ -1573,8 +1538,7 @@ Shows details of an instance.
<title>trove user-create command</title>
<screen><computeroutput>usage: trove user-create &lt;instance&gt; &lt;name&gt; &lt;password&gt;
[--host &lt;host&gt;]
[--databases &lt;databases&gt; [&lt;databases&gt; ...]]
</computeroutput></screen>
[--databases &lt;databases&gt; [&lt;databases&gt; ...]]</computeroutput></screen>
<para>
Creates a user.
</para> <variablelist wordsize="10">
@ -1626,8 +1590,7 @@ Creates a user.
</section>
<section xml:id="troveclient_subcommand_user-delete">
<title>trove user-delete command</title>
<screen><computeroutput>usage: trove user-delete [--host &lt;host&gt;] &lt;instance&gt; &lt;name&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove user-delete [--host &lt;host&gt;] &lt;instance&gt; &lt;name&gt;</computeroutput></screen>
<para>
Deletes a user from the instance.
</para> <variablelist wordsize="10">
@ -1664,8 +1627,7 @@ Deletes a user from the instance.
<section xml:id="troveclient_subcommand_user-grant-access">
<title>trove user-grant-access command</title>
<screen><computeroutput>usage: trove user-grant-access &lt;instance&gt; &lt;name&gt; &lt;databases&gt; [&lt;databases&gt; ...]
[--host &lt;host&gt;]
</computeroutput></screen>
[--host &lt;host&gt;]</computeroutput></screen>
<para>
Grants access to a database(s) for a user.
</para> <variablelist wordsize="10">
@ -1709,8 +1671,7 @@ Grants access to a database(s) for a user.
</section>
<section xml:id="troveclient_subcommand_user-list">
<title>trove user-list command</title>
<screen><computeroutput>usage: trove user-list &lt;instance&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove user-list &lt;instance&gt;</computeroutput></screen>
<para>
Lists the users for a instance.
</para> <variablelist wordsize="10">
@ -1727,8 +1688,7 @@ Lists the users for a instance.
</section>
<section xml:id="troveclient_subcommand_user-revoke-access">
<title>trove user-revoke-access command</title>
<screen><computeroutput>usage: trove user-revoke-access [--host &lt;host&gt;] &lt;instance&gt; &lt;name&gt; &lt;database&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove user-revoke-access [--host &lt;host&gt;] &lt;instance&gt; &lt;name&gt; &lt;database&gt;</computeroutput></screen>
<para>
Revokes access to a database for a user.
</para> <variablelist wordsize="10">
@ -1772,8 +1732,7 @@ Revokes access to a database for a user.
</section>
<section xml:id="troveclient_subcommand_user-show">
<title>trove user-show command</title>
<screen><computeroutput>usage: trove user-show [--host &lt;host&gt;] &lt;instance&gt; &lt;name&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove user-show [--host &lt;host&gt;] &lt;instance&gt; &lt;name&gt;</computeroutput></screen>
<para>
Gets a user from the instance.
</para> <variablelist wordsize="10">
@ -1809,8 +1768,7 @@ Gets a user from the instance.
</section>
<section xml:id="troveclient_subcommand_user-show-access">
<title>trove user-show-access command</title>
<screen><computeroutput>usage: trove user-show-access [--host &lt;host&gt;] &lt;instance&gt; &lt;name&gt;
</computeroutput></screen>
<screen><computeroutput>usage: trove user-show-access [--host &lt;host&gt;] &lt;instance&gt; &lt;name&gt;</computeroutput></screen>
<para>
Gets a users access from the instance.
</para> <variablelist wordsize="10">
@ -1849,8 +1807,7 @@ Gets a users access from the instance.
<screen><computeroutput>usage: trove user-update-attributes &lt;instance&gt; &lt;name&gt;
[--host &lt;host&gt;] [--new_name &lt;new_name&gt;]
[--new_password &lt;new_password&gt;]
[--new_host &lt;new_host&gt;]
</computeroutput></screen>
[--new_host &lt;new_host&gt;]</computeroutput></screen>
<para>
Updates a users attributes from the instance.
</para> <variablelist wordsize="10">