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