Database service command-line client¶

trove backup-copy¶

usage: trove backup-copy <name> <backup>
                         [--region <region>] [--description <description>]

Creates a backup from another backup.

Positional arguments:

<name>

Name of the backup.

<backup>

Backup ID of the source backup.

Optional arguments:

--region <region>

Region where the source backup resides.

--description <description>

An optional description for the backup.

trove backup-create¶

usage: trove backup-create <instance> <name>
                           [--description <description>] [--parent <parent>]
                           [--incremental]

Creates a backup of an instance.

Positional arguments:

<instance>

ID or name of the instance.

<name>

Name of the backup.

Optional arguments:

--description <description>

An optional description for the backup.

--parent <parent>

Optional ID of the parent backup to perform an incremental backup from.

--incremental

Create an incremental backup based on the last full or incremental backup. It will create a full backup if no existing backup found.

trove backup-delete¶

usage: trove backup-delete <backup>

Deletes a backup.

Positional arguments:

<backup>

ID or name of the backup.

trove backup-list¶

usage: trove backup-list [--limit <limit>] [--marker <ID>]
                         [--datastore <datastore>]

Lists available backups.

Optional arguments:

--limit <limit>

Return up to N number of the most recent backups.

--marker <ID>

Begin displaying the results for IDs greater than the specified marker. When used with --limit, set this to the last ID displayed in the previous run.

--datastore <datastore>

ID or name of the datastore (to filter backups by).

trove backup-list-instance¶

usage: trove backup-list-instance [--limit <limit>] [--marker <ID>] <instance>

Lists available backups for an instance.

Positional arguments:

<instance>

ID or name of the instance.

Optional arguments:

--limit <limit>

Return up to N number of the most recent backups.

--marker <ID>

Begin displaying the results for IDs greater than the specified marker. When used with --limit, set this to the last ID displayed in the previous run.

trove backup-show¶

usage: trove backup-show <backup>

Shows details of a backup.

Positional arguments:

<backup>

ID or name of the backup.

trove cluster-create¶

usage: trove cluster-create <name> <datastore> <datastore_version>
                            [--instance "opt=<value>[,opt=<value> ...] "]
                            [--locality <policy>]

Creates a new cluster.

Positional arguments:

<name>

Name of the cluster.

<datastore>

A datastore name or ID.

<datastore_version>

A datastore version name or ID.

Optional arguments:

--instance "opt=<value>[,opt=<value> ...] "

Add an instance to the cluster. Specify multiple times to create multiple instances. Valid options are: flavor=<flavor_name_or_id>, volume=<disk_size_in_GB>, volume_type=<type>, nic=’<net-id=<net-uuid>, v4-fixed-ip=<ip-addr>, port-id=<port-uuid>>’ (where net-id=network_id, v4-fixed-ip=IPv4r_fixed_address, port-id=port_id), availability_zone=<AZ_hint_for_Nova>, module=<module_name_or_id>.

--locality <policy>

Locality policy to use when creating cluster. Choose one of affinity, anti-affinity.

trove cluster-delete¶

usage: trove cluster-delete <cluster>

Deletes a cluster.

Positional arguments:

<cluster>

ID or name of the cluster.

trove cluster-force-delete¶

usage: trove cluster-force-delete <cluster>

Force delete a cluster

Positional arguments:

<cluster>

ID or name of the cluster.

trove cluster-grow¶

usage: trove cluster-grow <cluster>
                          [--instance "opt=<value>[,opt=<value> ...] "]

Adds more instances to a cluster.

Positional arguments:

<cluster>

ID or name of the cluster.

Optional arguments:

--instance "opt=<value>[,opt=<value> ...] "

Add an instance to the cluster. Specify multiple times to create multiple instances. Valid options are: flavor=<flavor_name_or_id>, volume=<disk_size_in_GB>, volume_type=<type>, nic=’<net-id=<net-uuid>, v4-fixed-ip=<ip-addr>, port-id=<port-uuid>>’ (where net-id=network_id, v4-fixed-ip=IPv4r_fixed_address, port-id=port_id), availability_zone=<AZ_hint_for_Nova>, module=<module_name_or_id>.

trove cluster-instances¶

usage: trove cluster-instances <cluster>

Lists all instances of a cluster.

