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

   1 <!--
   2  - Copyright (C) 2004-2007, 2009-2011, 2013 Internet Systems Consortium, Inc. ("ISC")
   3  - Copyright (C) 2000-2002 Internet Software Consortium.
   4  -
   5  - Permission to use, copy, modify, and/or 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$ -->
  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">-h</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">-L <em class="replaceable"><code>serial</code></em></code>] [<code class="option">-o <em class="replaceable"><code>filename</code></em></code>] [<code class="option">-r <em class="replaceable"><code>mode</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">-T <em class="replaceable"><code>mode</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">-L <em class="replaceable"><code>serial</code></em></code>] [<code class="option">-r <em class="replaceable"><code>mode</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">-T <em class="replaceable"><code>mode</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>] {<code class="option">-o <em class="replaceable"><code>filename</code></em></code>} {zonename} {filename}</p></div>
  34 </div>
  35 <div class="refsect1" lang="en">
  36 <a name="id2543736"></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="id2543771"></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">-h</span></dt>
  63 <dd><p>
  64             Print the usage summary and exit.
  65           </p></dd>
  66 <dt><span class="term">-q</span></dt>
  67 <dd><p>
  68             Quiet mode - exit code only.
  69           </p></dd>
  70 <dt><span class="term">-v</span></dt>
  71 <dd><p>
  72             Print the version of the <span><strong class="command">named-checkzone</strong></span>
  73             program and exit.
  74           </p></dd>
  75 <dt><span class="term">-j</span></dt>
  76 <dd><p>
  77             When loading the zone file read the journal if it exists.
  78           </p></dd>
  79 <dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
  80 <dd><p>
  81             Specify the class of the zone.  If not specified, "IN" is assumed.
  82           </p></dd>
  83 <dt><span class="term">-i <em class="replaceable"><code>mode</code></em></span></dt>
  84 <dd>
  85 <p>
  86               Perform post-load zone integrity checks.  Possible modes are
  87               <span><strong class="command">"full"</strong></span> (default),
  88               <span><strong class="command">"full-sibling"</strong></span>,
  89               <span><strong class="command">"local"</strong></span>,
  90               <span><strong class="command">"local-sibling"</strong></span> and
  91               <span><strong class="command">"none"</strong></span>.
  92           </p>
  93 <p>
  94               Mode <span><strong class="command">"full"</strong></span> checks that MX records
  95               refer to A or AAAA record (both in-zone and out-of-zone
  96               hostnames).  Mode <span><strong class="command">"local"</strong></span> only
  97               checks MX records which refer to in-zone hostnames.
  98           </p>
  99 <p>
 100               Mode <span><strong class="command">"full"</strong></span> checks that SRV records
 101               refer to A or AAAA record (both in-zone and out-of-zone
 102               hostnames).  Mode <span><strong class="command">"local"</strong></span> only
 103               checks SRV records which refer to in-zone hostnames.
 104           </p>
 105 <p>
 106               Mode <span><strong class="command">"full"</strong></span> checks that delegation NS
 107               records refer to A or AAAA record (both in-zone and out-of-zone
 108               hostnames).  It also checks that glue address records
 109               in the zone match those advertised by the child.
 110               Mode <span><strong class="command">"local"</strong></span> only checks NS records which
 111               refer to in-zone hostnames or that some required glue exists,
 112               that is when the nameserver is in a child zone.
 113           </p>
 114 <p>
 115               Mode <span><strong class="command">"full-sibling"</strong></span> and
 116               <span><strong class="command">"local-sibling"</strong></span> disable sibling glue
 117               checks but are otherwise the same as <span><strong class="command">"full"</strong></span>
 118               and <span><strong class="command">"local"</strong></span> respectively.
 119           </p>
 120 <p>
 121               Mode <span><strong class="command">"none"</strong></span> disables the checks.
 122           </p>
 123 </dd>
 124 <dt><span class="term">-f <em class="replaceable"><code>format</code></em></span></dt>
 125 <dd><p>
 126             Specify the format of the zone file.
 127             Possible formats are <span><strong class="command">"text"</strong></span> (default)
 128             and <span><strong class="command">"raw"</strong></span>.
 129           </p></dd>
 130 <dt><span class="term">-F <em class="replaceable"><code>format</code></em></span></dt>
 131 <dd>
 132 <p>
 133             Specify the format of the output file specified.
 134             For <span><strong class="command">named-checkzone</strong></span>,
 135             this does not cause any effects unless it dumps the zone
 136             contents.
 137           </p>
 138 <p>
 139             Possible formats are <span><strong class="command">"text"</strong></span> (default)
 140             and <span><strong class="command">"raw"</strong></span> or <span><strong class="command">"raw=N"</strong></span>,
 141             which store the zone in a binary format for rapid loading
 142             by <span><strong class="command">named</strong></span>.  <span><strong class="command">"raw=N"</strong></span>
 143             specifies the format version of the raw zone file: if N
 144             is 0, the raw file can be read by any version of
 145             <span><strong class="command">named</strong></span>; if N is 1, the file can be read
 146             by release 9.9.0 or higher.  The default is 1.
 147           </p>
 148 </dd>
 149 <dt><span class="term">-k <em class="replaceable"><code>mode</code></em></span></dt>
 150 <dd><p>
 151             Perform <span><strong class="command">"check-names"</strong></span> checks with the
 152             specified failure mode.
 153             Possible modes are <span><strong class="command">"fail"</strong></span>
 154             (default for <span><strong class="command">named-compilezone</strong></span>),
 155             <span><strong class="command">"warn"</strong></span>
 156             (default for <span><strong class="command">named-checkzone</strong></span>) and
 157             <span><strong class="command">"ignore"</strong></span>.
 158           </p></dd>
 159 <dt><span class="term">-L <em class="replaceable"><code>serial</code></em></span></dt>
 160 <dd><p>
 161             When compiling a zone to 'raw' format, set the "source serial"
 162             value in the header to the specified serial number.  (This is
 163             expected to be used primarily for testing purposes.)
 164           </p></dd>
 165 <dt><span class="term">-m <em class="replaceable"><code>mode</code></em></span></dt>
 166 <dd><p>
 167             Specify whether MX records should be checked to see if they
 168             are addresses.  Possible modes are <span><strong class="command">"fail"</strong></span>,
 169             <span><strong class="command">"warn"</strong></span> (default) and
 170             <span><strong class="command">"ignore"</strong></span>.
 171           </p></dd>
 172 <dt><span class="term">-M <em class="replaceable"><code>mode</code></em></span></dt>
 173 <dd><p>
 174             Check if a MX record refers to a CNAME.
 175             Possible modes are <span><strong class="command">"fail"</strong></span>,
 176             <span><strong class="command">"warn"</strong></span> (default) and
 177             <span><strong class="command">"ignore"</strong></span>.
 178           </p></dd>
 179 <dt><span class="term">-n <em class="replaceable"><code>mode</code></em></span></dt>
 180 <dd><p>
 181             Specify whether NS records should be checked to see if they
 182             are addresses.
 183             Possible modes are <span><strong class="command">"fail"</strong></span>
 184             (default for <span><strong class="command">named-compilezone</strong></span>),
 185             <span><strong class="command">"warn"</strong></span>
 186             (default for <span><strong class="command">named-checkzone</strong></span>) and
 187             <span><strong class="command">"ignore"</strong></span>.
 188           </p></dd>
 189 <dt><span class="term">-o <em class="replaceable"><code>filename</code></em></span></dt>
 190 <dd><p>
 191             Write zone output to <code class="filename">filename</code>.
 192             If <code class="filename">filename</code> is <code class="filename">-</code> then
 193             write to standard out.
 194             This is mandatory for <span><strong class="command">named-compilezone</strong></span>.
 195           </p></dd>
 196 <dt><span class="term">-r <em class="replaceable"><code>mode</code></em></span></dt>
 197 <dd><p>
 198             Check for records that are treated as different by DNSSEC but
 199             are semantically equal in plain DNS.
 200             Possible modes are <span><strong class="command">"fail"</strong></span>,
 201             <span><strong class="command">"warn"</strong></span> (default) and
 202             <span><strong class="command">"ignore"</strong></span>.
 203           </p></dd>
 204 <dt><span class="term">-s <em class="replaceable"><code>style</code></em></span></dt>
 205 <dd><p>
 206             Specify the style of the dumped zone file.
 207             Possible styles are <span><strong class="command">"full"</strong></span> (default)
 208             and <span><strong class="command">"relative"</strong></span>.
 209             The full format is most suitable for processing
 210             automatically by a separate script.
 211             On the other hand, the relative format is more
 212             human-readable and is thus suitable for editing by hand.
 213             For <span><strong class="command">named-checkzone</strong></span>
 214             this does not cause any effects unless it dumps the zone
 215             contents.
 216             It also does not have any meaning if the output format
 217             is not text.
 218           </p></dd>
 219 <dt><span class="term">-S <em class="replaceable"><code>mode</code></em></span></dt>
 220 <dd><p>
 221             Check if a SRV record refers to a CNAME.
 222             Possible modes are <span><strong class="command">"fail"</strong></span>,
 223             <span><strong class="command">"warn"</strong></span> (default) and
 224             <span><strong class="command">"ignore"</strong></span>.
 225           </p></dd>
 226 <dt><span class="term">-t <em class="replaceable"><code>directory</code></em></span></dt>
 227 <dd><p>
 228             Chroot to <code class="filename">directory</code> so that
 229             include
 230             directives in the configuration file are processed as if
 231             run by a similarly chrooted named.
 232           </p></dd>
 233 <dt><span class="term">-T <em class="replaceable"><code>mode</code></em></span></dt>
 234 <dd><p>
 235             Check if Sender Policy Framework records (TXT and SPF)
 236             both exist or both don't exist.  A warning is issued
 237             if they don't match.  Possible modes are
 238             <span><strong class="command">"warn"</strong></span> (default), <span><strong class="command">"ignore"</strong></span>.
 239           </p></dd>
 240 <dt><span class="term">-w <em class="replaceable"><code>directory</code></em></span></dt>
 241 <dd><p>
 242             chdir to <code class="filename">directory</code> so that
 243             relative
 244             filenames in master file $INCLUDE directives work.  This
 245             is similar to the directory clause in
 246             <code class="filename">named.conf</code>.
 247           </p></dd>
 248 <dt><span class="term">-D</span></dt>
 249 <dd><p>
 250             Dump zone file in canonical format.
 251             This is always enabled for <span><strong class="command">named-compilezone</strong></span>.
 252           </p></dd>
 253 <dt><span class="term">-W <em class="replaceable"><code>mode</code></em></span></dt>
 254 <dd><p>
 255             Specify whether to check for non-terminal wildcards.
 256             Non-terminal wildcards are almost always the result of a
 257             failure to understand the wildcard matching algorithm (RFC 1034).
 258             Possible modes are <span><strong class="command">"warn"</strong></span> (default)
 259             and
 260             <span><strong class="command">"ignore"</strong></span>.
 261           </p></dd>
 262 <dt><span class="term">zonename</span></dt>
 263 <dd><p>
 264             The domain name of the zone being checked.
 265           </p></dd>
 266 <dt><span class="term">filename</span></dt>
 267 <dd><p>
 268             The name of the zone file.
 269           </p></dd>
 270 </dl></div>
 271 </div>
 272 <div class="refsect1" lang="en">
 273 <a name="id2544612"></a><h2>RETURN VALUES</h2>
 274 <p><span><strong class="command">named-checkzone</strong></span>
 275       returns an exit status of 1 if
 276       errors were detected and 0 otherwise.
 277     </p>
 278 </div>
 279 <div class="refsect1" lang="en">
 280 <a name="id2544624"></a><h2>SEE ALSO</h2>
 281 <p><span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
 282       <span class="citerefentry"><span class="refentrytitle">named-checkconf</span>(8)</span>,
 283       <em class="citetitle">RFC 1035</em>,
 284       <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
 285     </p>
 286 </div>
 287 <div class="refsect1" lang="en">
 288 <a name="id2544657"></a><h2>AUTHOR</h2>
 289 <p><span class="corpauthor">Internet Systems Consortium</span>
 290     </p>
 291 </div>
 292 </div></body>
 293 </html>