man.rndc.html revision 3c7b4ac4517ac9d78c9bf3e0e790cedce10ddc18
970N/A<!--
970N/A - Copyright (C) 2004-2014 Internet Systems Consortium, Inc. ("ISC")
970N/A - Copyright (C) 2000-2003 Internet Software Consortium.
970N/A -
1447N/A - Permission to use, copy, modify, and/or distribute this software for any
970N/A - purpose with or without fee is hereby granted, provided that the above
970N/A - copyright notice and this permission notice appear in all copies.
970N/A -
970N/A - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
970N/A - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
970N/A - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
970N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
970N/A - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
970N/A - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
970N/A - PERFORMANCE OF THIS SOFTWARE.
970N/A-->
970N/A<!-- $Id$ -->
970N/A<html>
970N/A<head>
970N/A<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
970N/A<title>rndc</title>
970N/A<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
970N/A<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
970N/A<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
970N/A<link rel="prev" href="man.nsupdate.html" title="nsupdate">
970N/A<link rel="next" href="man.rndc.conf.html" title="rndc.conf">
970N/A</head>
970N/A<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
970N/A<div class="navheader">
970N/A<table width="100%" summary="Navigation header">
970N/A<tr><th colspan="3" align="center"><span class="application">rndc</span></th></tr>
970N/A<tr>
970N/A<td width="20%" align="left">
970N/A<a accesskey="p" href="man.nsupdate.html">Prev</a>�</td>
970N/A<th width="60%" align="center">Manual pages</th>
970N/A<td width="20%" align="right">�<a accesskey="n" href="man.rndc.conf.html">Next</a>
970N/A</td>
970N/A</tr>
970N/A</table>
970N/A<hr>
970N/A</div>
970N/A<div class="refentry" lang="en">
970N/A<a name="man.rndc"></a><div class="titlepage"></div>
1105N/A<div class="refnamediv">
970N/A<h2>Name</h2>
970N/A<p><span class="application">rndc</span> &#8212; name server control utility</p>
970N/A</div>
970N/A<div class="refsynopsisdiv">
970N/A<h2>Synopsis</h2>
970N/A<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">-V</code>] [<code class="option">-y <em class="replaceable"><code>key_id</code></em></code>] {command}</p></div>
970N/A</div>
970N/A<div class="refsect1" lang="en">
970N/A<a name="id2654391"></a><h2>DESCRIPTION</h2>
970N/A<p><span><strong class="command">rndc</strong></span>
970N/A controls the operation of a name
970N/A server. It supersedes the <span><strong class="command">ndc</strong></span> utility
970N/A that was provided in old BIND releases. If
970N/A <span><strong class="command">rndc</strong></span> is invoked with no command line
970N/A options or arguments, it prints a short summary of the
970N/A supported commands and the available options and their
970N/A arguments.
970N/A </p>
970N/A<p><span><strong class="command">rndc</strong></span>
970N/A communicates with the name server over a TCP connection, sending
970N/A commands authenticated with digital signatures. In the current
970N/A versions of
970N/A <span><strong class="command">rndc</strong></span> and <span><strong class="command">named</strong></span>,
970N/A the only supported authentication algorithms are HMAC-MD5
970N/A (for compatibility), HMAC-SHA1, HMAC-SHA224, HMAC-SHA256
1130N/A (default), HMAC-SHA384 and HMAC-SHA512.
970N/A They use a shared secret on each end of the connection.
970N/A This provides TSIG-style authentication for the command
970N/A request and the name server's response. All commands sent
970N/A over the channel must be signed by a key_id known to the
970N/A server.
970N/A </p>
970N/A<p><span><strong class="command">rndc</strong></span>
970N/A reads a configuration file to
970N/A determine how to contact the name server and decide what
970N/A algorithm and key it should use.
970N/A </p>
970N/A</div>
970N/A<div class="refsect1" lang="en">
970N/A<a name="id2654441"></a><h2>OPTIONS</h2>
970N/A<div class="variablelist"><dl>
970N/A<dt><span class="term">-b <em class="replaceable"><code>source-address</code></em></span></dt>
970N/A<dd><p>
970N/A Use <em class="replaceable"><code>source-address</code></em>
970N/A as the source address for the connection to the server.
970N/A Multiple instances are permitted to allow setting of both
970N/A the IPv4 and IPv6 source addresses.
970N/A </p></dd>
970N/A<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
970N/A<dd><p>
970N/A Use <em class="replaceable"><code>config-file</code></em>
970N/A as the configuration file instead of the default,
970N/A <code class="filename">/etc/rndc.conf</code>.
970N/A </p></dd>
1105N/A<dt><span class="term">-k <em class="replaceable"><code>key-file</code></em></span></dt>
1105N/A<dd><p>
970N/A Use <em class="replaceable"><code>key-file</code></em>
1105N/A as the key file instead of the default,
970N/A <code class="filename">/etc/rndc.key</code>. The key in
970N/A <code class="filename">/etc/rndc.key</code> will be used to
970N/A authenticate
970N/A commands sent to the server if the <em class="replaceable"><code>config-file</code></em>
970N/A does not exist.
970N/A </p></dd>
1154N/A<dt><span class="term">-s <em class="replaceable"><code>server</code></em></span></dt>
1152N/A<dd><p><em class="replaceable"><code>server</code></em> is
970N/A the name or address of the server which matches a
1172N/A server statement in the configuration file for
1172N/A <span><strong class="command">rndc</strong></span>. If no server is supplied on the
1172N/A command line, the host named by the default-server clause
970N/A in the options statement of the <span><strong class="command">rndc</strong></span>
1105N/A configuration file will be used.
970N/A </p></dd>
970N/A<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
1105N/A<dd><p>
970N/A Send commands to TCP port
970N/A <em class="replaceable"><code>port</code></em>
1120N/A instead
1120N/A of BIND 9's default control channel port, 953.
1120N/A </p></dd>
1423N/A<dt><span class="term">-q</span></dt>
1423N/A<dd><p>
1172N/A Quiet mode: Message text returned by the server
1172N/A will not be printed except when there is an error.
1153N/A </p></dd>
970N/A<dt><span class="term">-V</span></dt>
970N/A<dd><p>
1339N/A Enable verbose logging.
1339N/A </p></dd>
1339N/A<dt><span class="term">-y <em class="replaceable"><code>key_id</code></em></span></dt>
1339N/A<dd><p>
1339N/A Use the key <em class="replaceable"><code>key_id</code></em>
1339N/A from the configuration file.
1339N/A <em class="replaceable"><code>key_id</code></em>
1339N/A must be
1339N/A known by named with the same algorithm and secret string
1339N/A in order for control message validation to succeed.
970N/A If no <em class="replaceable"><code>key_id</code></em>
970N/A is specified, <span><strong class="command">rndc</strong></span> will first look
1105N/A for a key clause in the server statement of the server
1105N/A being used, or if no server statement is present for that
1105N/A host, then the default-key clause of the options statement.
970N/A Note that the configuration file contains shared secrets
970N/A which are used to send authenticated control commands
970N/A to name servers. It should therefore not have general read
1423N/A or write access.
1423N/A </p></dd>
1105N/A</dl></div>
970N/A</div>
970N/A<div class="refsect1" lang="en">
1423N/A<a name="id2654731"></a><h2>COMMANDS</h2>
1423N/A<p>
970N/A A list of commands supported by <span><strong class="command">rndc</strong></span> can
970N/A be seen by running <span><strong class="command">rndc</strong></span> without arguments.
970N/A </p>
970N/A<p>
970N/A Currently supported commands are:
970N/A </p>
970N/A<div class="variablelist"><dl>
970N/A<dt><span class="term"><strong class="userinput"><code>reload</code></strong></span></dt>
1189N/A<dd><p>
1189N/A Reload configuration file and zones.
1189N/A </p></dd>
1189N/A<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>
1189N/A<dd><p>
1189N/A Reload the given zone.
1189N/A </p></dd>
1189N/A<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>
970N/A<dd><p>
970N/A Schedule zone maintenance for the given zone.
970N/A </p></dd>
970N/A<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>
970N/A<dd>
1189N/A<p>
1189N/A Retransfer the given slave zone from the master server.
970N/A </p>
970N/A<p>
970N/A If the zone is configured to use
1132N/A <span><strong class="command">inline-signing</strong></span>, the signed
1132N/A version of the zone is discarded; after the
1132N/A retransfer of the unsigned version is complete, the
970N/A signed version will be regenerated with all new
970N/A signatures.
970N/A </p>
970N/A</dd>
970N/A<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>
1276N/A<dd>
1132N/A<p>
970N/A Fetch all DNSSEC keys for the given zone
970N/A from the key directory (see the
1132N/A <span><strong class="command">key-directory</strong></span> option in
1132N/A the BIND 9 Administrator Reference Manual). If they are within
1132N/A their publication period, merge them into the
1132N/A zone's DNSKEY RRset. If the DNSKEY RRset
1132N/A is changed, then the zone is automatically
970N/A re-signed with the new key set.
1132N/A </p>
1132N/A<p>
1132N/A This command requires that the
1132N/A <span><strong class="command">auto-dnssec</strong></span> zone option be set
1132N/A to <code class="literal">allow</code> or
1147N/A <code class="literal">maintain</code>,
1147N/A and also requires the zone to be configured to
1147N/A allow dynamic DNS.
1147N/A (See "Dynamic Update Policies" in the Administrator
1132N/A Reference Manual for more details.)
1132N/A </p>
1132N/A</dd>
1132N/A<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>
1132N/A<dd>
1132N/A<p>
1298N/A Fetch all DNSSEC keys for the given zone
1298N/A from the key directory. If they are within
1298N/A their publication period, merge them into the
1298N/A zone's DNSKEY RRset. Unlike <span><strong class="command">rndc
1423N/A sign</strong></span>, however, the zone is not
1423N/A immediately re-signed by the new keys, but is
1423N/A allowed to incrementally re-sign over time.
1298N/A </p>
1153N/A<p>
1153N/A This command requires that the
1153N/A <span><strong class="command">auto-dnssec</strong></span> zone option
1153N/A be set to <code class="literal">maintain</code>,
1172N/A and also requires the zone to be configured to
970N/A allow dynamic DNS.
970N/A (See "Dynamic Update Policies" in the Administrator
1003N/A Reference Manual for more details.)
1003N/A </p>
1360N/A</dd>
970N/A<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>
970N/A<dd><p>
1153N/A Suspend updates to a dynamic zone. If no zone is
1172N/A specified, then all zones are suspended. This allows
1172N/A manual edits to be made to a zone normally updated by
970N/A dynamic update. It also causes changes in the
1172N/A journal file to be synced into the master file.
1154N/A All dynamic update attempts will be refused while
970N/A the zone is frozen.
970N/A </p></dd>
970N/A<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>
970N/A<dd><p>
970N/A Enable updates to a frozen dynamic zone. If no
970N/A zone is specified, then all frozen zones are
970N/A enabled. This causes the server to reload the zone
970N/A from disk, and re-enables dynamic updates after the
1105N/A load has completed. After a zone is thawed,
1105N/A dynamic updates will no longer be refused. If
970N/A the zone has changed and the
1105N/A <span><strong class="command">ixfr-from-differences</strong></span> option is
1105N/A in use, then the journal file will be updated to
1153N/A reflect changes in the zone. Otherwise, if the
1153N/A zone has changed, any existing journal file will be
970N/A removed.
1153N/A </p></dd>
1153N/A<dt><span class="term"><strong class="userinput"><code>scan</code></strong></span></dt>
1153N/A<dd><p>
1153N/A Scan the list of available network interfaces
970N/A for changes, without performing a full
1423N/A <span><strong class="command">reconfig</strong></span> or waiting for the
1423N/A <span><strong class="command">interface-interval</strong></span> timer.
1423N/A </p></dd>
1423N/A<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>
1423N/A<dd><p>
1423N/A Sync changes in the journal file for a dynamic zone
1423N/A to the master file. If the "-clean" option is
1423N/A specified, the journal file is also removed. If
970N/A no zone is specified, then all zones are synced.
1261N/A </p></dd>
1261N/A<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>
1261N/A<dd><p>
1261N/A Resend NOTIFY messages for the zone.
1261N/A </p></dd>
970N/A<dt><span class="term"><strong class="userinput"><code>reconfig</code></strong></span></dt>
1261N/A<dd><p>
1261N/A Reload the configuration file and load new zones,
1152N/A but do not reload existing zone files even if they
1261N/A have changed.
1152N/A This is faster than a full <span><strong class="command">reload</strong></span> when there
970N/A is a large number of zones because it avoids the need
970N/A to examine the
970N/A modification times of the zones files.
970N/A </p></dd>
970N/A<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>
970N/A<dd><p>
970N/A Displays the current status of the given zone,
970N/A including the master file name and any include
970N/A files from which it was loaded, when it was most
970N/A recently loaded, the current serial number, the
970N/A number of nodes, whether the zone supports
970N/A dynamic updates, whether the zone is DNSSEC
970N/A signed, whether it uses automatic DNSSEC key
970N/A management or inline signing, and the scheduled
970N/A refresh or expiry times for the zone.
970N/A </p></dd>
970N/A<dt><span class="term"><strong class="userinput"><code>stats</code></strong></span></dt>
1153N/A<dd><p>
970N/A Write server statistics to the statistics file.
970N/A </p></dd>
970N/A<dt><span class="term"><strong class="userinput"><code>querylog</code></strong> [<span class="optional">on|off</span>] </span></dt>
970N/A<dd>
970N/A<p>
970N/A Enable or disable query logging. (For backward
1152N/A compatibility, this command can also be used without
970N/A an argument to toggle query logging on and off.)
970N/A </p>
970N/A<p>
970N/A Query logging can also be enabled
970N/A by explicitly directing the <span><strong class="command">queries</strong></span>
1261N/A <span><strong class="command">category</strong></span> to a
1261N/A <span><strong class="command">channel</strong></span> in the
1261N/A <span><strong class="command">logging</strong></span> section of
1261N/A <code class="filename">named.conf</code> or by specifying
970N/A <span><strong class="command">querylog yes;</strong></span> in the
970N/A <span><strong class="command">options</strong></span> section of
970N/A <code class="filename">named.conf</code>.
970N/A </p>
970N/A</dd>
1046N/A<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>
1046N/A<dd><p>
1046N/A Dump the server's caches (default) and/or zones to
1046N/A the
1261N/A dump file for the specified views. If no view is
1261N/A specified, all
1261N/A views are dumped.
1261N/A </p></dd>
1261N/A<dt><span class="term"><strong class="userinput"><code>secroots [<span class="optional"><em class="replaceable"><code>view ...</code></em></span>]</code></strong></span></dt>
1261N/A<dd><p>
1261N/A Dump the server's security roots to the secroots
1261N/A file for the specified views. If no view is
1261N/A specified, security roots for all
1261N/A views are dumped.
1152N/A </p></dd>
1152N/A<dt><span class="term"><strong class="userinput"><code>stop [<span class="optional">-p</span>]</code></strong></span></dt>
1261N/A<dd><p>
1152N/A Stop the server, making sure any recent changes
970N/A made through dynamic update or IXFR are first saved to
1152N/A the master files of the updated zones.
1152N/A If <code class="option">-p</code> is specified <span><strong class="command">named</strong></span>'s process id is returned.
970N/A This allows an external process to determine when <span><strong class="command">named</strong></span>
970N/A had completed stopping.
970N/A </p></dd>
1261N/A<dt><span class="term"><strong class="userinput"><code>halt [<span class="optional">-p</span>]</code></strong></span></dt>
1261N/A<dd><p>
1261N/A Stop the server immediately. Recent changes
970N/A made through dynamic update or IXFR are not saved to
970N/A the master files, but will be rolled forward from the
970N/A journal files when the server is restarted.
970N/A If <code class="option">-p</code> is specified <span><strong class="command">named</strong></span>'s process id is returned.
1152N/A This allows an external process to determine when <span><strong class="command">named</strong></span>
1152N/A had completed halting.
1152N/A </p></dd>
1152N/A<dt><span class="term"><strong class="userinput"><code>trace</code></strong></span></dt>
1152N/A<dd><p>
1152N/A Increment the servers debugging level by one.
1152N/A </p></dd>
1153N/A<dt><span class="term"><strong class="userinput"><code>trace <em class="replaceable"><code>level</code></em></code></strong></span></dt>
1153N/A<dd><p>
1153N/A Sets the server's debugging level to an explicit
1153N/A value.
1153N/A </p></dd>
1153N/A<dt><span class="term"><strong class="userinput"><code>notrace</code></strong></span></dt>
1152N/A<dd><p>
1153N/A Sets the server's debugging level to 0.
1152N/A </p></dd>
1152N/A<dt><span class="term"><strong class="userinput"><code>flush</code></strong></span></dt>
1153N/A<dd><p>
1152N/A Flushes the server's cache.
1152N/A </p></dd>
1152N/A<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>
970N/A<dd><p>
1153N/A Flushes the given name from the server's DNS cache
1153N/A and, if applicable, from the server's nameserver address
1153N/A database or bad-server cache.
1153N/A </p></dd>
1153N/A<dt><span class="term"><strong class="userinput"><code>flushtree</code></strong> [<span class="optional">-all</span>] <em class="replaceable"><code>name</code></em> [<span class="optional"><em class="replaceable"><code>view</code></em></span>] </span></dt>
1153N/A<dd><p>
1153N/A Flushes the given name, and all of its subdomains,
1153N/A from the server's DNS cache, the address database,
1153N/A and the bad server cache.
1130N/A </p></dd>
1130N/A<dt><span class="term"><strong class="userinput"><code>status</code></strong></span></dt>
1130N/A<dd><p>
1130N/A Display status of the server.
1130N/A Note that the number of zones includes the internal <span><strong class="command">bind/CH</strong></span> zone
1130N/A and the default <span><strong class="command">/IN</strong></span>
1130N/A hint zone if there is not an
1130N/A explicit root zone configured.
1130N/A </p></dd>
1130N/A<dt><span class="term"><strong class="userinput"><code>recursing</code></strong></span></dt>
1130N/A<dd><p>
1130N/A Dump the list of queries <span><strong class="command">named</strong></span> is currently recursing
1130N/A on.
1130N/A </p></dd>
1130N/A<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>
1161N/A<dd><p>
1130N/A Enable, disable, or check the current status of
1130N/A DNSSEC validation.
1130N/A Note <span><strong class="command">dnssec-enable</strong></span> also needs to be
1130N/A set to <strong class="userinput"><code>yes</code></strong> or
1130N/A <strong class="userinput"><code>auto</code></strong> to be effective.
1130N/A It defaults to enabled.
1130N/A </p></dd>
1172N/A<dt><span class="term"><strong class="userinput"><code>tsig-list</code></strong></span></dt>
1130N/A<dd><p>
1130N/A List the names of all TSIG keys currently configured
1130N/A for use by <span><strong class="command">named</strong></span> in each view. The
1130N/A list both statically configured keys and dynamic
1130N/A TKEY-negotiated keys.
1161N/A </p></dd>
1130N/A<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>
970N/A<dd><p>
970N/A Delete a given TKEY-negotiated key from the server.
970N/A (This does not apply to statically configured TSIG
1161N/A keys.)
970N/A </p></dd>
970N/A<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>
970N/A<dd>
970N/A<p>
970N/A Add a zone while the server is running. This
1139N/A command requires the
1139N/A <span><strong class="command">allow-new-zones</strong></span> option to be set
970N/A to <strong class="userinput"><code>yes</code></strong>. The
970N/A <em class="replaceable"><code>configuration</code></em> string
970N/A specified on the command line is the zone
970N/A configuration text that would ordinarily be
970N/A placed in <code class="filename">named.conf</code>.
1339N/A </p>
1339N/A<p>
1130N/A The configuration is saved in a file called
970N/A <code class="filename"><em class="replaceable"><code>hash</code></em>.nzf</code>,
1130N/A where <em class="replaceable"><code>hash</code></em> is a
970N/A cryptographic hash generated from the name of
1339N/A the view. When <span><strong class="command">named</strong></span> is
970N/A restarted, the file will be loaded into the view
970N/A configuration, so that zones that were added
1139N/A can persist after a restart.
1339N/A </p>
1132N/A<p>
970N/A This sample <span><strong class="command">addzone</strong></span> command
970N/A would add the zone <code class="literal">example.com</code>
970N/A to the default view:
970N/A </p>
1339N/A<p>
1339N/A<code class="prompt">$ </code><strong class="userinput"><code>rndc addzone example.com '{ type master; file "example.com.db"; };'</code></strong>
970N/A </p>
970N/A<p>
970N/A (Note the brackets and semi-colon around the zone
970N/A configuration text.)
970N/A </p>
970N/A</dd>
970N/A<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>
1139N/A<dd>
970N/A<p>
1130N/A Delete a zone while the server is running.
1130N/A Only zones that were originally added via
1130N/A <span><strong class="command">rndc addzone</strong></span> can be deleted
1130N/A in this manner.
1130N/A </p>
1130N/A<p>
1130N/A If the <code class="option">-clean</code> is specified,
1130N/A the zone's master file (and journal file, if any)
1130N/A will be deleted along with the zone. Without the
1130N/A <code class="option">-clean</code> option, zone files must
1130N/A be cleaned up by hand. (If the zone is of
1130N/A type "slave" or "stub", the files needing to
1130N/A be cleaned up will be reported in the output
1130N/A of the <span><strong class="command">rndc delzone</strong></span> command.)
1139N/A </p>
1139N/A</dd>
1130N/A<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> ) ) </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>
1130N/A<dd>
1130N/A<p>
970N/A List, edit, or remove the DNSSEC signing state records
970N/A for the specified zone. The status of ongoing DNSSEC
970N/A operations (such as signing or generating
970N/A NSEC3 chains) is stored in the zone in the form
970N/A of DNS resource records of type
970N/A <span><strong class="command">sig-signing-type</strong></span>.
970N/A <span><strong class="command">rndc signing -list</strong></span> converts
970N/A these records into a human-readable form,
1423N/A indicating which keys are currently signing
1423N/A or have finished signing the zone, and which NSEC3
970N/A chains are being created or removed.
970N/A </p>
970N/A<p>
970N/A <span><strong class="command">rndc signing -clear</strong></span> can remove
970N/A a single key (specified in the same format that
970N/A <span><strong class="command">rndc signing -list</strong></span> uses to
970N/A display it), or all keys. In either case, only
970N/A completed keys are removed; any record indicating
970N/A that a key has not yet finished signing the zone
970N/A will be retained.
970N/A </p>
970N/A<p>
970N/A <span><strong class="command">rndc signing -nsec3param</strong></span> sets
970N/A the NSEC3 parameters for a zone. This is the
970N/A only supported mechanism for using NSEC3 with
1172N/A <span><strong class="command">inline-signing</strong></span> zones.
970N/A Parameters are specified in the same format as
970N/A an NSEC3PARAM resource record: hash algorithm,
970N/A flags, iterations, and salt, in that order.
970N/A </p>
970N/A<p>
970N/A Currently, the only defined value for hash algorithm
1207N/A is <code class="literal">1</code>, representing SHA-1.
1207N/A The <code class="option">flags</code> may be set to
1207N/A <code class="literal">0</code> or <code class="literal">1</code>,
1207N/A depending on whether you wish to set the opt-out
1207N/A bit in the NSEC3 chain. <code class="option">iterations</code>
1207N/A defines the number of additional times to apply
970N/A the algorithm when generating an NSEC3 hash. The
970N/A <code class="option">salt</code> is a string of data expressed
1447N/A in hexadecimal, a hyphen (`-') if no salt is
1447N/A to be used, or the keyword <code class="literal">auto</code>,
970N/A which causes <span><strong class="command">named</strong></span> to generate a
970N/A random 64-bit salt.
970N/A </p>
1447N/A<p>
1463N/A So, for example, to create an NSEC3 chain using
1463N/A the SHA-1 hash algorithm, no opt-out flag,
1463N/A 10 iterations, and a salt value of "FFFF", use:
1463N/A <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>
</dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2686642"></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="id2686660"></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="id2686715"></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.ch10.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>
</body>
</html>