PageRenderTime 20ms CodeModel.GetById 14ms app.highlight 2ms RepoModel.GetById 1ms app.codeStats 0ms

/contrib/bind9/bin/rndc/rndc.8

https://bitbucket.org/freebsd/freebsd-head/
Unknown | 148 lines | 148 code | 0 blank | 0 comment | 0 complexity | f7006f9958f8e018599ed76527f7d79e MD5 | raw file
  1.\" Copyright (C) 2004, 2005, 2007 Internet Systems Consortium, Inc. ("ISC")
  2.\" Copyright (C) 2000, 2001 Internet Software Consortium.
  3.\" 
  4.\" Permission to use, copy, modify, and/or distribute this software for any
  5.\" purpose with or without fee is hereby granted, provided that the above
  6.\" copyright notice and this permission notice appear in all copies.
  7.\" 
  8.\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  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,
 11.\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 12.\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 13.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 14.\" PERFORMANCE OF THIS SOFTWARE.
 15.\"
 16.\" $Id$
 17.\"
 18.hy 0
 19.ad l
 20.\"     Title: rndc
 21.\"    Author: 
 22.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
 23.\"      Date: June 30, 2000
 24.\"    Manual: BIND9
 25.\"    Source: BIND9
 26.\"
 27.TH "RNDC" "8" "June 30, 2000" "BIND9" "BIND9"
 28.\" disable hyphenation
 29.nh
 30.\" disable justification (adjust text to left margin only)
 31.ad l
 32.SH "NAME"
 33rndc \- name server control utility
 34.SH "SYNOPSIS"
 35.HP 5
 36\fBrndc\fR [\fB\-b\ \fR\fB\fIsource\-address\fR\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}
 37.SH "DESCRIPTION"
 38.PP
 39\fBrndc\fR
 40controls the operation of a name server. It supersedes the
 41\fBndc\fR
 42utility that was provided in old BIND releases. If
 43\fBrndc\fR
 44is invoked with no command line options or arguments, it prints a short summary of the supported commands and the available options and their arguments.
 45.PP
 46\fBrndc\fR
 47communicates with the name server over a TCP connection, sending commands authenticated with digital signatures. In the current versions of
 48\fBrndc\fR
 49and
 50\fBnamed\fR, 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.PP
 52\fBrndc\fR
 53reads a configuration file to determine how to contact the name server and decide what algorithm and key it should use.
 54.SH "OPTIONS"
 55.PP
 56\-b \fIsource\-address\fR
 57.RS 4
 58Use
 59\fIsource\-address\fR
 60as the source address for the connection to the server. Multiple instances are permitted to allow setting of both the IPv4 and IPv6 source addresses.
 61.RE
 62.PP
 63\-c \fIconfig\-file\fR
 64.RS 4
 65Use
 66\fIconfig\-file\fR
 67as the configuration file instead of the default,
 68\fI/etc/rndc.conf\fR.
 69.RE
 70.PP
 71\-k \fIkey\-file\fR
 72.RS 4
 73Use
 74\fIkey\-file\fR
 75as the key file instead of the default,
 76\fI/etc/rndc.key\fR. The key in
 77\fI/etc/rndc.key\fR
 78will be used to authenticate commands sent to the server if the
 79\fIconfig\-file\fR
 80does not exist.
 81.RE
 82.PP
 83\-s \fIserver\fR
 84.RS 4
 85\fIserver\fR
 86is the name or address of the server which matches a server statement in the configuration file for
 87\fBrndc\fR. If no server is supplied on the command line, the host named by the default\-server clause in the options statement of the
 88\fBrndc\fR
 89configuration file will be used.
 90.RE
 91.PP
 92\-p \fIport\fR
 93.RS 4
 94Send commands to TCP port
 95\fIport\fR
 96instead of BIND 9's default control channel port, 953.
 97.RE
 98.PP
 99\-V
100.RS 4
101Enable verbose logging.
102.RE
103.PP
104\-y \fIkey_id\fR
105.RS 4
106Use the key
107\fIkey_id\fR
108from the configuration file.
109\fIkey_id\fR
110must be known by named with the same algorithm and secret string in order for control message validation to succeed. If no
111\fIkey_id\fR
112is specified,
113\fBrndc\fR
114will 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.
115.RE
116.PP
117For the complete set of commands supported by
118\fBrndc\fR, see the BIND 9 Administrator Reference Manual or run
119\fBrndc\fR
120without arguments to see its help message.
121.SH "LIMITATIONS"
122.PP
123\fBrndc\fR
124does not yet support all the commands of the BIND 8
125\fBndc\fR
126utility.
127.PP
128There is currently no way to provide the shared secret for a
129\fBkey_id\fR
130without using the configuration file.
131.PP
132Several error messages could be clearer.
133.SH "SEE ALSO"
134.PP
135\fBrndc.conf\fR(5),
136\fBrndc\-confgen\fR(8),
137\fBnamed\fR(8),
138\fBnamed.conf\fR(5),
139\fBndc\fR(8),
140BIND 9 Administrator Reference Manual.
141.SH "AUTHOR"
142.PP
143Internet Systems Consortium
144.SH "COPYRIGHT"
145Copyright \(co 2004, 2005, 2007 Internet Systems Consortium, Inc. ("ISC")
146.br
147Copyright \(co 2000, 2001 Internet Software Consortium.
148.br