1
.\" Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC")
2
.\" Copyright (C) 2000, 2001 Internet Software Consortium.
1
.\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
2
.\" Copyright (C) 2000, 2001 Internet Software Consortium.
4
4
.\" Permission to use, copy, modify, and distribute this software for any
5
5
.\" purpose with or without fee is hereby granted, provided that the above
6
6
.\" copyright notice and this permission notice appear in all copies.
8
8
.\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
9
9
.\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
10
.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
10
.\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
11
11
.\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
12
12
.\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
13
13
.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
14
14
.\" PERFORMANCE OF THIS SOFTWARE.
16
.\" $Id: rndc.8,v 1.24.206.2 2004/06/03 05:35:49 marka Exp $
16
.\" $Id: rndc.8,v 1.24.206.5 2005/10/13 02:33:49 marka Exp $
18
.TH "RNDC" "8" "June 30, 2000" "BIND9" ""
20
.\" ** You probably do not want to edit this file directly **
21
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
22
.\" Instead of manually editing it, you probably should edit the DocBook XML
23
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
24
.TH "RNDC" "8" "June 30, 2000" "BIND9" "BIND9"
25
.\" disable hyphenation
27
.\" disable justification (adjust text to left margin only)
20
30
rndc \- name server control utility
23
\fBrndc\fR [ \fB-c \fIconfig-file\fB\fR ] [ \fB-k \fIkey-file\fB\fR ] [ \fB-s \fIserver\fB\fR ] [ \fB-p \fIport\fB\fR ] [ \fB-V\fR ] [ \fB-y \fIkey_id\fB\fR ] \fBcommand\fR
33
\fBrndc\fR [\fB\-c\ \fR\fB\fIconfig\-file\fR\fR] [\fB\-k\ \fR\fB\fIkey\-file\fR\fR] [\fB\-s\ \fR\fB\fIserver\fR\fR] [\fB\-p\ \fR\fB\fIport\fR\fR] [\fB\-V\fR] [\fB\-y\ \fR\fB\fIkey_id\fR\fR] {command}
26
\fBrndc\fR controls the operation of a name
27
server. It supersedes the \fBndc\fR utility
28
that was provided in old BIND releases. If
29
\fBrndc\fR is invoked with no command line
30
options or arguments, it prints a short summary of the
31
supported commands and the available options and their
34
\fBrndc\fR communicates with the name server
35
over a TCP connection, sending commands authenticated with
36
digital signatures. In the current versions of
37
\fBrndc\fR and \fBnamed\fR,
38
the only supported authentication algorithm is HMAC-MD5,
39
which uses a shared secret on each end of the connection.
40
This provides TSIG-style authentication for the command
41
request and the name server's response. All commands sent
42
over the channel must be signed by a key_id known to the
45
\fBrndc\fR reads a configuration file to
46
determine how to contact the name server and decide what
47
algorithm and key it should use.
37
controls the operation of a name server. It supersedes the
39
utility that was provided in old BIND releases. If
41
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.
44
communicates with the name server over a TCP connection, sending commands authenticated with digital signatures. In the current versions of
48
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.
51
reads a configuration file to determine how to contact the name server and decide what algorithm and key it should use.
50
\fB-c \fIconfig-file\fB\fR
54
\-c \fIconfig\-file\fR
52
57
as the configuration file instead of the default,
53
58
\fI/etc/bind/rndc.conf\fR.
55
\fB-k \fIkey-file\fB\fR
57
63
as the key file instead of the default,
58
64
\fI/etc/rndc.key\fR. The key in
59
\fI/etc/rndc.key\fR will be used to authenticate
60
commands sent to the server if the \fIconfig-file\fR
66
will be used to authenticate commands sent to the server if the
65
the name or address of the server which matches a
66
server statement in the configuration file for
67
\fBrndc\fR. If no server is supplied on the
68
command line, the host named by the default-server clause
69
in the option statement of the configuration file will be
72
is the name or address of the server which matches a server statement in the configuration file for
73
\fBrndc\fR. 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.
73
76
Send commands to TCP port
75
of BIND 9's default control channel port, 953.
78
instead of BIND 9's default control channel port, 953.
78
81
Enable verbose logging.
81
Use the key \fIkeyid\fR
82
86
from the configuration file.
84
known by named with the same algorithm and secret string
85
in order for control message validation to succeed.
87
is specified, \fBrndc\fR will first look
88
for a key clause in the server statement of the server
89
being used, or if no server statement is present for that
90
host, then the default-key clause of the options statement.
91
Note that the configuration file contains shared secrets
92
which are used to send authenticated control commands
93
to name servers. It should therefore not have general read
96
For the complete set of commands supported by \fBrndc\fR,
97
see the BIND 9 Administrator Reference Manual or run
98
\fBrndc\fR without arguments to see its help message.
88
must be known by named with the same algorithm and secret string in order for control message validation to succeed. If no
92
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.
94
For the complete set of commands supported by
95
\fBrndc\fR, see the BIND 9 Administrator Reference Manual or run
97
without arguments to see its help message.
102
\fBrndc\fR does not yet support all the commands of
103
the BIND 8 \fBndc\fR utility.
101
does not yet support all the commands of the BIND 8
105
105
There is currently no way to provide the shared secret for a
106
\fBkey_id\fR without using the configuration file.
107
without using the configuration file.
108
109
Several error messages could be clearer.
111
112
\fBrndc.conf\fR(5),
115
\fIBIND 9 Administrator Reference Manual\fR.
114
\fBnamed.conf\fR(5)\fBndc\fR(8),
115
BIND 9 Administrator Reference Manual.
118
118
Internet Systems Consortium
added
removed
bin/rndc/rndc.8
