contrib/bind9/bin/rndc/rndc.8

   1 .\" Copyright (C) 2004, 2005, 2007, 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
   2 .\" Copyright (C) 2000, 2001 Internet Software Consortium.
   3 .\"
   4 .\" Permission to use, copy, modify, and/or distribute this software for any
   5 .\" purpose with or without fee is hereby granted, provided that the above
   6 .\" copyright notice and this permission notice appear in all copies.
   7 .\"
   8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
   9 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  10 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  11 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  12 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  13 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  14 .\" PERFORMANCE OF THIS SOFTWARE.
  15 .\"
  16 .\" $Id$
  17 .\"
  18 .hy 0
  19 .ad l
  20 .\"     Title: rndc
  21 .\"    Author:
  22 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
  23 .\"      Date: December 04, 2013
  24 .\"    Manual: BIND9
  25 .\"    Source: BIND9
  26 .\"
  27 .TH "RNDC" "8" "December 04, 2013" "BIND9" "BIND9"
  28 .\" disable hyphenation
  29 .nh
  30 .\" disable justification (adjust text to left margin only)
  31 .ad l
  32 .SH "NAME"
  33 rndc \- name server control utility
  34 .SH "SYNOPSIS"
  35 .HP 5
  36 \fBrndc\fR [\fB\-b\ \fR\fB\fIsource\-address\fR\fR] [\fB\-c\ \fR\fB\fIconfig\-file\fR\fR] [\fB\-k\ \fR\fB\fIkey\-file\fR\fR] [\fB\-s\ \fR\fB\fIserver\fR\fR] [\fB\-p\ \fR\fB\fIport\fR\fR] [\fB\-V\fR] [\fB\-y\ \fR\fB\fIkey_id\fR\fR] {command}
  37 .SH "DESCRIPTION"
  38 .PP
  39 \fBrndc\fR
  40 controls the operation of a name server. It supersedes the
  41 \fBndc\fR
  42 utility that was provided in old BIND releases. If
  43 \fBrndc\fR
  44 is invoked with no command line options or arguments, it prints a short summary of the supported commands and the available options and their arguments.
  45 .PP
  46 \fBrndc\fR
  47 communicates with the name server over a TCP connection, sending commands authenticated with digital signatures. In the current versions of
  48 \fBrndc\fR
  49 and
  50 \fBnamed\fR, the only supported authentication algorithm is HMAC\-MD5, which uses a shared secret on each end of the connection. This provides TSIG\-style authentication for the command request and the name server's response. All commands sent over the channel must be signed by a key_id known to the server.
  51 .PP
  52 \fBrndc\fR
  53 reads a configuration file to determine how to contact the name server and decide what algorithm and key it should use.
  54 .SH "OPTIONS"
  55 .PP
  56 \-b \fIsource\-address\fR
  57 .RS 4
  58 Use
  59 \fIsource\-address\fR
  60 as the source address for the connection to the server. Multiple instances are permitted to allow setting of both the IPv4 and IPv6 source addresses.
  61 .RE
  62 .PP
  63 \-c \fIconfig\-file\fR
  64 .RS 4
  65 Use
  66 \fIconfig\-file\fR
  67 as the configuration file instead of the default,
  68 \fI/etc/rndc.conf\fR.
  69 .RE
  70 .PP
  71 \-k \fIkey\-file\fR
  72 .RS 4
  73 Use
  74 \fIkey\-file\fR
  75 as the key file instead of the default,
  76 \fI/etc/rndc.key\fR. The key in
  77 \fI/etc/rndc.key\fR
  78 will be used to authenticate commands sent to the server if the
  79 \fIconfig\-file\fR
  80 does not exist.
  81 .RE
  82 .PP
  83 \-s \fIserver\fR
  84 .RS 4
  85 \fIserver\fR
  86 is the name or address of the server which matches a server statement in the configuration file for
  87 \fBrndc\fR. If no server is supplied on the command line, the host named by the default\-server clause in the options statement of the
  88 \fBrndc\fR
  89 configuration file will be used.
  90 .RE
  91 .PP
  92 \-p \fIport\fR
  93 .RS 4
  94 Send commands to TCP port
  95 \fIport\fR
  96 instead of BIND 9's default control channel port, 953.
  97 .RE
  98 .PP
  99 \-V
 100 .RS 4
 101 Enable verbose logging.
 102 .RE
 103 .PP
 104 \-y \fIkey_id\fR
 105 .RS 4
 106 Use the key
 107 \fIkey_id\fR
 108 from the configuration file.
 109 \fIkey_id\fR
 110 must be known by named with the same algorithm and secret string in order for control message validation to succeed. If no
 111 \fIkey_id\fR
 112 is specified,
 113 \fBrndc\fR
 114 will first look for a key clause in the server statement of the server being used, or if no server statement is present for that host, then the default\-key clause of the options statement. Note that the configuration file contains shared secrets which are used to send authenticated control commands to name servers. It should therefore not have general read or write access.
 115 .RE
 116 .SH "COMMANDS"
 117 .PP
 118 A list of commands supported by
 119 \fBrndc\fR
 120 can be seen by running
 121 \fBrndc\fR
 122 without arguments.
 123 .PP
 124 Currently supported commands are:
 125 .PP
 126 \fBreload\fR
 127 .RS 4
 128 Reload configuration file and zones.
 129 .RE
 130 .PP
 131 \fBreload \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR
 132 .RS 4
 133 Reload the given zone.
 134 .RE
 135 .PP
 136 \fBrefresh \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR
 137 .RS 4
 138 Schedule zone maintenance for the given zone.
 139 .RE
 140 .PP
 141 \fBretransfer \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR
 142 .RS 4
 143 Retransfer the given slave zone from the master server.
 144 .sp
 145 If the zone is configured to use
 146 \fBinline\-signing\fR, the signed version of the zone is discarded; after the retransfer of the unsigned version is complete, the signed version will be regenerated with all new signatures.
 147 .RE
 148 .PP
 149 \fBsign \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR
 150 .RS 4
 151 Fetch all DNSSEC keys for the given zone from the key directory (see the
 152 \fBkey\-directory\fR
 153 option in the BIND 9 Administrator Reference Manual). If they are within their publication period, merge them into the zone's DNSKEY RRset. If the DNSKEY RRset is changed, then the zone is automatically re\-signed with the new key set.
 154 .sp
 155 This command requires that the
 156 \fBauto\-dnssec\fR
 157 zone option be set to
 158 allow
 159 or
 160 maintain, and also requires the zone to be configured to allow dynamic DNS. (See "Dynamic Update Policies" in the Administrator Reference Manual for more details.)
 161 .RE
 162 .PP
 163 \fBloadkeys \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR
 164 .RS 4
 165 Fetch all DNSSEC keys for the given zone from the key directory. If they are within their publication period, merge them into the zone's DNSKEY RRset. Unlike
 166 \fBrndc sign\fR, however, the zone is not immediately re\-signed by the new keys, but is allowed to incrementally re\-sign over time.
 167 .sp
 168 This command requires that the
 169 \fBauto\-dnssec\fR
 170 zone option be set to
 171 maintain, and also requires the zone to be configured to allow dynamic DNS. (See "Dynamic Update Policies" in the Administrator Reference Manual for more details.)
 172 .RE
 173 .PP
 174 \fBfreeze \fR\fB[\fIzone\fR [\fIclass\fR [\fIview\fR]]]\fR
 175 .RS 4
 176 Suspend updates to a dynamic zone. If no zone is specified, then all zones are suspended. This allows manual edits to be made to a zone normally updated by dynamic update. It also causes changes in the journal file to be synced into the master file. All dynamic update attempts will be refused while the zone is frozen.
 177 .RE
 178 .PP
 179 \fBthaw \fR\fB[\fIzone\fR [\fIclass\fR [\fIview\fR]]]\fR
 180 .RS 4
 181 Enable updates to a frozen dynamic zone. If no zone is specified, then all frozen zones are enabled. This causes the server to reload the zone from disk, and re\-enables dynamic updates after the load has completed. After a zone is thawed, dynamic updates will no longer be refused. If the zone has changed and the
 182 \fBixfr\-from\-differences\fR
 183 option is in use, then the journal file will be updated to reflect changes in the zone. Otherwise, if the zone has changed, any existing journal file will be removed.
 184 .RE
 185 .PP
 186 \fBsync \fR\fB[\-clean]\fR\fB \fR\fB[\fIzone\fR [\fIclass\fR [\fIview\fR]]]\fR
 187 .RS 4
 188 Sync changes in the journal file for a dynamic zone to the master file. If the "\-clean" option is specified, the journal file is also removed. If no zone is specified, then all zones are synced.
 189 .RE
 190 .PP
 191 \fBnotify \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR
 192 .RS 4
 193 Resend NOTIFY messages for the zone.
 194 .RE
 195 .PP
 196 \fBreconfig\fR
 197 .RS 4
 198 Reload the configuration file and load new zones, but do not reload existing zone files even if they have changed. This is faster than a full
 199 \fBreload\fR
 200 when there is a large number of zones because it avoids the need to examine the modification times of the zones files.
 201 .RE
 202 .PP
 203 \fBstats\fR
 204 .RS 4
 205 Write server statistics to the statistics file.
 206 .RE
 207 .PP
 208 \fBquerylog\fR [on|off]
 209 .RS 4
 210 Enable or disable query logging. (For backward compatibility, this command can also be used without an argument to toggle query logging on and off.)
 211 .sp
 212 Query logging can also be enabled by explicitly directing the
 213 \fBqueries\fR
 214 \fBcategory\fR
 215 to a
 216 \fBchannel\fR
 217 in the
 218 \fBlogging\fR
 219 section of
 220 \fInamed.conf\fR
 221 or by specifying
 222 \fBquerylog yes;\fR
 223 in the
 224 \fBoptions\fR
 225 section of
 226 \fInamed.conf\fR.
 227 .RE
 228 .PP
 229 \fBdumpdb \fR\fB[\-all|\-cache|\-zone]\fR\fB \fR\fB[\fIview ...\fR]\fR
 230 .RS 4
 231 Dump the server's caches (default) and/or zones to the dump file for the specified views. If no view is specified, all views are dumped.
 232 .RE
 233 .PP
 234 \fBsecroots \fR\fB[\fIview ...\fR]\fR
 235 .RS 4
 236 Dump the server's security roots to the secroots file for the specified views. If no view is specified, security roots for all views are dumped.
 237 .RE
 238 .PP
 239 \fBstop \fR\fB[\-p]\fR
 240 .RS 4
 241 Stop the server, making sure any recent changes made through dynamic update or IXFR are first saved to the master files of the updated zones. If
 242 \fB\-p\fR
 243 is specified
 244 \fBnamed\fR's process id is returned. This allows an external process to determine when
 245 \fBnamed\fR
 246 had completed stopping.
 247 .RE
 248 .PP
 249 \fBhalt \fR\fB[\-p]\fR
 250 .RS 4
 251 Stop the server immediately. Recent changes made through dynamic update or IXFR are not saved to the master files, but will be rolled forward from the journal files when the server is restarted. If
 252 \fB\-p\fR
 253 is specified
 254 \fBnamed\fR's process id is returned. This allows an external process to determine when
 255 \fBnamed\fR
 256 had completed halting.
 257 .RE
 258 .PP
 259 \fBtrace\fR
 260 .RS 4
 261 Increment the servers debugging level by one.
 262 .RE
 263 .PP
 264 \fBtrace \fR\fB\fIlevel\fR\fR
 265 .RS 4
 266 Sets the server's debugging level to an explicit value.
 267 .RE
 268 .PP
 269 \fBnotrace\fR
 270 .RS 4
 271 Sets the server's debugging level to 0.
 272 .RE
 273 .PP
 274 \fBflush\fR
 275 .RS 4
 276 Flushes the server's cache.
 277 .RE
 278 .PP
 279 \fBflushname\fR \fIname\fR [\fIview\fR]
 280 .RS 4
 281 Flushes the given name from the server's DNS cache and, if applicable, from the server's nameserver address database or bad\-server cache.
 282 .RE
 283 .PP
 284 \fBflushtree\fR \fIname\fR [\fIview\fR]
 285 .RS 4
 286 Flushes the given name, and all of its subdomains, from the server's DNS cache. Note that this does
 287 \fInot\fR
 288 affect he server's address database or bad\-server cache.
 289 .RE
 290 .PP
 291 \fBstatus\fR
 292 .RS 4
 293 Display status of the server. Note that the number of zones includes the internal
 294 \fBbind/CH\fR
 295 zone and the default
 296 \fB./IN\fR
 297 hint zone if there is not an explicit root zone configured.
 298 .RE
 299 .PP
 300 \fBrecursing\fR
 301 .RS 4
 302 Dump the list of queries
 303 \fBnamed\fR
 304 is currently recursing on.
 305 .RE
 306 .PP
 307 \fBvalidation ( on | off | check ) \fR\fB[\fIview ...\fR]\fR\fB \fR
 308 .RS 4
 309 Enable, disable, or check the current status of DNSSEC validation. Note
 310 \fBdnssec\-enable\fR
 311 also needs to be set to
 312 \fByes\fR
 313 or
 314 \fBauto\fR
 315 to be effective. It defaults to enabled.
 316 .RE
 317 .PP
 318 \fBtsig\-list\fR
 319 .RS 4
 320 List the names of all TSIG keys currently configured for use by
 321 \fBnamed\fR
 322 in each view. The list both statically configured keys and dynamic TKEY\-negotiated keys.
 323 .RE
 324 .PP
 325 \fBtsig\-delete\fR \fIkeyname\fR [\fIview\fR]
 326 .RS 4
 327 Delete a given TKEY\-negotiated key from the server. (This does not apply to statically configured TSIG keys.)
 328 .RE
 329 .PP
 330 \fBaddzone \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR\fB \fR\fB\fIconfiguration\fR\fR\fB \fR
 331 .RS 4
 332 Add a zone while the server is running. This command requires the
 333 \fBallow\-new\-zones\fR
 334 option to be set to
 335 \fByes\fR. The
 336 \fIconfiguration\fR
 337 string specified on the command line is the zone configuration text that would ordinarily be placed in
 338 \fInamed.conf\fR.
 339 .sp
 340 The configuration is saved in a file called
 341 \fI\fIhash\fR\fR\fI.nzf\fR, where
 342 \fIhash\fR
 343 is a cryptographic hash generated from the name of the view. When
 344 \fBnamed\fR
 345 is restarted, the file will be loaded into the view configuration, so that zones that were added can persist after a restart.
 346 .sp
 347 This sample
 348 \fBaddzone\fR
 349 command would add the zone
 350 example.com
 351 to the default view:
 352 .sp
 353 $\fBrndc addzone example.com '{ type master; file "example.com.db"; };'\fR
 354 .sp
 355 (Note the brackets and semi\-colon around the zone configuration text.)
 356 .RE
 357 .PP
 358 \fBdelzone \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR\fB \fR
 359 .RS 4
 360 Delete a zone while the server is running. Only zones that were originally added via
 361 \fBrndc addzone\fR
 362 can be deleted in this manner.
 363 .RE
 364 .PP
 365 \fBsigning \fR\fB[( \-list | \-clear \fIkeyid/algorithm\fR | \-clear all | \-nsec3param ( \fIparameters\fR | none ) ) ]\fR\fB \fR\fB\fIzone\fR\fR\fB \fR\fB[\fIclass\fR [\fIview\fR]]\fR\fB \fR
 366 .RS 4
 367 List, edit, or remove the DNSSEC signing state records for the specified zone. The status of ongoing DNSSEC operations (such as signing or generating NSEC3 chains) is stored in the zone in the form of DNS resource records of type
 368 \fBsig\-signing\-type\fR.
 369 \fBrndc signing \-list\fR
 370 converts these records into a human\-readable form, indicating which keys are currently signing or have finished signing the zone, and which NSEC3 chains are being created or removed.
 371 .sp
 372 \fBrndc signing \-clear\fR
 373 can remove a single key (specified in the same format that
 374 \fBrndc signing \-list\fR
 375 uses to display it), or all keys. In either case, only completed keys are removed; any record indicating that a key has not yet finished signing the zone will be retained.
 376 .sp
 377 \fBrndc signing \-nsec3param\fR
 378 sets the NSEC3 parameters for a zone. This is the only supported mechanism for using NSEC3 with
 379 \fBinline\-signing\fR
 380 zones. Parameters are specified in the same format as an NSEC3PARAM resource record: hash algorithm, flags, iterations, and salt, in that order.
 381 .sp
 382 Currently, the only defined value for hash algorithm is
 383 1, representing SHA\-1. The
 384 \fBflags\fR
 385 may be set to
 386 0
 387 or
 388 1, depending on whether you wish to set the opt\-out bit in the NSEC3 chain.
 389 \fBiterations\fR
 390 defines the number of additional times to apply the algorithm when generating an NSEC3 hash. The
 391 \fBsalt\fR
 392 is a string of data expressed in hexadecimal, or a hyphen (`\-') if no salt is to be used.
 393 .sp
 394 So, for example, to create an NSEC3 chain using the SHA\-1 hash algorithm, no opt\-out flag, 10 iterations, and a salt value of "FFFF", use:
 395 \fBrndc signing \-nsec3param 1 0 10 FFFF \fR\fB\fIzone\fR\fR. To set the opt\-out flag, 15 iterations, and no salt, use:
 396 \fBrndc signing \-nsec3param 1 1 15 \- \fR\fB\fIzone\fR\fR.
 397 .sp
 398 \fBrndc signing \-nsec3param none\fR
 399 removes an existing NSEC3 chain and replaces it with NSEC.
 400 .RE
 401 .SH "LIMITATIONS"
 402 .PP
 403 There is currently no way to provide the shared secret for a
 404 \fBkey_id\fR
 405 without using the configuration file.
 406 .PP
 407 Several error messages could be clearer.
 408 .SH "SEE ALSO"
 409 .PP
 410 \fBrndc.conf\fR(5),
 411 \fBrndc\-confgen\fR(8),
 412 \fBnamed\fR(8),
 413 \fBnamed.conf\fR(5),
 414 \fBndc\fR(8),
 415 BIND 9 Administrator Reference Manual.
 416 .SH "AUTHOR"
 417 .PP
 418 Internet Systems Consortium
 419 .SH "COPYRIGHT"
 420 Copyright \(co 2004, 2005, 2007, 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
 421 .br
 422 Copyright \(co 2000, 2001 Internet Software Consortium.
 423 .br