nsupdate.docbook revision 8f7de3db7ec299ddeded142905f5eb1f22076353
689023771c563d8660e45d439a207e06e96de28fMark Andrews<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3e240d6559605696cadf630668683708b18de871Tinderbox User "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein [<!ENTITY mdash "—">]>
689023771c563d8660e45d439a207e06e96de28fMark Andrews - Copyright (C) 2004-2009 Internet Systems Consortium, Inc. ("ISC")
689023771c563d8660e45d439a207e06e96de28fMark Andrews - Copyright (C) 2000-2003 Internet Software Consortium.
689023771c563d8660e45d439a207e06e96de28fMark Andrews - Permission to use, copy, modify, and/or distribute this software for any
689023771c563d8660e45d439a207e06e96de28fMark Andrews - purpose with or without fee is hereby granted, provided that the above
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - copyright notice and this permission notice appear in all copies.
689023771c563d8660e45d439a207e06e96de28fMark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
689023771c563d8660e45d439a207e06e96de28fMark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
689023771c563d8660e45d439a207e06e96de28fMark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
689023771c563d8660e45d439a207e06e96de28fMark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - PERFORMANCE OF THIS SOFTWARE.
e21a2904f02a03fa06b6db04d348f65fe9c67b2bMark Andrews<!-- $Id: nsupdate.docbook,v 1.41 2009/10/16 02:59:41 each Exp $ -->
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentryinfo>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </refentryinfo>
24abfe433efd98bb2099b867fb14d049b2f1f531Tinderbox User <refentrytitle><application>nsupdate</application></refentrytitle>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refnamediv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refname><application>nsupdate</application></refname>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refpurpose>Dynamic DNS update utility</refpurpose>
9a5087bf58f651bfff841192aba5afd06760d6ceTinderbox User </refnamediv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </copyright>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </copyright>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refsynopsisdiv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <cmdsynopsis>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-y <replaceable class="parameter"><optional>hmac:</optional>keyname:secret</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-k <replaceable class="parameter">keyfile</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-t <replaceable class="parameter">timeout</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-u <replaceable class="parameter">udptimeout</replaceable></option></arg>
9a5087bf58f651bfff841192aba5afd06760d6ceTinderbox User <arg><option>-r <replaceable class="parameter">udpretries</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-R <replaceable class="parameter">randomdev</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </cmdsynopsis>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </refsynopsisdiv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein is used to submit Dynamic DNS Update requests as defined in RFC 2136
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein to a name server.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein This allows resource records to be added or removed from a zone
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein without manually editing the zone file.
00124ad0406365d39f4b2d1011ef6a76706e9df0Mark Andrews A single update request can contain requests to add or remove more than
88a2182a1ad4fc7af07272af6b05b74db7f28e52Tinderbox User resource record.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Zones that are under dynamic control via
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein or a DHCP server should not be edited by hand.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Manual edits could
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein conflict with dynamic updates and cause data to be lost.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The resource records that are dynamically added or removed with
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein have to be in the same zone.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Requests are sent to the zone's master server.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein This is identified by the MNAME field of the zone's SOA record.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein operate in debug mode.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein This provides tracing information about the update requests that are
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein made and the replies received from the name server.
d060d8669f5558690e7faf4a1c12fe5c02a7c60dAutomatic Updater The <option>-D</option> option makes <command>nsupdate</command>
aa6c5a3e331958d3c92c2facdbd2b8daa55b5959Tinderbox User report additional debugging information to <option>-d</option>.
d060d8669f5558690e7faf4a1c12fe5c02a7c60dAutomatic Updater The <option>-L</option> option with an integer argument of zero or
d060d8669f5558690e7faf4a1c12fe5c02a7c60dAutomatic Updater higher sets the logging debug level. If zero, logging is disabled.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Transaction signatures can be used to authenticate the Dynamic
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein DNS updates. These use the TSIG resource record type described
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein in RFC 2845 or the SIG(0) record described in RFC 2535 and
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein RFC 2931 or GSS-TSIG as described in RFC 3645. TSIG relies on
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein a shared secret that should only be known to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <command>nsupdate</command> and the name server. Currently,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the only supported encryption algorithm for TSIG is HMAC-MD5,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein which is defined in RFC 2104. Once other algorithms are
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein defined for TSIG, applications will need to ensure they select
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the appropriate algorithm as well as the key when authenticating
9a5087bf58f651bfff841192aba5afd06760d6ceTinderbox User each other. For instance, suitable <type>key</type> and
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <type>server</type> statements would be added to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <filename>/etc/named.conf</filename> so that the name server
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein can associate the appropriate secret key and algorithm with
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the IP address of the client application that will be using
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein TSIG authentication. SIG(0) uses public key cryptography.
4f6469885c3d66367e3f8fb94e1f3c66115990b0Mark Andrews To use a SIG(0) key, the public key must be stored in a KEY
4f6469885c3d66367e3f8fb94e1f3c66115990b0Mark Andrews record in a zone served by the name server.
4f6469885c3d66367e3f8fb94e1f3c66115990b0Mark Andrews GSS-TSIG uses Kerberos credentials. Standard GSS-TSIG mode
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein is switched on with the <option>-g</option> flag. A
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein non-standards-compliant variant of GSS-TSIG used by Windows
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 2000 can be switched on with the <option>-o</option> flag.
9a5087bf58f651bfff841192aba5afd06760d6ceTinderbox User uses the <option>-y</option> or <option>-k</option> option
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein to provide the shared secret needed to generate a TSIG record
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein for authenticating Dynamic DNS update requests, default type
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein HMAC-MD5. These options are mutually exclusive.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein When the <option>-y</option> option is used, a signature is
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein generated from
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <optional><parameter>hmac:</parameter></optional><parameter>keyname:secret.</parameter>
fc74b733bf679e1b3fb1599e32d445dffe325208Tinderbox User <parameter>keyname</parameter> is the name of the key, and
fc74b733bf679e1b3fb1599e32d445dffe325208Tinderbox User <parameter>secret</parameter> is the base64 encoded shared secret.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Use of the <option>-y</option> option is discouraged because the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein shared secret is supplied as a command line argument in clear text.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein This may be visible in the output from
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <citerefentry>
9a5087bf58f651bfff841192aba5afd06760d6ceTinderbox User <refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </citerefentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein or in a history file maintained by the user's shell.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <option>-k</option> option, <command>nsupdate</command> reads
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the shared secret from the file <parameter>keyfile</parameter>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Keyfiles may be in two formats: a single file containing
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein a <filename>named.conf</filename>-format <command>key</command>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein statement, which may be generated automatically by
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <command>ddns-confgen</command>, or a pair of files whose names are
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein of the format <filename>K{name}.+157.+{random}.key</filename> and
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <filename>K{name}.+157.+{random}.private</filename>, which can be
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The <option>-k</option> may also be used to specify a SIG(0) key used
d9184858dd5d7677050a813d444c281c56f697aaTinderbox User to authenticate Dynamic DNS update requests. In this case, the key
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein specified is not an HMAC-MD5 key.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <command>nsupdate</command> can be run in a local-host only mode
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein using the <option>-l</option> flag. This sets the server address to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein localhost (disabling the <command>server</command> so that the server
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein address cannot be overridden). Connections to the local server will
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein use a TSIG key found in <filename>/var/run/named/ddns.key</filename>,
4a71c59d2bf32585c5dd18f4630d5f10e56a1ab3Automatic Updater which is automatically generated by <command>named</command> if any
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein local master zone has set <command>update-policy</command> to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <command>local</command>. The location of this key file can be
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein uses UDP to send update requests to the name server unless they are too
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein large to fit in a UDP request in which case TCP will be used.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein option makes
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein use a TCP connection.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein This may be preferable when a batch of update requests is made.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The <option>-p</option> sets the default port number to use for
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein connections to a name server. The default is 53.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The <option>-t</option> option sets the maximum time an update request
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein take before it is aborted. The default is 300 seconds. Zero can be
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein to disable the timeout.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The <option>-u</option> option sets the UDP retry interval. The default
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 3 seconds. If zero, the interval will be computed from the timeout
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein and number of UDP retries.
47012ae6dbf18a2503d7b33c1c9583dc38625cb7Mark Andrews The <option>-r</option> option sets the number of UDP retries. The
89bc48260b64a8859ae717e9e5bae380e275fef4Mark Andrews 3. If zero, only one update request will be made.
79cf9524b15ca65f55fd6913e6cf01b5581c588aAutomatic Updater class="parameter">randomdev</replaceable></option> option
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein specifies a source of randomness. If the operating system
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein does not provide a <filename>/dev/random</filename> or
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein equivalent device, the default source of randomness is keyboard
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein input. <filename>randomdev</filename> specifies the name of
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein a character device or file containing random data to be used
276e28f813ffef042d5a6e9f3373ef4e2ad37996Mark Andrews instead of the default. The special value
276e28f813ffef042d5a6e9f3373ef4e2ad37996Mark Andrews <filename>keyboard</filename> indicates that keyboard input
538a83db7509d598da95a93bd7b74ef3112123a4Mark Andrews should be used. This option may be specified multiple times.
3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews reads input from
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein or standard input.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Each command is supplied on exactly one line of input.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Some commands are for administrative purposes.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The others are either update instructions or prerequisite checks on the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein contents of the zone.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein These checks set conditions that some name or set of
3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews resource records (RRset) either exists or is absent from the zone.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein These conditions must be met if the entire update request is to succeed.
3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews Updates will be rejected if the tests for the prerequisite conditions
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Every update request consists of zero or more prerequisites
f051d76c87e055c6ea3879e0c97a76609df915ccMark Andrews and zero or more updates.
36da16fa31fa2a582afe67010ba449a57177fd2fAutomatic Updater This allows a suitably authenticated update request to proceed if some
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein specified resource records are present or missing from the zone.
3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews A blank input line (or the <command>send</command> command)
65ad89971ee9973074cd11c207af92bf5440df01Automatic Updater accumulated commands to be sent as one Dynamic DNS update request to the
aa6c5a3e331958d3c92c2facdbd2b8daa55b5959Tinderbox User The command formats and their meaning are as follows:
aa6c5a3e331958d3c92c2facdbd2b8daa55b5959Tinderbox User <variablelist>
65ad89971ee9973074cd11c207af92bf5440df01Automatic Updater <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Sends all dynamic update requests to the name server
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein When no server statement is provided,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein will send updates to the master server of the correct zone.
68b30890ebd441a6a1ae3fdf71744d07d02cd030Mark Andrews The MNAME field of that zone's SOA record will identify the
68b30890ebd441a6a1ae3fdf71744d07d02cd030Mark Andrews server for that zone.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein is the port number on
083a5588a3488b6335ee7bafa505d00644c7c58dMark Andrews where the dynamic update requests get sent.
089c63b69cdf6803aa8901aae3f2fbae58969511Automatic Updater If no port number is specified, the default DNS port number of
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
7526edc7677371c366232de5f39a678b7dcda747Mark Andrews <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Sends all dynamic update requests using the local
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein When no local statement is provided,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein will send updates using an address and port chosen by the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein can additionally be used to make requests come from a specific
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein If no port number is specified, the system will assign one.
aeb7938001b22e811a910e1b36cdf452f9193865Automatic Updater </varlistentry>
aeb7938001b22e811a910e1b36cdf452f9193865Automatic Updater <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specifies that all updates are to be made to the zone
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein statement is provided,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein will attempt determine the correct zone to update based on the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein rest of the input.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
b29285b88f95055e1f399247994067f85882041cTinderbox User <varlistentry>
aa6c5a3e331958d3c92c2facdbd2b8daa55b5959Tinderbox User Specify the default class.
aa6c5a3e331958d3c92c2facdbd2b8daa55b5959Tinderbox User If no <parameter>class</parameter> is specified, the
aa6c5a3e331958d3c92c2facdbd2b8daa55b5959Tinderbox User default class is
d060d8669f5558690e7faf4a1c12fe5c02a7c60dAutomatic Updater </varlistentry>
d060d8669f5558690e7faf4a1c12fe5c02a7c60dAutomatic Updater <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specify the default time to live for records to be added.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The value <parameter>none</parameter> will clear the default
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
9a5087bf58f651bfff841192aba5afd06760d6ceTinderbox User Specifies that all updates are to be TSIG-signed using the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <parameter>keyname</parameter> <parameter>keysecret</parameter> pair.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein overrides any key specified on the command line via
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Requires that no resource record of any type exists with name
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
689023771c563d8660e45d439a207e06e96de28fMark Andrews <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Requires that
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein exists (has as at least one resource record, of any type).
689023771c563d8660e45d439a207e06e96de28fMark Andrews </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Requires that no resource record exists of the specified
276e28f813ffef042d5a6e9f3373ef4e2ad37996Mark Andrews is omitted, IN (internet) is assumed.
538a83db7509d598da95a93bd7b74ef3112123a4Mark Andrews </varlistentry>
3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein This requires that a resource record of the specified
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein is omitted, IN (internet) is assumed.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
65ad89971ee9973074cd11c207af92bf5440df01Automatic Updater <varlistentry>
1586d8cbac5d73031716561386f60758c6c332d5Mark Andrews from each set of prerequisites of this form
1586d8cbac5d73031716561386f60758c6c332d5Mark Andrews sharing a common
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein are combined to form a set of RRs. This set of RRs must
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein exactly match the set of RRs existing in the zone at the
083a5588a3488b6335ee7bafa505d00644c7c58dMark Andrews are written in the standard text representation of the resource
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg choice="opt">type <arg choice="opt" rep="repeat">data</arg></arg>
689023771c563d8660e45d439a207e06e96de28fMark Andrews Deletes any resource records named
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein is provided, only matching resource records will be removed.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The internet class is assumed if
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein is not supplied. The
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein is ignored, and is only allowed for compatibility.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Adds a new resource record with the specified
aa6c5a3e331958d3c92c2facdbd2b8daa55b5959Tinderbox User </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Displays the current message, containing all of the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein prerequisites and
9a5087bf58f651bfff841192aba5afd06760d6ceTinderbox User updates specified since the last send.
8a8d38eb8e5f853835df2f6799ce0d3d7ecf8be6Automatic Updater </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
689023771c563d8660e45d439a207e06e96de28fMark Andrews Sends the current message. This is equivalent to entering a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews <varlistentry>
3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews Displays the answer.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
aa6c5a3e331958d3c92c2facdbd2b8daa55b5959Tinderbox User Turn on debugging.
d060d8669f5558690e7faf4a1c12fe5c02a7c60dAutomatic Updater </varlistentry>
083a5588a3488b6335ee7bafa505d00644c7c58dMark Andrews </variablelist>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Lines beginning with a semicolon are comments and are ignored.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The examples below show how
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein could be used to insert and delete resource records from the
689023771c563d8660e45d439a207e06e96de28fMark Andrews Notice that the input in each example contains a trailing blank line so
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein a group of commands are sent as one dynamic update request to the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein master name server for
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <programlisting>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein> update delete oldhost.example.com A
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein> update add newhost.example.com 86400 A 172.16.1.1
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</programlisting>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Any A records for
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein are deleted.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein And an A record for
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein with IP address 172.16.1.1 is added.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The newly-added record has a 1 day TTL (86400 seconds).
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <programlisting>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein> prereq nxdomain nickname.example.com
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein> update add nickname.example.com 86400 CNAME somehost.example.com
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</programlisting>
731cc132f22dbc9e0ecd7035dce314a61076d31bAutomatic Updater The prerequisite condition gets the name server to check that there
731cc132f22dbc9e0ecd7035dce314a61076d31bAutomatic Updater are no resource records of any type for
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein If there are, the update request fails.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein If this name does not exist, a CNAME for it is added.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein This ensures that when the CNAME is added, it cannot conflict with the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein long-standing rule in RFC 1034 that a name must not exist as any other
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein record type if it exists as a CNAME.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein (The rule has been updated for DNSSEC in RFC 2535 to allow CNAMEs to have
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein RRSIG, DNSKEY and NSEC records.)
9a5087bf58f651bfff841192aba5afd06760d6ceTinderbox User <variablelist>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
1224c3b69b3d18f7127aa042644936af25a2d679Mark Andrews <term><constant>/etc/resolv.conf</constant></term>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein used to identify default name server
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>