openstack/python-troveclient
Code Issues Proposed changes

Update the README.rst with latest help

Browse Source 
The help has substantially changed since the last time the
trove client was published to pypi. Updated the README.rst
with the latest help information.

Closes-Bug: 1366981
Change-Id: I3e2533b4c57f63d20e804c1fca5731fe6a522199
This commit is contained in:
Nikhil Manchanda
2014-09-08 13:04:24 -07:00
parent fa33d6e927
commit e010a91975
1 changed files with 124 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files

134
README.rst
View File

@@ -56,7 +56,6 @@ can specify the one you want with ``--os-region-name`` (or
You'll find complete documentation on the shell by running You'll find complete documentation on the shell by running
``trove help``:: ``trove help``::
usage: trove [--version] [--debug] [--os-username <auth-user-name>] usage: trove [--version] [--debug] [--os-username <auth-user-name>]
[--os-password <auth-password>] [--os-password <auth-password>]
[--os-tenant-name <auth-tenant-name>] [--os-tenant-name <auth-tenant-name>]
@@ -73,110 +72,117 @@ You'll find complete documentation on the shell by running
Positional arguments: Positional arguments:
<subcommand> <subcommand>
backup-copy Creates a backup from another backup.
backup-create Creates a backup of an instance. backup-create Creates a backup of an instance.
backup-delete Deletes a backup. backup-delete Deletes a backup.
backup-list Lists available backups. backup-list Lists available backups.
backup-list-instance backup-list-instance Lists available backups for an instance.
Lists available backups for an instance.
backup-show Shows details of a backup. backup-show Shows details of a backup.
configuration-attach cluster-create Creates a new cluster.
Attaches a configuration group to an instance. cluster-delete Deletes a cluster.
configuration-create cluster-instances Lists all instances of a cluster.
Creates a configuration group. cluster-list Lists all the clusters.
configuration-default cluster-show Shows details of a cluster.
Shows the default configuration of an instance. configuration-attach Attaches a configuration group to an
configuration-delete instance.
Deletes a configuration group. configuration-create Creates a configuration group.
configuration-detach configuration-default Shows the default configuration of an
Detaches a configuration group from an instance. instance.
configuration-instances configuration-delete Deletes a configuration group.
Lists all instances associated with a configuration configuration-detach Detaches a configuration group from an
group. instance.
configuration-instances Lists all instances associated with a
configuration group.
configuration-list Lists all configuration groups. configuration-list Lists all configuration groups.
configuration-parameter-list configuration-parameter-list Lists available parameters for a
Lists available parameters for a configuration group. configuration group.
configuration-parameter-show configuration-parameter-show Shows details of a configuration parameter.
Shows details of a configuration parameter. configuration-patch Patches a configuration group.
configuration-patch
Patches a configuration group.
configuration-show Shows details of a configuration group. configuration-show Shows details of a configuration group.
configuration-update configuration-update Updates a configuration group.
Updates a configuration group.
create Creates a new instance. create Creates a new instance.
database-create Creates a database on an instance. database-create Creates a database on an instance.
database-delete Deletes a database from an instance. database-delete Deletes a database from an instance.
database-list Lists available databases on an instance. database-list Lists available databases on an instance.
datastore-list Lists available datastores. datastore-list Lists available datastores.
datastore-show Shows details of a datastore. datastore-show Shows details of a datastore.
datastore-version-list datastore-version-list Lists available versions for a datastore.
Lists available versions for a datastore. datastore-version-show Shows details of a datastore version.
datastore-version-show
Shows details of a datastore version.
delete Deletes an instance. delete Deletes an instance.
detach-replica Detaches a replica instance from its
replication source.
flavor-list Lists available flavors. flavor-list Lists available flavors.
flavor-show Shows details of a flavor. flavor-show Shows details of a flavor.
limit-list Lists the limits for a tenant. limit-list Lists the limits for a tenant.
list Lists all the instances. list Lists all the instances.
resize-flavor Resizes the flavor of an instance. metadata-create Creates metadata in the database for
instance <id>.
metadata-delete Deletes metadata for instance <id>.
metadata-edit Replaces metadata value with a new one, this
is non-destructive.
metadata-list Shows all metadata for instance <id>.
metadata-show Shows metadata entry for key <key> and
instance <id>.
metadata-update Updates metadata, this is destructive.
resize-flavor [DEPRECATED] Please use resize-instance
instead.
resize-instance Resizes an instance with a new flavor.
resize-volume Resizes the volume size of an instance. resize-volume Resizes the volume size of an instance.
restart Restarts an instance. restart Restarts an instance.
root-enable Enables root for an instance and resets if already exists. root-enable Enables root for an instance and resets if
root-show Gets status if root was ever enabled for an instance. already exists.
root-show Gets status if root was ever enabled for an
instance.
secgroup-add-rule Creates a security group rule. secgroup-add-rule Creates a security group rule.
secgroup-delete-rule secgroup-delete-rule Deletes a security group rule.
Deletes a security group rule.
secgroup-list-rules Lists all rules for a security group.
secgroup-list Lists all security groups. secgroup-list Lists all security groups.
secgroup-list-rules Lists all rules for a security group.
secgroup-show Shows details of a security group. secgroup-show Shows details of a security group.
show Shows details of an instance. show Shows details of an instance.
update Updates an instance: Edits name,
configuration, or replica source.
user-create Creates a user on an instance. user-create Creates a user on an instance.
user-delete Deletes a user from an instance. user-delete Deletes a user from an instance.
user-grant-access Grants access to a database(s) for a user. user-grant-access Grants access to a database(s) for a user.
user-list Lists the users for an instance. user-list Lists the users for an instance.
user-revoke-access Revokes access to a database for a user. user-revoke-access Revokes access to a database for a user.
user-show Shows details of a user of an instance. user-show Shows details of a user of an instance.
user-show-access Shows access details of a user of an instance. user-show-access Shows access details of a user of an
user-update-attributes instance.
Updates a user's attributes on an instance. user-update-attributes Updates a user's attributes on an instance.
bash-completion Prints arguments for bash_completion. bash-completion Prints arguments for bash_completion.
help Displays help about this program or one of its help Displays help about this program or one of
subcommands. its subcommands.
Optional arguments: Optional arguments:
--version show program's version number and exit --version Show program's version number and exit
--debug Print debugging output. --debug Print debugging output.
--os-username <auth-user-name> --os-username <auth-user-name> Defaults to env[OS_USERNAME].
Defaults to env[OS_USERNAME]. --os-password <auth-password> Defaults to env[OS_PASSWORD].
--os-password <auth-password>
Defaults to env[OS_PASSWORD].
--os-tenant-name <auth-tenant-name> --os-tenant-name <auth-tenant-name>
Defaults to env[OS_TENANT_NAME]. Defaults to env[OS_TENANT_NAME].
--os-tenant-id <auth-tenant-id> --os-tenant-id <auth-tenant-id>
Defaults to env[OS_TENANT_ID]. Defaults to env[OS_TENANT_ID].
--os-auth-url <auth-url> --os-auth-url <auth-url> Defaults to env[OS_AUTH_URL].
Defaults to env[OS_AUTH_URL]. --os-region-name <region-name> Defaults to env[OS_REGION_NAME].
--os-region-name <region-name> --service-type <service-type> Defaults to database for most actions.
Defaults to env[OS_REGION_NAME]. --service-name <service-name> Defaults to env[TROVE_SERVICE_NAME].
--service-type <service-type> --bypass-url <bypass-url> Defaults to env[TROVE_BYPASS_URL].
Defaults to database for most actions.
--service-name <service-name>
Defaults to env[TROVE_SERVICE_NAME].
--bypass-url <bypass-url>
Defaults to env[TROVE_BYPASS_URL].
--database-service-name <database-service-name> --database-service-name <database-service-name>
Defaults to env[TROVE_DATABASE_SERVICE_NAME]. Defaults to
env[TROVE_DATABASE_SERVICE_NAME].
--endpoint-type <endpoint-type> --endpoint-type <endpoint-type>
Defaults to env[TROVE_ENDPOINT_TYPE] or publicURL. Defaults to env[TROVE_ENDPOINT_TYPE] or
publicURL.
--os-database-api-version <database-api-ver> --os-database-api-version <database-api-ver>
Accepts 1, defaults to env[OS_DATABASE_API_VERSION]. Accepts 1, defaults to
--os-cacert <ca-certificate> env[OS_DATABASE_API_VERSION].
Specify a CA bundle file to use in verifying a TLS --os-cacert <ca-certificate> Specify a CA bundle file to use in verifying
(https) server certificate. Defaults to a TLS (https) server certificate. Defaults
env[OS_CACERT]. to env[OS_CACERT].
--retries <retries> Number of retries. --retries <retries> Number of retries.
--json, --os-json-output --json, --os-json-output Output JSON instead of prettyprint. Defaults
Output JSON instead of prettyprint. Defaults to to env[OS_JSON_OUTPUT].
env[OS_JSON_OUTPUT].
Python API Python API
---------- ----------