man.rndc.html revision 0ddeab91cf922fd977f37318620b4c69dccf8364
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews - Copyright (C) 2004-2009 Internet Systems Consortium, Inc. ("ISC")
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - Copyright (C) 2000-2003 Internet Software Consortium.
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - Permission to use, copy, modify, and distribute this software for any
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - purpose with or without fee is hereby granted, provided that the above
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - copyright notice and this permission notice appear in all copies.
d6fa26d0adaec6c910115be34fe7a5a5f402c14fMark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User - PERFORMANCE OF THIS SOFTWARE.
c3dc968140ab7f04795acc7835e4e89ccb0c0a27Tinderbox User<!-- $Id: man.rndc.html,v 1.106 2009/01/10 01:11:54 tbox Exp $ -->
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater<link rel="prev" href="man.nsupdate.html" title="nsupdate">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<link rel="next" href="man.rndc.conf.html" title="rndc.conf">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<table width="100%" summary="Navigation header">
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<tr><th colspan="3" align="center"><span class="application">rndc</span></th></tr>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<a accesskey="p" href="man.nsupdate.html">Prev</a>�</td>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<th width="60%" align="center">Manual pages</th>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<td width="20%" align="right">�<a accesskey="n" href="man.rndc.conf.html">Next</a>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<a name="man.rndc"></a><div class="titlepage"></div>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<p><span class="application">rndc</span> — name server control utility</p>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<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">-V</code>] [<code class="option">-y <em class="replaceable"><code>key_id</code></em></code>] {command}</p></div>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<p><span><strong class="command">rndc</strong></span>
7e71f05d8643aca84914437c900cb716444507e4Tinderbox User controls the operation of a name
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User server. It supersedes the <span><strong class="command">ndc</strong></span> utility
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews that was provided in old BIND releases. If
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <span><strong class="command">rndc</strong></span> is invoked with no command line
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews options or arguments, it prints a short summary of the
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User supported commands and the available options and their
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<p><span><strong class="command">rndc</strong></span>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User communicates with the name server
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater over a TCP connection, sending commands authenticated with
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User digital signatures. In the current versions of
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater <span><strong class="command">rndc</strong></span> and <span><strong class="command">named</strong></span>,
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater the only supported authentication algorithm is HMAC-MD5,
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater which uses a shared secret on each end of the connection.
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater This provides TSIG-style authentication for the command
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater request and the name server's response. All commands sent
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt over the channel must be signed by a key_id known to the
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<p><span><strong class="command">rndc</strong></span>
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater reads a configuration file to
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater determine how to contact the name server and decide what
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User algorithm and key it should use.
be6c1c506161e6f45fcff5d0425f78801bc267c1Automatic Updater<dt><span class="term">-b <em class="replaceable"><code>source-address</code></em></span></dt>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt Use <em class="replaceable"><code>source-address</code></em>
9d557856c2a19ec95ee73245f60a92f8675cf5baTinderbox User as the source address for the connection to the server.
43b94483957d3168796a816ed86cf097518817dcTinderbox User Multiple instances are permitted to allow setting of both
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User the IPv4 and IPv6 source addresses.
6ea2385360e9e2167e65f9286447da9eea189457Tinderbox User<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
6ea2385360e9e2167e65f9286447da9eea189457Tinderbox User Use <em class="replaceable"><code>config-file</code></em>
6ea2385360e9e2167e65f9286447da9eea189457Tinderbox User as the configuration file instead of the default,
6ea2385360e9e2167e65f9286447da9eea189457Tinderbox User <code class="filename">/etc/rndc.conf</code>.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<dt><span class="term">-k <em class="replaceable"><code>key-file</code></em></span></dt>
6ea2385360e9e2167e65f9286447da9eea189457Tinderbox User Use <em class="replaceable"><code>key-file</code></em>
6ea2385360e9e2167e65f9286447da9eea189457Tinderbox User as the key file instead of the default,
6ea2385360e9e2167e65f9286447da9eea189457Tinderbox User <code class="filename">/etc/rndc.key</code>. The key in
6ea2385360e9e2167e65f9286447da9eea189457Tinderbox User <code class="filename">/etc/rndc.key</code> will be used to
6ea2385360e9e2167e65f9286447da9eea189457Tinderbox User commands sent to the server if the <em class="replaceable"><code>config-file</code></em>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User does not exist.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<dt><span class="term">-s <em class="replaceable"><code>server</code></em></span></dt>
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater<dd><p><em class="replaceable"><code>server</code></em> is
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater the name or address of the server which matches a
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater server statement in the configuration file for
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <span><strong class="command">rndc</strong></span>. If no server is supplied on the
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater command line, the host named by the default-server clause
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User in the options statement of the <span><strong class="command">rndc</strong></span>
0a7ed88633a680bb881868b75ded4d09a7bbbc50Automatic Updater configuration file will be used.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User Send commands to TCP port
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User of BIND 9's default control channel port, 953.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Enable verbose logging.
0e1dece22e128f9dfa723316a35c4b3f06912381Tinderbox User<dt><span class="term">-y <em class="replaceable"><code>key_id</code></em></span></dt>
0e1dece22e128f9dfa723316a35c4b3f06912381Tinderbox User Use the key <em class="replaceable"><code>key_id</code></em>
0e1dece22e128f9dfa723316a35c4b3f06912381Tinderbox User from the configuration file.
0e1dece22e128f9dfa723316a35c4b3f06912381Tinderbox User <em class="replaceable"><code>key_id</code></em>
0e1dece22e128f9dfa723316a35c4b3f06912381Tinderbox User known by named with the same algorithm and secret string
0e1dece22e128f9dfa723316a35c4b3f06912381Tinderbox User in order for control message validation to succeed.
0e1dece22e128f9dfa723316a35c4b3f06912381Tinderbox User If no <em class="replaceable"><code>key_id</code></em>
0e1dece22e128f9dfa723316a35c4b3f06912381Tinderbox User is specified, <span><strong class="command">rndc</strong></span> will first look
0e1dece22e128f9dfa723316a35c4b3f06912381Tinderbox User for a key clause in the server statement of the server
0e1dece22e128f9dfa723316a35c4b3f06912381Tinderbox User being used, or if no server statement is present for that
0e1dece22e128f9dfa723316a35c4b3f06912381Tinderbox User host, then the default-key clause of the options statement.
0e1dece22e128f9dfa723316a35c4b3f06912381Tinderbox User Note that the configuration file contains shared secrets
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User which are used to send authenticated control commands
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews to name servers. It should therefore not have general read
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User or write access.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews For the complete set of commands supported by <span><strong class="command">rndc</strong></span>,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews see the BIND 9 Administrator Reference Manual or run
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <span><strong class="command">rndc</strong></span> without arguments to see its help
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<p><span><strong class="command">rndc</strong></span>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews does not yet support all the commands of
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews the BIND 8 <span><strong class="command">ndc</strong></span> utility.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews There is currently no way to provide the shared secret for a
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <code class="option">key_id</code> without using the configuration file.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User Several error messages could be clearer.
60a900e83bab52c3f023be66654f3ab023172778Automatic Updater<p><span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
60a900e83bab52c3f023be66654f3ab023172778Automatic Updater <span class="citerefentry"><span class="refentrytitle">rndc-confgen</span>(8)</span>,
60a900e83bab52c3f023be66654f3ab023172778Automatic Updater <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
60a900e83bab52c3f023be66654f3ab023172778Automatic Updater <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
60a900e83bab52c3f023be66654f3ab023172778Automatic Updater <span class="citerefentry"><span class="refentrytitle">ndc</span>(8)</span>,
60a900e83bab52c3f023be66654f3ab023172778Automatic Updater <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
60a900e83bab52c3f023be66654f3ab023172778Automatic Updater<p><span class="corpauthor">Internet Systems Consortium</span>
60a900e83bab52c3f023be66654f3ab023172778Automatic Updater<table width="100%" summary="Navigation footer">
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<a accesskey="p" href="man.nsupdate.html">Prev</a>�</td>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<td width="40%" align="right">�<a accesskey="n" href="man.rndc.conf.html">Next</a>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<span class="application">nsupdate</span>�</td>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<td width="40%" align="right" valign="top">�<code class="filename">rndc.conf</code>