Updated CLI reference for trove 1.0.8
Change-Id: Ibcb0a5c1f3763dd699b002f7b2f9994f29293781
This commit is contained in:
parent
013b61639d
commit
25491f45ef
@ -15,7 +15,7 @@
|
|||||||
interface (CLI) for the Database API and its extensions.
|
interface (CLI) for the Database API and its extensions.
|
||||||
|
|
||||||
This chapter documents <command>trove</command> version
|
This chapter documents <command>trove</command> version
|
||||||
<literal>1.0.7</literal>.
|
<literal>1.0.8</literal>.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>For help on a specific <command>trove</command>
|
<para>For help on a specific <command>trove</command>
|
||||||
@ -25,16 +25,27 @@
|
|||||||
|
|
||||||
<section xml:id="troveclient_command_usage">
|
<section xml:id="troveclient_command_usage">
|
||||||
<title>trove usage</title>
|
<title>trove usage</title>
|
||||||
<screen><computeroutput>usage: trove [--version] [--debug] [--os-username <auth-user-name>]
|
<screen><computeroutput>usage: trove [--version] [--debug] [--os-auth-system <auth-system>]
|
||||||
[--os-password <auth-password>]
|
[--service-type <service-type>] [--service-name <service-name>]
|
||||||
[--os-tenant-name <auth-tenant-name>]
|
[--bypass-url <bypass-url>]
|
||||||
[--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>]
|
|
||||||
[--os-region-name <region-name>] [--service-type <service-type>]
|
|
||||||
[--service-name <service-name>] [--bypass-url <bypass-url>]
|
|
||||||
[--database-service-name <database-service-name>]
|
[--database-service-name <database-service-name>]
|
||||||
[--endpoint-type <endpoint-type>]
|
[--endpoint-type <endpoint-type>]
|
||||||
[--os-database-api-version <database-api-ver>]
|
[--os-database-api-version <database-api-ver>]
|
||||||
[--os-cacert <ca-certificate>] [--retries <retries>] [--json]
|
[--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>
|
<subcommand> ...</computeroutput></screen>
|
||||||
<variablelist wordsize="10">
|
<variablelist wordsize="10">
|
||||||
<title>Subcommands</title>
|
<title>Subcommands</title>
|
||||||
@ -603,50 +614,9 @@
|
|||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><command>--os-username <auth-user-name></command></term>
|
<term><command>--os-auth-system <auth-system></command></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Defaults to <code>env[OS_USERNAME]</code>.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
<varlistentry>
|
|
||||||
<term><command>--os-password <auth-password></command></term>
|
|
||||||
<listitem>
|
|
||||||
<para>
|
|
||||||
Defaults to <code>env[OS_PASSWORD]</code>.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
<varlistentry>
|
|
||||||
<term><command>--os-tenant-name <auth-tenant-name></command></term>
|
|
||||||
<listitem>
|
|
||||||
<para>
|
|
||||||
Defaults to <code>env[OS_TENANT_NAME]</code>.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
<varlistentry>
|
|
||||||
<term><command>--os-tenant-id <auth-tenant-id></command></term>
|
|
||||||
<listitem>
|
|
||||||
<para>
|
|
||||||
Defaults to <code>env[OS_TENANT_ID]</code>.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
<varlistentry>
|
|
||||||
<term><command>--os-auth-url <auth-url></command></term>
|
|
||||||
<listitem>
|
|
||||||
<para>
|
|
||||||
Defaults to <code>env[OS_AUTH_URL]</code>.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
<varlistentry>
|
|
||||||
<term><command>--os-region-name <region-name></command></term>
|
|
||||||
<listitem>
|
|
||||||
<para>
|
|
||||||
Defaults to <code>env[OS_REGION_NAME]</code>.
|
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
@ -701,16 +671,6 @@
|
|||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</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>
|
<varlistentry>
|
||||||
<term><command>--retries <retries></command></term>
|
<term><command>--retries <retries></command></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
@ -728,6 +688,191 @@
|
|||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</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>
|
</variablelist>
|
||||||
</section>
|
</section>
|
||||||
<section xml:id="troveclient_subcommand_backup-copy">
|
<section xml:id="troveclient_subcommand_backup-copy">
|
||||||
|
Loading…
Reference in New Issue
Block a user