contrib/bind9/doc/misc/options

   1
   2 This is a summary of the named.conf options supported by
   3 this version of BIND 9.
   4
   5 options {
   6         avoid-v4-udp-ports { <port>; ... };
   7         avoid-v6-udp-ports { <port>; ... };
   8         blackhole { <address_match_element>; ... };
   9         coresize <size>;
  10         datasize <size>;
  11         deallocate-on-exit <boolean>; // obsolete
  12         directory <quoted_string>;
  13         dump-file <quoted_string>;
  14         fake-iquery <boolean>; // obsolete
  15         files <size>;
  16         has-old-clients <boolean>; // obsolete
  17         heartbeat-interval <integer>;
  18         host-statistics <boolean>; // not implemented
  19         host-statistics-max <integer>; // not implemented
  20         hostname ( <quoted_string> | none );
  21         interface-interval <integer>;
  22         listen-on [ port <integer> ] { <address_match_element>; ... };
  23         listen-on-v6 [ port <integer> ] { <address_match_element>; ... };
  24         match-mapped-addresses <boolean>;
  25         memstatistics-file <quoted_string>;
  26         multiple-cnames <boolean>; // obsolete
  27         named-xfer <quoted_string>; // obsolete
  28         pid-file ( <quoted_string> | none );
  29         port <integer>;
  30         querylog <boolean>;
  31         recursing-file <quoted_string>;
  32         random-device <quoted_string>;
  33         recursive-clients <integer>;
  34         serial-queries <integer>; // obsolete
  35         serial-query-rate <integer>;
  36         server-id ( <quoted_string> | none |;
  37         stacksize <size>;
  38         statistics-file <quoted_string>;
  39         statistics-interval <integer>; // not yet implemented
  40         tcp-clients <integer>;
  41         tcp-listen-queue <integer>;
  42         tkey-dhkey <quoted_string> <integer>;
  43         tkey-gssapi-credential <quoted_string>;
  44         tkey-domain <quoted_string>;
  45         transfers-per-ns <integer>;
  46         transfers-in <integer>;
  47         transfers-out <integer>;
  48         treat-cr-as-space <boolean>; // obsolete
  49         use-id-pool <boolean>; // obsolete
  50         use-ixfr <boolean>;
  51         version ( <quoted_string> | none );
  52         flush-zones-on-shutdown <boolean>;
  53         allow-query-cache { <address_match_element>; ... };
  54         allow-recursion { <address_match_element>; ... };
  55         allow-v6-synthesis { <address_match_element>; ... }; // obsolete
  56         sortlist { <address_match_element>; ... };
  57         topology { <address_match_element>; ... }; // not implemented
  58         auth-nxdomain <boolean>; // default changed
  59         minimal-responses <boolean>;
  60         recursion <boolean>;
  61         rrset-order { [ class <string> ] [ type <string> ] [ name
  62             <quoted_string> ] <string> <string>; ... };
  63         provide-ixfr <boolean>;
  64         request-ixfr <boolean>;
  65         fetch-glue <boolean>; // obsolete
  66         rfc2308-type1 <boolean>; // not yet implemented
  67         additional-from-auth <boolean>;
  68         additional-from-cache <boolean>;
  69         query-source <querysource4>;
  70         query-source-v6 <querysource6>;
  71         cleaning-interval <integer>;
  72         min-roots <integer>; // not implemented
  73         lame-ttl <integer>;
  74         max-ncache-ttl <integer>;
  75         max-cache-ttl <integer>;
  76         transfer-format ( many-answers | one-answer );
  77         max-cache-size <size_no_default>;
  78         check-names ( master | slave | response ) ( fail | warn | ignore );
  79         cache-file <quoted_string>;
  80         suppress-initial-notify <boolean>; // not yet implemented
  81         preferred-glue <string>;
  82         dual-stack-servers [ port <integer> ] { ( <quoted_string> [port
  83             <integer>] | <ipv4_address> [port <integer>] | <ipv6_address> [port <integer>] ); ... };
  84         edns-udp-size <integer>;
  85         max-udp-size <integer>;
  86         root-delegation-only [ exclude { <quoted_string>; ... } ];
  87         disable-algorithms <string> { <string>; ... };
  88         dnssec-enable <boolean>;
  89         dnssec-validation <boolean>;
  90         dnssec-lookaside <string> trust-anchor <string>;
  91         dnssec-must-be-secure <string> <boolean>;
  92         dnssec-accept-expired <boolean>;
  93         ixfr-from-differences <ixfrdiff>;
  94         acache-enable <boolean>;
  95         acache-cleaning-interval <integer>;
  96         max-acache-size <size_no_default>;
  97         clients-per-query <integer>;
  98         max-clients-per-query <integer>;
  99         empty-server <string>;
 100         empty-contact <string>;
 101         empty-zones-enable <boolean>;
 102         disable-empty-zone <string>;
 103         zero-no-soa-ttl-cache <boolean>;
 104         allow-query { <address_match_element>; ... };
 105         allow-transfer { <address_match_element>; ... };
 106         allow-update { <address_match_element>; ... };
 107         allow-update-forwarding { <address_match_element>; ... };
 108         allow-notify { <address_match_element>; ... };
 109         masterfile-format ( text | raw );
 110         notify <notifytype>;
 111         notify-source ( <ipv4_address> | * ) [ port ( <integer> | * ) ];
 112         notify-source-v6 ( <ipv6_address> | * ) [ port ( <integer> | * ) ];
 113         also-notify [ port <integer> ] { ( <ipv4_address> | <ipv6_address>
 114             ) [ port <integer> ]; ... };
 115         notify-delay <integer>;
 116         dialup <dialuptype>;
 117         forward ( first | only );
 118         forwarders [ port <integer> ] { ( <ipv4_address> | <ipv6_address> )
 119             [ port <integer> ]; ... };
 120         maintain-ixfr-base <boolean>; // obsolete
 121         max-ixfr-log-size <size>; // obsolete
 122         max-journal-size <size_no_default>;
 123         max-transfer-time-in <integer>;
 124         max-transfer-time-out <integer>;
 125         max-transfer-idle-in <integer>;
 126         max-transfer-idle-out <integer>;
 127         max-retry-time <integer>;
 128         min-retry-time <integer>;
 129         max-refresh-time <integer>;
 130         min-refresh-time <integer>;
 131         multi-master <boolean>;
 132         sig-validity-interval <integer>;
 133         transfer-source ( <ipv4_address> | * ) [ port ( <integer> | * ) ];
 134         transfer-source-v6 ( <ipv6_address> | * ) [ port ( <integer> | * ) ];
 135         alt-transfer-source ( <ipv4_address> | * ) [ port ( <integer> | * )
 136             ];
 137         alt-transfer-source-v6 ( <ipv6_address> | * ) [ port ( <integer> |
 138             * ) ];
 139         use-alt-transfer-source <boolean>;
 140         zone-statistics <boolean>;
 141         key-directory <quoted_string>;
 142         check-wildcard <boolean>;
 143         check-integrity <boolean>;
 144         check-mx ( fail | warn | ignore );
 145         check-mx-cname ( fail | warn | ignore );
 146         check-srv-cname ( fail | warn | ignore );
 147         check-sibling <boolean>;
 148         zero-no-soa-ttl <boolean>;
 149         update-check-ksk <boolean>;
 150 };
 151
 152 controls {
 153         inet ( <ipv4_address> | <ipv6_address> | * ) [ port ( <integer> | *
 154             ) ] allow { <address_match_element>; ... } [ keys { <string>; ... } ];
 155         unix <quoted_string> perm <integer> owner <integer> group <integer>
 156             [ keys { <string>; ... } ];
 157 };
 158
 159 acl <string> { <address_match_element>; ... };
 160
 161 masters <string> [ port <integer> ] { ( <masters> | <ipv4_address> [port
 162     <integer>] | <ipv6_address> [port <integer>] ) [ key <string> ]; ... };
 163
 164 logging {
 165         channel <string> {
 166                 file <log_file>;
 167                 syslog <optional_facility>;
 168                 null;
 169                 stderr;
 170                 severity <log_severity>;
 171                 print-time <boolean>;
 172                 print-severity <boolean>;
 173                 print-category <boolean>;
 174         };
 175         category <string> { <string>; ... };
 176 };
 177
 178 view <string> <optional_class> {
 179         match-clients { <address_match_element>; ... };
 180         match-destinations { <address_match_element>; ... };
 181         match-recursive-only <boolean>;
 182         key <string> {
 183                 algorithm <string>;
 184                 secret <string>;
 185         };
 186         zone <string> <optional_class> {
 187                 type ( master | slave | stub | hint | forward |
 188                     delegation-only );
 189                 file <quoted_string>;
 190                 journal <quoted_string>;
 191                 ixfr-base <quoted_string>; // obsolete
 192                 ixfr-tmp-file <quoted_string>; // obsolete
 193                 masters [ port <integer> ] { ( <masters> | <ipv4_address>
 194                     [port <integer>] | <ipv6_address> [port <integer>] ) [ key <string> ]; ... };
 195                 pubkey <integer> <integer> <integer> <quoted_string>; //
 196                     obsolete
 197                 update-policy { ( grant | deny ) <string> ( name |
 198                     subdomain | wildcard | self | selfsub | selfwild ) <string> <rrtypelist>; ... };
 199                 database <string>;
 200                 delegation-only <boolean>;
 201                 check-names ( fail | warn | ignore );
 202                 ixfr-from-differences <boolean>;
 203                 allow-query { <address_match_element>; ... };
 204                 allow-transfer { <address_match_element>; ... };
 205                 allow-update { <address_match_element>; ... };
 206                 allow-update-forwarding { <address_match_element>; ... };
 207                 allow-notify { <address_match_element>; ... };
 208                 masterfile-format ( text | raw );
 209                 notify <notifytype>;
 210                 notify-source ( <ipv4_address> | * ) [ port ( <integer> | *
 211                     ) ];
 212                 notify-source-v6 ( <ipv6_address> | * ) [ port ( <integer>
 213                     | * ) ];
 214                 also-notify [ port <integer> ] { ( <ipv4_address> |
 215                     <ipv6_address> ) [ port <integer> ]; ... };
 216                 notify-delay <integer>;
 217                 dialup <dialuptype>;
 218                 forward ( first | only );
 219                 forwarders [ port <integer> ] { ( <ipv4_address> |
 220                     <ipv6_address> ) [ port <integer> ]; ... };
 221                 maintain-ixfr-base <boolean>; // obsolete
 222                 max-ixfr-log-size <size>; // obsolete
 223                 max-journal-size <size_no_default>;
 224                 max-transfer-time-in <integer>;
 225                 max-transfer-time-out <integer>;
 226                 max-transfer-idle-in <integer>;
 227                 max-transfer-idle-out <integer>;
 228                 max-retry-time <integer>;
 229                 min-retry-time <integer>;
 230                 max-refresh-time <integer>;
 231                 min-refresh-time <integer>;
 232                 multi-master <boolean>;
 233                 sig-validity-interval <integer>;
 234                 transfer-source ( <ipv4_address> | * ) [ port ( <integer> |
 235                     * ) ];
 236                 transfer-source-v6 ( <ipv6_address> | * ) [ port (
 237                     <integer> | * ) ];
 238                 alt-transfer-source ( <ipv4_address> | * ) [ port (
 239                     <integer> | * ) ];
 240                 alt-transfer-source-v6 ( <ipv6_address> | * ) [ port (
 241                     <integer> | * ) ];
 242                 use-alt-transfer-source <boolean>;
 243                 zone-statistics <boolean>;
 244                 key-directory <quoted_string>;
 245                 check-wildcard <boolean>;
 246                 check-integrity <boolean>;
 247                 check-mx ( fail | warn | ignore );
 248                 check-mx-cname ( fail | warn | ignore );
 249                 check-srv-cname ( fail | warn | ignore );
 250                 check-sibling <boolean>;
 251                 zero-no-soa-ttl <boolean>;
 252                 update-check-ksk <boolean>;
 253         };
 254         dlz <string> {
 255                 database <string>;
 256         };
 257         server <netprefix> {
 258                 bogus <boolean>;
 259                 provide-ixfr <boolean>;
 260                 request-ixfr <boolean>;
 261                 support-ixfr <boolean>; // obsolete
 262                 transfers <integer>;
 263                 transfer-format ( many-answers | one-answer );
 264                 keys <server_key>;
 265                 edns <boolean>;
 266                 edns-udp-size <integer>;
 267                 max-udp-size <integer>;
 268                 notify-source ( <ipv4_address> | * ) [ port ( <integer> | *
 269                     ) ];
 270                 notify-source-v6 ( <ipv6_address> | * ) [ port ( <integer>
 271                     | * ) ];
 272                 query-source <querysource4>;
 273                 query-source-v6 <querysource6>;
 274                 transfer-source ( <ipv4_address> | * ) [ port ( <integer> |
 275                     * ) ];
 276                 transfer-source-v6 ( <ipv6_address> | * ) [ port (
 277                     <integer> | * ) ];
 278         };
 279         trusted-keys { <string> <integer> <integer> <integer>
 280             <quoted_string>; ... };
 281         allow-query-cache { <address_match_element>; ... };
 282         allow-recursion { <address_match_element>; ... };
 283         allow-v6-synthesis { <address_match_element>; ... }; // obsolete
 284         sortlist { <address_match_element>; ... };
 285         topology { <address_match_element>; ... }; // not implemented
 286         auth-nxdomain <boolean>; // default changed
 287         minimal-responses <boolean>;
 288         recursion <boolean>;
 289         rrset-order { [ class <string> ] [ type <string> ] [ name
 290             <quoted_string> ] <string> <string>; ... };
 291         provide-ixfr <boolean>;
 292         request-ixfr <boolean>;
 293         fetch-glue <boolean>; // obsolete
 294         rfc2308-type1 <boolean>; // not yet implemented
 295         additional-from-auth <boolean>;
 296         additional-from-cache <boolean>;
 297         query-source <querysource4>;
 298         query-source-v6 <querysource6>;
 299         cleaning-interval <integer>;
 300         min-roots <integer>; // not implemented
 301         lame-ttl <integer>;
 302         max-ncache-ttl <integer>;
 303         max-cache-ttl <integer>;
 304         transfer-format ( many-answers | one-answer );
 305         max-cache-size <size_no_default>;
 306         check-names ( master | slave | response ) ( fail | warn | ignore );
 307         cache-file <quoted_string>;
 308         suppress-initial-notify <boolean>; // not yet implemented
 309         preferred-glue <string>;
 310         dual-stack-servers [ port <integer> ] { ( <quoted_string> [port
 311             <integer>] | <ipv4_address> [port <integer>] | <ipv6_address> [port <integer>] ); ... };
 312         edns-udp-size <integer>;
 313         max-udp-size <integer>;
 314         root-delegation-only [ exclude { <quoted_string>; ... } ];
 315         disable-algorithms <string> { <string>; ... };
 316         dnssec-enable <boolean>;
 317         dnssec-validation <boolean>;
 318         dnssec-lookaside <string> trust-anchor <string>;
 319         dnssec-must-be-secure <string> <boolean>;
 320         dnssec-accept-expired <boolean>;
 321         ixfr-from-differences <ixfrdiff>;
 322         acache-enable <boolean>;
 323         acache-cleaning-interval <integer>;
 324         max-acache-size <size_no_default>;
 325         clients-per-query <integer>;
 326         max-clients-per-query <integer>;
 327         empty-server <string>;
 328         empty-contact <string>;
 329         empty-zones-enable <boolean>;
 330         disable-empty-zone <string>;
 331         zero-no-soa-ttl-cache <boolean>;
 332         allow-query { <address_match_element>; ... };
 333         allow-transfer { <address_match_element>; ... };
 334         allow-update { <address_match_element>; ... };
 335         allow-update-forwarding { <address_match_element>; ... };
 336         allow-notify { <address_match_element>; ... };
 337         masterfile-format ( text | raw );
 338         notify <notifytype>;
 339         notify-source ( <ipv4_address> | * ) [ port ( <integer> | * ) ];
 340         notify-source-v6 ( <ipv6_address> | * ) [ port ( <integer> | * ) ];
 341         also-notify [ port <integer> ] { ( <ipv4_address> | <ipv6_address>
 342             ) [ port <integer> ]; ... };
 343         notify-delay <integer>;
 344         dialup <dialuptype>;
 345         forward ( first | only );
 346         forwarders [ port <integer> ] { ( <ipv4_address> | <ipv6_address> )
 347             [ port <integer> ]; ... };
 348         maintain-ixfr-base <boolean>; // obsolete
 349         max-ixfr-log-size <size>; // obsolete
 350         max-journal-size <size_no_default>;
 351         max-transfer-time-in <integer>;
 352         max-transfer-time-out <integer>;
 353         max-transfer-idle-in <integer>;
 354         max-transfer-idle-out <integer>;
 355         max-retry-time <integer>;
 356         min-retry-time <integer>;
 357         max-refresh-time <integer>;
 358         min-refresh-time <integer>;
 359         multi-master <boolean>;
 360         sig-validity-interval <integer>;
 361         transfer-source ( <ipv4_address> | * ) [ port ( <integer> | * ) ];
 362         transfer-source-v6 ( <ipv6_address> | * ) [ port ( <integer> | * ) ];
 363         alt-transfer-source ( <ipv4_address> | * ) [ port ( <integer> | * )
 364             ];
 365         alt-transfer-source-v6 ( <ipv6_address> | * ) [ port ( <integer> |
 366             * ) ];
 367         use-alt-transfer-source <boolean>;
 368         zone-statistics <boolean>;
 369         key-directory <quoted_string>;
 370         check-wildcard <boolean>;
 371         check-integrity <boolean>;
 372         check-mx ( fail | warn | ignore );
 373         check-mx-cname ( fail | warn | ignore );
 374         check-srv-cname ( fail | warn | ignore );
 375         check-sibling <boolean>;
 376         zero-no-soa-ttl <boolean>;
 377         update-check-ksk <boolean>;
 378         database <string>;
 379 };
 380
 381 lwres {
 382         listen-on [ port <integer> ] { ( <ipv4_address> | <ipv6_address> )
 383             [ port <integer> ]; ... };
 384         view <string> <optional_class>;
 385         search { <string>; ... };
 386         ndots <integer>;
 387 };
 388
 389 key <string> {
 390         algorithm <string>;
 391         secret <string>;
 392 };
 393
 394 zone <string> <optional_class> {
 395         type ( master | slave | stub | hint | forward | delegation-only );
 396         file <quoted_string>;
 397         journal <quoted_string>;
 398         ixfr-base <quoted_string>; // obsolete
 399         ixfr-tmp-file <quoted_string>; // obsolete
 400         masters [ port <integer> ] { ( <masters> | <ipv4_address> [port
 401             <integer>] | <ipv6_address> [port <integer>] ) [ key <string> ]; ... };
 402         pubkey <integer> <integer> <integer> <quoted_string>; // obsolete
 403         update-policy { ( grant | deny ) <string> ( name | subdomain |
 404             wildcard | self | selfsub | selfwild ) <string> <rrtypelist>; ... };
 405         database <string>;
 406         delegation-only <boolean>;
 407         check-names ( fail | warn | ignore );
 408         ixfr-from-differences <boolean>;
 409         allow-query { <address_match_element>; ... };
 410         allow-transfer { <address_match_element>; ... };
 411         allow-update { <address_match_element>; ... };
 412         allow-update-forwarding { <address_match_element>; ... };
 413         allow-notify { <address_match_element>; ... };
 414         masterfile-format ( text | raw );
 415         notify <notifytype>;
 416         notify-source ( <ipv4_address> | * ) [ port ( <integer> | * ) ];
 417         notify-source-v6 ( <ipv6_address> | * ) [ port ( <integer> | * ) ];
 418         also-notify [ port <integer> ] { ( <ipv4_address> | <ipv6_address>
 419             ) [ port <integer> ]; ... };
 420         notify-delay <integer>;
 421         dialup <dialuptype>;
 422         forward ( first | only );
 423         forwarders [ port <integer> ] { ( <ipv4_address> | <ipv6_address> )
 424             [ port <integer> ]; ... };
 425         maintain-ixfr-base <boolean>; // obsolete
 426         max-ixfr-log-size <size>; // obsolete
 427         max-journal-size <size_no_default>;
 428         max-transfer-time-in <integer>;
 429         max-transfer-time-out <integer>;
 430         max-transfer-idle-in <integer>;
 431         max-transfer-idle-out <integer>;
 432         max-retry-time <integer>;
 433         min-retry-time <integer>;
 434         max-refresh-time <integer>;
 435         min-refresh-time <integer>;
 436         multi-master <boolean>;
 437         sig-validity-interval <integer>;
 438         transfer-source ( <ipv4_address> | * ) [ port ( <integer> | * ) ];
 439         transfer-source-v6 ( <ipv6_address> | * ) [ port ( <integer> | * ) ];
 440         alt-transfer-source ( <ipv4_address> | * ) [ port ( <integer> | * )
 441             ];
 442         alt-transfer-source-v6 ( <ipv6_address> | * ) [ port ( <integer> |
 443             * ) ];
 444         use-alt-transfer-source <boolean>;
 445         zone-statistics <boolean>;
 446         key-directory <quoted_string>;
 447         check-wildcard <boolean>;
 448         check-integrity <boolean>;
 449         check-mx ( fail | warn | ignore );
 450         check-mx-cname ( fail | warn | ignore );
 451         check-srv-cname ( fail | warn | ignore );
 452         check-sibling <boolean>;
 453         zero-no-soa-ttl <boolean>;
 454         update-check-ksk <boolean>;
 455 };
 456
 457 dlz <string> {
 458         database <string>;
 459 };
 460
 461 server <netprefix> {
 462         bogus <boolean>;
 463         provide-ixfr <boolean>;
 464         request-ixfr <boolean>;
 465         support-ixfr <boolean>; // obsolete
 466         transfers <integer>;
 467         transfer-format ( many-answers | one-answer );
 468         keys <server_key>;
 469         edns <boolean>;
 470         edns-udp-size <integer>;
 471         max-udp-size <integer>;
 472         notify-source ( <ipv4_address> | * ) [ port ( <integer> | * ) ];
 473         notify-source-v6 ( <ipv6_address> | * ) [ port ( <integer> | * ) ];
 474         query-source <querysource4>;
 475         query-source-v6 <querysource6>;
 476         transfer-source ( <ipv4_address> | * ) [ port ( <integer> | * ) ];
 477         transfer-source-v6 ( <ipv6_address> | * ) [ port ( <integer> | * ) ];
 478 };
 479
 480 trusted-keys { <string> <integer> <integer> <integer> <quoted_string>; ... };
 481