openstack-manuals/doc/common/section_cli_trove_commands.xml

<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
    xmlns:xi="http://www.w3.org/2001/XInclude"
    xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
    xml:id="troveclient_commands">

    <!-- This file is automatically generated, do not edit -->

    <?dbhtml stop-chunking?>

    <title>trove commands</title>
    <para>The trove client is the command-line interface (CLI) for the
         OpenStack Database API and its extensions.</para>
    <para>For help on a specific <command>trove</command>
       command, enter:
    </para>
    <screen><prompt>$</prompt> <userinput><command>trove</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>

    <section xml:id="troveclient_command_usage">
       <title>trove usage</title>
        <screen><computeroutput>             [--os-password &lt;auth-password>]
             [--os-tenant-name &lt;auth-tenant-name>]
             [--os-tenant-id &lt;auth-tenant-id>] [--os-auth-url &lt;auth-url>]
             [--os-region-name &lt;region-name>] [--service-type &lt;service-type>]
             [--service-name &lt;service-name>] [--bypass-url &lt;bypass-url>]
             [--database-service-name &lt;database-service-name>]
             [--endpoint-type &lt;endpoint-type>]
             [--os-database-api-version &lt;database-api-ver>]
             [--os-cacert &lt;ca-certificate>] [--retries &lt;retries>] [--json]
             &lt;subcommand> ...</computeroutput></screen>
    </section>
    <section xml:id="troveclient_command_pos">
        <title>trove positional arguments</title>
        <screen><computeroutput>  &lt;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.
</computeroutput></screen>
    </section>
    <section xml:id="troveclient_command_optional">
        <title>trove optional arguments</title>
        <screen><computeroutput>  --version             show program's version number and exit
  --debug               Print debugging output
  --os-username &lt;auth-user-name>
                        Defaults to env[OS_USERNAME].
  --os-password &lt;auth-password>
                        Defaults to env[OS_PASSWORD].
  --os-tenant-name &lt;auth-tenant-name>
                        Defaults to env[OS_TENANT_NAME].
  --os-tenant-id &lt;auth-tenant-id>
                        Defaults to env[OS_TENANT_ID].
  --os-auth-url &lt;auth-url>
                        Defaults to env[OS_AUTH_URL].
  --os-region-name &lt;region-name>
                        Defaults to env[OS_REGION_NAME].
  --service-type &lt;service-type>
                        Defaults to database for most actions
  --service-name &lt;service-name>
                        Defaults to env[TROVE_SERVICE_NAME]
  --bypass-url &lt;bypass-url>
                        Defaults to env[TROVE_BYPASS_URL]
  --database-service-name &lt;database-service-name>
                        Defaults to env[TROVE_DATABASE_SERVICE_NAME]
  --endpoint-type &lt;endpoint-type>
                        Defaults to env[TROVE_ENDPOINT_TYPE] or publicURL.
  --os-database-api-version &lt;database-api-ver>
                        Accepts 1,defaults to env[OS_DATABASE_API_VERSION].
  --os-cacert &lt;ca-certificate>
                        Specify a CA bundle file to use in verifying a TLS
                        (https) server certificate. Defaults to env[OS_CACERT]
  --retries &lt;retries>   Number of retries.
  --json, --os-json-output
                        Output json instead of prettyprint. Defaults to
                        OS_JSON_OUTPUT
</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_backup-create">
        <title>trove backup-create command</title>
        <screen><computeroutput>usage: trove backup-create [--description &lt;description>] &lt;name> &lt;instance>

Creates a backup.

Positional arguments:
  &lt;name>                Name of the backup.
  &lt;instance>            UUID of the instance.

Optional arguments:
  --description &lt;description>
                        An optional description for the backup.

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_backup-delete">
        <title>trove backup-delete command</title>
        <screen><computeroutput>usage: trove backup-delete &lt;backup>

Deletes a backup.

Positional arguments:
  &lt;backup>  ID of the backup.

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_backup-list">
        <title>trove backup-list command</title>
        <screen><computeroutput>usage: trove backup-list [--limit &lt;limit>]

List available backups.

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

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_backup-list-instance">
        <title>trove backup-list-instance command</title>
        <screen><computeroutput>usage: trove backup-list-instance [--limit &lt;limit>] &lt;instance>

List available backups for an instance.

Positional arguments:
  &lt;instance>       ID of the instance.

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

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_backup-show">
        <title>trove backup-show command</title>
        <screen><computeroutput>usage: trove backup-show &lt;backup>

Show details of a backup.

Positional arguments:
  &lt;backup>  ID of the backup.

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_create">
        <title>trove create command</title>
        <screen><computeroutput>usage: trove create &lt;name> &lt;flavor_id>
                    [--size &lt;size>]
                    [--databases &lt;databases> [&lt;databases> ...]]
                    [--users &lt;users> [&lt;users> ...]] [--backup &lt;backup>]
                    [--availability_zone &lt;availability_zone>]
                    [--datastore &lt;datastore>]
                    [--datastore_version &lt;datastore_version>]

