openstack-manuals/doc/common/ch_cli_trove_commands.xml

<?xml version="1.0" encoding="UTF-8"?>
<chapter 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>Database command-line client</title>
    <para>The <command>trove</command> client is the command-line interface
         (CLI) for the Database API and its extensions. This chapter documents
         <command>trove</command> version 1.0.3.
    </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>usage: trove [--version] [--debug] [--os-username &lt;auth-user-name&gt;]
             [--os-password &lt;auth-password&gt;]
             [--os-tenant-name &lt;auth-tenant-name&gt;]
             [--os-tenant-id &lt;auth-tenant-id&gt;] [--os-auth-url &lt;auth-url&gt;]
             [--os-region-name &lt;region-name&gt;] [--service-type &lt;service-type&gt;]
             [--service-name &lt;service-name&gt;] [--bypass-url &lt;bypass-url&gt;]
             [--database-service-name &lt;database-service-name&gt;]
             [--endpoint-type &lt;endpoint-type&gt;]
             [--os-database-api-version &lt;database-api-ver&gt;]
             [--os-cacert &lt;ca-certificate&gt;] [--retries &lt;retries&gt;]
             &lt;subcommand&gt; ...
</computeroutput></screen>
  <variablelist wordsize="10">
    <title>Subcommands</title>
  <varlistentry>
    <term><command>backup-create</command></term>
    <listitem>
      <para>
        Creates a backup.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>backup-delete</command></term>
    <listitem>
      <para>
        Deletes a backup.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>backup-list</command></term>
    <listitem>
      <para>
        List available backups.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>backup-list-instance</command></term>
    <listitem>
      <para>
      List available backups for an instance.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>backup-show</command></term>
    <listitem>
      <para>
        Show details of a backup.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>create</command></term>
    <listitem>
      <para>
        Creates a new instance.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>database-create</command></term>
    <listitem>
      <para>
        Creates a database on an instance.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>database-delete</command></term>
    <listitem>
      <para>
        Deletes a database.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>database-list</command></term>
    <listitem>
      <para>
        Lists available databases on an instance.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>delete</command></term>
    <listitem>
      <para>
        Deletes an instance.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>flavor-list</command></term>
    <listitem>
      <para>
        Lists available flavors.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>flavor-show</command></term>
    <listitem>
      <para>
        Show details of a flavor.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>limit-list</command></term>
    <listitem>
      <para>
        Lists the limits for a tenant.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>list</command></term>
    <listitem>
      <para>
        List all the instances.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>resize-flavor</command></term>
    <listitem>
      <para>
        Resizes the flavor of an instance.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>resize-volume</command></term>
    <listitem>
      <para>
        Resizes the volume size of an instance.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>restart</command></term>
    <listitem>
      <para>
        Restarts the instance.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>root-enable</command></term>
    <listitem>
      <para>
        Enables root for a instance.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>root-show</command></term>
    <listitem>
      <para>
        Gets root enabled status for a instance.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>secgroup-add-rule</command></term>
    <listitem>
      <para>
        Creates a security group rule.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>secgroup-delete-rule</command></term>
    <listitem>
      <para>
      Deletes a security group rule.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>secgroup-list</command></term>
    <listitem>
      <para>
        Lists all security groups.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>secgroup-show</command></term>
    <listitem>
      <para>
        Shows details about a security group.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>show</command></term>
    <listitem>
      <para>
        Show details of an instance.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>user-create</command></term>
    <listitem>
      <para>
        Creates a user.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>user-delete</command></term>
    <listitem>
      <para>
        Deletes a user from the instance.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>user-grant-access</command></term>
    <listitem>
      <para>
        Grants access to a database(s) for a user.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>user-list</command></term>
    <listitem>
      <para>
        Lists the users for a instance.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>user-revoke-access</command></term>
    <listitem>
      <para>
        Revokes access to a database for a user.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>user-show</command></term>
    <listitem>
      <para>
        Gets a user from the instance.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>user-show-access</command></term>
    <listitem>
      <para>
        Gets a users access from the instance.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>user-update-attributes</command></term>
    <listitem>
      <para>
      Updates a users attributes from the instance.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>bash-completion</command></term>
    <listitem>
      <para>
        Print arguments for bash_completion.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>help</command></term>
    <listitem>
      <para>
        Display help about this program or one of its
      subcommands.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="troveclient_command_optional">
        <title>trove optional arguments</title>
  <variablelist wordsize="10">
  <varlistentry>
    <term><command>--version</command></term>
    <listitem>
      <para>
        show program's version number and exit
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--debug</command></term>
    <listitem>
      <para>
        Print debugging output
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-username &lt;auth-user-name&gt;</command></term>
    <listitem>
      <para>
      Defaults to <code>env[OS_USERNAME]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-password &lt;auth-password&gt;</command></term>
    <listitem>
      <para>
      Defaults to <code>env[OS_PASSWORD]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-tenant-name &lt;auth-tenant-name&gt;</command></term>
    <listitem>
      <para>
      Defaults to <code>env[OS_TENANT_NAME]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-tenant-id &lt;auth-tenant-id&gt;</command></term>
    <listitem>
      <para>
      Defaults to <code>env[OS_TENANT_ID]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-auth-url &lt;auth-url&gt;</command></term>
    <listitem>
      <para>
      Defaults to <code>env[OS_AUTH_URL]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-region-name &lt;region-name&gt;</command></term>
    <listitem>
      <para>
      Defaults to <code>env[OS_REGION_NAME]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--service-type &lt;service-type&gt;</command></term>
    <listitem>
      <para>
      Defaults to database for most actions
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--service-name &lt;service-name&gt;</command></term>
    <listitem>
      <para>
      Defaults to <code>env[TROVE_SERVICE_NAME]</code>
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--bypass-url &lt;bypass-url&gt;</command></term>
    <listitem>
      <para>
      Defaults to <code>env[TROVE_BYPASS_URL]</code>
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--database-service-name &lt;database-service-name&gt;</command></term>
    <listitem>
      <para>
      Defaults to <code>env[TROVE_DATABASE_SERVICE_NAME]</code>
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--endpoint-type &lt;endpoint-type&gt;</command></term>
    <listitem>
      <para>
      Defaults to <code>env[TROVE_ENDPOINT_TYPE]</code> or publicURL.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-database-api-version &lt;database-api-ver&gt;</command></term>
    <listitem>
      <para>
      Accepts 1,defaults to <code>env[OS_DATABASE_API_VERSION]</code>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--os-cacert &lt;ca-certificate&gt;</command></term>
    <listitem>
      <para>
      Specify a CA bundle file to use in verifying a TLS
      (https) server certificate. Defaults to <code>env[OS_CACERT]</code>
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--retries &lt;retries&gt;</command></term>
    <listitem>
      <para>
        Number of retries.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="troveclient_subcommand_backup-create">
        <title>trove backup-create command</title>
        <screen><computeroutput>usage: trove backup-create [--description &lt;description&gt;] &lt;name&gt; &lt;instance&gt;
        </computeroutput></screen>
        <para>
