From 56f1285ca5d97d3205b74c32dc4de1ea7b69fea1 Mon Sep 17 00:00:00 2001 From: Michael Sawyer Date: Tue, 21 Nov 2000 18:12:45 +0000 Subject: [PATCH] Document new RNDC options and statistics file. Regenerate HTML files. --- doc/arm/Bv9ARM-book.xml | 92 ++++++++++- doc/arm/Bv9ARM.ch01.html | 28 ++-- doc/arm/Bv9ARM.ch03.html | 49 ++++-- doc/arm/Bv9ARM.ch04.html | 76 +++++---- doc/arm/Bv9ARM.ch05.html | 4 +- doc/arm/Bv9ARM.ch06.html | 327 +++++++++++++++++++-------------------- doc/arm/Bv9ARM.ch07.html | 25 +-- doc/arm/Bv9ARM.ch08.html | 16 +- doc/arm/Bv9ARM.ch09.html | 286 +++++++++++++++++++++++++++------- doc/arm/Bv9ARM.html | 123 ++++++++------- 10 files changed, 648 insertions(+), 378 deletions(-) diff --git a/doc/arm/Bv9ARM-book.xml b/doc/arm/Bv9ARM-book.xml index e77fac8a19..39224a312c 100644 --- a/doc/arm/Bv9ARM-book.xml +++ b/doc/arm/Bv9ARM-book.xml @@ -2,7 +2,7 @@ - + @@ -639,7 +639,9 @@ of a server. -c config -s server -p port + -v view -y key + -z zone command command @@ -665,11 +667,15 @@ of a server. Dump database and cache to /var/tmp/named_dump.db. +refresh +Forced refresh of specified zone. + + reload Reload configuration file and zones. -stats +stats Dump statistics to /var/tmp/named.stats. @@ -700,8 +706,8 @@ of a server. - As noted above, reload is the - only command available for BIND 9.0.0. The other + As noted above, only a limited number of commands are + available for BIND 9.0.0. The other commands, and more, are planned to be implemented for future releases. @@ -2432,6 +2438,7 @@ lookups performed on behalf of clients by a caching name server. memstatistics-file path_name; pid-file path_name; statistics-file path_name; + statistics yes_or_no; auth-nxdomain yes_or_no; deallocate-on-exit yes_or_no; dialup dialup_option; @@ -2581,11 +2588,8 @@ nameserver. statistics-file The pathname of the file the server appends statistics -to. If not specified, the default is named.stats. - Not -yet implemented in BIND 9. +to. If not specified, the default is named.stats. - port @@ -2749,6 +2753,13 @@ answers. The default is no. BIND 9 always allocates query IDs from a pool. +statistics +If yes, the server will, by default, collect +statistical data on all zones in the server. These statistics may be accessed +using the rndc which will dump them to the file listed +in the statistics-file option listed above. + + treat-cr-as-space This option was used in BIND 8 to make the server treat carriage return ("\r") characters the same way @@ -3500,6 +3511,7 @@ key data. view view_name class { match-clients { address_match_list } ; view_option; ... + statistics yes_or_no ; zone_statement; ... }; @@ -3590,6 +3602,7 @@ Statement Grammar pubkey number number number string ; transfer-source (ip4_addr | *) port ip_port ; transfer-source-v6 (ip6_addr | *) port ip_port ; + statistics yes_or_no ; sig-validity-interval number ; database string ; }; @@ -3818,6 +3831,12 @@ zones when they are loaded from disk. BIND 9 does not verify on loading and ignores the option. +statistics +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. + + sig-validity-interval See the description of sig-validity-interval under . @@ -5478,6 +5497,63 @@ after which they are deleted unless updated by their authors. + + Format of statistics file +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. +The statistics dump begins with the line +++ Statistics Dump ++++ (973798949), 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 --- Statistics Dump --- (973798949), where the +number is identical to the number in the beginning line. +The following counters are defined: + + + + + +success +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. + + +delegation +This counter is used to track the number +of queries which return delegations instead a final answer. + + +nxrrset +This counter is used to track the number +of queries made which return a result code of NXRRSET. + + +nxdoimain +This counter is used to track the number +of queries made which return a result code of NXDOMAIN. + + +recursion +This counter is used to track the number +of queries made which resulted in recursion in order to find the final +answer. + +failure +This counter is used to track the number +of queries resulted in a SERVFAIL reply. + + + + diff --git a/doc/arm/Bv9ARM.ch01.html b/doc/arm/Bv9ARM.ch01.html index 61850297d6..071c920d8b 100644 --- a/doc/arm/Bv9ARM.ch01.html +++ b/doc/arm/Bv9ARM.ch01.html @@ -601,17 +601,20 @@ CLASS="systemitem" >where com is the top level domain to which is the top level domain to which +ourhost.example.com belongs, belongs, +example is a subdomain of com, and , and +ourhost 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/ or via the Web at +or via the Web at http://www.ietf.org/rfc/. (See Appendix C for complete information on finding and retrieving -RFCs.) It is also recommended that you read the related man pages: named and domain which includes names such as host.aaa.example.com and host.aaa.example.com +and host.bbb.example.com even though the example.com zone includes only delegations -for the +zone includes only delegations for the +aaa.example.com and +and bbb.example.com zones. diff --git a/doc/arm/Bv9ARM.ch03.html b/doc/arm/Bv9ARM.ch03.html index 2a13168896..74e4c689ec 100644 --- a/doc/arm/Bv9ARM.ch03.html +++ b/doc/arm/Bv9ARM.ch03.html @@ -428,12 +428,14 @@ CLASS="command" options statement, see statement, see + RRset Ordering. This substatement is not supported in +>. + This substatement is not supported in BINDport] [-v view] [-y key] [-z zone] refresh

