contrib/bind-9.2.4rc7/bin/rndc/rndc.8

   1 .\" Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
   2 .\" Copyright (C) 2000, 2001  Internet Software Consortium.
   3 .\"
   4 .\" Permission to use, copy, modify, and 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: rndc.8,v 1.24.2.2 2004/06/03 05:21:15 marka Exp $
  17 .\"
  18 .TH "RNDC" "8" "June 30, 2000" "BIND9" ""
  19 .SH NAME
  20 rndc \- name server control utility
  21 .SH SYNOPSIS
  22 .sp
  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
  24 .SH "DESCRIPTION"
  25 .PP
  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
  32 arguments.
  33 .PP
  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 named
  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
  43 server.
  44 .PP
  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.
  48 .SH "OPTIONS"
  49 .TP
  50 \fB-c \fIconfig-file\fB\fR
  51 Use \fIconfig-file\fR
  52 as the configuration file instead of the default,
  53 \fI/etc/rndc.conf\fR.
  54 .TP
  55 \fB-k \fIkey-file\fB\fR
  56 Use \fIkey-file\fR
  57 as the key file instead of the default,
  58 \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
  61 does not exist.
  62 .TP
  63 \fB-s \fIserver\fB\fR
  64 \fIserver\fR is
  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
  70 used.
  71 .TP
  72 \fB-p \fIport\fB\fR
  73 Send commands to TCP port
  74 \fIport\fR instead
  75 of BIND 9's default control channel port, 953.
  76 .TP
  77 \fB-V\fR
  78 Enable verbose logging.
  79 .TP
  80 \fB-y \fIkeyid\fB\fR
  81 Use the key \fIkeyid\fR
  82 from the configuration file.
  83 \fIkeyid\fR must be
  84 known by named with the same algorithm and secret string
  85 in order for control message validation to succeed.
  86 If no \fIkeyid\fR
  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
  94 or write access.
  95 .PP
  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.
  99 .PP
 100 .SH "LIMITATIONS"
 101 .PP
 102 \fBrndc\fR does not yet support all the commands of
 103 the BIND 8 \fBndc\fR utility.
 104 .PP
 105 There is currently no way to provide the shared secret for a
 106 \fBkey_id\fR without using the configuration file.
 107 .PP
 108 Several error messages could be clearer.
 109 .SH "SEE ALSO"
 110 .PP
 111 \fBrndc.conf\fR(5),
 112 \fBnamed\fR(8),
 113 \fBnamed.conf\fR(5)
 114 \fBndc\fR(8),
 115 \fIBIND 9 Administrator Reference Manual\fR.
 116 .SH "AUTHOR"
 117 .PP
 118 Internet Systems Consortium