openstack-manuals/doc/cli-reference/generated/ch_cli_designate_commands.xml
Atsushi SAKAI f9929bb6f9 Update CLI reference for python-designateclient designate 1.5.0
It seems several missing period "." on this message.
  I will request it to fix it to python-designateclient.

Change-Id: If8eb481e03508bf89bad6a6410ac21a2537c3bf5
2015-09-24 08:22:52 +09:00

1395 lines
42 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="designateclient_commands">
<!-- This file is automatically generated, do not edit -->
<?dbhtml stop-chunking?>
<title>DNS service command-line client</title>
<para>The <command>designate</command> client is the command-line
interface (CLI) for the DNS service API and its extensions.
This chapter documents <command>designate</command> version
<literal>1.5.0</literal>.
</para>
<para>For help on a specific <command>designate</command>
command, enter:
</para>
<screen><prompt>$</prompt> <userinput><command>designate</command> <option>help</option> <replaceable>COMMAND</replaceable></userinput></screen>
<section xml:id="designateclient_command_usage">
<title>designate usage</title>
<screen><computeroutput>usage: designate [--version] [-v] [--log-file LOG_FILE] [-q] [-h] [--debug]
[--os-username OS_USERNAME] [--os-user-id OS_USER_ID]
[--os-user-domain-id OS_USER_DOMAIN_ID]
[--os-user-domain-name OS_USER_DOMAIN_NAME]
[--os-password OS_PASSWORD] [--os-tenant-name OS_TENANT_NAME]
[--os-tenant-id OS_TENANT_ID]
[--os-project-name OS_PROJECT_NAME]
[--os-domain-name OS_DOMAIN_NAME]
[--os-domain-id OS_DOMAIN_ID] [--os-project-id OS_PROJECT_ID]
[--os-project-domain-id OS_PROJECT_DOMAIN_ID]
[--os-project-domain-name OS_PROJECT_DOMAIN_NAME]
[--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME]
[--os-token OS_TOKEN] [--os-endpoint OS_ENDPOINT]
[--os-endpoint-type OS_ENDPOINT_TYPE]
[--os-service-type OS_SERVICE_TYPE] [--os-cacert OS_CACERT]
[--insecure] [--all-tenants] [--edit-managed]</computeroutput></screen>
</section>
<section xml:id="designateclient_command_optional">
<title>designate 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>-v, --verbose</command></term>
<listitem>
<para>
Increase verbosity of output. Can be repeated.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--log-file LOG_FILE</command></term>
<listitem>
<para>
Specify a file to log output. Disabled by default.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-q, --quiet</command></term>
<listitem>
<para>
Suppress output except warnings and errors.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
Show this help message and exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--debug</command></term>
<listitem>
<para>
Show tracebacks on errors.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-username OS_USERNAME</command></term>
<listitem>
<para>
Name used for authentication with the OpenStack
Identity service. Defaults to <code>env[OS_USERNAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-user-id OS_USER_ID</command></term>
<listitem>
<para>
User ID used for authentication with the OpenStack
Identity service. Defaults to <code>env[OS_USER_ID]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-user-domain-id OS_USER_DOMAIN_ID</command></term>
<listitem>
<para>
Defaults to <code>env[OS_USER_DOMAIN_ID]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-user-domain-name OS_USER_DOMAIN_NAME</command></term>
<listitem>
<para>
Defaults to <code>env[OS_USER_DOMAIN_NAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-password OS_PASSWORD</command></term>
<listitem>
<para>
Password used for authentication with the OpenStack
Identity service. Defaults to <code>env[OS_PASSWORD]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-tenant-name OS_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 OS_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-project-name OS_PROJECT_NAME</command></term>
<listitem>
<para>
Project to request authorization on. Defaults to
<code>env[OS_PROJECT_NAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-domain-name OS_DOMAIN_NAME</command></term>
<listitem>
<para>
Project to request authorization on. Defaults to
<code>env[OS_DOMAIN_NAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-domain-id OS_DOMAIN_ID</command></term>
<listitem>
<para>
Defaults to <code>env[OS_DOMAIN_ID]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-project-id OS_PROJECT_ID</command></term>
<listitem>
<para>
Project to request authorization on. Defaults to
<code>env[OS_PROJECT_ID]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-project-domain-id OS_PROJECT_DOMAIN_ID</command></term>
<listitem>
<para>
Defaults to <code>env[OS_PROJECT_DOMAIN_ID]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-project-domain-name OS_PROJECT_DOMAIN_NAME</command></term>
<listitem>
<para>
Defaults to <code>env[OS_PROJECT_DOMAIN_NAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-auth-url OS_AUTH_URL</command></term>
<listitem>
<para>
Specify the Identity endpoint to use for
authentication. Defaults to <code>env[OS_AUTH_URL]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-region-name OS_REGION_NAME</command></term>
<listitem>
<para>
Specify the region to use. Defaults to
<code>env[OS_REGION_NAME]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-token OS_TOKEN</command></term>
<listitem>
<para>
Specify an existing token to use instead of retrieving
one via authentication (e.g. with username &amp;
password). Defaults to <code>env[OS_SERVICE_TOKEN]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-endpoint OS_ENDPOINT</command></term>
<listitem>
<para>
Specify an endpoint to use instead of retrieving one
from the service catalog (via authentication).
Defaults to <code>env[OS_DNS_ENDPOINT]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-endpoint-type OS_ENDPOINT_TYPE</command></term>
<listitem>
<para>
Defaults to <code>env[OS_ENDPOINT_TYPE]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-service-type OS_SERVICE_TYPE</command></term>
<listitem>
<para>
Defaults to <code>env[OS_DNS_SERVICE_TYPE]</code>, or 'dns'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--os-cacert OS_CACERT</command></term>
<listitem>
<para>
CA certificate bundle file. Defaults to
<code>env[OS_CACERT]</code>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--insecure</command></term>
<listitem>
<para>
Explicitly allow 'insecure' SSL requests.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--all-tenants</command></term>
<listitem>
<para>
Allows to list all domains from all tenants.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--edit-managed</command></term>
<listitem>
<para>
Allows to edit records that are marked as managed.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_diagnostics-ping">
<title>designate diagnostics-ping</title>
<screen><computeroutput>usage: designate diagnostics-ping [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX] --service
SERVICE --host HOST</computeroutput></screen>
<para>
Ping a service on a given host
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--service SERVICE</command></term>
<listitem>
<para>
Service name (e.g. central)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--host HOST</command></term>
<listitem>
<para>
Hostname
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_domain-create">
<title>designate domain-create</title>
<screen><computeroutput>usage: designate domain-create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX] --name NAME
--email EMAIL [--ttl TTL]
[--description DESCRIPTION]</computeroutput></screen>
<para>
Create Domain
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--name NAME</command></term>
<listitem>
<para>
Domain name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--email EMAIL</command></term>
<listitem>
<para>
Domain email
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--ttl TTL</command></term>
<listitem>
<para>
Time to live (seconds)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description DESCRIPTION</command></term>
<listitem>
<para>
Description
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_domain-delete">
<title>designate domain-delete</title>
<screen><computeroutput>usage: designate domain-delete [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX]
id</computeroutput></screen>
<para>
Delete Domain
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>id</command></term>
<listitem>
<para>
Domain ID or name
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_domain-get">
<title>designate domain-get</title>
<screen><computeroutput>usage: designate domain-get [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;] [--noindent]
[--prefix PREFIX]
id</computeroutput></screen>
<para>
Get Domain
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>id</command></term>
<listitem>
<para>
Domain ID or name
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_domain-list">
<title>designate domain-list</title>
<screen><computeroutput>usage: designate domain-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--noindent]
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
<para>
List Domains
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_domain-servers-list">
<title>designate domain-servers-list</title>
<screen><computeroutput>usage: designate domain-servers-list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
id</computeroutput></screen>
<para>
List Domain Servers
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>id</command></term>
<listitem>
<para>
Domain ID or name
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_domain-update">
<title>designate domain-update</title>
<screen><computeroutput>usage: designate domain-update [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX] [--name NAME]
[--email EMAIL] [--ttl TTL]
[--description DESCRIPTION | --no-description]
id</computeroutput></screen>
<para>
Update Domain
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>id</command></term>
<listitem>
<para>
Domain ID or name
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--name NAME</command></term>
<listitem>
<para>
Domain name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--email EMAIL</command></term>
<listitem>
<para>
Domain email
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--ttl TTL</command></term>
<listitem>
<para>
Time to live (seconds)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description DESCRIPTION</command></term>
<listitem>
<para>
Description
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--no-description</command></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_quota-get">
<title>designate quota-get</title>
<screen><computeroutput>usage: designate quota-get [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--noindent]
[--prefix PREFIX]
tenant_id</computeroutput></screen>
<para>
Get Quota
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>tenant_id</command></term>
<listitem>
<para>
Tenant ID
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_quota-reset">
<title>designate quota-reset</title>
<screen><computeroutput>usage: designate quota-reset [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;] [--noindent]
[--prefix PREFIX]
tenant_id</computeroutput></screen>
<para>
Reset Quota
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>tenant_id</command></term>
<listitem>
<para>
Tenant ID
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_quota-update">
<title>designate quota-update</title>
<screen><computeroutput>usage: designate quota-update [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;] [--noindent]
[--prefix PREFIX] [--domains DOMAINS]
[--domain-recordsets DOMAIN_RECORDSETS]
[--recordset-records RECORDSET_RECORDS]
[--domain-records DOMAIN_RECORDS]
tenant_id</computeroutput></screen>
<para>
Update Quota
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>tenant_id</command></term>
<listitem>
<para>
Tenant ID
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--domains DOMAINS</command></term>
<listitem>
<para>
Allowed domains
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--domain-recordsets DOMAIN_RECORDSETS</command></term>
<listitem>
<para>
Allowed domain records
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--recordset-records RECORDSET_RECORDS</command></term>
<listitem>
<para>
Allowed recordset records
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--domain-records DOMAIN_RECORDS</command></term>
<listitem>
<para>
Allowed domain records
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_record-create">
<title>designate record-create</title>
<screen><computeroutput>usage: designate record-create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX] --name NAME
--type TYPE --data DATA [--ttl TTL]
[--priority PRIORITY]
[--description DESCRIPTION]
domain_id</computeroutput></screen>
<para>
Create Record
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>domain_id</command></term>
<listitem>
<para>
Domain ID or name
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--name NAME</command></term>
<listitem>
<para>
Record (relative|absolute) name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--type TYPE</command></term>
<listitem>
<para>
Record type
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--data DATA</command></term>
<listitem>
<para>
Record data
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--ttl TTL</command></term>
<listitem>
<para>
Record TTL
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--priority PRIORITY</command></term>
<listitem>
<para>
Record priority
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description DESCRIPTION</command></term>
<listitem>
<para>
Description
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_record-delete">
<title>designate record-delete</title>
<screen><computeroutput>usage: designate record-delete [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX]
domain_id id</computeroutput></screen>
<para>
Delete Record
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>domain_id</command></term>
<listitem>
<para>
Domain ID or name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>id</command></term>
<listitem>
<para>
Record ID
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_record-get">
<title>designate record-get</title>
<screen><computeroutput>usage: designate record-get [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;] [--noindent]
[--prefix PREFIX]
domain_id id</computeroutput></screen>
<para>
Get Record
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>domain_id</command></term>
<listitem>
<para>
Domain ID or name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>id</command></term>
<listitem>
<para>
Record ID
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_record-list">
<title>designate record-list</title>
<screen><computeroutput>usage: designate record-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
domain_id</computeroutput></screen>
<para>
List Records
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>domain_id</command></term>
<listitem>
<para>
Domain ID or name
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_record-update">
<title>designate record-update</title>
<screen><computeroutput>usage: designate record-update [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX] [--name NAME]
[--type TYPE] [--data DATA]
[--description DESCRIPTION | --no-description]
[--ttl TTL | --no-ttl]
[--priority PRIORITY | --no-priority]
domain_id id</computeroutput></screen>
<para>
Update Record
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>domain_id</command></term>
<listitem>
<para>
Domain ID or name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>id</command></term>
<listitem>
<para>
Record ID
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--name NAME</command></term>
<listitem>
<para>
Record name
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--type TYPE</command></term>
<listitem>
<para>
Record type
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--data DATA</command></term>
<listitem>
<para>
Record data
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--description DESCRIPTION</command></term>
<listitem>
<para>
Description
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--no-description</command></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--ttl TTL</command></term>
<listitem>
<para>
Record time to live (seconds)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--no-ttl</command></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--priority PRIORITY</command></term>
<listitem>
<para>
Record priority
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--no-priority</command></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_report-count-all">
<title>designate report-count-all</title>
<screen><computeroutput>usage: designate report-count-all [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX]</computeroutput></screen>
<para>
Get count totals for all tenants, domains and records
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_report-count-domains">
<title>designate report-count-domains</title>
<screen><computeroutput>usage: designate report-count-domains [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX]</computeroutput></screen>
<para>
Get counts for total domains
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_report-count-records">
<title>designate report-count-records</title>
<screen><computeroutput>usage: designate report-count-records [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX]</computeroutput></screen>
<para>
Get counts for total records
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_report-count-tenants">
<title>designate report-count-tenants</title>
<screen><computeroutput>usage: designate report-count-tenants [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX]</computeroutput></screen>
<para>
Get counts for total tenants
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_report-tenant-domains">
<title>designate report-tenant-domains</title>
<screen><computeroutput>usage: designate report-tenant-domains [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
--report-tenant-id REPORT_TENANT_ID</computeroutput></screen>
<para>
Get a list of domains for given tenant
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--report-tenant-id REPORT_TENANT_ID</command></term>
<listitem>
<para>
The tenant_id being reported on.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_report-tenants-all">
<title>designate report-tenants-all</title>
<screen><computeroutput>usage: designate report-tenants-all [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
<para>
Get list of tenants and domain count for each
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_server-create">
<title>designate server-create</title>
<screen><computeroutput>usage: designate server-create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX] --name NAME</computeroutput></screen>
<para>
Create Server
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--name NAME</command></term>
<listitem>
<para>
Server name
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_server-delete">
<title>designate server-delete</title>
<screen><computeroutput>usage: designate server-delete [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX]
id</computeroutput></screen>
<para>
Delete Server
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>id</command></term>
<listitem>
<para>
Server ID
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_server-get">
<title>designate server-get</title>
<screen><computeroutput>usage: designate server-get [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;] [--noindent]
[--prefix PREFIX]
id</computeroutput></screen>
<para>
Get Server
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>id</command></term>
<listitem>
<para>
Server ID
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_server-list">
<title>designate server-list</title>
<screen><computeroutput>usage: designate server-list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--noindent]
[--quote {all,minimal,none,nonnumeric}]</computeroutput></screen>
<para>
List Servers
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_server-update">
<title>designate server-update</title>
<screen><computeroutput>usage: designate server-update [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;]
[--noindent] [--prefix PREFIX] [--name NAME]
id</computeroutput></screen>
<para>
Update Server
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>id</command></term>
<listitem>
<para>
Server ID
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>--name NAME</command></term>
<listitem>
<para>
Server name
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_sync-all">
<title>designate sync-all</title>
<screen><computeroutput>usage: designate sync-all [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN]
[--max-width &lt;integer&gt;] [--noindent]
[--prefix PREFIX]</computeroutput></screen>
<para>
Sync Everything
</para> <variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_sync-domain">
<title>designate sync-domain</title>
<screen><computeroutput>usage: designate sync-domain [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;] [--noindent]
[--prefix PREFIX]
domain_id</computeroutput></screen>
<para>
Sync a single Domain
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>domain_id</command></term>
<listitem>
<para>
Domain ID
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_sync-record">
<title>designate sync-record</title>
<screen><computeroutput>usage: designate sync-record [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;] [--noindent]
[--prefix PREFIX]
domain_id record_id</computeroutput></screen>
<para>
Sync a single Record
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>domain_id</command></term>
<listitem>
<para>
Domain ID
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>record_id</command></term>
<listitem>
<para>
Record ID
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="designateclient_subcommand_touch-domain">
<title>designate touch-domain</title>
<screen><computeroutput>usage: designate touch-domain [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width &lt;integer&gt;] [--noindent]
[--prefix PREFIX]
domain_id</computeroutput></screen>
<para>
Touch a single Domain
</para> <variablelist wordsize="10">
<title>Positional arguments</title>
<varlistentry>
<term><command>domain_id</command></term>
<listitem>
<para>
Domain ID
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist wordsize="10">
<title>Optional arguments</title>
<varlistentry>
<term><command>-h, --help</command></term>
<listitem>
<para>
show this help message and exit
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</chapter>