contrib/bind9/doc/arm/man.named-checkzone.html

   1 <!--
   2  - Copyright (C) 2004-2008 Internet Systems Consortium, Inc. ("ISC")
   3  - Copyright (C) 2000-2003 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: man.named-checkzone.html,v 1.2.2.70 2008/10/18 01:29:59 tbox 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 <link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
  24 <link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
  25 <link rel="prev" href="man.named-checkconf.html" title="named-checkconf">
  26 <link rel="next" href="man.named.html" title="named">
  27 </head>
  28 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  29 <div class="navheader">
  30 <table width="100%" summary="Navigation header">
  31 <tr><th colspan="3" align="center"><span class="application">named-checkzone</span></th></tr>
  32 <tr>
  33 <td width="20%" align="left">
  34 <a accesskey="p" href="man.named-checkconf.html">Prev</a> </td>
  35 <th width="60%" align="center">Manual pages</th>
  36 <td width="20%" align="right"> <a accesskey="n" href="man.named.html">Next</a>
  37 </td>
  38 </tr>
  39 </table>
  40 <hr>
  41 </div>
  42 <div class="refentry" lang="en">
  43 <a name="man.named-checkzone"></a><div class="titlepage"></div>
  44 <div class="refnamediv">
  45 <h2>Name</h2>
  46 <p><span class="application">named-checkzone</span>, <span class="application">named-compilezone</span> &#8212; zone file validity checking or converting tool</p>
  47 </div>
  48 <div class="refsynopsisdiv">
  49 <h2>Synopsis</h2>
  50 <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>
  51 <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>
  52 </div>
  53 <div class="refsect1" lang="en">
  54 <a name="id2601603"></a><h2>DESCRIPTION</h2>
  55 <p><span><strong class="command">named-checkzone</strong></span>
  56       checks the syntax and integrity of a zone file.  It performs the
  57       same checks as <span><strong class="command">named</strong></span> does when loading a
  58       zone.  This makes <span><strong class="command">named-checkzone</strong></span> useful for
  59       checking zone files before configuring them into a name server.
  60     </p>
  61 <p>
  62         <span><strong class="command">named-compilezone</strong></span> is similar to
  63         <span><strong class="command">named-checkzone</strong></span>, but it always dumps the
  64         zone contents to a specified file in a specified format.
  65         Additionally, it applies stricter check levels by default,
  66         since the dump output will be used as an actual zone file
  67         loaded by <span><strong class="command">named</strong></span>.
  68         When manually specified otherwise, the check levels must at
  69         least be as strict as those specified in the
  70         <span><strong class="command">named</strong></span> configuration file.
  71      </p>
  72 </div>
  73 <div class="refsect1" lang="en">
  74 <a name="id2601653"></a><h2>OPTIONS</h2>
  75 <div class="variablelist"><dl>
  76 <dt><span class="term">-d</span></dt>
  77 <dd><p>
  78             Enable debugging.
  79           </p></dd>
  80 <dt><span class="term">-q</span></dt>
  81 <dd><p>
  82             Quiet mode - exit code only.
  83           </p></dd>
  84 <dt><span class="term">-v</span></dt>
  85 <dd><p>
  86             Print the version of the <span><strong class="command">named-checkzone</strong></span>
  87             program and exit.
  88           </p></dd>
  89 <dt><span class="term">-j</span></dt>
  90 <dd><p>
  91             When loading the zone file read the journal if it exists.
  92           </p></dd>
  93 <dt><span class="term">-c <em class="replaceable"><code>class</code></em></span></dt>
  94 <dd><p>
  95             Specify the class of the zone.  If not specified "IN" is assumed.
  96           </p></dd>
  97 <dt><span class="term">-i <em class="replaceable"><code>mode</code></em></span></dt>
  98 <dd>
  99 <p>
 100               Perform post-load zone integrity checks.  Possible modes are
 101               <span><strong class="command">"full"</strong></span> (default),
 102               <span><strong class="command">"full-sibling"</strong></span>,
 103               <span><strong class="command">"local"</strong></span>,
 104               <span><strong class="command">"local-sibling"</strong></span> and
 105               <span><strong class="command">"none"</strong></span>.
 106           </p>
 107 <p>
 108               Mode <span><strong class="command">"full"</strong></span> checks that MX records
 109               refer to A or AAAA record (both in-zone and out-of-zone
 110               hostnames).  Mode <span><strong class="command">"local"</strong></span> only
 111               checks MX records which refer to in-zone hostnames.
 112           </p>
 113 <p>
 114               Mode <span><strong class="command">"full"</strong></span> checks that SRV records
 115               refer to A or AAAA record (both in-zone and out-of-zone
 116               hostnames).  Mode <span><strong class="command">"local"</strong></span> only
 117               checks SRV records which refer to in-zone hostnames.
 118           </p>
 119 <p>
 120               Mode <span><strong class="command">"full"</strong></span> checks that delegation NS
 121               records refer to A or AAAA record (both in-zone and out-of-zone
 122               hostnames).  It also checks that glue address records
 123               in the zone match those advertised by the child.
 124               Mode <span><strong class="command">"local"</strong></span> only checks NS records which
 125               refer to in-zone hostnames or that some required glue exists,
 126               that is when the nameserver is in a child zone.
 127           </p>
 128 <p>
 129               Mode <span><strong class="command">"full-sibling"</strong></span> and
 130               <span><strong class="command">"local-sibling"</strong></span> disable sibling glue
 131               checks but are otherwise the same as <span><strong class="command">"full"</strong></span>
 132               and <span><strong class="command">"local"</strong></span> respectively.
 133           </p>
 134 <p>
 135               Mode <span><strong class="command">"none"</strong></span> disables the checks.
 136           </p>
 137 </dd>
 138 <dt><span class="term">-f <em class="replaceable"><code>format</code></em></span></dt>
 139 <dd><p>
 140             Specify the format of the zone file.
 141             Possible formats are <span><strong class="command">"text"</strong></span> (default)
 142             and <span><strong class="command">"raw"</strong></span>.
 143           </p></dd>
 144 <dt><span class="term">-F <em class="replaceable"><code>format</code></em></span></dt>
 145 <dd><p>
 146             Specify the format of the output file specified.
 147             Possible formats are <span><strong class="command">"text"</strong></span> (default)
 148             and <span><strong class="command">"raw"</strong></span>.
 149             For <span><strong class="command">named-checkzone</strong></span>,
 150             this does not cause any effects unless it dumps the zone
 151             contents.
 152           </p></dd>
 153 <dt><span class="term">-k <em class="replaceable"><code>mode</code></em></span></dt>
 154 <dd><p>
 155             Perform <span><strong class="command">"check-names"</strong></span> checks with the
 156             specified failure mode.
 157             Possible modes are <span><strong class="command">"fail"</strong></span>
 158             (default for <span><strong class="command">named-compilezone</strong></span>),
 159             <span><strong class="command">"warn"</strong></span>
 160             (default for <span><strong class="command">named-checkzone</strong></span>) and
 161             <span><strong class="command">"ignore"</strong></span>.
 162           </p></dd>
 163 <dt><span class="term">-m <em class="replaceable"><code>mode</code></em></span></dt>
 164 <dd><p>
 165             Specify whether MX records should be checked to see if they
 166             are addresses.  Possible modes are <span><strong class="command">"fail"</strong></span>,
 167             <span><strong class="command">"warn"</strong></span> (default) and
 168             <span><strong class="command">"ignore"</strong></span>.
 169           </p></dd>
 170 <dt><span class="term">-M <em class="replaceable"><code>mode</code></em></span></dt>
 171 <dd><p>
 172             Check if a MX record refers to a CNAME.
 173             Possible modes are <span><strong class="command">"fail"</strong></span>,
 174             <span><strong class="command">"warn"</strong></span> (default) and
 175             <span><strong class="command">"ignore"</strong></span>.
 176           </p></dd>
 177 <dt><span class="term">-n <em class="replaceable"><code>mode</code></em></span></dt>
 178 <dd><p>
 179             Specify whether NS records should be checked to see if they
 180             are addresses.
 181             Possible modes are <span><strong class="command">"fail"</strong></span>
 182             (default for <span><strong class="command">named-compilezone</strong></span>),
 183             <span><strong class="command">"warn"</strong></span>
 184             (default for <span><strong class="command">named-checkzone</strong></span>) and
 185             <span><strong class="command">"ignore"</strong></span>.
 186           </p></dd>
 187 <dt><span class="term">-o <em class="replaceable"><code>filename</code></em></span></dt>
 188 <dd><p>
 189             Write zone output to <code class="filename">filename</code>.
 190             This is mandatory for <span><strong class="command">named-compilezone</strong></span>.
 191           </p></dd>
 192 <dt><span class="term">-s <em class="replaceable"><code>style</code></em></span></dt>
 193 <dd><p>
 194             Specify the style of the dumped zone file.
 195             Possible styles are <span><strong class="command">"full"</strong></span> (default)
 196             and <span><strong class="command">"relative"</strong></span>.
 197             The full format is most suitable for processing
 198             automatically by a separate script.
 199             On the other hand, the relative format is more
 200             human-readable and is thus suitable for editing by hand.
 201             For <span><strong class="command">named-checkzone</strong></span>
 202             this does not cause any effects unless it dumps the zone
 203             contents.
 204             It also does not have any meaning if the output format
 205             is not text.
 206           </p></dd>
 207 <dt><span class="term">-S <em class="replaceable"><code>mode</code></em></span></dt>
 208 <dd><p>
 209             Check if a SRV record refers to a CNAME.
 210             Possible modes are <span><strong class="command">"fail"</strong></span>,
 211             <span><strong class="command">"warn"</strong></span> (default) and
 212             <span><strong class="command">"ignore"</strong></span>.
 213           </p></dd>
 214 <dt><span class="term">-t <em class="replaceable"><code>directory</code></em></span></dt>
 215 <dd><p>
 216             Chroot to <code class="filename">directory</code> so that
 217             include
 218             directives in the configuration file are processed as if
 219             run by a similarly chrooted named.
 220           </p></dd>
 221 <dt><span class="term">-w <em class="replaceable"><code>directory</code></em></span></dt>
 222 <dd><p>
 223             chdir to <code class="filename">directory</code> so that
 224             relative
 225             filenames in master file $INCLUDE directives work.  This
 226             is similar to the directory clause in
 227             <code class="filename">named.conf</code>.
 228           </p></dd>
 229 <dt><span class="term">-D</span></dt>
 230 <dd><p>
 231             Dump zone file in canonical format.
 232             This is always enabled for <span><strong class="command">named-compilezone</strong></span>.
 233           </p></dd>
 234 <dt><span class="term">-W <em class="replaceable"><code>mode</code></em></span></dt>
 235 <dd><p>
 236             Specify whether to check for non-terminal wildcards.
 237             Non-terminal wildcards are almost always the result of a
 238             failure to understand the wildcard matching algorithm (RFC 1034).
 239             Possible modes are <span><strong class="command">"warn"</strong></span> (default)
 240             and
 241             <span><strong class="command">"ignore"</strong></span>.
 242           </p></dd>
 243 <dt><span class="term">zonename</span></dt>
 244 <dd><p>
 245             The domain name of the zone being checked.
 246           </p></dd>
 247 <dt><span class="term">filename</span></dt>
 248 <dd><p>
 249             The name of the zone file.
 250           </p></dd>
 251 </dl></div>
 252 </div>
 253 <div class="refsect1" lang="en">
 254 <a name="id2656364"></a><h2>RETURN VALUES</h2>
 255 <p><span><strong class="command">named-checkzone</strong></span>
 256       returns an exit status of 1 if
 257       errors were detected and 0 otherwise.
 258     </p>
 259 </div>
 260 <div class="refsect1" lang="en">
 261 <a name="id2656378"></a><h2>SEE ALSO</h2>
 262 <p><span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
 263       <span class="citerefentry"><span class="refentrytitle">named-checkconf</span>(8)</span>,
 264       <em class="citetitle">RFC 1035</em>,
 265       <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
 266     </p>
 267 </div>
 268 <div class="refsect1" lang="en">
 269 <a name="id2656480"></a><h2>AUTHOR</h2>
 270 <p><span class="corpauthor">Internet Systems Consortium</span>
 271     </p>
 272 </div>
 273 </div>
 274 <div class="navfooter">
 275 <hr>
 276 <table width="100%" summary="Navigation footer">
 277 <tr>
 278 <td width="40%" align="left">
 279 <a accesskey="p" href="man.named-checkconf.html">Prev</a> </td>
 280 <td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
 281 <td width="40%" align="right"> <a accesskey="n" href="man.named.html">Next</a>
 282 </td>
 283 </tr>
 284 <tr>
 285 <td width="40%" align="left" valign="top">
 286 <span class="application">named-checkconf</span> </td>
 287 <td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
 288 <td width="40%" align="right" valign="top"> <span class="application">named</span>
 289 </td>
 290 </tr>
 291 </table>
 292 </div>
 293 </body>
 294 </html>