1
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN"
2
"http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd"
1
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3
3
[<!ENTITY mdash "—">]>
5
- Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
5
- Copyright (C) 2004, 2005, 2007 Internet Systems Consortium, Inc. ("ISC")
6
6
- Copyright (C) 2000, 2001 Internet Software Consortium.
8
- Permission to use, copy, modify, and distribute this software for any
8
- Permission to use, copy, modify, and/or distribute this software for any
9
9
- purpose with or without fee is hereby granted, provided that the above
10
10
- copyright notice and this permission notice appear in all copies.
66
67
<title>DESCRIPTION</title>
68
<command>rndc</command> controls the operation of a name
69
server. It supersedes the <command>ndc</command> utility
70
that was provided in old BIND releases. If
71
<command>rndc</command> is invoked with no command line
72
options or arguments, it prints a short summary of the
73
supported commands and the available options and their
77
<command>rndc</command> communicates with the name server
78
over a TCP connection, sending commands authenticated with
79
digital signatures. In the current versions of
80
<command>rndc</command> and <command>named</command> named
81
the only supported authentication algorithm is HMAC-MD5,
82
which uses a shared secret on each end of the connection.
83
This provides TSIG-style authentication for the command
84
request and the name server's response. All commands sent
85
over the channel must be signed by a key_id known to the
89
<command>rndc</command> reads a configuration file to
90
determine how to contact the name server and decide what
91
algorithm and key it should use.
68
<para><command>rndc</command>
69
controls the operation of a name
70
server. It supersedes the <command>ndc</command> utility
71
that was provided in old BIND releases. If
72
<command>rndc</command> is invoked with no command line
73
options or arguments, it prints a short summary of the
74
supported commands and the available options and their
77
<para><command>rndc</command>
78
communicates with the name server
79
over a TCP connection, sending commands authenticated with
80
digital signatures. In the current versions of
81
<command>rndc</command> and <command>named</command>,
82
the only supported authentication algorithm is HMAC-MD5,
83
which uses a shared secret on each end of the connection.
84
This provides TSIG-style authentication for the command
85
request and the name server's response. All commands sent
86
over the channel must be signed by a key_id known to the
89
<para><command>rndc</command>
90
reads a configuration file to
91
determine how to contact the name server and decide what
92
algorithm and key it should use.
101
<term>-b <replaceable class="parameter">source-address</replaceable></term>
104
Use <replaceable class="parameter">source-address</replaceable>
105
as the source address for the connection to the server.
106
Multiple instances are permitted to allow setting of both
107
the IPv4 and IPv6 source addresses.
100
113
<term>-c <replaceable class="parameter">config-file</replaceable></term>
103
Use <replaceable class="parameter">config-file</replaceable>
104
as the configuration file instead of the default,
105
<filename>/etc/rndc.conf</filename>.
116
Use <replaceable class="parameter">config-file</replaceable>
117
as the configuration file instead of the default,
118
<filename>/etc/rndc.conf</filename>.
111
124
<term>-k <replaceable class="parameter">key-file</replaceable></term>
114
Use <replaceable class="parameter">key-file</replaceable>
115
as the key file instead of the default,
116
<filename>/etc/rndc.key</filename>. The key in
117
<filename>/etc/rndc.key</filename> will be used to authenticate
118
commands sent to the server if the <replaceable class="parameter">config-file</replaceable>
127
Use <replaceable class="parameter">key-file</replaceable>
128
as the key file instead of the default,
129
<filename>/etc/rndc.key</filename>. The key in
130
<filename>/etc/rndc.key</filename> will be used to
132
commands sent to the server if the <replaceable class="parameter">config-file</replaceable>
125
139
<term>-s <replaceable class="parameter">server</replaceable></term>
128
<replaceable class="parameter">server</replaceable> is
129
the name or address of the server which matches a
130
server statement in the configuration file for
131
<command>rndc</command>. If no server is supplied on the
132
command line, the host named by the default-server clause
133
in the option statement of the configuration file will be
141
<para><replaceable class="parameter">server</replaceable> is
142
the name or address of the server which matches a
143
server statement in the configuration file for
144
<command>rndc</command>. If no server is supplied on the
145
command line, the host named by the default-server clause
146
in the options statement of the <command>rndc</command>
147
configuration file will be used.
140
153
<term>-p <replaceable class="parameter">port</replaceable></term>
143
Send commands to TCP port
144
<replaceable class="parameter">port</replaceable> instead
145
of BIND 9's default control channel port, 953.
156
Send commands to TCP port
157
<replaceable class="parameter">port</replaceable>
159
of BIND 9's default control channel port, 953.
154
Enable verbose logging.
168
Enable verbose logging.
160
<term>-y <replaceable class="parameter">keyid</replaceable></term>
163
Use the key <replaceable class="parameter">keyid</replaceable>
164
from the configuration file.
165
<replaceable class="parameter">keyid</replaceable> must be
166
known by named with the same algorithm and secret string
167
in order for control message validation to succeed.
168
If no <replaceable class="parameter">keyid</replaceable>
169
is specified, <command>rndc</command> will first look
170
for a key clause in the server statement of the server
171
being used, or if no server statement is present for that
172
host, then the default-key clause of the options statement.
173
Note that the configuration file contains shared secrets
174
which are used to send authenticated control commands
175
to name servers. It should therefore not have general read
174
<term>-y <replaceable class="parameter">key_id</replaceable></term>
177
Use the key <replaceable class="parameter">key_id</replaceable>
178
from the configuration file.
179
<replaceable class="parameter">key_id</replaceable>
181
known by named with the same algorithm and secret string
182
in order for control message validation to succeed.
183
If no <replaceable class="parameter">key_id</replaceable>
184
is specified, <command>rndc</command> will first look
185
for a key clause in the server statement of the server
186
being used, or if no server statement is present for that
187
host, then the default-key clause of the options statement.
188
Note that the configuration file contains shared secrets
189
which are used to send authenticated control commands
190
to name servers. It should therefore not have general read
184
199
For the complete set of commands supported by <command>rndc</command>,
185
200
see the BIND 9 Administrator Reference Manual or run
186
<command>rndc</command> without arguments to see its help message.
201
<command>rndc</command> without arguments to see its help
192
208
<title>LIMITATIONS</title>
194
<command>rndc</command> does not yet support all the commands of
195
the BIND 8 <command>ndc</command> utility.
198
There is currently no way to provide the shared secret for a
199
<option>key_id</option> without using the configuration file.
202
Several error messages could be clearer.
209
<para><command>rndc</command>
210
does not yet support all the commands of
211
the BIND 8 <command>ndc</command> utility.
214
There is currently no way to provide the shared secret for a
215
<option>key_id</option> without using the configuration file.
218
Several error messages could be clearer.
207
223
<title>SEE ALSO</title>
210
<refentrytitle>rndc.conf</refentrytitle>
211
<manvolnum>5</manvolnum>
214
<refentrytitle>named</refentrytitle>
215
<manvolnum>8</manvolnum>
218
<refentrytitle>named.conf</refentrytitle>
219
<manvolnum>5</manvolnum>
222
<refentrytitle>ndc</refentrytitle>
223
<manvolnum>8</manvolnum>
225
<refentrytitle>rndc.conf</refentrytitle><manvolnum>5</manvolnum>
228
<refentrytitle>rndc-confgen</refentrytitle><manvolnum>8</manvolnum>
231
<refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
234
<refentrytitle>named.conf</refentrytitle><manvolnum>5</manvolnum>
237
<refentrytitle>ndc</refentrytitle><manvolnum>8</manvolnum>
225
239
<citetitle>BIND 9 Administrator Reference Manual</citetitle>.
added
removed
bin/rndc/rndc.docbook
