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