Forced refresh of specified zone.

reload

stats[a]

As noted above, reload is the - only command available for As noted above, only a limited number of commands are + available for BIND 9.0.0. The other @@ -1216,7 +1243,7 @@ CLASS="sect2" >

3.4.2. Signals

4.3. Split DNS
4.5. TKEY
4.6. SIG(0)
4.8. IPv6 Support in BIND

4.3. Split DNS

site2.internal.

To protect theTo protect the site1.internal and site1.internal and site2.internal domains, @@ -445,8 +439,8 @@ CLASS="systemitem" > and site2.example.com zones.

site2.example.com zones.

  • 4.4.1. Generate Shared Keys for Each Pair of Hosts

    4.4.1.1. Automatic Generation

    4.4.1.2. Manual Generation

    4.4.2. Copying the Shared Secret to Both Machines

    4.4.3. Informing the Servers of the Key's Existence

    4.4.4. Instructing the Server to Use the Key

    4.4.5. TSIG Key Based Access Control

    4.4.6. Errors

    4.5. TKEY

    4.6. SIG(0)

    4.7.1. Generating Keys

    statements, including the .key files.

    .key     files.

    4.7.2. Creating a Keyset

    4.7.3. Signing the Child's Keyset

    4.7.4. Signing the Zone

    4.7.5. Configuring Servers

    4.8. IPv6 Support in BIND

    4.8.1. Address Lookups Using AAAA Records

    4.8.2. Address Lookups Using A6 Records

    4.8.2.1. A6 Chains

    4.8.2.2. A6 Records for DNS Servers

    4.8.3. Address to Name Lookups Using Nibble Format

    4.8.4. Address to Name Lookups Using Bitstring Format

    4.8.5. Using DNAME for Delegation of IPv6 Reverse Addresses

    • 5.1. The Lightweight Resolver Library

    5.1. The Lightweight Resolver Library

    6.3. Zone File

    6.1.1.1. Syntax

    6.1.1.2. Definition and Usage
    6.1.2. Comment Syntax
    6.1.2.1. Syntax
    6.1.2.2. Definition and Usage
    6.2.1. acl
    6.2.3. controls
    6.2.4. controls
    6.2.5. include
    6.2.6. include
    6.2.7. key
    6.2.8. key
    6.2.9. logging
    6.2.10. logging
    6.2.10.1. The channel
    6.2.11. lwres
    6.2.12. lwres
    6.2.13. options]
     [ statistics yes_or_no; ]
+    [ auth-nxdomain 
    6.2.14. optionsnamed.stats.
    Note: Not
-yet implemented in BIND 9.
    statistics
    If yes, the server will, by default, collect
+statistical data on all zones in the server.  These statistics may be accessed
+using the rndc which will dump them to the file listed
+in the statistics-file option listed above.
    treat-cr-as-space
    BIND 8 to make
-the server treat "\r" characters the same way
-as <space> " " or "\t",
+>") characters the same way
+as a space or tab character,
 to facilitate loading of zone files on a UNIX system that were generated
 on an NT or DOS machine. In 
-
    Note: These options are not yet implemented in BIND 9.0.
    
 
    6.2.14.2. Forwarding
    6.2.14.5. Interfaces
    6.2.14.6. Query Address
    6.2.14.8. Resource Limits
    default.
    Note: Not yet implemented in BIND
-9.
    default.
    Note: Not
-yet implemented in BIND 9.
    unlimited.
 
    Note: on some operating systems the server cannot set an unlimited
-value and cannot determine the maximum number of open files the
-kernel can support. On such systems, choosing 
-unlimited will
-cause the server to use the larger of the rlim_max for RLIMIT_NOFILE and
-the value returned by sysconf(_SC_OPEN_MAX).
-If the actual kernel limit is larger than this value, use limit
-files to specify the limit explicitly.
    Note: Not yet
-implemented in BIND 9.
    default.
    Note: Not
-yet implemented in BIND 9.
    6.2.14.9. Periodic Task Intervals
    6.2.14.14. Deprecated Features
    6.2.17. trusted-keys
    6.2.18. trusted-keys
    6.2.19. view]
       [ statistics yes_or_no ; ]
