man.rndc.html revision 9ef82979c49da3dd3647273b1cd6ed7d3352c003
47be870bd83fb3719dffc3ee9348a409ab762a14Lennart Poettering - Copyright (C) 2004-2008 Internet Systems Consortium, Inc. ("ISC")
47be870bd83fb3719dffc3ee9348a409ab762a14Lennart Poettering - Copyright (C) 2000-2003 Internet Software Consortium.
47be870bd83fb3719dffc3ee9348a409ab762a14Lennart Poettering - Permission to use, copy, modify, and distribute this software for any
47be870bd83fb3719dffc3ee9348a409ab762a14Lennart Poettering - purpose with or without fee is hereby granted, provided that the above
47be870bd83fb3719dffc3ee9348a409ab762a14Lennart Poettering - copyright notice and this permission notice appear in all copies.
47be870bd83fb3719dffc3ee9348a409ab762a14Lennart Poettering - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
47be870bd83fb3719dffc3ee9348a409ab762a14Lennart Poettering - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
47be870bd83fb3719dffc3ee9348a409ab762a14Lennart Poettering - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
47be870bd83fb3719dffc3ee9348a409ab762a14Lennart Poettering - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
47be870bd83fb3719dffc3ee9348a409ab762a14Lennart Poettering - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
47be870bd83fb3719dffc3ee9348a409ab762a14Lennart Poettering - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
47be870bd83fb3719dffc3ee9348a409ab762a14Lennart Poettering - PERFORMANCE OF THIS SOFTWARE.
47be870bd83fb3719dffc3ee9348a409ab762a14Lennart Poettering<!-- $Id: man.rndc.html,v 1.78 2008/05/07 01:11:56 tbox Exp $ -->
8c4a3079a7f358c179430d1aec59de8b670b5f6eLennart Poettering<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
d1ab0ca07372649dad70a0348d75e394f254e1b6Lennart Poettering<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
8c4a3079a7f358c179430d1aec59de8b670b5f6eLennart Poettering<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
036643a247c659db8e1b3df1778d51553a816ec9Lennart Poettering<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
8c4a3079a7f358c179430d1aec59de8b670b5f6eLennart Poettering<link rel="prev" href="man.named.html" title="named">
d1ab0ca07372649dad70a0348d75e394f254e1b6Lennart Poettering<link rel="next" href="man.rndc.conf.html" title="rndc.conf">
8c4a3079a7f358c179430d1aec59de8b670b5f6eLennart Poettering<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
8c4a3079a7f358c179430d1aec59de8b670b5f6eLennart Poettering<table width="100%" summary="Navigation header">
8c4a3079a7f358c179430d1aec59de8b670b5f6eLennart Poettering<tr><th colspan="3" align="center"><span class="application">rndc</span></th></tr>
70fcff314feff469a8e61dbe5017ed74f5e0a09dLennart Poettering<a accesskey="p" href="man.named.html">Prev</a>�</td>
47be870bd83fb3719dffc3ee9348a409ab762a14Lennart Poettering<th width="60%" align="center">Manual pages</th>
47be870bd83fb3719dffc3ee9348a409ab762a14Lennart Poettering<td width="20%" align="right">�<a accesskey="n" href="man.rndc.conf.html">Next</a>
8c4a3079a7f358c179430d1aec59de8b670b5f6eLennart Poettering<a name="man.rndc"></a><div class="titlepage"></div>
47be870bd83fb3719dffc3ee9348a409ab762a14Lennart Poettering<p><span class="application">rndc</span> — name server control utility</p>
a9b5b03212f9c854938483b8901e433c2ba6619bMichael Tremer<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>
8e27452380193a5f81bfd08a59aab8b07008ba0bLennart Poettering<a name="id2608510"></a><h2>DESCRIPTION</h2>
a9b5b03212f9c854938483b8901e433c2ba6619bMichael Tremer<p><span><strong class="command">rndc</strong></span>
8e27452380193a5f81bfd08a59aab8b07008ba0bLennart Poettering controls the operation of a name
8c4a3079a7f358c179430d1aec59de8b670b5f6eLennart Poettering server. It supersedes the <span><strong class="command">ndc</strong></span> utility
8e27452380193a5f81bfd08a59aab8b07008ba0bLennart Poettering that was provided in old BIND releases. If
0b7964b804e093d31c9adc34ba1917017c7f4d60Lennart Poettering <span><strong class="command">rndc</strong></span> is invoked with no command line
0b7964b804e093d31c9adc34ba1917017c7f4d60Lennart Poettering options or arguments, it prints a short summary of the
47be870bd83fb3719dffc3ee9348a409ab762a14Lennart Poettering supported commands and the available options and their
15ae422b7471cf6f41ccf450243d8afd8ea0a054Lennart Poettering<p><span><strong class="command">rndc</strong></span>
af5bc85dc1297079edc9890861aaa38de0ec30dfLennart Poettering communicates with the name server
af5bc85dc1297079edc9890861aaa38de0ec30dfLennart Poettering over a TCP connection, sending commands authenticated with
47be870bd83fb3719dffc3ee9348a409ab762a14Lennart Poettering digital signatures. In the current versions of
d1ab0ca07372649dad70a0348d75e394f254e1b6Lennart Poettering <span><strong class="command">rndc</strong></span> and <span><strong class="command">named</strong></span>,
dfac97b21e00cd3617ba817227db7b621841b5ccLennart Poettering the only supported authentication algorithm is HMAC-MD5,
e24067c3ec0e16e94e9620d4f7a06ccc4b637eb4Lennart Poettering which uses a shared secret on each end of the connection.
d1ab0ca07372649dad70a0348d75e394f254e1b6Lennart Poettering This provides TSIG-style authentication for the command
dfac97b21e00cd3617ba817227db7b621841b5ccLennart Poettering request and the name server's response. All commands sent
5cc5d790f4593bbf7829faba502e4c00b3718a08Lennart Poettering over the channel must be signed by a key_id known to the
4288f619215e3dda0b75113d78e4fb7ba219ed58Lennart Poettering<p><span><strong class="command">rndc</strong></span>
4288f619215e3dda0b75113d78e4fb7ba219ed58Lennart Poettering reads a configuration file to
4288f619215e3dda0b75113d78e4fb7ba219ed58Lennart Poettering determine how to contact the name server and decide what
4288f619215e3dda0b75113d78e4fb7ba219ed58Lennart Poettering algorithm and key it should use.
4288f619215e3dda0b75113d78e4fb7ba219ed58Lennart Poettering<dt><span class="term">-b <em class="replaceable"><code>source-address</code></em></span></dt>
01f78473b104d28db0fa813414092bc6358ae521Lennart Poettering Use <em class="replaceable"><code>source-address</code></em>
4288f619215e3dda0b75113d78e4fb7ba219ed58Lennart Poettering as the source address for the connection to the server.
d1ab0ca07372649dad70a0348d75e394f254e1b6Lennart Poettering Multiple instances are permitted to allow setting of both
70fcff314feff469a8e61dbe5017ed74f5e0a09dLennart Poettering the IPv4 and IPv6 source addresses.
5e6afdd3d359fc42de7ac432243e98673577e81fLennart Poettering<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
70449379def39da2a3efbd7c7da27a4745702b08Lennart Poettering Use <em class="replaceable"><code>config-file</code></em>
70449379def39da2a3efbd7c7da27a4745702b08Lennart Poettering as the configuration file instead of the default,
70449379def39da2a3efbd7c7da27a4745702b08Lennart Poettering <code class="filename">/etc/rndc.conf</code>.
5e6afdd3d359fc42de7ac432243e98673577e81fLennart Poettering<dt><span class="term">-k <em class="replaceable"><code>key-file</code></em></span></dt>
70449379def39da2a3efbd7c7da27a4745702b08Lennart Poettering Use <em class="replaceable"><code>key-file</code></em>
5e6afdd3d359fc42de7ac432243e98673577e81fLennart Poettering as the key file instead of the default,
f0b02ca2afa806efb73b43a81204ff21c4c65446Lennart Poettering <code class="filename">/etc/rndc.key</code>. The key in
70449379def39da2a3efbd7c7da27a4745702b08Lennart Poettering <code class="filename">/etc/rndc.key</code> will be used to
70449379def39da2a3efbd7c7da27a4745702b08Lennart Poettering commands sent to the server if the <em class="replaceable"><code>config-file</code></em>
70449379def39da2a3efbd7c7da27a4745702b08Lennart Poettering does not exist.
70fcff314feff469a8e61dbe5017ed74f5e0a09dLennart Poettering<dt><span class="term">-s <em class="replaceable"><code>server</code></em></span></dt>
670802d4b1d16c3785a695bea6e13b8bf8c8a822Lennart Poettering<dd><p><em class="replaceable"><code>server</code></em> is
670802d4b1d16c3785a695bea6e13b8bf8c8a822Lennart Poettering the name or address of the server which matches a
670802d4b1d16c3785a695bea6e13b8bf8c8a822Lennart Poettering server statement in the configuration file for
670802d4b1d16c3785a695bea6e13b8bf8c8a822Lennart Poettering <span><strong class="command">rndc</strong></span>. If no server is supplied on the
670802d4b1d16c3785a695bea6e13b8bf8c8a822Lennart Poettering command line, the host named by the default-server clause
670802d4b1d16c3785a695bea6e13b8bf8c8a822Lennart Poettering in the options statement of the <span><strong class="command">rndc</strong></span>
670802d4b1d16c3785a695bea6e13b8bf8c8a822Lennart Poettering configuration file will be used.
670802d4b1d16c3785a695bea6e13b8bf8c8a822Lennart Poettering<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
6d526de26737a0f1e8d1cf422da364d29489022eLennart Poettering Send commands to TCP port
6d526de26737a0f1e8d1cf422da364d29489022eLennart Poettering <em class="replaceable"><code>port</code></em>
70fcff314feff469a8e61dbe5017ed74f5e0a09dLennart Poettering of BIND 9's default control channel port, 953.
5e6afdd3d359fc42de7ac432243e98673577e81fLennart Poettering Enable verbose logging.
dfac97b21e00cd3617ba817227db7b621841b5ccLennart Poettering<dt><span class="term">-y <em class="replaceable"><code>key_id</code></em></span></dt>
a7b6f8e578724c3b4f0cfc8777d9b4a8e29207b0Lennart Poettering Use the key <em class="replaceable"><code>key_id</code></em>
d1ab0ca07372649dad70a0348d75e394f254e1b6Lennart Poettering from the configuration file.
0d26c91071adb33a3c25f075dcbacb85e1469d53Lennart Poettering <em class="replaceable"><code>key_id</code></em>
0d26c91071adb33a3c25f075dcbacb85e1469d53Lennart Poettering known by named with the same algorithm and secret string
fb1bd35a5dd1ad5cfd848fdbe0d64ac53a122af0Lennart Poettering in order for control message validation to succeed.
a1b256b0b562481404bda8304e04dee7d7d5e7c9Lennart Poettering If no <em class="replaceable"><code>key_id</code></em>
a1b256b0b562481404bda8304e04dee7d7d5e7c9Lennart Poettering is specified, <span><strong class="command">rndc</strong></span> will first look
fb1bd35a5dd1ad5cfd848fdbe0d64ac53a122af0Lennart Poettering for a key clause in the server statement of the server
e24067c3ec0e16e94e9620d4f7a06ccc4b637eb4Lennart Poettering being used, or if no server statement is present for that
f92a18f5274ad506aed600b2ed8f4a560c510807Lennart Poettering host, then the default-key clause of the options statement.
5e6afdd3d359fc42de7ac432243e98673577e81fLennart Poettering Note that the configuration file contains shared secrets
5e6afdd3d359fc42de7ac432243e98673577e81fLennart Poettering which are used to send authenticated control commands
5e6afdd3d359fc42de7ac432243e98673577e81fLennart Poettering to name servers. It should therefore not have general read
705dbf3aa3e95a4e591dcbc79774708d71b0e2e8Lennart Poettering or write access.
a1b256b0b562481404bda8304e04dee7d7d5e7c9Lennart Poettering For the complete set of commands supported by <span><strong class="command">rndc</strong></span>,
31cee6f634ce07aa2c3514a506f93830f91f14a5Lennart Poettering see the BIND 9 Administrator Reference Manual or run
eb10a76494542fb560efd09c16b40826fc37bc5fLennart Poettering <span><strong class="command">rndc</strong></span> without arguments to see its help
5e6afdd3d359fc42de7ac432243e98673577e81fLennart Poettering<a name="id2609059"></a><h2>LIMITATIONS</h2>
5e6afdd3d359fc42de7ac432243e98673577e81fLennart Poettering<p><span><strong class="command">rndc</strong></span>
5e6afdd3d359fc42de7ac432243e98673577e81fLennart Poettering does not yet support all the commands of
5e6afdd3d359fc42de7ac432243e98673577e81fLennart Poettering the BIND 8 <span><strong class="command">ndc</strong></span> utility.
5e6afdd3d359fc42de7ac432243e98673577e81fLennart Poettering There is currently no way to provide the shared secret for a
5e6afdd3d359fc42de7ac432243e98673577e81fLennart Poettering <code class="option">key_id</code> without using the configuration file.
65b0095b1c126eee9f8d44f81593edb6ff601356Kay Sievers Several error messages could be clearer.
65b0095b1c126eee9f8d44f81593edb6ff601356Kay Sievers<p><span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
ea2d9ed42d9896d2ade0dcd5d555c35778c19049Marc-Antoine Perennou <span class="citerefentry"><span class="refentrytitle">rndc-confgen</span>(8)</span>,
ea2d9ed42d9896d2ade0dcd5d555c35778c19049Marc-Antoine Perennou <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
ea2d9ed42d9896d2ade0dcd5d555c35778c19049Marc-Antoine Perennou <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
ea2d9ed42d9896d2ade0dcd5d555c35778c19049Marc-Antoine Perennou <span class="citerefentry"><span class="refentrytitle">ndc</span>(8)</span>,
ea2d9ed42d9896d2ade0dcd5d555c35778c19049Marc-Antoine Perennou <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
ea2d9ed42d9896d2ade0dcd5d555c35778c19049Marc-Antoine Perennou<a name="id2609145"></a><h2>AUTHOR</h2>
75db651adba49238a02fe031842155d30e7a8219Tollef Fog Heen<p><span class="corpauthor">Internet Systems Consortium</span>
e99e38bbdcca3fe5956823bdb3d38544ccf93221Lennart Poettering<table width="100%" summary="Navigation footer">
e99e38bbdcca3fe5956823bdb3d38544ccf93221Lennart Poettering<a accesskey="p" href="man.named.html">Prev</a>�</td>
e99e38bbdcca3fe5956823bdb3d38544ccf93221Lennart Poettering<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
e99e38bbdcca3fe5956823bdb3d38544ccf93221Lennart Poettering<td width="40%" align="right">�<a accesskey="n" href="man.rndc.conf.html">Next</a>
e99e38bbdcca3fe5956823bdb3d38544ccf93221Lennart Poettering<td width="40%" align="left" valign="top">
e99e38bbdcca3fe5956823bdb3d38544ccf93221Lennart Poettering<span class="application">named</span>�</td>
e99e38bbdcca3fe5956823bdb3d38544ccf93221Lennart Poettering<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
e99e38bbdcca3fe5956823bdb3d38544ccf93221Lennart Poettering<td width="40%" align="right" valign="top">�<code class="filename">rndc.conf</code>