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