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