Creates a new instance.

Positional arguments:
  &lt;name>                Name of the instance
  &lt;flavor_id>           Flavor of the instance

Optional arguments:
  --size &lt;size>         Size of the instance disk in GB
  --databases &lt;databases> [&lt;databases> ...]
                        Optional list of databases.
  --users &lt;users> [&lt;users> ...]
                        Optional list of users in the form user:password.
  --backup &lt;backup>     A backup UUID
  --availability_zone &lt;availability_zone>
                        The Zone hint to give to nova
  --datastore &lt;datastore>
                        A datastore name or UUID
  --datastore_version &lt;datastore_version>
                        A datastore version name or UUID

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_database-create">
        <title>trove database-create command</title>
        <screen><computeroutput>usage: trove database-create &lt;instance> &lt;name>
                             [--character_set &lt;character_set>]
                             [--collate &lt;collate>]

Creates a database on an instance.

Positional arguments:
  &lt;instance>            UUID of the instance.
  &lt;name>                Name of the database.

Optional arguments:
  --character_set &lt;character_set>
                        Optional character set for database
  --collate &lt;collate>   Optional collation type for database

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_database-delete">
        <title>trove database-delete command</title>
        <screen><computeroutput>usage: trove database-delete &lt;instance> &lt;database>

Deletes a database.

Positional arguments:
  &lt;instance>  UUID of the instance.
  &lt;database>  Name of the database.

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_database-list">
        <title>trove database-list command</title>
        <screen><computeroutput>usage: trove database-list &lt;instance>

Lists available databases on an instance.

Positional arguments:
  &lt;instance>  UUID of the instance.

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_datastore-list">
        <title>trove datastore-list command</title>
        <screen><computeroutput>usage: trove datastore-list

List available datastores.

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_datastore-show">
        <title>trove datastore-show command</title>
        <screen><computeroutput>usage: trove datastore-show &lt;datastore>

Show details of a datastore.

Positional arguments:
  &lt;datastore>  ID of the datastore.

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_datastore-version-list">
        <title>trove datastore-version-list command</title>
        <screen><computeroutput>usage: trove datastore-version-list &lt;datastore>

List available versions for a datastore.

Positional arguments:
  &lt;datastore>  ID of the datastore.

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_datastore-version-show">
        <title>trove datastore-version-show command</title>
        <screen><computeroutput>usage: trove datastore-version-show &lt;datastore_version>
                                    [--datastore &lt;datastore>]

Show details of a datastore version.

Positional arguments:
  &lt;datastore_version>   ID of the datastore version.

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

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_delete">
        <title>trove delete command</title>
        <screen><computeroutput>usage: trove delete &lt;instance>

Deletes an instance.

Positional arguments:
  &lt;instance>  ID of the instance.

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_flavor-list">
        <title>trove flavor-list command</title>
        <screen><computeroutput>usage: trove flavor-list

Lists available flavors.

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_flavor-show">
        <title>trove flavor-show command</title>
        <screen><computeroutput>usage: trove flavor-show &lt;flavor>

Show details of a flavor.

Positional arguments:
  &lt;flavor>  ID of the flavor.

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_limit-list">
        <title>trove limit-list command</title>
        <screen><computeroutput>usage: trove limit-list

Lists the limits for a tenant.

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_list">
        <title>trove list command</title>
        <screen><computeroutput>usage: trove list

List all the instances.

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_resize-flavor">
        <title>trove resize-flavor command</title>
        <screen><computeroutput>usage: trove resize-flavor &lt;instance> &lt;flavor_id>

Resizes the flavor of an instance.

Positional arguments:
  &lt;instance>   UUID of the instance
  &lt;flavor_id>  Flavor of the instance

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_resize-volume">
        <title>trove resize-volume command</title>
        <screen><computeroutput>usage: trove resize-volume &lt;instance> &lt;size>

Resizes the volume size of an instance.

Positional arguments:
  &lt;instance>  UUID of the instance
  &lt;size>      Size of the instance disk in GB

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_restart">
        <title>trove restart command</title>
        <screen><computeroutput>usage: trove restart &lt;instance>

Restarts the instance.

Positional arguments:
  &lt;instance>  UUID of the instance

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_root-enable">
        <title>trove root-enable command</title>
        <screen><computeroutput>usage: trove root-enable &lt;instance>

Enables root for a instance.

Positional arguments:
  &lt;instance>  UUID of the instance.

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_root-show">
        <title>trove root-show command</title>
        <screen><computeroutput>usage: trove root-show &lt;instance>

