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