troveclient.compat.cli module

Trove Command line tool

class troveclient.compat.cli.BackupsCommands(parser)

Bases: troveclient.compat.common.AuthedCommandsBase

Command to manage and show backups.

create()

Create a new backup.

delete()

Delete a backup.

get()

Get details for the specified backup.

list()

List backups.

params = ['name', 'instance', 'description']

class troveclient.compat.cli.ConfigurationsCommands(parser)

Bases: troveclient.compat.common.AuthedCommandsBase

Command to manage and show configurations.

create()

Create a new configuration.

delete()

Delete a configuration.

edit()

Edit an existing configuration values.

get()

Get details for the specified configuration.

list()

List configurations.

list_instances()

Get details for the specified configuration.

params = ['name', 'instances', 'values', 'description', 'parameter']

update()

Update an existing configuration.

class troveclient.compat.cli.DatabaseCommands(parser)

Bases: troveclient.compat.common.AuthedCommandsBase

Database CRUD operations on an instance.

create()

Create a database.

delete()

Delete a database.

list()

List the databases.

params = ['name', 'id', 'limit', 'marker']

class troveclient.compat.cli.DatastoreConfigurationParameters(parser)

Bases: troveclient.compat.common.AuthedCommandsBase

Command to show configuration parameters for a datastore.

get_parameter()

List parameters that can be set.

parameters()

List parameters that can be set.

params = ['datastore', 'parameter']

class troveclient.compat.cli.InstanceCommands(parser)

Bases: troveclient.compat.common.AuthedCommandsBase

Commands to perform various instance operations and actions.

backups()

Get a list of backups for the specified instance.

configuration()

Get configuration for the specified instance.

create()

Create a new instance.

delete()

Delete the specified instance.

get()

Get details for the specified instance.

list()

List all instances for account.

modify()

Modify an instance.

params = ['flavor', 'id', 'limit', 'marker', 'name', 'size', 'backup', 'availability_zone', 'configuration_id']

resize_instance()

Resize an instance flavor

resize_volume()

Resize an instance volume.

restart()

Restart the database.

class troveclient.compat.cli.LimitsCommands(parser)

Bases: troveclient.compat.common.AuthedCommandsBase

Show the rate limits and absolute limits.

list()

List the rate limits and absolute limits.

class troveclient.compat.cli.MetadataCommands(parser)

Bases: troveclient.compat.common.AuthedCommandsBase

Commands to create/update/replace/delete/show metadata for an instance

params = ['instance_id', 'metadata']

show()

Show instance metadata.

class troveclient.compat.cli.RootCommands(parser)

Bases: troveclient.compat.common.AuthedCommandsBase

Root user related operations on an instance.

create()

Enable the instance’s root user.

delete()

Disable the instance’s root user.

enabled()

Check the instance for root access.

params = ['id']

class troveclient.compat.cli.SecurityGroupCommands(parser)

Bases: troveclient.compat.common.AuthedCommandsBase

Commands to list and show Security Groups For an Instance and create and delete security group rules for them.

add_rule()

Add a security group rule.

delete_rule()

Delete a security group rule.

get()

Get a security group associated with an instance.

list()

List all the Security Groups and the rules.

params = ['id', 'secgroup_id', 'protocol', 'from_port', 'to_port', 'cidr']

class troveclient.compat.cli.UserCommands(parser)

Bases: troveclient.compat.common.AuthedCommandsBase

User CRUD operations on an instance.

access()

Show all databases the user has access to.

change_password()

Change the password of a single user.

create()

Create a user in instance, with access to one or more databases.

delete()

Delete the specified user

get()

Get a single user.

grant()

Allow an existing user permissions to access one or more databases.

list()

List all the users for an instance.

params = ['id', 'database', 'databases', 'hostname', 'name', 'password', 'new_name', 'new_host', 'new_password']

revoke()

Revoke from an existing user access permissions to a database.

update_attributes()

Update attributes of a single user.

class troveclient.compat.cli.VersionCommands(parser)

Bases: troveclient.compat.common.AuthedCommandsBase

List available versions.

list()

List all the supported versions.

params = ['url']

troveclient.compat.cli.main()