contrib/bind9/bin/rndc/rndc.8

   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 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.26.18.12 2007/01/30 00:23:44 marka Exp $
  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"
  33 rndc \- 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
  40 controls the operation of a name server. It supersedes the
  41 \fBndc\fR
  42 utility that was provided in old BIND releases. If
  43 \fBrndc\fR
  44 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.
  45 .PP
  46 \fBrndc\fR
  47 communicates with the name server over a TCP connection, sending commands authenticated with digital signatures. In the current versions of
  48 \fBrndc\fR
  49 and
  50 \fBnamed\fR
  51 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.
  52 .PP
  53 \fBrndc\fR
  54 reads a configuration file to determine how to contact the name server and decide what algorithm and key it should use.
  55 .SH "OPTIONS"
  56 .PP
  57 \-b \fIsource\-address\fR
  58 .RS 4
  59 Use
  60 \fIsource\-address\fR
  61 as the source address for the connection to the server. Multiple instances are permitted to allow setting of both the IPv4 and IPv6 source addresses.
  62 .RE
  63 .PP
  64 \-c \fIconfig\-file\fR
  65 .RS 4
  66 Use
  67 \fIconfig\-file\fR
  68 as the configuration file instead of the default,
  69 \fI/etc/rndc.conf\fR.
  70 .RE
  71 .PP
  72 \-k \fIkey\-file\fR
  73 .RS 4
  74 Use
  75 \fIkey\-file\fR
  76 as the key file instead of the default,
  77 \fI/etc/rndc.key\fR. The key in
  78 \fI/etc/rndc.key\fR
  79 will be used to authenticate commands sent to the server if the
  80 \fIconfig\-file\fR
  81 does not exist.
  82 .RE
  83 .PP
  84 \-s \fIserver\fR
  85 .RS 4
  86 \fIserver\fR
  87 is the name or address of the server which matches a server statement in the configuration file for
  88 \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.
  89 .RE
  90 .PP
  91 \-p \fIport\fR
  92 .RS 4
  93 Send commands to TCP port
  94 \fIport\fR
  95 instead of BIND 9's default control channel port, 953.
  96 .RE
  97 .PP
  98 \-V
  99 .RS 4
 100 Enable verbose logging.
 101 .RE
 102 .PP
 103 \-y \fIkeyid\fR
 104 .RS 4
 105 Use the key
 106 \fIkeyid\fR
 107 from the configuration file.
 108 \fIkeyid\fR
 109 must be known by named with the same algorithm and secret string in order for control message validation to succeed. If no
 110 \fIkeyid\fR
 111 is specified,
 112 \fBrndc\fR
 113 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.
 114 .RE
 115 .PP
 116 For the complete set of commands supported by
 117 \fBrndc\fR, see the BIND 9 Administrator Reference Manual or run
 118 \fBrndc\fR
 119 without arguments to see its help message.
 120 .SH "LIMITATIONS"
 121 .PP
 122 \fBrndc\fR
 123 does not yet support all the commands of the BIND 8
 124 \fBndc\fR
 125 utility.
 126 .PP
 127 There is currently no way to provide the shared secret for a
 128 \fBkey_id\fR
 129 without using the configuration file.
 130 .PP
 131 Several error messages could be clearer.
 132 .SH "SEE ALSO"
 133 .PP
 134 \fBrndc.conf\fR(5),
 135 \fBnamed\fR(8),
 136 \fBnamed.conf\fR(5)
 137 \fBndc\fR(8),
 138 BIND 9 Administrator Reference Manual.
 139 .SH "AUTHOR"
 140 .PP
 141 Internet Systems Consortium
 142 .SH "COPYRIGHT"
 143 Copyright \(co 2004, 2005, 2007 Internet Systems Consortium, Inc. ("ISC")
 144 .br
 145 Copyright \(co 2000, 2001 Internet Software Consortium.
 146 .br