nsupdate.docbook revision 5cd4555ad444fd391002ae32450572054369fd42
5cd4555ad444fd391002ae32450572054369fd42Rob Austein<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
5cd4555ad444fd391002ae32450572054369fd42Rob Austein "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein [<!ENTITY mdash "&#8212;">]>
9c49c394b4218cc9c743a372a8fcfb787f5ea8caAndreas Gustafsson<!--
26e2a07a0b6a3b1eccef82ba31270d0c54ad4f06Mark Andrews - Copyright (C) 2004-2006 Internet Systems Consortium, Inc. ("ISC")
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews - Copyright (C) 2000-2003 Internet Software Consortium.
9c49c394b4218cc9c743a372a8fcfb787f5ea8caAndreas Gustafsson -
9c49c394b4218cc9c743a372a8fcfb787f5ea8caAndreas Gustafsson - Permission to use, copy, modify, and distribute this software for any
9c49c394b4218cc9c743a372a8fcfb787f5ea8caAndreas Gustafsson - purpose with or without fee is hereby granted, provided that the above
9c49c394b4218cc9c743a372a8fcfb787f5ea8caAndreas Gustafsson - copyright notice and this permission notice appear in all copies.
9c49c394b4218cc9c743a372a8fcfb787f5ea8caAndreas Gustafsson -
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
9c49c394b4218cc9c743a372a8fcfb787f5ea8caAndreas Gustafsson-->
f5d30e2864e048a42c4dc1134993ae7efdb5d6c3Mark Andrews
5cd4555ad444fd391002ae32450572054369fd42Rob Austein<!-- $Id: nsupdate.docbook,v 1.25 2007/01/29 22:16:02 sra Exp $ -->
9c49c394b4218cc9c743a372a8fcfb787f5ea8caAndreas Gustafsson<refentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentryinfo>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <date>Jun 30, 2000</date>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refentryinfo>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refmeta>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle>nsupdate</refentrytitle>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <manvolnum>8</manvolnum>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refmiscinfo>BIND9</refmiscinfo>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refmeta>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refnamediv>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refname>nsupdate</refname>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refpurpose>Dynamic DNS update utility</refpurpose>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refnamediv>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <docinfo>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <copyright>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <year>2004</year>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <year>2005</year>
26e2a07a0b6a3b1eccef82ba31270d0c54ad4f06Mark Andrews <year>2006</year>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </copyright>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <copyright>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <year>2000</year>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <year>2001</year>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <year>2002</year>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <year>2003</year>
f5d30e2864e048a42c4dc1134993ae7efdb5d6c3Mark Andrews <holder>Internet Software Consortium.</holder>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </copyright>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </docinfo>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refsynopsisdiv>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <cmdsynopsis>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>nsupdate</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg><option>-d</option></arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <group>
c6d4f781529d2f28693546b25b2967d44ec89e60Mark Andrews <arg><option>-y <replaceable class="parameter"><optional>hmac:</optional>keyname:secret</replaceable></option></arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg><option>-k <replaceable class="parameter">keyfile</replaceable></option></arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </group>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg><option>-t <replaceable class="parameter">timeout</replaceable></option></arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg><option>-u <replaceable class="parameter">udptimeout</replaceable></option></arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg><option>-r <replaceable class="parameter">udpretries</replaceable></option></arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg><option>-v</option></arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg>filename</arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </cmdsynopsis>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refsynopsisdiv>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refsect1>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <title>DESCRIPTION</title>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para><command>nsupdate</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein is used to submit Dynamic DNS Update requests as defined in RFC2136
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein to a name server.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein This allows resource records to be added or removed from a zone
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein without manually editing the zone file.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein A single update request can contain requests to add or remove more than
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein one
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein resource record.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Zones that are under dynamic control via
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>nsupdate</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein or a DHCP server should not be edited by hand.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Manual edits could
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein conflict with dynamic updates and cause data to be lost.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein The resource records that are dynamically added or removed with
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>nsupdate</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein have to be in the same zone.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Requests are sent to the zone's master server.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein This is identified by the MNAME field of the zone's SOA record.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein The
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <option>-d</option>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein option makes
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>nsupdate</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein operate in debug mode.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein This provides tracing information about the update requests that are
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein made and the replies received from the name server.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Transaction signatures can be used to authenticate the Dynamic DNS
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein updates.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein These use the TSIG resource record type described in RFC2845 or the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein SIG(0) record described in RFC3535 and RFC2931.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein TSIG relies on a shared secret that should only be known to
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>nsupdate</command> and the name server.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Currently, the only supported encryption algorithm for TSIG is
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein HMAC-MD5, which is defined in RFC 2104.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Once other algorithms are defined for TSIG, applications will need to
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein ensure they select the appropriate algorithm as well as the key when
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein authenticating each other.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein For instance suitable
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <type>key</type>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein and
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <type>server</type>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein statements would be added to
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <filename>/etc/named.conf</filename>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein so that the name server can associate the appropriate secret key
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein and algorithm with the IP address of the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein client application that will be using TSIG authentication.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein SIG(0) uses public key cryptography. To use a SIG(0) key, the public
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein key must be stored in a KEY record in a zone served by the name server.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>nsupdate</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein does not read
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <filename>/etc/named.conf</filename>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para><command>nsupdate</command>
c6d4f781529d2f28693546b25b2967d44ec89e60Mark Andrews uses the <option>-y</option> or <option>-k</option> option
c6d4f781529d2f28693546b25b2967d44ec89e60Mark Andrews to provide the shared secret needed to generate a TSIG record
c6d4f781529d2f28693546b25b2967d44ec89e60Mark Andrews for authenticating Dynamic DNS update requests, default type
c6d4f781529d2f28693546b25b2967d44ec89e60Mark Andrews HMAC-MD5. These options are mutually exclusive. With the
c6d4f781529d2f28693546b25b2967d44ec89e60Mark Andrews <option>-k</option> option, <command>nsupdate</command> reads
c6d4f781529d2f28693546b25b2967d44ec89e60Mark Andrews the shared secret from the file <parameter>keyfile</parameter>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein whose name is of the form
c6d4f781529d2f28693546b25b2967d44ec89e60Mark Andrews <filename>K{name}.+157.+{random}.private</filename>. For
c6d4f781529d2f28693546b25b2967d44ec89e60Mark Andrews historical reasons, the file
c6d4f781529d2f28693546b25b2967d44ec89e60Mark Andrews <filename>K{name}.+157.+{random}.key</filename> must also be
c6d4f781529d2f28693546b25b2967d44ec89e60Mark Andrews present. When the <option>-y</option> option is used, a
c6d4f781529d2f28693546b25b2967d44ec89e60Mark Andrews signature is generated from
c6d4f781529d2f28693546b25b2967d44ec89e60Mark Andrews <optional><parameter>hmac:</parameter></optional><parameter>keyname:secret.</parameter>
c6d4f781529d2f28693546b25b2967d44ec89e60Mark Andrews <parameter>keyname</parameter> is the name of the key, and
c6d4f781529d2f28693546b25b2967d44ec89e60Mark Andrews <parameter>secret</parameter> is the base64 encoded shared
c6d4f781529d2f28693546b25b2967d44ec89e60Mark Andrews secret. Use of the <option>-y</option> option is discouraged
c6d4f781529d2f28693546b25b2967d44ec89e60Mark Andrews because the shared secret is supplied as a command line
c6d4f781529d2f28693546b25b2967d44ec89e60Mark Andrews argument in clear text. This may be visible in the output
c6d4f781529d2f28693546b25b2967d44ec89e60Mark Andrews from
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <citerefentry>
c6d4f781529d2f28693546b25b2967d44ec89e60Mark Andrews <refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum>
c6d4f781529d2f28693546b25b2967d44ec89e60Mark Andrews </citerefentry> or in a history file maintained by the user's
c6d4f781529d2f28693546b25b2967d44ec89e60Mark Andrews shell.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein The <option>-k</option> may also be used to specify a SIG(0) key used
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein to authenticate Dynamic DNS update requests. In this case, the key
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein specified is not an HMAC-MD5 key.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein By default
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>nsupdate</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein uses UDP to send update requests to the name server unless they are too
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein large to fit in a UDP request in which case TCP will be used.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein The
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <option>-v</option>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein option makes
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>nsupdate</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein use a TCP connection.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein This may be preferable when a batch of update requests is made.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein The <option>-t</option> option sets the maximum time a update request
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein can
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein take before it is aborted. The default is 300 seconds. Zero can be
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein used
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein to disable the timeout.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein The <option>-u</option> option sets the UDP retry interval. The default
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein is
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein 3 seconds. If zero the interval will be computed from the timeout
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein interval
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein and number of UDP retries.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein The <option>-r</option> option sets the number of UDP retries. The
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein default is
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein 3. If zero only one update request will be made.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refsect1>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refsect1>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <title>INPUT FORMAT</title>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para><command>nsupdate</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein reads input from
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>filename</parameter>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein or standard input.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Each command is supplied on exactly one line of input.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Some commands are for administrative purposes.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein The others are either update instructions or prerequisite checks on the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein contents of the zone.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein These checks set conditions that some name or set of
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein resource records (RRset) either exists or is absent from the zone.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein These conditions must be met if the entire update request is to succeed.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Updates will be rejected if the tests for the prerequisite conditions
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein fail.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Every update request consists of zero or more prerequisites
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein and zero or more updates.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein This allows a suitably authenticated update request to proceed if some
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein specified resource records are present or missing from the zone.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein A blank input line (or the <command>send</command> command)
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein causes the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein accumulated commands to be sent as one Dynamic DNS update request to the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein name server.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein The command formats and their meaning are as follows:
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <variablelist>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein <term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>server</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="req">servername</arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="opt">port</arg>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein </term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Sends all dynamic update requests to the name server
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>servername</parameter>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein When no server statement is provided,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>nsupdate</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein will send updates to the master server of the correct zone.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein The MNAME field of that zone's SOA record will identify the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein master
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein server for that zone.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>port</parameter>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein is the port number on
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>servername</parameter>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein where the dynamic update requests get sent.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein If no port number is specified, the default DNS port number of
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein 53 is
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein used.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein <term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>local</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="req">address</arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="opt">port</arg>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein </term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Sends all dynamic update requests using the local
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>address</parameter>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein When no local statement is provided,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>nsupdate</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein will send updates using an address and port chosen by the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein system.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>port</parameter>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein can additionally be used to make requests come from a specific
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein port.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein If no port number is specified, the system will assign one.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein <term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>zone</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="req">zonename</arg>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein </term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Specifies that all updates are to be made to the zone
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>zonename</parameter>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein If no
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>zone</parameter>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein statement is provided,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>nsupdate</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein will attempt determine the correct zone to update based on the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein rest of the input.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein <term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>class</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="req">classname</arg>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein </term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Specify the default class.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein If no <parameter>class</parameter> is specified the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein default class is
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>IN</parameter>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein <term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>key</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="req">name</arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="req">secret</arg>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein </term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Specifies that all updates are to be TSIG signed using the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>keyname</parameter> <parameter>keysecret</parameter> pair.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein The <command>key</command> command
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein overrides any key specified on the command line via
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <option>-y</option> or <option>-k</option>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein <term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>prereq nxdomain</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="req">domain-name</arg>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein </term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Requires that no resource record of any type exists with name
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>domain-name</parameter>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein <term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>prereq yxdomain</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="req">domain-name</arg>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein </term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Requires that
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>domain-name</parameter>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein exists (has as at least one resource record, of any type).
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein <term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>prereq nxrrset</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="req">domain-name</arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="opt">class</arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="req">type</arg>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein </term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Requires that no resource record exists of the specified
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>type</parameter>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>class</parameter>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein and
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>domain-name</parameter>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein If
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>class</parameter>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein is omitted, IN (internet) is assumed.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein <term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>prereq yxrrset</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="req">domain-name</arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="opt">class</arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="req">type</arg>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein </term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein This requires that a resource record of the specified
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>type</parameter>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>class</parameter>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein and
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>domain-name</parameter>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein must exist.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein If
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>class</parameter>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein is omitted, IN (internet) is assumed.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein <term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>prereq yxrrset</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="req">domain-name</arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="opt">class</arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="req">type</arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="req" rep="repeat">data</arg>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein </term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein The
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>data</parameter>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein from each set of prerequisites of this form
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein sharing a common
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>type</parameter>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>class</parameter>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein and
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>domain-name</parameter>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein are combined to form a set of RRs. This set of RRs must
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein exactly match the set of RRs existing in the zone at the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein given
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>type</parameter>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>class</parameter>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein and
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>domain-name</parameter>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein The
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>data</parameter>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein are written in the standard text representation of the resource
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein record's
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein RDATA.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein <term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>update delete</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="req">domain-name</arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="opt">ttl</arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="opt">class</arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="opt">type <arg choice="opt" rep="repeat">data</arg></arg>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein </term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Deletes any resource records named
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>domain-name</parameter>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein If
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>type</parameter>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein and
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>data</parameter>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein is provided, only matching resource records will be removed.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein The internet class is assumed if
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>class</parameter>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein is not supplied. The
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>ttl</parameter>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein is ignored, and is only allowed for compatibility.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein <term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>update add</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="req">domain-name</arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="req">ttl</arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="opt">class</arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="req">type</arg>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <arg choice="req" rep="repeat">data</arg>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein </term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Adds a new resource record with the specified
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>ttl</parameter>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>class</parameter>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein and
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <parameter>data</parameter>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein <term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>show</command>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein </term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Displays the current message, containing all of the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein prerequisites and
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein updates specified since the last send.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein <term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>send</command>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein </term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Sends the current message. This is equivalent to entering a
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein blank line.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein <term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>answer</command>
8d709e3ee443222cd35e44eadc9a4c0a8d92fec2Rob Austein </term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Displays the answer.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </variablelist>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Lines beginning with a semicolon are comments and are ignored.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refsect1>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refsect1>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <title>EXAMPLES</title>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein The examples below show how
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <command>nsupdate</command>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein could be used to insert and delete resource records from the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <type>example.com</type>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein zone.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Notice that the input in each example contains a trailing blank line so
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein that
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein a group of commands are sent as one dynamic update request to the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein master name server for
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <type>example.com</type>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <programlisting>
9c49c394b4218cc9c743a372a8fcfb787f5ea8caAndreas Gustafsson# nsupdate
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein&gt; update delete oldhost.example.com A
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein&gt; update add newhost.example.com 86400 A 172.16.1.1
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein&gt; send
9c49c394b4218cc9c743a372a8fcfb787f5ea8caAndreas Gustafsson</programlisting>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Any A records for
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <type>oldhost.example.com</type>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein are deleted.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein and an A record for
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <type>newhost.example.com</type>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein it IP address 172.16.1.1 is added.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein The newly-added record has a 1 day TTL (86400 seconds)
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <programlisting>
9c49c394b4218cc9c743a372a8fcfb787f5ea8caAndreas Gustafsson# nsupdate
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein&gt; prereq nxdomain nickname.example.com
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein&gt; update add nickname.example.com 86400 CNAME somehost.example.com
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein&gt; send
9c49c394b4218cc9c743a372a8fcfb787f5ea8caAndreas Gustafsson</programlisting>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein The prerequisite condition gets the name server to check that there
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein are no resource records of any type for
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <type>nickname.example.com</type>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein If there are, the update request fails.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein If this name does not exist, a CNAME for it is added.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein This ensures that when the CNAME is added, it cannot conflict with the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein long-standing rule in RFC1034 that a name must not exist as any other
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein record type if it exists as a CNAME.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein (The rule has been updated for DNSSEC in RFC2535 to allow CNAMEs to have
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein RRSIG, DNSKEY and NSEC records.)
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refsect1>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refsect1>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <title>FILES</title>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <variablelist>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term><constant>/etc/resolv.conf</constant></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein used to identify default name server
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term><constant>K{name}.+157.+{random}.key</constant></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein base-64 encoding of HMAC-MD5 key created by
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <citerefentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </citerefentry>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term><constant>K{name}.+157.+{random}.private</constant></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein base-64 encoding of HMAC-MD5 key created by
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <citerefentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </citerefentry>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </variablelist>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refsect1>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refsect1>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <title>SEE ALSO</title>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para><citerefentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle>RFC2136</refentrytitle>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </citerefentry>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <citerefentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle>RFC3007</refentrytitle>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </citerefentry>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <citerefentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle>RFC2104</refentrytitle>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </citerefentry>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <citerefentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle>RFC2845</refentrytitle>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </citerefentry>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <citerefentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle>RFC1034</refentrytitle>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </citerefentry>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <citerefentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle>RFC2535</refentrytitle>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </citerefentry>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <citerefentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle>RFC2931</refentrytitle>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </citerefentry>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <citerefentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </citerefentry>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <citerefentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </citerefentry>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refsect1>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refsect1>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <title>BUGS</title>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein The TSIG key is redundantly stored in two separate files.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein This is a consequence of nsupdate using the DST library
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein for its cryptographic operations, and may change in future
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein releases.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refsect1>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein</refentry><!--
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein - Local variables:
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein - mode: sgml
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein - End:
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein-->