Gets root enabled status for a instance.

Positional arguments:
  &lt;instance>  UUID of the instance.

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_secgroup-add-rule">
        <title>trove secgroup-add-rule command</title>
        <screen><computeroutput>usage: trove secgroup-add-rule &lt;security_group> &lt;protocol> &lt;from_port>
                               &lt;to_port> &lt;cidr>

Creates a security group rule.

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

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_secgroup-delete-rule">
        <title>trove secgroup-delete-rule command</title>
        <screen><computeroutput>usage: trove secgroup-delete-rule &lt;security_group_rule>

Deletes a security group rule.

Positional arguments:
  &lt;security_group_rule>
                        Security group rule

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_secgroup-list">
        <title>trove secgroup-list command</title>
        <screen><computeroutput>usage: trove secgroup-list

Lists all security groups.

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_secgroup-show">
        <title>trove secgroup-show command</title>
        <screen><computeroutput>usage: trove secgroup-show &lt;security_group>

Shows details about a security group.

Positional arguments:
  &lt;security_group>  ID of the security group.

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_show">
        <title>trove show command</title>
        <screen><computeroutput>usage: trove show &lt;instance>

Show details of an instance.

Positional arguments:
  &lt;instance>  ID of the instance.

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_user-create">
        <title>trove user-create command</title>
        <screen><computeroutput>usage: trove user-create &lt;instance> &lt;name> &lt;password>
                         [--host &lt;host>]
                         [--databases &lt;databases> [&lt;databases> ...]]

Creates a user.

Positional arguments:
  &lt;instance>            UUID of the instance.
  &lt;name>                Name of user
  &lt;password>            Password of user

Optional arguments:
  --host &lt;host>         Optional host of user
  --databases &lt;databases> [&lt;databases> ...]
                        Optional list of databases.

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_user-delete">
        <title>trove user-delete command</title>
        <screen><computeroutput>usage: trove user-delete [--host &lt;host>] &lt;instance> &lt;name>

Deletes a user from the instance.

Positional arguments:
  &lt;instance>     UUID of the instance.
  &lt;name>         Name of user

Optional arguments:
  --host &lt;host>  Optional host of user

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_user-grant-access">
        <title>trove user-grant-access command</title>
        <screen><computeroutput>usage: trove user-grant-access &lt;instance> &lt;name> &lt;databases> [&lt;databases> ...]
                               [--host &lt;host>]

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

Positional arguments:
  &lt;instance>     UUID of the instance.
  &lt;name>         Name of user
  &lt;databases>    List of databases.

Optional arguments:
  --host &lt;host>  Optional host of user

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_user-list">
        <title>trove user-list command</title>
        <screen><computeroutput>usage: trove user-list &lt;instance>

Lists the users for a instance.

Positional arguments:
  &lt;instance>  UUID of the instance.

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_user-revoke-access">
        <title>trove user-revoke-access command</title>
        <screen><computeroutput>usage: trove user-revoke-access [--host &lt;host>] &lt;instance> &lt;name> &lt;database>

Revokes access to a database for a user.

Positional arguments:
  &lt;instance>     UUID of the instance.
  &lt;name>         Name of user
  &lt;database>     A single database.

Optional arguments:
  --host &lt;host>  Optional host of user

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_user-show">
        <title>trove user-show command</title>
        <screen><computeroutput>usage: trove user-show [--host &lt;host>] &lt;instance> &lt;name>

Gets a user from the instance.

Positional arguments:
  &lt;instance>     UUID of the instance.
  &lt;name>         Name of user

Optional arguments:
  --host &lt;host>  Optional host of user

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_user-show-access">
        <title>trove user-show-access command</title>
        <screen><computeroutput>usage: trove user-show-access [--host &lt;host>] &lt;instance> &lt;name>

Gets a users access from the instance.

Positional arguments:
  &lt;instance>     UUID of the instance.
  &lt;name>         Name of user

Optional arguments:
  --host &lt;host>  Optional host of user

</computeroutput></screen>
    </section>
    <section xml:id="troveclient_subcommand_user-update-attributes">
        <title>trove user-update-attributes command</title>
        <screen><computeroutput>usage: trove user-update-attributes &lt;instance> &lt;name>
                                    [--host &lt;host>] [--new_name &lt;new_name>]
                                    [--new_password &lt;new_password>]
                                    [--new_host &lt;new_host>]

Updates a users attributes from the instance.

Positional arguments:
  &lt;instance>            UUID of the instance.
  &lt;name>                Name of user

Optional arguments:
  --host &lt;host>         Optional host of user
  --new_name &lt;new_name>
                        Optional new name of user
  --new_password &lt;new_password>
                        Optional new password of user
  --new_host &lt;new_host>
                        Optional new host of user

</computeroutput></screen>
    </section>
</section>