Creates a backup.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;name&gt;</command></term>
    <listitem>
      <para>
        Name of the backup.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;instance&gt;</command></term>
    <listitem>
      <para>
        UUID of the instance.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--description &lt;description&gt;</command></term>
    <listitem>
      <para>
      An optional description for the backup.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="troveclient_subcommand_backup-delete">
        <title>trove backup-delete command</title>
        <screen><computeroutput>usage: trove backup-delete &lt;backup&gt;
        </computeroutput></screen>
        <para>
Deletes a backup.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;backup&gt;</command></term>
    <listitem>
      <para>
        ID of the backup.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="troveclient_subcommand_backup-list">
        <title>trove backup-list command</title>
        <screen><computeroutput>usage: trove backup-list
        </computeroutput></screen>
        <para>
List available backups.
        </para>    </section>
    <section xml:id="troveclient_subcommand_backup-list-instance">
        <title>trove backup-list-instance command</title>
        <screen><computeroutput>usage: trove backup-list-instance &lt;instance&gt;
        </computeroutput></screen>
        <para>
List available backups for an instance.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;instance&gt;</command></term>
    <listitem>
      <para>
        ID of the instance.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="troveclient_subcommand_backup-show">
        <title>trove backup-show command</title>
        <screen><computeroutput>usage: trove backup-show &lt;backup&gt;
        </computeroutput></screen>
        <para>
