rndc.html revision 1700442a7751c2bbdafe2d039cebbd8316496957
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont - Copyright (C) 2004, 2005, 2007, 2013-2016 Internet Systems Consortium, Inc. ("ISC")
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont - Copyright (C) 2000, 2001 Internet Software Consortium.
6ea2385360e9e2167e65f9286447da9eea189457Tinderbox User - Permission to use, copy, modify, and/or distribute this software for any
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont - purpose with or without fee is hereby granted, provided that the above
db0008c4486414b81e90dca9938e1fc2320e5133Automatic Updater - copyright notice and this permission notice appear in all copies.
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont - PERFORMANCE OF THIS SOFTWARE.
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
cf58feee56bf1afb8c2909f399a6f1e28d0dbf68Jeremy Reed<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<a name="man.rndc"></a><div class="titlepage"></div>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<p><span class="application">rndc</span> — name server control utility</p>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<div class="cmdsynopsis"><p><code class="command">rndc</code> [<code class="option">-b <em class="replaceable"><code>source-address</code></em></code>] [<code class="option">-c <em class="replaceable"><code>config-file</code></em></code>] [<code class="option">-k <em class="replaceable"><code>key-file</code></em></code>] [<code class="option">-s <em class="replaceable"><code>server</code></em></code>] [<code class="option">-p <em class="replaceable"><code>port</code></em></code>] [<code class="option">-q</code>] [<code class="option">-r</code>] [<code class="option">-V</code>] [<code class="option">-y <em class="replaceable"><code>key_id</code></em></code>] {command}</p></div>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<p><span class="command"><strong>rndc</strong></span>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont controls the operation of a name
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont server. It supersedes the <span class="command"><strong>ndc</strong></span> utility
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont that was provided in old BIND releases. If
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont <span class="command"><strong>rndc</strong></span> is invoked with no command line
26d8ffe715e74d1e67d268551449b780fec1b95fAutomatic Updater options or arguments, it prints a short summary of the
ca4e44ebe8f3b29a426fe047c4192262ca660c6fAutomatic Updater supported commands and the available options and their
6ea2385360e9e2167e65f9286447da9eea189457Tinderbox User<p><span class="command"><strong>rndc</strong></span>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont communicates with the name server over a TCP connection, sending
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont commands authenticated with digital signatures. In the current
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont <span class="command"><strong>rndc</strong></span> and <span class="command"><strong>named</strong></span>,
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont the only supported authentication algorithms are HMAC-MD5
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont (for compatibility), HMAC-SHA1, HMAC-SHA224, HMAC-SHA256
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont (default), HMAC-SHA384 and HMAC-SHA512.
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont They use a shared secret on each end of the connection.
d1f39121a69b6afa6c0c9e44eceb60910d1d7f81Evan Hunt This provides TSIG-style authentication for the command
d1f39121a69b6afa6c0c9e44eceb60910d1d7f81Evan Hunt request and the name server's response. All commands sent
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont over the channel must be signed by a key_id known to the
8b78c993cb475cc94e88560941b28c37684789d9Francis Dupont<p><span class="command"><strong>rndc</strong></span>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont reads a configuration file to
b843f577bbcd6660fbaa506d9e55b156c689a5a8Evan Hunt determine how to contact the name server and decide what
b843f577bbcd6660fbaa506d9e55b156c689a5a8Evan Hunt algorithm and key it should use.
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont<div class="variablelist"><dl class="variablelist">
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<dt><span class="term">-b <em class="replaceable"><code>source-address</code></em></span></dt>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont Use <em class="replaceable"><code>source-address</code></em>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont as the source address for the connection to the server.
8a198fa776a09beb4dabf40b73a54d9c7bd70ac9Evan Hunt Multiple instances are permitted to allow setting of both
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont the IPv4 and IPv6 source addresses.
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont Use <em class="replaceable"><code>config-file</code></em>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont as the configuration file instead of the default,
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont <code class="filename">/etc/rndc.conf</code>.
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<dt><span class="term">-k <em class="replaceable"><code>key-file</code></em></span></dt>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont Use <em class="replaceable"><code>key-file</code></em>
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont as the key file instead of the default,
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont <code class="filename">/etc/rndc.key</code>. The key in
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont <code class="filename">/etc/rndc.key</code> will be used to
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont commands sent to the server if the <em class="replaceable"><code>config-file</code></em>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont does not exist.
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<dt><span class="term">-s <em class="replaceable"><code>server</code></em></span></dt>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<dd><p><em class="replaceable"><code>server</code></em> is
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont the name or address of the server which matches a
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont server statement in the configuration file for
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont <span class="command"><strong>rndc</strong></span>. If no server is supplied on the
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont command line, the host named by the default-server clause
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont in the options statement of the <span class="command"><strong>rndc</strong></span>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont configuration file will be used.
cc6cddfd94e8f0c58c290317b0853dac30b1b895Evan Hunt<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
aaaf8d4f4873d21e55c3ffb4f656203d08339865Mark Andrews Send commands to TCP port
d1f39121a69b6afa6c0c9e44eceb60910d1d7f81Evan Hunt of BIND 9's default control channel port, 953.
cc6cddfd94e8f0c58c290317b0853dac30b1b895Evan Hunt Quiet mode: Message text returned by the server
cc6cddfd94e8f0c58c290317b0853dac30b1b895Evan Hunt will not be printed except when there is an error.
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont Instructs <span class="command"><strong>rndc</strong></span> to print the result code
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont returned by <span class="command"><strong>named</strong></span> after executing the
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont requested command (e.g., ISC_R_SUCCESS, ISC_R_FAILURE, etc).
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont Enable verbose logging.
d1f39121a69b6afa6c0c9e44eceb60910d1d7f81Evan Hunt<dt><span class="term">-y <em class="replaceable"><code>key_id</code></em></span></dt>
d1f39121a69b6afa6c0c9e44eceb60910d1d7f81Evan Hunt Use the key <em class="replaceable"><code>key_id</code></em>
d1f39121a69b6afa6c0c9e44eceb60910d1d7f81Evan Hunt from the configuration file.
d1f39121a69b6afa6c0c9e44eceb60910d1d7f81Evan Hunt known by <span class="command"><strong>named</strong></span> with the same algorithm and secret string
d1f39121a69b6afa6c0c9e44eceb60910d1d7f81Evan Hunt in order for control message validation to succeed.
d1f39121a69b6afa6c0c9e44eceb60910d1d7f81Evan Hunt If no <em class="replaceable"><code>key_id</code></em>
d1f39121a69b6afa6c0c9e44eceb60910d1d7f81Evan Hunt is specified, <span class="command"><strong>rndc</strong></span> will first look
d1f39121a69b6afa6c0c9e44eceb60910d1d7f81Evan Hunt for a key clause in the server statement of the server
d1f39121a69b6afa6c0c9e44eceb60910d1d7f81Evan Hunt being used, or if no server statement is present for that
8b78c993cb475cc94e88560941b28c37684789d9Francis Dupont host, then the default-key clause of the options statement.
8b78c993cb475cc94e88560941b28c37684789d9Francis Dupont Note that the configuration file contains shared secrets
8b78c993cb475cc94e88560941b28c37684789d9Francis Dupont which are used to send authenticated control commands
8b78c993cb475cc94e88560941b28c37684789d9Francis Dupont to name servers. It should therefore not have general read
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt or write access.
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt A list of commands supported by <span class="command"><strong>rndc</strong></span> can
ba751492fcc4f161a18b983d4f018a1a52938cb9Evan Hunt be seen by running <span class="command"><strong>rndc</strong></span> without arguments.
8b78c993cb475cc94e88560941b28c37684789d9Francis Dupont Currently supported commands are:
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<div class="variablelist"><dl class="variablelist">
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<dt><span class="term"><strong class="userinput"><code>addzone <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>] <em class="replaceable"><code>configuration</code></em> </code></strong></span></dt>
08c67b5b7a54047fbfed423a59b48c86177b9859Evan Hunt Add a zone while the server is running. This
08c67b5b7a54047fbfed423a59b48c86177b9859Evan Hunt command requires the
08c67b5b7a54047fbfed423a59b48c86177b9859Evan Hunt <span class="command"><strong>allow-new-zones</strong></span> option to be set
08c67b5b7a54047fbfed423a59b48c86177b9859Evan Hunt to <strong class="userinput"><code>yes</code></strong>. The
08c67b5b7a54047fbfed423a59b48c86177b9859Evan Hunt <em class="replaceable"><code>configuration</code></em> string
08c67b5b7a54047fbfed423a59b48c86177b9859Evan Hunt specified on the command line is the zone
08c67b5b7a54047fbfed423a59b48c86177b9859Evan Hunt configuration text that would ordinarily be
08c67b5b7a54047fbfed423a59b48c86177b9859Evan Hunt placed in <code class="filename">named.conf</code>.
08c67b5b7a54047fbfed423a59b48c86177b9859Evan Hunt The configuration is saved in a file called
08c67b5b7a54047fbfed423a59b48c86177b9859Evan Hunt <code class="filename"><em class="replaceable"><code>name</code></em>.nzf</code>,
08c67b5b7a54047fbfed423a59b48c86177b9859Evan Hunt where <em class="replaceable"><code>name</code></em> is the
08c67b5b7a54047fbfed423a59b48c86177b9859Evan Hunt name of the view, or if it contains characters
08c67b5b7a54047fbfed423a59b48c86177b9859Evan Hunt that are incompatible with use as a file name, a
08c67b5b7a54047fbfed423a59b48c86177b9859Evan Hunt cryptographic hash generated from the name
08c67b5b7a54047fbfed423a59b48c86177b9859Evan Hunt of the view.
08c67b5b7a54047fbfed423a59b48c86177b9859Evan Hunt When <span class="command"><strong>named</strong></span> is
08c67b5b7a54047fbfed423a59b48c86177b9859Evan Hunt restarted, the file will be loaded into the view
08c67b5b7a54047fbfed423a59b48c86177b9859Evan Hunt configuration, so that zones that were added
08c67b5b7a54047fbfed423a59b48c86177b9859Evan Hunt can persist after a restart.
08c67b5b7a54047fbfed423a59b48c86177b9859Evan Hunt This sample <span class="command"><strong>addzone</strong></span> command
08c67b5b7a54047fbfed423a59b48c86177b9859Evan Hunt would add the zone <code class="literal">example.com</code>
08c67b5b7a54047fbfed423a59b48c86177b9859Evan Hunt to the default view:
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<code class="prompt">$ </code><strong class="userinput"><code>rndc addzone example.com '{ type master; file "example.com.db"; };'</code></strong>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont (Note the brackets and semi-colon around the zone
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont configuration text.)
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont See also <span class="command"><strong>rndc delzone</strong></span> and <span class="command"><strong>rndc modzone</strong></span>.
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<dt><span class="term"><strong class="userinput"><code>delzone [<span class="optional">-clean</span>] <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>] </code></strong></span></dt>
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont Delete a zone while the server is running.
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont If the <code class="option">-clean</code> argument is specified,
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont the zone's master file (and journal file, if any)
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont will be deleted along with the zone. Without the
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont <code class="option">-clean</code> option, zone files must
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont be cleaned up by hand. (If the zone is of
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont type "slave" or "stub", the files needing to
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont be cleaned up will be reported in the output
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont of the <span class="command"><strong>rndc delzone</strong></span> command.)
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont If the zone was originally added via
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont <span class="command"><strong>rndc addzone</strong></span>, then it will be
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont removed permanently. However, if it was originally
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont configured in <code class="filename">named.conf</code>, then
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont that original configuration is still in place; when
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont the server is restarted or reconfigured, the zone will
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont come back. To remove it permanently, it must also be
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont removed from <code class="filename">named.conf</code>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont See also <span class="command"><strong>rndc addzone</strong></span> and <span class="command"><strong>rndc modzone</strong></span>.
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<dt><span class="term"><strong class="userinput"><code>dnstap ( -reopen | -roll [<span class="optional"><em class="replaceable"><code>number</code></em></span>] )</code></strong></span></dt>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont Close and re-open DNSTAP output files.
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont <span class="command"><strong>rndc dnstap -reopen</strong></span> allows the output
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont file to be renamed externally, then re-opened.
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont <span class="command"><strong>rndc dnstap -roll</strong></span> causes the output file
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont to be rolled automatically, similar to log files; the most
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont recent output file has ".0" appended to its name; the
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont previous most recent output file is moved to ".1", and so on.
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont If <em class="replaceable"><code>number</code></em> is specified, then the
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont number of backup log files is limited to that number.
b843f577bbcd6660fbaa506d9e55b156c689a5a8Evan Hunt<dt><span class="term"><strong class="userinput"><code>dumpdb [<span class="optional">-all|-cache|-zone|-adb|-bad|-fail</span>] [<span class="optional"><em class="replaceable"><code>view ...</code></em></span>]</code></strong></span></dt>
b843f577bbcd6660fbaa506d9e55b156c689a5a8Evan Hunt Dump the server's caches (default) and/or zones to
b843f577bbcd6660fbaa506d9e55b156c689a5a8Evan Hunt dump file for the specified views. If no view is
b843f577bbcd6660fbaa506d9e55b156c689a5a8Evan Hunt specified, all
b843f577bbcd6660fbaa506d9e55b156c689a5a8Evan Hunt views are dumped.
b843f577bbcd6660fbaa506d9e55b156c689a5a8Evan Hunt (See the <span class="command"><strong>dump-file</strong></span> option in
b843f577bbcd6660fbaa506d9e55b156c689a5a8Evan Hunt the BIND 9 Administrator Reference Manual.)
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<dt><span class="term"><strong class="userinput"><code>flush</code></strong></span></dt>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont Flushes the server's cache.
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<dt><span class="term"><strong class="userinput"><code>flushname</code></strong> <em class="replaceable"><code>name</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>] </span></dt>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont Flushes the given name from the view's DNS cache
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont and, if applicable, from the view's nameserver address
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont database, bad server cache and SERVFAIL cache.
553ead32ff5b00284e574dcabc39115d4d74ec66Evan Hunt<dt><span class="term"><strong class="userinput"><code>flushtree</code></strong> <em class="replaceable"><code>name</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>] </span></dt>
553ead32ff5b00284e574dcabc39115d4d74ec66Evan Hunt Flushes the given name, and all of its subdomains,
553ead32ff5b00284e574dcabc39115d4d74ec66Evan Hunt from the view's DNS cache, address database,
553ead32ff5b00284e574dcabc39115d4d74ec66Evan Hunt bad server cache, and SERVFAIL cache.
553ead32ff5b00284e574dcabc39115d4d74ec66Evan Hunt<dt><span class="term"><strong class="userinput"><code>freeze [<span class="optional"><em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</span>]</code></strong></span></dt>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont Suspend updates to a dynamic zone. If no zone is
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont specified, then all zones are suspended. This allows
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont manual edits to be made to a zone normally updated by
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont dynamic update. It also causes changes in the
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont journal file to be synced into the master file.
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont All dynamic update attempts will be refused while
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont the zone is frozen.
61bcc232038f0a2cb77ed6269675fdc288f5ec98Evan Hunt See also <span class="command"><strong>rndc thaw</strong></span>.
61bcc232038f0a2cb77ed6269675fdc288f5ec98Evan Hunt<dt><span class="term"><strong class="userinput"><code>halt [<span class="optional">-p</span>]</code></strong></span></dt>
61bcc232038f0a2cb77ed6269675fdc288f5ec98Evan Hunt Stop the server immediately. Recent changes
61bcc232038f0a2cb77ed6269675fdc288f5ec98Evan Hunt made through dynamic update or IXFR are not saved to
61bcc232038f0a2cb77ed6269675fdc288f5ec98Evan Hunt the master files, but will be rolled forward from the
61bcc232038f0a2cb77ed6269675fdc288f5ec98Evan Hunt journal files when the server is restarted.
61bcc232038f0a2cb77ed6269675fdc288f5ec98Evan Hunt If <code class="option">-p</code> is specified <span class="command"><strong>named</strong></span>'s process id is returned.
61bcc232038f0a2cb77ed6269675fdc288f5ec98Evan Hunt This allows an external process to determine when <span class="command"><strong>named</strong></span>
61bcc232038f0a2cb77ed6269675fdc288f5ec98Evan Hunt had completed halting.
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont See also <span class="command"><strong>rndc stop</strong></span>.
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont<dt><span class="term"><strong class="userinput"><code>loadkeys <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</code></strong></span></dt>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont Fetch all DNSSEC keys for the given zone
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont from the key directory. If they are within
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont their publication period, merge them into the
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont zone's DNSKEY RRset. Unlike <span class="command"><strong>rndc
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont sign</strong></span>, however, the zone is not
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont immediately re-signed by the new keys, but is
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont allowed to incrementally re-sign over time.
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont This command requires that the
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont <span class="command"><strong>auto-dnssec</strong></span> zone option
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont be set to <code class="literal">maintain</code>,
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont and also requires the zone to be configured to
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont allow dynamic DNS.
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont (See "Dynamic Update Policies" in the Administrator
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont Reference Manual for more details.)
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<dt><span class="term"><strong class="userinput"><code>managed-keys <em class="replaceable"><code>(status | refresh | sync)</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</code></strong></span></dt>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont When run with the "status" keyword, print the current
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont status of the managed-keys database for the specified
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont view, or for all views if none is specified. When run
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont with the "refresh" keyword, force an immediate refresh
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont of all the managed-keys in the specified view, or all
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont views. When run with the "sync" keyword, force an
8a198fa776a09beb4dabf40b73a54d9c7bd70ac9Evan Hunt immediate dump of the managed-keys database to disk (in
8a198fa776a09beb4dabf40b73a54d9c7bd70ac9Evan Hunt the file <code class="filename">managed-keys.bind</code> or
8a198fa776a09beb4dabf40b73a54d9c7bd70ac9Evan Hunt (<code class="filename"><em class="replaceable"><code>viewname</code></em>.mkeys</code>).
8a198fa776a09beb4dabf40b73a54d9c7bd70ac9Evan Hunt<dt><span class="term"><strong class="userinput"><code>modzone <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>] <em class="replaceable"><code>configuration</code></em> </code></strong></span></dt>
8a198fa776a09beb4dabf40b73a54d9c7bd70ac9Evan Hunt Modify the configuration of a zone while the server
8a198fa776a09beb4dabf40b73a54d9c7bd70ac9Evan Hunt is running. This command requires the
8a198fa776a09beb4dabf40b73a54d9c7bd70ac9Evan Hunt <span class="command"><strong>allow-new-zones</strong></span> option to be
8a198fa776a09beb4dabf40b73a54d9c7bd70ac9Evan Hunt set to <strong class="userinput"><code>yes</code></strong>. As with
8a198fa776a09beb4dabf40b73a54d9c7bd70ac9Evan Hunt <span class="command"><strong>addzone</strong></span>, the
8a198fa776a09beb4dabf40b73a54d9c7bd70ac9Evan Hunt <em class="replaceable"><code>configuration</code></em> string
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont specified on the command line is the zone
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont configuration text that would ordinarily be
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont placed in <code class="filename">named.conf</code>.
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont If the zone was originally added via
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont <span class="command"><strong>rndc addzone</strong></span>, the configuration
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont changes will be recorded permanently and will still be
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont in effect after the server is restarted or reconfigured.
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont However, if it was originally configured in
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont <code class="filename">named.conf</code>, then that original
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont configuration is still in place; when the server is
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont restarted or reconfigured, the zone will revert to
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont its original configuration. To make the changes
a165a17a81ff3285f4f4d79785fafb465e626183Evan Hunt permanent, it must also be modified in
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont See also <span class="command"><strong>rndc addzone</strong></span> and <span class="command"><strong>rndc delzone</strong></span>.
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont<dt><span class="term"><strong class="userinput"><code>notify <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</code></strong></span></dt>
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont Resend NOTIFY messages for the zone.
b843f577bbcd6660fbaa506d9e55b156c689a5a8Evan Hunt<dt><span class="term"><strong class="userinput"><code>notrace</code></strong></span></dt>
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont Sets the server's debugging level to 0.
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont See also <span class="command"><strong>rndc trace</strong></span>.
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont<dt><span class="term"><strong class="userinput"><code>nta
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont [<span class="optional">( -d | -f | -r | -l <em class="replaceable"><code>duration</code></em>)</span>]
eec29cfd40361662b25bad50e1b94f7738a8fea0Jeremy Reed <em class="replaceable"><code>domain</code></em>
b843f577bbcd6660fbaa506d9e55b156c689a5a8Evan Hunt [<span class="optional"><em class="replaceable"><code>view</code></em></span>]
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont Sets a DNSSEC negative trust anchor (NTA)
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont for <code class="option">domain</code>, with a lifetime of
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont <code class="option">duration</code>. The default lifetime is
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont configured in <code class="filename">named.conf</code> via the
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont <code class="option">nta-lifetime</code> option, and defaults to
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont one hour. The lifetime cannot exceed one week.
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont A negative trust anchor selectively disables
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont DNSSEC validation for zones that are known to be
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont failing because of misconfiguration rather than
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont an attack. When data to be validated is
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont at or below an active NTA (and above any other
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont configured trust anchors), <span class="command"><strong>named</strong></span> will
5cfe4bcb0afd71f6bc1cc2dab37a9ad6181c13f9Mark Andrews abort the DNSSEC validation process and treat the data as
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont insecure rather than bogus. This continues until the
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont NTA's lifetime is elapsed.
b843f577bbcd6660fbaa506d9e55b156c689a5a8Evan Hunt NTAs persist across restarts of the <span class="command"><strong>named</strong></span> server.
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont The NTAs for a view are saved in a file called
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont <code class="filename"><em class="replaceable"><code>name</code></em>.nta</code>,
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont where <em class="replaceable"><code>name</code></em> is the
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont name of the view, or if it contains characters
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont that are incompatible with use as a file name, a
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont cryptographic hash generated from the name
b843f577bbcd6660fbaa506d9e55b156c689a5a8Evan Hunt An existing NTA can be removed by using the
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont An NTA's lifetime can be specified with the
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont <code class="option">-lifetime</code> option. TTL-style
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont suffixes can be used to specify the lifetime in
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont seconds, minutes, or hours. If the specified NTA
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont already exists, its lifetime will be updated to the
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont new value. Setting <code class="option">lifetime</code> to zero
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont is equivalent to <code class="option">-remove</code>.
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont If <code class="option">-dump</code> is used, any other arguments
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont are ignored, and a list of existing NTAs is printed
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont (note that this may include NTAs that are expired but
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont have not yet been cleaned up).
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont Normally, <span class="command"><strong>named</strong></span> will periodically
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont test to see whether data below an NTA can now be
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont validated (see the <code class="option">nta-recheck</code> option
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont in the Administrator Reference Manual for details).
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont If data can be validated, then the NTA is regarded as
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont no longer necessary, and will be allowed to expire
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont early. The <code class="option">-force</code> overrides this
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont behavior and forces an NTA to persist for its entire
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont lifetime, regardless of whether data could be
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont validated if the NTA were not present.
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont All of these options can be shortened, i.e., to
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont <code class="option">-l</code>, <code class="option">-r</code>, <code class="option">-d</code>,
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<dt><span class="term"><strong class="userinput"><code>querylog</code></strong> [<span class="optional">on|off</span>] </span></dt>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont Enable or disable query logging. (For backward
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont compatibility, this command can also be used without
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont an argument to toggle query logging on and off.)
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont Query logging can also be enabled
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont by explicitly directing the <span class="command"><strong>queries</strong></span>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont <span class="command"><strong>category</strong></span> to a
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont <span class="command"><strong>channel</strong></span> in the
1f821c10583d9cddbaf3626a96ff8cf10cdb645bFrancis Dupont <span class="command"><strong>logging</strong></span> section of
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont <code class="filename">named.conf</code> or by specifying
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont <span class="command"><strong>querylog yes;</strong></span> in the
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont <span class="command"><strong>options</strong></span> section of
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<dt><span class="term"><strong class="userinput"><code>reconfig</code></strong></span></dt>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont Reload the configuration file and load new zones,
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont but do not reload existing zone files even if they
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont have changed.
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont This is faster than a full <span class="command"><strong>reload</strong></span> when there
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont is a large number of zones because it avoids the need
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont to examine the
08c67b5b7a54047fbfed423a59b48c86177b9859Evan Hunt modification times of the zones files.
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<dt><span class="term"><strong class="userinput"><code>recursing</code></strong></span></dt>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont Dump the list of queries <span class="command"><strong>named</strong></span> is currently
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont recursing on, and the list of domains to which iterative
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont queries are currently being sent. (The second list includes
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont the number of fetches currently active for the given domain,
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont and how many have been passed or dropped because of the
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont <code class="option">fetches-per-zone</code> option.)
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<dt><span class="term"><strong class="userinput"><code>refresh <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</code></strong></span></dt>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont Schedule zone maintenance for the given zone.
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont<dt><span class="term"><strong class="userinput"><code>reload</code></strong></span></dt>
<dt><span class="term"><strong class="userinput"><code>reload <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</code></strong></span></dt>
<dt><span class="term"><strong class="userinput"><code>retransfer <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</code></strong></span></dt>
<dt><span class="term"><strong class="userinput"><code>secroots [<span class="optional">-</span>] [<span class="optional"><em class="replaceable"><code>view ...</code></em></span>]</code></strong></span></dt>
<dt><span class="term"><strong class="userinput"><code>showzone <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>] </code></strong></span></dt>
<dt><span class="term"><strong class="userinput"><code>sign <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</code></strong></span></dt>
<dt><span class="term"><strong class="userinput"><code>signing [<span class="optional">( -list | -clear <em class="replaceable"><code>keyid/algorithm</code></em> | -clear <code class="literal">all</code> | -nsec3param ( <em class="replaceable"><code>parameters</code></em> | <code class="literal">none</code> ) | -serial <em class="replaceable"><code>value</code></em> ) </span>] <em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>] </code></strong></span></dt>
<span class="command"><strong>rndc signing -nsec3param 1 0 10 FFFF <em class="replaceable"><code>zone</code></em></strong></span>.
<span class="command"><strong>rndc signing -nsec3param 1 1 15 - <em class="replaceable"><code>zone</code></em></strong></span>.
Note that the number of zones includes the internal <span class="command"><strong>bind/CH</strong></span> zone
<dt><span class="term"><strong class="userinput"><code>stop [<span class="optional">-p</span>]</code></strong></span></dt>
If <code class="option">-p</code> is specified <span class="command"><strong>named</strong></span>'s process id is returned.
This allows an external process to determine when <span class="command"><strong>named</strong></span>
<dt><span class="term"><strong class="userinput"><code>sync [<span class="optional">-clean</span>] [<span class="optional"><em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</span>]</code></strong></span></dt>
<dt><span class="term"><strong class="userinput"><code>thaw [<span class="optional"><em class="replaceable"><code>zone</code></em> [<span class="optional"><em class="replaceable"><code>class</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span>]</span>]</code></strong></span></dt>
<dt><span class="term"><strong class="userinput"><code>trace <em class="replaceable"><code>level</code></em></code></strong></span></dt>
<dt><span class="term"><strong class="userinput"><code>tsig-delete</code></strong> <em class="replaceable"><code>keyname</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>]</span></dt>
<dt><span class="term"><strong class="userinput"><code>validation ( on | off | check ) [<span class="optional"><em class="replaceable"><code>view ...</code></em></span>] </code></strong></span></dt>