885ad3e7e8
Manually edited for white spaces.(one line removed) This manually edited problem is already reported as follows. https://bugs.launchpad.net/openstack-manuals/+bug/1495737 Change-Id: I0b6303acd012c1e661fdc2e0e28fe2cc5ca8c6f2
2833 lines
82 KiB
XML
2833 lines
82 KiB
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 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.4.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 <auth-system>]
|
|
[--service-type <service-type>] [--service-name <service-name>]
|
|
[--bypass-url <bypass-url>]
|
|
[--database-service-name <database-service-name>]
|
|
[--endpoint-type <endpoint-type>]
|
|
[--os-database-api-version <database-api-ver>]
|
|
[--retries <retries>] [--json] [--insecure]
|
|
[--os-cacert <ca-certificate>] [--os-cert <certificate>]
|
|
[--os-key <key>] [--timeout <seconds>]
|
|
[--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 <auth-tenant-name>]
|
|
[--os-tenant-id <tenant-id>] [--os-auth-token OS_AUTH_TOKEN]
|
|
[--os-region-name <region-name>]
|
|
<subcommand> ...</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 <id>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>metadata-delete</command></term>
|
|
<listitem>
|
|
<para>
|
|
Deletes metadata for instance <id>.
|
|
</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 <id>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>metadata-show</command></term>
|
|
<listitem>
|
|
<para>
|
|
Shows metadata entry for key <key> and
|
|
instance <id>.
|
|
</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 <auth-system></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_AUTH_SYSTEM]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--service-type <service-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to database for most actions.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--service-name <service-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[TROVE_SERVICE_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--bypass-url <bypass-url></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[TROVE_BYPASS_URL]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--database-service-name <database-service-name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to
|
|
<code>env[TROVE_DATABASE_SERVICE_NAME]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--endpoint-type <endpoint-type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[TROVE_ENDPOINT_TYPE]</code> or
|
|
publicURL.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-database-api-version <database-api-ver></command></term>
|
|
<listitem>
|
|
<para>
|
|
Accepts 1, defaults to
|
|
<code>env[OS_DATABASE_API_VERSION]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--retries <retries></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>--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 <ca-certificate></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 <certificate></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_CERT]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--os-key <key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Defaults to <code>env[OS_KEY]</code>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--timeout <seconds></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 <auth-tenant-name></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 <tenant-id></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 <region-name></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 <name> <backup>
|
|
[--region <region>] [--description <description>]</computeroutput></screen>
|
|
<para>
|
|
Creates a backup from another backup.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the backup.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><backup></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 <region></command></term>
|
|
<listitem>
|
|
<para>
|
|
Region where the source backup resides.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></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 <instance> <name>
|
|
[--description <description>] [--parent <parent>]</computeroutput></screen>
|
|
<para>
|
|
Creates a backup of an instance.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the instance.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the backup.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--description <description></command></term>
|
|
<listitem>
|
|
<para>
|
|
An optional description for the backup.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--parent <parent></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 <backup></computeroutput></screen>
|
|
<para>
|
|
Deletes a backup.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><backup></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 <limit>] [--marker <ID>]
|
|
[--datastore <datastore>]</computeroutput></screen>
|
|
<para>
|
|
Lists available backups.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--limit <limit></command></term>
|
|
<listitem>
|
|
<para>
|
|
Return up to N number of the most recent backups.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--marker <ID></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 <datastore></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 <limit>] [--marker <ID>] <instance></computeroutput></screen>
|
|
<para>
|
|
Lists available backups for an instance.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance></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 <limit></command></term>
|
|
<listitem>
|
|
<para>
|
|
Return up to N number of the most recent backups.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--marker <ID></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 <backup></computeroutput></screen>
|
|
<para>
|
|
Shows details of a backup.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><backup></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 <name> <datastore> <datastore_version>
|
|
[--instance <opt=value,opt=value,...>]</computeroutput></screen>
|
|
<para>
|
|
Creates a new cluster.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the cluster.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><datastore></command></term>
|
|
<listitem>
|
|
<para>
|
|
A datastore name or ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><datastore_version></command></term>
|
|
<listitem>
|
|
<para>
|
|
A datastore version name or ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--instance <opt=value,opt=value,...></command></term>
|
|
<listitem>
|
|
<para>
|
|
Create an instance for the cluster. Specify
|
|
multiple times to create multiple instances.
|
|
Valid options are: flavor=flavor_name_or_id,
|
|
volume=disk_size_in_GB, nic='net-id=net-
|
|
uuid,v4-fixed-ip=ip-addr,port-id=port-uuid'
|
|
(where net-id=network_id, v4-fixed-
|
|
ip=IPv4r_fixed_address, port-id=port_id),
|
|
availability_zone=AZ_hint_for_Nova.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="troveclient_subcommand_cluster-delete">
|
|
<title>trove cluster-delete</title>
|
|
<screen><computeroutput>usage: trove cluster-delete <cluster></computeroutput></screen>
|
|
<para>
|
|
Deletes a cluster.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><cluster></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 <cluster>
|
|
[--instance <name=name,flavor=flavor_name_or_id,volume=volume>]</computeroutput></screen>
|
|
<para>
|
|
Adds more instances to a cluster.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><cluster></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 <name=name,flavor=flavor_name_or_id,volume=volume></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 <cluster></computeroutput></screen>
|
|
<para>
|
|
Lists all instances of a cluster.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><cluster></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 <limit>] [--marker <ID>]</computeroutput></screen>
|
|
<para>
|
|
Lists all the clusters.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--limit <limit></command></term>
|
|
<listitem>
|
|
<para>
|
|
Limit the number of results displayed.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--marker <ID></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 <cluster></computeroutput></screen>
|
|
<para>
|
|
Shows details of a cluster.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><cluster></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 <cluster> <instance> [<instance> ...]</computeroutput></screen>
|
|
<para>
|
|
Drops instances from a cluster.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><cluster></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the cluster.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><instance></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 <instance> <configuration></computeroutput></screen>
|
|
<para>
|
|
Attaches a configuration group to an instance.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the instance.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><configuration></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 <name> <values>
|
|
[--datastore <datastore>]
|
|
[--datastore_version <datastore_version>]
|
|
[--description <description>]</computeroutput></screen>
|
|
<para>
|
|
Creates a configuration group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the configuration group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><values></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 <datastore></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 <datastore_version></command></term>
|
|
<listitem>
|
|
<para>
|
|
Datastore version ID assigned to the
|
|
configuration group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></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 <instance></computeroutput></screen>
|
|
<para>
|
|
Shows the default configuration of an instance.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance></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 <configuration_group></computeroutput></screen>
|
|
<para>
|
|
Deletes a configuration group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><configuration_group></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 <instance></computeroutput></screen>
|
|
<para>
|
|
Detaches a configuration group from an instance.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance></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 <configuration_group></computeroutput></screen>
|
|
<para>
|
|
Lists all instances associated with a configuration group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><configuration_group></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 <datastore_version>
|
|
[--datastore <datastore>]</computeroutput></screen>
|
|
<para>
|
|
Lists available parameters for a configuration group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><datastore_version></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 <datastore></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 <datastore_version> <parameter>
|
|
[--datastore <datastore>]</computeroutput></screen>
|
|
<para>
|
|
Shows details of a configuration parameter.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><datastore_version></command></term>
|
|
<listitem>
|
|
<para>
|
|
Datastore version name or ID assigned to the
|
|
configuration group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><parameter></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the configuration parameter.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--datastore <datastore></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 <configuration_group> <values></computeroutput></screen>
|
|
<para>
|
|
Patches a configuration group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><configuration_group></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the configuration group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><values></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 <configuration_group></computeroutput></screen>
|
|
<para>
|
|
Shows details of a configuration group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><configuration_group></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 <configuration_group> <values>
|
|
[--name <name>]
|
|
[--description <description>]</computeroutput></screen>
|
|
<para>
|
|
Updates a configuration group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><configuration_group></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the configuration group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><values></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 <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the configuration group.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--description <description></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 <name> <flavor>
|
|
[--size <size>]
|
|
[--databases <databases> [<databases> ...]]
|
|
[--users <users> [<users> ...]] [--backup <backup>]
|
|
[--availability_zone <availability_zone>]
|
|
[--datastore <datastore>]
|
|
[--datastore_version <datastore_version>]
|
|
[--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,port-id=port-uuid>]
|
|
[--configuration <configuration>]
|
|
[--replica_of <source_instance>] [--replica_count <count>]</computeroutput></screen>
|
|
<para>
|
|
Creates a new instance.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the instance.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><flavor></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 <size></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 <databases> [<databases> ...]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Optional list of databases.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--users <users> [<users> ...]</command></term>
|
|
<listitem>
|
|
<para>
|
|
Optional list of users in the form
|
|
user:password.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--backup <backup></command></term>
|
|
<listitem>
|
|
<para>
|
|
A backup ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--availability_zone <availability_zone></command></term>
|
|
<listitem>
|
|
<para>
|
|
The Zone hint to give to nova.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--datastore <datastore></command></term>
|
|
<listitem>
|
|
<para>
|
|
A datastore name or ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--datastore_version <datastore_version></command></term>
|
|
<listitem>
|
|
<para>
|
|
A datastore version name or ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--nic <net-id=net-uuid,v4-fixed-ip=ip-addr,port-id=port-uuid></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 <configuration></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID of the configuration group to attach to
|
|
the instance.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--replica_of <source_instance></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of an existing instance to
|
|
replicate from.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--replica_count <count></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 <instance> <name>
|
|
[--character_set <character_set>]
|
|
[--collate <collate>]</computeroutput></screen>
|
|
<para>
|
|
Creates a database on an instance.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the instance.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the database.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--character_set <character_set></command></term>
|
|
<listitem>
|
|
<para>
|
|
Optional character set for database.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--collate <collate></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 <instance> <database></computeroutput></screen>
|
|
<para>
|
|
Deletes a database from an instance.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the instance.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><database></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 <instance></computeroutput></screen>
|
|
<para>
|
|
Lists available databases on an instance.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance></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 <datastore></computeroutput></screen>
|
|
<para>
|
|
Shows details of a datastore.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><datastore></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 <datastore></computeroutput></screen>
|
|
<para>
|
|
Lists available versions for a datastore.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><datastore></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 <datastore_version>
|
|
[--datastore <datastore>]</computeroutput></screen>
|
|
<para>
|
|
Shows details of a datastore version.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><datastore_version></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 <datastore></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 <instance></computeroutput></screen>
|
|
<para>
|
|
Deletes an instance.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance></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 <instance></computeroutput></screen>
|
|
<para>
|
|
Detaches a replica instance from its replication source.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance></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 <instance></computeroutput></screen>
|
|
<para>
|
|
Ejects a replica source from its set.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance></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 <datastore_type>]
|
|
[--datastore_version_id <datastore_version_id>]</computeroutput></screen>
|
|
<para>
|
|
Lists available flavors.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--datastore_type <datastore_type></command></term>
|
|
<listitem>
|
|
<para>
|
|
Type of the datastore. For eg: mysql.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--datastore_version_id <datastore_version_id></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 <flavor></computeroutput></screen>
|
|
<para>
|
|
Shows details of a flavor.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><flavor></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 <limit>] [--marker <ID>] [--include-clustered]</computeroutput></screen>
|
|
<para>
|
|
Lists all the instances.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--limit <limit></command></term>
|
|
<listitem>
|
|
<para>
|
|
Limit the number of results displayed.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--marker <ID></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 <instance_id> <key> <value></computeroutput></screen>
|
|
<para>
|
|
Creates metadata in the database for instance <id>.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
UUID for instance.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Key for assignment.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Value to assign to <key>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="troveclient_subcommand_metadata-delete">
|
|
<title>trove metadata-delete</title>
|
|
<screen><computeroutput>usage: trove metadata-delete <instance_id> <key></computeroutput></screen>
|
|
<para>
|
|
Deletes metadata for instance <id>.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
UUID for instance.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><key></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 <instance_id> <key> <value></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><instance_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
UUID for instance.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Key to replace.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><value></command></term>
|
|
<listitem>
|
|
<para>
|
|
New value to assign to <key>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="troveclient_subcommand_metadata-list">
|
|
<title>trove metadata-list</title>
|
|
<screen><computeroutput>usage: trove metadata-list <instance_id></computeroutput></screen>
|
|
<para>
|
|
Shows all metadata for instance <id>.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance_id></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 <instance_id> <key></computeroutput></screen>
|
|
<para>
|
|
Shows metadata entry for key <key> and instance <id>.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
UUID for instance.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><key></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 <instance_id> <key> <newkey> <value></computeroutput></screen>
|
|
<para>
|
|
Updates metadata, this is destructive.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance_id></command></term>
|
|
<listitem>
|
|
<para>
|
|
UUID for instance.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><key></command></term>
|
|
<listitem>
|
|
<para>
|
|
Key to update.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><newkey></command></term>
|
|
<listitem>
|
|
<para>
|
|
New key.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><value></command></term>
|
|
<listitem>
|
|
<para>
|
|
Value to assign to <newkey>.
|
|
</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 <instance></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><instance></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 <instance> <flavor></computeroutput></screen>
|
|
<para>
|
|
Resizes an instance with a new flavor.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the instance.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><flavor></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 <instance> <size></computeroutput></screen>
|
|
<para>
|
|
Resizes the volume size of an instance.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the instance.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><size></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 <instance></computeroutput></screen>
|
|
<para>
|
|
Restarts an instance.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance></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 <instance_or_cluster>
|
|
[--root_password <root_password>]</computeroutput></screen>
|
|
<para>
|
|
Enables root for an instance and resets if already exists.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance_or_cluster></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 <root_password></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 <instance_or_cluster></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><instance_or_cluster></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 <security_group> <cidr></computeroutput></screen>
|
|
<para>
|
|
Creates a security group rule.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><security_group></command></term>
|
|
<listitem>
|
|
<para>
|
|
Security group ID.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><cidr></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 <security_group_rule></computeroutput></screen>
|
|
<para>
|
|
Deletes a security group rule.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><security_group_rule></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 <security_group></computeroutput></screen>
|
|
<para>
|
|
Lists all rules for a security group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><security_group></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 <security_group></computeroutput></screen>
|
|
<para>
|
|
Shows details of a security group.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><security_group></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 <instance></computeroutput></screen>
|
|
<para>
|
|
Shows details of an instance.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance></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 <instance>
|
|
[--name <name>] [--configuration <configuration>]
|
|
[--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><instance></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 <name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of the instance.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--configuration <configuration></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 <instance> <name> <password>
|
|
[--host <host>]
|
|
[--databases <databases> [<databases> ...]]</computeroutput></screen>
|
|
<para>
|
|
Creates a user on an instance.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the instance.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of user.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><password></command></term>
|
|
<listitem>
|
|
<para>
|
|
Password of user.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--host <host></command></term>
|
|
<listitem>
|
|
<para>
|
|
Optional host of user.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--databases <databases> [<databases> ...]</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 <host>] <instance> <name></computeroutput></screen>
|
|
<para>
|
|
Deletes a user from an instance.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the instance.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of user.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--host <host></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 <instance> <name> <databases> [<databases> ...]
|
|
[--host <host>]</computeroutput></screen>
|
|
<para>
|
|
Grants access to a database(s) for a user.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the instance.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of user.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><databases></command></term>
|
|
<listitem>
|
|
<para>
|
|
List of databases.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--host <host></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 <instance></computeroutput></screen>
|
|
<para>
|
|
Lists the users for an instance.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance></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 <host>] <instance> <name> <database></computeroutput></screen>
|
|
<para>
|
|
Revokes access to a database for a user.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the instance.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of user.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><database></command></term>
|
|
<listitem>
|
|
<para>
|
|
A single database.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--host <host></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 <host>] <instance> <name></computeroutput></screen>
|
|
<para>
|
|
Shows details of a user of an instance.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the instance.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of user.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--host <host></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 <host>] <instance> <name></computeroutput></screen>
|
|
<para>
|
|
Shows access details of a user of an instance.
|
|
</para> <variablelist wordsize="10">
|
|
<title>Positional arguments</title>
|
|
<varlistentry>
|
|
<term><command><instance></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the instance.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of user.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--host <host></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 <instance> <name>
|
|
[--host <host>] [--new_name <new_name>]
|
|
[--new_password <new_password>]
|
|
[--new_host <new_host>]</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><instance></command></term>
|
|
<listitem>
|
|
<para>
|
|
ID or name of the instance.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command><name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Name of user.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist wordsize="10">
|
|
<title>Optional arguments</title>
|
|
<varlistentry>
|
|
<term><command>--host <host></command></term>
|
|
<listitem>
|
|
<para>
|
|
Optional host of user.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--new_name <new_name></command></term>
|
|
<listitem>
|
|
<para>
|
|
Optional new name of user.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--new_password <new_password></command></term>
|
|
<listitem>
|
|
<para>
|
|
Optional new password of user.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><command>--new_host <new_host></command></term>
|
|
<listitem>
|
|
<para>
|
|
Optional new host of user.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
</chapter>
|