named-checkzone.docbook 19.5 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
<!--
Mark Andrews's avatar
Mark Andrews committed
5
 - Copyright (C) 2004-2007, 2009-2014  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>
Mark Andrews's avatar
Mark Andrews committed
44
      <year>2014</year>
45 46 47 48 49 50
      <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
51
      <holder>Internet Software Consortium.</holder>
52 53 54
    </copyright>
  </docinfo>

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

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

  <refsect1>
    <title>DESCRIPTION</title>
124 125 126 127 128
    <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.
129
    </para>
130 131 132 133 134 135 136
    <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>.
137
	When manually specified otherwise, the check levels must at
138 139
        least be as strict as those specified in the
	<command>named</command> configuration file.
Mark Andrews's avatar
Mark Andrews committed
140
     </para>
141 142 143 144 145 146 147 148
  </refsect1>

  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term>-d</term>
149 150 151 152 153
        <listitem>
          <para>
            Enable debugging.
          </para>
        </listitem>
154 155
      </varlistentry>

156 157 158 159 160 161 162 163 164
      <varlistentry>
        <term>-h</term>
        <listitem>
          <para>
            Print the usage summary and exit.
          </para>
        </listitem>
      </varlistentry>

165 166
      <varlistentry>
        <term>-q</term>
167 168 169 170 171
        <listitem>
          <para>
            Quiet mode - exit code only.
          </para>
        </listitem>
172 173
      </varlistentry>

174 175
      <varlistentry>
        <term>-v</term>
176 177 178 179 180 181
        <listitem>
          <para>
            Print the version of the <command>named-checkzone</command>
            program and exit.
          </para>
        </listitem>
182 183
      </varlistentry>

184
      <varlistentry>
185
        <term>-j</term>
186 187
        <listitem>
          <para>
188 189 190 191 192 193 194 195 196 197 198 199 200
            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.)
201
          </para>
202
        </listitem>
203
      </varlistentry>
204

205 206
      <varlistentry>
        <term>-c <replaceable class="parameter">class</replaceable></term>
207 208
        <listitem>
          <para>
209
            Specify the class of the zone.  If not specified, "IN" is assumed.
210 211
          </para>
        </listitem>
212 213
      </varlistentry>

214 215 216 217
      <varlistentry>
        <term>-i <replaceable class="parameter">mode</replaceable></term>
	<listitem>
	  <para>
218
	      Perform post-load zone integrity checks.  Possible modes are
219
	      <command>"full"</command> (default),
220 221 222
	      <command>"full-sibling"</command>,
	      <command>"local"</command>,
	      <command>"local-sibling"</command> and
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
	      <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
240
	      hostnames).  It also checks that glue address records
241 242 243 244 245
	      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>
246 247 248 249 250 251
	  <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>
252 253 254 255 256 257
	  <para>
	      Mode <command>"none"</command> disables the checks.
	  </para>
	</listitem>
      </varlistentry>

258 259 260 261 262
      <varlistentry>
	<term>-f <replaceable class="parameter">format</replaceable></term>
	<listitem>
	  <para>
	    Specify the format of the zone file.
263
	    Possible formats are <command>"text"</command> (default),
Evan Hunt's avatar
Evan Hunt committed
264
	    <command>"raw"</command>, and <command>"map"</command>.
265 266 267 268 269 270 271 272 273 274 275 276 277
	  </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>
278
	  <para>
279 280
	    Possible formats are <command>"text"</command> (default),
	    which is the standard textual representation of the zone,
Evan Hunt's avatar
Evan Hunt committed
281
	    and <command>"map"</command>, <command>"raw"</command>,
282 283 284 285 286 287
            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.
288
	  </para>
289 290 291
	</listitem>
      </varlistentry>

292 293
      <varlistentry>
        <term>-k <replaceable class="parameter">mode</replaceable></term>
294 295
        <listitem>
          <para>
Mark Andrews's avatar
Mark Andrews committed
296
            Perform <command>"check-names"</command> checks with the
297 298 299 300 301
	    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
302 303 304
            <command>"ignore"</command>.
          </para>
        </listitem>
305
      </varlistentry>
306

Evan Hunt's avatar
Evan Hunt committed
307 308 309 310 311 312 313 314 315 316 317 318 319
      <varlistentry>
        <term>-l <replaceable class="parameter">ttl</replaceable></term>
        <listitem>
          <para>
            Sets a maximum permissible TTL for the input file.
            Any record with a TTL higher than this value will cause
            the zone to be rejected.  This is similar to using the
            <command>max-zone-ttl</command> option in
            <filename>named.conf</filename>.
          </para>
        </listitem>
      </varlistentry>

320 321 322 323
      <varlistentry>
        <term>-L <replaceable class="parameter">serial</replaceable></term>
        <listitem>
          <para>
