named-checkzone.docbook revision b5ad6dfea4cc3e7d1d322ac99f1e5a31096837c4
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN"
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd"
75c0816e8295e180f4bc7f10db3d0d880383bc1cMark Andrews [<!ENTITY mdash "—">]>
4a14ce5ba00ab7bc55c99ffdcf59c7a4ab902721Automatic Updater - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - Copyright (C) 2000-2002 Internet Software Consortium.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - Permission to use, copy, modify, and distribute this software for any
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - purpose with or without fee is hereby granted, provided that the above
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - copyright notice and this permission notice appear in all copies.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - PERFORMANCE OF THIS SOFTWARE.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<!-- $Id: named-checkzone.docbook,v 1.22 2005/07/19 04:55:19 marka Exp $ -->
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentryinfo>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </refentryinfo>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentrytitle><application>named-checkzone</application></refentrytitle>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </copyright>
5fa6a064b8301e4f274bd132fd577def59e4fb4cTinderbox User <holder>Internet Software Consortium.</holder>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refnamediv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refname><application>named-checkzone</application></refname>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refname><application>named-compilezone</application></refname>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refpurpose>zone file validity checking or converting tool</refpurpose>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </refnamediv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refsynopsisdiv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <cmdsynopsis>
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User <arg><option>-f <replaceable class="parameter">format</replaceable></option></arg>
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User <arg><option>-F <replaceable class="parameter">format</replaceable></option></arg>
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User <arg><option>-i <replaceable class="parameter">mode</replaceable></option></arg>
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User <arg><option>-k <replaceable class="parameter">mode</replaceable></option></arg>
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User <arg><option>-m <replaceable class="parameter">mode</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-n <replaceable class="parameter">mode</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-o <replaceable class="parameter">filename</replaceable></option></arg>
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews <arg><option>-s <replaceable class="parameter">style</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User <arg><option>-w <replaceable class="parameter">directory</replaceable></option></arg>
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User <arg><option>-W <replaceable class="parameter">mode</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </cmdsynopsis>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <cmdsynopsis>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-c <replaceable class="parameter">class</replaceable></option></arg>
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User <arg><option>-f <replaceable class="parameter">format</replaceable></option></arg>
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User <arg><option>-F <replaceable class="parameter">format</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-i <replaceable class="parameter">mode</replaceable></option></arg>
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User <arg><option>-k <replaceable class="parameter">mode</replaceable></option></arg>
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User <arg><option>-m <replaceable class="parameter">mode</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-n <replaceable class="parameter">mode</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-o <replaceable class="parameter">filename</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-s <replaceable class="parameter">style</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-t <replaceable class="parameter">directory</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-w <replaceable class="parameter">directory</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-W <replaceable class="parameter">mode</replaceable></option></arg>
5d564da348e890e42f63eebf2dced9a05b41f4fbTinderbox User </cmdsynopsis>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </refsynopsisdiv>
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User checks the syntax and integrity of a zone file. It performs the
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User same checks as <command>named</command> does when loading a
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User zone. This makes <command>named-checkzone</command> useful for
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein checking zone files before configuring them into a name server.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <command>named-compilezone</command> is similar to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <command>named-checkzone</command>, but it always dumps the
5d564da348e890e42f63eebf2dced9a05b41f4fbTinderbox User zone contents to a specified file in a specified format.
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User Additionally, it applies stricter check levels by default,
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User since the dump output will be used as an actual zone file
6f64d4ab8e68f9b2333bcbfc755396d29a4a9d7cAutomatic Updater When manaully specified otherwise, the check levels must at
6f64d4ab8e68f9b2333bcbfc755396d29a4a9d7cAutomatic Updater least be as strict as those specified in the
5091a6fed939d70cc5ae90a8ddecf2a829cdbabaTinderbox User <variablelist>
5091a6fed939d70cc5ae90a8ddecf2a829cdbabaTinderbox User <varlistentry>
5091a6fed939d70cc5ae90a8ddecf2a829cdbabaTinderbox User Enable debugging.
44d0f0256fbdce130a18655023c3b06bacacbd61Automatic Updater </varlistentry>
5091a6fed939d70cc5ae90a8ddecf2a829cdbabaTinderbox User <varlistentry>
5091a6fed939d70cc5ae90a8ddecf2a829cdbabaTinderbox User Quiet mode - exit code only.
5091a6fed939d70cc5ae90a8ddecf2a829cdbabaTinderbox User </varlistentry>
5091a6fed939d70cc5ae90a8ddecf2a829cdbabaTinderbox User <varlistentry>
44d0f0256fbdce130a18655023c3b06bacacbd61Automatic Updater Print the version of the <command>named-checkzone</command>
5091a6fed939d70cc5ae90a8ddecf2a829cdbabaTinderbox User program and exit.
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User </varlistentry>
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User <varlistentry>
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews When loading the zone file read the journal if it exists.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term>-c <replaceable class="parameter">class</replaceable></term>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specify the class of the zone. If not specified "IN" is assumed.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
d9184858dd5d7677050a813d444c281c56f697aaTinderbox User <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term>-i <replaceable class="parameter">mode</replaceable></term>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Perform post load zone integrity checks. Possible modes are
d9184858dd5d7677050a813d444c281c56f697aaTinderbox User Mode <command>"full"</command> checks that MX records
d9184858dd5d7677050a813d444c281c56f697aaTinderbox User refer to A or AAAA record (both in-zone and out-of-zone
d9184858dd5d7677050a813d444c281c56f697aaTinderbox User hostnames). Mode <command>"local"</command> only
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein checks MX records which refer to in-zone hostnames.
d9184858dd5d7677050a813d444c281c56f697aaTinderbox User Mode <command>"full"</command> checks that SRV records
5d564da348e890e42f63eebf2dced9a05b41f4fbTinderbox User refer to A or AAAA record (both in-zone and out-of-zone
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein hostnames). Mode <command>"local"</command> only
5d564da348e890e42f63eebf2dced9a05b41f4fbTinderbox User checks SRV records which refer to in-zone hostnames.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Mode <command>"full"</command> checks that delegation NS
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein records refer to A or AAAA record (both in-zone and out-of-zone
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein hostnames). It also checks that glue addresses records
a1ad6695ed6f988406cf155aa26376f84f73bcb9Automatic Updater in the zone match those advertised by the child.
5091a6fed939d70cc5ae90a8ddecf2a829cdbabaTinderbox User Mode <command>"local"</command> only checks NS records which
a1ad6695ed6f988406cf155aa26376f84f73bcb9Automatic Updater refer to in-zone hostnames or that some required glue exists,
44d0f0256fbdce130a18655023c3b06bacacbd61Automatic Updater that is when the nameserver is in a child zone.
5091a6fed939d70cc5ae90a8ddecf2a829cdbabaTinderbox User Mode <command>"none"</command> disables the checks.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term>-f <replaceable class="parameter">format</replaceable></term>
5091a6fed939d70cc5ae90a8ddecf2a829cdbabaTinderbox User Specify the format of the zone file.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Possible formats are <command>"text"</command> (default)
5091a6fed939d70cc5ae90a8ddecf2a829cdbabaTinderbox User </varlistentry>
5091a6fed939d70cc5ae90a8ddecf2a829cdbabaTinderbox User <varlistentry>
7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews <term>-F <replaceable class="parameter">format</replaceable></term>
507151045be68c671ffd4e2f37e17cdfa0376fc4Automatic Updater Specify the format of the output file specified.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Possible formats are <command>"text"</command> (default)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein this does not cause any effects unless it dumps the zone
5091a6fed939d70cc5ae90a8ddecf2a829cdbabaTinderbox User </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term>-k <replaceable class="parameter">mode</replaceable></term>
5091a6fed939d70cc5ae90a8ddecf2a829cdbabaTinderbox User Perform <command>"check-name"</command> checks with the
5091a6fed939d70cc5ae90a8ddecf2a829cdbabaTinderbox User specified failure mode.
5091a6fed939d70cc5ae90a8ddecf2a829cdbabaTinderbox User (default for <command>named-compilezone</command>),
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User (default for <command>named-checkzone</command>) and
aa6c5a3e331958d3c92c2facdbd2b8daa55b5959Tinderbox User </varlistentry>
aa6c5a3e331958d3c92c2facdbd2b8daa55b5959Tinderbox User <varlistentry>
aa6c5a3e331958d3c92c2facdbd2b8daa55b5959Tinderbox User <term>-m <replaceable class="parameter">mode</replaceable></term>
aa6c5a3e331958d3c92c2facdbd2b8daa55b5959Tinderbox User Specify whether MX records should be checked to see if they
aa6c5a3e331958d3c92c2facdbd2b8daa55b5959Tinderbox User are addresses. Possible modes are <command>"fail"</command>,
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User </varlistentry>
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User <varlistentry>
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User <term>-n <replaceable class="parameter">mode</replaceable></term>
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User Specify whether NS records should be checked to see if they
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User are addresses.
44d0f0256fbdce130a18655023c3b06bacacbd61Automatic Updater (default for <command>named-compilezone</command>),
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User (default for <command>named-checkzone</command>) and
5091a6fed939d70cc5ae90a8ddecf2a829cdbabaTinderbox User </varlistentry>
5091a6fed939d70cc5ae90a8ddecf2a829cdbabaTinderbox User <varlistentry>
5091a6fed939d70cc5ae90a8ddecf2a829cdbabaTinderbox User <term>-o <replaceable class="parameter">filename</replaceable></term>
5091a6fed939d70cc5ae90a8ddecf2a829cdbabaTinderbox User Write zone output to <filename>filename</filename>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein This is mandatory for <command>named-compilezone</command>.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </varlistentry>
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews <varlistentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <term>-s <replaceable class="parameter">style</replaceable></term>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Specify the style of the dumped zone file.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Possible styles are <command>"full"</command> (default)
6d382c9fcec316a84a237779fb64bb471b6f9d43Tinderbox User The full format is most suitable for processing
6d382c9fcec316a84a237779fb64bb471b6f9d43Tinderbox User automatically by a separate script.
f9aef05653eeb454c489d5bd2bde6daab774ad4aTinderbox User On the other hand, the default format is more
f9aef05653eeb454c489d5bd2bde6daab774ad4aTinderbox User human-readable and is thus suitable for editing by hand.
f9aef05653eeb454c489d5bd2bde6daab774ad4aTinderbox User this does not cause any effects unless it dumps the zone
f9aef05653eeb454c489d5bd2bde6daab774ad4aTinderbox User It also does not have any meaning if the output format
50066670817cdf9e86c832066d73715232b29680Tinderbox User </varlistentry>
50066670817cdf9e86c832066d73715232b29680Tinderbox User <varlistentry>
28b3569d6248168e6c00caab951521cc8141a49dAutomatic Updater <term>-t <replaceable class="parameter">directory</replaceable></term>
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews chroot to <filename>directory</filename> so that
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews directives in the configuration file are processed as if
2cbb4ab75757fbb656997a82c14ca07db37d481aAutomatic Updater run by a similarly chrooted named.
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater </varlistentry>
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater <varlistentry>
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews <term>-w <replaceable class="parameter">directory</replaceable></term>
c3dc968140ab7f04795acc7835e4e89ccb0c0a27Tinderbox User chdir to <filename>directory</filename> so that
c3dc968140ab7f04795acc7835e4e89ccb0c0a27Tinderbox User filenames in master file $INCLUDE directives work. This
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews is similar to the directory clause in
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </varlistentry>
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews <varlistentry>
e2e4d321999340802f77adaacd19c797d04b4b95Automatic Updater Dump zone file in canonical format.
e2e4d321999340802f77adaacd19c797d04b4b95Automatic Updater This is always enabled for <command>named-compilezone</command>.
b6b8f8a0362da8c749021c4b6376cfb96047912bTinderbox User </varlistentry>
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater <varlistentry>
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater <term>-W <replaceable class="parameter">mode</replaceable></term>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Specify whether to check for non-terminal wildcards.
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews Non-terminal wildcards are almost always the result of a
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews failure to understand the wildcard matching algorithm (RFC 1034).
9b469e3c59015b1a4899c9d8395168126fe094fdAutomatic Updater Possible modes are <command>"warn"</command> (default)
9b469e3c59015b1a4899c9d8395168126fe094fdAutomatic Updater </varlistentry>
e2e4d321999340802f77adaacd19c797d04b4b95Automatic Updater <varlistentry>
e2e4d321999340802f77adaacd19c797d04b4b95Automatic Updater The domain name of the zone being checked.
fdd80e9a55c70b36a3bf3e409b86897301c44ff8Automatic Updater </varlistentry>
e2e4d321999340802f77adaacd19c797d04b4b95Automatic Updater <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The name of the zone file.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </variablelist>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein returns an exit status of 1 if
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein errors were detected and 0 otherwise.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>