Commit 56f1285c authored by Michael Sawyer's avatar Michael Sawyer
Browse files

Document new RNDC options and statistics file.

Regenerate HTML files.
parent 3e3be8fe
......@@ -2,7 +2,7 @@
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN"
"http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd">
<!-- File: $Id: Bv9ARM-book.xml,v 1.43 2000/11/20 21:49:14 bwelling Exp $ -->
<!-- File: $Id: Bv9ARM-book.xml,v 1.44 2000/11/21 18:12:34 mws Exp $ -->
<book>
......@@ -639,7 +639,9 @@ of a server.</para>
<arg>-c <replaceable>config</replaceable></arg>
<arg>-s <replaceable>server</replaceable></arg>
<arg>-p <replaceable>port</replaceable></arg>
<arg>-v <replaceable>view</replaceable></arg>
<arg>-y <replaceable>key</replaceable></arg>
<arg>-z <replaceable>zone</replaceable></arg>
<arg choice="plain"><replaceable>command</replaceable></arg>
<arg rep="repeat"><replaceable>command</replaceable></arg>
</cmdsynopsis>
......@@ -665,11 +667,15 @@ of a server.</para>
<entry colname = "2"><para>Dump database and cache to /var/tmp/named_dump.db.</para></entry>
</row>
<row rowsep = "0">
<entry colname = "1"><para><userinput>refresh</userinput></para></entry>
<entry colname = "2"><para>Forced refresh of specified zone.</para></entry>
</row>
<row rowsep = "0">
<entry colname = "1"><para><userinput>reload</userinput></para></entry>
<entry colname = "2"><para>Reload configuration file and zones.</para></entry>
</row>
<row rowsep = "0">
<entry colname = "1"><para><userinput>stats</userinput><footnoteref linkend="nyi1"/></para></entry>
<entry colname = "1"><para><userinput>stats</userinput></para></entry>
<entry colname = "2"><para>Dump statistics to /var/tmp/named.stats.</para></entry>
</row>
<row rowsep = "0">
......@@ -700,8 +706,8 @@ of a server.</para>
</tbody>
</tgroup>
</informaltable>
<para>As noted above, <command>reload</command> is the
only command available for <acronym>BIND</acronym> 9.0.0. The other
<para>As noted above, only a limited number of commands are
available for <acronym>BIND</acronym> 9.0.0. The other
commands, and more, are planned to be implemented for
future releases.</para>
......@@ -2432,6 +2438,7 @@ lookups performed on behalf of clients by a caching name server.</para></entry>
<optional> memstatistics-file <replaceable>path_name</replaceable>; </optional>
<optional> pid-file <replaceable>path_name</replaceable>; </optional>
<optional> statistics-file <replaceable>path_name</replaceable>; </optional>
<optional> statistics <replaceable>yes_or_no</replaceable>; </optional>
<optional> auth-nxdomain <replaceable>yes_or_no</replaceable>; </optional>
<optional> deallocate-on-exit <replaceable>yes_or_no</replaceable>; </optional>
<optional> dialup <replaceable>dialup_option</replaceable>; </optional>
......@@ -2581,11 +2588,8 @@ nameserver.</para></entry>
<row rowsep = "0">
<entry colname = "1"><para><command>statistics-file</command></para></entry>
<entry colname = "2"><para>The pathname of the file the server appends statistics
to. If not specified, the default is <filename>named.stats</filename>.</para><note>
<simpara>Not
yet implemented in <acronym>BIND</acronym> 9.</simpara></note></entry>
to. If not specified, the default is <filename>named.stats</filename>.</para></entry>
</row>
<row rowsep = "0">
<entry colname = "1"><para><command>port</command></para></entry>
<entry colname = "2"><para>
......@@ -2749,6 +2753,13 @@ answers. The default is <userinput>no</userinput>.</para>
<acronym>BIND</acronym> 9 always allocates query IDs from a pool.</para></entry>
</row>
<row rowsep = "0">
<entry colname = "1"><para><command>statistics</command></para></entry>
<entry colname = "2"><para>If yes, the server will, by default, collect
statistical data on all zones in the server. These statistics may be accessed
using the <command>rndc</command> which will dump them to the file listed
in the <command>statistics-file</command> option listed above.</para></entry>
</row>
<row rowsep = "0">
<entry colname = "1"><para><command>treat-cr-as-space</command></para></entry>
<entry colname = "2"><para>This option was used in <acronym>BIND</acronym> 8 to make
the server treat carriage return ("<command>\r</command>") characters the same way
......@@ -3500,6 +3511,7 @@ key data.</para></sect2>
<programlisting>view <replaceable>view_name</replaceable> <optional><replaceable>class</replaceable></optional> {
match-clients { <replaceable>address_match_list</replaceable> } ;
<optional> <replaceable>view_option</replaceable>; ...</optional>
<optional> statistics <replaceable>yes_or_no</replaceable> ; </optional>
<optional> <replaceable>zone_statement</replaceable>; ...</optional>
};
</programlisting></sect2>
......@@ -3590,6 +3602,7 @@ Statement Grammar</title>
<optional> pubkey <replaceable>number</replaceable> <replaceable>number</replaceable> <replaceable>number</replaceable> <replaceable>string</replaceable> ; </optional>
<optional> transfer-source (<replaceable>ip4_addr</replaceable> | <constant>*</constant>) <optional>port <replaceable>ip_port</replaceable></optional> ; </optional>
<optional> transfer-source-v6 (<replaceable>ip6_addr</replaceable> | <constant>*</constant>) <optional>port <replaceable>ip_port</replaceable></optional> ; </optional>
<optional> statistics <replaceable>yes_or_no</replaceable> ; </optional>
<optional> sig-validity-interval <replaceable>number</replaceable> ; </optional>
<optional> database <replaceable>string</replaceable> ; </optional>
}</optional>;
......@@ -3818,6 +3831,12 @@ zones when they are loaded from disk. <acronym>BIND</acronym> 9 does not verify
on loading and ignores the option.</para></entry>
</row>
<row rowsep = "0">
<entry colname = "1"><para><command>statistics</command></para></entry>
<entry colname = "2"><para>If set to yes, the server will keep statistical
information for all zones in the view, which can be dumped to the
statistics-file defined in the server options.</para></entry>
</row>
<row rowsep = "0">
<entry colname = "1"><para><command>sig-validity-interval</command></para></entry>
<entry colname = "2"><para>See the description of
<command>sig-validity-interval</command> under <xref linkend="tuning"/>.</para></entry>
......@@ -5478,6 +5497,63 @@ after which they are deleted unless updated by their authors.
</bibliography>
</sect2>
</sect1>
<sect1 id="statsfile">
<title>Format of statistics file</title>
<para>The statistics file generated by Bind9 is similar in form to that
generated by Bind8, but is not identical, due to differences in the counters
currently implemented in Bind9.</para>
<para>The statistics dump begins with the line <command>+++ Statistics Dump
+++ (973798949)</command>, where the number in parentheses is a standard
Unix-style timestamp, measured as seconds since January 1, 1970. Following
that line are a series of lines containing a counter type, value of the
counter, and possibly a view/zone pair. The lines without view and zone
listed are global counters for the entire server and the lines with view and
zones specified are for the given view and zone. The statistics dump ends
with the line <command>--- Statistics Dump --- (973798949)</command>, where the
number is identical to the number in the beginning line.</para>
<para>The following counters are defined:</para>
<informaltable
colsep = "0" rowsep = "0"><tgroup cols = "2"
colsep = "0" rowsep = "0" tgroupstyle = "4Level-table">
<colspec colname = "1" colnum = "1" colsep = "0" colwidth = "1.150in"/>
<colspec colname = "2" colnum = "2" colsep = "0" colwidth = "3.350in"/>
<tbody>
<row rowsep = "0">
<entry colname = "1"><para><command>success</command></para></entry>
<entry colname = "2"><para>This counter is used to track the number of
successful queries made to the server or zone. A successful query
is defined as query which returns a NOERROR result other than
delegation replies.</para></entry>
</row>
<row rowsep = "0">
<entry colname = "1"><para><command>delegation</command></para></entry>
<entry colname = "2"><para>This counter is used to track the number
of queries which return delegations instead a final answer.</para></entry>
</row>
<row rowsep = "0">
<entry colname = "1"><para><command>nxrrset</command></para></entry>
<entry colname = "2"><para>This counter is used to track the number
of queries made which return a result code of NXRRSET.</para></entry>
</row>
<row rowsep = "0">
<entry colname = "1"><para><command>nxdoimain</command></para></entry>
<entry colname = "2"><para>This counter is used to track the number
of queries made which return a result code of NXDOMAIN.</para></entry>
</row>
<row rowsep = "0">
<entry colname = "1"><para><command>recursion</command></para></entry>
<entry colname = "2"><para>This counter is used to track the number
of queries made which resulted in recursion in order to find the final
answer.</para></entry>
</row
><row rowsep = "0">
<entry colname = "1"><para><command>failure</command></para></entry>
<entry colname = "2"><para>This counter is used to track the number
of queries resulted in a SERVFAIL reply.</para></entry>
</row>
</tbody>
</tgroup></informaltable>
</sect1>
</appendix>
</book>
......
......@@ -601,17 +601,20 @@ CLASS="systemitem"
>where <SPAN
CLASS="systemitem"
>com</SPAN
> is the top level domain to which <SPAN
> is the top level domain to which
<SPAN
CLASS="systemitem"
>ourhost.example.com</SPAN
> belongs, <SPAN
> belongs,
<SPAN
CLASS="systemitem"
>example</SPAN
> is
a subdomain of <SPAN
CLASS="systemitem"
>com</SPAN
>, and <SPAN
>, and
<SPAN
CLASS="systemitem"
>ourhost</SPAN
> is the
......@@ -629,13 +632,15 @@ via File Transfer Protocol (FTP) from
HREF="ftp://www.isi.edu/in-notes/"
TARGET="_top"
>ftp://www.isi.edu/in-notes/</A
> or via the Web at <A
>
or via the Web at <A
HREF="http://www.ietf.org/rfc/"
TARGET="_top"
>http://www.ietf.org/rfc/</A
>.
(See Appendix C for complete information on finding and retrieving
RFCs.) It is also recommended that you read the related man pages: <B
RFCs.) It is also recommended that you read the related man pages:
<B
CLASS="command"
>named</B
> and <B
......@@ -679,19 +684,22 @@ CLASS="systemitem"
> domain
which includes names such as <SPAN
CLASS="systemitem"
>host.aaa.example.com </SPAN
>and <SPAN
>host.aaa.example.com</SPAN
>
and <SPAN
CLASS="systemitem"
>host.bbb.example.com</SPAN
> even
though the <SPAN
CLASS="systemitem"
>example.com</SPAN
> zone includes only delegations
for the <SPAN
>
zone includes only delegations for the
<SPAN
CLASS="systemitem"
>aaa.example.com</SPAN
> and <SPAN
>
and <SPAN
CLASS="systemitem"
>bbb.example.com</SPAN
> zones.
......
......@@ -428,12 +428,14 @@ CLASS="command"
<B
CLASS="command"
>options</B
> statement, see <A
> statement, see
<A
HREF="Bv9ARM.ch06.html#rrset_ordering"
><I
>RRset Ordering</I
></A
>. This substatement is not supported in
>.
This substatement is not supported in
<SPAN
CLASS="acronym"
>BIND</SPAN
......@@ -753,11 +755,21 @@ CLASS="replaceable"
><I
>port</I
></TT
>] [-v <TT
CLASS="replaceable"
><I
>view</I
></TT
>] [-y <TT
CLASS="replaceable"
><I
>key</I
></TT
>] [-z <TT
CLASS="replaceable"
><I
>zone</I
></TT
>] <TT
CLASS="replaceable"
><I
......@@ -841,6 +853,27 @@ VALIGN="MIDDLE"
><TT
CLASS="userinput"
><B
>refresh</B
></TT
></P
></TD
><TD
WIDTH="288"
ALIGN="LEFT"
VALIGN="MIDDLE"
><P
>Forced refresh of specified zone.</P
></TD
></TR
><TR
><TD
WIDTH="144"
ALIGN="LEFT"
VALIGN="MIDDLE"
><P
><TT
CLASS="userinput"
><B
>reload</B
></TT
></P
......@@ -864,9 +897,6 @@ CLASS="userinput"
><B
>stats</B
></TT
><A
HREF="#FTN.nyi1"
>[a]</A
></P
></TD
><TD
......@@ -1011,11 +1041,8 @@ NAME="FTN.nyi1"
></P
></DIV
><P
>As noted above, <B
CLASS="command"
>reload</B
> is the
only command available for <SPAN
>As noted above, only a limited number of commands are
available for <SPAN
CLASS="acronym"
>BIND</SPAN
> 9.0.0. The other
......@@ -1216,7 +1243,7 @@ CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN599"
NAME="AEN607"
>3.4.2. Signals</A
></H2
><P
......
......@@ -85,7 +85,7 @@ HREF="Bv9ARM.ch04.html#incremental_zone_transfers"
></DT
><DT
>4.3. <A
HREF="Bv9ARM.ch04.html#AEN653"
HREF="Bv9ARM.ch04.html#AEN661"
>Split DNS</A
></DT
><DT
......@@ -95,12 +95,12 @@ HREF="Bv9ARM.ch04.html#tsig"
></DT
><DT
>4.5. <A
HREF="Bv9ARM.ch04.html#AEN815"
HREF="Bv9ARM.ch04.html#AEN821"
>TKEY</A
></DT
><DT
>4.6. <A
HREF="Bv9ARM.ch04.html#AEN830"
HREF="Bv9ARM.ch04.html#AEN836"
>SIG(0)</A
></DT
><DT
......@@ -110,7 +110,7 @@ HREF="Bv9ARM.ch04.html#DNSSEC"
></DT
><DT
>4.8. <A
HREF="Bv9ARM.ch04.html#AEN914"
HREF="Bv9ARM.ch04.html#AEN920"
>IPv6 Support in <SPAN
CLASS="acronym"
>BIND</SPAN
......@@ -229,7 +229,7 @@ CLASS="sect1"
><H1
CLASS="sect1"
><A
NAME="AEN653"
NAME="AEN661"
>4.3. Split DNS</A
></H1
><P
......@@ -312,16 +312,10 @@ CLASS="filename"
>site2.internal</TT
>.</P
><P
>To protect the<TT
>To protect the <TT
CLASS="filename"
> site1.interna</TT
><I
CLASS="emphasis"
>l</I
> and<I
CLASS="emphasis"
> </I
><TT
>site1.internal</TT
> and <TT
CLASS="filename"
>site2.internal</TT
> domains,
......@@ -445,8 +439,8 @@ CLASS="systemitem"
> and
<SPAN
CLASS="systemitem"
>site2.example.com </SPAN
>zones.</P
>site2.example.com</SPAN
> zones.</P
></LI
><LI
><P
......@@ -635,7 +629,7 @@ CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN746"
NAME="AEN752"
>4.4.1. Generate Shared Keys for Each Pair of Hosts</A
></H2
><P
......@@ -653,7 +647,7 @@ CLASS="sect3"
><H3
CLASS="sect3"
><A
NAME="AEN751"
NAME="AEN757"
>4.4.1.1. Automatic Generation</A
></H3
><P
......@@ -695,7 +689,7 @@ CLASS="sect3"
><H3
CLASS="sect3"
><A
NAME="AEN762"
NAME="AEN768"
>4.4.1.2. Manual Generation</A
></H3
><P
......@@ -716,7 +710,7 @@ CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN767"
NAME="AEN773"
>4.4.2. Copying the Shared Secret to Both Machines</A
></H2
><P
......@@ -728,7 +722,7 @@ CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN770"
NAME="AEN776"
>4.4.3. Informing the Servers of the Key's Existence</A
></H2
><P
......@@ -776,7 +770,7 @@ CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN782"
NAME="AEN788"
>4.4.4. Instructing the Server to Use the Key</A
></H2
><P
......@@ -836,7 +830,7 @@ CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN798"
NAME="AEN804"
>4.4.5. TSIG Key Based Access Control</A
></H2
><P
......@@ -882,7 +876,7 @@ CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN811"
NAME="AEN817"
>4.4.6. Errors</A
></H2
><P
......@@ -911,7 +905,7 @@ CLASS="sect1"
><H1
CLASS="sect1"
><A
NAME="AEN815"
NAME="AEN821"
>4.5. TKEY</A
></H1
><P
......@@ -977,7 +971,7 @@ CLASS="sect1"
><H1
CLASS="sect1"
><A
NAME="AEN830"
NAME="AEN836"
>4.6. SIG(0)</A
></H1
><P
......@@ -1046,7 +1040,7 @@ CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN846"
NAME="AEN852"
>4.7.1. Generating Keys</A
></H2
><P
......@@ -1117,15 +1111,15 @@ CLASS="command"
> statements, including the
<TT
CLASS="filename"
>.key </TT
>files.</P
>.key</TT
> files.</P
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN866"
NAME="AEN872"
>4.7.2. Creating a Keyset</A
></H2
><P
......@@ -1178,7 +1172,7 @@ CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN878"
NAME="AEN884"
>4.7.3. Signing the Child's Keyset</A
></H2
><P
......@@ -1228,7 +1222,7 @@ CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN891"
NAME="AEN897"
>4.7.4. Signing the Zone</A
></H2
><P
......@@ -1290,7 +1284,7 @@ CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN907"
NAME="AEN913"
>4.7.5. Configuring Servers</A
></H2
><P
......@@ -1317,7 +1311,7 @@ CLASS="sect1"
><H1
CLASS="sect1"
><A
NAME="AEN914"
NAME="AEN920"
>4.8. IPv6 Support in <SPAN
CLASS="acronym"
>BIND</SPAN
......@@ -1371,7 +1365,7 @@ CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN928"
NAME="AEN934"
>4.8.1. Address Lookups Using AAAA Records</A
></H2
><P
......@@ -1393,7 +1387,7 @@ CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN933"
NAME="AEN939"
>4.8.2. Address Lookups Using A6 Records</A
></H2
><P
......@@ -1413,7 +1407,7 @@ CLASS="sect3"
><H3
CLASS="sect3"
><A
NAME="AEN937"
NAME="AEN943"
>4.8.2.1. A6 Chains</A
></H3
><P
......@@ -1459,7 +1453,7 @@ CLASS="sect3"
><H3
CLASS="sect3"
><A
NAME="AEN948"
NAME="AEN954"
>4.8.2.2. A6 Records for DNS Servers</A
></H3
><P
......@@ -1489,7 +1483,7 @@ CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN954"
NAME="AEN960"
>4.8.3. Address to Name Lookups Using Nibble Format</A
></H2
><P
......@@ -1520,7 +1514,7 @@ CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN961"
NAME="AEN967"
>4.8.4. Address to Name Lookups Using Bitstring Format</A
></H2
><P
......@@ -1547,7 +1541,7 @@ CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN968"
NAME="AEN974"
>4.8.5. Using DNAME for Delegation of IPv6 Reverse Addresses</A
></H2
><P
......
......@@ -78,7 +78,7 @@ CLASS="TOC"
></DT
><DT
>5.1. <A
HREF="Bv9ARM.ch05.html#AEN988"
HREF="Bv9ARM.ch05.html#AEN994"
>The Lightweight Resolver Library</A
></DT
><DT
......@@ -93,7 +93,7 @@ CLASS="sect1"
><H1
CLASS="sect1"
><A
NAME="AEN988"
NAME="AEN994"
>5.1. The Lightweight Resolver Library</A
></H1
><P
......
......@@ -88,7 +88,7 @@ HREF="Bv9ARM.ch06.html#Configuration_File_Grammar"
></DT
><DT
>6.3. <A
HREF="Bv9ARM.ch06.html#AEN3242"
HREF="Bv9ARM.ch06.html#AEN3249"
>Zone File</A
></DT
></DL
......@@ -731,7 +731,7 @@ CLASS="sect3"
><H3
CLASS="sect3"
><A
NAME="AEN1193"
NAME="AEN1199"
>6.1.1.1. Syntax</A
></H3
><PRE
......@@ -762,7 +762,7 @@ CLASS="sect3"
><H3