Positional arguments:

<cluster>

ID or name of the cluster.

trove cluster-list¶

usage: trove cluster-list [--limit <limit>] [--marker <ID>]

Lists all the clusters.

Optional arguments:

--limit <limit>

Limit the number of results displayed.

--marker <ID>

Begin displaying the results for IDs greater than the specified marker. When used with --limit, set this to the last ID displayed in the previous run.

trove cluster-modules¶

usage: trove cluster-modules <cluster>

Lists all modules for each instance of a cluster.

Positional arguments:

<cluster>

ID or name of the cluster.

trove cluster-reset-status¶

usage: trove cluster-reset-status <cluster>

Set the cluster task to NONE.

Positional arguments:

<cluster>

ID or name of the cluster.

trove cluster-show¶

usage: trove cluster-show <cluster>

Shows details of a cluster.

Positional arguments:

<cluster>

ID or name of the cluster.

trove cluster-shrink¶

usage: trove cluster-shrink <cluster> <instance> [<instance> ...]

Drops instances from a cluster.

Positional arguments:

<cluster>

ID or name of the cluster.

<instance>

Drop instance(s) from the cluster. Specify multiple ids to drop multiple instances.

trove configuration-attach¶

usage: trove configuration-attach <instance> <configuration>

Attaches a configuration group to an instance.

Positional arguments:

<instance>

ID or name of the instance.

<configuration>

ID or name of the configuration group to attach to the instance.

trove configuration-create¶

usage: trove configuration-create <name> <values>
                                  [--datastore <datastore>]
                                  [--datastore_version <datastore_version>]
                                  [--description <description>]

Creates a configuration group.

Positional arguments:

<name>

Name of the configuration group.

<values>

Dictionary of the values to set.

Optional arguments:

--datastore <datastore>

Datastore assigned to the configuration group. Required if default datastore is not configured.

--datastore_version <datastore_version>

Datastore version ID assigned to the configuration group.

--description <description>

An optional description for the configuration group.

trove configuration-default¶

usage: trove configuration-default <instance>

Shows the default configuration of an instance.

Positional arguments:

<instance>

ID or name of the instance.

trove configuration-delete¶

usage: trove configuration-delete <configuration_group>

Deletes a configuration group.

Positional arguments:

<configuration_group>

ID or name of the configuration group.

trove configuration-detach¶

usage: trove configuration-detach <instance>

Detaches a configuration group from an instance.

Positional arguments:

<instance>

ID or name of the instance.

trove configuration-instances¶

usage: trove configuration-instances <configuration_group>

Lists all instances associated with a configuration group.

Positional arguments:

<configuration_group>

ID or name of the configuration group.

trove configuration-list¶

usage: trove configuration-list

Lists all configuration groups.

trove configuration-parameter-list¶

usage: trove configuration-parameter-list <datastore_version>
                                          [--datastore <datastore>]

Lists available parameters for a configuration group.

Positional arguments:

<datastore_version>

Datastore version name or ID assigned to the configuration group.

Optional arguments:

--datastore <datastore>

ID or name of the datastore to list configuration parameters for. Optional if the ID of the datastore_version is provided.

trove configuration-parameter-show¶

usage: trove configuration-parameter-show <datastore_version> <parameter>
                                          [--datastore <datastore>]

Shows details of a configuration parameter.

Positional arguments:

<datastore_version>

Datastore version name or ID assigned to the configuration group.

<parameter>

Name of the configuration parameter.

Optional arguments:

--datastore <datastore>

ID or name of the datastore to list configuration parameters for. Optional if the ID of the datastore_version is provided.

trove configuration-patch¶

usage: trove configuration-patch <configuration_group> <values>

Patches a configuration group.

Positional arguments:

<configuration_group>

ID or name of the configuration group.

<values>

Dictionary of the values to set.

trove configuration-show¶

usage: trove configuration-show <configuration_group>

Shows details of a configuration group.

Positional arguments:

<configuration_group>

ID or name of the configuration group.

trove configuration-update¶

usage: trove configuration-update <configuration_group> <values>
                                  [--name <name>]
                                  [--description <description>]

Updates a configuration group.

Positional arguments:

<configuration_group>

ID or name of the configuration group.

<values>

Dictionary of the values to set.

Optional arguments:

