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