+      [ 
    6.2.20. view]
     [ statistics yes_or_no ; ]
+    [ sig-validity-interval number ; ]
+    [ database string ; ]
 }];
@@ -7555,7 +7497,7 @@ CLASS="sect2"
 >
    6.2.22. zone
    6.2.22.1. Zone Types
    6.2.22.2. Class
    6.2.22.3. Zone Options
    database
    The first string represents the
+type of database used to store the zone data in the server.  The default value
+is rbt, a red-black tree.  The other defined value is rbt64, a variant of rbt
+that allows 2^64 updates.  Additional databases may be implemented later or
+included.  Strings after the first string are optional arguments to
+the database driver initialization routine.  There are none defined for
+rbt or rbt64.
+
    dialup
    statistics
    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.
    sig-validity-interval
    6.3. Zone File
    6.3.1.1. Resource Records
    6.3.1.2. Textual expression of RRs
    6.3.2. Discussion of MX Records
    6.3.4. Inverse Mapping in IPv4
    6.3.5. Other Zone File Directives
    6.3.5.1. The $ORIGIN
    6.3.5.2. The $INCLUDE
    6.3.5.3. The $TTL
    6.3.6. BIND
    7.2. chroot
    7.3. Dynamic Updates
    7.2. chroot
    7.2.1. The chroot
    7.2.2. Using the setuid
    7.3. Dynamic Updates
    For these reasons, we strongly recommend that updates be
-cryptographically authenticated by means transaction signatures (TSIG).
-That is, the allow-update option should list only
-TSIG key names, not IP addresses. Alternatively, the new 
- option should
+list only TSIG key names, not IP addresses or network
+prefixes. Alternatively, the new update-policy option can be used.
    
+option can be used.
    Some sites choose to keep all dynamically updated DNS data
 in a subdomain and delegate that subdomain to a separate zone. This
diff --git a/doc/arm/Bv9ARM.ch08.html b/doc/arm/Bv9ARM.ch08.html
index 584b57c5ac..b9819f87fb 100644
--- a/doc/arm/Bv9ARM.ch08.html
+++ b/doc/arm/Bv9ARM.ch08.html
@@ -75,17 +75,17 @@ CLASS="TOC"
 >
    8.1. Common Problems
    8.2. Incrementing and Changing the Serial Number
    8.3. Where Can I Get Help?
    8.1. Common Problems
    8.1.1. It's not working; how can I figure out what's wrong?
    8.2. Incrementing and Changing the Serial Number
    8.3. Where Can I Get Help?
    To discuss arrangements for support, contact
     info@isc.org or visit the
