Shell¶
- 
troveclient.v1.shell.do_backup_copy(cs, args)
- Creates a backup from another backup. 
- 
troveclient.v1.shell.do_backup_create(cs, args)
- Creates a backup of an instance. 
- 
troveclient.v1.shell.do_backup_delete(cs, args)
- Deletes a backup. 
- 
troveclient.v1.shell.do_backup_list(cs, args)
- Lists available backups. 
- 
troveclient.v1.shell.do_backup_list_instance(cs, args)
- Lists available backups for an instance. 
- 
troveclient.v1.shell.do_backup_show(cs, args)
- Shows details of a backup. 
- 
troveclient.v1.shell.do_cluster_create(cs, args)
- Creates a new cluster. 
- 
troveclient.v1.shell.do_cluster_delete(cs, args)
- Deletes a cluster. 
- 
troveclient.v1.shell.do_cluster_force_delete(cs, args)
- Force delete a cluster 
- 
troveclient.v1.shell.do_cluster_grow(cs, args)
- Adds more instances to a cluster. 
- 
troveclient.v1.shell.do_cluster_instances(cs, args)
- Lists all instances of a cluster. 
- 
troveclient.v1.shell.do_cluster_list(cs, args)
- Lists all the clusters. 
- 
troveclient.v1.shell.do_cluster_modules(cs, args)
- Lists all modules for each instance of a cluster. 
- 
troveclient.v1.shell.do_cluster_reset_status(cs, args)
- Set the cluster task to NONE. 
- 
troveclient.v1.shell.do_cluster_show(cs, args)
- Shows details of a cluster. 
- 
troveclient.v1.shell.do_cluster_shrink(cs, args)
- Drops instances from a cluster. 
- 
troveclient.v1.shell.do_cluster_upgrade(cs, args)
- Upgrades a cluster to a new datastore version. 
- 
troveclient.v1.shell.do_configuration_attach(cs, args)
- Attaches a configuration group to an instance. 
- 
troveclient.v1.shell.do_configuration_create(cs, args)
- Creates a configuration group. 
- 
troveclient.v1.shell.do_configuration_default(cs, args)
- Shows the default configuration of an instance. 
- 
troveclient.v1.shell.do_configuration_delete(cs, args)
- Deletes a configuration group. 
- 
troveclient.v1.shell.do_configuration_detach(cs, args)
- Detaches a configuration group from an instance. 
- 
troveclient.v1.shell.do_configuration_instances(cs, args)
- Lists all instances associated with a configuration group. 
- 
troveclient.v1.shell.do_configuration_list(cs, args)
- Lists all configuration groups. 
- 
troveclient.v1.shell.do_configuration_parameter_list(cs, args)
- Lists available parameters for a configuration group. 
- 
troveclient.v1.shell.do_configuration_parameter_show(cs, args)
- Shows details of a configuration parameter. 
- 
troveclient.v1.shell.do_configuration_patch(cs, args)
- Patches a configuration group. 
- 
troveclient.v1.shell.do_configuration_show(cs, args)
- Shows details of a configuration group. 
- 
troveclient.v1.shell.do_configuration_update(cs, args)
- Updates a configuration group. 
- 
troveclient.v1.shell.do_create(cs, args)
- Creates a new instance. 
- 
troveclient.v1.shell.do_database_create(cs, args)
- Creates a database on an instance. 
- 
troveclient.v1.shell.do_database_delete(cs, args)
- Deletes a database from an instance. 
- 
troveclient.v1.shell.do_database_list(cs, args)
- Lists available databases on an instance. 
- 
troveclient.v1.shell.do_datastore_list(cs, args)
- Lists available datastores. 
- 
troveclient.v1.shell.do_datastore_show(cs, args)
- Shows details of a datastore. 
- 
troveclient.v1.shell.do_datastore_version_list(cs, args)
- Lists available versions for a datastore. 
- 
troveclient.v1.shell.do_datastore_version_show(cs, args)
- Shows details of a datastore version. 
- 
troveclient.v1.shell.do_delete(cs, args)
- Deletes an instance. 
- 
troveclient.v1.shell.do_detach_replica(cs, args)
- Detaches a replica instance from its replication source. 
- 
troveclient.v1.shell.do_eject_replica_source(cs, args)
- Ejects a replica source from its set. 
- 
troveclient.v1.shell.do_execution_delete(cs, args)
- Deletes an execution. 
- 
troveclient.v1.shell.do_execution_list(cs, args)
- Lists executions of a scheduled backup of an instance. 
- 
troveclient.v1.shell.do_flavor_list(cs, args)
- Lists available flavors. 
- 
troveclient.v1.shell.do_flavor_show(cs, args)
- Shows details of a flavor. 
- 
troveclient.v1.shell.do_force_delete(cs, args)
- Force delete an instance. 
- 
troveclient.v1.shell.do_limit_list(cs, args)
- Lists the limits for a tenant. 
- 
troveclient.v1.shell.do_list(cs, args)
- Lists all the instances. 
- 
troveclient.v1.shell.do_log_disable(cs, args)
- Instructs Trove guest to stop collecting log details. 
- 
troveclient.v1.shell.do_log_discard(cs, args)
- Instructs Trove guest to discard the container of the published log. 
- 
troveclient.v1.shell.do_log_enable(cs, args)
- Instructs Trove guest to start collecting log details. 
- 
troveclient.v1.shell.do_log_list(cs, args)
- Lists the log files available for instance. 
- 
troveclient.v1.shell.do_log_publish(cs, args)
- Instructs Trove guest to publish latest log entries on instance. 
- 
troveclient.v1.shell.do_log_save(cs, args)
- Save log file for instance. 
- 
troveclient.v1.shell.do_log_show(cs, args)
- Instructs Trove guest to show details of log. 
- 
troveclient.v1.shell.do_log_tail(cs, args)
- Display log entries for instance. 
- 
troveclient.v1.shell.do_metadata_create(cs, args)
- Creates metadata in the database for instance <id>. 
- 
troveclient.v1.shell.do_metadata_delete(cs, args)
- Deletes metadata for instance <id>. 
- 
troveclient.v1.shell.do_metadata_edit(cs, args)
- Replaces metadata value with a new one, this is non-destructive. 
- 
troveclient.v1.shell.do_metadata_list(cs, args)
- Shows all metadata for instance <id>. 
- 
troveclient.v1.shell.do_metadata_show(cs, args)
- Shows metadata entry for key <key> and instance <id>. 
- 
troveclient.v1.shell.do_metadata_update(cs, args)
- Updates metadata, this is destructive. 
- 
troveclient.v1.shell.do_module_apply(cs, args)
- Apply modules to an instance. 
- 
troveclient.v1.shell.do_module_create(cs, args)
- Create a module. 
- 
troveclient.v1.shell.do_module_delete(cs, args)
- Delete a module. 
- 
troveclient.v1.shell.do_module_instance_count(cs, args)
- Lists a count of the instances for each module md5. 
- 
troveclient.v1.shell.do_module_instances(cs, args)
- Lists the instances that have a particular module applied. 
- 
troveclient.v1.shell.do_module_list(cs, args)
- Lists the modules available. 
- 
troveclient.v1.shell.do_module_list_instance(cs, args)
- Lists the modules that have been applied to an instance. 
- 
troveclient.v1.shell.do_module_query(cs, args)
- Query the status of the modules on an instance. 
- 
troveclient.v1.shell.do_module_reapply(cs, args)
- Reapply a module. 
- 
troveclient.v1.shell.do_module_remove(cs, args)
- Remove a module from an instance. 
- 
troveclient.v1.shell.do_module_retrieve(cs, args)
- Retrieve module contents from an instance. 
- 
troveclient.v1.shell.do_module_show(cs, args)
- Shows details of a module. 
- 
troveclient.v1.shell.do_module_update(cs, args)
- Update a module. 
- 
troveclient.v1.shell.do_promote_to_replica_source(cs, args)
- Promotes a replica to be the new replica source of its set. 
- 
troveclient.v1.shell.do_quota_show(cs, args)
- Show quotas for a tenant. 
- 
troveclient.v1.shell.do_quota_update(cs, args)
- Update quotas for a tenant. 
- 
troveclient.v1.shell.do_reset_status(cs, args)
- Set the status to NONE. 
- 
troveclient.v1.shell.do_resize_instance(cs, args)
- Resizes an instance with a new flavor. 
- 
troveclient.v1.shell.do_resize_volume(cs, args)
- Resizes the volume size of an instance. 
- 
troveclient.v1.shell.do_restart(cs, args)
- Restarts an instance. 
- 
troveclient.v1.shell.do_root_disable(cs, args)
- Disables root for an instance. 
- 
troveclient.v1.shell.do_root_enable(cs, args)
- Enables root for an instance and resets if already exists. 
- 
troveclient.v1.shell.do_root_show(cs, args)
- Gets status if root was ever enabled for an instance or cluster. 
- 
troveclient.v1.shell.do_schedule_create(cs, args)
- Schedules backups for an instance. 
- 
troveclient.v1.shell.do_schedule_delete(cs, args)
- Deletes a schedule. 
- 
troveclient.v1.shell.do_schedule_list(cs, args)
- Lists scheduled backups for an instance. 
- 
troveclient.v1.shell.do_schedule_show(cs, args)
- Shows details of a schedule. 
- 
troveclient.v1.shell.do_secgroup_add_rule(cs, args)
- Creates a security group rule. 
- 
troveclient.v1.shell.do_secgroup_delete_rule(cs, args)
- Deletes a security group rule. 
- 
troveclient.v1.shell.do_secgroup_list(cs, args)
- Lists all security groups. 
- 
troveclient.v1.shell.do_secgroup_list_rules(cs, args)
- Lists all rules for a security group. 
- 
troveclient.v1.shell.do_secgroup_show(cs, args)
- Shows details of a security group. 
- 
troveclient.v1.shell.do_show(cs, args)
- Shows details of an instance. 
- 
troveclient.v1.shell.do_update(cs, args)
- Updates an instance: Edits name, configuration, or replica source. 
- 
troveclient.v1.shell.do_upgrade(cs, args)
- Upgrades an instance to a new datastore version. 
- 
troveclient.v1.shell.do_user_create(cs, args)
- Creates a user on an instance. 
- 
troveclient.v1.shell.do_user_delete(cs, args)
- Deletes a user from an instance. 
- 
troveclient.v1.shell.do_user_grant_access(cs, args)
- Grants access to a database(s) for a user. 
- 
troveclient.v1.shell.do_user_list(cs, args)
- Lists the users for an instance. 
- 
troveclient.v1.shell.do_user_revoke_access(cs, args)
- Revokes access to a database for a user. 
- 
troveclient.v1.shell.do_user_show(cs, args)
- Shows details of a user of an instance. 
- 
troveclient.v1.shell.do_user_show_access(cs, args)
- Shows access details of a user of an instance. 
- 
troveclient.v1.shell.do_user_update_attributes(cs, args)
- Updates a user’s attributes on an instance. At least one optional argument must be provided. 
- 
troveclient.v1.shell.do_volume_type_list(cs, args)
- Lists available volume types. 
- 
troveclient.v1.shell.do_volume_type_show(cs, args)
- Shows details of a volume type.