| blob | 69d122ac651685d3b592388dc888a258d12a55db |
1 .\" $NetBSD: named-checkzone.8,v 1.7 2014/12/10 04:37:51 christos Exp $
2 .\"
3 .\" Copyright (C) 2004-2007, 2009-2014 Internet Systems Consortium, Inc. ("ISC")
4 .\" Copyright (C) 2000-2002 Internet Software Consortium.
5 .\"
6 .\" Permission to use, copy, modify, and/or distribute this software for any
7 .\" purpose with or without fee is hereby granted, provided that the above
8 .\" copyright notice and this permission notice appear in all copies.
9 .\"
10 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
11 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
12 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
13 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
14 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
15 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16 .\" PERFORMANCE OF THIS SOFTWARE.
17 .\"
18 .\" Id
19 .\"
20 .hy 0
21 .ad l
22 .\" Title: named\-checkzone
23 .\" Author:
24 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
25 .\" Date: February 19, 2014
26 .\" Manual: BIND9
27 .\" Source: BIND9
28 .\"
29 .TH "NAMED\-CHECKZONE" "8" "February 19, 2014" "BIND9" "BIND9"
30 .\" disable hyphenation
31 .nh
32 .\" disable justification (adjust text to left margin only)
33 .ad l
34 .SH "NAME"
35 named\-checkzone, named\-compilezone \- zone file validity checking or converting tool
36 .SH "SYNOPSIS"
37 .HP 16
38 \fBnamed\-checkzone\fR [\fB\-d\fR] [\fB\-h\fR] [\fB\-j\fR] [\fB\-q\fR] [\fB\-v\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-f\ \fR\fB\fIformat\fR\fR] [\fB\-F\ \fR\fB\fIformat\fR\fR] [\fB\-J\ \fR\fB\fIfilename\fR\fR] [\fB\-i\ \fR\fB\fImode\fR\fR] [\fB\-k\ \fR\fB\fImode\fR\fR] [\fB\-m\ \fR\fB\fImode\fR\fR] [\fB\-M\ \fR\fB\fImode\fR\fR] [\fB\-n\ \fR\fB\fImode\fR\fR] [\fB\-l\ \fR\fB\fIttl\fR\fR] [\fB\-L\ \fR\fB\fIserial\fR\fR] [\fB\-o\ \fR\fB\fIfilename\fR\fR] [\fB\-r\ \fR\fB\fImode\fR\fR] [\fB\-s\ \fR\fB\fIstyle\fR\fR] [\fB\-S\ \fR\fB\fImode\fR\fR] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] [\fB\-T\ \fR\fB\fImode\fR\fR] [\fB\-w\ \fR\fB\fIdirectory\fR\fR] [\fB\-D\fR] [\fB\-W\ \fR\fB\fImode\fR\fR] {zonename} {filename}
39 .HP 18
40 \fBnamed\-compilezone\fR [\fB\-d\fR] [\fB\-j\fR] [\fB\-q\fR] [\fB\-v\fR] [\fB\-c\ \fR\fB\fIclass\fR\fR] [\fB\-C\ \fR\fB\fImode\fR\fR] [\fB\-f\ \fR\fB\fIformat\fR\fR] [\fB\-F\ \fR\fB\fIformat\fR\fR] [\fB\-J\ \fR\fB\fIfilename\fR\fR] [\fB\-i\ \fR\fB\fImode\fR\fR] [\fB\-k\ \fR\fB\fImode\fR\fR] [\fB\-m\ \fR\fB\fImode\fR\fR] [\fB\-n\ \fR\fB\fImode\fR\fR] [\fB\-l\ \fR\fB\fIttl\fR\fR] [\fB\-L\ \fR\fB\fIserial\fR\fR] [\fB\-r\ \fR\fB\fImode\fR\fR] [\fB\-s\ \fR\fB\fIstyle\fR\fR] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] [\fB\-T\ \fR\fB\fImode\fR\fR] [\fB\-w\ \fR\fB\fIdirectory\fR\fR] [\fB\-D\fR] [\fB\-W\ \fR\fB\fImode\fR\fR] {\fB\-o\ \fR\fB\fIfilename\fR\fR} {zonename} {filename}
41 .SH "DESCRIPTION"
42 .PP
43 \fBnamed\-checkzone\fR
44 checks the syntax and integrity of a zone file. It performs the same checks as
45 \fBnamed\fR
46 does when loading a zone. This makes
47 \fBnamed\-checkzone\fR
48 useful for checking zone files before configuring them into a name server.
49 .PP
50 \fBnamed\-compilezone\fR
51 is similar to
52 \fBnamed\-checkzone\fR, 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
53 \fBnamed\fR. When manually specified otherwise, the check levels must at least be as strict as those specified in the
54 \fBnamed\fR
55 configuration file.
56 .SH "OPTIONS"
57 .PP
58 \-d
59 .RS 4
60 Enable debugging.
61 .RE
62 .PP
63 \-h
64 .RS 4
65 Print the usage summary and exit.
66 .RE
67 .PP
68 \-q
69 .RS 4
70 Quiet mode \- exit code only.
71 .RE
72 .PP
73 \-v
74 .RS 4
75 Print the version of the
76 \fBnamed\-checkzone\fR
77 program and exit.
78 .RE
79 .PP
80 \-j
81 .RS 4
82 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
83 \fI.jnl\fR.
84 .RE
85 .PP
86 \-J \fIfilename\fR
87 .RS 4
88 When loading the zone file read the journal from the given file, if it exists. (Implies \-j.)
89 .RE
90 .PP
91 \-c \fIclass\fR
92 .RS 4
93 Specify the class of the zone. If not specified, "IN" is assumed.
94 .RE
95 .PP
96 \-i \fImode\fR
97 .RS 4
98 Perform post\-load zone integrity checks. Possible modes are
99 \fB"full"\fR
100 (default),
101 \fB"full\-sibling"\fR,
102 \fB"local"\fR,
103 \fB"local\-sibling"\fR
104 and
105 \fB"none"\fR.
106 .sp
107 Mode
108 \fB"full"\fR
109 checks that MX records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames). Mode
110 \fB"local"\fR
111 only checks MX records which refer to in\-zone hostnames.
112 .sp
113 Mode
114 \fB"full"\fR
115 checks that SRV records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames). Mode
116 \fB"local"\fR
117 only checks SRV records which refer to in\-zone hostnames.
118 .sp
119 Mode
120 \fB"full"\fR
121 checks that delegation NS records refer to A or AAAA record (both in\-zone and out\-of\-zone hostnames). It also checks that glue address records in the zone match those advertised by the child. Mode
122 \fB"local"\fR
123 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.
124 .sp
125 Mode
126 \fB"full\-sibling"\fR
127 and
128 \fB"local\-sibling"\fR
129 disable sibling glue checks but are otherwise the same as
130 \fB"full"\fR
131 and
132 \fB"local"\fR
133 respectively.
134 .sp
135 Mode
136 \fB"none"\fR
137 disables the checks.
138 .RE
139 .PP
140 \-f \fIformat\fR
141 .RS 4
142 Specify the format of the zone file. Possible formats are
143 \fB"text"\fR
144 (default),
145 \fB"raw"\fR, and
146 \fB"map"\fR.
147 .RE
148 .PP
149 \-F \fIformat\fR
150 .RS 4
151 Specify the format of the output file specified. For
152 \fBnamed\-checkzone\fR, this does not cause any effects unless it dumps the zone contents.
153 .sp
154 Possible formats are
155 \fB"text"\fR
156 (default), which is the standard textual representation of the zone, and
157 \fB"map"\fR,
158 \fB"raw"\fR, and
159 \fB"raw=N"\fR, which store the zone in a binary format for rapid loading by
160 \fBnamed\fR.
161 \fB"raw=N"\fR
162 specifies the format version of the raw zone file: if N is 0, the raw file can be read by any version of
163 \fBnamed\fR; if N is 1, the file can be read by release 9.9.0 or higher; the default is 1.
164 .RE
165 .PP
166 \-k \fImode\fR
167 .RS 4
168 Perform
169 \fB"check\-names"\fR
170 checks with the specified failure mode. Possible modes are
171 \fB"fail"\fR
172 (default for
173 \fBnamed\-compilezone\fR),
174 \fB"warn"\fR
175 (default for
176 \fBnamed\-checkzone\fR) and
177 \fB"ignore"\fR.
178 .RE
179 .PP
180 \-l \fIttl\fR
181 .RS 4
182 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
183 \fBmax\-zone\-ttl\fR
184 option in
185 \fInamed.conf\fR.
186 .RE
187 .PP
188 \-L \fIserial\fR
189 .RS 4
190 When compiling a zone to "raw" or "map" format, set the "source serial" value in the header to the specified serial number. (This is expected to be used primarily for testing purposes.)
191 .RE
192 .PP
193 \-m \fImode\fR
194 .RS 4
195 Specify whether MX records should be checked to see if they are addresses. Possible modes are
196 \fB"fail"\fR,
197 \fB"warn"\fR
198 (default) and
199 \fB"ignore"\fR.
200 .RE
201 .PP
202 \-M \fImode\fR
203 .RS 4
204 Check if a MX record refers to a CNAME. Possible modes are
205 \fB"fail"\fR,
206 \fB"warn"\fR
207 (default) and
208 \fB"ignore"\fR.
209 .RE
210 .PP
211 \-n \fImode\fR
212 .RS 4
213 Specify whether NS records should be checked to see if they are addresses. Possible modes are
214 \fB"fail"\fR
215 (default for
216 \fBnamed\-compilezone\fR),
217 \fB"warn"\fR
218 (default for
219 \fBnamed\-checkzone\fR) and
220 \fB"ignore"\fR.
221 .RE
222 .PP
223 \-o \fIfilename\fR
224 .RS 4
225 Write zone output to
226 \fIfilename\fR. If
227 \fIfilename\fR
228 is
229 \fI\-\fR
230 then write to standard out. This is mandatory for
231 \fBnamed\-compilezone\fR.
232 .RE
233 .PP
234 \-r \fImode\fR
235 .RS 4
236 Check for records that are treated as different by DNSSEC but are semantically equal in plain DNS. Possible modes are
237 \fB"fail"\fR,
238 \fB"warn"\fR
239 (default) and
240 \fB"ignore"\fR.
241 .RE
242 .PP
243 \-s \fIstyle\fR
244 .RS 4
245 Specify the style of the dumped zone file. Possible styles are
246 \fB"full"\fR
247 (default) and
248 \fB"relative"\fR. The full format is most suitable for processing automatically by a separate script. On the other hand, the relative format is more human\-readable and is thus suitable for editing by hand. For
249 \fBnamed\-checkzone\fR
250 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.
251 .RE
252 .PP
253 \-S \fImode\fR
254 .RS 4
255 Check if a SRV record refers to a CNAME. Possible modes are
256 \fB"fail"\fR,
257 \fB"warn"\fR
258 (default) and
259 \fB"ignore"\fR.
260 .RE
261 .PP
262 \-t \fIdirectory\fR
263 .RS 4
264 Chroot to
265 \fIdirectory\fR
266 so that include directives in the configuration file are processed as if run by a similarly chrooted named.
267 .RE
268 .PP
269 \-T \fImode\fR
270 .RS 4
271 Check if Sender Policy Framework (SPF) records exist and issues a warning if an SPF\-formatted TXT record is not also present. Possible modes are
272 \fB"warn"\fR
273 (default),
274 \fB"ignore"\fR.
275 .RE
276 .PP
277 \-w \fIdirectory\fR
278 .RS 4
279 chdir to
280 \fIdirectory\fR
281 so that relative filenames in master file $INCLUDE directives work. This is similar to the directory clause in
282 \fInamed.conf\fR.
283 .RE
284 .PP
285 \-D
286 .RS 4
287 Dump zone file in canonical format. This is always enabled for
288 \fBnamed\-compilezone\fR.
289 .RE
290 .PP
291 \-W \fImode\fR
292 .RS 4
293 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
294 \fB"warn"\fR
295 (default) and
296 \fB"ignore"\fR.
297 .RE
298 .PP
299 zonename
300 .RS 4
301 The domain name of the zone being checked.
302 .RE
303 .PP
304 filename
305 .RS 4
306 The name of the zone file.
307 .RE
308 .SH "RETURN VALUES"
309 .PP
310 \fBnamed\-checkzone\fR
311 returns an exit status of 1 if errors were detected and 0 otherwise.
312 .SH "SEE ALSO"
313 .PP
314 \fBnamed\fR(8),
315 \fBnamed\-checkconf\fR(8),
316 RFC 1035,
317 BIND 9 Administrator Reference Manual.
318 .SH "AUTHOR"
319 .PP
320 Internet Systems Consortium
321 .SH "COPYRIGHT"
322 Copyright \(co 2004\-2007, 2009\-2014 Internet Systems Consortium, Inc. ("ISC")
323 .br
324 Copyright \(co 2000\-2002 Internet Software Consortium.
325 .br