--name <name>

Name of the configuration group.

--description <description>

An optional description for the configuration group.

trove create¶

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>] [--locality <policy>]

Creates a new instance.

Positional arguments:

<name>

Name of the instance.

<flavor>

A flavor name or ID.

Optional arguments:

--size <size>

Size of the instance disk volume in GB. Required when volume support is enabled.

--volume_type <volume_type>

Volume type. Optional when volume support is enabled.

--databases <database> [<database> ...]

Optional list of databases.

--users <user:password> [<user:password> ...]

Optional list of users.

--backup <backup>

A backup name or ID.

--availability_zone <availability_zone>

The Zone hint to give to Nova.

--datastore <datastore>

A datastore name or ID.

--datastore_version <datastore_version>

A datastore version name or ID.

--nic <net-id=<net-uuid>,v4-fixed-ip=<ip-addr>,port-id=<port-uuid>>

Create a NIC on the instance. Specify option multiple times to create multiple NICs. net-id: attach NIC to network with this ID (either port-id or net-id must be specified), v4-fixed-ip: IPv4 fixed address for NIC (optional), port-id: attach NIC to port with this ID (either port-id or net-id must be specified).

--configuration <configuration>

ID of the configuration group to attach to the instance.

--replica_of <source_instance>

ID or name of an existing instance to replicate from.

--replica_count <count>

Number of replicas to create (defaults to 1 if replica_of specified).

--module <module>

ID or name of the module to apply. Specify multiple times to apply multiple modules.

--locality <policy>

Locality policy to use when creating replicas. Choose one of affinity, anti-affinity.

trove database-create¶

usage: trove database-create <instance> <name>
                             [--character_set <character_set>]
                             [--collate <collate>]

Creates a database on an instance.

Positional arguments:

<instance>

ID or name of the instance.

<name>

Name of the database.

Optional arguments:

--character_set <character_set>

Optional character set for database.

--collate <collate>

Optional collation type for database.

trove database-delete¶

usage: trove database-delete <instance> <database>

Deletes a database from an instance.

Positional arguments:

<instance>

ID or name of the instance.

<database>

Name of the database.

trove database-list¶

usage: trove database-list <instance>

Lists available databases on an instance.

Positional arguments:

<instance>

ID or name of the instance.

trove datastore-list¶

usage: trove datastore-list

Lists available datastores.

trove datastore-show¶

usage: trove datastore-show <datastore>

Shows details of a datastore.

Positional arguments:

<datastore>

ID of the datastore.

trove datastore-version-list¶

usage: trove datastore-version-list <datastore>

Lists available versions for a datastore.

Positional arguments:

<datastore>

ID or name of the datastore.

trove datastore-version-show¶

usage: trove datastore-version-show <datastore_version>
                                    [--datastore <datastore>]

Shows details of a datastore version.

Positional arguments:

<datastore_version>

ID or name of the datastore version.

Optional arguments:

--datastore <datastore>

ID or name of the datastore. Optional if the ID of the datastore_version is provided.

trove delete¶

usage: trove delete <instance>

Deletes an instance.

Positional arguments:

<instance>

ID or name of the instance.

trove detach-replica¶

usage: trove detach-replica <instance>

Detaches a replica instance from its replication source.

Positional arguments:

<instance>

ID or name of the instance.

trove eject-replica-source¶

usage: trove eject-replica-source <instance>

Ejects a replica source from its set.

Positional arguments:

<instance>

ID or name of the instance.

trove execution-delete¶

usage: trove execution-delete <execution>

Deletes an execution.

Positional arguments:

<execution>

Id of the execution to delete.

trove execution-list¶

usage: trove execution-list [--limit <limit>] [--marker <ID>] <schedule id>

Lists executions of a scheduled backup of an instance.

Positional arguments:

<schedule id>

Id of the schedule.

Optional arguments:

--limit <limit>

Return up to N number of the most recent executions.

--marker <ID>

Begin displaying the results for IDs greater than the specified marker. When used with --limit, set this to the last ID displayed in the previous run.

trove flavor-list¶

usage: trove flavor-list [--datastore_type <datastore_type>]
                         [--datastore_version_id <datastore_version_id>]

Lists available flavors.

Optional arguments:

--datastore_type <datastore_type>

