summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorjiansong <jian.song@easystack.cn>2016-09-28 00:07:08 -0700
committerjiansong <jian.song@easystack.cn>2016-09-28 01:52:37 -0700
commit8b27e7f1c63987d2c8e229685b3b4c8e131daca5 (patch)
tree2dfd0b6f093d3c85672cf792e787483223c24a9c /README.rst
parent010cf7b93f101d517e5b4fd63b5d1b2b6f9837df (diff)
downloadpython-troveclient-8b27e7f1c63987d2c8e229685b3b4c8e131daca5.tar.gz
Add a new command in the readme
With https://review.openstack.org/#/c/343927/ merge, We have two new commands are reset-status and the force-delete, but the existing readme and there is not have this two commands,Look this readme shows that some out of date, so need to be updated Change-Id: Idde08fd0ae2e42dab209d38bc0225683c5fa1922
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst434
1 files changed, 231 insertions, 203 deletions
diff --git a/README.rst b/README.rst
index 13777f9..4bd0139 100644
--- a/README.rst
+++ b/README.rst
@@ -79,216 +79,244 @@ Argument ``--profile`` is available only when the osprofiler lib is installed.
You'll find complete documentation on the shell by running
``trove help``::
- usage: trove [--version] [--debug] [--os-auth-system <auth-system>]
- [--service-type <service-type>] [--service-name <service-name>]
- [--bypass-url <bypass-url>]
- [--database-service-name <database-service-name>]
- [--endpoint-type <endpoint-type>]
- [--os-database-api-version <database-api-ver>]
- [--retries <retries>] [--json] [--profile HMAC_KEY] [--insecure]
- [--os-cacert <ca-certificate>] [--os-cert <certificate>]
- [--os-key <key>] [--timeout <seconds>]
- [--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID]
- [--os-domain-name OS_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID]
- [--os-project-name OS_PROJECT_NAME]
- [--os-project-domain-id OS_PROJECT_DOMAIN_ID]
- [--os-project-domain-name OS_PROJECT_DOMAIN_NAME]
- [--os-trust-id OS_TRUST_ID] [--os-user-id OS_USER_ID]
- [--os-username OS_USERNAME]
- [--os-user-domain-id OS_USER_DOMAIN_ID]
- [--os-user-domain-name OS_USER_DOMAIN_NAME]
- [--os-password OS_PASSWORD] [--os-tenant-name <auth-tenant-name>]
- [--os-tenant-id <tenant-id>] [--os-auth-token OS_AUTH_TOKEN]
- [--os-region-name <region-name>]
- <subcommand> ...
+ usage: trove [--version] [--debug] [--service-type <service-type>]
+ [--service-name <service-name>] [--bypass-url <bypass-url>]
+ [--database-service-name <database-service-name>]
+ [--endpoint-type <endpoint-type>]
+ [--os-database-api-version <database-api-ver>]
+ [--retries <retries>] [--json] [--profile HMAC_KEY] [--insecure]
+ [--os-cacert <ca-certificate>] [--os-cert <certificate>]
+ [--os-key <key>] [--timeout <seconds>] [--os-auth-type <name>]
+ [--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID]
+ [--os-domain-name OS_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID]
+ [--os-project-name OS_PROJECT_NAME]
+ [--os-project-domain-id OS_PROJECT_DOMAIN_ID]
+ [--os-project-domain-name OS_PROJECT_DOMAIN_NAME]
+ [--os-trust-id OS_TRUST_ID]
+ [--os-default-domain-id OS_DEFAULT_DOMAIN_ID]
+ [--os-default-domain-name OS_DEFAULT_DOMAIN_NAME]
+ [--os-user-id OS_USER_ID] [--os-username OS_USERNAME]
+ [--os-user-domain-id OS_USER_DOMAIN_ID]
+ [--os-user-domain-name OS_USER_DOMAIN_NAME]
+ [--os-password OS_PASSWORD] [--os-region-name <region-name>]
+ <subcommand> ...
Command-line interface to the OpenStack Trove API.
Positional arguments:
- <subcommand>
- backup-copy Creates a backup from another backup.
- backup-create Creates a backup of an instance.
- backup-delete Deletes a backup.
- backup-list Lists available backups.
- backup-list-instance Lists available backups for an instance.
- backup-show Shows details of a backup.
- cluster-create Creates a new cluster.
- cluster-delete Deletes a cluster.
- cluster-grow Adds more instances to a cluster.
- cluster-instances Lists all instances of a cluster.
- cluster-list Lists all the clusters.
- cluster-modules Lists all modules for each instance of a
- cluster.
- cluster-show Shows details of a cluster.
- cluster-shrink Drops instances from a cluster.
- configuration-attach Attaches a configuration group to an
- instance.
- configuration-create Creates a configuration group.
- configuration-default Shows the default configuration of an
- instance.
- configuration-delete Deletes a configuration group.
- configuration-detach Detaches a configuration group from an
- instance.
- configuration-instances Lists all instances associated with a
- configuration group.
- configuration-list Lists all configuration groups.
- configuration-parameter-list Lists available parameters for a
- configuration group.
- configuration-parameter-show Shows details of a configuration parameter.
- configuration-patch Patches a configuration group.
- configuration-show Shows details of a configuration group.
- configuration-update Updates a configuration group.
- create Creates a new instance.
- database-create Creates a database on an instance.
- database-delete Deletes a database from an instance.
- database-list Lists available databases on an instance.
- datastore-list Lists available datastores.
- datastore-show Shows details of a datastore.
- datastore-version-list Lists available versions for a datastore.
- datastore-version-show Shows details of a datastore version.
- delete Deletes an instance.
- detach-replica Detaches a replica instance from its
- replication source.
- eject-replica-source Ejects a replica source from its set.
- flavor-list Lists available flavors.
- flavor-show Shows details of a flavor.
- limit-list Lists the limits for a tenant.
- list Lists all the instances.
- log-disable Instructs Trove guest to stop collecting log
- details.
- log-discard Instructs Trove guest to discard the
- container of the published log.
- log-enable Instructs Trove guest to start collecting
- log details.
- log-list Lists the log files available for instance.
- log-publish Instructs Trove guest to publish latest log
- entries on instance.
- log-save Save log file for instance.
- log-show Instructs Trove guest to show details of
- log.
- log-tail Display log entries for 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.
- module-apply Apply modules to an instance.
- module-create Create a module.
- module-delete Delete a module.
- module-instances Lists the instances that have a particular
- module applied.
- module-list Lists the modules available.
- module-list-instance Lists the modules that have been applied to
- an instance.
- module-query Query the status of the modules on an
- instance.
- module-remove Remove a module from an instance.
- module-retrieve Retrieve module contents from an instance.
- module-show Shows details of a module.
- module-update Update a module.
- promote-to-replica-source Promotes a replica to be the new replica
- source of its set.
- resize-instance Resizes an instance with a new flavor.
- resize-volume Resizes the volume size of an instance.
- restart Restarts an instance.
- root-disable Disables root for an instance.
- root-enable Enables root for an instance and resets if
- already exists.
- root-show Gets status if root was ever enabled for an
- instance or cluster.
- secgroup-add-rule Creates a security group rule.
- secgroup-delete-rule Deletes a security group rule.
- secgroup-list Lists all security groups.
- secgroup-list-rules Lists all rules for a security group.
- secgroup-show Shows details of a security group.
- 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-delete Deletes a user from an instance.
- user-grant-access Grants access to a database(s) for a user.
- user-list Lists the users for an instance.
- user-revoke-access Revokes access to a database for a user.
- user-show Shows details of a user of an instance.
- user-show-access Shows access details of a user of an
- instance.
- user-update-attributes Updates a user's attributes on an instance.
- bash-completion Prints arguments for bash_completion.
- help Displays help about this program or one of
- its subcommands.
+ <subcommand>
+ backup-copy Creates a backup from another backup.
+ backup-create Creates a backup of an instance.
+ backup-delete Deletes a backup.
+ backup-list Lists available backups.
+ backup-list-instance Lists available backups for an instance.
+ backup-show Shows details of a backup.
+ cluster-create Creates a new cluster.
+ cluster-delete Deletes a cluster.
+ cluster-force-delete Force delete a cluster
+ cluster-grow Adds more instances to a cluster.
+ cluster-instances Lists all instances of a cluster.
+ cluster-list Lists all the clusters.
+ cluster-modules Lists all modules for each instance of a
+ cluster.
+ cluster-reset-status Set the cluster task to NONE.
+ cluster-show Shows details of a cluster.
+ cluster-shrink Drops instances from a cluster.
+ configuration-attach Attaches a configuration group to an
+ instance.
+ configuration-create Creates a configuration group.
+ configuration-default Shows the default configuration of an
+ instance.
+ configuration-delete Deletes a configuration group.
+ configuration-detach Detaches a configuration group from an
+ instance.
+ configuration-instances Lists all instances associated with a
+ configuration group.
+ configuration-list Lists all configuration groups.
+ configuration-parameter-list Lists available parameters for a
+ configuration group.
+ configuration-parameter-show Shows details of a configuration parameter.
+ configuration-patch Patches a configuration group.
+ configuration-show Shows details of a configuration group.
+ configuration-update Updates a configuration group.
+ create Creates a new instance.
+ database-create Creates a database on an instance.
+ database-delete Deletes a database from an instance.
+ database-list Lists available databases on an instance.
+ datastore-list Lists available datastores.
+ datastore-show Shows details of a datastore.
+ datastore-version-list Lists available versions for a datastore.
+ datastore-version-show Shows details of a datastore version.
+ delete Deletes an instance.
+ detach-replica Detaches a replica instance from its
+ replication source.
+ eject-replica-source Ejects a replica source from its set.
+ execution-delete Deletes an execution.
+ execution-list Lists executions of a scheduled backup of an
+ instance.
+ flavor-list Lists available flavors.
+ flavor-show Shows details of a flavor.
+ force-delete Force delete an instance.
+ limit-list Lists the limits for a tenant.
+ list Lists all the instances.
+ log-disable Instructs Trove guest to stop collecting log
+ details.
+ log-discard Instructs Trove guest to discard the
+ container of the published log.
+ log-enable Instructs Trove guest to start collecting
+ log details.
+ log-list Lists the log files available for instance.
+ log-publish Instructs Trove guest to publish latest log
+ entries on instance.
+ log-save Save log file for instance.
+ log-show Instructs Trove guest to show details of
+ log.
+ log-tail Display log entries for 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.
+ module-apply Apply modules to an instance.
+ module-create Create a module.
+ module-delete Delete a module.
+ module-instances Lists the instances that have a particular
+ module applied.
+ module-list Lists the modules available.
+ module-list-instance Lists the modules that have been applied to
+ an instance.
+ module-query Query the status of the modules on an
+ instance.
+ module-remove Remove a module from an instance.
+ module-retrieve Retrieve module contents from an instance.
+ module-show Shows details of a module.
+ module-update Update a module.
+ promote-to-replica-source Promotes a replica to be the new replica
+ source of its set.
+ quota-show Show quotas for a tenant.
+ quota-update Update quotas for a tenant.
+ reset-status Set the status to NONE.
+ resize-instance Resizes an instance with a new flavor.
+ resize-volume Resizes the volume size of an instance.
+ restart Restarts an instance.
+ root-disable Disables root for an instance.
+ root-enable Enables root for an instance and resets if
+ already exists.
+ root-show Gets status if root was ever enabled for an
+ instance or cluster.
+ schedule-create Schedules backups for an instance.
+ schedule-delete Deletes a schedule.
+ schedule-list Lists scheduled backups for an instance.
+ schedule-show Shows details of a schedule.
+ secgroup-add-rule Creates a security group rule.
+ secgroup-delete-rule Deletes a security group rule.
+ secgroup-list Lists all security groups.
+ secgroup-list-rules Lists all rules for a security group.
+ secgroup-show Shows details of a security group.
+ show Shows details of an instance.
+ update Updates an instance: Edits name,
+ configuration, or replica source.
+ upgrade Upgrades an instance to a new datastore
+ version.
+ user-create Creates a user on an instance.
+ user-delete Deletes a user from an instance.
+ user-grant-access Grants access to a database(s) for a user.
+ user-list Lists the users for an instance.
+ user-revoke-access Revokes access to a database for a user.
+ user-show Shows details of a user of an instance.
+ user-show-access Shows access details of a user of an
+ instance.
+ user-update-attributes Updates a user's attributes on an instance.
+ bash-completion Prints arguments for bash_completion.
+ help Displays help about this program or one of
+ its subcommands.
Optional arguments:
- --version Show program's version number and exit.
- --debug Print debugging output.
- --os-auth-system <auth-system> Defaults to env[OS_AUTH_SYSTEM].
- --service-type <service-type> 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>
- Defaults to
- env[TROVE_DATABASE_SERVICE_NAME].
- --endpoint-type <endpoint-type>
- Defaults to env[TROVE_ENDPOINT_TYPE] or
- env[OS_ENDPOINT_TYPE] or publicURL.
- --os-database-api-version <database-api-ver>
- Accepts 1, defaults to
- env[OS_DATABASE_API_VERSION].
- --retries <retries> Number of retries.
- --json, --os-json-output Output JSON instead of prettyprint. Defaults
- to env[OS_JSON_OUTPUT].
- --profile HMAC_KEY HMAC key used to encrypt context data when
- profiling the performance of an operation.
- This key should be set to one of the HMAC
- keys configured in Trove (they are found in
- api-paste.ini, typically in /etc/trove).
- Without the key, profiling will not be
- triggered even if it is enabled on the
- server side. Defaults to
- env[OS_PROFILE_HMACKEY].
- --insecure 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.
- --os-cacert <ca-certificate> Specify a CA bundle file to use in verifying
- a TLS (https) server certificate. Defaults
- to env[OS_CACERT].
- --os-cert <certificate> Defaults to env[OS_CERT].
- --os-key <key> Defaults to env[OS_KEY].
- --timeout <seconds> Set request timeout (in seconds).
- --os-auth-url OS_AUTH_URL Authentication URL
- --os-domain-id OS_DOMAIN_ID Domain ID to scope to
- --os-domain-name OS_DOMAIN_NAME
- Domain name to scope to
- --os-project-id OS_PROJECT_ID Project ID to scope to
- --os-project-name OS_PROJECT_NAME
- Project name to scope to
- --os-project-domain-id OS_PROJECT_DOMAIN_ID
- Domain ID containing project
- --os-project-domain-name OS_PROJECT_DOMAIN_NAME
- Domain name containing project
- --os-trust-id OS_TRUST_ID Trust ID
- --os-user-id OS_USER_ID User ID
- --os-username OS_USERNAME, --os-user_name OS_USERNAME
- Username
- --os-user-domain-id OS_USER_DOMAIN_ID
- User's domain id
- --os-user-domain-name OS_USER_DOMAIN_NAME
- User's domain name
- --os-password OS_PASSWORD User's password
- --os-tenant-name <auth-tenant-name>
- Tenant to request authorization on. Defaults
- to env[OS_TENANT_NAME].
- --os-tenant-id <tenant-id> Tenant to request authorization on. Defaults
- to env[OS_TENANT_ID].
- --os-auth-token OS_AUTH_TOKEN Defaults to env[OS_AUTH_TOKEN]
- --os-region-name <region-name> Specify the region to use. Defaults to
- env[OS_REGION_NAME].
+ --version Show program's version number and exit.
+ --debug Print debugging output.
+ --service-type <service-type> 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>
+ Defaults to
+ env[TROVE_DATABASE_SERVICE_NAME].
+ --endpoint-type <endpoint-type>
+ Defaults to env[TROVE_ENDPOINT_TYPE] or
+ env[OS_ENDPOINT_TYPE] or publicURL.
+ --os-database-api-version <database-api-ver>
+ Accepts 1, defaults to
+ env[OS_DATABASE_API_VERSION].
+ --retries <retries> Number of retries.
+ --json, --os-json-output Output JSON instead of prettyprint. Defaults
+ to env[OS_JSON_OUTPUT].
+ --profile HMAC_KEY HMAC key used to encrypt context data when
+ profiling the performance of an operation.
+ This key should be set to one of the HMAC
+ keys configured in Trove (they are found in
+ api-paste.ini, typically in /etc/trove).
+ Without the key, profiling will not be
+ triggered even if it is enabled on the
+ server side. Defaults to
+ env[OS_PROFILE_HMACKEY].
+ --os-auth-type <name>, --os-auth-plugin <name>
+ Authentication type to use
+ --os-region-name <region-name> Specify the region to use. Defaults to
+ env[OS_REGION_NAME].
+ API Connection Options:
+ Options controlling the HTTP API Connections
+
+ --insecure 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.
+ --os-cacert <ca-certificate> Specify a CA bundle file to use in verifying
+ a TLS (https) server certificate. Defaults
+ to env[OS_CACERT].
+ --os-cert <certificate> Defaults to env[OS_CERT].
+ --os-key <key> Defaults to env[OS_KEY].
+ --timeout <seconds> Set request timeout (in seconds).
+
+ Authentication Options:
+ Options specific to the password plugin.
+
+ --os-auth-url OS_AUTH_URL Authentication URL
+ --os-domain-id OS_DOMAIN_ID Domain ID to scope to
+ --os-domain-name OS_DOMAIN_NAME
+ Domain name to scope to
+ --os-project-id OS_PROJECT_ID, --os-tenant-id OS_PROJECT_ID
+ Project ID to scope to
+ --os-project-name OS_PROJECT_NAME, --os-tenant-name OS_PROJECT_NAME
+ Project name to scope to
+ --os-project-domain-id OS_PROJECT_DOMAIN_ID
+ Domain ID containing project
+ --os-project-domain-name OS_PROJECT_DOMAIN_NAME
+ Domain name containing project
+ --os-trust-id OS_TRUST_ID Trust ID
+ --os-default-domain-id OS_DEFAULT_DOMAIN_ID
+ Optional domain ID to use with v3 and v2
+ parameters. It will be used for both the
+ user and project domain in v3 and ignored in
+ v2 authentication.
+ --os-default-domain-name OS_DEFAULT_DOMAIN_NAME
+ Optional domain name to use with v3 API and
+ v2 parameters. It will be used for both the
+ user and project domain in v3 and ignored in
+ v2 authentication.
+ --os-user-id OS_USER_ID User id
+ --os-username OS_USERNAME, --os-user-name OS_USERNAME
+ Username
+ --os-user-domain-id OS_USER_DOMAIN_ID
+ User's domain id
+ --os-user-domain-name OS_USER_DOMAIN_NAME
+ User's domain name
+ --os-password OS_PASSWORD User's password
+
See "trove help COMMAND" for help on a specific command.