rndc.docbook revision b435b1ded3def3159f597953d21dffc1615cb250
ac4e70ff8955669341f435bc0a734a17c01af124Mark Andrews<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
1167fc7904c5f0a472f8df207ac46dd52c7f1ec8Automatic Updater <refentryinfo>
46da3117812814a29432a8d9a9ccf8acdbfdadceAutomatic Updater </refentryinfo>
2ec4ab21838e218863d052ebfa3e106e04f50820Evan Hunt <refentrytitle><application>rndc</application></refentrytitle>
ac4e70ff8955669341f435bc0a734a17c01af124Mark Andrews <refname><application>rndc</application></refname>
6c6a121295b30772cbf3dd75a51fb9d883051a0eAutomatic Updater <refpurpose>name server control utility</refpurpose>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </refnamediv>
bc0a53583d92309bebcf93c408e2f3247ebd3d3cAutomatic Updater <refsynopsisdiv>
96713299d08c0735c18ebe8772dd2cc1ecd4356aAutomatic Updater <arg><option>-c <replaceable class="parameter">config-file</replaceable></option></arg>
3cc98b8ecedcbc8465f1cf2740b966b315662430Automatic Updater <arg><option>-s <replaceable class="parameter">server</replaceable></option></arg>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <arg><option>-p <replaceable class="parameter">port</replaceable></option></arg>
96713299d08c0735c18ebe8772dd2cc1ecd4356aAutomatic Updater <arg><option>-y <replaceable class="parameter">key_id</replaceable></option></arg>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews </cmdsynopsis>
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater </refsynopsisdiv>
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater <command>rndc</command> controls the operation of a name
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson server. It supersedes the <command>ndc</command> utility
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater that was provided in old BIND releases. If
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <command>rndc</command> is invoked with no command line
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater options or arguments, it prints a short summary of the
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt supported commands and the available options and their
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <command>rndc</command> communicates with the name server
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater over a TCP connection, sending commands authenticated with
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater digital signatures. In the current versions of
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt <command>rndc</command> and <command>named</command> named
2d2dc37599979c83495510f8af8d1756753aa2c5Automatic Updater the only supported authentication algorithm is HMAC-MD5,
2d2dc37599979c83495510f8af8d1756753aa2c5Automatic Updater which uses a shared secret on each end of the connection.
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt This provides TSIG-style authentication for the command
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater request and the name server's response. All commands sent
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater over the channel must be signed by a key_id known to the
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater <command>rndc</command> reads a configuration file to
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater determine how to contact the name server and decide what
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater algorithm and key it should use.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <variablelist>
9cd5eb6fe0f26d65724b99216cb31dcdd12e4afdAutomatic Updater <varlistentry>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <term>-c <replaceable class="parameter">config-file</replaceable></term>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews Use <replaceable class="parameter">config-file</replaceable>
59528addd704f8d5757b54e540520f74e588a7c7Automatic Updater as the configuration file instead of the default,
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews </varlistentry>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <varlistentry>
db5b7e2cdf150c46e8242d3e2e3ad3f5c7300258Automatic Updater <term>-s <replaceable class="parameter">server</replaceable></term>
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater <replaceable class="parameter">server</replaceable> is
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson the name or address of the server which matches a
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater server statement in the configuration file for
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater <command>rndc</command>. If no server is supplied on the
efb0e886f18894a1d2489f1ad74ad14b579e11c7Mark Andrews command line, the host named by the default-server clause
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater in the option statement of the configuration file will be
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson </varlistentry>
dd65eb1efb40b1c47d57963192bfc54873b219beAutomatic Updater <varlistentry>
dd65eb1efb40b1c47d57963192bfc54873b219beAutomatic Updater <term>-p <replaceable class="parameter">port</replaceable></term>
9174e44c14b1cb91a651fa1dc29470438c246ab9Automatic Updater Send commands to TCP port
9174e44c14b1cb91a651fa1dc29470438c246ab9Automatic Updater <replaceable class="parameter">port</replaceable> instead
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont of BIND 9's default control channel port, 953.
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont </varlistentry>
f9119ad8f6114b2255e7545bf5cd187f4db0a89bAutomatic Updater <varlistentry>
dd65eb1efb40b1c47d57963192bfc54873b219beAutomatic Updater Enable verbose logging.
995eaa289ba9709c64ef89b3776e53c36adc0010Automatic Updater </varlistentry>
418cc932318b1d67f88a36904d88d8a5a0a2ba09Automatic Updater <varlistentry>
995eaa289ba9709c64ef89b3776e53c36adc0010Automatic Updater <term>-y <replaceable class="parameter">keyid</replaceable></term>
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater Use the key <replaceable class="parameter">keyid</replaceable>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews from the configuration file.
0c39b3ed9409ecb277d5e32fa763a4e4d6598df8Automatic Updater <replaceable class="parameter">keyid</replaceable> must be
0c39b3ed9409ecb277d5e32fa763a4e4d6598df8Automatic Updater known by named with the same algorithm and secret string
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater in order for control message validation to succeed.
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater If no <replaceable class="parameter">keyid</replaceable>
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater is specified, <command>rndc</command> will first look
fe80a4909bf62b602feaf246866e9d29f7654194Automatic Updater for a key clause in the server statement of the server
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater being used, or if no server statement is present for that
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater host, then the default-key clause of the options statement.
fe80a4909bf62b602feaf246866e9d29f7654194Automatic Updater Note that the configuration file contains shared secrets
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater which are used to send authenticated control commands
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater to name servers. It should therefore not have general read
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson or write access.
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson </varlistentry>
dd65eb1efb40b1c47d57963192bfc54873b219beAutomatic Updater </variablelist>
133e6d43fa82e80d3798be4de00f4540f485ec6cAutomatic Updater For the complete set of commands supported by <command>rndc</command>,
133e6d43fa82e80d3798be4de00f4540f485ec6cAutomatic Updater see the BIND 9 Administrator Reference Manual or run
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater <command>rndc</command> without arguments to see its help message.
0df8ead472f207020f8da22a185fe4b945248ab8Automatic Updater <command>rndc</command> does not yet support all the commands of
2bb3422dc683c013db7042f5736240de6b86f182Automatic Updater the BIND 8 <command>ndc</command> utility.
3b6e4c84a525b0b3fc9e8affd8bb9fa5c000345fAutomatic Updater There is currently no way to provide the shared secret for a
19b3dc94bce93fa76bd7e066f9298630dbc9dcb4Automatic Updater <option>key_id</option> without using the configuration file.
59528addd704f8d5757b54e540520f74e588a7c7Automatic Updater Several error messages could be clearer.
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <citerefentry>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater </citerefentry>,
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <citerefentry>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater </citerefentry>,
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <citerefentry>
19b3dc94bce93fa76bd7e066f9298630dbc9dcb4Automatic Updater </citerefentry>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <citerefentry>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater </citerefentry>,
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
96ea71632887c58a9d00f47eb318bf76b35903c3Mark Andrews <corpauthor>Internet Software Consortium</corpauthor>
9cd5eb6fe0f26d65724b99216cb31dcdd12e4afdAutomatic Updater - Local variables: