The trove client is the command-line interface (CLI) for the Database API and its extensions. This chapter documents trove version 1.0.3. For help on a specific trove command, enter: $ trove help COMMAND

usage: trove [--version] [--debug] [--os-username <auth-user-name>] [--os-password <auth-password>] [--os-tenant-name <auth-tenant-name>] [--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>] [--os-region-name <region-name>] [--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>] [--os-cacert <ca-certificate>] [--retries <retries>] <subcommand> ... backup-create Creates a backup. backup-delete Deletes a backup. backup-list List available backups. backup-list-instance List available backups for an instance. backup-show Show details of a backup. create Creates a new instance. database-create Creates a database on an instance. database-delete Deletes a database. database-list Lists available databases on an instance. delete Deletes an instance. flavor-list Lists available flavors. flavor-show Show details of a flavor. limit-list Lists the limits for a tenant. list List all the instances. resize-flavor Resizes the flavor of an instance. resize-volume Resizes the volume size of an instance. restart Restarts the instance. root-enable Enables root for a instance. root-show Gets root enabled status for a instance. secgroup-add-rule Creates a security group rule. secgroup-delete-rule Deletes a security group rule. secgroup-list Lists all security groups. secgroup-show Shows details about a security group. show Show details of an instance. user-create Creates a user. user-delete Deletes a user from the instance. user-grant-access Grants access to a database(s) for a user. user-list Lists the users for a instance. user-revoke-access Revokes access to a database for a user. user-show Gets a user from the instance. user-show-access Gets a users access from the instance. user-update-attributes Updates a users attributes from the instance. bash-completion Print arguments for bash_completion. help Display help about this program or one of its subcommands.

--version show program's version number and exit --debug Print debugging output --os-username <auth-user-name> Defaults to env[OS_USERNAME]. --os-password <auth-password> Defaults to env[OS_PASSWORD]. --os-tenant-name <auth-tenant-name> Defaults to env[OS_TENANT_NAME]. --os-tenant-id <auth-tenant-id> Defaults to env[OS_TENANT_ID]. --os-auth-url <auth-url> Defaults to env[OS_AUTH_URL]. --os-region-name <region-name> Defaults to env[OS_REGION_NAME]. --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 publicURL. --os-database-api-version <database-api-ver> Accepts 1,defaults to env[OS_DATABASE_API_VERSION]. --os-cacert <ca-certificate> Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to env[OS_CACERT] --retries <retries> Number of retries.

usage: trove backup-create [--description <description>] <name> <instance> Creates a backup. <name> Name of the backup. <instance> UUID of the instance. --description <description> An optional description for the backup.

usage: trove backup-delete <backup> Deletes a backup. <backup> ID of the backup.

usage: trove backup-list List available backups.

usage: trove backup-list-instance <instance> List available backups for an instance. <instance> ID of the instance.

usage: trove backup-show <backup> Show details of a backup. <backup> ID of the backup.

usage: trove create [--size <size>] [--databases <databases> [<databases> ...]] [--users <users> [<users> ...]] [--backup <backup>] [--availability_zone <availability_zone>] <name> <flavor_id> Creates a new instance. <name> Name of the instance <flavor_id> Flavor of the instance --size <size> Size of the instance disk in GB --databases <databases> [<databases> ...] Optional list of databases. --users <users> [<users> ...] Optional list of users in the form user:password. --backup <backup> A backup UUID --availability_zone <availability_zone> The Zone hint to give to nova

usage: trove database-create [--character_set <character_set>] [--collate <collate>] <instance> <name> Creates a database on an instance. <instance> UUID of the instance. <name> Name of the backup. --character_set <character_set> Optional character set for database --collate <collate> Optional collation type for database

usage: trove database-delete <instance> <database> Deletes a database. <instance> UUID of the instance. <database> Name of the database.

usage: trove database-list <instance> Lists available databases on an instance. <instance> UUID of the instance.

usage: trove delete <instance> Deletes an instance. <instance> ID of the instance.

usage: trove flavor-list Lists available flavors.

usage: trove flavor-show <flavor> Show details of a flavor. <flavor> ID of the flavor.

usage: trove limit-list Lists the limits for a tenant.

usage: trove list List all the instances.

usage: trove resize-flavor <instance> <flavor_id> Resizes the flavor of an instance. <instance> UUID of the instance <flavor_id> Flavor of the instance

usage: trove resize-volume <instance> <size> Resizes the volume size of an instance. <instance> UUID of the instance <size> Size of the instance disk in GB

usage: trove restart <instance> Restarts the instance. <instance> UUID of the instance

usage: trove root-enable <instance> Enables root for a instance. <instance> UUID of the instance.

usage: trove root-show <instance> Gets root enabled status for a instance. <instance> UUID of the instance.

usage: trove secgroup-add-rule <security_group> <protocol> <from_port> <to_port> <cidr> Creates a security group rule. <security_group> Security group name <protocol> Protocol <from_port> from port <to_port> to port <cidr> CIDR address

usage: trove secgroup-delete-rule <security_group_rule> Deletes a security group rule. <security_group_rule> Security group rule

usage: trove secgroup-list Lists all security groups.

usage: trove secgroup-show <security_group> Shows details about a security group. <security_group> ID of the security group.

usage: trove show <instance> Show details of an instance. <instance> ID of the instance.

usage: trove user-create [--host <host>] [--databases <databases> [<databases> ...]] <instance> <name> <password> Creates a user. <instance> UUID of the instance. <name> Name of user <password> Password of user --host <host> Optional host of user --databases <databases> [<databases> ...] Optional list of databases.

usage: trove user-delete [--host <host>] <instance> <name> Deletes a user from the instance. <instance> UUID of the instance. <name> Name of user --host <host> Optional host of user

usage: trove user-grant-access [--host <host>] <instance> <name> <databases> [<databases> ...] Grants access to a database(s) for a user. <instance> UUID of the instance. <name> Name of user <databases> List of databases. --host <host> Optional host of user

usage: trove user-list <instance> Lists the users for a instance. <instance> UUID of the instance.

usage: trove user-revoke-access [--host <host>] <instance> <name> <database> Revokes access to a database for a user. <instance> UUID of the instance. <name> Name of user <database> A single database. --host <host> Optional host of user

usage: trove user-show [--host <host>] <instance> <name> Gets a user from the instance. <instance> UUID of the instance. <name> Name of user --host <host> Optional host of user

usage: trove user-show-access [--host <host>] <instance> <name> Gets a users access from the instance. <instance> UUID of the instance. <name> Name of user --host <host> Optional host of user

usage: trove user-update-attributes [--host <host>] [--new_name <new_name>] [--new_password <new_password>] [--new_host <new_host>] <instance> <name> Updates a users attributes from the instance. <instance> UUID of the instance. <name> Name of user --host <host> Optional host of user --new_name <new_name> Optional new name of user --new_password <new_password> Optional new password of user --new_host <new_host> Optional new host of user