Show details of a backup.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;backup&gt;</command></term>
    <listitem>
      <para>
        ID of the backup.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="troveclient_subcommand_create">
        <title>trove create command</title>
        <screen><computeroutput>usage: trove create [--size &lt;size&gt;]
                    [--databases &lt;databases&gt; [&lt;databases&gt; ...]]
                    [--users &lt;users&gt; [&lt;users&gt; ...]] [--backup &lt;backup&gt;]
                    [--availability_zone &lt;availability_zone&gt;]
                    &lt;name&gt; &lt;flavor_id&gt;
        </computeroutput></screen>
        <para>
Creates a new instance.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;name&gt;</command></term>
    <listitem>
      <para>
        Name of the instance
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;flavor_id&gt;</command></term>
    <listitem>
      <para>
        Flavor of the instance
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--size &lt;size&gt;</command></term>
    <listitem>
      <para>
        Size of the instance disk in GB
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--databases &lt;databases&gt; [&lt;databases&gt; ...]</command></term>
    <listitem>
      <para>
      Optional list of databases.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--users &lt;users&gt; [&lt;users&gt; ...]</command></term>
    <listitem>
      <para>
      Optional list of users in the form user:password.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--backup &lt;backup&gt; A</command></term>
    <listitem>
      <para>
        backup UUID
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--availability_zone &lt;availability_zone&gt;</command></term>
    <listitem>
      <para>
      The Zone hint to give to nova
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="troveclient_subcommand_database-create">
        <title>trove database-create command</title>
        <screen><computeroutput>usage: trove database-create [--character_set &lt;character_set&gt;]
                             [--collate &lt;collate&gt;]
                             &lt;instance&gt; &lt;name&gt;
        </computeroutput></screen>
        <para>
Creates a database on an instance.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;instance&gt;</command></term>
    <listitem>
      <para>
        UUID of the instance.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;name&gt;</command></term>
    <listitem>
      <para>
        Name of the backup.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--character_set &lt;character_set&gt;</command></term>
    <listitem>
      <para>
      Optional character set for database
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--collate &lt;collate&gt;</command></term>
    <listitem>
      <para>
        Optional collation type for database
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="troveclient_subcommand_database-delete">
        <title>trove database-delete command</title>
        <screen><computeroutput>usage: trove database-delete &lt;instance&gt; &lt;database&gt;
        </computeroutput></screen>
        <para>
Deletes a database.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;instance&gt;</command></term>
    <listitem>
      <para>
        UUID of the instance.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;database&gt;</command></term>
    <listitem>
      <para>
        Name of the database.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="troveclient_subcommand_database-list">
        <title>trove database-list command</title>
        <screen><computeroutput>usage: trove database-list &lt;instance&gt;
        </computeroutput></screen>
        <para>
Lists available databases on an instance.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;instance&gt;</command></term>
    <listitem>
      <para>
        UUID of the instance.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="troveclient_subcommand_delete">
        <title>trove delete command</title>
        <screen><computeroutput>usage: trove delete &lt;instance&gt;
        </computeroutput></screen>
        <para>
Deletes an instance.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;instance&gt;</command></term>
    <listitem>
      <para>
        ID of the instance.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="troveclient_subcommand_flavor-list">
        <title>trove flavor-list command</title>
        <screen><computeroutput>usage: trove flavor-list
        </computeroutput></screen>
        <para>
Lists available flavors.
        </para>    </section>
    <section xml:id="troveclient_subcommand_flavor-show">
        <title>trove flavor-show command</title>
        <screen><computeroutput>usage: trove flavor-show &lt;flavor&gt;
        </computeroutput></screen>
        <para>
Show details of a flavor.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;flavor&gt;</command></term>
    <listitem>
      <para>
        ID of the flavor.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="troveclient_subcommand_limit-list">
        <title>trove limit-list command</title>
        <screen><computeroutput>usage: trove limit-list
        </computeroutput></screen>
        <para>
Lists the limits for a tenant.
        </para>    </section>
    <section xml:id="troveclient_subcommand_list">
        <title>trove list command</title>
        <screen><computeroutput>usage: trove list
        </computeroutput></screen>
        <para>
List all the instances.
        </para>    </section>
    <section xml:id="troveclient_subcommand_resize-flavor">
        <title>trove resize-flavor command</title>
        <screen><computeroutput>usage: trove resize-flavor &lt;instance&gt; &lt;flavor_id&gt;
        </computeroutput></screen>
        <para>
