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