trove commands

The trove client is the command-line interface (CLI) for the OpenStack Database API and its extensions.

For help on a specific trove command, enter:

$ trove help COMMAND

 trove usage

             [--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>] [--json]
             <subcommand> ...

 trove positional arguments

  <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.
    datastore-list      List available datastores.
    datastore-show      Show details of a datastore.
    datastore-version-list
                        List available versions for a datastore.
    datastore-version-show
                        Show details of a datastore version.
    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.

 trove optional arguments

  --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.
  --json, --os-json-output
                        Output json instead of prettyprint. Defaults to
                        OS_JSON_OUTPUT

 trove backup-create command

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

Creates a backup.

Positional arguments:
  <name>                Name of the backup.
  <instance>            UUID of the instance.

Optional arguments:
  --description <description>
                        An optional description for the backup.

 trove backup-delete command

usage: trove backup-delete <backup>

Deletes a backup.

Positional arguments:
  <backup>  ID of the backup.

 trove backup-list command

usage: trove backup-list [--limit <limit>]

List available backups.

Optional arguments:
  --limit <limit>  Return up to N number of the most recent backups.

 trove backup-list-instance command

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

List available backups for an instance.

Positional arguments:
  <instance>       ID of the instance.

Optional arguments:
  --limit <limit>  Return up to N number of the most recent backups.

 trove backup-show command

usage: trove backup-show <backup>

Show details of a backup.

Positional arguments:
  <backup>  ID of the backup.

 trove create command

usage: trove create <name> <flavor_id>
                    [--size <size>]
                    [--databases <databases> [<databases> ...]]
                    [--users <users> [<users> ...]] [--backup <backup>]
                    [--availability_zone <availability_zone>]
                    [--datastore <datastore>]
                    [--datastore_version <datastore_version>]

Creates a new instance.

Positional arguments:
  <name>                Name of the instance
  <flavor_id>           Flavor of the instance

Optional arguments:
  --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
  --datastore <datastore>
                        A datastore name or UUID
  --datastore_version <datastore_version>
                        A datastore version name or UUID

 trove database-create command

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

Creates a database on an instance.

Positional arguments:
  <instance>            UUID 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 command

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

Deletes a database.

Positional arguments:
  <instance>  UUID of the instance.
  <database>  Name of the database.

 trove database-list command

usage: trove database-list <instance>

Lists available databases on an instance.

Positional arguments:
  <instance>  UUID of the instance.

 trove datastore-list command

usage: trove datastore-list

List available datastores.

 trove datastore-show command

usage: trove datastore-show <datastore>

Show details of a datastore.

Positional arguments:
  <datastore>  ID of the datastore.

 trove datastore-version-list command

usage: trove datastore-version-list <datastore>

List available versions for a datastore.

Positional arguments:
  <datastore>  ID of the datastore.

 trove datastore-version-show command

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

Show details of a datastore version.

Positional arguments:
  <datastore_version>   ID of the datastore version.

Optional arguments:
  --datastore <datastore>
                        ID or name of the datastore. Optional if UUID of the
                        datastore_version is provided.

 trove delete command

usage: trove delete <instance>

Deletes an instance.

Positional arguments:
  <instance>  ID of the instance.

 trove flavor-list command

usage: trove flavor-list

Lists available flavors.

 trove flavor-show command

usage: trove flavor-show <flavor>

Show details of a flavor.

Positional arguments:
  <flavor>  ID of the flavor.

 trove limit-list command

usage: trove limit-list

Lists the limits for a tenant.

 trove list command

usage: trove list

List all the instances.

 trove resize-flavor command

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

Resizes the flavor of an instance.

Positional arguments:
  <instance>   UUID of the instance
  <flavor_id>  Flavor of the instance

 trove resize-volume command

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

Resizes the volume size of an instance.

Positional arguments:
  <instance>  UUID of the instance
  <size>      Size of the instance disk in GB

 trove restart command

usage: trove restart <instance>

Restarts the instance.

Positional arguments:
  <instance>  UUID of the instance

 trove root-enable command

usage: trove root-enable <instance>

Enables root for a instance.

Positional arguments:
  <instance>  UUID of the instance.

 trove root-show command

usage: trove root-show <instance>

Gets root enabled status for a instance.

Positional arguments:
  <instance>  UUID of the instance.

 trove secgroup-add-rule command

usage: trove secgroup-add-rule <security_group> <protocol> <from_port>
                               <to_port> <cidr>

Creates a security group rule.

Positional arguments:
  <security_group>  Security group name
  <protocol>        Protocol
  <from_port>       from port
  <to_port>         to port
  <cidr>            CIDR address

 trove secgroup-delete-rule command

usage: trove secgroup-delete-rule <security_group_rule>

Deletes a security group rule.

Positional arguments:
  <security_group_rule>
                        Security group rule

 trove secgroup-list command

usage: trove secgroup-list

Lists all security groups.

 trove secgroup-show command

usage: trove secgroup-show <security_group>

Shows details about a security group.

Positional arguments:
  <security_group>  ID of the security group.

 trove show command

usage: trove show <instance>

Show details of an instance.

Positional arguments:
  <instance>  ID of the instance.

 trove user-create command

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

Creates a user.

Positional arguments:
  <instance>            UUID 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 command

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

Deletes a user from the instance.

Positional arguments:
  <instance>     UUID of the instance.
  <name>         Name of user

Optional arguments:
  --host <host>  Optional host of user

 trove user-grant-access command

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

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

Positional arguments:
  <instance>     UUID of the instance.
  <name>         Name of user
  <databases>    List of databases.

Optional arguments:
  --host <host>  Optional host of user

 trove user-list command

usage: trove user-list <instance>

Lists the users for a instance.

Positional arguments:
  <instance>  UUID of the instance.

 trove user-revoke-access command

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

Revokes access to a database for a user.

Positional arguments:
  <instance>     UUID of the instance.
  <name>         Name of user
  <database>     A single database.

Optional arguments:
  --host <host>  Optional host of user

 trove user-show command

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

Gets a user from the instance.

Positional arguments:
  <instance>     UUID of the instance.
  <name>         Name of user

Optional arguments:
  --host <host>  Optional host of user

 trove user-show-access command

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

Gets a users access from the instance.

Positional arguments:
  <instance>     UUID of the instance.
  <name>         Name of user

Optional arguments:
  --host <host>  Optional host of user

 trove user-update-attributes command

usage: trove user-update-attributes <instance> <name>
                                    [--host <host>] [--new_name <new_name>]
                                    [--new_password <new_password>]
                                    [--new_host <new_host>]

Updates a users attributes from the instance.

Positional arguments:
  <instance>            UUID 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

Log a bug against this page

loading table of contents...