Resizes the flavor of an instance.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;instance&gt;</command></term>
    <listitem>
      <para>
        UUID of the instance
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;flavor_id&gt;</command></term>
    <listitem>
      <para>
        Flavor of the instance
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="troveclient_subcommand_resize-volume">
        <title>trove resize-volume command</title>
        <screen><computeroutput>usage: trove resize-volume &lt;instance&gt; &lt;size&gt;
        </computeroutput></screen>
        <para>
Resizes the volume size of an instance.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;instance&gt;</command></term>
    <listitem>
      <para>
        UUID of the instance
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;size&gt;</command></term>
    <listitem>
      <para>
        Size of the instance disk in GB
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="troveclient_subcommand_restart">
        <title>trove restart command</title>
        <screen><computeroutput>usage: trove restart &lt;instance&gt;
        </computeroutput></screen>
        <para>
Restarts the instance.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;instance&gt;</command></term>
    <listitem>
      <para>
        UUID of the instance
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="troveclient_subcommand_root-enable">
        <title>trove root-enable command</title>
        <screen><computeroutput>usage: trove root-enable &lt;instance&gt;
        </computeroutput></screen>
        <para>
Enables root for a instance.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;instance&gt;</command></term>
    <listitem>
      <para>
        UUID of the instance.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="troveclient_subcommand_root-show">
        <title>trove root-show command</title>
        <screen><computeroutput>usage: trove root-show &lt;instance&gt;
        </computeroutput></screen>
        <para>
Gets root enabled status for a instance.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;instance&gt;</command></term>
    <listitem>
      <para>
        UUID of the instance.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </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&gt; &lt;protocol&gt; &lt;from_port&gt;
                               &lt;to_port&gt; &lt;cidr&gt;
        </computeroutput></screen>
        <para>
Creates a security group rule.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;security_group&gt;</command></term>
    <listitem>
      <para>
        Security group name
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;protocol&gt;</command></term>
    <listitem>
      <para>
        Protocol
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;from_port&gt;</command></term>
    <listitem>
      <para>
        from port
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;to_port&gt;</command></term>
    <listitem>
      <para>
        to port
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;cidr&gt;</command></term>
    <listitem>
      <para>
        CIDR address
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </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&gt;
        </computeroutput></screen>
        <para>
Deletes a security group rule.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;security_group_rule&gt;</command></term>
    <listitem>
      <para>
      Security group rule
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="troveclient_subcommand_secgroup-list">
        <title>trove secgroup-list command</title>
        <screen><computeroutput>usage: trove secgroup-list
        </computeroutput></screen>
        <para>
Lists all security groups.
        </para>    </section>
    <section xml:id="troveclient_subcommand_secgroup-show">
        <title>trove secgroup-show command</title>
        <screen><computeroutput>usage: trove secgroup-show &lt;security_group&gt;
        </computeroutput></screen>
        <para>
Shows details about a security group.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;security_group&gt;</command></term>
    <listitem>
      <para>
        ID of the security group.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="troveclient_subcommand_show">
        <title>trove show command</title>
        <screen><computeroutput>usage: trove show &lt;instance&gt;
        </computeroutput></screen>
        <para>
Show details of an instance.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;instance&gt;</command></term>
    <listitem>
      <para>
        ID of the instance.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="troveclient_subcommand_user-create">
        <title>trove user-create command</title>
        <screen><computeroutput>usage: trove user-create [--host &lt;host&gt;]
                         [--databases &lt;databases&gt; [&lt;databases&gt; ...]]
                         &lt;instance&gt; &lt;name&gt; &lt;password&gt;
        </computeroutput></screen>
        <para>
Creates a user.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;instance&gt;</command></term>
    <listitem>
      <para>
        UUID of the instance.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;name&gt;</command></term>
    <listitem>
      <para>
        Name of user
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;password&gt;</command></term>
    <listitem>
      <para>
        Password of user
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--host &lt;host&gt;</command></term>
    <listitem>
      <para>
        Optional host of user
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--databases &lt;databases&gt; [&lt;databases&gt; ...]</command></term>
    <listitem>
      <para>
      Optional list of databases.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="troveclient_subcommand_user-delete">
        <title>trove user-delete command</title>
        <screen><computeroutput>usage: trove user-delete [--host &lt;host&gt;] &lt;instance&gt; &lt;name&gt;
        </computeroutput></screen>
        <para>
