man.rndc.html revision 7e71f05d8643aca84914437c900cb716444507e4
178f6ad061e54bc5babfca3577f72058fa0797c1Bob Halley - Copyright (C) 2000-2015 Internet Systems Consortium, Inc. ("ISC")
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews - This Source Code Form is subject to the terms of the Mozilla Public
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews - License, v. 2.0. If a copy of the MPL was not distributed with this
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews - file, You can obtain one at http://mozilla.org/MPL/2.0/.
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews<link rel="prev" href="man.nsupdate.html" title="nsupdate">
bf8267aa453e5d2a735ed732a043b77a0b355b20Mark Andrews<link rel="next" href="man.rndc.conf.html" title="rndc.conf">
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<tr><th colspan="3" align="center"><span class="application">rndc</span></th></tr>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<a accesskey="p" href="man.nsupdate.html">Prev</a>�</td>
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence<td width="20%" align="right">�<a accesskey="n" href="man.rndc.conf.html">Next</a>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<a name="man.rndc"></a><div class="titlepage"></div>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<p><span class="application">rndc</span> — name server control utility</p>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<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">-r</code>] [<code class="option">-V</code>] [<code class="option">-y <em class="replaceable"><code>key_id</code></em></code>] {command}</p></div>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt<p><span class="command"><strong>rndc</strong></span>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt controls the operation of a name
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt server. It supersedes the <span class="command"><strong>ndc</strong></span> utility
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt that was provided in old BIND releases. If
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt <span class="command"><strong>rndc</strong></span> is invoked with no command line
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt options or arguments, it prints a short summary of the
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt supported commands and the available options and their
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence<p><span class="command"><strong>rndc</strong></span>
18483fce5b9d1e02748bdcb916014cedea654f78Mark Andrews communicates with the name server over a TCP connection, sending
18483fce5b9d1e02748bdcb916014cedea654f78Mark Andrews commands authenticated with digital signatures. In the current
18483fce5b9d1e02748bdcb916014cedea654f78Mark Andrews <span class="command"><strong>rndc</strong></span> and <span class="command"><strong>named</strong></span>,
18483fce5b9d1e02748bdcb916014cedea654f78Mark Andrews the only supported authentication algorithms are HMAC-MD5
18483fce5b9d1e02748bdcb916014cedea654f78Mark Andrews (for compatibility), HMAC-SHA1, HMAC-SHA224, HMAC-SHA256
18483fce5b9d1e02748bdcb916014cedea654f78Mark Andrews (default), HMAC-SHA384 and HMAC-SHA512.
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence They use a shared secret on each end of the connection.
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley This provides TSIG-style authentication for the command
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence request and the name server's response. All commands sent
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence over the channel must be signed by a key_id known to the
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence<p><span class="command"><strong>rndc</strong></span>
dabea86dac4c01f852b7aea728f73b4f55a89d44Mark Andrews reads a configuration file to
dabea86dac4c01f852b7aea728f73b4f55a89d44Mark Andrews determine how to contact the name server and decide what
dabea86dac4c01f852b7aea728f73b4f55a89d44Mark Andrews algorithm and key it should use.
dabea86dac4c01f852b7aea728f73b4f55a89d44Mark Andrews<div class="variablelist"><dl class="variablelist">
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<dt><span class="term">-b <em class="replaceable"><code>source-address</code></em></span></dt>
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence Use <em class="replaceable"><code>source-address</code></em>
18483fce5b9d1e02748bdcb916014cedea654f78Mark Andrews as the source address for the connection to the server.
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence Multiple instances are permitted to allow setting of both
18483fce5b9d1e02748bdcb916014cedea654f78Mark Andrews the IPv4 and IPv6 source addresses.
18483fce5b9d1e02748bdcb916014cedea654f78Mark Andrews<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
18483fce5b9d1e02748bdcb916014cedea654f78Mark Andrews Use <em class="replaceable"><code>config-file</code></em>
8319af16557b81eba3277ee67215285f0823b587Mark Andrews as the configuration file instead of the default,
18483fce5b9d1e02748bdcb916014cedea654f78Mark Andrews<dt><span class="term">-k <em class="replaceable"><code>key-file</code></em></span></dt>
f7a6d4f915ce622d988916397f313b33ae954afcMark Andrews Use <em class="replaceable"><code>key-file</code></em>
f7a6d4f915ce622d988916397f313b33ae954afcMark Andrews as the key file instead of the default,
18483fce5b9d1e02748bdcb916014cedea654f78Mark Andrews <code class="filename">/etc/rndc.key</code>. The key in
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence <code class="filename">/etc/rndc.key</code> will be used to
66c9805347f24da946c17a881e489ffe2e89c25dMark Andrews authenticate
66c9805347f24da946c17a881e489ffe2e89c25dMark Andrews commands sent to the server if the <em class="replaceable"><code>config-file</code></em>
18483fce5b9d1e02748bdcb916014cedea654f78Mark Andrews does not exist.
66c9805347f24da946c17a881e489ffe2e89c25dMark Andrews<dt><span class="term">-s <em class="replaceable"><code>server</code></em></span></dt>
66c9805347f24da946c17a881e489ffe2e89c25dMark Andrews<dd><p><em class="replaceable"><code>server</code></em> is
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence the name or address of the server which matches a
c32b87bc54abacf95fb3b063d72b7d1855c1643bMichael Graff server statement in the configuration file for
7f9f8c13c5e5e26e0ba2b82c0900d11ecf6269ceMark Andrews <span class="command"><strong>rndc</strong></span>. If no server is supplied on the
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence command line, the host named by the default-server clause
c3e6fbe4b7471d843d015e3f1737b7edb9d0c547Mark Andrews in the options statement of the <span class="command"><strong>rndc</strong></span>
c3e6fbe4b7471d843d015e3f1737b7edb9d0c547Mark Andrews configuration file will be used.
12e63bfe1d111ccb57f482b28d56c785cccc7cf7David Lawrence<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
460b427411b72da26b1836b9424e2e70d65d9394David Lawrence Send commands to TCP port
6376f6189950156cc1488c86f22b19dd4feec11cMark Andrews of BIND 9's default control channel port, 953.
5e47b4200ed81b8e18e165fe3a626d9992003db4Mark Andrews Quiet mode: Message text returned by the server
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley will not be printed except when there is an error.
620a452ebe92fff63e85c5930a6e6dc8d9455918Mark Andrews Instructs <span class="command"><strong>rndc</strong></span> to print the result code
6dcb47e37f9f0cdb94bdabc3fa157ff07983c590Mark Andrews returned by <span class="command"><strong>named</strong></span> after executing the
6dcb47e37f9f0cdb94bdabc3fa157ff07983c590Mark Andrews requested command (e.g., ISC_R_SUCCESS, ISC_R_FAILURE, etc).
f10370fd44f05fecc808d89c01b2d50df2b232f3Mark Andrews Enable verbose logging.
693d70f96fc2b3c1830580edcc29146afd6a9f61Mark Andrews<dt><span class="term">-y <em class="replaceable"><code>key_id</code></em></span></dt>
693d70f96fc2b3c1830580edcc29146afd6a9f61Mark Andrews Use the key <em class="replaceable"><code>key_id</code></em>
d3347bd01baee56e476982a7443ba18cdbaeebe1Mark Andrews from the configuration file.
d3347bd01baee56e476982a7443ba18cdbaeebe1Mark Andrews <em class="replaceable"><code>key_id</code></em>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley known by <span class="command"><strong>named</strong></span> with the same algorithm and secret string
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley in order for control message validation to succeed.
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt If no <em class="replaceable"><code>key_id</code></em>
66c9805347f24da946c17a881e489ffe2e89c25dMark Andrews is specified, <span class="command"><strong>rndc</strong></span> will first look
4c6bf2d14ee70f1966d4c18475f93211fbc928e1Mark Andrews for a key clause in the server statement of the server
66c9805347f24da946c17a881e489ffe2e89c25dMark Andrews being used, or if no server statement is present for that
66c9805347f24da946c17a881e489ffe2e89c25dMark Andrews host, then the default-key clause of the options statement.
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley Note that the configuration file contains shared secrets
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley which are used to send authenticated control commands
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley to name servers. It should therefore not have general read
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley or write access.
18483fce5b9d1e02748bdcb916014cedea654f78Mark Andrews A list of commands supported by <span class="command"><strong>rndc</strong></span> can
0014d6342b0d50ae37126ac16d5bf821d02ffff7David Lawrence be seen by running <span class="command"><strong>rndc</strong></span> without arguments.
a9558a6c63d9c6dbb2f3800b39ccb008652fcde3Mark Andrews Currently supported commands are:
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<div class="variablelist"><dl class="variablelist">
0014d6342b0d50ae37126ac16d5bf821d02ffff7David Lawrence<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>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt Add a zone while the server is running. This
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley command requires the
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley <span class="command"><strong>allow-new-zones</strong></span> option to be set
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley to <strong class="userinput"><code>yes</code></strong>. The
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley <em class="replaceable"><code>configuration</code></em> string
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley specified on the command line is the zone
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt configuration text that would ordinarily be
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley placed in <code class="filename">named.conf</code>.
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt The configuration is saved in a file called
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley <code class="filename"><em class="replaceable"><code>name</code></em>.nzf</code>,
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley where <em class="replaceable"><code>name</code></em> is the
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley name of the view, or if it contains characters
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt that are incompatible with use as a file name, a
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley cryptographic hash generated from the name
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt of the view.
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt When <span class="command"><strong>named</strong></span> is
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley restarted, the file will be loaded into the view
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley configuration, so that zones that were added
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley can persist after a restart.
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley This sample <span class="command"><strong>addzone</strong></span> command
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley would add the zone <code class="literal">example.com</code>
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley to the default view:
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley<code class="prompt">$ </code><strong class="userinput"><code>rndc addzone example.com '{ type master; file "example.com.db"; };'</code></strong>
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt (Note the brackets and semi-colon around the zone
af9dbf1ccdd53933aaae9300d13ce0965d39b067Evan Hunt configuration text.)
0b72c791466d0807bcf22522b5ddb7da902c2720Bob Halley See also <span class="command"><strong>rndc delzone</strong></span> and <span class="command"><strong>rndc modzone</strong></span>.
<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>
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|-zone|-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 | check ) [<span class="optional"><em class="replaceable"><code>view ...</code></em></span>] </code></strong></span></dt>