rndc.docbook revision 8009525601d946805fae58b037cf7dad0da516f8
d6fa26d0adaec6c910115be34fe7a5a5f402c14fMark Andrews<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User [<!ENTITY mdash "—">]>
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User - Copyright (C) 2004, 2005, 2007, 2013 Internet Systems Consortium, Inc. ("ISC")
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User - Copyright (C) 2000, 2001 Internet Software Consortium.
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User - Permission to use, copy, modify, and/or distribute this software for any
d6fa26d0adaec6c910115be34fe7a5a5f402c14fMark Andrews - purpose with or without fee is hereby granted, provided that the above
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User - copyright notice and this permission notice appear in all copies.
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User - PERFORMANCE OF THIS SOFTWARE.
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User<!-- $Id: rndc.docbook,v 1.21 2007/12/14 20:39:14 marka Exp $ -->
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User <refentryinfo>
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User </refentryinfo>
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User <refentrytitle><application>rndc</application></refentrytitle>
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User <refname><application>rndc</application></refname>
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User <refpurpose>name server control utility</refpurpose>
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User </refnamediv>
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User <holder>Internet Software Consortium.</holder>
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User <refsynopsisdiv>
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User <cmdsynopsis>
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User <arg><option>-b <replaceable class="parameter">source-address</replaceable></option></arg>
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User <arg><option>-c <replaceable class="parameter">config-file</replaceable></option></arg>
281ed127e3ed6c7e07792c19c3bc4562f71cfa90Tinderbox User <arg><option>-k <replaceable class="parameter">key-file</replaceable></option></arg>
281ed127e3ed6c7e07792c19c3bc4562f71cfa90Tinderbox User <arg><option>-s <replaceable class="parameter">server</replaceable></option></arg>
281ed127e3ed6c7e07792c19c3bc4562f71cfa90Tinderbox User <arg><option>-p <replaceable class="parameter">port</replaceable></option></arg>
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User <arg><option>-y <replaceable class="parameter">key_id</replaceable></option></arg>
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User </cmdsynopsis>
7e71f05d8643aca84914437c900cb716444507e4Tinderbox User </refsynopsisdiv>
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User controls the operation of a name
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User server. It supersedes the <command>ndc</command> utility
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User that was provided in old BIND releases. If
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User <command>rndc</command> is invoked with no command line
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User options or arguments, it prints a short summary of the
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User supported commands and the available options and their
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User communicates with the name server over a TCP connection, sending
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User commands authenticated with digital signatures. In the current
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User <command>rndc</command> and <command>named</command>,
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User the only supported authentication algorithms are HMAC-MD5
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User (for compatibility), HMAC-SHA1, HMAC-SHA224, HMAC-SHA256
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User (default), HMAC-SHA384 and HMAC-SHA512.
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User They use a shared secret on each end of the connection.
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User This provides TSIG-style authentication for the command
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User request and the name server's response. All commands sent
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User over the channel must be signed by a key_id known to the
<term><userinput>reload <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></userinput></term>
<term><userinput>refresh <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></userinput></term>
<term><userinput>retransfer <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></userinput></term>
<term><userinput>sign <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></userinput></term>
<term><userinput>loadkeys <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></userinput></term>
<term><userinput>freeze <optional><replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></optional></userinput></term>
<term><userinput>thaw <optional><replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></optional></userinput></term>
<term><userinput>sync <optional>-clean</optional> <optional><replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></optional></userinput></term>
<term><userinput>notify <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></userinput></term>
<term><userinput>zonestatus <optional><replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional></optional></userinput></term>
<term><userinput>dumpdb <optional>-all|-cache|-zone</optional> <optional><replaceable>view ...</replaceable></optional></userinput></term>
<term><userinput>secroots <optional><replaceable>view ...</replaceable></optional></userinput></term>
<term><userinput>flushname</userinput> <replaceable>name</replaceable> <optional><replaceable>view</replaceable></optional> </term>
<term><userinput>flushtree</userinput> <optional>-all</optional> <replaceable>name</replaceable> <optional><replaceable>view</replaceable></optional> </term>
<term><userinput>validation ( on | off | check ) <optional><replaceable>view ...</replaceable></optional> </userinput></term>
<term><userinput>tsig-delete</userinput> <replaceable>keyname</replaceable> <optional><replaceable>view</replaceable></optional></term>
<term><userinput>addzone <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional> <replaceable>configuration</replaceable> </userinput></term>
<prompt>$ </prompt><userinput>rndc addzone example.com '{ type master; file "example.com.db"; };'</userinput>
<term><userinput>delzone <optional>-clean</optional> <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional> </userinput></term>
<term><userinput>signing <optional>( -list | -clear <replaceable>keyid/algorithm</replaceable> | -clear <literal>all</literal> | -nsec3param ( <replaceable>parameters</replaceable> | <literal>none</literal> ) ) </optional> <replaceable>zone</replaceable> <optional><replaceable>class</replaceable> <optional><replaceable>view</replaceable></optional></optional> </userinput></term>