named-checkzone.docbook 18.2 KB
Newer Older
1 2
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3
	       [<!ENTITY mdash "&#8212;">]>
Brian Wellington's avatar
Brian Wellington committed
4
<!--
Tinderbox User's avatar
Tinderbox User committed
5
 - Copyright (C) 2004-2007, 2009-2013  Internet Systems Consortium, Inc. ("ISC")
6
 - Copyright (C) 2000-2002  Internet Software Consortium.
Brian Wellington's avatar
Brian Wellington committed
7
 -
Automatic Updater's avatar
Automatic Updater committed
8
 - Permission to use, copy, modify, and/or distribute this software for any
Brian Wellington's avatar
Brian Wellington committed
9 10 11
 - purpose with or without fee is hereby granted, provided that the above
 - copyright notice and this permission notice appear in all copies.
 -
Mark Andrews's avatar
Mark Andrews committed
12 13 14 15 16 17 18
 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 - PERFORMANCE OF THIS SOFTWARE.
Brian Wellington's avatar
Brian Wellington committed
19
-->
Mark Andrews's avatar
Mark Andrews committed
20

21
<!-- $Id: named-checkzone.docbook,v 1.44 2011/12/22 07:32:39 each Exp $ -->
22
<refentry id="man.named-checkzone">
23 24 25 26 27 28 29 30 31 32
  <refentryinfo>
    <date>June 13, 2000</date>
  </refentryinfo>

  <refmeta>
    <refentrytitle><application>named-checkzone</application></refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo>BIND9</refmiscinfo>
  </refmeta>

33 34 35 36
  <docinfo>
    <copyright>
      <year>2004</year>
      <year>2005</year>
Mark Andrews's avatar
Mark Andrews committed
37
      <year>2006</year>
Mark Andrews's avatar
Mark Andrews committed
38
      <year>2007</year>
Automatic Updater's avatar
Automatic Updater committed
39
      <year>2009</year>
Automatic Updater's avatar
Automatic Updater committed
40
      <year>2010</year>
Automatic Updater's avatar
Automatic Updater committed
41
      <year>2011</year>
Tinderbox User's avatar
Tinderbox User committed
42
      <year>2012</year>
Tinderbox User's avatar
Tinderbox User committed
43
      <year>2013</year>
44 45 46 47 48 49
      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
    </copyright>
    <copyright>
      <year>2000</year>
      <year>2001</year>
      <year>2002</year>
Mark Andrews's avatar
Mark Andrews committed
50
      <holder>Internet Software Consortium.</holder>
51 52 53
    </copyright>
  </docinfo>

54 55
  <refnamediv>
    <refname><application>named-checkzone</application></refname>
56 57
    <refname><application>named-compilezone</application></refname>
    <refpurpose>zone file validity checking or converting tool</refpurpose>
58 59 60 61 62 63
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>named-checkzone</command>
      <arg><option>-d</option></arg>
64
      <arg><option>-h</option></arg>
Mark Andrews's avatar
Mark Andrews committed
65
      <arg><option>-j</option></arg>
66
      <arg><option>-q</option></arg>
67
      <arg><option>-v</option></arg>
68
      <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>
69 70
      <arg><option>-f <replaceable class="parameter">format</replaceable></option></arg>
      <arg><option>-F <replaceable class="parameter">format</replaceable></option></arg>
71
      <arg><option>-J <replaceable class="parameter">filename</replaceable></option></arg>
72
      <arg><option>-i <replaceable class="parameter">mode</replaceable></option></arg>
73
      <arg><option>-k <replaceable class="parameter">mode</replaceable></option></arg>
74
      <arg><option>-m <replaceable class="parameter">mode</replaceable></option></arg>
75
      <arg><option>-M <replaceable class="parameter">mode</replaceable></option></arg>
76
      <arg><option>-n <replaceable class="parameter">mode</replaceable></option></arg>
77
      <arg><option>-L <replaceable class="parameter">serial</replaceable></option></arg>
78
      <arg><option>-o <replaceable class="parameter">filename</replaceable></option></arg>
79
      <arg><option>-r <replaceable class="parameter">mode</replaceable></option></arg>
80
      <arg><option>-s <replaceable class="parameter">style</replaceable></option></arg>
81
      <arg><option>-S <replaceable class="parameter">mode</replaceable></option></arg>
82 83 84 85 86 87 88 89 90 91 92 93 94 95
      <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
      <arg><option>-w <replaceable class="parameter">directory</replaceable></option></arg>
      <arg><option>-D</option></arg>
      <arg><option>-W <replaceable class="parameter">mode</replaceable></option></arg>
      <arg choice="req">zonename</arg>
      <arg choice="req">filename</arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>named-compilezone</command>
      <arg><option>-d</option></arg>
      <arg><option>-j</option></arg>
      <arg><option>-q</option></arg>
      <arg><option>-v</option></arg>
      <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>
