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