diff options
Diffstat (limited to 'src/bin/auth/b10-auth.xml.pre')
| -rw-r--r-- | src/bin/auth/b10-auth.xml.pre | 327 |
1 files changed, 0 insertions, 327 deletions
diff --git a/src/bin/auth/b10-auth.xml.pre b/src/bin/auth/b10-auth.xml.pre deleted file mode 100644 index b8e29469fd..0000000000 --- a/src/bin/auth/b10-auth.xml.pre +++ /dev/null @@ -1,327 +0,0 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" - [<!ENTITY mdash "—">]> -<!-- - - Copyright (C) 2010-2012 Internet Systems Consortium, Inc. ("ISC") - - - - Permission to use, copy, modify, and/or distribute this software for any - - purpose with or without fee is hereby granted, provided that the above - - copyright notice and this permission notice appear in all copies. - - - - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH - - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY - - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, - - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM - - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE - - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - - PERFORMANCE OF THIS SOFTWARE. ---> - -<refentry> - - <refentryinfo> - <date>July 16, 2013</date> - </refentryinfo> - - <refmeta> - <refentrytitle>b10-auth</refentrytitle> - <manvolnum>8</manvolnum> - <refmiscinfo>BIND10</refmiscinfo> - </refmeta> - - <refnamediv> - <refname>b10-auth</refname> - <refpurpose>Authoritative DNS server</refpurpose> - </refnamediv> - - <docinfo> - <copyright> - <year>2010-2012</year> - <holder>Internet Systems Consortium, Inc. ("ISC")</holder> - </copyright> - </docinfo> - - <refsynopsisdiv> - <cmdsynopsis> - <command>b10-auth</command> - <arg><option>-v</option></arg> - </cmdsynopsis> - </refsynopsisdiv> - - <refsect1> - <title>DESCRIPTION</title> - <para>The <command>b10-auth</command> daemon provides the BIND 10 - authoritative DNS server. - Normally it is started by the - <citerefentry><refentrytitle>b10-init</refentrytitle><manvolnum>8</manvolnum></citerefentry> - process. - </para> - - <para> - This daemon communicates with other BIND 10 components over a - <citerefentry><refentrytitle>b10-msgq</refentrytitle><manvolnum>8</manvolnum></citerefentry> - C-Channel connection. If this connection is not established, - <command>b10-auth</command> will exit. -<!-- TODO what if msgq connection closes later, will b10-auth exit? --> - It receives its configurations from -<citerefentry><refentrytitle>b10-cfgmgr</refentrytitle><manvolnum>8</manvolnum></citerefentry>. - - </para> - -<!-- TODO: mention xfrin, xfrout, zonemgr ? --> - - </refsect1> - - <refsect1> - <title>OPTIONS</title> - - <para>The arguments are as follows:</para> - - <variablelist> - <varlistentry> - <term><option>-v</option></term> - <listitem><para> - Enable verbose logging mode. This enables logging of - diagnostic messages at the maximum debug level. - </para></listitem> - </varlistentry> - - </variablelist> - - </refsect1> - - <refsect1> - <title>CONFIGURATION AND COMMANDS</title> - <para> - The configurable settings are: - </para> - - <para> - <varname>database_file</varname> defines the path to the - SQLite3 zone file when using the sqlite datasource. - The default is - <filename>@@LOCALSTATEDIR@@/bind10/zone.sqlite3</filename>. - </para> - - <para> - <varname>datasources</varname> configures data sources. - The list items include: - <varname>type</varname> to define the required data source type - (such as <quote>memory</quote>); - <varname>class</varname> to optionally select the class - (it defaults to <quote>IN</quote>); - and - <varname>zones</varname> to define the - <varname>file</varname> path name, - <varname>origin</varname> (default domain), and optional - <varname>filetype</varname>. - By default, <varname>zones</varname> is empty. - For the in-memory data source (i.e., the <varname>type</varname> - is <quote>memory</quote>), the optional <varname>filetype</varname> - configuration item for <varname>zones</varname> can be - specified so the in-memory zone data can be built from another - data source that is based on a database backend (in practice - with current implementation, it would be an SQLite3 database - file for the SQLite3 data source). - See the <citetitle>BIND 10 Guide</citetitle> for configuration - details. - - <note><simpara> - Only the IN class is supported at this time. - By default, the memory data source is disabled. - Also, currently the zone file must be canonical such as - generated by <command>named-compilezone -D</command>. - </simpara></note> - </para> - - <para> - <varname>listen_on</varname> is a list of addresses and ports for - <command>b10-auth</command> to listen on. - The list items are the <varname>address</varname> string - and <varname>port</varname> number. - By default, <command>b10-auth</command> listens on port 53 - on the IPv6 (::) and IPv4 (0.0.0.0) wildcard addresses. - </para> - - <para> - <varname>tcp_recv_timeout</varname> is the timeout used on - incoming TCP connections, in milliseconds. If the query - is not sent within this time, the connection is closed. - Setting this to 0 will disable TCP timeouts completely. - The default is 5000 (five seconds). - </para> - -<!-- TODO: formating --> - <para> - The configuration commands are: - </para> - - <para> - <command>getstats</command> tells <command>b10-auth</command> - to report its defined statistics data in JSON format. - It will not report about unused counters. - This is used by the - <citerefentry><refentrytitle>b10-stats</refentrytitle><manvolnum>8</manvolnum></citerefentry> daemon. - (The <command>sendstats</command> command is deprecated.) - </para> - - <para> - <command>loadzone</command> tells <command>b10-auth</command> - to load or reload a zone file. The arguments include: - <varname>class</varname> which optionally defines the class - (it defaults to <quote>IN</quote>); - <varname>origin</varname> is the domain name of the zone; - and - <varname>datasrc</varname> optionally defines the type of datasource - (it defaults to <quote>memory</quote>). - - <note><simpara> - In this development version, currently this only supports the - IN class and the memory data source. - </simpara></note> - </para> - - <para> - <command>getstats</command> tells <command>b10-auth</command> - to send its statistics data. - </para> - - <para> - <command>shutdown</command> exits <command>b10-auth</command>. - This has an optional <varname>pid</varname> argument to - select the process ID to stop. - (Note that the b10-init process may restart this service - if configured.) - </para> - - <para> - <command>start_ddns_forwarder</command> starts (or restarts) the - internal forwarding of DDNS Update messages. - This is used by the - <citerefentry><refentrytitle>b10-ddns</refentrytitle><manvolnum>8</manvolnum></citerefentry> - daemon to tell <command>b10-auth</command> that DDNS Update - messages can be forwarded. - <note><simpara>This is not expected to be called by administrators; - it will be removed as a public command in the future.</simpara></note> - </para> - - <para> - <command>stop_ddns_forwarder</command> stops the internal - forwarding of DDNS Update messages. - This is used by the - <citerefentry><refentrytitle>b10-ddns</refentrytitle><manvolnum>8</manvolnum></citerefentry> - daemon to tell <command>b10-auth</command> that DDNS Update - messages should not be forwarded. - <note><simpara>This is not expected to be called by administrators; - it will be removed as a public command in the future.</simpara></note> - </para> - - </refsect1> - - <refsect1> - <title>STATISTICS DATA</title> - - <para> - The statistics data collected by the <command>b10-stats</command> - daemon for <quote>Auth</quote> include: - </para> - -<!-- ### STATISTICS DATA PLACEHOLDER ### --> - - <note> - <para> - Opcode of a request message will not be counted if: - <itemizedlist> - <listitem><para> - The request message is too short to parse the message header - </para></listitem> - <listitem><para> - The request message is a response (i.e. QR bit is set) - </para></listitem> - </itemizedlist> - </para> - - <para> - Request attributes except for opcode will not be counted if TSIG - validation failed as they are not reliable. - We always count opcode mainly for compatibility with BIND 9, - but remember that if there's any error related to TSIG, some - of the counted opcode may not be trustworthy. - </para> - - <para> - The <quote>qryrecursion</quote> counter is limited to queries - (requests of opcode 0) even though the RD bit is not specific - to queries. In practice, this bit is generally just ignored for - other types of requests, while DNS servers behave differently - for queries depending on this bit. It is also known that - some authoritative-only servers receive a non negligible - number of queries with the RD bit being set, so it would be - of particular interest to have a specific counters for such - requests. - </para> - - <para> - There are two request counters related to EDNS: - <quote>request.edns0</quote> and <quote>request.badednsver</quote>. - The latter is a counter of requests with unsupported EDNS version: - other than version 0 in the current implementation. Therefore, total - number of requests with EDNS is a sum of <quote>request.edns0</quote> - and <quote>request.badednsver</quote>. - </para> - </note> - - </refsect1> - - <refsect1> - <title>FILES</title> - <para> - <filename>@@LOCALSTATEDIR@@/bind10/zone.sqlite3</filename> - — Location for the SQLite3 zone database - when <emphasis>database_file</emphasis> configuration is not - defined. - </para> - </refsect1> - - <refsect1> - <title>SEE ALSO</title> - <para> - <citerefentry> - <refentrytitle>b10-cfgmgr</refentrytitle><manvolnum>8</manvolnum> - </citerefentry>, - <citerefentry> - <refentrytitle>b10-ddns</refentrytitle><manvolnum>8</manvolnum> - </citerefentry>, - <citerefentry> - <refentrytitle>b10-init</refentrytitle><manvolnum>8</manvolnum> - </citerefentry>, - <citerefentry> - <refentrytitle>b10-loadzone</refentrytitle><manvolnum>8</manvolnum> - </citerefentry>, - <citerefentry> - <refentrytitle>b10-msgq</refentrytitle><manvolnum>8</manvolnum> - </citerefentry>, - <citerefentry> - <refentrytitle>b10-stats</refentrytitle><manvolnum>8</manvolnum> - </citerefentry>, - <citerefentry> - <refentrytitle>b10-zonemgr</refentrytitle><manvolnum>8</manvolnum> - </citerefentry>, - <citerefentry> - <refentrytitle>bind10</refentrytitle><manvolnum>8</manvolnum> - </citerefentry>, - <citetitle>BIND 10 Guide</citetitle>. - </para> - </refsect1> - - <refsect1> - <title>HISTORY</title> - <para> - The <command>b10-auth</command> daemon was first coded in October 2009. - </para> - </refsect1> -</refentry><!-- - - Local variables: - - mode: sgml - - End: ---> |