96
      <arg><option>-C <replaceable class="parameter">mode</replaceable></option></arg>
97 98
      <arg><option>-f <replaceable class="parameter">format</replaceable></option></arg>
      <arg><option>-F <replaceable class="parameter">format</replaceable></option></arg>
99
      <arg><option>-J <replaceable class="parameter">filename</replaceable></option></arg>
100 101 102 103
      <arg><option>-i <replaceable class="parameter">mode</replaceable></option></arg>
      <arg><option>-k <replaceable class="parameter">mode</replaceable></option></arg>
      <arg><option>-m <replaceable class="parameter">mode</replaceable></option></arg>
      <arg><option>-n <replaceable class="parameter">mode</replaceable></option></arg>
104
      <arg><option>-L <replaceable class="parameter">serial</replaceable></option></arg>
105
      <arg><option>-r <replaceable class="parameter">mode</replaceable></option></arg>
106
      <arg><option>-s <replaceable class="parameter">style</replaceable></option></arg>
107 108
      <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
      <arg><option>-w <replaceable class="parameter">directory</replaceable></option></arg>
109
      <arg><option>-D</option></arg>
110
      <arg><option>-W <replaceable class="parameter">mode</replaceable></option></arg>
111
      <arg choice="req"><option>-o <replaceable class="parameter">filename</replaceable></option></arg>
112 113 114 115 116 117 118
      <arg choice="req">zonename</arg>
      <arg choice="req">filename</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>
119 120 121 122 123
    <para><command>named-checkzone</command>
      checks the syntax and integrity of a zone file.  It performs the
      same checks as <command>named</command> does when loading a
      zone.  This makes <command>named-checkzone</command> useful for
      checking zone files before configuring them into a name server.
124
    </para>
125 126 127 128 129 130 131
    <para>
        <command>named-compilezone</command> is similar to
	<command>named-checkzone</command>, but it always dumps the
        zone contents to a specified file in a specified format.
	Additionally, it applies stricter check levels by default,
        since the dump output will be used as an actual zone file
	loaded by <command>named</command>.
132
	When manually specified otherwise, the check levels must at
133 134
        least be as strict as those specified in the
	<command>named</command> configuration file.
Mark Andrews's avatar
Mark Andrews committed
135
     </para>
136 137 138 139 140 141 142 143
  </refsect1>

  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term>-d</term>
144 145 146 147 148
        <listitem>
          <para>
            Enable debugging.
          </para>
        </listitem>
149 150
      </varlistentry>

151 152 153 154 155 156 157 158 159
      <varlistentry>
        <term>-h</term>
        <listitem>
          <para>
            Print the usage summary and exit.
          </para>
        </listitem>
      </varlistentry>

160 161
      <varlistentry>
        <term>-q</term>
162 163 164 165 166
        <listitem>
          <para>
            Quiet mode - exit code only.
          </para>
        </listitem>
167 168
      </varlistentry>

169 170
      <varlistentry>
        <term>-v</term>
171 172 173 174 175 176
        <listitem>
          <para>
            Print the version of the <command>named-checkzone</command>
            program and exit.
          </para>
        </listitem>
177 178
      </varlistentry>

179
      <varlistentry>
180
        <term>-j</term>
181 182
        <listitem>
          <para>
183 184 185 186 187 188 189 190 191 192 193 194 195
            When loading a zone file, read the journal if it exists.
            The journal file name is assumed to be the zone file name
	    appended with the string <filename>.jnl</filename>.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-J <replaceable class="parameter">filename</replaceable></term>
        <listitem>
          <para>
            When loading the zone file read the journal from the given
            file, if it exists. (Implies -j.)
196
          </para>
197
        </listitem>
198
      </varlistentry>
199

200 201
      <varlistentry>
        <term>-c <replaceable class="parameter">class</replaceable></term>
202 203
        <listitem>
          <para>
204
            Specify the class of the zone.  If not specified, "IN" is assumed.
205 206
          </para>
        </listitem>
207 208
      </varlistentry>

209 210 211 212
      <varlistentry>
        <term>-i <replaceable class="parameter">mode</replaceable></term>
	<listitem>
	  <para>
213
	      Perform post-load zone integrity checks.  Possible modes are
214
	      <command>"full"</command> (default),
215 216 217
	      <command>"full-sibling"</command>,
	      <command>"local"</command>,
	      <command>"local-sibling"</command> and
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
	      <command>"none"</command>.
	  </para>
	  <para>
	      Mode <command>"full"</command> checks that MX records
	      refer to A or AAAA record (both in-zone and out-of-zone
	      hostnames).  Mode <command>"local"</command> only
	      checks MX records which refer to in-zone hostnames.
	  </para>
	  <para>
	      Mode <command>"full"</command> checks that SRV records
	      refer to A or AAAA record (both in-zone and out-of-zone
	      hostnames).  Mode <command>"local"</command> only
	      checks SRV records which refer to in-zone hostnames.
	  </para>
	  <para>
	      Mode <command>"full"</command> checks that delegation NS
	      records refer to A or AAAA record (both in-zone and out-of-zone
235
	      hostnames).  It also checks that glue address records
