nsupdate.docbook revision 9a63fb8455efa3c7decd1d78db58fbd46c0f7b7b
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
75c0816e8295e180f4bc7f10db3d0d880383bc1cMark Andrews [<!ENTITY mdash "—">]>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - Copyright (C) 2004-2011 Internet Systems Consortium, Inc. ("ISC")
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - Copyright (C) 2000-2003 Internet Software Consortium.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - Permission to use, copy, modify, and/or distribute this software for any
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - purpose with or without fee is hereby granted, provided that the above
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - copyright notice and this permission notice appear in all copies.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - PERFORMANCE OF THIS SOFTWARE.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<!-- $Id: nsupdate.docbook,v 1.46 2011/12/16 23:46:20 tbox Exp $ -->
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentryinfo>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </refentryinfo>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentrytitle><application>nsupdate</application></refentrytitle>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refnamediv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refname><application>nsupdate</application></refname>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refpurpose>Dynamic DNS update utility</refpurpose>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </refnamediv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </copyright>
3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews </copyright>
3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews <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>
3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews <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>
727f5b8846457a33d06f515a10a7e1aa849ddf18Andreas Gustafsson is used to submit Dynamic DNS Update requests as defined in RFC 2136
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce to a name server.
8e245ec21beee31a780de9b89ba1e8bb2b9f4c9aAndreas Gustafsson This allows resource records to be added or removed from a zone
727f5b8846457a33d06f515a10a7e1aa849ddf18Andreas Gustafsson without manually editing the zone file.
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce A single update request can contain requests to add or remove more than
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce resource record.
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce 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.
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce operate in debug mode.
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce This provides tracing information about the update requests that are
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce made and the replies received from the name server.
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce The <option>-D</option> option makes <command>nsupdate</command>
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce report additional debugging information to <option>-d</option>.
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce The <option>-L</option> option with an integer argument of zero or
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce higher sets the logging debug level. If zero, logging is disabled.
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce Transaction signatures can be used to authenticate the Dynamic
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce DNS updates. These use the TSIG resource record type described
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce in RFC 2845 or the SIG(0) record described in RFC 2535 and
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce RFC 2931 or GSS-TSIG as described in RFC 3645. TSIG relies on
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce a shared secret that should only be known to
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce <command>nsupdate</command> and the name server. Currently,
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce the only supported encryption algorithm for TSIG is HMAC-MD5,
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce which is defined in RFC 2104. Once other algorithms are
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce defined for TSIG, applications will need to ensure they select
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce the appropriate algorithm as well as the key when authenticating
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce each other. For instance, suitable <type>key</type> and
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.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein To use a SIG(0) key, the public key must be stored in a KEY
3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews record in a zone served by the name server.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <parameter>keyname</parameter> is the name of the key, and
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <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>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <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
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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/session.key</filename>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The <option>-r</option> option sets the number of UDP retries. The
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 3. If zero, only one update request will be made.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein instead of the default. The special value
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <filename>keyboard</filename> indicates that keyboard input
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein should be used. This option may be specified multiple times.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Other types can be entered using "TYPEXXXXX" where "XXXXX" is the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein decimal value of the type with no leading zeros. The rdata,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if present, will be parsed using the UNKNOWN rdata format,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein (<backslash> <hash> <space> <length>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <space> <hexstring>).
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The <option>-T</option> and <option>-P</option> options print out
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein lists of non-meta types for which the type-specific presentation
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein formats are known. <option>-T</option> prints out the list of
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein IANA-assigned types. <option>-P</option> prints out the list of
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein private types specific to <command>named</command>. These options
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein may be combined. <command>nsupdate</command> will exit after the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein lists are printed.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Updates will be rejected if the tests for the prerequisite conditions
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Every update request consists of zero or more prerequisites
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein and zero or more updates.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein This allows a suitably authenticated update request to proceed if some
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein specified resource records are present or missing from the zone.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein A blank input line (or the <command>send</command> command)
3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews accumulated commands to be sent as one Dynamic DNS update request to the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein name server.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The command formats and their meaning are as follows:
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <variablelist>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <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.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The MNAME field of that zone's SOA record will identify the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein server for that zone.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein is the port number on
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein where the dynamic update requests get sent.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein If no port number is specified, the default DNS port number of
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <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.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <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>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specify the default class.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein If no <parameter>class</parameter> is specified, the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein default class is
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <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>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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 Use GSS-TSIG to sign the updated. This is equivalent to
7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews specifying <option>-g</option> on the commandline.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </varlistentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Use the Windows 2000 version of GSS-TSIG to sign the updated.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein This is equivalent to specifying <option>-o</option> on the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein commandline.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg choice="req"><optional>realm_name</optional></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein When using GSS-TSIG use <parameter>realm_name</parameter> rather
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein than the default realm in <filename>krb5.conf</filename>. If no
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein realm is specified the saved realm is cleared.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <command><optional>prereq</optional> nxdomain</command>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Requires that no resource record of any type exists with name
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <command><optional>prereq</optional> yxdomain</command>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Requires that
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein exists (has as at least one resource record, of any type).
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <command><optional>prereq</optional> nxrrset</command>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Requires that no resource record exists of the specified
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein is omitted, IN (internet) is assumed.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <command><optional>prereq</optional> yxrrset</command>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein This requires that a resource record of the specified
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein is omitted, IN (internet) is assumed.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <varlistentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <command><optional>prereq</optional> yxrrset</command>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein from each set of prerequisites of this form
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein are written in the standard text representation of the resource
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </varlistentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <command><optional>update</optional> del<optional>ete</optional></command>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg choice="opt">type <arg choice="opt" rep="repeat">data</arg></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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 <command><optional>update</optional> add</command>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Adds a new resource record with the specified
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Displays the current message, containing all of the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein prerequisites and
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein updates specified since the last send.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Sends the current message. This is equivalent to entering a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Displays the answer.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Turn on debugging.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </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
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews> 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>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The prerequisite condition gets the name server to check that there
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein are no resource records of any type for
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce If there are, the update request fails.
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce If this name does not exist, a CNAME for it is added.
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce This ensures that when the CNAME is added, it cannot conflict with the
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce long-standing rule in RFC 1034 that a name must not exist as any other
727f5b8846457a33d06f515a10a7e1aa849ddf18Andreas Gustafsson record type if it exists as a CNAME.
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce (The rule has been updated for DNSSEC in RFC 2535 to allow CNAMEs to have
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce RRSIG, DNSKEY and NSEC records.)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <variablelist>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term><constant>/etc/resolv.conf</constant></term>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein used to identify default name server
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
33682c92e96b39c395cdb2c3feb8eb5914e7d5a8Andreas Gustafsson <varlistentry>
f293a69bcd1c1dd7bdac8f4102fc2398b9e475c8Eric Luce <term><constant>/var/run/named/session.key</constant></term>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein sets the default TSIG key for use in local-only mode
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term><constant>K{name}.+157.+{random}.key</constant></term>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein base-64 encoding of HMAC-MD5 key created by
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <citerefentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </citerefentry>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term><constant>K{name}.+157.+{random}.private</constant></term>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein base-64 encoding of HMAC-MD5 key created by
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <citerefentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews </citerefentry>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </variablelist>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <citerefentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </citerefentry>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <citerefentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentrytitle>ddns-confgen</refentrytitle><manvolnum>8</manvolnum>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </citerefentry>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <citerefentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </citerefentry>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The TSIG key is redundantly stored in two separate files.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein This is a consequence of nsupdate using the DST library
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein for its cryptographic operations, and may change in future
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - Local variables:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - mode: sgml