openstack/openstack-manuals
Code Issues Proposed changes
c9bf0b40fb
openstack-manuals/doc/cli-reference/generated/ch_cli_trove_commands.xml
Peter Stachowski 38323fb21b Update Trove CLI doc to version 1.3.0 
Trove recently release version 1.3.0 of the python client:
https://pypi.python.org/pypi/python-troveclient

The CLI documention has been updated to reflect the new release.

Change-Id: I41f31057ecc4756cf2845d9eee96d7ccea3886ff
Closes-Bug: #1496576
2015-09-17 14:36:58 +00:00

2843 lines
82 KiB
XML
Raw Blame History

<?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 service 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
<literal>1.3.0</literal>.
</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-auth-system &lt;auth-system&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;]
[--retries &lt;retries&gt;] [--json] [--profile HMAC_KEY] [--insecure]
[--os-cacert &lt;ca-certificate&gt;] [--os-cert &lt;certificate&gt;]
[--os-key &lt;key&gt;] [--timeout &lt;seconds&gt;]
[--os-auth-url OS_AUTH_URL] [--os-domain-id OS_DOMAIN_ID]
[--os-domain-name OS_DOMAIN_NAME] [--os-project-id OS_PROJECT_ID]
[--os-project-name OS_PROJECT_NAME]
[--os-project-domain-id OS_PROJECT_DOMAIN_ID]
[--os-project-domain-name OS_PROJECT_DOMAIN_NAME]
[--os-trust-id OS_TRUST_ID] [--os-user-id OS_USER_ID]
[--os-user-name OS_USERNAME]
[--os-user-domain-id OS_USER_DOMAIN_ID]
[--os-user-domain-name OS_USER_DOMAIN_NAME]
[--os-password OS_PASSWORD] [--os-tenant-name &lt;auth-tenant-name&gt;]
[--os-tenant-id &lt;tenant-id&gt;] [--os-auth-token OS_AUTH_TOKEN]
[--os-region-name &lt;region-name&gt;]
&lt;subcommand&gt; ...</computeroutput></screen>
<variablelist wordsize="10">
<title>Subcommands</title>
<varlistentry>
<term><command>backup-copy</command></term>
<listitem>
<para>
Creates a backup from another backup.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>backup-create</command></term>
<listitem>
<para>
Creates a backup of an instance.
</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>
Lists available backups.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>backup-list-instance</command></term>
<listitem>
<para>
Lists available backups for an instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>backup-show</command></term>
<listitem>
<para>
Shows details of a backup.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cluster-create</command></term>
<listitem>
<para>
Creates a new cluster.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cluster-delete</command></term>
<listitem>
<para>
Deletes a cluster.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cluster-grow</command></term>
<listitem>
<para>
Adds more instances to a cluster.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cluster-instances</command></term>
<listitem>
<para>
Lists all instances of a cluster.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cluster-list</command></term>
<listitem>
<para>
Lists all the clusters.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cluster-show</command></term>
<listitem>
<para>
Shows details of a cluster.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>cluster-shrink</command></term>
<listitem>
<para>
Drops instances from a cluster.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>configuration-attach</command></term>
<listitem>
<para>
Attaches a configuration group to an
instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>configuration-create</command></term>
<listitem>
<para>
Creates a configuration group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>configuration-default</command></term>
<listitem>
<para>
Shows the default configuration of an
instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>configuration-delete</command></term>
<listitem>
<para>
Deletes a configuration group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>configuration-detach</command></term>
<listitem>
<para>
Detaches a configuration group from an
instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>configuration-instances</command></term>
<listitem>
<para>
Lists all instances associated with a
configuration group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>configuration-list</command></term>
<listitem>
<para>
Lists all configuration groups.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>configuration-parameter-list</command></term>
<listitem>
<para>
Lists available parameters for a
configuration group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>configuration-parameter-show</command></term>
<listitem>
<para>
Shows details of a configuration parameter.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>configuration-patch</command></term>
<listitem>
<para>
Patches a configuration group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>configuration-show</command></term>
<listitem>
<para>
Shows details of a configuration group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>configuration-update</command></term>
<listitem>
<para>
Updates a configuration group.
</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 from an instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>database-list</command></term>
<listitem>
<para>
Lists available databases on an instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>datastore-list</command></term>
<listitem>
<para>
Lists available datastores.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>datastore-show</command></term>
<listitem>
<para>
Shows details of a datastore.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>datastore-version-list</command></term>
<listitem>
<para>
Lists available versions for a datastore.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>datastore-version-show</command></term>
<listitem>
<para>
Shows details of a datastore version.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>delete</command></term>
<listitem>
<para>
Deletes an instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>detach-replica</command></term>
<listitem>
<para>
Detaches a replica instance from its
replication source.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>eject-replica-source</command></term>
<listitem>
<para>
Ejects a replica source from its set.
</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>
Shows 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>
Lists all the instances.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>metadata-create</command></term>
<listitem>
<para>
Creates metadata in the database for
instance &lt;id&gt;.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>metadata-delete</command></term>
<listitem>
<para>
Deletes metadata for instance &lt;id&gt;.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>metadata-edit</command></term>
<listitem>
<para>
Replaces metadata value with a new one, this
is non-destructive.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>metadata-list</command></term>
<listitem>
<para>
Shows all metadata for instance &lt;id&gt;.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>metadata-show</command></term>
<listitem>
<para>
Shows metadata entry for key &lt;key&gt; and
instance &lt;id&gt;.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>metadata-update</command></term>
<listitem>
<para>
Updates metadata, this is destructive.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>promote-to-replica-source</command></term>
<listitem>
<para>
Promotes a replica to be the new replica
source of its set.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>resize-instance</command></term>
<listitem>
<para>
Resizes an instance with a new flavor.
</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 an instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>root-enable</command></term>
<listitem>
<para>
Enables root for an instance and resets if
already exists.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>root-show</command></term>
<listitem>
<para>
Gets status if root was ever enabled for an
instance or cluster.
</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-list-rules</command></term>
<listitem>
<para>
Lists all rules for a security group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>secgroup-show</command></term>
<listitem>
<para>
Shows details of a security group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>show</command></term>
<listitem>
<para>
Shows details of an instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>update</command></term>
<listitem>
<para>
Updates an instance: Edits name,
configuration, or replica source.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>user-create</command></term>
<listitem>
<para>
Creates a user on an instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>user-delete</command></term>
<listitem>
<para>
Deletes a user from an 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 an 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>
Shows details of a user of an instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>user-show-access</command></term>
<listitem>
<para>
Shows access details of a user of an
instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>user-update-attributes</command></term>
<listitem>
<para>
Updates a user's attributes on an instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>bash-completion</command></term>
<listitem>
<para>
Prints arguments for bash_completion.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>help</command></term>
<listitem>
<para>
Displays 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-auth-system &lt;auth-system&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_AUTH_SYSTEM]</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>--retries &lt;retries&gt;</command></term>
<listitem>
<para>
Number of retries.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--json, --os-json-output</command></term>
<listitem>
<para>
Output JSON instead of prettyprint. Defaults
to <code>env[OS_JSON_OUTPUT]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--profile HMAC_KEY HMAC</command></term>
<listitem>
<para>
key used to encrypt context data when
profiling the performance of an operation.
This key should be set to one of the HMAC
keys configured in Trove (they are found in
api-paste.ini, typically in /etc/trove).
Without the key, profiling will not be
triggered even if it is enabled on the
server side. Defaults to
<code>env[OS_PROFILE_HMACKEY]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--insecure</command></term>
<listitem>
<para>
Explicitly allow client to perform
"insecure" TLS (https) requests. The
server's certificate will not be verified
against any certificate authorities. This
option should be used with caution.
</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>--os-cert &lt;certificate&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_CERT]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-key &lt;key&gt;</command></term>
<listitem>
<para>
Defaults to <code>env[OS_KEY]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--timeout &lt;seconds&gt;</command></term>
<listitem>
<para>
Set request timeout (in seconds).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-auth-url OS_AUTH_URL</command></term>
<listitem>
<para>
Authentication URL
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-domain-id OS_DOMAIN_ID</command></term>
<listitem>
<para>
Domain ID to scope to
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-domain-name OS_DOMAIN_NAME</command></term>
<listitem>
<para>
Domain name to scope to
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-project-id OS_PROJECT_ID</command></term>
<listitem>
<para>
Project ID to scope to
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-project-name OS_PROJECT_NAME</command></term>
<listitem>
<para>
Project name to scope to
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-project-domain-id OS_PROJECT_DOMAIN_ID</command></term>
<listitem>
<para>
Domain ID containing project
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-project-domain-name OS_PROJECT_DOMAIN_NAME</command></term>
<listitem>
<para>
Domain name containing project
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-trust-id OS_TRUST_ID</command></term>
<listitem>
<para>
Trust ID
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-user-id OS_USER_ID</command></term>
<listitem>
<para>
User ID
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-user-name OS_USERNAME, --os-username OS_USERNAME</command></term>
<listitem>
<para>
Username
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-user-domain-id OS_USER_DOMAIN_ID</command></term>
<listitem>
<para>
User's domain id
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-user-domain-name OS_USER_DOMAIN_NAME</command></term>
<listitem>
<para>
User's domain name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-password OS_PASSWORD</command></term>
<listitem>
<para>
User's password
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-tenant-name &lt;auth-tenant-name&gt;</command></term>
<listitem>
<para>
Tenant to request authorization on. Defaults
to <code>env[OS_TENANT_NAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-tenant-id &lt;tenant-id&gt;</command></term>
<listitem>
<para>
Tenant to request authorization on. Defaults
to <code>env[OS_TENANT_ID]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-auth-token OS_AUTH_TOKEN</command></term>
<listitem>
<para>
Defaults to <code>env[OS_AUTH_TOKEN]</code>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-region-name &lt;region-name&gt;</command></term>
<listitem>
<para>
Specify the region to use. Defaults to
<code>env[OS_REGION_NAME]</code>.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_backup-copy">
<title>trove backup-copy</title>
<screen><computeroutput>usage: trove backup-copy &lt;name&gt; &lt;backup&gt;
[--region &lt;region&gt;] [--description &lt;description&gt;]</computeroutput></screen>
<para>
Creates a backup from another 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;backup&gt;</command></term>
<listitem>
<para>
Backup ID of the source backup.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--region &lt;region&gt;</command></term>
<listitem>
<para>
Region where the source backup resides.
</para>
</listitem>
</varlistentry>
<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-create">
<title>trove backup-create</title>
<screen><computeroutput>usage: trove backup-create &lt;instance&gt; &lt;name&gt;
[--description &lt;description&gt;] [--parent &lt;parent&gt;]</computeroutput></screen>
<para>
Creates a backup of an instance.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<listitem>
<para>
ID or name 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>--description &lt;description&gt;</command></term>
<listitem>
<para>
An optional description for the backup.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--parent &lt;parent&gt;</command></term>
<listitem>
<para>
Optional ID of the parent backup to perform an
incremental backup from.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_backup-delete">
<title>trove backup-delete</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</title>
<screen><computeroutput>usage: trove backup-list [--limit &lt;limit&gt;] [--marker &lt;ID&gt;]
[--datastore &lt;datastore&gt;]</computeroutput></screen>
<para>
Lists available backups.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--limit &lt;limit&gt;</command></term>
<listitem>
<para>
Return up to N number of the most recent backups.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--marker &lt;ID&gt;</command></term>
<listitem>
<para>
Begin displaying the results for IDs greater than
the specified marker. When used with --limit, set
this to the last ID displayed in the previous run.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--datastore &lt;datastore&gt;</command></term>
<listitem>
<para>
Name or ID of the datastore to list backups for.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_backup-list-instance">
<title>trove backup-list-instance</title>
<screen><computeroutput>usage: trove backup-list-instance [--limit &lt;limit&gt;] [--marker &lt;ID&gt;] &lt;instance&gt;</computeroutput></screen>
<para>
Lists available backups for an instance.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<listitem>
<para>
ID or name of the instance.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--limit &lt;limit&gt;</command></term>
<listitem>
<para>
Return up to N number of the most recent backups.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--marker &lt;ID&gt;</command></term>
<listitem>
<para>
Begin displaying the results for IDs greater than the
specified marker. When used with --limit, set this to the
last ID displayed in the previous run.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_backup-show">
<title>trove backup-show</title>
<screen><computeroutput>usage: trove backup-show &lt;backup&gt;</computeroutput></screen>
<para>
Shows 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_cluster-create">
<title>trove cluster-create</title>
<screen><computeroutput>usage: trove cluster-create &lt;name&gt; &lt;datastore&gt; &lt;datastore_version&gt;
[--instance &lt;flavor=flavor_name_or_id,volume=volume&gt;]</computeroutput></screen>
<para>
Creates a new cluster.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;name&gt;</command></term>
<listitem>
<para>
Name of the cluster.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;datastore&gt;</command></term>
<listitem>
<para>
A datastore name or UUID.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;datastore_version&gt;</command></term>
<listitem>
<para>
A datastore version name or UUID.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--instance &lt;flavor=flavor_name_or_id,volume=volume&gt;</command></term>
<listitem>
<para>
Create an instance for the cluster. Specify
multiple times to create multiple instances.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_cluster-delete">
<title>trove cluster-delete</title>
<screen><computeroutput>usage: trove cluster-delete &lt;cluster&gt;</computeroutput></screen>
<para>
Deletes a cluster.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;cluster&gt;</command></term>
<listitem>
<para>
ID or name of the cluster.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_cluster-grow">
<title>trove cluster-grow</title>
<screen><computeroutput>usage: trove cluster-grow &lt;cluster&gt;
[--instance &lt;name=name,flavor=flavor_name_or_id,volume=volume&gt;]</computeroutput></screen>
<para>
Adds more instances to a cluster.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;cluster&gt;</command></term>
<listitem>
<para>
ID or name of the cluster.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--instance &lt;name=name,flavor=flavor_name_or_id,volume=volume&gt;</command></term>
<listitem>
<para>
Add an instance to the cluster. Specify
multiple times to create multiple instances.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_cluster-instances">
<title>trove cluster-instances</title>
<screen><computeroutput>usage: trove cluster-instances &lt;cluster&gt;</computeroutput></screen>
<para>
Lists all instances of a cluster.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;cluster&gt;</command></term>
<listitem>
<para>
ID or name of the cluster.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_cluster-list">
<title>trove cluster-list</title>
<screen><computeroutput>usage: trove cluster-list [--limit &lt;limit&gt;] [--marker &lt;ID&gt;]</computeroutput></screen>
<para>
Lists all the clusters.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--limit &lt;limit&gt;</command></term>
<listitem>
<para>
Limit the number of results displayed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--marker &lt;ID&gt;</command></term>
<listitem>
<para>
Begin displaying the results for IDs greater than the
specified marker. When used with --limit, set this to the
last ID displayed in the previous run.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_cluster-show">
<title>trove cluster-show</title>
<screen><computeroutput>usage: trove cluster-show &lt;cluster&gt;</computeroutput></screen>
<para>
Shows details of a cluster.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;cluster&gt;</command></term>
<listitem>
<para>
ID or name of the cluster.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_cluster-shrink">
<title>trove cluster-shrink</title>
<screen><computeroutput>usage: trove cluster-shrink &lt;cluster&gt; &lt;instance&gt; [&lt;instance&gt; ...]</computeroutput></screen>
<para>
Drops instances from a cluster.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;cluster&gt;</command></term>
<listitem>
<para>
ID or name of the cluster.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<listitem>
<para>
Drop instance(s) from the cluster. Specify multiple ids to drop
multiple instances.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_configuration-attach">
<title>trove configuration-attach</title>
<screen><computeroutput>usage: trove configuration-attach &lt;instance&gt; &lt;configuration&gt;</computeroutput></screen>
<para>
Attaches a configuration group to an instance.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<listitem>
<para>
ID or name of the instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;configuration&gt;</command></term>
<listitem>
<para>
ID of the configuration group to attach to the instance.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_configuration-create">
<title>trove configuration-create</title>
<screen><computeroutput>usage: trove configuration-create &lt;name&gt; &lt;values&gt;
[--datastore &lt;datastore&gt;]
[--datastore_version &lt;datastore_version&gt;]
[--description &lt;description&gt;]</computeroutput></screen>
<para>
Creates a configuration group.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;name&gt;</command></term>
<listitem>
<para>
Name of the configuration group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;values&gt;</command></term>
<listitem>
<para>
Dictionary of the values to set.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--datastore &lt;datastore&gt;</command></term>
<listitem>
<para>
Datastore assigned to the configuration
group. Required if default datastore is not
configured.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--datastore_version &lt;datastore_version&gt;</command></term>
<listitem>
<para>
Datastore version ID assigned to the
configuration group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description &lt;description&gt;</command></term>
<listitem>
<para>
An optional description for the
configuration group.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_configuration-default">
<title>trove configuration-default</title>
<screen><computeroutput>usage: trove configuration-default &lt;instance&gt;</computeroutput></screen>
<para>
Shows the default configuration of an instance.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<listitem>
<para>
ID or name of the instance.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_configuration-delete">
<title>trove configuration-delete</title>
<screen><computeroutput>usage: trove configuration-delete &lt;configuration_group&gt;</computeroutput></screen>
<para>
Deletes a configuration group.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;configuration_group&gt;</command></term>
<listitem>
<para>
ID of the configuration group.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_configuration-detach">
<title>trove configuration-detach</title>
<screen><computeroutput>usage: trove configuration-detach &lt;instance&gt;</computeroutput></screen>
<para>
Detaches a configuration group from an instance.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<listitem>
<para>
ID or name of the instance.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_configuration-instances">
<title>trove configuration-instances</title>
<screen><computeroutput>usage: trove configuration-instances &lt;configuration_group&gt;</computeroutput></screen>
<para>
Lists all instances associated with a configuration group.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;configuration_group&gt;</command></term>
<listitem>
<para>
ID of the configuration group.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_configuration-list">
<title>trove configuration-list</title>
<screen><computeroutput>usage: trove configuration-list</computeroutput></screen>
<para>
Lists all configuration groups.
</para>
</section>
<section xml:id="troveclient_subcommand_configuration-parameter-list">
<title>trove configuration-parameter-list</title>
<screen><computeroutput>usage: trove configuration-parameter-list &lt;datastore_version&gt;
[--datastore &lt;datastore&gt;]</computeroutput></screen>
<para>
Lists available parameters for a configuration group.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;datastore_version&gt;</command></term>
<listitem>
<para>
Datastore version name or ID assigned to the
configuration group.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--datastore &lt;datastore&gt;</command></term>
<listitem>
<para>
ID or name of the datastore to list configuration
parameters for. Optional if the ID of the
datastore_version is provided.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_configuration-parameter-show">
<title>trove configuration-parameter-show</title>
<screen><computeroutput>usage: trove configuration-parameter-show &lt;datastore_version&gt; &lt;parameter&gt;
[--datastore &lt;datastore&gt;]</computeroutput></screen>
<para>
Shows details of a configuration parameter.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;datastore_version&gt;</command></term>
<listitem>
<para>
Datastore version name or ID assigned to the
configuration group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;parameter&gt;</command></term>
<listitem>
<para>
Name of the configuration parameter.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--datastore &lt;datastore&gt;</command></term>
<listitem>
<para>
ID or name of the datastore to list configuration
parameters for. Optional if the ID of the
datastore_version is provided.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_configuration-patch">
<title>trove configuration-patch</title>
<screen><computeroutput>usage: trove configuration-patch &lt;configuration_group&gt; &lt;values&gt;</computeroutput></screen>
<para>
Patches a configuration group.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;configuration_group&gt;</command></term>
<listitem>
<para>
ID of the configuration group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;values&gt;</command></term>
<listitem>
<para>
Dictionary of the values to set.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_configuration-show">
<title>trove configuration-show</title>
<screen><computeroutput>usage: trove configuration-show &lt;configuration_group&gt;</computeroutput></screen>
<para>
Shows details of a configuration group.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;configuration_group&gt;</command></term>
<listitem>
<para>
ID of the configuration group.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_configuration-update">
<title>trove configuration-update</title>
<screen><computeroutput>usage: trove configuration-update &lt;configuration_group&gt; &lt;values&gt;
[--name &lt;name&gt;]
[--description &lt;description&gt;]</computeroutput></screen>
<para>
Updates a configuration group.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;configuration_group&gt;</command></term>
<listitem>
<para>
ID of the configuration group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;values&gt;</command></term>
<listitem>
<para>
Dictionary of the values to set.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--name &lt;name&gt;</command></term>
<listitem>
<para>
Name of the configuration group.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description &lt;description&gt;</command></term>
<listitem>
<para>
An optional description for the configuration
group.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_create">
<title>trove create</title>
<screen><computeroutput>usage: trove create &lt;name&gt; &lt;flavor&gt;
[--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;]
[--datastore &lt;datastore&gt;]
[--datastore_version &lt;datastore_version&gt;]
[--nic &lt;net-id=net-uuid,v4-fixed-ip=ip-addr,port-id=port-uuid&gt;]
[--configuration &lt;configuration&gt;]
[--replica_of &lt;source_instance&gt;] [--replica_count &lt;count&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&gt;</command></term>
<listitem>
<para>
Flavor ID or name 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 volume in GB.
Required when volume support is enabled.
</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;</command></term>
<listitem>
<para>
A backup ID.
</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>
<varlistentry>
<term><command>--datastore &lt;datastore&gt;</command></term>
<listitem>
<para>
A datastore name or ID.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--datastore_version &lt;datastore_version&gt;</command></term>
<listitem>
<para>
A datastore version name or ID.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--nic &lt;net-id=net-uuid,v4-fixed-ip=ip-addr,port-id=port-uuid&gt;</command></term>
<listitem>
<para>
Create a NIC on the instance. Specify option
multiple times to create multiple NICs. net-
id: attach NIC to network with this ID
(either port-id or net-id must be
specified), v4-fixed-ip: IPv4 fixed address
for NIC (optional), port-id: attach NIC to
port with this ID (either port-id or net-id
must be specified).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--configuration &lt;configuration&gt;</command></term>
<listitem>
<para>
ID of the configuration group to attach to
the instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--replica_of &lt;source_instance&gt;</command></term>
<listitem>
<para>
ID or name of an existing instance to
replicate from.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--replica_count &lt;count&gt;</command></term>
<listitem>
<para>
Number of replicas to create (defaults to
1).
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_database-create">
<title>trove database-create</title>
<screen><computeroutput>usage: trove database-create &lt;instance&gt; &lt;name&gt;
[--character_set &lt;character_set&gt;]
[--collate &lt;collate&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>
ID or name of the instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;name&gt;</command></term>
<listitem>
<para>
Name of the database.
</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</title>
<screen><computeroutput>usage: trove database-delete &lt;instance&gt; &lt;database&gt;</computeroutput></screen>
<para>
Deletes a database from an instance.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<listitem>
<para>
ID or name 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</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>
ID or name of the instance.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_datastore-list">
<title>trove datastore-list</title>
<screen><computeroutput>usage: trove datastore-list</computeroutput></screen>
<para>
Lists available datastores.
</para>
</section>
<section xml:id="troveclient_subcommand_datastore-show">
<title>trove datastore-show</title>
<screen><computeroutput>usage: trove datastore-show &lt;datastore&gt;</computeroutput></screen>
<para>
Shows details of a datastore.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;datastore&gt;</command></term>
<listitem>
<para>
ID of the datastore.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_datastore-version-list">
<title>trove datastore-version-list</title>
<screen><computeroutput>usage: trove datastore-version-list &lt;datastore&gt;</computeroutput></screen>
<para>
Lists available versions for a datastore.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;datastore&gt;</command></term>
<listitem>
<para>
ID or name of the datastore.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_datastore-version-show">
<title>trove datastore-version-show</title>
<screen><computeroutput>usage: trove datastore-version-show &lt;datastore_version&gt;
[--datastore &lt;datastore&gt;]</computeroutput></screen>
<para>
Shows details of a datastore version.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;datastore_version&gt;</command></term>
<listitem>
<para>
ID or name of the datastore version.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--datastore &lt;datastore&gt;</command></term>
<listitem>
<para>
ID or name of the datastore. Optional if the ID of
the datastore_version is provided.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_delete">
<title>trove delete</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 or name of the instance.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_detach-replica">
<title>trove detach-replica</title>
<screen><computeroutput>usage: trove detach-replica &lt;instance&gt;</computeroutput></screen>
<para>
Detaches a replica instance from its replication source.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<listitem>
<para>
ID or name of the instance.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_eject-replica-source">
<title>trove eject-replica-source</title>
<screen><computeroutput>usage: trove eject-replica-source &lt;instance&gt;</computeroutput></screen>
<para>
Ejects a replica source from its set.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<listitem>
<para>
ID or name of the instance.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_flavor-list">
<title>trove flavor-list</title>
<screen><computeroutput>usage: trove flavor-list [--datastore_type &lt;datastore_type&gt;]
[--datastore_version_id &lt;datastore_version_id&gt;]</computeroutput></screen>
<para>
Lists available flavors.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--datastore_type &lt;datastore_type&gt;</command></term>
<listitem>
<para>
Type of the datastore. For eg: mysql.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--datastore_version_id &lt;datastore_version_id&gt;</command></term>
<listitem>
<para>
ID of the datastore version.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_flavor-show">
<title>trove flavor-show</title>
<screen><computeroutput>usage: trove flavor-show &lt;flavor&gt;</computeroutput></screen>
<para>
Shows details of a flavor.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;flavor&gt;</command></term>
<listitem>
<para>
ID or name of the flavor.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_limit-list">
<title>trove limit-list</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</title>
<screen><computeroutput>usage: trove list [--limit &lt;limit&gt;] [--marker &lt;ID&gt;] [--include-clustered]</computeroutput></screen>
<para>
Lists all the instances.
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--limit &lt;limit&gt;</command></term>
<listitem>
<para>
Limit the number of results displayed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--marker &lt;ID&gt;</command></term>
<listitem>
<para>
Begin displaying the results for IDs greater than the
specified marker. When used with --limit, set this to
the last ID displayed in the previous run.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--include-clustered</command></term>
<listitem>
<para>
Include instances that are part of a cluster (default
false).
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_metadata-create">
<title>trove metadata-create</title>
<screen><computeroutput>usage: trove metadata-create &lt;instance_id&gt; &lt;key&gt; &lt;value&gt;</computeroutput></screen>
<para>
Creates metadata in the database for instance &lt;id&gt;.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance_id&gt;</command></term>
<listitem>
<para>
UUID for instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;key&gt;</command></term>
<listitem>
<para>
Key for assignment.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;value&gt;</command></term>
<listitem>
<para>
Value to assign to &lt;key&gt;.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_metadata-delete">
<title>trove metadata-delete</title>
<screen><computeroutput>usage: trove metadata-delete &lt;instance_id&gt; &lt;key&gt;</computeroutput></screen>
<para>
Deletes metadata for instance &lt;id&gt;.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance_id&gt;</command></term>
<listitem>
<para>
UUID for instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;key&gt;</command></term>
<listitem>
<para>
Metadata key to delete.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_metadata-edit">
<title>trove metadata-edit</title>
<screen><computeroutput>usage: trove metadata-edit &lt;instance_id&gt; &lt;key&gt; &lt;value&gt;</computeroutput></screen>
<para>
Replaces metadata value with a new one, this is non-destructive.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance_id&gt;</command></term>
<listitem>
<para>
UUID for instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;key&gt;</command></term>
<listitem>
<para>
Key to replace.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;value&gt;</command></term>
<listitem>
<para>
New value to assign to &lt;key&gt;.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_metadata-list">
<title>trove metadata-list</title>
<screen><computeroutput>usage: trove metadata-list &lt;instance_id&gt;</computeroutput></screen>
<para>
Shows all metadata for instance &lt;id&gt;.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance_id&gt;</command></term>
<listitem>
<para>
UUID for instance.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_metadata-show">
<title>trove metadata-show</title>
<screen><computeroutput>usage: trove metadata-show &lt;instance_id&gt; &lt;key&gt;</computeroutput></screen>
<para>
Shows metadata entry for key &lt;key&gt; and instance &lt;id&gt;.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance_id&gt;</command></term>
<listitem>
<para>
UUID for instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;key&gt;</command></term>
<listitem>
<para>
Key to display.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_metadata-update">
<title>trove metadata-update</title>
<screen><computeroutput>usage: trove metadata-update &lt;instance_id&gt; &lt;key&gt; &lt;newkey&gt; &lt;value&gt;</computeroutput></screen>
<para>
Updates metadata, this is destructive.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance_id&gt;</command></term>
<listitem>
<para>
UUID for instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;key&gt;</command></term>
<listitem>
<para>
Key to update.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;newkey&gt;</command></term>
<listitem>
<para>
New key.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;value&gt;</command></term>
<listitem>
<para>
Value to assign to &lt;newkey&gt;.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_promote-to-replica-source">
<title>trove promote-to-replica-source</title>
<screen><computeroutput>usage: trove promote-to-replica-source &lt;instance&gt;</computeroutput></screen>
<para>
Promotes a replica to be the new replica source of its set.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<listitem>
<para>
ID or name of the instance.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_resize-instance">
<title>trove resize-instance</title>
<screen><computeroutput>usage: trove resize-instance &lt;instance&gt; &lt;flavor&gt;</computeroutput></screen>
<para>
Resizes an instance with a new flavor.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<listitem>
<para>
ID or name of the instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;flavor&gt;</command></term>
<listitem>
<para>
New flavor of the instance.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_resize-volume">
<title>trove resize-volume</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>
ID or name of the instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&lt;size&gt;</command></term>
<listitem>
<para>
New size of the instance disk volume in GB.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_restart">
<title>trove restart</title>
<screen><computeroutput>usage: trove restart &lt;instance&gt;</computeroutput></screen>
<para>
Restarts an instance.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<listitem>
<para>
ID or name of the instance.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_root-enable">
<title>trove root-enable</title>
<screen><computeroutput>usage: trove root-enable &lt;instance_or_cluster&gt;
[--root_password &lt;root_password&gt;]</computeroutput></screen>
<para>
Enables root for an instance and resets if already exists.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance_or_cluster&gt;</command></term>
<listitem>
<para>
ID or name of the instance or cluster.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--root_password &lt;root_password&gt;</command></term>
<listitem>
<para>
Root password to set.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_root-show">
<title>trove root-show</title>
<screen><computeroutput>usage: trove root-show &lt;instance_or_cluster&gt;</computeroutput></screen>
<para>
Gets status if root was ever enabled for an instance or cluster.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance_or_cluster&gt;</command></term>
<listitem>
<para>
ID or name of the instance or cluster.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_secgroup-add-rule">
<title>trove secgroup-add-rule</title>
<screen><computeroutput>usage: trove secgroup-add-rule &lt;security_group&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 ID.
</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</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>
Name of security group rule.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_secgroup-list">
<title>trove secgroup-list</title>
<screen><computeroutput>usage: trove secgroup-list</computeroutput></screen>
<para>
Lists all security groups.
</para>
</section>
<section xml:id="troveclient_subcommand_secgroup-list-rules">
<title>trove secgroup-list-rules</title>
<screen><computeroutput>usage: trove secgroup-list-rules &lt;security_group&gt;</computeroutput></screen>
<para>
Lists all rules for a security group.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;security_group&gt;</command></term>
<listitem>
<para>
Security group ID.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_secgroup-show">
<title>trove secgroup-show</title>
<screen><computeroutput>usage: trove secgroup-show &lt;security_group&gt;</computeroutput></screen>
<para>
Shows details of a security group.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;security_group&gt;</command></term>
<listitem>
<para>
Security group ID.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_show">
<title>trove show</title>
<screen><computeroutput>usage: trove show &lt;instance&gt;</computeroutput></screen>
<para>
Shows details of an instance.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<listitem>
<para>
ID or name of the instance.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_update">
<title>trove update</title>
<screen><computeroutput>usage: trove update &lt;instance&gt;
[--name &lt;name&gt;] [--configuration &lt;configuration&gt;]
[--detach-replica-source] [--remove_configuration]</computeroutput></screen>
<para>
Updates an instance: Edits name, configuration, or replica source.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<listitem>
<para>
ID or name of the instance.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>--name &lt;name&gt;</command></term>
<listitem>
<para>
Name of the instance.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--configuration &lt;configuration&gt;</command></term>
<listitem>
<para>
ID of the configuration reference to attach.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--detach-replica-source</command></term>
<listitem>
<para>
Detach the replica instance from its
replication source.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--remove_configuration</command></term>
<listitem>
<para>
Drops the current configuration reference.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_user-create">
<title>trove user-create</title>
<screen><computeroutput>usage: trove user-create &lt;instance&gt; &lt;name&gt; &lt;password&gt;
[--host &lt;host&gt;]
[--databases &lt;databases&gt; [&lt;databases&gt; ...]]</computeroutput></screen>
<para>
Creates a user on an instance.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<listitem>
<para>
ID or name 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</title>
<screen><computeroutput>usage: trove user-delete [--host &lt;host&gt;] &lt;instance&gt; &lt;name&gt;</computeroutput></screen>
<para>
Deletes a user from an instance.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<listitem>
<para>
ID or name 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</title>
<screen><computeroutput>usage: trove user-grant-access &lt;instance&gt; &lt;name&gt; &lt;databases&gt; [&lt;databases&gt; ...]
[--host &lt;host&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>
ID or name 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</title>
<screen><computeroutput>usage: trove user-list &lt;instance&gt;</computeroutput></screen>
<para>
Lists the users for an instance.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<listitem>
<para>
ID or name of the instance.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="troveclient_subcommand_user-revoke-access">
<title>trove user-revoke-access</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>
ID or name 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</title>
<screen><computeroutput>usage: trove user-show [--host &lt;host&gt;] &lt;instance&gt; &lt;name&gt;</computeroutput></screen>
<para>
Shows details of a user of an instance.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<listitem>
<para>
ID or name 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</title>
<screen><computeroutput>usage: trove user-show-access [--host &lt;host&gt;] &lt;instance&gt; &lt;name&gt;</computeroutput></screen>
<para>
Shows access details of a user of an instance.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<listitem>
<para>
ID or name 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</title>
<screen><computeroutput>usage: trove user-update-attributes &lt;instance&gt; &lt;name&gt;
[--host &lt;host&gt;] [--new_name &lt;new_name&gt;]
[--new_password &lt;new_password&gt;]
[--new_host &lt;new_host&gt;]</computeroutput></screen>
<para>
Updates a user's attributes on an instance. At least one optional argument
must be provided.
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>&lt;instance&gt;</command></term>
<listitem>
<para>
ID or name 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>
View Git Blame Copy Permalink