contrib/bind9/bin/check/named-checkzone.html

   1 <!--
   2  - Copyright (C) 2004-2007 Internet Systems Consortium, Inc. ("ISC")
   3  - Copyright (C) 2000-2002 Internet Software Consortium.
   4  -
   5  - Permission to use, copy, modify, and distribute this software for any
   6  - purpose with or without fee is hereby granted, provided that the above
   7  - copyright notice and this permission notice appear in all copies.
   8  -
   9  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11  - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15  - PERFORMANCE OF THIS SOFTWARE.
  16 -->
  17 <!-- $Id: named-checkzone.html,v 1.11.18.30 2007/06/20 02:26:58 marka Exp $ -->
  18 <html>
  19 <head>
  20 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  21 <title>named-checkzone</title>
  22 <meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
  23 </head>
  24 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
  25 <a name="man.named-checkzone"></a><div class="titlepage"></div>
  26 <div class="refnamediv">
  27 <h2>Name</h2>
  28 <p><span class="application">named-checkzone</span>, <span class="application">named-compilezone</span> &#8212; zone file validity checking or converting tool</p>
  29 </div>
  30 <div class="refsynopsisdiv">
  31 <h2>Synopsis</h2>
  32 <div class="cmdsynopsis"><p><code class="command">named-checkzone</code>  [<code class="option">-d</code>] [<code class="option">-j</code>] [<code class="option">-q</code>] [<code class="option">-v</code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-f <em class="replaceable"><code>format</code></em></code>] [<code class="option">-F <em class="replaceable"><code>format</code></em></code>] [<code class="option">-i <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-k <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-m <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-M <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-n <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-o <em class="replaceable"><code>filename</code></em></code>] [<code class="option">-s <em class="replaceable"><code>style</code></em></code>] [<code class="option">-S <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-t <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-w <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-D</code>] [<code class="option">-W <em class="replaceable"><code>mode</code></em></code>] {zonename} {filename}</p></div>
  33 <div class="cmdsynopsis"><p><code class="command">named-compilezone</code>  [<code class="option">-d</code>] [<code class="option">-j</code>] [<code class="option">-q</code>] [<code class="option">-v</code>] [<code class="option">-c <em class="replaceable"><code>class</code></em></code>] [<code class="option">-C <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-f <em class="replaceable"><code>format</code></em></code>] [<code class="option">-F <em class="replaceable"><code>format</code></em></code>] [<code class="option">-i <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-k <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-m <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-n <em class="replaceable"><code>mode</code></em></code>] [<code class="option">-o <em class="replaceable"><code>filename</code></em></code>] [<code class="option">-s <em class="replaceable"><code>style</code></em></code>] [<code class="option">-t <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-w <em class="replaceable"><code>directory</code></em></code>] [<code class="option">-D</code>] [<code class="option">-W <em class="replaceable"><code>mode</code></em></code>] {zonename} {filename}</p></div>
  34 </div>
  35 <div class="refsect1" lang="en">
  36 <a name="id2543665"></a><h2>DESCRIPTION</h2>
  37 <p><span><strong class="command">named-checkzone</strong></span>
  38       checks the syntax and integrity of a zone file.  It performs the
  39       same checks as <span><strong class="command">named</strong></span> does when loading a
  40       zone.  This makes <span><strong class="command">named-checkzone</strong></span> useful for
  41       checking zone files before configuring them into a name server.
  42     </p>
  43 <p>
  44         <span><strong class="command">named-compilezone</strong></span> is similar to
  45         <span><strong class="command">named-checkzone</strong></span>, but it always dumps the
  46         zone contents to a specified file in a specified format.
  47         Additionally, it applies stricter check levels by default,
  48         since the dump output will be used as an actual zone file
  49         loaded by <span><strong class="command">named</strong></span>.
  50         When manually specified otherwise, the check levels must at
  51         least be as strict as those specified in the
  52         <span><strong class="command">named</strong></span> configuration file.
  53      </p>
  54 </div>
  55 <div class="refsect1" lang="en">
  56 <a name="id2543700"></a><h2>OPTIONS</h2>
  57 <div class="variablelist"><dl>
  58 <dt><span class="term">-d</span></dt>
  59 <dd><p>
  60             Enable debugging.
  61           </p></dd>
  62 <dt><span class="term">-q</span></dt>
  63 <dd><p>
  64             Quiet mode - exit code only.
  65           </p></dd>
  66 <dt><span class="term">-v</span></dt>
  67 <dd><p>
  68             Print the version of the <span><strong class="command">named-checkzone</strong></span>
  69             program and exit.
  70           </p></dd>
  71 <dt><span class="term">-j</span></dt>
  72 <dd><p>
  73             When loading the zone file read the journal if it exists.
  74           </p></dd>
  75 <dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
  76 <dd><p>
  77             Specify the class of the zone.  If not specified "IN" is assumed.
  78           </p></dd>
  79 <dt><span class="term">-i <em class="replaceable"><code>mode</code></em></span></dt>
  80 <dd>
  81 <p>
  82               Perform post-load zone integrity checks.  Possible modes are
  83               <span><strong class="command">"full"</strong></span> (default),
  84               <span><strong class="command">"full-sibling"</strong></span>,
  85               <span><strong class="command">"local"</strong></span>,
  86               <span><strong class="command">"local-sibling"</strong></span> and
  87               <span><strong class="command">"none"</strong></span>.
  88           </p>
  89 <p>
  90               Mode <span><strong class="command">"full"</strong></span> checks that MX records
  91               refer to A or AAAA record (both in-zone and out-of-zone
  92               hostnames).  Mode <span><strong class="command">"local"</strong></span> only
  93               checks MX records which refer to in-zone hostnames.
  94           </p>
  95 <p>
  96               Mode <span><strong class="command">"full"</strong></span> checks that SRV records
  97               refer to A or AAAA record (both in-zone and out-of-zone
  98               hostnames).  Mode <span><strong class="command">"local"</strong></span> only
  99               checks SRV records which refer to in-zone hostnames.
 100           </p>
 101 <p>
 102               Mode <span><strong class="command">"full"</strong></span> checks that delegation NS
 103               records refer to A or AAAA record (both in-zone and out-of-zone
 104               hostnames).  It also checks that glue address records
 105               in the zone match those advertised by the child.
 106               Mode <span><strong class="command">"local"</strong></span> only checks NS records which
 107               refer to in-zone hostnames or that some required glue exists,
 108               that is when the nameserver is in a child zone.
 109           </p>
 110 <p>
 111               Mode <span><strong class="command">"full-sibling"</strong></span> and
 112               <span><strong class="command">"local-sibling"</strong></span> disable sibling glue
 113               checks but are otherwise the same as <span><strong class="command">"full"</strong></span>
 114               and <span><strong class="command">"local"</strong></span> respectively.
 115           </p>
 116 <p>
 117               Mode <span><strong class="command">"none"</strong></span> disables the checks.
 118           </p>
 119 </dd>
 120 <dt><span class="term">-f <em class="replaceable"><code>format</code></em></span></dt>
 121 <dd><p>
 122             Specify the format of the zone file.
 123             Possible formats are <span><strong class="command">"text"</strong></span> (default)
 124             and <span><strong class="command">"raw"</strong></span>.
 125           </p></dd>
 126 <dt><span class="term">-F <em class="replaceable"><code>format</code></em></span></dt>
 127 <dd><p>
 128             Specify the format of the output file specified.
 129             Possible formats are <span><strong class="command">"text"</strong></span> (default)
 130             and <span><strong class="command">"raw"</strong></span>.
 131             For <span><strong class="command">named-checkzone</strong></span>,
 132             this does not cause any effects unless it dumps the zone
 133             contents.
 134           </p></dd>
 135 <dt><span class="term">-k <em class="replaceable"><code>mode</code></em></span></dt>
 136 <dd><p>
 137             Perform <span><strong class="command">"check-names"</strong></span> checks with the
 138             specified failure mode.
 139             Possible modes are <span><strong class="command">"fail"</strong></span>
 140             (default for <span><strong class="command">named-compilezone</strong></span>),
 141             <span><strong class="command">"warn"</strong></span>
 142             (default for <span><strong class="command">named-checkzone</strong></span>) and
 143             <span><strong class="command">"ignore"</strong></span>.
 144           </p></dd>
 145 <dt><span class="term">-m <em class="replaceable"><code>mode</code></em></span></dt>
 146 <dd><p>
 147             Specify whether MX records should be checked to see if they
 148             are addresses.  Possible modes are <span><strong class="command">"fail"</strong></span>,
 149             <span><strong class="command">"warn"</strong></span> (default) and
 150             <span><strong class="command">"ignore"</strong></span>.
 151           </p></dd>
 152 <dt><span class="term">-M <em class="replaceable"><code>mode</code></em></span></dt>
 153 <dd><p>
 154             Check if a MX record refers to a CNAME.
 155             Possible modes are <span><strong class="command">"fail"</strong></span>,
 156             <span><strong class="command">"warn"</strong></span> (default) and
 157             <span><strong class="command">"ignore"</strong></span>.
 158           </p></dd>
 159 <dt><span class="term">-n <em class="replaceable"><code>mode</code></em></span></dt>
 160 <dd><p>
 161             Specify whether NS records should be checked to see if they
 162             are addresses.
 163             Possible modes are <span><strong class="command">"fail"</strong></span>
 164             (default for <span><strong class="command">named-compilezone</strong></span>),
 165             <span><strong class="command">"warn"</strong></span>
 166             (default for <span><strong class="command">named-checkzone</strong></span>) and
 167             <span><strong class="command">"ignore"</strong></span>.
 168           </p></dd>
 169 <dt><span class="term">-o <em class="replaceable"><code>filename</code></em></span></dt>
 170 <dd><p>
 171             Write zone output to <code class="filename">filename</code>.
 172             This is mandatory for <span><strong class="command">named-compilezone</strong></span>.
 173           </p></dd>
 174 <dt><span class="term">-s <em class="replaceable"><code>style</code></em></span></dt>
 175 <dd><p>
 176             Specify the style of the dumped zone file.
 177             Possible styles are <span><strong class="command">"full"</strong></span> (default)
 178             and <span><strong class="command">"relative"</strong></span>.
 179             The full format is most suitable for processing
 180             automatically by a separate script.
 181             On the other hand, the relative format is more
 182             human-readable and is thus suitable for editing by hand.
 183             For <span><strong class="command">named-checkzone</strong></span>
 184             this does not cause any effects unless it dumps the zone
 185             contents.
 186             It also does not have any meaning if the output format
 187             is not text.
 188           </p></dd>
 189 <dt><span class="term">-S <em class="replaceable"><code>mode</code></em></span></dt>
 190 <dd><p>
 191             Check if a SRV record refers to a CNAME.
 192             Possible modes are <span><strong class="command">"fail"</strong></span>,
 193             <span><strong class="command">"warn"</strong></span> (default) and
 194             <span><strong class="command">"ignore"</strong></span>.
 195           </p></dd>
 196 <dt><span class="term">-t <em class="replaceable"><code>directory</code></em></span></dt>
 197 <dd><p>
 198             Chroot to <code class="filename">directory</code> so that
 199             include
 200             directives in the configuration file are processed as if
 201             run by a similarly chrooted named.
 202           </p></dd>
 203 <dt><span class="term">-w <em class="replaceable"><code>directory</code></em></span></dt>
 204 <dd><p>
 205             chdir to <code class="filename">directory</code> so that
 206             relative
 207             filenames in master file $INCLUDE directives work.  This
 208             is similar to the directory clause in
 209             <code class="filename">named.conf</code>.
 210           </p></dd>
 211 <dt><span class="term">-D</span></dt>
 212 <dd><p>
 213             Dump zone file in canonical format.
 214             This is always enabled for <span><strong class="command">named-compilezone</strong></span>.
 215           </p></dd>
 216 <dt><span class="term">-W <em class="replaceable"><code>mode</code></em></span></dt>
 217 <dd><p>
 218             Specify whether to check for non-terminal wildcards.
 219             Non-terminal wildcards are almost always the result of a
 220             failure to understand the wildcard matching algorithm (RFC 1034).
 221             Possible modes are <span><strong class="command">"warn"</strong></span> (default)
 222             and
 223             <span><strong class="command">"ignore"</strong></span>.
 224           </p></dd>
 225 <dt><span class="term">zonename</span></dt>
 226 <dd><p>
 227             The domain name of the zone being checked.
 228           </p></dd>
 229 <dt><span class="term">filename</span></dt>
 230 <dd><p>
 231             The name of the zone file.
 232           </p></dd>
 233 </dl></div>
 234 </div>
 235 <div class="refsect1" lang="en">
 236 <a name="id2544299"></a><h2>RETURN VALUES</h2>
 237 <p><span><strong class="command">named-checkzone</strong></span>
 238       returns an exit status of 1 if
 239       errors were detected and 0 otherwise.
 240     </p>
 241 </div>
 242 <div class="refsect1" lang="en">
 243 <a name="id2544311"></a><h2>SEE ALSO</h2>
 244 <p><span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
 245       <span class="citerefentry"><span class="refentrytitle">named-checkconf</span>(8)</span>,
 246       <em class="citetitle">RFC 1035</em>,
 247       <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
 248     </p>
 249 </div>
 250 <div class="refsect1" lang="en">
 251 <a name="id2544344"></a><h2>AUTHOR</h2>
 252 <p><span class="corpauthor">Internet Systems Consortium</span>
 253     </p>
 254 </div>
 255 </div></body>
 256 </html>