diff options
Diffstat (limited to 'contrib/bind9/bin/rndc/rndc.html')
| -rw-r--r-- | contrib/bind9/bin/rndc/rndc.html | 454 |
1 files changed, 111 insertions, 343 deletions
diff --git a/contrib/bind9/bin/rndc/rndc.html b/contrib/bind9/bin/rndc/rndc.html index 56f1aa1..d23f468 100644 --- a/contrib/bind9/bin/rndc/rndc.html +++ b/contrib/bind9/bin/rndc/rndc.html @@ -1,284 +1,112 @@ <!-- - - Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") - - Copyright (C) 2001 Internet Software Consortium. - - + - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC") + - Copyright (C) 2000, 2001 Internet Software Consortium. + - - Permission to use, copy, modify, and distribute this software for any - purpose with or without fee is hereby granted, provided that the above - copyright notice and this permission notice appear in all copies. - - + - - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY - - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, + - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, - 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. --> - -<!-- $Id: rndc.html,v 1.7.2.1.4.3 2004/08/22 23:39:00 marka Exp $ --> - -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<HTML -><HEAD -><TITLE ->rndc</TITLE -><META -NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD -><BODY -CLASS="REFENTRY" -BGCOLOR="#FFFFFF" -TEXT="#000000" -LINK="#0000FF" -VLINK="#840084" -ALINK="#0000FF" -><H1 -><A -NAME="AEN1" -></A -><SPAN -CLASS="APPLICATION" ->rndc</SPAN -></H1 -><DIV -CLASS="REFNAMEDIV" -><A -NAME="AEN9" -></A -><H2 ->Name</H2 -><SPAN -CLASS="APPLICATION" ->rndc</SPAN -> -- name server control utility</DIV -><DIV -CLASS="REFSYNOPSISDIV" -><A -NAME="AEN13" -></A -><H2 ->Synopsis</H2 -><P -><B -CLASS="COMMAND" ->rndc</B -> [<VAR -CLASS="OPTION" ->-c <VAR -CLASS="REPLACEABLE" ->config-file</VAR -></VAR ->] [<VAR -CLASS="OPTION" ->-k <VAR -CLASS="REPLACEABLE" ->key-file</VAR -></VAR ->] [<VAR -CLASS="OPTION" ->-s <VAR -CLASS="REPLACEABLE" ->server</VAR -></VAR ->] [<VAR -CLASS="OPTION" ->-p <VAR -CLASS="REPLACEABLE" ->port</VAR -></VAR ->] [<VAR -CLASS="OPTION" ->-V</VAR ->] [<VAR -CLASS="OPTION" ->-y <VAR -CLASS="REPLACEABLE" ->key_id</VAR -></VAR ->] {command}</P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN34" -></A -><H2 ->DESCRIPTION</H2 -><P -> <B -CLASS="COMMAND" ->rndc</B -> controls the operation of a name - server. It supersedes the <B -CLASS="COMMAND" ->ndc</B -> utility +<!-- $Id: rndc.html,v 1.7.2.1.4.10 2005/10/13 02:33:50 marka Exp $ --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>rndc</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> +<a name="id2463721"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2>Name</h2> +<p><span class="application">rndc</span> — name server control utility</p> +</div> +<div class="refsynopsisdiv"> +<h2>Synopsis</h2> +<div class="cmdsynopsis"><p><code class="command">rndc</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> +</div> +<div class="refsect1" lang="en"> +<a name="id2525886"></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 - <B -CLASS="COMMAND" ->rndc</B -> is invoked with no command line + <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. - </P -><P -> <B -CLASS="COMMAND" ->rndc</B -> communicates with the name server + </p> +<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 - <B -CLASS="COMMAND" ->rndc</B -> and <B -CLASS="COMMAND" ->named</B -> named + <span><strong class="command">rndc</strong></span> and <span><strong class="command">named</strong></span> named 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. - </P -><P -> <B -CLASS="COMMAND" ->rndc</B -> reads a configuration file to + </p> +<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. - </P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN46" -></A -><H2 ->OPTIONS</H2 -><P -></P -><DIV -CLASS="VARIABLELIST" -><DL -><DT ->-c <VAR -CLASS="REPLACEABLE" ->config-file</VAR -></DT -><DD -><P -> Use <VAR -CLASS="REPLACEABLE" ->config-file</VAR -> + </p> +</div> +<div class="refsect1" lang="en"> +<a name="id2525927"></a><h2>OPTIONS</h2> +<div class="variablelist"><dl> +<dt><span class="term">-c <em class="replaceable"><code>config-file</code></em></span></dt> +<dd><p> + Use <em class="replaceable"><code>config-file</code></em> as the configuration file instead of the default, - <TT -CLASS="FILENAME" ->/etc/rndc.conf</TT ->. - </P -></DD -><DT ->-k <VAR -CLASS="REPLACEABLE" ->key-file</VAR -></DT -><DD -><P -> Use <VAR -CLASS="REPLACEABLE" ->key-file</VAR -> + <code class="filename">/etc/rndc.conf</code>. + </p></dd> +<dt><span class="term">-k <em class="replaceable"><code>key-file</code></em></span></dt> +<dd><p> + Use <em class="replaceable"><code>key-file</code></em> as the key file instead of the default, - <TT -CLASS="FILENAME" ->/etc/rndc.key</TT ->. The key in - <TT -CLASS="FILENAME" ->/etc/rndc.key</TT -> will be used to authenticate - commands sent to the server if the <VAR -CLASS="REPLACEABLE" ->config-file</VAR -> + <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 -><DT ->-s <VAR -CLASS="REPLACEABLE" ->server</VAR -></DT -><DD -><P -> <VAR -CLASS="REPLACEABLE" ->server</VAR -> is + </p></dd> +<dt><span class="term">-s <em class="replaceable"><code>server</code></em></span></dt> +<dd><p> + <em class="replaceable"><code>server</code></em> is the name or address of the server which matches a server statement in the configuration file for - <B -CLASS="COMMAND" ->rndc</B ->. If no server is supplied on the + <span><strong class="command">rndc</strong></span>. If no server is supplied on the command line, the host named by the default-server clause in the option statement of the configuration file will be used. - </P -></DD -><DT ->-p <VAR -CLASS="REPLACEABLE" ->port</VAR -></DT -><DD -><P -> Send commands to TCP port - <VAR -CLASS="REPLACEABLE" ->port</VAR -> instead + </p></dd> +<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt> +<dd><p> + Send commands to TCP port + <em class="replaceable"><code>port</code></em> instead of BIND 9's default control channel port, 953. - </P -></DD -><DT ->-V</DT -><DD -><P -> Enable verbose logging. - </P -></DD -><DT ->-y <VAR -CLASS="REPLACEABLE" ->keyid</VAR -></DT -><DD -><P -> Use the key <VAR -CLASS="REPLACEABLE" ->keyid</VAR -> + </p></dd> +<dt><span class="term">-V</span></dt> +<dd><p> + Enable verbose logging. + </p></dd> +<dt><span class="term">-y <em class="replaceable"><code>keyid</code></em></span></dt> +<dd><p> + Use the key <em class="replaceable"><code>keyid</code></em> from the configuration file. - <VAR -CLASS="REPLACEABLE" ->keyid</VAR -> must be + <em class="replaceable"><code>keyid</code></em> must be known by named with the same algorithm and secret string in order for control message validation to succeed. - If no <VAR -CLASS="REPLACEABLE" ->keyid</VAR -> - is specified, <B -CLASS="COMMAND" ->rndc</B -> will first look + If no <em class="replaceable"><code>keyid</code></em> + 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. @@ -286,103 +114,43 @@ CLASS="COMMAND" which are used to send authenticated control commands to name servers. It should therefore not have general read or write access. - </P -></DD -></DL -></DIV -><P -> For the complete set of commands supported by <B -CLASS="COMMAND" ->rndc</B ->, + </p></dd> +</dl></div> +<p> + For the complete set of commands supported by <span><strong class="command">rndc</strong></span>, see the BIND 9 Administrator Reference Manual or run - <B -CLASS="COMMAND" ->rndc</B -> without arguments to see its help message. - </P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN94" -></A -><H2 ->LIMITATIONS</H2 -><P -> <B -CLASS="COMMAND" ->rndc</B -> does not yet support all the commands of - the BIND 8 <B -CLASS="COMMAND" ->ndc</B -> utility. - </P -><P -> There is currently no way to provide the shared secret for a - <VAR -CLASS="OPTION" ->key_id</VAR -> without using the configuration file. - </P -><P -> Several error messages could be clearer. - </P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN102" -></A -><H2 ->SEE ALSO</H2 -><P -> <SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->rndc.conf</SPAN ->(5)</SPAN ->, - <SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->named</SPAN ->(8)</SPAN ->, - <SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->named.conf</SPAN ->(5)</SPAN -> - <SPAN -CLASS="CITEREFENTRY" -><SPAN -CLASS="REFENTRYTITLE" ->ndc</SPAN ->(8)</SPAN ->, - <I -CLASS="CITETITLE" ->BIND 9 Administrator Reference Manual</I ->. - </P -></DIV -><DIV -CLASS="REFSECT1" -><A -NAME="AEN118" -></A -><H2 ->AUTHOR</H2 -><P -> Internet Systems Consortium - </P -></DIV -></BODY -></HTML -> + <span><strong class="command">rndc</strong></span> without arguments to see its help message. + </p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526109"></a><h2>LIMITATIONS</h2> +<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. + </p> +<p> + There is currently no way to provide the shared secret for a + <code class="option">key_id</code> without using the configuration file. + </p> +<p> + Several error messages could be clearer. + </p> +</div> +<div class="refsect1" lang="en"> +<a name="id2526138"></a><h2>SEE ALSO</h2> +<p> + <span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>, + <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>, + <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span> + <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"> +<a name="id2526190"></a><h2>AUTHOR</h2> +<p> + <span class="corpauthor">Internet Systems Consortium</span> + </p> +</div> +</div></body> +</html> |
