options 17.3 KB
Newer Older
1

Andreas Gustafsson's avatar
Andreas Gustafsson committed
2 3
This is a summary of the named.conf options supported by 
this version of BIND 9.
Andreas Gustafsson's avatar
created  
Andreas Gustafsson committed
4 5

options {
6 7
        avoid-v4-udp-ports { <port>; ... };
        avoid-v6-udp-ports { <port>; ... };
8 9 10 11 12 13 14 15 16 17
        blackhole { <address_match_element>; ... };
        coresize <size>;
        datasize <size>;
        deallocate-on-exit <boolean>; // obsolete
        directory <quoted_string>;
        dump-file <quoted_string>;
        fake-iquery <boolean>; // obsolete
        files <size>;
        has-old-clients <boolean>; // obsolete
        heartbeat-interval <integer>;
Andreas Gustafsson's avatar
Andreas Gustafsson committed
18
        host-statistics <boolean>; // not implemented
Mark Andrews's avatar
regen  
Mark Andrews committed
19
        host-statistics-max <integer>; // not implemented
Andreas Gustafsson's avatar
Andreas Gustafsson committed
20
        hostname ( <quoted_string> | none );
21 22 23 24 25 26 27
        interface-interval <integer>;
        listen-on [ port <integer> ] { <address_match_element>; ... };
        listen-on-v6 [ port <integer> ] { <address_match_element>; ... };
        match-mapped-addresses <boolean>;
        memstatistics-file <quoted_string>;
        multiple-cnames <boolean>; // obsolete
        named-xfer <quoted_string>; // obsolete
Andreas Gustafsson's avatar
Andreas Gustafsson committed
28
        pid-file ( <quoted_string> | none );
29
        port <integer>;
Mark Andrews's avatar
regen  
Mark Andrews committed
30
        querylog <boolean>;
31
        recursing-file <quoted_string>;
32 33 34 35
        random-device <quoted_string>;
        recursive-clients <integer>;
        serial-queries <integer>; // obsolete
        serial-query-rate <integer>;
36
        server-id ( <quoted_string> | none |;
37 38 39 40
        stacksize <size>;
        statistics-file <quoted_string>;
        statistics-interval <integer>; // not yet implemented
        tcp-clients <integer>;
41
        tcp-listen-queue <integer>;
42 43 44 45 46 47 48 49 50
        tkey-dhkey <quoted_string> <integer>;
        tkey-gssapi-credential <quoted_string>;
        tkey-domain <quoted_string>;
        transfers-per-ns <integer>;
        transfers-in <integer>;
        transfers-out <integer>;
        treat-cr-as-space <boolean>; // obsolete
        use-id-pool <boolean>; // obsolete
        use-ixfr <boolean>;
Andreas Gustafsson's avatar
Andreas Gustafsson committed
51
        version ( <quoted_string> | none );
Mark Andrews's avatar
regen  
Mark Andrews committed
52
        allow-query-cache { <address_match_element>; ... };
53
        allow-recursion { <address_match_element>; ... };
54
        allow-v6-synthesis { <address_match_element>; ... }; // obsolete
55 56 57 58 59
        sortlist { <address_match_element>; ... };
        topology { <address_match_element>; ... }; // not implemented
        auth-nxdomain <boolean>; // default changed
        minimal-responses <boolean>;
        recursion <boolean>;
60 61
        rrset-order { [ class <string> ] [ type <string> ] [ name
            <quoted_string> ] <string> <string>; ... };
62 63 64 65 66 67 68 69 70 71 72 73 74
        provide-ixfr <boolean>;
        request-ixfr <boolean>;
        fetch-glue <boolean>; // obsolete
        rfc2308-type1 <boolean>; // not yet implemented
        additional-from-auth <boolean>;
        additional-from-cache <boolean>;
        query-source <querysource4>;
        query-source-v6 <querysource6>;
        cleaning-interval <integer>;
        min-roots <integer>; // not implemented
        lame-ttl <integer>;
        max-ncache-ttl <integer>;
        max-cache-ttl <integer>;
Andreas Gustafsson's avatar
Andreas Gustafsson committed
75
        transfer-format ( many-answers | one-answer );
Andreas Gustafsson's avatar
Andreas Gustafsson committed
76
        max-cache-size <size_no_default>;
Mark Andrews's avatar
regen  
Mark Andrews committed
77
        check-names ( master | slave | response ) ( fail | warn | ignore );
78
        cache-file <quoted_string>;
79
        suppress-initial-notify <boolean>; // not yet implemented
80 81 82 83
        preferred-glue <string>;
        dual-stack-servers [ port <integer> ] { ( <quoted_string> [port
            <integer>] | <ipv4_address> [port <integer>] | <ipv6_address> [port <integer>] ); ... };
        edns-udp-size <integer>;
Mark Andrews's avatar
Mark Andrews committed
84
        root-delegation-only [ exclude { <quoted_string>; ... } ];
85
        disable-algorithms <string> { <string>; ... };
Mark Andrews's avatar
Mark Andrews committed
86
        dnssec-enable <boolean>;
87
        dnssec-lookaside <string> trust-anchor <string>;
Mark Andrews's avatar
regen  
Mark Andrews committed
88
        dnssec-must-be-secure <string> <boolean>;
Mark Andrews's avatar
regen  
Mark Andrews committed
89
        ixfr-from-differences <ixfrdiff>;
Mark Andrews's avatar
regen  
Mark Andrews committed
90 91 92
        use-additional-cache <boolean>;
        acache-cleaning-interval <integer>;
        max-acache-size <size_no_default>;
93 94
        allow-query { <address_match_element>; ... };
        allow-transfer { <address_match_element>; ... };
Mark Andrews's avatar
regen  
Mark Andrews committed
95
        allow-update { <address_match_element>; ... };
96 97
        allow-update-forwarding { <address_match_element>; ... };
        allow-notify { <address_match_element>; ... };
98
        notify <notifytype>;
99 100
        notify-source ( <ipv4_address> | * ) [ port ( <integer> | * ) ];
        notify-source-v6 ( <ipv6_address> | * ) [ port ( <integer> | * ) ];
Andreas Gustafsson's avatar
Andreas Gustafsson committed
101 102
        also-notify [ port <integer> ] { ( <ipv4_address> | <ipv6_address>
            ) [ port <integer> ]; ... };
103 104
        dialup <dialuptype>;
        forward ( first | only );
Andreas Gustafsson's avatar
Andreas Gustafsson committed
105 106
        forwarders [ port <integer> ] { ( <ipv4_address> | <ipv6_address> )
            [ port <integer> ]; ... };
Andreas Gustafsson's avatar
Andreas Gustafsson committed
107
        maintain-ixfr-base <boolean>; // obsolete
108
        max-ixfr-log-size <size>; // obsolete
109
        max-journal-size <size_no_default>;
110 111 112 113 114 115 116 117
        max-transfer-time-in <integer>;
        max-transfer-time-out <integer>;
        max-transfer-idle-in <integer>;
        max-transfer-idle-out <integer>;
        max-retry-time <integer>;
        min-retry-time <integer>;
        max-refresh-time <integer>;
        min-refresh-time <integer>;
118
        multi-master <boolean>;
119
        sig-validity-interval <integer>;
120 121 122 123 124 125 126
        transfer-source ( <ipv4_address> | * ) [ port ( <integer> | * ) ];
        transfer-source-v6 ( <ipv6_address> | * ) [ port ( <integer> | * ) ];
        alt-transfer-source ( <ipv4_address> | * ) [ port ( <integer> | * )
            ];
        alt-transfer-source-v6 ( <ipv6_address> | * ) [ port ( <integer> |
            * ) ];
        use-alt-transfer-source <boolean>;
127
        zone-statistics <boolean>;
Mark Andrews's avatar
regen  
Mark Andrews committed
128
        key-directory <quoted_string>;
Andreas Gustafsson's avatar
created  
Andreas Gustafsson committed
129 130
};

131
controls {
Andreas Gustafsson's avatar
Andreas Gustafsson committed
132 133
        inet ( <ipv4_address> | <ipv6_address> | * ) [ port ( <integer> | *
            ) ] allow { <address_match_element>; ... } [ keys { <string>; ... } ];
134
        unix <unsupported>; // not implemented
135
};
Andreas Gustafsson's avatar
created  
Andreas Gustafsson committed
136

137
acl <string> { <address_match_element>; ... };
Andreas Gustafsson's avatar
created  
Andreas Gustafsson committed
138

139 140 141
masters <string> [ port <integer> ] { ( <masters> | <ipv4_address> [port
    <integer>] | <ipv6_address> [port <integer>] ) [ key <string> ]; ... };

142
logging {
Andreas Gustafsson's avatar
Andreas Gustafsson committed
143
        channel <string> {
144
                file <log_file>;
145 146 147
                syslog <optional_facility>;
                null;
                stderr;
148
                severity <log_severity>;
149 150 151 152 153
                print-time <boolean>;
                print-severity <boolean>;
                print-category <boolean>;
        };
        category <string> { <string>; ... };
Andreas Gustafsson's avatar
created  
Andreas Gustafsson committed
154 155
};

156 157 158 159
view <string> <optional_class> {
        match-clients { <address_match_element>; ... };
        match-destinations { <address_match_element>; ... };
        match-recursive-only <boolean>;
Andreas Gustafsson's avatar
Andreas Gustafsson committed
160
        key <string> {
161 162 163 164
                algorithm <string>;
                secret <string>;
        };
        zone <string> <optional_class> {
Mark Andrews's avatar
Mark Andrews committed
165 166
                type ( master | slave | stub | hint | forward |
                    delegation-only );
167
                file <quoted_string>;
Mark Andrews's avatar
regen  
Mark Andrews committed
168
                journal <quoted_string>;
169 170
                ixfr-base <quoted_string>; // obsolete
                ixfr-tmp-file <quoted_string>; // obsolete
171 172
                masters [ port <integer> ] { ( <masters> | <ipv4_address>
                    [port <integer>] | <ipv6_address> [port <integer>] ) [ key <string> ]; ... };
173 174 175 176 177
                pubkey <integer> <integer> <integer> <quoted_string>; //
                    obsolete
                update-policy { ( grant | deny ) <string> ( name |
                    subdomain | wildcard | self ) <string> <rrtypelist>; ... };
                database <string>;
Mark Andrews's avatar
Mark Andrews committed
178
                delegation-only <boolean>;
Mark Andrews's avatar
regen  
Mark Andrews committed
179
                check-names ( fail | warn | ignore );
Mark Andrews's avatar
regen  
Mark Andrews committed
180
                ixfr-from-differences <boolean>;
181 182
                allow-query { <address_match_element>; ... };
                allow-transfer { <address_match_element>; ... };
Mark Andrews's avatar
regen  
Mark Andrews committed
183
                allow-update { <address_match_element>; ... };
184 185
                allow-update-forwarding { <address_match_element>; ... };
                allow-notify { <address_match_element>; ... };
186
                notify <notifytype>;
187 188 189 190
                notify-source ( <ipv4_address> | * ) [ port ( <integer> | *
                    ) ];
                notify-source-v6 ( <ipv6_address> | * ) [ port ( <integer>
                    | * ) ];
Andreas Gustafsson's avatar
Andreas Gustafsson committed
191 192
                also-notify [ port <integer> ] { ( <ipv4_address> |
                    <ipv6_address> ) [ port <integer> ]; ... };
193 194
                dialup <dialuptype>;
                forward ( first | only );
Andreas Gustafsson's avatar
Andreas Gustafsson committed
195 196
                forwarders [ port <integer> ] { ( <ipv4_address> |
                    <ipv6_address> ) [ port <integer> ]; ... };
Andreas Gustafsson's avatar
Andreas Gustafsson committed
197
                maintain-ixfr-base <boolean>; // obsolete
198
                max-ixfr-log-size <size>; // obsolete
199
                max-journal-size <size_no_default>;
200 201 202 203 204 205 206 207
                max-transfer-time-in <integer>;
                max-transfer-time-out <integer>;
                max-transfer-idle-in <integer>;
                max-transfer-idle-out <integer>;
                max-retry-time <integer>;
                min-retry-time <integer>;
                max-refresh-time <integer>;
                min-refresh-time <integer>;
208
                multi-master <boolean>;
209
                sig-validity-interval <integer>;
210 211 212 213 214 215 216 217 218
                transfer-source ( <ipv4_address> | * ) [ port ( <integer> |
                    * ) ];
                transfer-source-v6 ( <ipv6_address> | * ) [ port (
                    <integer> | * ) ];
                alt-transfer-source ( <ipv4_address> | * ) [ port (
                    <integer> | * ) ];
                alt-transfer-source-v6 ( <ipv6_address> | * ) [ port (
                    <integer> | * ) ];
                use-alt-transfer-source <boolean>;
219
                zone-statistics <boolean>;
Mark Andrews's avatar
regen  
Mark Andrews committed
220
                key-directory <quoted_string>;
221
        };
Mark Andrews's avatar
regen  
Mark Andrews committed
222
        server ( <ipv4_address> | <ipv6_address> ) {
223 224 225 226 227 228 229 230
                bogus <boolean>;
                provide-ixfr <boolean>;
                request-ixfr <boolean>;
                support-ixfr <boolean>; // obsolete
                transfers <integer>;
                transfer-format ( many-answers | one-answer );
                keys <server_key>;
                edns <boolean>;
Mark Andrews's avatar
Mark Andrews committed
231 232 233 234
                transfer-source ( <ipv4_address> | * ) [ port ( <integer> |
                    * ) ];
                transfer-source-v6 ( <ipv6_address> | * ) [ port (
                    <integer> | * ) ];
235 236 237
        };
        trusted-keys { <string> <integer> <integer> <integer>
            <quoted_string>; ... };
Mark Andrews's avatar
regen  
Mark Andrews committed
238
        allow-query-cache { <address_match_element>; ... };
239
        allow-recursion { <address_match_element>; ... };
240
        allow-v6-synthesis { <address_match_element>; ... }; // obsolete
241 242 243 244 245
        sortlist { <address_match_element>; ... };
        topology { <address_match_element>; ... }; // not implemented
        auth-nxdomain <boolean>; // default changed
        minimal-responses <boolean>;
        recursion <boolean>;
246 247
        rrset-order { [ class <string> ] [ type <string> ] [ name
            <quoted_string> ] <string> <string>; ... };
248 249 250 251 252 253 254 255 256 257 258 259 260
        provide-ixfr <boolean>;
        request-ixfr <boolean>;
        fetch-glue <boolean>; // obsolete
        rfc2308-type1 <boolean>; // not yet implemented
        additional-from-auth <boolean>;
        additional-from-cache <boolean>;
        query-source <querysource4>;
        query-source-v6 <querysource6>;
        cleaning-interval <integer>;
        min-roots <integer>; // not implemented
        lame-ttl <integer>;
        max-ncache-ttl <integer>;
        max-cache-ttl <integer>;
Andreas Gustafsson's avatar
Andreas Gustafsson committed
261
        transfer-format ( many-answers | one-answer );
Andreas Gustafsson's avatar
Andreas Gustafsson committed
262
        max-cache-size <size_no_default>;
Mark Andrews's avatar
regen  
Mark Andrews committed
263
        check-names ( master | slave | response ) ( fail | warn | ignore );
264
        cache-file <quoted_string>;
265
        suppress-initial-notify <boolean>; // not yet implemented
266 267 268 269
        preferred-glue <string>;
        dual-stack-servers [ port <integer> ] { ( <quoted_string> [port
            <integer>] | <ipv4_address> [port <integer>] | <ipv6_address> [port <integer>] ); ... };
        edns-udp-size <integer>;
Mark Andrews's avatar
Mark Andrews committed
270
        root-delegation-only [ exclude { <quoted_string>; ... } ];
271
        disable-algorithms <string> { <string>; ... };
Mark Andrews's avatar
Mark Andrews committed
272
        dnssec-enable <boolean>;
273
        dnssec-lookaside <string> trust-anchor <string>;
Mark Andrews's avatar
regen  
Mark Andrews committed
274
        dnssec-must-be-secure <string> <boolean>;
Mark Andrews's avatar
regen  
Mark Andrews committed
275
        ixfr-from-differences <ixfrdiff>;
Mark Andrews's avatar
regen  
Mark Andrews committed
276 277 278
        use-additional-cache <boolean>;
        acache-cleaning-interval <integer>;
        max-acache-size <size_no_default>;
279 280
        allow-query { <address_match_element>; ... };
        allow-transfer { <address_match_element>; ... };
Mark Andrews's avatar
regen  
Mark Andrews committed
281
        allow-update { <address_match_element>; ... };
282 283
        allow-update-forwarding { <address_match_element>; ... };
        allow-notify { <address_match_element>; ... };
284
        notify <notifytype>;
285 286
        notify-source ( <ipv4_address> | * ) [ port ( <integer> | * ) ];
        notify-source-v6 ( <ipv6_address> | * ) [ port ( <integer> | * ) ];
Andreas Gustafsson's avatar
Andreas Gustafsson committed
287 288
        also-notify [ port <integer> ] { ( <ipv4_address> | <ipv6_address>
            ) [ port <integer> ]; ... };
289 290
        dialup <dialuptype>;
        forward ( first | only );
Andreas Gustafsson's avatar
Andreas Gustafsson committed
291 292
        forwarders [ port <integer> ] { ( <ipv4_address> | <ipv6_address> )
            [ port <integer> ]; ... };
Andreas Gustafsson's avatar
Andreas Gustafsson committed
293
        maintain-ixfr-base <boolean>; // obsolete
294
        max-ixfr-log-size <size>; // obsolete
295
        max-journal-size <size_no_default>;
296 297 298 299 300 301 302 303
        max-transfer-time-in <integer>;
        max-transfer-time-out <integer>;
        max-transfer-idle-in <integer>;
        max-transfer-idle-out <integer>;
        max-retry-time <integer>;
        min-retry-time <integer>;
        max-refresh-time <integer>;
        min-refresh-time <integer>;
304
        multi-master <boolean>;
305
        sig-validity-interval <integer>;
306 307 308 309 310 311 312
        transfer-source ( <ipv4_address> | * ) [ port ( <integer> | * ) ];
        transfer-source-v6 ( <ipv6_address> | * ) [ port ( <integer> | * ) ];
        alt-transfer-source ( <ipv4_address> | * ) [ port ( <integer> | * )
            ];
        alt-transfer-source-v6 ( <ipv6_address> | * ) [ port ( <integer> |
            * ) ];
        use-alt-transfer-source <boolean>;
313
        zone-statistics <boolean>;
Mark Andrews's avatar
regen  
Mark Andrews committed
314
        key-directory <quoted_string>;
Andreas Gustafsson's avatar
created  
Andreas Gustafsson committed
315 316
};

317
lwres {
Andreas Gustafsson's avatar
Andreas Gustafsson committed
318 319
        listen-on [ port <integer> ] { ( <ipv4_address> | <ipv6_address> )
            [ port <integer> ]; ... };
320 321 322
        view <string> <optional_class>;
        search { <string>; ... };
        ndots <integer>;
323 324
};

Andreas Gustafsson's avatar
Andreas Gustafsson committed
325
key <string> {
326 327
        algorithm <string>;
        secret <string>;
Andreas Gustafsson's avatar
created  
Andreas Gustafsson committed
328 329
};

330
zone <string> <optional_class> {
Mark Andrews's avatar
Mark Andrews committed
331
        type ( master | slave | stub | hint | forward | delegation-only );
332
        file <quoted_string>;
Mark Andrews's avatar
regen  
Mark Andrews committed
333
        journal <quoted_string>;
334 335
        ixfr-base <quoted_string>; // obsolete
        ixfr-tmp-file <quoted_string>; // obsolete
336 337
        masters [ port <integer> ] { ( <masters> | <ipv4_address> [port
            <integer>] | <ipv6_address> [port <integer>] ) [ key <string> ]; ... };
338 339 340 341
        pubkey <integer> <integer> <integer> <quoted_string>; // obsolete
        update-policy { ( grant | deny ) <string> ( name | subdomain |
            wildcard | self ) <string> <rrtypelist>; ... };
        database <string>;
Mark Andrews's avatar
Mark Andrews committed
342
        delegation-only <boolean>;
Mark Andrews's avatar
regen  
Mark Andrews committed
343
        check-names ( fail | warn | ignore );
Mark Andrews's avatar
regen  
Mark Andrews committed
344
        ixfr-from-differences <boolean>;
345 346
        allow-query { <address_match_element>; ... };
        allow-transfer { <address_match_element>; ... };
Mark Andrews's avatar
regen  
Mark Andrews committed
347
        allow-update { <address_match_element>; ... };
348 349
        allow-update-forwarding { <address_match_element>; ... };
        allow-notify { <address_match_element>; ... };
350
        notify <notifytype>;
351 352
        notify-source ( <ipv4_address> | * ) [ port ( <integer> | * ) ];
        notify-source-v6 ( <ipv6_address> | * ) [ port ( <integer> | * ) ];
Andreas Gustafsson's avatar
Andreas Gustafsson committed
353 354
        also-notify [ port <integer> ] { ( <ipv4_address> | <ipv6_address>
            ) [ port <integer> ]; ... };
355 356
        dialup <dialuptype>;
        forward ( first | only );
Andreas Gustafsson's avatar
Andreas Gustafsson committed
357 358
        forwarders [ port <integer> ] { ( <ipv4_address> | <ipv6_address> )
            [ port <integer> ]; ... };
Andreas Gustafsson's avatar
Andreas Gustafsson committed
359
        maintain-ixfr-base <boolean>; // obsolete
360
        max-ixfr-log-size <size>; // obsolete
361
        max-journal-size <size_no_default>;
362 363 364 365 366 367 368 369
        max-transfer-time-in <integer>;
        max-transfer-time-out <integer>;
        max-transfer-idle-in <integer>;
        max-transfer-idle-out <integer>;
        max-retry-time <integer>;
        min-retry-time <integer>;
        max-refresh-time <integer>;
        min-refresh-time <integer>;
370
        multi-master <boolean>;
371
        sig-validity-interval <integer>;
372 373 374 375 376 377 378
        transfer-source ( <ipv4_address> | * ) [ port ( <integer> | * ) ];
        transfer-source-v6 ( <ipv6_address> | * ) [ port ( <integer> | * ) ];
        alt-transfer-source ( <ipv4_address> | * ) [ port ( <integer> | * )
            ];
        alt-transfer-source-v6 ( <ipv6_address> | * ) [ port ( <integer> |
            * ) ];
        use-alt-transfer-source <boolean>;
379
        zone-statistics <boolean>;
Mark Andrews's avatar
regen  
Mark Andrews committed
380
        key-directory <quoted_string>;
Andreas Gustafsson's avatar
created  
Andreas Gustafsson committed
381
};
382

Mark Andrews's avatar
regen  
Mark Andrews committed
383
server ( <ipv4_address> | <ipv6_address> ) {
384 385 386 387 388 389 390 391
        bogus <boolean>;
        provide-ixfr <boolean>;
        request-ixfr <boolean>;
        support-ixfr <boolean>; // obsolete
        transfers <integer>;
        transfer-format ( many-answers | one-answer );
        keys <server_key>;
        edns <boolean>;
Mark Andrews's avatar
Mark Andrews committed
392 393
        transfer-source ( <ipv4_address> | * ) [ port ( <integer> | * ) ];
        transfer-source-v6 ( <ipv6_address> | * ) [ port ( <integer> | * ) ];
394
};
395 396 397

trusted-keys { <string> <integer> <integer> <integer> <quoted_string>; ... };