Type of the datastore. For eg: mysql.

--datastore_version_id <datastore_version_id>

ID of the datastore version.

trove flavor-show¶

usage: trove flavor-show <flavor>

Shows details of a flavor.

Positional arguments:

<flavor>

ID or name of the flavor.

trove force-delete¶

usage: trove force-delete <instance>

Force delete an instance.

Positional arguments:

<instance>

ID or name of the instance.

trove limit-list¶

usage: trove limit-list

Lists the limits for a tenant.

trove list¶

usage: trove list [--limit <limit>] [--marker <ID>] [--include_clustered]

Lists all the instances.

Optional arguments:

--limit <limit>

Limit the number of results displayed.

--marker <ID>

Begin displaying the results for IDs greater than the specified marker. When used with --limit, set this to the last ID displayed in the previous run.

--include_clustered, --include-clustered

Include instances that are part of a cluster (default False). --include-clustered may be deprecated in the future, retaining just --include_clustered.

trove log-disable¶

usage: trove log-disable [--discard] <instance> <log_name>

Instructs Trove guest to stop collecting log details.

Positional arguments:

<instance>

Id or Name of the instance.

<log_name>

Name of log to publish.

Optional arguments:

--discard

Discard published contents of specified log.

trove log-discard¶

usage: trove log-discard <instance> <log_name>

Instructs Trove guest to discard the container of the published log.

Positional arguments:

<instance>

Id or Name of the instance.

<log_name>

Name of log to publish.

trove log-enable¶

usage: trove log-enable <instance> <log_name>

Instructs Trove guest to start collecting log details.

Positional arguments:

<instance>

Id or Name of the instance.

<log_name>

Name of log to publish.

trove log-list¶

usage: trove log-list <instance>

Lists the log files available for instance.

Positional arguments:

<instance>

Id or Name of the instance.

trove log-publish¶

usage: trove log-publish [--disable] [--discard] <instance> <log_name>

Instructs Trove guest to publish latest log entries on instance.

Positional arguments:

<instance>

Id or Name of the instance.

<log_name>

Name of log to publish.

Optional arguments:

--disable

Stop collection of specified log.

--discard

Discard published contents of specified log.

trove log-save¶

usage: trove log-save [--publish] [--file <file>] <instance> <log_name>

Save log file for instance.

Positional arguments:

<instance>

Id or Name of the instance.

<log_name>

Name of log to publish.

Optional arguments:

--publish

Publish latest entries from guest before display.

--file <file>

Path of file to save log to for instance.

trove log-show¶

usage: trove log-show <instance> <log_name>

Instructs Trove guest to show details of log.

Positional arguments:

<instance>

Id or Name of the instance.

<log_name>

Name of log to show.

trove log-tail¶

usage: trove log-tail [--publish] [--lines <lines>] <instance> <log_name>

Display log entries for instance.

Positional arguments:

<instance>

Id or Name of the instance.

<log_name>

Name of log to publish.

Optional arguments:

--publish

Publish latest entries from guest before display.

--lines <lines>

Publish latest entries from guest before display.

trove metadata-create¶

usage: trove metadata-create <instance_id> <key> <value>

Creates metadata in the database for instance <id>.

Positional arguments:

<instance_id>

UUID for instance.

<key>

Key for assignment.

<value>

Value to assign to <key>.

trove metadata-delete¶

usage: trove metadata-delete <instance_id> <key>

Deletes metadata for instance <id>.

Positional arguments:

<instance_id>

UUID for instance.

<key>

Metadata key to delete.

trove metadata-edit¶

usage: trove metadata-edit <instance_id> <key> <value>

Replaces metadata value with a new one, this is non-destructive.

Positional arguments:

<instance_id>

UUID for instance.

<key>

Key to replace.

<value>

New value to assign to <key>.

trove metadata-list¶

usage: trove metadata-list <instance_id>

Shows all metadata for instance <id>.

Positional arguments:

<instance_id>

UUID for instance.

trove metadata-show¶

usage: trove metadata-show <instance_id> <key>

Shows metadata entry for key <key> and instance <id>.

Positional arguments:

<instance_id>

UUID for instance.

<key>

Key to display.

trove metadata-update¶

usage: trove metadata-update <instance_id> <key> <newkey> <value>

