The trove client is the command-line interface (CLI) for the Database service API and its extensions.
This chapter documents trove version 2.2.0.
For help on a specific trove command, enter:
$ trove help COMMAND
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> ...
Subcommands:
usage: trove backup-copy <name> <backup>
[--region <region>] [--description <description>]
Creates a backup from another backup.
Positional arguments:
Optional arguments:
usage: trove backup-create <instance> <name>
[--description <description>] [--parent <parent>]
Creates a backup of an instance.
Positional arguments:
Optional arguments:
usage: trove backup-delete <backup>
Deletes a backup.
Positional arguments:
usage: trove backup-list [--limit <limit>] [--marker <ID>]
[--datastore <datastore>]
Lists available backups.
Optional arguments:
usage: trove backup-list-instance [--limit <limit>] [--marker <ID>] <instance>
Lists available backups for an instance.
Positional arguments:
Optional arguments:
usage: trove backup-show <backup>
Shows details of a backup.
Positional arguments:
usage: trove cluster-create <name> <datastore> <datastore_version>
[--instance "opt=<value>[,opt=<value> ...] "]
Creates a new cluster.
Positional arguments:
Optional arguments:
usage: trove cluster-delete <cluster>
Deletes a cluster.
Positional arguments:
usage: trove cluster-grow <cluster>
[--instance "opt=<value>[,opt=<value> ...] "]
Adds more instances to a cluster.
Positional arguments:
Optional arguments:
usage: trove cluster-instances <cluster>
Lists all instances of a cluster.
Positional arguments:
usage: trove cluster-list [--limit <limit>] [--marker <ID>]
Lists all the clusters.
Optional arguments:
usage: trove cluster-modules <cluster>
Lists all modules for each instance of a cluster.
Positional arguments:
usage: trove cluster-show <cluster>
Shows details of a cluster.
Positional arguments:
usage: trove cluster-shrink <cluster> <instance> [<instance> ...]
Drops instances from a cluster.
Positional arguments:
usage: trove configuration-attach <instance> <configuration>
Attaches a configuration group to an instance.
Positional arguments:
usage: trove configuration-create <name> <values>
[--datastore <datastore>]
[--datastore_version <datastore_version>]
[--description <description>]
Creates a configuration group.
Positional arguments:
Optional arguments:
usage: trove configuration-default <instance>
Shows the default configuration of an instance.
Positional arguments:
usage: trove configuration-delete <configuration_group>
Deletes a configuration group.
Positional arguments:
usage: trove configuration-detach <instance>
Detaches a configuration group from an instance.
Positional arguments:
usage: trove configuration-instances <configuration_group>
Lists all instances associated with a configuration group.
Positional arguments:
usage: trove configuration-parameter-list <datastore_version>
[--datastore <datastore>]
Lists available parameters for a configuration group.
Positional arguments:
Optional arguments:
usage: trove configuration-parameter-show <datastore_version> <parameter>
[--datastore <datastore>]
Shows details of a configuration parameter.
Positional arguments:
Optional arguments:
usage: trove configuration-patch <configuration_group> <values>
Patches a configuration group.
Positional arguments:
usage: trove configuration-show <configuration_group>
Shows details of a configuration group.
Positional arguments:
usage: trove configuration-update <configuration_group> <values>
[--name <name>]
[--description <description>]
Updates a configuration group.
Positional arguments:
Optional arguments:
usage: trove create <name> <flavor>
[--size <size>] [--volume_type <volume_type>]
[--databases <database> [<database> ...]]
[--users <user:password> [<user:password> ...]]
[--backup <backup>]
[--availability_zone <availability_zone>]
[--datastore <datastore>]
[--datastore_version <datastore_version>]
[--nic <net-id=<net-uuid>,v4-fixed-ip=<ip-addr>,port-id=<port-uuid>>]
[--configuration <configuration>]
[--replica_of <source_instance>] [--replica_count <count>]
[--module <module>]
Creates a new instance.
Positional arguments:
Optional arguments:
usage: trove database-create <instance> <name>
[--character_set <character_set>]
[--collate <collate>]
Creates a database on an instance.
Positional arguments:
Optional arguments:
usage: trove database-delete <instance> <database>
Deletes a database from an instance.
Positional arguments:
usage: trove database-list <instance>
Lists available databases on an instance.
Positional arguments:
usage: trove datastore-show <datastore>
Shows details of a datastore.
Positional arguments:
usage: trove datastore-version-list <datastore>
Lists available versions for a datastore.
Positional arguments:
usage: trove datastore-version-show <datastore_version>
[--datastore <datastore>]
Shows details of a datastore version.
Positional arguments:
Optional arguments:
usage: trove delete <instance>
Deletes an instance.
Positional arguments:
usage: trove detach-replica <instance>
Detaches a replica instance from its replication source.
Positional arguments:
usage: trove eject-replica-source <instance>
Ejects a replica source from its set.
Positional arguments:
usage: trove flavor-list [--datastore_type <datastore_type>]
[--datastore_version_id <datastore_version_id>]
Lists available flavors.
Optional arguments:
usage: trove flavor-show <flavor>
Shows details of a flavor.
Positional arguments:
usage: trove list [--limit <limit>] [--marker <ID>] [--include_clustered]
Lists all the instances.
Optional arguments:
usage: trove log-disable [--discard] <instance> <log_name>
Instructs Trove guest to stop collecting log details.
Positional arguments:
Optional arguments:
usage: trove log-discard <instance> <log_name>
Instructs Trove guest to discard the container of the published log.
Positional arguments:
usage: trove log-enable <instance> <log_name>
Instructs Trove guest to start collecting log details.
Positional arguments:
usage: trove log-list <instance>
Lists the log files available for instance.
Positional arguments:
usage: trove log-publish [--disable] [--discard] <instance> <log_name>
Instructs Trove guest to publish latest log entries on instance.
Positional arguments:
Optional arguments:
usage: trove log-save [--publish] [--file <file>] <instance> <log_name>
Save log file for instance.
Positional arguments:
Optional arguments:
usage: trove log-show <instance> <log_name>
Instructs Trove guest to show details of log.
Positional arguments:
usage: trove log-tail [--publish] [--lines <lines>] <instance> <log_name>
Display log entries for instance.
Positional arguments:
Optional arguments:
usage: trove metadata-create <instance_id> <key> <value>
Creates metadata in the database for instance <id>.
Positional arguments:
usage: trove metadata-delete <instance_id> <key>
Deletes metadata for instance <id>.
Positional arguments:
usage: trove metadata-edit <instance_id> <key> <value>
Replaces metadata value with a new one, this is non-destructive.
Positional arguments:
usage: trove metadata-list <instance_id>
Shows all metadata for instance <id>.
Positional arguments:
usage: trove metadata-show <instance_id> <key>
Shows metadata entry for key <key> and instance <id>.
Positional arguments:
usage: trove metadata-update <instance_id> <key> <newkey> <value>
Updates metadata, this is destructive.
Positional arguments:
usage: trove module-apply <instance> <module> [<module> ...]
Apply modules to an instance.
Positional arguments:
usage: trove module-create <name> <type> <filename>
[--description <description>]
[--datastore <datastore>]
[--datastore_version <version>] [--auto_apply]
[--all_tenants] [--live_update]
Create a module.
Positional arguments:
Optional arguments:
usage: trove module-delete <module>
Delete a module.
Positional arguments:
usage: trove module-instances <module>
[--include_clustered] [--limit <limit>]
[--marker <ID>]
Lists the instances that have a particular module applied.
Positional arguments:
Optional arguments:
usage: trove module-list [--datastore <datastore>]
Lists the modules available.
Optional arguments:
usage: trove module-list-instance <instance>
Lists the modules that have been applied to an instance.
Positional arguments:
usage: trove module-query <instance>
Query the status of the modules on an instance.
Positional arguments:
usage: trove module-remove <instance> <module>
Remove a module from an instance.
Positional arguments:
usage: trove module-retrieve <instance>
[--directory <directory>]
[--prefix <filename_prefix>]
Retrieve module contents from an instance.
Positional arguments:
Optional arguments:
usage: trove module-show <module>
Shows details of a module.
Positional arguments:
usage: trove module-update <module>
[--name <name>] [--type <type>] [--file <filename>]
[--description <description>]
[--datastore <datastore>] [--all_datastores]
[--datastore_version <version>]
[--all_datastore_versions] [--auto_apply]
[--no_auto_apply] [--all_tenants]
[--no_all_tenants] [--live_update]
[--no_live_update]
Update a module.
Positional arguments:
Optional arguments:
usage: trove promote-to-replica-source <instance>
Promotes a replica to be the new replica source of its set.
Positional arguments:
usage: trove resize-instance <instance> <flavor>
Resizes an instance with a new flavor.
Positional arguments:
usage: trove resize-volume <instance> <size>
Resizes the volume size of an instance.
Positional arguments:
usage: trove restart <instance>
Restarts an instance.
Positional arguments:
usage: trove root-disable <instance>
Disables root for an instance.
Positional arguments:
usage: trove root-enable <instance_or_cluster>
[--root_password <root_password>]
Enables root for an instance and resets if already exists.
Positional arguments:
Optional arguments:
usage: trove root-show <instance_or_cluster>
Gets status if root was ever enabled for an instance or cluster.
Positional arguments:
usage: trove secgroup-add-rule <security_group> <cidr>
Creates a security group rule.
Positional arguments:
usage: trove secgroup-delete-rule <security_group_rule>
Deletes a security group rule.
Positional arguments:
usage: trove secgroup-list-rules <security_group>
Lists all rules for a security group.
Positional arguments:
usage: trove secgroup-show <security_group>
Shows details of a security group.
Positional arguments:
usage: trove show <instance>
Shows details of an instance.
Positional arguments:
usage: trove update <instance>
[--name <name>] [--configuration <configuration>]
[--detach_replica_source] [--remove_configuration]
Updates an instance: Edits name, configuration, or replica source.
Positional arguments:
Optional arguments:
usage: trove user-create <instance> <name> <password>
[--host <host>]
[--databases <databases> [<databases> ...]]
Creates a user on an instance.
Positional arguments:
Optional arguments:
usage: trove user-delete [--host <host>] <instance> <name>
Deletes a user from an instance.
Positional arguments:
Optional arguments:
usage: trove user-grant-access <instance> <name> <databases> [<databases> ...]
[--host <host>]
Grants access to a database(s) for a user.
Positional arguments:
Optional arguments:
usage: trove user-list <instance>
Lists the users for an instance.
Positional arguments:
usage: trove user-revoke-access [--host <host>] <instance> <name> <database>
Revokes access to a database for a user.
Positional arguments:
Optional arguments:
usage: trove user-show [--host <host>] <instance> <name>
Shows details of a user of an instance.
Positional arguments:
Optional arguments:
usage: trove user-show-access [--host <host>] <instance> <name>
Shows access details of a user of an instance.
Positional arguments:
Optional arguments:
usage: trove user-update-attributes <instance> <name>
[--host <host>] [--new_name <new_name>]
[--new_password <new_password>]
[--new_host <new_host>]
Updates a user’s attributes on an instance. At least one optional argument must be provided.
Positional arguments:
Optional arguments:
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.