236 237 238 239 240
	      in the zone match those advertised by the child.
	      Mode <command>"local"</command> only checks NS records which
	      refer to in-zone hostnames or that some required glue exists,
	      that is when the nameserver is in a child zone.
	  </para>
241 242 243 244 245 246
	  <para>
	      Mode <command>"full-sibling"</command> and
	      <command>"local-sibling"</command> disable sibling glue
	      checks but are otherwise the same as <command>"full"</command>
	      and <command>"local"</command> respectively.
	  </para>
247 248 249 250 251 252
	  <para>
	      Mode <command>"none"</command> disables the checks.
	  </para>
	</listitem>
      </varlistentry>

253 254 255 256 257
      <varlistentry>
	<term>-f <replaceable class="parameter">format</replaceable></term>
	<listitem>
	  <para>
	    Specify the format of the zone file.
258 259
	    Possible formats are <command>"text"</command> (default),
	    <command>"raw"</command>, and <command>"fast"</command>.
260 261 262 263 264 265 266 267 268 269 270 271 272
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>-F <replaceable class="parameter">format</replaceable></term>
	<listitem>
	  <para>
	    Specify the format of the output file specified.
	    For <command>named-checkzone</command>,
	    this does not cause any effects unless it dumps the zone
	    contents.
	  </para>
273
	  <para>
274 275 276 277 278 279 280 281 282
	    Possible formats are <command>"text"</command> (default),
	    which is the standard textual representation of the zone,
	    and <command>"fast"</command>, <command>"raw"</command>,
            and <command>"raw=N"</command>, which store the zone in a
            binary format for rapid loading by <command>named</command>.
            <command>"raw=N"</command> specifies the format version of
            the raw zone file: if N is 0, the raw file can be read by
            any version of <command>named</command>; if N is 1, the file
            can be read by release 9.9.0 or higher; the default is 1.
283
	  </para>
284 285 286
	</listitem>
      </varlistentry>

287 288
      <varlistentry>
        <term>-k <replaceable class="parameter">mode</replaceable></term>
289 290
        <listitem>
          <para>
Mark Andrews's avatar
Mark Andrews committed
291
            Perform <command>"check-names"</command> checks with the
292 293 294 295 296
	    specified failure mode.
            Possible modes are <command>"fail"</command>
	    (default for <command>named-compilezone</command>),
            <command>"warn"</command>
	    (default for <command>named-checkzone</command>) and
297 298 299
            <command>"ignore"</command>.
          </para>
        </listitem>
300
      </varlistentry>
301 302 303 304 305

      <varlistentry>
        <term>-L <replaceable class="parameter">serial</replaceable></term>
        <listitem>
          <para>
306 307 308 309
            When compiling a zone to "raw" or "fast" format, set the
            "source serial" value in the header to the specified serial
            number.  (This is expected to be used primarily for testing
            purposes.)
310 311 312
          </para>
        </listitem>
      </varlistentry>
313

314 315 316 317 318 319 320 321 322 323 324 325
      <varlistentry>
        <term>-m <replaceable class="parameter">mode</replaceable></term>
        <listitem>
          <para>
            Specify whether MX records should be checked to see if they
            are addresses.  Possible modes are <command>"fail"</command>,
            <command>"warn"</command> (default) and
            <command>"ignore"</command>.
          </para>
        </listitem>
      </varlistentry>

326 327 328 329 330 331 332 333 334 335 336 337
      <varlistentry>
	<term>-M <replaceable class="parameter">mode</replaceable></term>
        <listitem>
	  <para>
	    Check if a MX record refers to a CNAME.
            Possible modes are <command>"fail"</command>,
            <command>"warn"</command> (default) and
            <command>"ignore"</command>.
	  </para>
        </listitem>
      </varlistentry>

338 339
      <varlistentry>
        <term>-n <replaceable class="parameter">mode</replaceable></term>
340 341 342
        <listitem>
          <para>
            Specify whether NS records should be checked to see if they
343 344 345 346 347
            are addresses.
	    Possible modes are <command>"fail"</command>
	    (default for <command>named-compilezone</command>),
            <command>"warn"</command>
	    (default for <command>named-checkzone</command>) and
348 349 350
            <command>"ignore"</command>.
          </para>
        </listitem>
351 352
      </varlistentry>

353 354 355 356
      <varlistentry>
        <term>-o <replaceable class="parameter">filename</replaceable></term>
        <listitem>
          <para>
