openstack/openstack-manuals
Code Issues Proposed changes

Merge "Update for keystoneclient 0.7.1"

Browse Source
This commit is contained in:
Jenkins
2014-03-28 07:57:35 +00:00
committed by Gerrit Code Review
parent 636088cffe c9ad8f325e
commit 1ab088b49e
1 changed files with 93 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

181
doc/common/ch_cli_keystone_commands.xml
View File

@@ -11,7 +11,7 @@
<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.6.0.
<command>keystone</command> version 0.7.1.
</para>
<para>For help on a specific <command>keystone</command>
command, enter:
@@ -72,7 +72,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>
@@ -241,7 +241,7 @@
<term><command>user-delete</command></term>
<listitem>
<para>
Delete user
Delete user.
</para>
</listitem>
</varlistentry>
@@ -273,7 +273,7 @@
<term><command>user-role-add</command></term>
<listitem>
<para>
Add role to user
Add role to user.
</para>
</listitem>
</varlistentry>
@@ -281,7 +281,7 @@
<term><command>user-role-list</command></term>
<listitem>
<para>
List roles granted to a user
List roles granted to a user.
</para>
</listitem>
</varlistentry>
@@ -289,7 +289,7 @@
<term><command>user-role-remove</command></term>
<listitem>
<para>
Remove role from user
Remove role from user.
</para>
</listitem>
</varlistentry>
@@ -345,7 +345,7 @@
<term><command>--version</command></term>
<listitem>
<para>
Shows the client version and exits
Shows the client version and exits.
</para>
</listitem>
</varlistentry>
@@ -353,7 +353,7 @@
<term><command>--timeout &lt;seconds&gt;</command></term>
<listitem>
<para>
Set request timeout (in seconds)
Set request timeout (in seconds).
</para>
</listitem>
</varlistentry>
@@ -362,7 +362,7 @@
<listitem>
<para>
Name used for authentication with the OpenStack
Identity service. Defaults to <code>env[OS_USERNAME]</code>
Identity service. Defaults to <code>env[OS_USERNAME]</code>.
</para>
</listitem>
</varlistentry>
@@ -371,7 +371,7 @@
<listitem>
<para>
Password used for authentication with the OpenStack
Identity service. Defaults to <code>env[OS_PASSWORD]</code>
Identity service. Defaults to <code>env[OS_PASSWORD]</code>.
</para>
</listitem>
</varlistentry>
@@ -380,7 +380,7 @@
<listitem>
<para>
Tenant to request authorization on. Defaults to
<code>env[OS_TENANT_NAME]</code>
<code>env[OS_TENANT_NAME]</code>.
</para>
</listitem>
</varlistentry>
@@ -389,7 +389,7 @@
<listitem>
<para>
Tenant to request authorization on. Defaults to
<code>env[OS_TENANT_ID]</code>
<code>env[OS_TENANT_ID]</code>.
</para>
</listitem>
</varlistentry>
@@ -398,7 +398,7 @@
<listitem>
<para>
Specify the Identity endpoint to use for
authentication. Defaults to <code>env[OS_AUTH_URL]</code>
authentication. Defaults to <code>env[OS_AUTH_URL]</code>.
</para>
</listitem>
</varlistentry>
@@ -406,7 +406,8 @@
<term><command>--os-region-name &lt;region-name&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_REGION_NAME]</code>
Specify the region to use. Defaults to
<code>env[OS_REGION_NAME]</code>.
</para>
</listitem>
</varlistentry>
@@ -414,7 +415,8 @@
<term><command>--os-identity-api-version &lt;identity-api-version&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_IDENTITY_API_VERSION]</code> or 2.0
Specify Identity API version to use. Defaults to
<code>env[OS_IDENTITY_API_VERSION]</code> or 2.0.
</para>
</listitem>
</varlistentry>
@@ -424,7 +426,7 @@
<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>
password). Defaults to <code>env[OS_SERVICE_TOKEN]</code>.
</para>
</listitem>
</varlistentry>
@@ -434,7 +436,7 @@
<para>
Specify an endpoint to use instead of retrieving one
from the service catalog (via authentication).
Defaults to <code>env[OS_SERVICE_ENDPOINT]</code>
Defaults to <code>env[OS_SERVICE_ENDPOINT]</code>.
</para>
</listitem>
</varlistentry>
@@ -443,7 +445,8 @@
<listitem>
<para>
Specify a CA bundle file to use in verifying a TLS
(https) server certificate. Defaults to <code>env[OS_CACERT]</code>
(https) server certificate. Defaults to
<code>env[OS_CACERT]</code>.
</para>
</listitem>
</varlistentry>
@@ -462,7 +465,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>
@@ -470,7 +473,7 @@
<term><command>--os-key &lt;key&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_KEY]</code>
Defaults to <code>env[OS_KEY]</code>.
</para>
</listitem>
</varlistentry>
@@ -478,7 +481,7 @@
<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>
@@ -564,7 +567,7 @@ List service catalog, possibly filtered by service.
<term><command>--service &lt;service-type&gt;</command></term>
<listitem>
<para>
Service type to return
Service type to return.
</para>
</listitem>
</varlistentry>
@@ -590,7 +593,8 @@ Create EC2-compatible credentials for user per tenant.
<term><command>--user-id &lt;user-id&gt;</command></term>
<listitem>
<para>
User ID
User ID for which to create credentials. If not
specified, the authenticated user will be used.
</para>
</listitem>
</varlistentry>
@@ -598,7 +602,8 @@ Create EC2-compatible credentials for user per tenant.
<term><command>--tenant-id &lt;tenant-id&gt;</command></term>
<listitem>
<para>
Tenant ID
Tenant ID for which to to create credentials. If not
specified, the authenticated tenant ID will be used.
</para>
</listitem>
</varlistentry>
@@ -617,7 +622,7 @@ Delete EC2-compatible credentials.
<term><command>--user-id &lt;user-id&gt;</command></term>
<listitem>
<para>
User ID
User ID.
</para>
</listitem>
</varlistentry>
@@ -625,7 +630,7 @@ Delete EC2-compatible credentials.
<term><command>--access &lt;access-key&gt;</command></term>
<listitem>
<para>
Access Key
Access Key.
</para>
</listitem>
</varlistentry>
@@ -644,7 +649,7 @@ Display EC2-compatible credentials.
<term><command>--user-id &lt;user-id&gt;</command></term>
<listitem>
<para>
User ID
User ID.
</para>
</listitem>
</varlistentry>
@@ -652,7 +657,7 @@ Display EC2-compatible credentials.
<term><command>--access &lt;access-key&gt;</command></term>
<listitem>
<para>
Access Key
Access Key.
</para>
</listitem>
</varlistentry>
@@ -663,14 +668,14 @@ Display EC2-compatible credentials.
<screen><computeroutput>usage: keystone ec2-credentials-list [--user-id &lt;user-id&gt;]
</computeroutput></screen>
<para>
List EC2-compatible credentials for a user
List EC2-compatible credentials for a user.
</para> <variablelist wordsize="10">
<title>Arguments</title>
<varlistentry>
<term><command>--user-id &lt;user-id&gt;</command></term>
<listitem>
<para>
User ID
User ID.
</para>
</listitem>
</varlistentry>
@@ -691,7 +696,7 @@ Create a new endpoint associated with a service.
<term><command>--region &lt;endpoint-region&gt;</command></term>
<listitem>
<para>
Endpoint region
Endpoint region.
</para>
</listitem>
</varlistentry>
@@ -699,7 +704,7 @@ Create a new endpoint associated with a service.
<term><command>--service &lt;service&gt;, --service-id &lt;service&gt;, --service_id &lt;service&gt;</command></term>
<listitem>
<para>
Name or ID of service associated with Endpoint
Name or ID of service associated with endpoint.
</para>
</listitem>
</varlistentry>
@@ -707,7 +712,7 @@ Create a new endpoint associated with a service.
<term><command>--publicurl &lt;public-url&gt;</command></term>
<listitem>
<para>
Public URL endpoint
Public URL endpoint.
</para>
</listitem>
</varlistentry>
@@ -715,7 +720,7 @@ Create a new endpoint associated with a service.
<term><command>--adminurl &lt;admin-url&gt;</command></term>
<listitem>
<para>
Admin URL endpoint
Admin URL endpoint.
</para>
</listitem>
</varlistentry>
@@ -723,7 +728,7 @@ Create a new endpoint associated with a service.
<term><command>--internalurl &lt;internal-url&gt;</command></term>
<listitem>
<para>
Internal URL endpoint
Internal URL endpoint.
</para>
</listitem>
</varlistentry>
@@ -741,7 +746,7 @@ Delete a service endpoint.
<term><command>&lt;endpoint-id&gt;</command></term>
<listitem>
<para>
ID of endpoint to delete
ID of endpoint to delete.
</para>
</listitem>
</varlistentry>
@@ -761,7 +766,7 @@ Find endpoint filtered by a specific attribute or service type.
<term><command>--service &lt;service-type&gt;</command></term>
<listitem>
<para>
Service type to select
Service type to select.
</para>
</listitem>
</varlistentry>
@@ -769,7 +774,7 @@ Find endpoint filtered by a specific attribute or service type.
<term><command>--endpoint-type &lt;endpoint-type&gt;</command></term>
<listitem>
<para>
Endpoint type to select
Endpoint type to select.
</para>
</listitem>
</varlistentry>
@@ -777,7 +782,7 @@ Find endpoint filtered by a specific attribute or service type.
<term><command>--attr &lt;service-attribute&gt;</command></term>
<listitem>
<para>
Service attribute to match for selection
Service attribute to match for selection.
</para>
</listitem>
</varlistentry>
@@ -785,7 +790,7 @@ Find endpoint filtered by a specific attribute or service type.
<term><command>--value &lt;value&gt;</command></term>
<listitem>
<para>
Value of attribute to match
Value of attribute to match.
</para>
</listitem>
</varlistentry>
@@ -812,7 +817,7 @@ Update own password.
<listitem>
<para>
Current password, Defaults to the password as set by
--os-password or OS_PASSWORD
--os-password or <code>env[OS_PASSWORD]</code>.
</para>
</listitem>
</varlistentry>
@@ -820,7 +825,7 @@ Update own password.
<term><command>--new-password &lt;new-password&gt;</command></term>
<listitem>
<para>
Desired new password
Desired new password.
</para>
</listitem>
</varlistentry>
@@ -838,7 +843,7 @@ Create new role.
<term><command>--name &lt;role-name&gt;</command></term>
<listitem>
<para>
Name of new role
Name of new role.
</para>
</listitem>
</varlistentry>
@@ -856,7 +861,7 @@ Delete role.
<term><command>&lt;role&gt;</command></term>
<listitem>
<para>
Name or ID of role to delete
Name or ID of role to delete.
</para>
</listitem>
</varlistentry>
@@ -874,7 +879,7 @@ Display role details.
<term><command>&lt;role&gt;</command></term>
<listitem>
<para>
Name or ID of role to display
Name or ID of role to display.
</para>
</listitem>
</varlistentry>
@@ -900,7 +905,7 @@ Add service to Service Catalog.
<term><command>--name &lt;name&gt;</command></term>
<listitem>
<para>
Name of new service (must be unique)
Name of new service (must be unique).
</para>
</listitem>
</varlistentry>
@@ -910,7 +915,7 @@ Add service to Service Catalog.
<para>
Service type (one of: identity, compute, network,
image, object-store, or other service identifier
string)
string).
</para>
</listitem>
</varlistentry>
@@ -918,7 +923,7 @@ Add service to Service Catalog.
<term><command>--description &lt;service-description&gt;</command></term>
<listitem>
<para>
Description of service
Description of service.
</para>
</listitem>
</varlistentry>
@@ -936,7 +941,7 @@ Delete service from Service Catalog.
<term><command>&lt;service&gt;</command></term>
<listitem>
<para>
Name or ID of service to delete
Name or ID of service to delete.
</para>
</listitem>
</varlistentry>
@@ -954,7 +959,7 @@ Display service from Service Catalog.
<term><command>&lt;service&gt;</command></term>
<listitem>
<para>
Name or ID of service to display
Name or ID of service to display.
</para>
</listitem>
</varlistentry>
@@ -981,7 +986,7 @@ Create new tenant.
<term><command>--name &lt;tenant-name&gt;</command></term>
<listitem>
<para>
New tenant name (must be unique)
New tenant name (must be unique).
</para>
</listitem>
</varlistentry>
@@ -989,7 +994,7 @@ Create new tenant.
<term><command>--description &lt;tenant-description&gt;</command></term>
<listitem>
<para>
Description of new tenant (default is none)
Description of new tenant. Default is none.
</para>
</listitem>
</varlistentry>
@@ -997,7 +1002,7 @@ Create new tenant.
<term><command>--enabled &lt;true|false&gt;</command></term>
<listitem>
<para>
Initial tenant enabled status (default true)
Initial tenant enabled status. Default is true.
</para>
</listitem>
</varlistentry>
@@ -1015,7 +1020,7 @@ Delete tenant.
<term><command>&lt;tenant&gt;</command></term>
<listitem>
<para>
Name or ID of tenant to delete
Name or ID of tenant to delete.
</para>
</listitem>
</varlistentry>
@@ -1033,7 +1038,7 @@ Display tenant details.
<term><command>&lt;tenant&gt;</command></term>
<listitem>
<para>
Name or ID of tenant to display
Name or ID of tenant to display.
</para>
</listitem>
</varlistentry>
@@ -1061,7 +1066,7 @@ Update tenant name, description, enabled status.
<term><command>--name &lt;tenant_name&gt;</command></term>
<listitem>
<para>
Desired new name of tenant
Desired new name of tenant.
</para>
</listitem>
</varlistentry>
@@ -1069,7 +1074,7 @@ Update tenant name, description, enabled status.
<term><command>--description &lt;tenant-description&gt;</command></term>
<listitem>
<para>
Desired new description of tenant
Desired new description of tenant.
</para>
</listitem>
</varlistentry>
@@ -1077,7 +1082,7 @@ Update tenant name, description, enabled status.
<term><command>--enabled &lt;true|false&gt;</command></term>
<listitem>
<para>
Enable or disable tenant
Enable or disable tenant.
</para>
</listitem>
</varlistentry>
@@ -1085,7 +1090,7 @@ Update tenant name, description, enabled status.
<term><command>&lt;tenant&gt;</command></term>
<listitem>
<para>
Name or ID of tenant to update
Name or ID of tenant to update.
</para>
</listitem>
</varlistentry>
@@ -1103,7 +1108,7 @@ Display the current user token.
<term><command>--wrap &lt;integer&gt;</command></term>
<listitem>
<para>
wrap PKI tokens to a specified length, or 0 to disable
Wrap PKI tokens to a specified length, or 0 to disable.
</para>
</listitem>
</varlistentry>
@@ -1112,7 +1117,7 @@ Display the current user token.
<section xml:id="keystoneclient_subcommand_user-create">
<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;]
[--pass [&lt;pass&gt;]] [--email &lt;email&gt;]
[--enabled &lt;true|false&gt;]
</computeroutput></screen>
<para>
@@ -1123,7 +1128,7 @@ Create new user
<term><command>--name &lt;user-name&gt;</command></term>
<listitem>
<para>
New user name (must be unique)
New user name (must be unique).
</para>
</listitem>
</varlistentry>
@@ -1131,15 +1136,15 @@ Create new user
<term><command>--tenant &lt;tenant&gt;, --tenant-id &lt;tenant&gt;</command></term>
<listitem>
<para>
New user default tenant
New user default tenant.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--pass &lt;pass&gt;</command></term>
<term><command>--pass [&lt;pass&gt;]</command></term>
<listitem>
<para>
New user password
New user password; required for some auth backends.
</para>
</listitem>
</varlistentry>
@@ -1147,7 +1152,7 @@ Create new user
<term><command>--email &lt;email&gt;</command></term>
<listitem>
<para>
New user email address
New user email address.
</para>
</listitem>
</varlistentry>
@@ -1155,7 +1160,7 @@ Create new user
<term><command>--enabled &lt;true|false&gt;</command></term>
<listitem>
<para>
Initial user enabled status (default true)
Initial user enabled status. Default is true.
</para>
</listitem>
</varlistentry>
@@ -1166,14 +1171,14 @@ Create new user
<screen><computeroutput>usage: keystone user-delete &lt;user&gt;
</computeroutput></screen>
<para>
Delete user
Delete user.
</para> <variablelist wordsize="10">
<title>Arguments</title>
<varlistentry>
<term><command>&lt;user&gt;</command></term>
<listitem>
<para>
Name or ID of user to delete
Name or ID of user to delete.
</para>
</listitem>
</varlistentry>
@@ -1191,7 +1196,7 @@ Display user details.
<term><command>&lt;user&gt;</command></term>
<listitem>
<para>
Name or ID of user to display
Name or ID of user to display.
</para>
</listitem>
</varlistentry>
@@ -1209,7 +1214,7 @@ List users.
<term><command>--tenant &lt;tenant&gt;, --tenant-id &lt;tenant&gt;</command></term>
<listitem>
<para>
Tenant; lists all users if not specified
Tenant; lists all users if not specified.
</para>
</listitem>
</varlistentry>
@@ -1227,7 +1232,7 @@ Update user password.
<term><command>--pass &lt;password&gt;</command></term>
<listitem>
<para>
Desired new password
Desired new password.
</para>
</listitem>
</varlistentry>
@@ -1235,7 +1240,7 @@ Update user password.
<term><command>&lt;user&gt;</command></term>
<listitem>
<para>
Name or ID of user to update password
Name or ID of user to update password.
</para>
</listitem>
</varlistentry>
@@ -1246,14 +1251,14 @@ Update user password.
<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
Add role to user.
</para> <variablelist wordsize="10">
<title>Arguments</title>
<varlistentry>
<term><command>--user &lt;user&gt;, --user-id &lt;user&gt;, --user_id &lt;user&gt;</command></term>
<listitem>
<para>
Name or ID of user
Name or ID of user.
</para>
</listitem>
</varlistentry>
@@ -1261,7 +1266,7 @@ Add role to user
<term><command>--role &lt;role&gt;, --role-id &lt;role&gt;, --role_id &lt;role&gt;</command></term>
<listitem>
<para>
Name or ID of role
Name or ID of role.
</para>
</listitem>
</varlistentry>
@@ -1269,7 +1274,7 @@ Add role to user
<term><command>--tenant &lt;tenant&gt;, --tenant-id &lt;tenant&gt;</command></term>
<listitem>
<para>
Name or ID of tenant
Name or ID of tenant.
</para>
</listitem>
</varlistentry>
@@ -1280,14 +1285,14 @@ Add role to user
<screen><computeroutput>usage: keystone user-role-list [--user &lt;user&gt;] [--tenant &lt;tenant&gt;]
</computeroutput></screen>
<para>
List roles granted to a user
List roles granted to a user.
</para> <variablelist wordsize="10">
<title>Arguments</title>
<varlistentry>
<term><command>--user &lt;user&gt;, --user-id &lt;user&gt;</command></term>
<listitem>
<para>
List roles granted to a user
List roles granted to specified user.
</para>
</listitem>
</varlistentry>
@@ -1295,7 +1300,7 @@ List roles granted to a user
<term><command>--tenant &lt;tenant&gt;, --tenant-id &lt;tenant&gt;</command></term>
<listitem>
<para>
List roles granted on a tenant
List only roles granted on specified tenant.
</para>
</listitem>
</varlistentry>
@@ -1307,14 +1312,14 @@ List roles granted to a user
[--tenant &lt;tenant&gt;]
</computeroutput></screen>
<para>
Remove role from user
Remove role from user.
</para> <variablelist wordsize="10">
<title>Arguments</title>
<varlistentry>
<term><command>--user &lt;user&gt;, --user-id &lt;user&gt;, --user_id &lt;user&gt;</command></term>
<listitem>
<para>
Name or ID of user
Name or ID of user.
</para>
</listitem>
</varlistentry>
@@ -1322,7 +1327,7 @@ Remove role from user
<term><command>--role &lt;role&gt;, --role-id &lt;role&gt;, --role_id &lt;role&gt;</command></term>
<listitem>
<para>
Name or ID of role
Name or ID of role.
</para>
</listitem>
</varlistentry>
@@ -1330,7 +1335,7 @@ Remove role from user
<term><command>--tenant &lt;tenant&gt;, --tenant-id &lt;tenant&gt;</command></term>
<listitem>
<para>
Name or ID of tenant
Name or ID of tenant.
</para>
</listitem>
</varlistentry>
@@ -1350,7 +1355,7 @@ Update user's name, email, and enabled status.
<term><command>--name &lt;user-name&gt;</command></term>
<listitem>
<para>
Desired new user name
Desired new user name.
</para>
</listitem>
</varlistentry>
@@ -1358,7 +1363,7 @@ Update user's name, email, and enabled status.
<term><command>--email &lt;email&gt;</command></term>
<listitem>
<para>
Desired new email address
Desired new email address.
</para>
</listitem>
</varlistentry>
@@ -1366,7 +1371,7 @@ Update user's name, email, and enabled status.
<term><command>--enabled &lt;true|false&gt;</command></term>
<listitem>
<para>
Enable or disable user
Enable or disable user.
</para>
</listitem>
</varlistentry>
@@ -1374,7 +1379,7 @@ Update user's name, email, and enabled status.
<term><command>&lt;user&gt;</command></term>
<listitem>
<para>
Name or ID of user to update
Name or ID of user to update.
</para>
</listitem>
</varlistentry>