Updates metadata, this is destructive.

Positional arguments:

<instance_id>

UUID for instance.

<key>

Key to update.

<newkey>

New key.

<value>

Value to assign to <newkey>.

trove module-apply¶

usage: trove module-apply <instance> <module> [<module> ...]

Apply modules to an instance.

Positional arguments:

<instance>

ID or name of the instance.

<module>

ID or name of the module.

trove module-create¶

usage: trove module-create <name> <type> <filename>
                           [--description <description>]
                           [--datastore <datastore>]
                           [--datastore_version <version>] [--auto_apply]
                           [--all_tenants] [--hidden] [--live_update]
                           [--priority_apply]
                           [--apply_order {0,1,2,3,4,5,6,7,8,9}]
                           [--full_access]

Create a module.

Positional arguments:

<name>

Name of the module.

<type>

Type of the module. The type must be supported by a corresponding module plugin on the datastore it is applied to.

<filename>

File containing data contents for the module.

Optional arguments:

--description <description>

Description of the module.

--datastore <datastore>

Name or ID of datastore this module can be applied to. If not specified, module can be applied to all datastores.

--datastore_version <version>

Name or ID of datastore version this module can be applied to. If not specified, module can be applied to all versions.

--auto_apply

Automatically apply this module when creating an instance or cluster. Admin only.

--all_tenants

Module is valid for all tenants. Admin only.

--hidden

Hide this module from non-Admin. Useful in creating auto-apply modules without cluttering up module lists. Admin only.

--live_update

Allow module to be updated even if it is already applied to a current instance or cluster. Automatically attempt to reapply this module if the contents change.

--priority_apply

Sets a priority for applying the module. All priority modules will be applied before non-priority ones. Admin only.

--apply_order {0,1,2,3,4,5,6,7,8,9}

Sets an order for applying the module. Modules with a lower value will be applied before modules with a higher value. Modules having the same value may be applied in any order (default 5).

--full_access

Marks a module as ‘non-admin’, unless an admin-only option was specified. Admin only.

trove module-delete¶

usage: trove module-delete <module>

Delete a module.

Positional arguments:

<module>

ID or name of the module.

trove module-instances¶

usage: trove module-instances <module>
                              [--include_clustered] [--limit <limit>]
                              [--marker <ID>]

Lists the instances that have a particular module applied.

Positional arguments:

<module>

ID or name of the module.

Optional arguments:

--include_clustered

Include instances that are part of a cluster (default False).

--limit <limit>

Return up to N number of the most recent results.

--marker <ID>

Begin displaying the results for IDs greater than the specified marker. When used with --limit, set this to the last ID displayed in the previous run.

trove module-list¶

usage: trove module-list [--datastore <datastore>]

Lists the modules available.

Optional arguments:

--datastore <datastore>

Name or ID of datastore to list modules for. Use ‘all’ to list modules that apply to all datastores.

trove module-list-instance¶

usage: trove module-list-instance <instance>

Lists the modules that have been applied to an instance.

Positional arguments:

<instance>

ID or name of the instance.

trove module-query¶

usage: trove module-query <instance>

Query the status of the modules on an instance.

Positional arguments:

<instance>

ID or name of the instance.

trove module-remove¶

usage: trove module-remove <instance> <module>

Remove a module from an instance.

Positional arguments:

<instance>

ID or name of the instance.

<module>

ID or name of the module.

trove module-retrieve¶

usage: trove module-retrieve <instance>
                             [--directory <directory>]
                             [--prefix <filename_prefix>]

Retrieve module contents from an instance.

Positional arguments:

<instance>

ID or name of the instance.

Optional arguments:

--directory <directory>

Directory to write module content files in. It will be created if it does not exist. Defaults to the current directory.

--prefix <filename_prefix>

Prefix to prepend to generated filename for each module.

trove module-show¶

usage: trove module-show <module>

Shows details of a module.

Positional arguments:

<module>

ID or name of the module.

trove module-update¶

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] [--hidden] [--no_hidden]
                           [--live_update] [--no_live_update]
                           [--priority_apply] [--no_priority_apply]
                           [--apply_order {0,1,2,3,4,5,6,7,8,9}]
                           [--full_access] [--no_full_access]

Update a module.

Positional arguments:

<module>

Name or ID of the module.

Optional arguments:

--name <name>

Name of the module.

--type <type>

Type of the module. The type must be supported by a corresponding module driver plugin on the datastore it is applied to.

--file <filename>

File containing data contents for the module.

--description <description>

Description of the module.

--datastore <datastore>

Name or ID of datastore this module can be applied to. If not specified, module can be applied to all datastores.

--all_datastores

Module is valid for all datastores.

--datastore_version <version>

Name or ID of datastore version this module can be applied to. If not specified, module can be applied to all versions.

--all_datastore_versions

Module is valid for all datastore versions.

--auto_apply

Automatically apply this module when creating an instance or cluster. Admin only.

--no_auto_apply

Do not automatically apply this module when creating an instance or cluster. Admin only.

--all_tenants

Module is valid for all tenants. Admin only.

--no_all_tenants

Module is valid for current tenant only. Admin only.

--hidden

Hide this module from non-admin users. Useful in creating auto-apply modules without cluttering up module lists. Admin only.

--no_hidden

Allow all users to see this module. Admin only.

--live_update

Allow module to be updated or deleted even if it is already applied to a current instance or cluster. Automatically attempt to reapply this module if the contents change.

--no_live_update

Restricts a module from being updated or deleted if it is already applied to a current instance or cluster.

--priority_apply

Sets a priority for applying the module. All priority modules will be applied before non-priority ones. Admin only.

--no_priority_apply

Removes apply priority from the module. Admin only.

--apply_order {0,1,2,3,4,5,6,7,8,9}

Sets an order for applying the module. Modules with a lower value will be applied before modules with a higher value. Modules having the same value may be applied in any order (default None).

--full_access

Marks a module as ‘non-admin’, unless an admin-only option was specified. Admin only.

--no_full_access

Restricts modification access for non-admin. Admin only.

trove promote-to-replica-source¶

usage: trove promote-to-replica-source <instance>

Promotes a replica to be the new replica source of its set.

Positional arguments:

<instance>

ID or name of the instance.

trove quota-show¶

usage: trove quota-show <tenant_id>

Show quotas for a tenant.

Positional arguments:

<tenant_id>

Id of tenant for which to show quotas.

trove quota-update¶

usage: trove quota-update <tenant_id> <resource> <limit>

Update quotas for a tenant.

Positional arguments:

<tenant_id>

Id of tenant for which to update quotas.

<resource>

Id of resource to change.

<limit>

New limit to set for the named resource.

trove reset-status¶

usage: trove reset-status <instance>

Set the status to NONE.

Positional arguments:

<instance>

ID or name of the instance.

trove resize-instance¶

usage: trove resize-instance <instance> <flavor>

Resizes an instance with a new flavor.

Positional arguments:

<instance>

ID or name of the instance.

<flavor>

New flavor of the instance.

trove resize-volume¶

usage: trove resize-volume <instance> <size>

Resizes the volume size of an instance.

Positional arguments:

<instance>

ID or name of the instance.

<size>

New size of the instance disk volume in GB.

trove restart¶

usage: trove restart <instance>

Restarts an instance.

Positional arguments:

<instance>

ID or name of the instance.

trove root-disable¶

usage: trove root-disable <instance>

Disables root for an instance.

Positional arguments:

<instance>

ID or name of the instance.

trove root-enable¶

usage: trove root-enable <instance_or_cluster>
                         [--root_password <root_password>]

Enables root for an instance and resets if already exists.

Positional arguments:

<instance_or_cluster>

ID or name of the instance or cluster.

Optional arguments:

--root_password <root_password>

Root password to set.

trove root-show¶

usage: trove root-show <instance_or_cluster>

Gets status if root was ever enabled for an instance or cluster.

Positional arguments:

<instance_or_cluster>

ID or name of the instance or cluster.

trove schedule-create¶

usage: trove schedule-create <instance> <pattern> <name>
                             [--description <description>] [--incremental]

Schedules backups for an instance.

Positional arguments:

<instance>

ID or name of the instance.

<pattern>

Cron style pattern describing schedule occurrence.

<name>

Name of the backup.

Optional arguments:

--description <description>

An optional description for the backup.

--incremental

Flag to select incremental backup based on most recent backup.

trove schedule-delete¶

