man.rndc.html revision 6d45011a65dfc43f476ca15c3fd9ee5227eb968f
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass - Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC")
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass - Copyright (C) 2000-2003 Internet Software Consortium.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass - Permission to use, copy, modify, and/or distribute this software for any
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass - purpose with or without fee is hereby granted, provided that the above
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass - copyright notice and this permission notice appear in all copies.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass - PERFORMANCE OF THIS SOFTWARE.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<!-- $Id$ -->
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<link rel="prev" href="man.nsupdate.html" title="nsupdate">
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<link rel="next" href="man.rndc.conf.html" title="rndc.conf">
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<tr><th colspan="3" align="center"><span class="application">rndc</span></th></tr>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<a accesskey="p" href="man.nsupdate.html">Prev</a>�</td>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<td width="20%" align="right">�<a accesskey="n" href="man.rndc.conf.html">Next</a>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<a name="man.rndc"></a><div class="titlepage"></div>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<p><span class="application">rndc</span> — name server control utility</p>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<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>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<p><span><strong class="command">rndc</strong></span>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass controls the operation of a name
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass server. It supersedes the <span><strong class="command">ndc</strong></span> utility
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass that was provided in old BIND releases. If
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass <span><strong class="command">rndc</strong></span> is invoked with no command line
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass options or arguments, it prints a short summary of the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass supported commands and the available options and their
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<p><span><strong class="command">rndc</strong></span>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass communicates with the name server over a TCP connection, sending
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass commands authenticated with digital signatures. In the current
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass <span><strong class="command">rndc</strong></span> and <span><strong class="command">named</strong></span>,
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass the only supported authentication algorithms are HMAC-MD5
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass (for compatibility), HMAC-SHA1, HMAC-SHA224, HMAC-SHA256
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass (default), HMAC-SHA384 and HMAC-SHA512.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass They use a shared secret on each end of the connection.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass This provides TSIG-style authentication for the command
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass request and the name server's response. All commands sent
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass over the channel must be signed by a key_id known to the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<p><span><strong class="command">rndc</strong></span>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass reads a configuration file to
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass determine how to contact the name server and decide what
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass algorithm and key it should use.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<dt><span class="term">-b <em class="replaceable"><code>source-address</code></em></span></dt>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Use <em class="replaceable"><code>source-address</code></em>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass as the source address for the connection to the server.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Multiple instances are permitted to allow setting of both
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass the IPv4 and IPv6 source addresses.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Use <em class="replaceable"><code>config-file</code></em>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass as the configuration file instead of the default,
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<dt><span class="term">-k <em class="replaceable"><code>key-file</code></em></span></dt>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Use <em class="replaceable"><code>key-file</code></em>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass as the key file instead of the default,
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass <code class="filename">/etc/rndc.key</code>. The key in
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass <code class="filename">/etc/rndc.key</code> will be used to
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass authenticate
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass commands sent to the server if the <em class="replaceable"><code>config-file</code></em>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass does not exist.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<dt><span class="term">-s <em class="replaceable"><code>server</code></em></span></dt>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<dd><p><em class="replaceable"><code>server</code></em> is
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass the name or address of the server which matches a
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass server statement in the configuration file for
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass <span><strong class="command">rndc</strong></span>. If no server is supplied on the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass command line, the host named by the default-server clause
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass in the options statement of the <span><strong class="command">rndc</strong></span>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass configuration file will be used.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Send commands to TCP port
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass of BIND 9's default control channel port, 953.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Quiet mode: Message text returned by the server
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass will not be printed except when there is an error.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Instructs <span><strong class="command">rndc</strong></span> to print the result code
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass returned by <span><strong class="command">named</strong></span> after executing the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass requested command (e.g., ISC_R_SUCCESS, ISC_R_FAILURE, etc).
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Enable verbose logging.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<dt><span class="term">-y <em class="replaceable"><code>key_id</code></em></span></dt>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Use the key <em class="replaceable"><code>key_id</code></em>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass from the configuration file.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass known by <span><strong class="command">named</strong></span> with the same algorithm and secret string
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass in order for control message validation to succeed.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass If no <em class="replaceable"><code>key_id</code></em>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass is specified, <span><strong class="command">rndc</strong></span> will first look
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass for a key clause in the server statement of the server
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass being used, or if no server statement is present for that
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass host, then the default-key clause of the options statement.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Note that the configuration file contains shared secrets
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass which are used to send authenticated control commands
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass to name servers. It should therefore not have general read
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass or write access.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass A list of commands supported by <span><strong class="command">rndc</strong></span> can
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass be seen by running <span><strong class="command">rndc</strong></span> without arguments.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Currently supported commands are:
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<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>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Add a zone while the server is running. This
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass command requires the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass <span><strong class="command">allow-new-zones</strong></span> option to be set
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass to <strong class="userinput"><code>yes</code></strong>. The
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass <em class="replaceable"><code>configuration</code></em> string
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass specified on the command line is the zone
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass configuration text that would ordinarily be
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass placed in <code class="filename">named.conf</code>.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass The configuration is saved in a file called
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass <code class="filename"><em class="replaceable"><code>name</code></em>.nzf</code>,
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass where <em class="replaceable"><code>name</code></em> is the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass name of the view, or if it contains characters
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass that are incompatible with use as a file name, a
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass cryptographic hash generated from the name
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass of the view.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass When <span><strong class="command">named</strong></span> is
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass restarted, the file will be loaded into the view
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass configuration, so that zones that were added
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass can persist after a restart.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass This sample <span><strong class="command">addzone</strong></span> command
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass would add the zone <code class="literal">example.com</code>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass to the default view:
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<code class="prompt">$ </code><strong class="userinput"><code>rndc addzone example.com '{ type master; file "example.com.db"; };'</code></strong>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass (Note the brackets and semi-colon around the zone
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass configuration text.)
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass See also <span><strong class="command">rndc delzone</strong></span> and <span><strong class="command">rndc modzone</strong></span>.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<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>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Delete a zone while the server is running.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass If the <code class="option">-clean</code> argument is specified,
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass the zone's master file (and journal file, if any)
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass will be deleted along with the zone. Without the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass <code class="option">-clean</code> option, zone files must
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass be cleaned up by hand. (If the zone is of
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass type "slave" or "stub", the files needing to
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass be cleaned up will be reported in the output
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass of the <span><strong class="command">rndc delzone</strong></span> command.)
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass If the zone was originally added via
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass <span><strong class="command">rndc addzone</strong></span>, then it will be
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass removed permanently. However, if it was originally
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass configured in <code class="filename">named.conf</code>, then
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass that original configuration is still in place; when
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass the server is restarted or reconfigured, the zone will
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass come back. To remove it permanently, it must also be
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass removed from <code class="filename">named.conf</code>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass See also <span><strong class="command">rndc addzone</strong></span> and <span><strong class="command">rndc modzone</strong></span>.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<dt><span class="term"><strong class="userinput"><code>dumpdb [<span class="optional">-all|-cache|-zone</span>] [<span class="optional"><em class="replaceable"><code>view ...</code></em></span>]</code></strong></span></dt>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Dump the server's caches (default) and/or zones to
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass dump file for the specified views. If no view is
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass specified, all
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass views are dumped.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass (See the <span><strong class="command">dump-file</strong></span> option in
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass the BIND 9 Administrator Reference Manual.)
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<dt><span class="term"><strong class="userinput"><code>flush</code></strong></span></dt>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Flushes the server's cache.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<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>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Flushes the given name from the view's DNS cache
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass and, if applicable, from the view's nameserver address
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass database, bad server cache and SERVFAIL cache.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<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>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Flushes the given name, and all of its subdomains,
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass from the view's DNS cache, address database,
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass bad server cache, and SERVFAIL cache.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<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>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Suspend updates to a dynamic zone. If no zone is
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass specified, then all zones are suspended. This allows
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass manual edits to be made to a zone normally updated by
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass dynamic update. It also causes changes in the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass journal file to be synced into the master file.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass All dynamic update attempts will be refused while
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass the zone is frozen.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass See also <span><strong class="command">rndc thaw</strong></span>.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<dt><span class="term"><strong class="userinput"><code>halt [<span class="optional">-p</span>]</code></strong></span></dt>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Stop the server immediately. Recent changes
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass made through dynamic update or IXFR are not saved to
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass the master files, but will be rolled forward from the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass journal files when the server is restarted.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass If <code class="option">-p</code> is specified <span><strong class="command">named</strong></span>'s process id is returned.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass This allows an external process to determine when <span><strong class="command">named</strong></span>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass had completed halting.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass See also <span><strong class="command">rndc stop</strong></span>.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<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>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Fetch all DNSSEC keys for the given zone
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass from the key directory. If they are within
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass their publication period, merge them into the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass zone's DNSKEY RRset. Unlike <span><strong class="command">rndc
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass immediately re-signed by the new keys, but is
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass allowed to incrementally re-sign over time.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass This command requires that the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass <span><strong class="command">auto-dnssec</strong></span> zone option
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass and also requires the zone to be configured to
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass allow dynamic DNS.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass (See "Dynamic Update Policies" in the Administrator
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Reference Manual for more details.)
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<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>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass When run with the "status" keyword, print the current
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass status of the managed-keys database for the specified
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass view, or for all views if none is specified. When run
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass with the "refresh" keyword, force an immediate refresh
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass of all the managed-keys in the specified view, or all
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass views. When run with the "sync" keyword, force an
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass immediate dump of the managed-keys database to disk (in
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass the file <code class="filename">managed-keys.bind</code> or
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass (<code class="filename"><em class="replaceable"><code>viewname</code></em>.mkeys</code>).
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<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>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Modify the configuration of a zone while the server
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass is running. This command requires the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass <span><strong class="command">allow-new-zones</strong></span> option to be
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass set to <strong class="userinput"><code>yes</code></strong>. As with
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass <span><strong class="command">addzone</strong></span>, the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass <em class="replaceable"><code>configuration</code></em> string
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass specified on the command line is the zone
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass configuration text that would ordinarily be
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass placed in <code class="filename">named.conf</code>.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass If the zone was originally added via
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass <span><strong class="command">rndc addzone</strong></span>, the configuration
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass changes will be recorded permanently and will still be
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass in effect after the server is restarted or reconfigured.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass However, if it was originally configured in
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass <code class="filename">named.conf</code>, then that original
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass configuration is still in place; when the server is
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass restarted or reconfigured, the zone will revert to
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass its original configuration. To make the changes
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass permanent, it must also be modified in
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass See also <span><strong class="command">rndc addzone</strong></span> and <span><strong class="command">rndc delzone</strong></span>.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<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>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Resend NOTIFY messages for the zone.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<dt><span class="term"><strong class="userinput"><code>notrace</code></strong></span></dt>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Sets the server's debugging level to 0.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass See also <span><strong class="command">rndc trace</strong></span>.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass<dt><span class="term"><strong class="userinput"><code>nta
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass [<span class="optional">( -d | -f | -r | -l <em class="replaceable"><code>duration</code></em>)</span>]
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass [<span class="optional"><em class="replaceable"><code>view</code></em></span>]
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Sets a DNSSEC negative trust anchor (NTA)
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass for <code class="option">domain</code>, with a lifetime of
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass <code class="option">duration</code>. The default lifetime is
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass configured in <code class="filename">named.conf</code> via the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass <code class="option">nta-lifetime</code> option, and defaults to
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass one hour. The lifetime cannot exceed one week.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass A negative trust anchor selectively disables
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass DNSSEC validation for zones that are known to be
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass failing because of misconfiguration rather than
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass an attack. When data to be validated is
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass at or below an active NTA (and above any other
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass configured trust anchors), <span><strong class="command">named</strong></span> will
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass abort the DNSSEC validation process and treat the data as
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass insecure rather than bogus. This continues until the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass NTA's lifetime is elapsed.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass NTAs persist across restarts of the <span><strong class="command">named</strong></span> server.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass The NTAs for a view are saved in a file called
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass <code class="filename"><em class="replaceable"><code>name</code></em>.nta</code>,
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass where <em class="replaceable"><code>name</code></em> is the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass name of the view, or if it contains characters
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass that are incompatible with use as a file name, a
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass cryptographic hash generated from the name
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass of the view.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass An existing NTA can be removed by using the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass An NTA's lifetime can be specified with the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass <code class="option">-lifetime</code> option. TTL-style
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass suffixes can be used to specify the lifetime in
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass seconds, minutes, or hours. If the specified NTA
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass already exists, its lifetime will be updated to the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass new value. Setting <code class="option">lifetime</code> to zero
8a6b21bbf4ce4b186b37c9f3623a198acd13b950Dav Glass is equivalent to <code class="option">-remove</code>.
All of these options can be shortened, i.e., to
<dt><span class="term"><strong class="userinput"><code>querylog</code></strong> [<span class="optional">on|off</span>] </span></dt>
<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>
<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><strong class="command">rndc signing -nsec3param 1 0 10 FFFF <em class="replaceable"><code>zone</code></em></strong></span>.
<span><strong class="command">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><strong class="command">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><strong class="command">named</strong></span>'s process id is returned.
This allows an external process to determine when <span><strong class="command">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>
<dt><span class="term"><strong class="userinput"><code>zonestatus [<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>