Evan Hunt's avatar
Evan Hunt committed
324
            When compiling a zone to "raw" or "map" format, set the
325 326 327
            "source serial" value in the header to the specified serial
            number.  (This is expected to be used primarily for testing
            purposes.)
328 329 330
          </para>
        </listitem>
      </varlistentry>
331

332 333 334 335 336 337 338 339 340 341 342 343
      <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>

344 345 346 347 348 349 350 351 352 353 354 355
      <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>

356 357
      <varlistentry>
        <term>-n <replaceable class="parameter">mode</replaceable></term>
358 359 360
        <listitem>
          <para>
            Specify whether NS records should be checked to see if they
361 362 363 364 365
            are addresses.
	    Possible modes are <command>"fail"</command>
	    (default for <command>named-compilezone</command>),
            <command>"warn"</command>
	    (default for <command>named-checkzone</command>) and
366 367 368
            <command>"ignore"</command>.
          </para>
        </listitem>
369 370
      </varlistentry>

371 372 373 374
      <varlistentry>
        <term>-o <replaceable class="parameter">filename</replaceable></term>
        <listitem>
          <para>
375
            Write zone output to <filename>filename</filename>.
376 377
	    If <filename>filename</filename> is <filename>-</filename> then
	    write to standard out.
378
	    This is mandatory for <command>named-compilezone</command>.
379 380 381 382
          </para>
        </listitem>
      </varlistentry>

383 384 385 386 387 388 389 390 391 392 393 394 395
      <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>

396 397 398 399 400 401
      <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)
402
	    and <command>"relative"</command>.
403 404
	    The full format is most suitable for processing
	    automatically by a separate script.
405
	    On the other hand, the relative format is more
406 407 408 409 410 411 412 413 414 415
	    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>

416 417 418 419 420 421 422 423 424 425 426 427
      <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>

428 429 430 431
      <varlistentry>
        <term>-t <replaceable class="parameter">directory</replaceable></term>
        <listitem>
          <para>
432
            Chroot to <filename>directory</filename> so that
433 434 435
            include
            directives in the configuration file are processed as if
            run by a similarly chrooted named.
436 437 438 439
          </para>
        </listitem>
      </varlistentry>

440 441 442 443 444 445 446 447 448 449 450 451
      <varlistentry>
	<term>-T <replaceable class="parameter">mode</replaceable></term>
	<listitem>
	  <para>
	    Check if Sender Policy Framework records (TXT and SPF)
	    both exist or both don't exist.  A warning is issued
	    if they don't match.  Possible modes are
	    <command>"warn"</command> (default), <command>"ignore"</command>.
	  </para>
	</listitem>
      </varlistentry>

452 453 454 455
      <varlistentry>
        <term>-w <replaceable class="parameter">directory</replaceable></term>
        <listitem>
          <para>
456 457 458 459 460
            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>.
461 462 463 464
          </para>
        </listitem>
      </varlistentry>

465 466
      <varlistentry>
        <term>-D</term>
467 468 469
        <listitem>
          <para>
            Dump zone file in canonical format.
470
	    This is always enabled for <command>named-compilezone</command>.
471 472
          </para>
        </listitem>
473 474
      </varlistentry>

475 476
      <varlistentry>
        <term>-W <replaceable class="parameter">mode</replaceable></term>
477 478 479 480 481 482 483 484 485 486
        <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>
487 488
      </varlistentry>

489 490
      <varlistentry>
        <term>zonename</term>
491 492 493 494 495
        <listitem>
          <para>
            The domain name of the zone being checked.
          </para>
        </listitem>
496 497 498 499
      </varlistentry>

      <varlistentry>
        <term>filename</term>
500 501 502 503 504
        <listitem>
          <para>
            The name of the zone file.
          </para>
        </listitem>
505 506 507 508 509 510 511 512
      </varlistentry>

    </variablelist>

  </refsect1>

  <refsect1>
    <title>RETURN VALUES</title>
513 514 515 516
    <para><command>named-checkzone</command>
      returns an exit status of 1 if
      errors were detected and 0 otherwise.
    </para>
517 518 519 520
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
521 522
    <para><citerefentry>
        <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
523
      </citerefentry>,
524 525 526
      <citerefentry>
        <refentrytitle>named-checkconf</refentrytitle><manvolnum>8</manvolnum>  
      </citerefentry>,
527 528 529 530 531 532 533
      <citetitle>RFC 1035</citetitle>,
      <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
    </para>
  </refsect1>

  <refsect1>
    <title>AUTHOR</title>
534
    <para><corpauthor>Internet Systems Consortium</corpauthor>
535 536 537
    </para>
  </refsect1>

538
</refentry><!--
539 540 541 542
 - Local variables:
 - mode: sgml
 - End:
-->