diff --git a/doc/arm/Bv9ARM.ch09.html b/doc/arm/Bv9ARM.ch09.html
index b26610c286..667a9516be 100644
--- a/doc/arm/Bv9ARM.ch09.html
+++ b/doc/arm/Bv9ARM.ch09.html
@@ -69,7 +69,7 @@ CLASS="TOC"
 >
    A.1. Acknowledgements
    A.3. General DNSBibliography (and Suggested Reading)
    A.5. Format of statistics file
    A.1. Acknowledgements
    A.1.1. A Brief History of the DNS
    A.2.1.1. HS = hesiod
    A.2.1.2. CH = chaos
    A.3. General DNS
    A.3.1. IPv6 addresses (A6)
    .
    Bibliography
    Standards
    [RFC974] C. Partridge, 
    [RFC1034] P.V. Mockapetris, 
    [RFC1035] P. V. Mockapetris, 
    [RFC2181] R., R. Bush Elz, 
    [RFC2308] M. Andrews, 
    [RFC1995] M. Ohta, 
    [RFC1996] P. Vixie, 
    [RFC2136] P. Vixie, S. Thomson, Y. Rekhter, and J. Bound, 
    [RFC2845] P. Vixie, O. Gudmundsson, D. Eastlake, 3rd, and B. Wellington, 
    Proposed Standards Still Under Development
    [RFC1886] S. Thomson and C. Huitema, 
    [RFC2065] D. Eastlake, 3rd and C. Kaufman, 
    [RFC2137] D. Eastlake, 3rd, 
    Other Important RFCs About DNS
    [RFC1535] E. Gavron, 
    [RFC1536] A. Kumar, J. Postel, C. Neuman, P. Danzig, and S. Miller, 
    [RFC1982] R. Elz and R. Bush, 
    Resource Record Types
    [RFC1183] C.F. Everhart, L. A. Mamakos, R. Ullmann, and P. Mockapetris, 
    [RFC1706] B. Manning and R. Colella, 
    [RFC2168] R. Daniel and M. Mealling, 
    [RFC1876] C. Davis, P. Vixie, T., and I. Dickinson, 
    [RFC2052] A. Gulbrandsen and P. Vixie, 
    [RFC2163] A. Allocchio, 
    [RFC2230] R. Atkinson, 
    DNS
    [RFC1101] P. V. Mockapetris, 
    [RFC1123] Braden, 
    [RFC1591] J. Postel, 
    [RFC2317] H. Eidnes, G. de Groot, and P. Vixie, 
    DNS
    [RFC1537] P. Beertema, 
    [RFC1912] D. Barr, 
    [RFC1912] D. Barr, 
    [RFC2010] B. Manning and P. Vixie, 
    [RFC2219] M. Hamilton and R. Wright, 
    Other DNS
    [RFC1464] R. Rosenbaum, 
    [RFC1713] A. Romao, 
    [RFC1794] T. Brisco, 
    [RFC2240] O. Vaughan, 
    [RFC2345] J. Klensin, T. Wolf, and G. Oglesby, 
    [RFC2352] O. Vaughan, 
    Obsolete and Unimplemented Experimental RRs
    [RFC1712] C. Farrell, M. Schulze, S. Pleitner, and D. Baldoni, 
    A.4.3. Other Documents About BIND
    Bibliography
    Paul Albitz and Cricket Liu, 
    A.5. Format of statistics file
    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.
    The statistics dump begins with the line +++ Statistics Dump
++++ (973798949), 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 --- Statistics Dump --- (973798949), where the
+number is identical to the number in the beginning line.
    The following counters are defined:
    success
    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.
    delegation
    This counter is used to track the number
+of queries which return delegations instead a final answer.
    nxrrset
    This counter is used to track the number
+of queries made which return a result code of NXRRSET.
    nxdoimain
    This counter is used to track the number
+of queries made which return a result code of NXDOMAIN.
    recursion
    This counter is used to track the number
+of queries made which resulted in recursion in order to find the final
+answer.
    failure
    This counter is used to track the number
+of queries resulted in a SERVFAIL reply.
    3.4.2. Signals
    4.3. Split DNS
    4.4.1. Generate Shared Keys for Each Pair of Hosts
    4.4.2. Copying the Shared Secret to Both Machines
    4.4.3. Informing the Servers of the Key's Existence
    4.4.4. Instructing the Server to Use the Key
    4.4.5. TSIG Key Based Access Control
    4.4.6. Errors
    4.5. TKEY
    4.6. SIG(0)
    4.7.1. Generating Keys
    4.7.2. Creating a Keyset
    4.7.3. Signing the Child's Keyset
    4.7.4. Signing the Zone
    4.7.5. Configuring Servers
    4.8. IPv6 Support in BIND
    4.8.1. Address Lookups Using AAAA Records
    4.8.2. Address Lookups Using A6 Records
    4.8.3. Address to Name Lookups Using Nibble Format
    4.8.4. Address to Name Lookups Using Bitstring Format
    4.8.5. Using DNAME for Delegation of IPv6 Reverse Addresses
    5.1. The Lightweight Resolver Library
    6.1.2. Comment Syntax
    6.2.1. acl
    6.2.3. controls
    6.2.4. controls
    6.2.5. include
    6.2.6. include
    6.2.7. key
    6.2.8. key
    6.2.9. logging
    6.2.10. logging
    6.2.11. lwres
    6.2.12. lwres
    6.2.13. options
    6.2.14. options
    6.2.17. trusted-keys
    6.2.18. trusted-keys
    6.2.19. view
    6.2.20. view
    6.2.22. zone
    6.3. Zone File
    6.3.2. Discussion of MX Records
    6.3.4. Inverse Mapping in IPv4
    6.3.5. Other Zone File Directives
    6.3.6. BIND
    7.2. chroot
    7.2.1. The chroot
    7.2.2. Using the setuid
    7.3. Dynamic Updates
    8.1. Common Problems
    8.1.1. It's not working; how can I figure out what's wrong?
    8.2. Incrementing and Changing the Serial Number
    8.3. Where Can I Get Help?
    A.1. Acknowledgements
    A.1.1. A Brief History of the DNS
    A.3. General DNS
    A.3.1. IPv6 addresses (A6)
    A.4.3. Other Documents About BIND
    A.5. Format of statistics file