From 36a379484c755eccc145a03ee2babe4e19c97da6 Mon Sep 17 00:00:00 2001 From: Jakob Schlyter Date: Wed, 19 Dec 2007 09:47:04 +0000 Subject: ref rndc-confgen(8); from Jean Raby --- usr.sbin/bind/bin/rndc/rndc.docbook | 263 ++++++++++++++++++++---------------- 1 file changed, 144 insertions(+), 119 deletions(-) diff --git a/usr.sbin/bind/bin/rndc/rndc.docbook b/usr.sbin/bind/bin/rndc/rndc.docbook index 386415a57c5..1a055c119bb 100644 --- a/usr.sbin/bind/bin/rndc/rndc.docbook +++ b/usr.sbin/bind/bin/rndc/rndc.docbook @@ -1,24 +1,25 @@ - +]> - - - + + June 30, 2000 @@ -34,9 +35,24 @@ name server control utility + + + 2004 + 2005 + 2007 + Internet Systems Consortium, Inc. ("ISC") + + + 2000 + 2001 + Internet Software Consortium. + + + rndc + @@ -49,31 +65,31 @@ DESCRIPTION - - rndc controls the operation of a name - server. It supersedes the ndc utility - that was provided in old BIND releases. If - rndc 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. + rndc + controls the operation of a name + server. It supersedes the ndc utility + that was provided in old BIND releases. If + rndc 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. - - rndc communicates with the name server - over a TCP connection, sending commands authenticated with - digital signatures. In the current versions of - rndc and named 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. + rndc + communicates with the name server + over a TCP connection, sending commands authenticated with + digital signatures. In the current versions of + rndc and 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. - - rndc reads a configuration file to - determine how to contact the name server and decide what - algorithm and key it should use. + rndc + reads a configuration file to + determine how to contact the name server and decide what + algorithm and key it should use. @@ -81,86 +97,100 @@ OPTIONS + + -b source-address + + + Use source-address + 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. + + + + -c config-file - - - Use config-file - as the configuration file instead of the default, - /etc/rndc.conf. - - + + + Use config-file + as the configuration file instead of the default, + /etc/rndc.conf. + + -k key-file - - - Use key-file - as the key file instead of the default, - /etc/rndc.key. The key in - /etc/rndc.key will be used to authenticate - commands sent to the server if the config-file - does not exist. - - + + + Use key-file + as the key file instead of the default, + /etc/rndc.key. The key in + /etc/rndc.key will be used to + authenticate + commands sent to the server if the config-file + does not exist. + + -s server - - - server is - the name or address of the server which matches a - server statement in the configuration file for - rndc. 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. - - + + server is + the name or address of the server which matches a + server statement in the configuration file for + rndc. If no server is supplied on the + command line, the host named by the default-server clause + in the options statement of the rndc + configuration file will be used. + + -p port - - - Send commands to TCP port - port instead - of BIND 9's default control channel port, 953. - - + + + Send commands to TCP port + port + instead + of BIND 9's default control channel port, 953. + + -V - - - Enable verbose logging. - - + + + Enable verbose logging. + + - -y keyid - - - Use the key keyid - from the configuration file. - keyid must be - known by named with the same algorithm and secret string - in order for control message validation to succeed. - If no keyid - is specified, rndc 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. - - + -y key_id + + + Use the key key_id + from the configuration file. + key_id + must be + known by named with the same algorithm and secret string + in order for control message validation to succeed. + If no key_id + is specified, rndc 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. + + @@ -168,44 +198,43 @@ For the complete set of commands supported by rndc, see the BIND 9 Administrator Reference Manual or run - rndc without arguments to see its help message. + rndc without arguments to see its help + message. LIMITATIONS - - rndc does not yet support all the commands of - the BIND 8 ndc utility. + rndc + does not yet support all the commands of + the BIND 8 ndc utility. - There is currently no way to provide the shared secret for a - without using the configuration file. + There is currently no way to provide the shared secret for a + without using the configuration file. - Several error messages could be clearer. + Several error messages could be clearer. SEE ALSO - + + rndc.conf5 + , - rndc.conf - 5 + rndc-confgen8 , - named - 8 + named8 , - named.conf - 5 - + named.conf5 + , - ndc - 8 + ndc8 , BIND 9 Administrator Reference Manual. @@ -213,16 +242,12 @@ AUTHOR - - Internet Software Consortium + Internet Systems Consortium - - - - -- cgit v1.2.3