Deletes a user from the instance.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;instance&gt;</command></term>
    <listitem>
      <para>
        UUID of the instance.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;name&gt;</command></term>
    <listitem>
      <para>
        Name of user
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--host &lt;host&gt;</command></term>
    <listitem>
      <para>
        Optional host of user
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="troveclient_subcommand_user-grant-access">
        <title>trove user-grant-access command</title>
        <screen><computeroutput>usage: trove user-grant-access [--host &lt;host&gt;]
                               &lt;instance&gt; &lt;name&gt; &lt;databases&gt; [&lt;databases&gt; ...]
        </computeroutput></screen>
        <para>
Grants access to a database(s) for a user.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;instance&gt;</command></term>
    <listitem>
      <para>
        UUID of the instance.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;name&gt;</command></term>
    <listitem>
      <para>
        Name of user
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;databases&gt;</command></term>
    <listitem>
      <para>
        List of databases.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--host &lt;host&gt;</command></term>
    <listitem>
      <para>
        Optional host of user
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="troveclient_subcommand_user-list">
        <title>trove user-list command</title>
        <screen><computeroutput>usage: trove user-list &lt;instance&gt;
        </computeroutput></screen>
        <para>
Lists the users for a instance.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;instance&gt;</command></term>
    <listitem>
      <para>
        UUID of the instance.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </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&gt;] &lt;instance&gt; &lt;name&gt; &lt;database&gt;
        </computeroutput></screen>
        <para>
Revokes access to a database for a user.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;instance&gt;</command></term>
    <listitem>
      <para>
        UUID of the instance.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;name&gt;</command></term>
    <listitem>
      <para>
        Name of user
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;database&gt;</command></term>
    <listitem>
      <para>
        A single database.
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--host &lt;host&gt;</command></term>
    <listitem>
      <para>
        Optional host of user
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="troveclient_subcommand_user-show">
        <title>trove user-show command</title>
        <screen><computeroutput>usage: trove user-show [--host &lt;host&gt;] &lt;instance&gt; &lt;name&gt;
        </computeroutput></screen>
        <para>
Gets a user from the instance.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;instance&gt;</command></term>
    <listitem>
      <para>
        UUID of the instance.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;name&gt;</command></term>
    <listitem>
      <para>
        Name of user
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--host &lt;host&gt;</command></term>
    <listitem>
      <para>
        Optional host of user
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </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&gt;] &lt;instance&gt; &lt;name&gt;
        </computeroutput></screen>
        <para>
Gets a users access from the instance.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;instance&gt;</command></term>
    <listitem>
      <para>
        UUID of the instance.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;name&gt;</command></term>
    <listitem>
      <para>
        Name of user
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--host &lt;host&gt;</command></term>
    <listitem>
      <para>
        Optional host of user
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
    <section xml:id="troveclient_subcommand_user-update-attributes">
        <title>trove user-update-attributes command</title>
        <screen><computeroutput>usage: trove user-update-attributes [--host &lt;host&gt;] [--new_name &lt;new_name&gt;]
                                    [--new_password &lt;new_password&gt;]
                                    [--new_host &lt;new_host&gt;]
                                    &lt;instance&gt; &lt;name&gt;
        </computeroutput></screen>
        <para>
Updates a users attributes from the instance.
        </para>  <variablelist wordsize="10">
    <title>Positional arguments</title>
  <varlistentry>
    <term><command>&lt;instance&gt;</command></term>
    <listitem>
      <para>
        UUID of the instance.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>&lt;name&gt;</command></term>
    <listitem>
      <para>
        Name of user
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
  <variablelist wordsize="10">
    <title>Optional arguments</title>
  <varlistentry>
    <term><command>--host &lt;host&gt;</command></term>
    <listitem>
      <para>
        Optional host of user
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--new_name &lt;new_name&gt;</command></term>
    <listitem>
      <para>
      Optional new name of user
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--new_password &lt;new_password&gt;</command></term>
    <listitem>
      <para>
      Optional new password of user
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><command>--new_host &lt;new_host&gt;</command></term>
    <listitem>
      <para>
      Optional new host of user
      </para>
    </listitem>
  </varlistentry>
 </variablelist>
    </section>
</chapter>