357
            Write zone output to <filename>filename</filename>.
358 359
	    If <filename>filename</filename> is <filename>-</filename> then
	    write to standard out.
360
	    This is mandatory for <command>named-compilezone</command>.
361 362 363 364
          </para>
        </listitem>
      </varlistentry>

365 366 367 368 369 370 371 372 373 374 375 376 377
      <varlistentry>
	<term>-r <replaceable class="parameter">mode</replaceable></term>
        <listitem>
	  <para>
            Check for records that are treated as different by DNSSEC but
	    are semantically equal in plain DNS.  
            Possible modes are <command>"fail"</command>,
            <command>"warn"</command> (default) and
            <command>"ignore"</command>.
	  </para>
        </listitem>
      </varlistentry>

378 379 380 381 382 383
      <varlistentry>
	<term>-s <replaceable class="parameter">style</replaceable></term>
	<listitem>
	  <para>
	    Specify the style of the dumped zone file.
	    Possible styles are <command>"full"</command> (default)
384
	    and <command>"relative"</command>.
385 386
	    The full format is most suitable for processing
	    automatically by a separate script.
387
	    On the other hand, the relative format is more
388 389 390 391 392 393 394 395 396 397
	    human-readable and is thus suitable for editing by hand.
	    For <command>named-checkzone</command>
	    this does not cause any effects unless it dumps the zone
	    contents.
	    It also does not have any meaning if the output format
	    is not text.
	  </para>
	</listitem>
      </varlistentry>

398 399 400 401 402 403 404 405 406 407 408 409
      <varlistentry>
	<term>-S <replaceable class="parameter">mode</replaceable></term>
        <listitem>
	  <para>
	    Check if a SRV record refers to a CNAME.
            Possible modes are <command>"fail"</command>,
            <command>"warn"</command> (default) and
            <command>"ignore"</command>.
	  </para>
        </listitem>
      </varlistentry>

410 411 412 413
      <varlistentry>
        <term>-t <replaceable class="parameter">directory</replaceable></term>
        <listitem>
          <para>
414
            Chroot to <filename>directory</filename> so that
415 416 417
            include
            directives in the configuration file are processed as if
            run by a similarly chrooted named.
418 419 420 421 422 423 424 425
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>-w <replaceable class="parameter">directory</replaceable></term>
        <listitem>
          <para>
426 427 428 429 430
            chdir to <filename>directory</filename> so that
            relative
            filenames in master file $INCLUDE directives work.  This
            is similar to the directory clause in
            <filename>named.conf</filename>.
431 432 433 434
          </para>
        </listitem>
      </varlistentry>

435 436
      <varlistentry>
        <term>-D</term>
437 438 439
        <listitem>
          <para>
            Dump zone file in canonical format.
440
	    This is always enabled for <command>named-compilezone</command>.
441 442
          </para>
        </listitem>
443 444
      </varlistentry>

445 446
      <varlistentry>
        <term>-W <replaceable class="parameter">mode</replaceable></term>
447 448 449 450 451 452 453 454 455 456
        <listitem>
          <para>
            Specify whether to check for non-terminal wildcards.
            Non-terminal wildcards are almost always the result of a
            failure to understand the wildcard matching algorithm (RFC 1034).
            Possible modes are <command>"warn"</command> (default)
            and
            <command>"ignore"</command>.
          </para>
        </listitem>
457 458
      </varlistentry>

459 460
      <varlistentry>
        <term>zonename</term>
461 462 463 464 465
        <listitem>
          <para>
            The domain name of the zone being checked.
          </para>
        </listitem>
466 467 468 469
      </varlistentry>

      <varlistentry>
        <term>filename</term>
470 471 472 473 474
        <listitem>
          <para>
            The name of the zone file.
          </para>
        </listitem>
475 476 477 478 479 480 481 482
      </varlistentry>

    </variablelist>

  </refsect1>

  <refsect1>
    <title>RETURN VALUES</title>
483 484 485 486
    <para><command>named-checkzone</command>
      returns an exit status of 1 if
      errors were detected and 0 otherwise.
    </para>
487 488 489 490
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
491 492
    <para><citerefentry>
        <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
493
      </citerefentry>,
494 495 496
      <citerefentry>
        <refentrytitle>named-checkconf</refentrytitle><manvolnum>8</manvolnum>  
      </citerefentry>,
497 498 499 500 501 502 503
      <citetitle>RFC 1035</citetitle>,
      <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
    </para>
  </refsect1>

  <refsect1>
    <title>AUTHOR</title>
504
    <para><corpauthor>Internet Systems Consortium</corpauthor>
505 506 507
    </para>
  </refsect1>

508
</refentry><!--
509 510 511 512
 - Local variables:
 - mode: sgml
 - End:
-->