rndc.html revision 4677c85720e7d949a5653e793cf8fa4aa81fa37a
4677c85720e7d949a5653e793cf8fa4aa81fa37aTinderbox User - Copyright (C) 2004, 2005, 2007, 2013-2016 Internet Systems Consortium, Inc. ("ISC")
75c0816e8295e180f4bc7f10db3d0d880383bc1cMark Andrews - Copyright (C) 2000, 2001 Internet Software Consortium.
4a14ce5ba00ab7bc55c99ffdcf59c7a4ab902721Automatic Updater - Permission to use, copy, modify, and/or distribute this software for any
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley - purpose with or without fee is hereby granted, provided that the above
4610465ed9408cbe434dbfb8be8ea53f48969c91Bob Halley - copyright notice and this permission notice appear in all copies.
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<a name="man.rndc"></a><div class="titlepage"></div>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<p><span class="application">rndc</span> — name server control utility</p>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<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>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<p><span class="command"><strong>rndc</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein controls the operation of a name
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User server. It supersedes the <span class="command"><strong>ndc</strong></span> utility
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein that was provided in old BIND releases. If
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>rndc</strong></span> is invoked with no command line
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein options or arguments, it prints a short summary of the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein supported commands and the available options and their
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<p><span class="command"><strong>rndc</strong></span>
b2f07642fd712c8fda81a116bcdde229ab291f33Tinderbox User communicates with the name server over a TCP connection, sending
b2f07642fd712c8fda81a116bcdde229ab291f33Tinderbox User commands authenticated with digital signatures. In the current
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>rndc</strong></span> and <span class="command"><strong>named</strong></span>,
b2f07642fd712c8fda81a116bcdde229ab291f33Tinderbox User the only supported authentication algorithms are HMAC-MD5
b2f07642fd712c8fda81a116bcdde229ab291f33Tinderbox User (for compatibility), HMAC-SHA1, HMAC-SHA224, HMAC-SHA256
b2f07642fd712c8fda81a116bcdde229ab291f33Tinderbox User (default), HMAC-SHA384 and HMAC-SHA512.
b2f07642fd712c8fda81a116bcdde229ab291f33Tinderbox User They use a shared secret on each end of the connection.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein This provides TSIG-style authentication for the command
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein request and the name server's response. All commands sent
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein over the channel must be signed by a key_id known to the
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<p><span class="command"><strong>rndc</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein reads a configuration file to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein determine how to contact the name server and decide what
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein algorithm and key it should use.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<div class="variablelist"><dl class="variablelist">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-b <em class="replaceable"><code>source-address</code></em></span></dt>
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User Use <em class="replaceable"><code>source-address</code></em>
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User as the source address for the connection to the server.
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User Multiple instances are permitted to allow setting of both
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User the IPv4 and IPv6 source addresses.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User Use <em class="replaceable"><code>config-file</code></em>
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User as the configuration file instead of the default,
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User <code class="filename">/etc/rndc.conf</code>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-k <em class="replaceable"><code>key-file</code></em></span></dt>
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User Use <em class="replaceable"><code>key-file</code></em>
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User as the key file instead of the default,
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User <code class="filename">/etc/rndc.key</code>. The key in
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User <code class="filename">/etc/rndc.key</code> will be used to
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User commands sent to the server if the <em class="replaceable"><code>config-file</code></em>
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User does not exist.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-s <em class="replaceable"><code>server</code></em></span></dt>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<dd><p><em class="replaceable"><code>server</code></em> is
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User the name or address of the server which matches a
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User server statement in the configuration file for
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>rndc</strong></span>. If no server is supplied on the
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User command line, the host named by the default-server clause
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User in the options statement of the <span class="command"><strong>rndc</strong></span>
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User configuration file will be used.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User Send commands to TCP port
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User <em class="replaceable"><code>port</code></em>
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User of BIND 9's default control channel port, 953.
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User Quiet mode: Message text returned by the server
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User will not be printed except when there is an error.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User Instructs <span class="command"><strong>rndc</strong></span> to print the result code
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User returned by <span class="command"><strong>named</strong></span> after executing the
6d45011a65dfc43f476ca15c3fd9ee5227eb968fTinderbox User requested command (e.g., ISC_R_SUCCESS, ISC_R_FAILURE, etc).
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User Enable verbose logging.
c247e3f281613fabe1af362e9f3157e35ebbe52cMark Andrews<dt><span class="term">-y <em class="replaceable"><code>key_id</code></em></span></dt>
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User Use the key <em class="replaceable"><code>key_id</code></em>
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User from the configuration file.
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User <em class="replaceable"><code>key_id</code></em>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User known by <span class="command"><strong>named</strong></span> with the same algorithm and secret string
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User in order for control message validation to succeed.
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User If no <em class="replaceable"><code>key_id</code></em>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User is specified, <span class="command"><strong>rndc</strong></span> will first look
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User for a key clause in the server statement of the server
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User being used, or if no server statement is present for that
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User host, then the default-key clause of the options statement.
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User Note that the configuration file contains shared secrets
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User which are used to send authenticated control commands
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User to name servers. It should therefore not have general read
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User or write access.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User A list of commands supported by <span class="command"><strong>rndc</strong></span> can
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User be seen by running <span class="command"><strong>rndc</strong></span> without arguments.
0ccb0e98c77a9b9636a036f8f64f5679a430aaf4Tinderbox User Currently supported commands are:
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<div class="variablelist"><dl class="variablelist">
395c95214142142854509945adf3293c0270e1c5Tinderbox User<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>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Add a zone while the server is running. This
395c95214142142854509945adf3293c0270e1c5Tinderbox User command requires the
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>allow-new-zones</strong></span> option to be set
395c95214142142854509945adf3293c0270e1c5Tinderbox User to <strong class="userinput"><code>yes</code></strong>. The
395c95214142142854509945adf3293c0270e1c5Tinderbox User <em class="replaceable"><code>configuration</code></em> string
395c95214142142854509945adf3293c0270e1c5Tinderbox User specified on the command line is the zone
395c95214142142854509945adf3293c0270e1c5Tinderbox User configuration text that would ordinarily be
395c95214142142854509945adf3293c0270e1c5Tinderbox User placed in <code class="filename">named.conf</code>.
395c95214142142854509945adf3293c0270e1c5Tinderbox User The configuration is saved in a file called
395c95214142142854509945adf3293c0270e1c5Tinderbox User <code class="filename"><em class="replaceable"><code>name</code></em>.nzf</code>,
395c95214142142854509945adf3293c0270e1c5Tinderbox User where <em class="replaceable"><code>name</code></em> is the
395c95214142142854509945adf3293c0270e1c5Tinderbox User name of the view, or if it contains characters
395c95214142142854509945adf3293c0270e1c5Tinderbox User that are incompatible with use as a file name, a
395c95214142142854509945adf3293c0270e1c5Tinderbox User cryptographic hash generated from the name
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User When <span class="command"><strong>named</strong></span> is
395c95214142142854509945adf3293c0270e1c5Tinderbox User restarted, the file will be loaded into the view
395c95214142142854509945adf3293c0270e1c5Tinderbox User configuration, so that zones that were added
395c95214142142854509945adf3293c0270e1c5Tinderbox User can persist after a restart.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User This sample <span class="command"><strong>addzone</strong></span> command
395c95214142142854509945adf3293c0270e1c5Tinderbox User would add the zone <code class="literal">example.com</code>
395c95214142142854509945adf3293c0270e1c5Tinderbox User to the default view:
395c95214142142854509945adf3293c0270e1c5Tinderbox User<code class="prompt">$ </code><strong class="userinput"><code>rndc addzone example.com '{ type master; file "example.com.db"; };'</code></strong>
395c95214142142854509945adf3293c0270e1c5Tinderbox User (Note the brackets and semi-colon around the zone
395c95214142142854509945adf3293c0270e1c5Tinderbox User configuration text.)
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User See also <span class="command"><strong>rndc delzone</strong></span> and <span class="command"><strong>rndc modzone</strong></span>.
395c95214142142854509945adf3293c0270e1c5Tinderbox User<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>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Delete a zone while the server is running.
6d45011a65dfc43f476ca15c3fd9ee5227eb968fTinderbox User If the <code class="option">-clean</code> argument is specified,
395c95214142142854509945adf3293c0270e1c5Tinderbox User the zone's master file (and journal file, if any)
395c95214142142854509945adf3293c0270e1c5Tinderbox User will be deleted along with the zone. Without the
395c95214142142854509945adf3293c0270e1c5Tinderbox User <code class="option">-clean</code> option, zone files must
395c95214142142854509945adf3293c0270e1c5Tinderbox User be cleaned up by hand. (If the zone is of
395c95214142142854509945adf3293c0270e1c5Tinderbox User type "slave" or "stub", the files needing to
395c95214142142854509945adf3293c0270e1c5Tinderbox User be cleaned up will be reported in the output
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User of the <span class="command"><strong>rndc delzone</strong></span> command.)
395c95214142142854509945adf3293c0270e1c5Tinderbox User If the zone was originally added via
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>rndc addzone</strong></span>, then it will be
395c95214142142854509945adf3293c0270e1c5Tinderbox User removed permanently. However, if it was originally
395c95214142142854509945adf3293c0270e1c5Tinderbox User configured in <code class="filename">named.conf</code>, then
395c95214142142854509945adf3293c0270e1c5Tinderbox User that original configuration is still in place; when
395c95214142142854509945adf3293c0270e1c5Tinderbox User the server is restarted or reconfigured, the zone will
395c95214142142854509945adf3293c0270e1c5Tinderbox User come back. To remove it permanently, it must also be
395c95214142142854509945adf3293c0270e1c5Tinderbox User removed from <code class="filename">named.conf</code>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User See also <span class="command"><strong>rndc addzone</strong></span> and <span class="command"><strong>rndc modzone</strong></span>.
76cf91b5df7a1bc450afcb9ce7585c61bb87de68Tinderbox User<dt><span class="term"><strong class="userinput"><code>dnstap-reopen</code></strong></span></dt>
76cf91b5df7a1bc450afcb9ce7585c61bb87de68Tinderbox User Close and re-open DNSTAP output files. This allows the files
76cf91b5df7a1bc450afcb9ce7585c61bb87de68Tinderbox User to be renamed externally then to be re-opened.
c0cbdeedb5e119c640f098da1851cb1b9adcc739Tinderbox User<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>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Dump the server's caches (default) and/or zones to
395c95214142142854509945adf3293c0270e1c5Tinderbox User dump file for the specified views. If no view is
395c95214142142854509945adf3293c0270e1c5Tinderbox User specified, all
395c95214142142854509945adf3293c0270e1c5Tinderbox User views are dumped.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User (See the <span class="command"><strong>dump-file</strong></span> option in
395c95214142142854509945adf3293c0270e1c5Tinderbox User the BIND 9 Administrator Reference Manual.)
395c95214142142854509945adf3293c0270e1c5Tinderbox User<dt><span class="term"><strong class="userinput"><code>flush</code></strong></span></dt>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Flushes the server's cache.
395c95214142142854509945adf3293c0270e1c5Tinderbox User<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>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Flushes the given name from the view's DNS cache
395c95214142142854509945adf3293c0270e1c5Tinderbox User and, if applicable, from the view's nameserver address
395c95214142142854509945adf3293c0270e1c5Tinderbox User database, bad server cache and SERVFAIL cache.
395c95214142142854509945adf3293c0270e1c5Tinderbox User<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>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Flushes the given name, and all of its subdomains,
395c95214142142854509945adf3293c0270e1c5Tinderbox User from the view's DNS cache, address database,
395c95214142142854509945adf3293c0270e1c5Tinderbox User bad server cache, and SERVFAIL cache.
395c95214142142854509945adf3293c0270e1c5Tinderbox User<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>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Suspend updates to a dynamic zone. If no zone is
395c95214142142854509945adf3293c0270e1c5Tinderbox User specified, then all zones are suspended. This allows
395c95214142142854509945adf3293c0270e1c5Tinderbox User manual edits to be made to a zone normally updated by
395c95214142142854509945adf3293c0270e1c5Tinderbox User dynamic update. It also causes changes in the
395c95214142142854509945adf3293c0270e1c5Tinderbox User journal file to be synced into the master file.
395c95214142142854509945adf3293c0270e1c5Tinderbox User All dynamic update attempts will be refused while
395c95214142142854509945adf3293c0270e1c5Tinderbox User the zone is frozen.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User See also <span class="command"><strong>rndc thaw</strong></span>.
395c95214142142854509945adf3293c0270e1c5Tinderbox User<dt><span class="term"><strong class="userinput"><code>halt [<span class="optional">-p</span>]</code></strong></span></dt>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Stop the server immediately. Recent changes
395c95214142142854509945adf3293c0270e1c5Tinderbox User made through dynamic update or IXFR are not saved to
395c95214142142854509945adf3293c0270e1c5Tinderbox User the master files, but will be rolled forward from the
395c95214142142854509945adf3293c0270e1c5Tinderbox User journal files when the server is restarted.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User If <code class="option">-p</code> is specified <span class="command"><strong>named</strong></span>'s process id is returned.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User This allows an external process to determine when <span class="command"><strong>named</strong></span>
395c95214142142854509945adf3293c0270e1c5Tinderbox User had completed halting.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User See also <span class="command"><strong>rndc stop</strong></span>.
0ccb0e98c77a9b9636a036f8f64f5679a430aaf4Tinderbox User<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>
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User Fetch all DNSSEC keys for the given zone
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User from the key directory. If they are within
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User their publication period, merge them into the
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User zone's DNSKEY RRset. Unlike <span class="command"><strong>rndc
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User sign</strong></span>, however, the zone is not
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User immediately re-signed by the new keys, but is
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User allowed to incrementally re-sign over time.
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User This command requires that the
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>auto-dnssec</strong></span> zone option
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User be set to <code class="literal">maintain</code>,
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User and also requires the zone to be configured to
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User allow dynamic DNS.
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User (See "Dynamic Update Policies" in the Administrator
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User Reference Manual for more details.)
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User<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>
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User When run with the "status" keyword, print the current
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User status of the managed-keys database for the specified
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User view, or for all views if none is specified. When run
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User with the "refresh" keyword, force an immediate refresh
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User of all the managed-keys in the specified view, or all
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User views. When run with the "sync" keyword, force an
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User immediate dump of the managed-keys database to disk (in
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User the file <code class="filename">managed-keys.bind</code> or
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User (<code class="filename"><em class="replaceable"><code>viewname</code></em>.mkeys</code>).
395c95214142142854509945adf3293c0270e1c5Tinderbox User<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>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Modify the configuration of a zone while the server
395c95214142142854509945adf3293c0270e1c5Tinderbox User is running. This command requires the
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>allow-new-zones</strong></span> option to be
395c95214142142854509945adf3293c0270e1c5Tinderbox User set to <strong class="userinput"><code>yes</code></strong>. As with
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>addzone</strong></span>, the
395c95214142142854509945adf3293c0270e1c5Tinderbox User <em class="replaceable"><code>configuration</code></em> string
395c95214142142854509945adf3293c0270e1c5Tinderbox User specified on the command line is the zone
395c95214142142854509945adf3293c0270e1c5Tinderbox User configuration text that would ordinarily be
395c95214142142854509945adf3293c0270e1c5Tinderbox User placed in <code class="filename">named.conf</code>.
395c95214142142854509945adf3293c0270e1c5Tinderbox User If the zone was originally added via
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>rndc addzone</strong></span>, the configuration
395c95214142142854509945adf3293c0270e1c5Tinderbox User changes will be recorded permanently and will still be
395c95214142142854509945adf3293c0270e1c5Tinderbox User in effect after the server is restarted or reconfigured.
395c95214142142854509945adf3293c0270e1c5Tinderbox User However, if it was originally configured in
395c95214142142854509945adf3293c0270e1c5Tinderbox User <code class="filename">named.conf</code>, then that original
395c95214142142854509945adf3293c0270e1c5Tinderbox User configuration is still in place; when the server is
395c95214142142854509945adf3293c0270e1c5Tinderbox User restarted or reconfigured, the zone will revert to
395c95214142142854509945adf3293c0270e1c5Tinderbox User its original configuration. To make the changes
395c95214142142854509945adf3293c0270e1c5Tinderbox User permanent, it must also be modified in
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User See also <span class="command"><strong>rndc addzone</strong></span> and <span class="command"><strong>rndc delzone</strong></span>.
395c95214142142854509945adf3293c0270e1c5Tinderbox User<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>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Resend NOTIFY messages for the zone.
395c95214142142854509945adf3293c0270e1c5Tinderbox User<dt><span class="term"><strong class="userinput"><code>notrace</code></strong></span></dt>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Sets the server's debugging level to 0.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User See also <span class="command"><strong>rndc trace</strong></span>.
61ab11c0ec845606f85452b2c9f2e223772aae00Tinderbox User<dt><span class="term"><strong class="userinput"><code>nta
61ab11c0ec845606f85452b2c9f2e223772aae00Tinderbox User [<span class="optional">( -d | -f | -r | -l <em class="replaceable"><code>duration</code></em>)</span>]
61ab11c0ec845606f85452b2c9f2e223772aae00Tinderbox User <em class="replaceable"><code>domain</code></em>
61ab11c0ec845606f85452b2c9f2e223772aae00Tinderbox User [<span class="optional"><em class="replaceable"><code>view</code></em></span>]
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User Sets a DNSSEC negative trust anchor (NTA)
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User for <code class="option">domain</code>, with a lifetime of
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User <code class="option">duration</code>. The default lifetime is
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User configured in <code class="filename">named.conf</code> via the
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User <code class="option">nta-lifetime</code> option, and defaults to
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User one hour. The lifetime cannot exceed one week.
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User A negative trust anchor selectively disables
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User DNSSEC validation for zones that are known to be
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User failing because of misconfiguration rather than
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User an attack. When data to be validated is
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User at or below an active NTA (and above any other
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User configured trust anchors), <span class="command"><strong>named</strong></span> will
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User abort the DNSSEC validation process and treat the data as
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User insecure rather than bogus. This continues until the
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User NTA's lifetime is elapsed.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User NTAs persist across restarts of the <span class="command"><strong>named</strong></span> server.
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User The NTAs for a view are saved in a file called
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User <code class="filename"><em class="replaceable"><code>name</code></em>.nta</code>,
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User where <em class="replaceable"><code>name</code></em> is the
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User name of the view, or if it contains characters
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User that are incompatible with use as a file name, a
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User cryptographic hash generated from the name
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User An existing NTA can be removed by using the
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User An NTA's lifetime can be specified with the
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User <code class="option">-lifetime</code> option. TTL-style
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User suffixes can be used to specify the lifetime in
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User seconds, minutes, or hours. If the specified NTA
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User already exists, its lifetime will be updated to the
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User new value. Setting <code class="option">lifetime</code> to zero
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User is equivalent to <code class="option">-remove</code>.
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User If <code class="option">-dump</code> is used, any other arguments
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User are ignored, and a list of existing NTAs is printed
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User (note that this may include NTAs that are expired but
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User have not yet been cleaned up).
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User Normally, <span class="command"><strong>named</strong></span> will periodically
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User test to see whether data below an NTA can now be
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User validated (see the <code class="option">nta-recheck</code> option
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User in the Administrator Reference Manual for details).
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User If data can be validated, then the NTA is regarded as
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User no longer necessary, and will be allowed to expire
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User early. The <code class="option">-force</code> overrides this
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User behavior and forces an NTA to persist for its entire
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User lifetime, regardless of whether data could be
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User validated if the NTA were not present.
395c95214142142854509945adf3293c0270e1c5Tinderbox User All of these options can be shortened, i.e., to
395c95214142142854509945adf3293c0270e1c5Tinderbox User <code class="option">-l</code>, <code class="option">-r</code>, <code class="option">-d</code>,
395c95214142142854509945adf3293c0270e1c5Tinderbox User<dt><span class="term"><strong class="userinput"><code>querylog</code></strong> [<span class="optional">on|off</span>] </span></dt>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Enable or disable query logging. (For backward
395c95214142142854509945adf3293c0270e1c5Tinderbox User compatibility, this command can also be used without
395c95214142142854509945adf3293c0270e1c5Tinderbox User an argument to toggle query logging on and off.)
395c95214142142854509945adf3293c0270e1c5Tinderbox User Query logging can also be enabled
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User by explicitly directing the <span class="command"><strong>queries</strong></span>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>category</strong></span> to a
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>channel</strong></span> in the
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>logging</strong></span> section of
395c95214142142854509945adf3293c0270e1c5Tinderbox User <code class="filename">named.conf</code> or by specifying
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>querylog yes;</strong></span> in the
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>options</strong></span> section of
395c95214142142854509945adf3293c0270e1c5Tinderbox User<dt><span class="term"><strong class="userinput"><code>reconfig</code></strong></span></dt>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Reload the configuration file and load new zones,
395c95214142142854509945adf3293c0270e1c5Tinderbox User but do not reload existing zone files even if they
395c95214142142854509945adf3293c0270e1c5Tinderbox User have changed.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User This is faster than a full <span class="command"><strong>reload</strong></span> when there
395c95214142142854509945adf3293c0270e1c5Tinderbox User is a large number of zones because it avoids the need
395c95214142142854509945adf3293c0270e1c5Tinderbox User to examine the
395c95214142142854509945adf3293c0270e1c5Tinderbox User modification times of the zones files.
395c95214142142854509945adf3293c0270e1c5Tinderbox User<dt><span class="term"><strong class="userinput"><code>recursing</code></strong></span></dt>
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User Dump the list of queries <span class="command"><strong>named</strong></span> is currently
c0cbdeedb5e119c640f098da1851cb1b9adcc739Tinderbox User recursing on, and the list of domains to which iterative
c0cbdeedb5e119c640f098da1851cb1b9adcc739Tinderbox User queries are currently being sent. (The second list includes
c0cbdeedb5e119c640f098da1851cb1b9adcc739Tinderbox User the number of fetches currently active for the given domain,
c0cbdeedb5e119c640f098da1851cb1b9adcc739Tinderbox User and how many have been passed or dropped because of the
c0cbdeedb5e119c640f098da1851cb1b9adcc739Tinderbox User <code class="option">fetches-per-zone</code> option.)
395c95214142142854509945adf3293c0270e1c5Tinderbox User<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>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Schedule zone maintenance for the given zone.
395c95214142142854509945adf3293c0270e1c5Tinderbox User<dt><span class="term"><strong class="userinput"><code>reload</code></strong></span></dt>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Reload configuration file and zones.
395c95214142142854509945adf3293c0270e1c5Tinderbox User<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>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Reload the given zone.
395c95214142142854509945adf3293c0270e1c5Tinderbox User<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>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Retransfer the given slave zone from the master server.
395c95214142142854509945adf3293c0270e1c5Tinderbox User If the zone is configured to use
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>inline-signing</strong></span>, the signed
395c95214142142854509945adf3293c0270e1c5Tinderbox User version of the zone is discarded; after the
395c95214142142854509945adf3293c0270e1c5Tinderbox User retransfer of the unsigned version is complete, the
395c95214142142854509945adf3293c0270e1c5Tinderbox User signed version will be regenerated with all new
395c95214142142854509945adf3293c0270e1c5Tinderbox User<dt><span class="term"><strong class="userinput"><code>scan</code></strong></span></dt>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Scan the list of available network interfaces
395c95214142142854509945adf3293c0270e1c5Tinderbox User for changes, without performing a full
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>reconfig</strong></span> or waiting for the
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>interface-interval</strong></span> timer.
395c95214142142854509945adf3293c0270e1c5Tinderbox User<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>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Dump the server's security roots and negative trust anchors
395c95214142142854509945adf3293c0270e1c5Tinderbox User for the specified views. If no view is specified, all views
395c95214142142854509945adf3293c0270e1c5Tinderbox User If the first argument is "-", then the output is
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User returned via the <span class="command"><strong>rndc</strong></span> response channel
395c95214142142854509945adf3293c0270e1c5Tinderbox User and printed to the standard output.
395c95214142142854509945adf3293c0270e1c5Tinderbox User Otherwise, it is written to the secroots dump file, which
395c95214142142854509945adf3293c0270e1c5Tinderbox User defaults to <code class="filename">named.secroots</code>, but can be
395c95214142142854509945adf3293c0270e1c5Tinderbox User overridden via the <code class="option">secroots-file</code> option in
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User See also <span class="command"><strong>rndc managed-keys</strong></span>.
395c95214142142854509945adf3293c0270e1c5Tinderbox User<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>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Print the configuration of a running zone.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User See also <span class="command"><strong>rndc zonestatus</strong></span>.
395c95214142142854509945adf3293c0270e1c5Tinderbox User<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>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Fetch all DNSSEC keys for the given zone
395c95214142142854509945adf3293c0270e1c5Tinderbox User from the key directory (see the
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>key-directory</strong></span> option in
395c95214142142854509945adf3293c0270e1c5Tinderbox User the BIND 9 Administrator Reference Manual). If they are within
395c95214142142854509945adf3293c0270e1c5Tinderbox User their publication period, merge them into the
395c95214142142854509945adf3293c0270e1c5Tinderbox User zone's DNSKEY RRset. If the DNSKEY RRset
395c95214142142854509945adf3293c0270e1c5Tinderbox User is changed, then the zone is automatically
395c95214142142854509945adf3293c0270e1c5Tinderbox User re-signed with the new key set.
395c95214142142854509945adf3293c0270e1c5Tinderbox User This command requires that the
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>auto-dnssec</strong></span> zone option be set
395c95214142142854509945adf3293c0270e1c5Tinderbox User and also requires the zone to be configured to
395c95214142142854509945adf3293c0270e1c5Tinderbox User allow dynamic DNS.
395c95214142142854509945adf3293c0270e1c5Tinderbox User (See "Dynamic Update Policies" in the Administrator
395c95214142142854509945adf3293c0270e1c5Tinderbox User Reference Manual for more details.)
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User See also <span class="command"><strong>rndc loadkeys</strong></span>.
eaaf00efc02fdd4965f747afb51f881ac5a389d2Tinderbox User<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>
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User List, edit, or remove the DNSSEC signing state records
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User for the specified zone. The status of ongoing DNSSEC
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User operations (such as signing or generating
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User NSEC3 chains) is stored in the zone in the form
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User of DNS resource records of type
9d557856c2a19ec95ee73245f60a92f8675cf5baTinderbox User <span class="command"><strong>sig-signing-type</strong></span>.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>rndc signing -list</strong></span> converts
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User these records into a human-readable form,
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User indicating which keys are currently signing
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User or have finished signing the zone, and which NSEC3
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User chains are being created or removed.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>rndc signing -clear</strong></span> can remove
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User a single key (specified in the same format that
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>rndc signing -list</strong></span> uses to
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User display it), or all keys. In either case, only
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User completed keys are removed; any record indicating
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User that a key has not yet finished signing the zone
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User will be retained.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>rndc signing -nsec3param</strong></span> sets
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User the NSEC3 parameters for a zone. This is the
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User only supported mechanism for using NSEC3 with
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>inline-signing</strong></span> zones.
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User Parameters are specified in the same format as
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User an NSEC3PARAM resource record: hash algorithm,
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User flags, iterations, and salt, in that order.
9d557856c2a19ec95ee73245f60a92f8675cf5baTinderbox User Currently, the only defined value for hash algorithm
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User is <code class="literal">1</code>, representing SHA-1.
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User The <code class="option">flags</code> may be set to
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User <code class="literal">0</code> or <code class="literal">1</code>,
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User depending on whether you wish to set the opt-out
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User bit in the NSEC3 chain. <code class="option">iterations</code>
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User defines the number of additional times to apply
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User the algorithm when generating an NSEC3 hash. The
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User <code class="option">salt</code> is a string of data expressed
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User in hexadecimal, a hyphen (`-') if no salt is
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User to be used, or the keyword <code class="literal">auto</code>,
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User which causes <span class="command"><strong>named</strong></span> to generate a
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User random 64-bit salt.
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User So, for example, to create an NSEC3 chain using
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User the SHA-1 hash algorithm, no opt-out flag,
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User 10 iterations, and a salt value of "FFFF", use:
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>rndc signing -nsec3param 1 0 10 FFFF <em class="replaceable"><code>zone</code></em></strong></span>.
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User To set the opt-out flag, 15 iterations, and no
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>rndc signing -nsec3param 1 1 15 - <em class="replaceable"><code>zone</code></em></strong></span>.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>rndc signing -nsec3param none</strong></span>
659d063f23a35d77ad5826e6556d3137672bb937Tinderbox User removes an existing NSEC3 chain and replaces it
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>rndc signing -serial value</strong></span> sets
eaaf00efc02fdd4965f747afb51f881ac5a389d2Tinderbox User the serial number of the zone to value. If the value
eaaf00efc02fdd4965f747afb51f881ac5a389d2Tinderbox User would cause the serial number to go backwards it will
eaaf00efc02fdd4965f747afb51f881ac5a389d2Tinderbox User be rejected. The primary use is to set the serial on
eaaf00efc02fdd4965f747afb51f881ac5a389d2Tinderbox User inline signed zones.
395c95214142142854509945adf3293c0270e1c5Tinderbox User<dt><span class="term"><strong class="userinput"><code>stats</code></strong></span></dt>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Write server statistics to the statistics file.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User (See the <span class="command"><strong>statistics-file</strong></span> option in
395c95214142142854509945adf3293c0270e1c5Tinderbox User the BIND 9 Administrator Reference Manual.)
395c95214142142854509945adf3293c0270e1c5Tinderbox User<dt><span class="term"><strong class="userinput"><code>status</code></strong></span></dt>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Display status of the server.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User Note that the number of zones includes the internal <span class="command"><strong>bind/CH</strong></span> zone
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User and the default <span class="command"><strong>/IN</strong></span>
395c95214142142854509945adf3293c0270e1c5Tinderbox User hint zone if there is not an
395c95214142142854509945adf3293c0270e1c5Tinderbox User explicit root zone configured.
395c95214142142854509945adf3293c0270e1c5Tinderbox User<dt><span class="term"><strong class="userinput"><code>stop [<span class="optional">-p</span>]</code></strong></span></dt>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Stop the server, making sure any recent changes
395c95214142142854509945adf3293c0270e1c5Tinderbox User made through dynamic update or IXFR are first saved to
395c95214142142854509945adf3293c0270e1c5Tinderbox User the master files of the updated zones.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User If <code class="option">-p</code> is specified <span class="command"><strong>named</strong></span>'s process id is returned.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User This allows an external process to determine when <span class="command"><strong>named</strong></span>
395c95214142142854509945adf3293c0270e1c5Tinderbox User had completed stopping.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<p>See also <span class="command"><strong>rndc halt</strong></span>.</p>
395c95214142142854509945adf3293c0270e1c5Tinderbox User<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>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Sync changes in the journal file for a dynamic zone
395c95214142142854509945adf3293c0270e1c5Tinderbox User to the master file. If the "-clean" option is
395c95214142142854509945adf3293c0270e1c5Tinderbox User specified, the journal file is also removed. If
395c95214142142854509945adf3293c0270e1c5Tinderbox User no zone is specified, then all zones are synced.
395c95214142142854509945adf3293c0270e1c5Tinderbox User<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>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Enable updates to a frozen dynamic zone. If no
395c95214142142854509945adf3293c0270e1c5Tinderbox User zone is specified, then all frozen zones are
395c95214142142854509945adf3293c0270e1c5Tinderbox User enabled. This causes the server to reload the zone
395c95214142142854509945adf3293c0270e1c5Tinderbox User from disk, and re-enables dynamic updates after the
395c95214142142854509945adf3293c0270e1c5Tinderbox User load has completed. After a zone is thawed,
395c95214142142854509945adf3293c0270e1c5Tinderbox User dynamic updates will no longer be refused. If
395c95214142142854509945adf3293c0270e1c5Tinderbox User the zone has changed and the
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User <span class="command"><strong>ixfr-from-differences</strong></span> option is
395c95214142142854509945adf3293c0270e1c5Tinderbox User in use, then the journal file will be updated to
395c95214142142854509945adf3293c0270e1c5Tinderbox User reflect changes in the zone. Otherwise, if the
395c95214142142854509945adf3293c0270e1c5Tinderbox User zone has changed, any existing journal file will be
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<p>See also <span class="command"><strong>rndc freeze</strong></span>.</p>
395c95214142142854509945adf3293c0270e1c5Tinderbox User<dt><span class="term"><strong class="userinput"><code>trace</code></strong></span></dt>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Increment the servers debugging level by one.
395c95214142142854509945adf3293c0270e1c5Tinderbox User<dt><span class="term"><strong class="userinput"><code>trace <em class="replaceable"><code>level</code></em></code></strong></span></dt>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Sets the server's debugging level to an explicit
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User See also <span class="command"><strong>rndc notrace</strong></span>.
395c95214142142854509945adf3293c0270e1c5Tinderbox User<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>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Delete a given TKEY-negotiated key from the server.
395c95214142142854509945adf3293c0270e1c5Tinderbox User (This does not apply to statically configured TSIG
395c95214142142854509945adf3293c0270e1c5Tinderbox User<dt><span class="term"><strong class="userinput"><code>tsig-list</code></strong></span></dt>
395c95214142142854509945adf3293c0270e1c5Tinderbox User List the names of all TSIG keys currently configured
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User for use by <span class="command"><strong>named</strong></span> in each view. The
395c95214142142854509945adf3293c0270e1c5Tinderbox User list both statically configured keys and dynamic
395c95214142142854509945adf3293c0270e1c5Tinderbox User TKEY-negotiated keys.
395c95214142142854509945adf3293c0270e1c5Tinderbox User<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>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Enable, disable, or check the current status of
395c95214142142854509945adf3293c0270e1c5Tinderbox User DNSSEC validation.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User Note <span class="command"><strong>dnssec-enable</strong></span> also needs to be
395c95214142142854509945adf3293c0270e1c5Tinderbox User set to <strong class="userinput"><code>yes</code></strong> or
395c95214142142854509945adf3293c0270e1c5Tinderbox User <strong class="userinput"><code>auto</code></strong> to be effective.
395c95214142142854509945adf3293c0270e1c5Tinderbox User It defaults to enabled.
b3338fc248b647e1a88a824a62e809a5b94c076cTinderbox User<dt><span class="term"><strong class="userinput"><code>zonestatus <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>
395c95214142142854509945adf3293c0270e1c5Tinderbox User Displays the current status of the given zone,
395c95214142142854509945adf3293c0270e1c5Tinderbox User including the master file name and any include
395c95214142142854509945adf3293c0270e1c5Tinderbox User files from which it was loaded, when it was most
395c95214142142854509945adf3293c0270e1c5Tinderbox User recently loaded, the current serial number, the
395c95214142142854509945adf3293c0270e1c5Tinderbox User number of nodes, whether the zone supports
395c95214142142854509945adf3293c0270e1c5Tinderbox User dynamic updates, whether the zone is DNSSEC
395c95214142142854509945adf3293c0270e1c5Tinderbox User signed, whether it uses automatic DNSSEC key
395c95214142142854509945adf3293c0270e1c5Tinderbox User management or inline signing, and the scheduled
395c95214142142854509945adf3293c0270e1c5Tinderbox User refresh or expiry times for the zone.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User See also <span class="command"><strong>rndc showzone</strong></span>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein There is currently no way to provide the shared secret for a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="option">key_id</code> without using the configuration file.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Several error messages could be clearer.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<p><span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <span class="citerefentry"><span class="refentrytitle">rndc-confgen</span>(8)</span>,
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <span class="citerefentry"><span class="refentrytitle">ndc</span>(8)</span>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <em class="citetitle">BIND 9 Administrator Reference Manual</em>.