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-recursion { <address_match_element>; ... };
  54         allow-v6-synthesis { <address_match_element>; ... }; // obsolete
  55         sortlist { <address_match_element>; ... };
  56         topology { <address_match_element>; ... }; // not implemented
  57         auth-nxdomain <boolean>; // default changed
  58         minimal-responses <boolean>;
  59         recursion <boolean>;
  60         rrset-order { [ class <string> ] [ type <string> ] [ name
  61             <quoted_string> ] <string> <string>; ... };
  62         provide-ixfr <boolean>;
  63         request-ixfr <boolean>;
  64         fetch-glue <boolean>; // obsolete
  65         rfc2308-type1 <boolean>; // not yet implemented
  66         additional-from-auth <boolean>;
  67         additional-from-cache <boolean>;
  68         query-source <querysource4>;
  69         query-source-v6 <querysource6>;
  70         cleaning-interval <integer>;
  71         min-roots <integer>; // not implemented
  72         lame-ttl <integer>;
  73         max-ncache-ttl <integer>;
  74         max-cache-ttl <integer>;
  75         transfer-format ( many-answers | one-answer );
  76         max-cache-size <size_no_default>;
  77         check-names ( master | slave | response ) ( fail | warn | ignore );
  78         cache-file <quoted_string>;
  79         suppress-initial-notify <boolean>; // not yet implemented
  80         preferred-glue <string>;
  81         dual-stack-servers [ port <integer> ] { ( <quoted_string> [port
  82             <integer>] | <ipv4_address> [port <integer>] | <ipv6_address> [port <integer>] ); ... };
  83         edns-udp-size <integer>;
  84         root-delegation-only [ exclude { <quoted_string>; ... } ];
  85         disable-algorithms <string> { <string>; ... };
  86         dnssec-enable <boolean>;
  87         dnssec-lookaside <string> trust-anchor <string>;
  88         dnssec-must-be-secure <string> <boolean>;
  89         allow-query { <address_match_element>; ... };
  90         allow-transfer { <address_match_element>; ... };
  91         allow-update-forwarding { <address_match_element>; ... };
  92         allow-notify { <address_match_element>; ... };
  93         notify <notifytype>;
  94         notify-source ( <ipv4_address> | * ) [ port ( <integer> | * ) ];
  95         notify-source-v6 ( <ipv6_address> | * ) [ port ( <integer> | * ) ];
  96         also-notify [ port <integer> ] { ( <ipv4_address> | <ipv6_address>
  97             ) [ port <integer> ]; ... };
  98         dialup <dialuptype>;
  99         forward ( first | only );
 100         forwarders [ port <integer> ] { ( <ipv4_address> | <ipv6_address> )
 101             [ port <integer> ]; ... };
 102         ixfr-from-differences <boolean>;
 103         maintain-ixfr-base <boolean>; // obsolete
 104         max-ixfr-log-size <size>; // obsolete
 105         max-journal-size <size_no_default>;
 106         max-transfer-time-in <integer>;
 107         max-transfer-time-out <integer>;
 108         max-transfer-idle-in <integer>;
 109         max-transfer-idle-out <integer>;
 110         max-retry-time <integer>;
 111         min-retry-time <integer>;
 112         max-refresh-time <integer>;
 113         min-refresh-time <integer>;
 114         multi-master <boolean>;
 115         sig-validity-interval <integer>;
 116         transfer-source ( <ipv4_address> | * ) [ port ( <integer> | * ) ];
 117         transfer-source-v6 ( <ipv6_address> | * ) [ port ( <integer> | * ) ];
 118         alt-transfer-source ( <ipv4_address> | * ) [ port ( <integer> | * )
 119             ];
 120         alt-transfer-source-v6 ( <ipv6_address> | * ) [ port ( <integer> |
 121             * ) ];
 122         use-alt-transfer-source <boolean>;
 123         zone-statistics <boolean>;
 124         key-directory <quoted_string>;
 125 };
 126
 127 controls {
 128         inet ( <ipv4_address> | <ipv6_address> | * ) [ port ( <integer> | *
 129             ) ] allow { <address_match_element>; ... } [ keys { <string>; ... } ];
 130         unix <unsupported>; // not implemented
 131 };
 132
 133 acl <string> { <address_match_element>; ... };
 134
 135 masters <string> [ port <integer> ] { ( <masters> | <ipv4_address> [port
 136     <integer>] | <ipv6_address> [port <integer>] ) [ key <string> ]; ... };
 137
 138 logging {
 139         channel <string> {
 140                 file <log_file>;
 141                 syslog <optional_facility>;
 142                 null;
 143                 stderr;
 144                 severity <log_severity>;
 145                 print-time <boolean>;
 146                 print-severity <boolean>;
 147                 print-category <boolean>;
 148         };
 149         category <string> { <string>; ... };
 150 };
 151
 152 view <string> <optional_class> {
 153         match-clients { <address_match_element>; ... };
 154         match-destinations { <address_match_element>; ... };
 155         match-recursive-only <boolean>;
 156         key <string> {
 157                 algorithm <string>;
 158                 secret <string>;
 159         };
 160         zone <string> <optional_class> {
 161                 type ( master | slave | stub | hint | forward |
 162                     delegation-only );
 163                 allow-update { <address_match_element>; ... };
 164                 file <quoted_string>;
 165                 ixfr-base <quoted_string>; // obsolete
 166                 ixfr-tmp-file <quoted_string>; // obsolete
 167                 masters [ port <integer> ] { ( <masters> | <ipv4_address>
 168                     [port <integer>] | <ipv6_address> [port <integer>] ) [ key <string> ]; ... };
 169                 pubkey <integer> <integer> <integer> <quoted_string>; //
 170                     obsolete
 171                 update-policy { ( grant | deny ) <string> ( name |
 172                     subdomain | wildcard | self ) <string> <rrtypelist>; ... };
 173                 database <string>;
 174                 delegation-only <boolean>;
 175                 check-names ( fail | warn | ignore );
 176                 allow-query { <address_match_element>; ... };
 177                 allow-transfer { <address_match_element>; ... };
 178                 allow-update-forwarding { <address_match_element>; ... };
 179                 allow-notify { <address_match_element>; ... };
 180                 notify <notifytype>;
 181                 notify-source ( <ipv4_address> | * ) [ port ( <integer> | *
 182                     ) ];
 183                 notify-source-v6 ( <ipv6_address> | * ) [ port ( <integer>
 184                     | * ) ];
 185                 also-notify [ port <integer> ] { ( <ipv4_address> |
 186                     <ipv6_address> ) [ port <integer> ]; ... };
 187                 dialup <dialuptype>;
 188                 forward ( first | only );
 189                 forwarders [ port <integer> ] { ( <ipv4_address> |
 190                     <ipv6_address> ) [ port <integer> ]; ... };
 191                 ixfr-from-differences <boolean>;
 192                 maintain-ixfr-base <boolean>; // obsolete
 193                 max-ixfr-log-size <size>; // obsolete
 194                 max-journal-size <size_no_default>;
 195                 max-transfer-time-in <integer>;
 196                 max-transfer-time-out <integer>;
 197                 max-transfer-idle-in <integer>;
 198                 max-transfer-idle-out <integer>;
 199                 max-retry-time <integer>;
 200                 min-retry-time <integer>;
 201                 max-refresh-time <integer>;
 202                 min-refresh-time <integer>;
 203                 multi-master <boolean>;
 204                 sig-validity-interval <integer>;
 205                 transfer-source ( <ipv4_address> | * ) [ port ( <integer> |
 206                     * ) ];
 207                 transfer-source-v6 ( <ipv6_address> | * ) [ port (
 208                     <integer> | * ) ];
 209                 alt-transfer-source ( <ipv4_address> | * ) [ port (
 210                     <integer> | * ) ];
 211                 alt-transfer-source-v6 ( <ipv6_address> | * ) [ port (
 212                     <integer> | * ) ];
 213                 use-alt-transfer-source <boolean>;
 214                 zone-statistics <boolean>;
 215                 key-directory <quoted_string>;
 216         };
 217         server <netaddr> {
 218                 bogus <boolean>;
 219                 provide-ixfr <boolean>;
 220                 request-ixfr <boolean>;
 221                 support-ixfr <boolean>; // obsolete
 222                 transfers <integer>;
 223                 transfer-format ( many-answers | one-answer );
 224                 keys <server_key>;
 225                 edns <boolean>;
 226                 transfer-source ( <ipv4_address> | * ) [ port ( <integer> |
 227                     * ) ];
 228                 transfer-source-v6 ( <ipv6_address> | * ) [ port (
 229                     <integer> | * ) ];
 230         };
 231         trusted-keys { <string> <integer> <integer> <integer>
 232             <quoted_string>; ... };
 233         allow-recursion { <address_match_element>; ... };
 234         allow-v6-synthesis { <address_match_element>; ... }; // obsolete
 235         sortlist { <address_match_element>; ... };
 236         topology { <address_match_element>; ... }; // not implemented
 237         auth-nxdomain <boolean>; // default changed
 238         minimal-responses <boolean>;
 239         recursion <boolean>;
 240         rrset-order { [ class <string> ] [ type <string> ] [ name
 241             <quoted_string> ] <string> <string>; ... };
 242         provide-ixfr <boolean>;
 243         request-ixfr <boolean>;
 244         fetch-glue <boolean>; // obsolete
 245         rfc2308-type1 <boolean>; // not yet implemented
 246         additional-from-auth <boolean>;
 247         additional-from-cache <boolean>;
 248         query-source <querysource4>;
 249         query-source-v6 <querysource6>;
 250         cleaning-interval <integer>;
 251         min-roots <integer>; // not implemented
 252         lame-ttl <integer>;
 253         max-ncache-ttl <integer>;
 254         max-cache-ttl <integer>;
 255         transfer-format ( many-answers | one-answer );
 256         max-cache-size <size_no_default>;
 257         check-names ( master | slave | response ) ( fail | warn | ignore );
 258         cache-file <quoted_string>;
 259         suppress-initial-notify <boolean>; // not yet implemented
 260         preferred-glue <string>;
 261         dual-stack-servers [ port <integer> ] { ( <quoted_string> [port
 262             <integer>] | <ipv4_address> [port <integer>] | <ipv6_address> [port <integer>] ); ... };
 263         edns-udp-size <integer>;
 264         root-delegation-only [ exclude { <quoted_string>; ... } ];
 265         disable-algorithms <string> { <string>; ... };
 266         dnssec-enable <boolean>;
 267         dnssec-lookaside <string> trust-anchor <string>;
 268         dnssec-must-be-secure <string> <boolean>;
 269         allow-query { <address_match_element>; ... };
 270         allow-transfer { <address_match_element>; ... };
 271         allow-update-forwarding { <address_match_element>; ... };
 272         allow-notify { <address_match_element>; ... };
 273         notify <notifytype>;
 274         notify-source ( <ipv4_address> | * ) [ port ( <integer> | * ) ];
 275         notify-source-v6 ( <ipv6_address> | * ) [ port ( <integer> | * ) ];
 276         also-notify [ port <integer> ] { ( <ipv4_address> | <ipv6_address>
 277             ) [ port <integer> ]; ... };
 278         dialup <dialuptype>;
 279         forward ( first | only );
 280         forwarders [ port <integer> ] { ( <ipv4_address> | <ipv6_address> )
 281             [ port <integer> ]; ... };
 282         ixfr-from-differences <boolean>;
 283         maintain-ixfr-base <boolean>; // obsolete
 284         max-ixfr-log-size <size>; // obsolete
 285         max-journal-size <size_no_default>;
 286         max-transfer-time-in <integer>;
 287         max-transfer-time-out <integer>;
 288         max-transfer-idle-in <integer>;
 289         max-transfer-idle-out <integer>;
 290         max-retry-time <integer>;
 291         min-retry-time <integer>;
 292         max-refresh-time <integer>;
 293         min-refresh-time <integer>;
 294         multi-master <boolean>;
 295         sig-validity-interval <integer>;
 296         transfer-source ( <ipv4_address> | * ) [ port ( <integer> | * ) ];
 297         transfer-source-v6 ( <ipv6_address> | * ) [ port ( <integer> | * ) ];
 298         alt-transfer-source ( <ipv4_address> | * ) [ port ( <integer> | * )
 299             ];
 300         alt-transfer-source-v6 ( <ipv6_address> | * ) [ port ( <integer> |
 301             * ) ];
 302         use-alt-transfer-source <boolean>;
 303         zone-statistics <boolean>;
 304         key-directory <quoted_string>;
 305 };
 306
 307 lwres {
 308         listen-on [ port <integer> ] { ( <ipv4_address> | <ipv6_address> )
 309             [ port <integer> ]; ... };
 310         view <string> <optional_class>;
 311         search { <string>; ... };
 312         ndots <integer>;
 313 };
 314
 315 key <string> {
 316         algorithm <string>;
 317         secret <string>;
 318 };
 319
 320 zone <string> <optional_class> {
 321         type ( master | slave | stub | hint | forward | delegation-only );
 322         allow-update { <address_match_element>; ... };
 323         file <quoted_string>;
 324         ixfr-base <quoted_string>; // obsolete
 325         ixfr-tmp-file <quoted_string>; // obsolete
 326         masters [ port <integer> ] { ( <masters> | <ipv4_address> [port
 327             <integer>] | <ipv6_address> [port <integer>] ) [ key <string> ]; ... };
 328         pubkey <integer> <integer> <integer> <quoted_string>; // obsolete
 329         update-policy { ( grant | deny ) <string> ( name | subdomain |
 330             wildcard | self ) <string> <rrtypelist>; ... };
 331         database <string>;
 332         delegation-only <boolean>;
 333         check-names ( fail | warn | ignore );
 334         allow-query { <address_match_element>; ... };
 335         allow-transfer { <address_match_element>; ... };
 336         allow-update-forwarding { <address_match_element>; ... };
 337         allow-notify { <address_match_element>; ... };
 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         dialup <dialuptype>;
 344         forward ( first | only );
 345         forwarders [ port <integer> ] { ( <ipv4_address> | <ipv6_address> )
 346             [ port <integer> ]; ... };
 347         ixfr-from-differences <boolean>;
 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 };
 371
 372 server <netaddr> {
 373         bogus <boolean>;
 374         provide-ixfr <boolean>;
 375         request-ixfr <boolean>;
 376         support-ixfr <boolean>; // obsolete
 377         transfers <integer>;
 378         transfer-format ( many-answers | one-answer );
 379         keys <server_key>;
 380         edns <boolean>;
 381         transfer-source ( <ipv4_address> | * ) [ port ( <integer> | * ) ];
 382         transfer-source-v6 ( <ipv6_address> | * ) [ port ( <integer> | * ) ];
 383 };
 384
 385 trusted-keys { <string> <integer> <integer> <integer> <quoted_string>; ... };
 386