man.rndc.html revision c313914d0e66b20969215e519bbf2ab4ecf39512
9b2bd54c98edb185a3985410367754ab33217362bnicholes<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
9b2bd54c98edb185a3985410367754ab33217362bnicholes - Copyright (C) 2000-2018 Internet Systems Consortium, Inc. ("ISC")
9b2bd54c98edb185a3985410367754ab33217362bnicholes - This Source Code Form is subject to the terms of the Mozilla Public
9b2bd54c98edb185a3985410367754ab33217362bnicholes - License, v. 2.0. If a copy of the MPL was not distributed with this
9b2bd54c98edb185a3985410367754ab33217362bnicholes - file, You can obtain one at http://mozilla.org/MPL/2.0/.
9b2bd54c98edb185a3985410367754ab33217362bnicholes<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
9b2bd54c98edb185a3985410367754ab33217362bnicholes<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
9b2bd54c98edb185a3985410367754ab33217362bnicholes<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
9b2bd54c98edb185a3985410367754ab33217362bnicholes<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
9b2bd54c98edb185a3985410367754ab33217362bnicholes<link rel="prev" href="man.nsupdate.html" title="nsupdate">
9b2bd54c98edb185a3985410367754ab33217362bnicholes<link rel="next" href="man.rndc.conf.html" title="rndc.conf">
70953fb44a7140fe206c3a5f011e24209c8c5c6abnicholes<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
16b55a35cff91315d261d1baa776138af465c4e4fuankg<tr><th colspan="3" align="center"><span class="application">rndc</span></th></tr>
9b2bd54c98edb185a3985410367754ab33217362bnicholes<a accesskey="p" href="man.nsupdate.html">Prev</a>�</td>
9b2bd54c98edb185a3985410367754ab33217362bnicholes<td width="20%" align="right">�<a accesskey="n" href="man.rndc.conf.html">Next</a>
9b2bd54c98edb185a3985410367754ab33217362bnicholes<a name="man.rndc"></a><div class="titlepage"></div>
9b2bd54c98edb185a3985410367754ab33217362bnicholes — name server control utility
9b2bd54c98edb185a3985410367754ab33217362bnicholes [<code class="option">-b <em class="replaceable"><code>source-address</code></em></code>]
9b2bd54c98edb185a3985410367754ab33217362bnicholes [<code class="option">-c <em class="replaceable"><code>config-file</code></em></code>]
9b2bd54c98edb185a3985410367754ab33217362bnicholes [<code class="option">-k <em class="replaceable"><code>key-file</code></em></code>]
9b2bd54c98edb185a3985410367754ab33217362bnicholes [<code class="option">-s <em class="replaceable"><code>server</code></em></code>]
9b2bd54c98edb185a3985410367754ab33217362bnicholes [<code class="option">-p <em class="replaceable"><code>port</code></em></code>]
9b2bd54c98edb185a3985410367754ab33217362bnicholes [<code class="option">-y <em class="replaceable"><code>key_id</code></em></code>]
9b2bd54c98edb185a3985410367754ab33217362bnicholes <p><span class="command"><strong>rndc</strong></span>
9b2bd54c98edb185a3985410367754ab33217362bnicholes controls the operation of a name
9b2bd54c98edb185a3985410367754ab33217362bnicholes server. It supersedes the <span class="command"><strong>ndc</strong></span> utility
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg that was provided in old BIND releases. If
9b2bd54c98edb185a3985410367754ab33217362bnicholes <span class="command"><strong>rndc</strong></span> is invoked with no command line
9b2bd54c98edb185a3985410367754ab33217362bnicholes options or arguments, it prints a short summary of the
9b2bd54c98edb185a3985410367754ab33217362bnicholes supported commands and the available options and their
9b2bd54c98edb185a3985410367754ab33217362bnicholes <p><span class="command"><strong>rndc</strong></span>
9b2bd54c98edb185a3985410367754ab33217362bnicholes communicates with the name server over a TCP connection, sending
9b2bd54c98edb185a3985410367754ab33217362bnicholes commands authenticated with digital signatures. In the current
9b2bd54c98edb185a3985410367754ab33217362bnicholes <span class="command"><strong>rndc</strong></span> and <span class="command"><strong>named</strong></span>,
9b2bd54c98edb185a3985410367754ab33217362bnicholes the only supported authentication algorithms are HMAC-MD5
9b2bd54c98edb185a3985410367754ab33217362bnicholes (for compatibility), HMAC-SHA1, HMAC-SHA224, HMAC-SHA256
9b2bd54c98edb185a3985410367754ab33217362bnicholes (default), HMAC-SHA384 and HMAC-SHA512.
9b2bd54c98edb185a3985410367754ab33217362bnicholes They use a shared secret on each end of the connection.
9b2bd54c98edb185a3985410367754ab33217362bnicholes This provides TSIG-style authentication for the command
9b2bd54c98edb185a3985410367754ab33217362bnicholes request and the name server's response. All commands sent
9b2bd54c98edb185a3985410367754ab33217362bnicholes over the channel must be signed by a key_id known to the
9b2bd54c98edb185a3985410367754ab33217362bnicholes <p><span class="command"><strong>rndc</strong></span>
9b2bd54c98edb185a3985410367754ab33217362bnicholes reads a configuration file to
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg determine how to contact the name server and decide what
9b2bd54c98edb185a3985410367754ab33217362bnicholes algorithm and key it should use.
9b2bd54c98edb185a3985410367754ab33217362bnicholes <div class="variablelist"><dl class="variablelist">
9b2bd54c98edb185a3985410367754ab33217362bnicholes<dt><span class="term">-b <em class="replaceable"><code>source-address</code></em></span></dt>
9b2bd54c98edb185a3985410367754ab33217362bnicholes Use <em class="replaceable"><code>source-address</code></em>
9b2bd54c98edb185a3985410367754ab33217362bnicholes as the source address for the connection to the server.
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg Multiple instances are permitted to allow setting of both
9b2bd54c98edb185a3985410367754ab33217362bnicholes the IPv4 and IPv6 source addresses.
9b2bd54c98edb185a3985410367754ab33217362bnicholes<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
9b2bd54c98edb185a3985410367754ab33217362bnicholes Use <em class="replaceable"><code>config-file</code></em>
9b2bd54c98edb185a3985410367754ab33217362bnicholes as the configuration file instead of the default,
9b2bd54c98edb185a3985410367754ab33217362bnicholes<dt><span class="term">-k <em class="replaceable"><code>key-file</code></em></span></dt>
9b2bd54c98edb185a3985410367754ab33217362bnicholes Use <em class="replaceable"><code>key-file</code></em>
9b2bd54c98edb185a3985410367754ab33217362bnicholes as the key file instead of the default,
9b2bd54c98edb185a3985410367754ab33217362bnicholes <code class="filename">/etc/rndc.key</code>. The key in
9b2bd54c98edb185a3985410367754ab33217362bnicholes <code class="filename">/etc/rndc.key</code> will be used to
9b2bd54c98edb185a3985410367754ab33217362bnicholes authenticate
9b2bd54c98edb185a3985410367754ab33217362bnicholes commands sent to the server if the <em class="replaceable"><code>config-file</code></em>
9b2bd54c98edb185a3985410367754ab33217362bnicholes does not exist.
9b2bd54c98edb185a3985410367754ab33217362bnicholes<dt><span class="term">-s <em class="replaceable"><code>server</code></em></span></dt>
9b2bd54c98edb185a3985410367754ab33217362bnicholes <p><em class="replaceable"><code>server</code></em> is
9b2bd54c98edb185a3985410367754ab33217362bnicholes the name or address of the server which matches a
9b2bd54c98edb185a3985410367754ab33217362bnicholes server statement in the configuration file for
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg <span class="command"><strong>rndc</strong></span>. If no server is supplied on the
9b2bd54c98edb185a3985410367754ab33217362bnicholes command line, the host named by the default-server clause
9b2bd54c98edb185a3985410367754ab33217362bnicholes in the options statement of the <span class="command"><strong>rndc</strong></span>
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg configuration file will be used.
9b2bd54c98edb185a3985410367754ab33217362bnicholes<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
9b2bd54c98edb185a3985410367754ab33217362bnicholes Send commands to TCP port
9b2bd54c98edb185a3985410367754ab33217362bnicholes of BIND 9's default control channel port, 953.
9b2bd54c98edb185a3985410367754ab33217362bnicholes Quiet mode: Message text returned by the server
9b2bd54c98edb185a3985410367754ab33217362bnicholes will not be printed except when there is an error.
9b2bd54c98edb185a3985410367754ab33217362bnicholes Instructs <span class="command"><strong>rndc</strong></span> to print the result code
9b2bd54c98edb185a3985410367754ab33217362bnicholes returned by <span class="command"><strong>named</strong></span> after executing the
bf1e7c075ccc3e6597d17de7641332ff6ff92e8astriker requested command (e.g., ISC_R_SUCCESS, ISC_R_FAILURE, etc).
9b2bd54c98edb185a3985410367754ab33217362bnicholes Enable verbose logging.
9b2bd54c98edb185a3985410367754ab33217362bnicholes<dt><span class="term">-y <em class="replaceable"><code>key_id</code></em></span></dt>
9b2bd54c98edb185a3985410367754ab33217362bnicholes Use the key <em class="replaceable"><code>key_id</code></em>
9b2bd54c98edb185a3985410367754ab33217362bnicholes from the configuration file.
9b2bd54c98edb185a3985410367754ab33217362bnicholes known by <span class="command"><strong>named</strong></span> with the same algorithm and secret string
9b2bd54c98edb185a3985410367754ab33217362bnicholes in order for control message validation to succeed.
9b2bd54c98edb185a3985410367754ab33217362bnicholes If no <em class="replaceable"><code>key_id</code></em>
9b2bd54c98edb185a3985410367754ab33217362bnicholes is specified, <span class="command"><strong>rndc</strong></span> will first look
9b2bd54c98edb185a3985410367754ab33217362bnicholes for a key clause in the server statement of the server
9b2bd54c98edb185a3985410367754ab33217362bnicholes being used, or if no server statement is present for that
9b2bd54c98edb185a3985410367754ab33217362bnicholes host, then the default-key clause of the options statement.
9b2bd54c98edb185a3985410367754ab33217362bnicholes Note that the configuration file contains shared secrets
9b2bd54c98edb185a3985410367754ab33217362bnicholes which are used to send authenticated control commands
9b2bd54c98edb185a3985410367754ab33217362bnicholes to name servers. It should therefore not have general read
9b2bd54c98edb185a3985410367754ab33217362bnicholes or write access.
9b2bd54c98edb185a3985410367754ab33217362bnicholes A list of commands supported by <span class="command"><strong>rndc</strong></span> can
9b2bd54c98edb185a3985410367754ab33217362bnicholes be seen by running <span class="command"><strong>rndc</strong></span> without arguments.
9b2bd54c98edb185a3985410367754ab33217362bnicholes Currently supported commands are:
9b2bd54c98edb185a3985410367754ab33217362bnicholes <div class="variablelist"><dl class="variablelist">
0cb770e9049c8e85ede0bbe3d47904785b15f868fuankg<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>
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg Add a zone while the server is running. This
609ef720afd62ca63391c9fdb415cd2faf29aa46bnicholes command requires the
609ef720afd62ca63391c9fdb415cd2faf29aa46bnicholes <span class="command"><strong>allow-new-zones</strong></span> option to be set
609ef720afd62ca63391c9fdb415cd2faf29aa46bnicholes to <strong class="userinput"><code>yes</code></strong>. The
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg <em class="replaceable"><code>configuration</code></em> string
609ef720afd62ca63391c9fdb415cd2faf29aa46bnicholes specified on the command line is the zone
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg configuration text that would ordinarily be
9b2bd54c98edb185a3985410367754ab33217362bnicholes The configuration is saved in a file called
9b2bd54c98edb185a3985410367754ab33217362bnicholes <code class="filename"><em class="replaceable"><code>name</code></em>.nzf</code>,
9b2bd54c98edb185a3985410367754ab33217362bnicholes where <em class="replaceable"><code>name</code></em> is the
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg name of the view, or if it contains characters
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg that are incompatible with use as a file name, a
9b2bd54c98edb185a3985410367754ab33217362bnicholes cryptographic hash generated from the name
9b2bd54c98edb185a3985410367754ab33217362bnicholes of the view.
9b2bd54c98edb185a3985410367754ab33217362bnicholes When <span class="command"><strong>named</strong></span> is
9b2bd54c98edb185a3985410367754ab33217362bnicholes restarted, the file will be loaded into the view
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg configuration, so that zones that were added
9b2bd54c98edb185a3985410367754ab33217362bnicholes can persist after a restart.
9b2bd54c98edb185a3985410367754ab33217362bnicholes This sample <span class="command"><strong>addzone</strong></span> command
9b2bd54c98edb185a3985410367754ab33217362bnicholes would add the zone <code class="literal">example.com</code>
9b2bd54c98edb185a3985410367754ab33217362bnicholes to the default view:
9b2bd54c98edb185a3985410367754ab33217362bnicholes<code class="prompt">$ </code><strong class="userinput"><code>rndc addzone example.com '{ type master; file "example.com.db"; };'</code></strong>
9b2bd54c98edb185a3985410367754ab33217362bnicholes (Note the brackets and semi-colon around the zone
9b2bd54c98edb185a3985410367754ab33217362bnicholes configuration text.)
9b2bd54c98edb185a3985410367754ab33217362bnicholes See also <span class="command"><strong>rndc delzone</strong></span> and <span class="command"><strong>rndc modzone</strong></span>.
9b2bd54c98edb185a3985410367754ab33217362bnicholes<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>
9b2bd54c98edb185a3985410367754ab33217362bnicholes Delete a zone while the server is running.
9b2bd54c98edb185a3985410367754ab33217362bnicholes If the <code class="option">-clean</code> argument is specified,
9b2bd54c98edb185a3985410367754ab33217362bnicholes the zone's master file (and journal file, if any)
9b2bd54c98edb185a3985410367754ab33217362bnicholes will be deleted along with the zone. Without the
9b2bd54c98edb185a3985410367754ab33217362bnicholes <code class="option">-clean</code> option, zone files must
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg be cleaned up by hand. (If the zone is of
See also <span class="command"><strong>rndc addzone</strong></span> and <span class="command"><strong>rndc modzone</strong></span>.
<dt><span class="term"><strong class="userinput"><code>dnstap ( -reopen | -roll [<span class="optional"><em class="replaceable"><code>number</code></em></span>] )</code></strong></span></dt>
<dt><span class="term"><strong class="userinput"><code>dumpdb [<span class="optional">-all|-cache|-zones|-adb|-bad|-fail</span>] [<span class="optional"><em class="replaceable"><code>view ...</code></em></span>]</code></strong></span></dt>
<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>
<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>
<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>
<dt><span class="term"><strong class="userinput"><code>halt [<span class="optional">-p</span>]</code></strong></span></dt>
If <code class="option">-p</code> is specified <span class="command"><strong>named</strong></span>'s process id is returned.
This allows an external process to determine when <span class="command"><strong>named</strong></span>
<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>
<dt><span class="term"><strong class="userinput"><code>managed-keys <em class="replaceable"><code>(status | refresh | sync)</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>
<dt><span class="term"><strong class="userinput"><code>modzone <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>
See also <span class="command"><strong>rndc addzone</strong></span> and <span class="command"><strong>rndc delzone</strong></span>.
<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>
[<span class="optional">( -d | -f | -r | -l <em class="replaceable"><code>duration</code></em>)</span>]
All of these options can be shortened, i.e., to
<dt><span class="term"><strong class="userinput"><code>querylog</code></strong> [<span class="optional"> on | off </span>] </span></dt>
<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>
<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>
<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>
<dt><span class="term"><strong class="userinput"><code>secroots [<span class="optional">-</span>] [<span class="optional"><em class="replaceable"><code>view ...</code></em></span>]</code></strong></span></dt>
<dt><span class="term"><strong class="userinput"><code>showzone <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>
<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>
<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> ) | -serial <em class="replaceable"><code>value</code></em> ) </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>
<span class="command"><strong>rndc signing -nsec3param 1 0 10 FFFF <em class="replaceable"><code>zone</code></em></strong></span>.
<span class="command"><strong>rndc signing -nsec3param 1 1 15 - <em class="replaceable"><code>zone</code></em></strong></span>.
Note that the number of zones includes the internal <span class="command"><strong>bind/CH</strong></span> zone
<dt><span class="term"><strong class="userinput"><code>stop [<span class="optional">-p</span>]</code></strong></span></dt>
If <code class="option">-p</code> is specified <span class="command"><strong>named</strong></span>'s process id is returned.
This allows an external process to determine when <span class="command"><strong>named</strong></span>
<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>
<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>
<dt><span class="term"><strong class="userinput"><code>trace <em class="replaceable"><code>level</code></em></code></strong></span></dt>
<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>
<dt><span class="term"><strong class="userinput"><code>validation ( on | off | status ) [<span class="optional"><em class="replaceable"><code>view ...</code></em></span>] </code></strong></span></dt>
<dt><span class="term"><strong class="userinput"><code>zonestatus <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>
<p xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.11.3 (Extended Support Version)</p>