2004-09-19 01:30:24 +00:00
|
|
|
<!--
|
2007-06-02 23:21:47 +00:00
|
|
|
- Copyright (C) 2004, 2005, 2007 Internet Systems Consortium, Inc. ("ISC")
|
2005-12-29 04:22:58 +00:00
|
|
|
- Copyright (C) 2000, 2001 Internet Software Consortium.
|
|
|
|
|
-
|
2010-03-02 19:49:55 +00:00
|
|
|
- Permission to use, copy, modify, and/or distribute this software for any
|
2004-09-19 01:30:24 +00:00
|
|
|
- purpose with or without fee is hereby granted, provided that the above
|
|
|
|
|
- copyright notice and this permission notice appear in all copies.
|
2005-12-29 04:22:58 +00:00
|
|
|
-
|
2004-09-19 01:30:24 +00:00
|
|
|
- THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
|
|
|
|
|
- REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
|
2005-12-29 04:22:58 +00:00
|
|
|
- AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
|
2004-09-19 01:30:24 +00:00
|
|
|
- INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
|
|
|
|
- LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
|
|
|
|
|
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
|
|
|
- PERFORMANCE OF THIS SOFTWARE.
|
|
|
|
|
-->
|
2011-05-27 23:50:10 +00:00
|
|
|
<!-- $Id: rndc.html,v 1.31.214.1 2009-07-11 01:55:21 tbox Exp $ -->
|
2005-12-29 04:22:58 +00:00
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
|
|
|
|
<title>rndc</title>
|
2007-06-02 23:21:47 +00:00
|
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
|
2005-12-29 04:22:58 +00:00
|
|
|
</head>
|
|
|
|
|
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
|
2007-06-02 23:21:47 +00:00
|
|
|
<a name="man.rndc"></a><div class="titlepage"></div>
|
2005-12-29 04:22:58 +00:00
|
|
|
<div class="refnamediv">
|
|
|
|
|
<h2>Name</h2>
|
|
|
|
|
<p><span class="application">rndc</span> — name server control utility</p>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="refsynopsisdiv">
|
|
|
|
|
<h2>Synopsis</h2>
|
2007-06-02 23:21:47 +00:00
|
|
|
<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>
|
2005-12-29 04:22:58 +00:00
|
|
|
</div>
|
|
|
|
|
<div class="refsect1" lang="en">
|
2007-06-02 23:21:47 +00:00
|
|
|
<a name="id2543413"></a><h2>DESCRIPTION</h2>
|
|
|
|
|
<p><span><strong class="command">rndc</strong></span>
|
|
|
|
|
controls the operation of a name
|
|
|
|
|
server. It supersedes the <span><strong class="command">ndc</strong></span> utility
|
|
|
|
|
that was provided in old BIND releases. If
|
|
|
|
|
<span><strong class="command">rndc</strong></span> is invoked with no command line
|
|
|
|
|
options or arguments, it prints a short summary of the
|
|
|
|
|
supported commands and the available options and their
|
|
|
|
|
arguments.
|
2005-12-29 04:22:58 +00:00
|
|
|
</p>
|
2007-06-02 23:21:47 +00:00
|
|
|
<p><span><strong class="command">rndc</strong></span>
|
|
|
|
|
communicates with the name server
|
|
|
|
|
over a TCP connection, sending commands authenticated with
|
|
|
|
|
digital signatures. In the current versions of
|
2007-12-02 19:10:41 +00:00
|
|
|
<span><strong class="command">rndc</strong></span> and <span><strong class="command">named</strong></span>,
|
2007-06-02 23:21:47 +00:00
|
|
|
the only supported authentication algorithm is HMAC-MD5,
|
|
|
|
|
which uses a shared secret on each end of the connection.
|
|
|
|
|
This provides TSIG-style authentication for the command
|
|
|
|
|
request and the name server's response. All commands sent
|
|
|
|
|
over the channel must be signed by a key_id known to the
|
|
|
|
|
server.
|
2005-12-29 04:22:58 +00:00
|
|
|
</p>
|
2007-06-02 23:21:47 +00:00
|
|
|
<p><span><strong class="command">rndc</strong></span>
|
|
|
|
|
reads a configuration file to
|
|
|
|
|
determine how to contact the name server and decide what
|
|
|
|
|
algorithm and key it should use.
|
2005-12-29 04:22:58 +00:00
|
|
|
</p>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="refsect1" lang="en">
|
2007-06-02 23:21:47 +00:00
|
|
|
<a name="id2543448"></a><h2>OPTIONS</h2>
|
2005-12-29 04:22:58 +00:00
|
|
|
<div class="variablelist"><dl>
|
2007-06-02 23:21:47 +00:00
|
|
|
<dt><span class="term">-b <em class="replaceable"><code>source-address</code></em></span></dt>
|
|
|
|
|
<dd><p>
|
|
|
|
|
Use <em class="replaceable"><code>source-address</code></em>
|
|
|
|
|
as the source address for the connection to the server.
|
|
|
|
|
Multiple instances are permitted to allow setting of both
|
|
|
|
|
the IPv4 and IPv6 source addresses.
|
|
|
|
|
</p></dd>
|
2005-12-29 04:22:58 +00:00
|
|
|
<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt>
|
|
|
|
|
<dd><p>
|
2007-06-02 23:21:47 +00:00
|
|
|
Use <em class="replaceable"><code>config-file</code></em>
|
|
|
|
|
as the configuration file instead of the default,
|
|
|
|
|
<code class="filename">/etc/rndc.conf</code>.
|
|
|
|
|
</p></dd>
|
2005-12-29 04:22:58 +00:00
|
|
|
<dt><span class="term">-k <em class="replaceable"><code>key-file</code></em></span></dt>
|
|
|
|
|
<dd><p>
|
2007-06-02 23:21:47 +00:00
|
|
|
Use <em class="replaceable"><code>key-file</code></em>
|
|
|
|
|
as the key file instead of the default,
|
|
|
|
|
<code class="filename">/etc/rndc.key</code>. The key in
|
|
|
|
|
<code class="filename">/etc/rndc.key</code> will be used to
|
|
|
|
|
authenticate
|
|
|
|
|
commands sent to the server if the <em class="replaceable"><code>config-file</code></em>
|
|
|
|
|
does not exist.
|
|
|
|
|
</p></dd>
|
2005-12-29 04:22:58 +00:00
|
|
|
<dt><span class="term">-s <em class="replaceable"><code>server</code></em></span></dt>
|
2007-06-02 23:21:47 +00:00
|
|
|
<dd><p><em class="replaceable"><code>server</code></em> is
|
2007-12-02 19:10:41 +00:00
|
|
|
the name or address of the server which matches a
|
2007-06-02 23:21:47 +00:00
|
|
|
server statement in the configuration file for
|
2007-12-02 19:10:41 +00:00
|
|
|
<span><strong class="command">rndc</strong></span>. If no server is supplied on the
|
2007-06-02 23:21:47 +00:00
|
|
|
command line, the host named by the default-server clause
|
2007-12-02 19:10:41 +00:00
|
|
|
in the options statement of the <span><strong class="command">rndc</strong></span>
|
|
|
|
|
configuration file will be used.
|
2007-06-02 23:21:47 +00:00
|
|
|
</p></dd>
|
2005-12-29 04:22:58 +00:00
|
|
|
<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
|
|
|
|
|
<dd><p>
|
2007-06-02 23:21:47 +00:00
|
|
|
Send commands to TCP port
|
|
|
|
|
<em class="replaceable"><code>port</code></em>
|
|
|
|
|
instead
|
|
|
|
|
of BIND 9's default control channel port, 953.
|
|
|
|
|
</p></dd>
|
2005-12-29 04:22:58 +00:00
|
|
|
<dt><span class="term">-V</span></dt>
|
|
|
|
|
<dd><p>
|
2007-06-02 23:21:47 +00:00
|
|
|
Enable verbose logging.
|
|
|
|
|
</p></dd>
|
2007-12-02 19:10:41 +00:00
|
|
|
<dt><span class="term">-y <em class="replaceable"><code>key_id</code></em></span></dt>
|
2005-12-29 04:22:58 +00:00
|
|
|
<dd><p>
|
2007-12-02 19:10:41 +00:00
|
|
|
Use the key <em class="replaceable"><code>key_id</code></em>
|
2007-06-02 23:21:47 +00:00
|
|
|
from the configuration file.
|
2007-12-02 19:10:41 +00:00
|
|
|
<em class="replaceable"><code>key_id</code></em>
|
2007-06-02 23:21:47 +00:00
|
|
|
must be
|
|
|
|
|
known by named with the same algorithm and secret string
|
|
|
|
|
in order for control message validation to succeed.
|
2007-12-02 19:10:41 +00:00
|
|
|
If no <em class="replaceable"><code>key_id</code></em>
|
2007-06-02 23:21:47 +00:00
|
|
|
is specified, <span><strong class="command">rndc</strong></span> will first look
|
|
|
|
|
for a key clause in the server statement of the server
|
|
|
|
|
being used, or if no server statement is present for that
|
|
|
|
|
host, then the default-key clause of the options statement.
|
|
|
|
|
Note that the configuration file contains shared secrets
|
|
|
|
|
which are used to send authenticated control commands
|
|
|
|
|
to name servers. It should therefore not have general read
|
|
|
|
|
or write access.
|
|
|
|
|
</p></dd>
|
2005-12-29 04:22:58 +00:00
|
|
|
</dl></div>
|
|
|
|
|
<p>
|
|
|
|
|
For the complete set of commands supported by <span><strong class="command">rndc</strong></span>,
|
2004-09-19 01:30:24 +00:00
|
|
|
see the BIND 9 Administrator Reference Manual or run
|
2007-06-02 23:21:47 +00:00
|
|
|
<span><strong class="command">rndc</strong></span> without arguments to see its help
|
|
|
|
|
message.
|
2005-12-29 04:22:58 +00:00
|
|
|
</p>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="refsect1" lang="en">
|
2007-12-02 19:10:41 +00:00
|
|
|
<a name="id2543656"></a><h2>LIMITATIONS</h2>
|
2007-06-02 23:21:47 +00:00
|
|
|
<p><span><strong class="command">rndc</strong></span>
|
|
|
|
|
does not yet support all the commands of
|
|
|
|
|
the BIND 8 <span><strong class="command">ndc</strong></span> utility.
|
2005-12-29 04:22:58 +00:00
|
|
|
</p>
|
|
|
|
|
<p>
|
2007-06-02 23:21:47 +00:00
|
|
|
There is currently no way to provide the shared secret for a
|
|
|
|
|
<code class="option">key_id</code> without using the configuration file.
|
2005-12-29 04:22:58 +00:00
|
|
|
</p>
|
|
|
|
|
<p>
|
2007-06-02 23:21:47 +00:00
|
|
|
Several error messages could be clearer.
|
2005-12-29 04:22:58 +00:00
|
|
|
</p>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="refsect1" lang="en">
|
2007-12-02 19:10:41 +00:00
|
|
|
<a name="id2543683"></a><h2>SEE ALSO</h2>
|
2007-06-02 23:21:47 +00:00
|
|
|
<p><span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
|
2008-12-23 18:35:21 +00:00
|
|
|
<span class="citerefentry"><span class="refentrytitle">rndc-confgen</span>(8)</span>,
|
2005-12-29 04:22:58 +00:00
|
|
|
<span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
|
2007-12-02 19:10:41 +00:00
|
|
|
<span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
|
2005-12-29 04:22:58 +00:00
|
|
|
<span class="citerefentry"><span class="refentrytitle">ndc</span>(8)</span>,
|
|
|
|
|
<em class="citetitle">BIND 9 Administrator Reference Manual</em>.
|
|
|
|
|
</p>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="refsect1" lang="en">
|
2008-12-23 18:35:21 +00:00
|
|
|
<a name="id2543738"></a><h2>AUTHOR</h2>
|
2007-06-02 23:21:47 +00:00
|
|
|
<p><span class="corpauthor">Internet Systems Consortium</span>
|
2005-12-29 04:22:58 +00:00
|
|
|
</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div></body>
|
|
|
|
|
</html>
|