usage: trove schedule-delete <schedule id>

Deletes a schedule.

Positional arguments:

<schedule id>

Id of the schedule.

trove schedule-list¶

usage: trove schedule-list <instance>

Lists scheduled backups for an instance.

Positional arguments:

<instance>

ID or name of the instance.

trove schedule-show¶

usage: trove schedule-show <schedule id>

Shows details of a schedule.

Positional arguments:

<schedule id>

Id of the schedule.

trove secgroup-add-rule¶

usage: trove secgroup-add-rule <security_group> <cidr>

Creates a security group rule.

Positional arguments:

<security_group>

Security group ID.

<cidr>

CIDR address.

trove secgroup-delete-rule¶

usage: trove secgroup-delete-rule <security_group_rule>

Deletes a security group rule.

Positional arguments:

<security_group_rule>

Name of security group rule.

trove secgroup-list¶

usage: trove secgroup-list

Lists all security groups.

trove secgroup-list-rules¶

usage: trove secgroup-list-rules <security_group>

Lists all rules for a security group.

Positional arguments:

<security_group>

Security group ID.

trove secgroup-show¶

usage: trove secgroup-show <security_group>

Shows details of a security group.

Positional arguments:

<security_group>

Security group ID.

trove show¶

usage: trove show <instance>

Shows details of an instance.

Positional arguments:

<instance>

ID or name of the instance.

trove update¶

usage: trove update <instance>
                    [--name <name>] [--configuration <configuration>]
                    [--detach_replica_source] [--remove_configuration]

Updates an instance: Edits name, configuration, or replica source.

Positional arguments:

<instance>

ID or name of the instance.

Optional arguments:

--name <name>

Name of the instance.

--configuration <configuration>

ID of the configuration reference to attach.

--detach_replica_source, --detach-replica-source

Detach the replica instance from its replication source. --detach-replica-source may be deprecated in the future in favor of just --detach_replica_source

--remove_configuration

Drops the current configuration reference.

trove upgrade¶

usage: trove upgrade <instance> <datastore_version>

Upgrades an instance to a new datastore version.

Positional arguments:

<instance>

ID or name of the instance.

<datastore_version>

A datastore version name or ID.

trove user-create¶

usage: trove user-create <instance> <name> <password>
                         [--host <host>]
                         [--databases <databases> [<databases> ...]]

Creates a user on an instance.

Positional arguments:

<instance>

ID or name of the instance.

<name>

Name of user.

<password>

Password of user.

Optional arguments:

--host <host>

Optional host of user.

--databases <databases> [<databases> ...]

Optional list of databases.

trove user-delete¶

usage: trove user-delete [--host <host>] <instance> <name>

Deletes a user from an instance.

Positional arguments:

<instance>

ID or name of the instance.

<name>

Name of user.

Optional arguments:

--host <host>

Optional host of user.

trove user-grant-access¶

usage: trove user-grant-access <instance> <name> <databases> [<databases> ...]
                               [--host <host>]

Grants access to a database(s) for a user.

Positional arguments:

<instance>

ID or name of the instance.

<name>

Name of user.

<databases>

List of databases.

Optional arguments:

--host <host>

Optional host of user.

trove user-list¶

usage: trove user-list <instance>

Lists the users for an instance.

Positional arguments:

<instance>

ID or name of the instance.

trove user-revoke-access¶

usage: trove user-revoke-access [--host <host>] <instance> <name> <database>

Revokes access to a database for a user.

Positional arguments:

<instance>

ID or name of the instance.

<name>

Name of user.

<database>

A single database.

Optional arguments:

--host <host>

Optional host of user.

trove user-show¶

usage: trove user-show [--host <host>] <instance> <name>

Shows details of a user of an instance.

Positional arguments:

<instance>

ID or name of the instance.

<name>

Name of user.

Optional arguments:

--host <host>

Optional host of user.

trove user-show-access¶

usage: trove user-show-access [--host <host>] <instance> <name>

Shows access details of a user of an instance.

Positional arguments:

<instance>

ID or name of the instance.

<name>

Name of user.

Optional arguments:

--host <host>

Optional host of user.

trove user-update-attributes¶

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:

<instance>

ID or name of the instance.

<name>

Name of user.

Optional arguments:

--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.