openstack/openstack-manuals
Code Issues Proposed changes

Update for python-keystoneclient 0.11.1

Browse Source 
Regenerate ch_cli_keystone_commands.xml with
python-keystoneclient 0.11.1 version release.

Change-Id: I41e563ef7eef727a7c7f517df54ff615eecec066
This commit is contained in:
Christian Berendt 2014-09-23 20:56:01 +02:00
parent f62a2b006f
commit d3daadece1
1 changed files with 82 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -10,10 +10,14 @@
<?dbhtml stop-chunking?>
<title>Identity service command-line client</title>
<para>The <command>keystone</command> client is the command-line interface
(CLI) for the OpenStack Identity API and its extensions. This chapter documents
<command>keystone</command> version 0.10.1.
<para>The <command>keystone</command> client is the command-line
interface (CLI) for the OpenStack Identity API and its extensions.
This chapter documents <command>keystone</command> version
<literal>0.11.1</literal>.
</para>
<para>For help on a specific <command>keystone</command>
command, enter:
</para>
@ -39,7 +43,8 @@
<term><command>catalog</command></term>
<listitem>
<para>
List service catalog, possibly filtered by service.
List service catalog, possibly filtered by
service.
</para>
</listitem>
</varlistentry>
@ -47,7 +52,8 @@
<term><command>ec2-credentials-create</command></term>
<listitem>
<para>
Create EC2-compatible credentials for user per tenant.
Create EC2-compatible credentials for user per
tenant.
</para>
</listitem>
</varlistentry>
@ -55,7 +61,7 @@
<term><command>ec2-credentials-delete</command></term>
<listitem>
<para>
Delete EC2-compatible credentials.
Delete EC2-compatible credentials.
</para>
</listitem>
</varlistentry>
@ -63,7 +69,7 @@
<term><command>ec2-credentials-get</command></term>
<listitem>
<para>
Display EC2-compatible credentials.
Display EC2-compatible credentials.
</para>
</listitem>
</varlistentry>
@ -71,7 +77,7 @@
<term><command>ec2-credentials-list</command></term>
<listitem>
<para>
List EC2-compatible credentials for a user.
List EC2-compatible credentials for a user.
</para>
</listitem>
</varlistentry>
@ -264,7 +270,7 @@
<term><command>user-password-update</command></term>
<listitem>
<para>
Update user password.
Update user password.
</para>
</listitem>
</varlistentry>
@ -304,8 +310,8 @@
<term><command>discover</command></term>
<listitem>
<para>
Discover Keystone servers, supported API versions and
extensions.
Discover Keystone servers, supported API versions
and extensions.
</para>
</listitem>
</varlistentry>
@ -313,8 +319,8 @@
<term><command>bootstrap</command></term>
<listitem>
<para>
Grants a new role to a new user on a new tenant, after
creating each.
Grants a new role to a new user on a new tenant,
after creating each.
</para>
</listitem>
</varlistentry>
@ -353,8 +359,9 @@
<listitem>
<para>
Prints debugging output onto the console, this
includes the curl request and response calls. Helpful
for debugging and understanding the API calls.
includes the curl request and response calls.
Helpful for debugging and understanding the API
calls.
</para>
</listitem>
</varlistentry>
@ -371,8 +378,9 @@
<term><command>--os-password &lt;auth-password&gt;</command></term>
<listitem>
<para>
Password used for authentication with the OpenStack
Identity service. Defaults to <code>env[OS_PASSWORD]</code>.
Password used for authentication with the
OpenStack Identity service. Defaults to
<code>env[OS_PASSWORD]</code>.
</para>
</listitem>
</varlistentry>
@ -398,7 +406,7 @@
<term><command>--os-auth-url &lt;auth-url&gt;</command></term>
<listitem>
<para>
Specify the Identity endpoint to use for
Specify the Identity endpoint to use for
authentication. Defaults to <code>env[OS_AUTH_URL]</code>.
</para>
</listitem>
@ -425,9 +433,10 @@
<term><command>--os-token &lt;service-token&gt;</command></term>
<listitem>
<para>
Specify an existing token to use instead of retrieving
one via authentication (e.g. with username &amp;
password). Defaults to <code>env[OS_SERVICE_TOKEN]</code>.
Specify an existing token to use instead of
retrieving one via authentication (e.g. with
username &amp; password). Defaults to
<code>env[OS_SERVICE_TOKEN]</code>.
</para>
</listitem>
</varlistentry>
@ -435,8 +444,8 @@
<term><command>--os-endpoint &lt;service-endpoint&gt;</command></term>
<listitem>
<para>
Specify an endpoint to use instead of retrieving one
from the service catalog (via authentication).
Specify an endpoint to use instead of retrieving
one from the service catalog (via authentication).
Defaults to <code>env[OS_SERVICE_ENDPOINT]</code>.
</para>
</listitem>
@ -445,7 +454,8 @@
<term><command>--os-cache</command></term>
<listitem>
<para>
Use the auth token cache. Defaults to <code>env[OS_CACHE]</code>.
Use the auth token cache. Defaults to
<code>env[OS_CACHE]</code>.
</para>
</listitem>
</varlistentry>
@ -454,9 +464,10 @@
<listitem>
<para>
If the keyring is available and in use, token will
always be stored and fetched from the keyring until
the token has expired. Use this option to request a
new token and replace the existing one in the keyring.
always be stored and fetched from the keyring
until the token has expired. Use this option to
request a new token and replace the existing one
in the keyring.
</para>
</listitem>
</varlistentry>
@ -464,10 +475,10 @@
<term><command>--stale-duration &lt;seconds&gt;</command></term>
<listitem>
<para>
Stale duration (in seconds) used to determine whether
a token has expired when retrieving it from keyring.
This is useful in mitigating process or network
delays. Default is 30 seconds.
Stale duration (in seconds) used to determine
whether a token has expired when retrieving it
from keyring. This is useful in mitigating process
or network delays. Default is 30 seconds.
</para>
</listitem>
</varlistentry>
@ -476,9 +487,10 @@
<listitem>
<para>
Explicitly allow client to perform "insecure" TLS
(https) requests. The server's certificate will not be
verified against any certificate authorities. This
option should be used with caution.
(https) requests. The server's certificate will
not be verified against any certificate
authorities. This option should be used with
caution.
</para>
</listitem>
</varlistentry>
@ -496,7 +508,7 @@
<term><command>--os-cert &lt;certificate&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_CERT]</code>.
Defaults to <code>env[OS_CERT]</code>.
</para>
</listitem>
</varlistentry>
@ -519,7 +531,7 @@
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_bootstrap">
<title>keystone bootstrap command</title>
<title>keystone bootstrap</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>
@ -564,7 +576,7 @@ Grants a new role to a new user on a new tenant, after creating each.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_catalog">
<title>keystone catalog command</title>
<title>keystone catalog</title>
<screen><computeroutput>usage: keystone catalog [--service &lt;service-type&gt;]</computeroutput></screen>
<para>
List service catalog, possibly filtered by service.
@ -581,14 +593,14 @@ List service catalog, possibly filtered by service.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_discover">
<title>keystone discover command</title>
<title>keystone discover</title>
<screen><computeroutput>usage: keystone discover</computeroutput></screen>
<para>
Discover Keystone servers, supported API versions and extensions.
</para>
</section>
<section xml:id="keystoneclient_subcommand_ec2-credentials-create">
<title>keystone ec2-credentials-create command</title>
<title>keystone ec2-credentials-create</title>
<screen><computeroutput>usage: keystone ec2-credentials-create [--user-id &lt;user-id&gt;]
[--tenant-id &lt;tenant-id&gt;]</computeroutput></screen>
<para>
@ -616,7 +628,7 @@ Create EC2-compatible credentials for user per tenant.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_ec2-credentials-delete">
<title>keystone ec2-credentials-delete command</title>
<title>keystone ec2-credentials-delete</title>
<screen><computeroutput>usage: keystone ec2-credentials-delete [--user-id &lt;user-id&gt;] --access
&lt;access-key&gt;</computeroutput></screen>
<para>
@ -642,7 +654,7 @@ Delete EC2-compatible credentials.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_ec2-credentials-get">
<title>keystone ec2-credentials-get command</title>
<title>keystone ec2-credentials-get</title>
<screen><computeroutput>usage: keystone ec2-credentials-get [--user-id &lt;user-id&gt;] --access
&lt;access-key&gt;</computeroutput></screen>
<para>
@ -668,7 +680,7 @@ Display EC2-compatible credentials.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_ec2-credentials-list">
<title>keystone ec2-credentials-list command</title>
<title>keystone ec2-credentials-list</title>
<screen><computeroutput>usage: keystone ec2-credentials-list [--user-id &lt;user-id&gt;]</computeroutput></screen>
<para>
List EC2-compatible credentials for a user.
@ -685,7 +697,7 @@ List EC2-compatible credentials for a user.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_endpoint-create">
<title>keystone endpoint-create command</title>
<title>keystone endpoint-create</title>
<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;]
@ -737,7 +749,7 @@ Create a new endpoint associated with a service.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_endpoint-delete">
<title>keystone endpoint-delete command</title>
<title>keystone endpoint-delete</title>
<screen><computeroutput>usage: keystone endpoint-delete &lt;endpoint-id&gt;</computeroutput></screen>
<para>
Delete a service endpoint.
@ -754,7 +766,7 @@ Delete a service endpoint.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_endpoint-get">
<title>keystone endpoint-get command</title>
<title>keystone endpoint-get</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>
@ -797,14 +809,14 @@ Find endpoint filtered by a specific attribute or service type.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_endpoint-list">
<title>keystone endpoint-list command</title>
<title>keystone endpoint-list</title>
<screen><computeroutput>usage: keystone endpoint-list</computeroutput></screen>
<para>
List configured service endpoints.
</para>
</section>
<section xml:id="keystoneclient_subcommand_password-update">
<title>keystone password-update command</title>
<title>keystone password-update</title>
<screen><computeroutput>usage: keystone password-update [--current-password &lt;current-password&gt;]
[--new-password &lt;new-password&gt;]</computeroutput></screen>
<para>
@ -831,7 +843,7 @@ Update own password.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_role-create">
<title>keystone role-create command</title>
<title>keystone role-create</title>
<screen><computeroutput>usage: keystone role-create --name &lt;role-name&gt;</computeroutput></screen>
<para>
Create new role.
@ -848,7 +860,7 @@ Create new role.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_role-delete">
<title>keystone role-delete command</title>
<title>keystone role-delete</title>
<screen><computeroutput>usage: keystone role-delete &lt;role&gt;</computeroutput></screen>
<para>
Delete role.
@ -865,7 +877,7 @@ Delete role.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_role-get">
<title>keystone role-get command</title>
<title>keystone role-get</title>
<screen><computeroutput>usage: keystone role-get &lt;role&gt;</computeroutput></screen>
<para>
Display role details.
@ -882,14 +894,14 @@ Display role details.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_role-list">
<title>keystone role-list command</title>
<title>keystone role-list</title>
<screen><computeroutput>usage: keystone role-list</computeroutput></screen>
<para>
List all roles.
</para>
</section>
<section xml:id="keystoneclient_subcommand_service-create">
<title>keystone service-create command</title>
<title>keystone service-create</title>
<screen><computeroutput>usage: keystone service-create --name &lt;name&gt; --type &lt;type&gt;
[--description &lt;service-description&gt;]</computeroutput></screen>
<para>
@ -925,7 +937,7 @@ Add service to Service Catalog.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_service-delete">
<title>keystone service-delete command</title>
<title>keystone service-delete</title>
<screen><computeroutput>usage: keystone service-delete &lt;service&gt;</computeroutput></screen>
<para>
Delete service from Service Catalog.
@ -942,7 +954,7 @@ Delete service from Service Catalog.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_service-get">
<title>keystone service-get command</title>
<title>keystone service-get</title>
<screen><computeroutput>usage: keystone service-get &lt;service&gt;</computeroutput></screen>
<para>
Display service from Service Catalog.
@ -959,14 +971,14 @@ Display service from Service Catalog.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_service-list">
<title>keystone service-list command</title>
<title>keystone service-list</title>
<screen><computeroutput>usage: keystone service-list</computeroutput></screen>
<para>
List all services in Service Catalog.
</para>
</section>
<section xml:id="keystoneclient_subcommand_tenant-create">
<title>keystone tenant-create command</title>
<title>keystone tenant-create</title>
<screen><computeroutput>usage: keystone tenant-create --name &lt;tenant-name&gt;
[--description &lt;tenant-description&gt;]
[--enabled &lt;true|false&gt;]</computeroutput></screen>
@ -1001,7 +1013,7 @@ Create new tenant.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_tenant-delete">
<title>keystone tenant-delete command</title>
<title>keystone tenant-delete</title>
<screen><computeroutput>usage: keystone tenant-delete &lt;tenant&gt;</computeroutput></screen>
<para>
Delete tenant.
@ -1018,7 +1030,7 @@ Delete tenant.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_tenant-get">
<title>keystone tenant-get command</title>
<title>keystone tenant-get</title>
<screen><computeroutput>usage: keystone tenant-get &lt;tenant&gt;</computeroutput></screen>
<para>
Display tenant details.
@ -1035,14 +1047,14 @@ Display tenant details.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_tenant-list">
<title>keystone tenant-list command</title>
<title>keystone tenant-list</title>
<screen><computeroutput>usage: keystone tenant-list</computeroutput></screen>
<para>
List all tenants.
</para>
</section>
<section xml:id="keystoneclient_subcommand_tenant-update">
<title>keystone tenant-update command</title>
<title>keystone tenant-update</title>
<screen><computeroutput>usage: keystone tenant-update [--name &lt;tenant_name&gt;]
[--description &lt;tenant-description&gt;]
[--enabled &lt;true|false&gt;]
@ -1086,7 +1098,7 @@ Update tenant name, description, enabled status.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_token-get">
<title>keystone token-get command</title>
<title>keystone token-get</title>
<screen><computeroutput>usage: keystone token-get [--wrap &lt;integer&gt;]</computeroutput></screen>
<para>
Display the current user token.
@ -1103,7 +1115,7 @@ Display the current user token.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_user-create">
<title>keystone user-create command</title>
<title>keystone user-create</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>
@ -1154,7 +1166,7 @@ Create new user.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_user-delete">
<title>keystone user-delete command</title>
<title>keystone user-delete</title>
<screen><computeroutput>usage: keystone user-delete &lt;user&gt;</computeroutput></screen>
<para>
Delete user.
@ -1171,7 +1183,7 @@ Delete user.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_user-get">
<title>keystone user-get command</title>
<title>keystone user-get</title>
<screen><computeroutput>usage: keystone user-get &lt;user&gt;</computeroutput></screen>
<para>
Display user details.
@ -1188,7 +1200,7 @@ Display user details.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_user-list">
<title>keystone user-list command</title>
<title>keystone user-list</title>
<screen><computeroutput>usage: keystone user-list [--tenant &lt;tenant&gt;]</computeroutput></screen>
<para>
List users.
@ -1205,7 +1217,7 @@ List users.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_user-password-update">
<title>keystone user-password-update command</title>
<title>keystone user-password-update</title>
<screen><computeroutput>usage: keystone user-password-update [--pass &lt;password&gt;] &lt;user&gt;</computeroutput></screen>
<para>
Update user password.
@ -1230,7 +1242,7 @@ Update user password.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_user-role-add">
<title>keystone user-role-add command</title>
<title>keystone user-role-add</title>
<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.
@ -1263,7 +1275,7 @@ Add role to user.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_user-role-list">
<title>keystone user-role-list command</title>
<title>keystone user-role-list</title>
<screen><computeroutput>usage: keystone user-role-list [--user &lt;user&gt;] [--tenant &lt;tenant&gt;]</computeroutput></screen>
<para>
List roles granted to a user.
@ -1288,7 +1300,7 @@ List roles granted to a user.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_user-role-remove">
<title>keystone user-role-remove command</title>
<title>keystone user-role-remove</title>
<screen><computeroutput>usage: keystone user-role-remove --user &lt;user&gt; --role &lt;role&gt;
[--tenant &lt;tenant&gt;]</computeroutput></screen>
<para>
@ -1322,7 +1334,7 @@ Remove role from user.
</variablelist>
</section>
<section xml:id="keystoneclient_subcommand_user-update">
<title>keystone user-update command</title>
<title>keystone user-update</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>