summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorjakedahn <jake@ansolabs.com>2012-02-21 15:02:41 -0800
committerDean Troyer <dtroyer@gmail.com>2012-02-23 16:28:38 -0600
commit2a1c94a75375dec5bd2a8a6dace98b411d2ab29e (patch)
treed108bd70682e88ef60825eb8ffa8a19e190322fe /README.rst
parent1f75cab683f43fbdc4f2a603806e8f2624a9a5aa (diff)
downloadpython-keystoneclient-2a1c94a75375dec5bd2a8a6dace98b411d2ab29e.tar.gz
Improve usability of CLI.
* Fixes bug #936422 * Fixes bug #932223 * Depends on bcwaldon's review: https://review.openstack.org/#change,4305 * This review proposes making changes outlined in this spreadsheet: https://docs.google.com/spreadsheet/ccc?key=0Ak6TA47h_6fwdGZwRE5WWEJBdEhnckpMTG5RcWFjY3c#gid=0 This cleans up the CLI, normalizing commands and arguments, correcting optional and required arguments and flags. * included https://review.openstack.org/4270 here per Brian's request Note that some commands have changed names to conform to noun-verb form: user-update-password -> user-password-update add-user-role -> user-role-add remove-user-role -> user-role-remove ec2-create-credentials -> ec2-credentials-create ec2-list-credentials -> ec2-credentials-list ec2-delete-credentials -> ec2-credentials-delete token -> token-get Change-Id: I8128fa105a1b8002199211f9e475b1a7a6229b8c
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst70
1 files changed, 54 insertions, 16 deletions
diff --git a/README.rst b/README.rst
index 9f26cf9..d14cbc4 100644
--- a/README.rst
+++ b/README.rst
@@ -66,28 +66,66 @@ can specify the one you want with ``--region_name`` (or
You'll find complete documentation on the shell by running
``keystone help``::
- usage: keystone [--username user] [--password password]
- [--tenant_name tenant] [--auth_url URL]
- <subcommand> ...
+ usage: keystone [--username USERNAME] [--password PASSWORD]
+ [--tenant_name TENANT_NAME] [--tenant_id TENANT_ID]
+ [--auth_url AUTH_URL] [--region_name REGION_NAME]
+ [--identity_api_version IDENTITY_API_VERSION] [--token TOKEN]
+ [--endpoint ENDPOINT]
+ <subcommand> ...
Command-line interface to the OpenStack Keystone API.
Positional arguments:
<subcommand>
- add-fixed-ip Add a new fixed IP address to a servers network.
-
+ catalog List service catalog, possibly filtered by service.
+ ec2-credentials-create
+ Create EC2-compatibile credentials for user per tenant
+ ec2-credentials-delete
+ Delete EC2-compatibile credentials
+ ec2-credentials-list
+ List EC2-compatibile credentials for a user
+ endpoint-get Find endpoint filtered by a specific attribute or
+ service type
+ role-create Create new role
+ role-delete Delete role
+ role-get Display role details
+ role-list List all available roles
+ service-create Add service to Service Catalog
+ service-delete Delete service from Service Catalog
+ service-get Display service from Service Catalog
+ service-list List all services in Service Catalog
+ tenant-create Create new tenant
+ tenant-delete Delete tenant
+ tenant-get Display tenant details
+ tenant-list List all tenants
+ tenant-update Update tenant name, description, enabled status
+ token-get Display the current user token
+ user-create Create new user
+ user-delete Delete user
+ user-list List users
+ user-password-update
+ Update user password
+ user-role-add Add role to user
+ user-role-remove Remove role from user
+ user-update Update user's name, email, and enabled status
+ discover Discover Keystone servers and show authentication
+ protocols and
+ help Display help about this program or one of its
+ subcommands.
Optional arguments:
- --username USER Defaults to env[OS_USERNAME].
- --password PASSWORD Defaults to env[OS_PASSWORD].
- --tenant_name TENANT_NAME Defaults to env[OS_TENANT_NAME].
- --tenant_id TENANT_ID Defaults to env[OS_TENANT_ID].
- --url AUTH_URL Defaults to env[OS_AUTH_URL].
+ --username USERNAME Defaults to env[OS_USERNAME]
+ --password PASSWORD Defaults to env[OS_PASSWORD]
+ --tenant_name TENANT_NAME
+ Defaults to env[OS_TENANT_NAME]
+ --tenant_id TENANT_ID
+ Defaults to env[OS_TENANT_ID]
+ --auth_url AUTH_URL Defaults to env[OS_AUTH_URL]
+ --region_name REGION_NAME
+ Defaults to env[OS_REGION_NAME]
--identity_api_version IDENTITY_API_VERSION
- Defaults to env[OS_IDENTITY_API_VERSION] or 2.0.
- --region_name NAME The region name in the Keystone Service
- Catalog to use after authentication.
- Defaults to env[KEYSTONE_REGION_NAME] or the
- first item in the list returned.
+ Defaults to env[OS_IDENTITY_API_VERSION] or 2.0
+ --token TOKEN Defaults to env[SERVICE_TOKEN]
+ --endpoint ENDPOINT Defaults to env[SERVICE_ENDPOINT]
- See "keystone help COMMAND" for help on a specific command.
+See "keystone help COMMAND" for help on a specific command.