nsupdate.docbook revision 30eec077db2bdcb6f2a0dc388a3cdde2ede75ec1
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync - Copyright (C) 2004-2012, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
4bc1bbf45f30ff3ca38c2ad006836e490972c7ccvboxsync - Copyright (C) 2000-2003 Internet Software Consortium.
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync - Permission to use, copy, modify, and/or distribute this software for any
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync - purpose with or without fee is hereby granted, provided that the above
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync - copyright notice and this permission notice appear in all copies.
d63de4508a08b11f57c307a15eda3cd95485bf2cvboxsync - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
d63de4508a08b11f57c307a15eda3cd95485bf2cvboxsync - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
d63de4508a08b11f57c307a15eda3cd95485bf2cvboxsync - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync - PERFORMANCE OF THIS SOFTWARE.
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync<!-- Converted by db4-upgrade version 1.0 -->
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.nsupdate">
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <refentryinfo>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync </refentryinfo>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <refentrytitle><application>nsupdate</application></refentrytitle>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <refnamediv>
4bc1bbf45f30ff3ca38c2ad006836e490972c7ccvboxsync <refname><application>nsupdate</application></refname>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <refpurpose>Dynamic DNS update utility</refpurpose>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync </refnamediv>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <copyright>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync </copyright>
d02610fd604cc8ab4cccf7e3fa510c06cb728ff2vboxsync <copyright>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync </copyright>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <refsynopsisdiv>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <arg choice="opt" rep="norepeat"><option>-d</option></arg>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <arg choice="opt" rep="norepeat"><option>-D</option></arg>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <arg choice="opt" rep="norepeat"><option>-L <replaceable class="parameter">level</replaceable></option></arg>
f03d2f859a6661088b765809ff4feb39bdd7a311vboxsync <arg choice="opt" rep="norepeat"><option>-g</option></arg>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <arg choice="opt" rep="norepeat"><option>-o</option></arg>
f2ca52afeb0baed982c05e9d8591e0e4c7539dbdvboxsync <arg choice="opt" rep="norepeat"><option>-l</option></arg>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <arg choice="opt" rep="norepeat"><option>-y <replaceable class="parameter"><optional>hmac:</optional>keyname:secret</replaceable></option></arg>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <arg choice="opt" rep="norepeat"><option>-k <replaceable class="parameter">keyfile</replaceable></option></arg>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">timeout</replaceable></option></arg>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <arg choice="opt" rep="norepeat"><option>-u <replaceable class="parameter">udptimeout</replaceable></option></arg>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <arg choice="opt" rep="norepeat"><option>-r <replaceable class="parameter">udpretries</replaceable></option></arg>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <arg choice="opt" rep="norepeat"><option>-R <replaceable class="parameter">randomdev</replaceable></option></arg>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <arg choice="opt" rep="norepeat"><option>-v</option></arg>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <arg choice="opt" rep="norepeat"><option>-T</option></arg>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <arg choice="opt" rep="norepeat"><option>-P</option></arg>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <arg choice="opt" rep="norepeat"><option>-V</option></arg>
3baadeafd9922582dad9b32431362e6296417dd8vboxsync </cmdsynopsis>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync </refsynopsisdiv>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <refsection><info><title>DESCRIPTION</title></info>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync is used to submit Dynamic DNS Update requests as defined in RFC 2136
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync to a name server.
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync This allows resource records to be added or removed from a zone
f2ca52afeb0baed982c05e9d8591e0e4c7539dbdvboxsync without manually editing the zone file.
49c9958a74e4a297fb7ec141ee764e872430f4bavboxsync A single update request can contain requests to add or remove more than
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync resource record.
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync Zones that are under dynamic control via
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync or a DHCP server should not be edited by hand.
080867566ec24e954aac5664d20a8fb364be2ed1vboxsync Manual edits could
4bc1bbf45f30ff3ca38c2ad006836e490972c7ccvboxsync conflict with dynamic updates and cause data to be lost.
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync The resource records that are dynamically added or removed with
4bc1bbf45f30ff3ca38c2ad006836e490972c7ccvboxsync have to be in the same zone.
c215a948010614887014a258c1751602d8bf7781vboxsync Requests are sent to the zone's master server.
4bc1bbf45f30ff3ca38c2ad006836e490972c7ccvboxsync This is identified by the MNAME field of the zone's SOA record.
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync Transaction signatures can be used to authenticate the Dynamic
7c205843b5f25329b7bac4cb41e4c55a21c7aafevboxsync DNS updates. These use the TSIG resource record type described
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync in RFC 2845 or the SIG(0) record described in RFC 2535 and
b1212d1cdc6c9396aa851ef0a5388edce69806advboxsync RFC 2931 or GSS-TSIG as described in RFC 3645.
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync TSIG relies on
08879243dd70cdd8c01c3a5941c82c96c45a7e32vboxsync a shared secret that should only be known to
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <filename>/etc/named.conf</filename> so that the name server
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync can associate the appropriate secret key and algorithm with
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync the IP address of the client application that will be using
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync TSIG authentication. You can use <command>ddns-confgen</command>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync to generate suitable configuration fragments.
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync uses the <option>-y</option> or <option>-k</option> options
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync to provide the TSIG shared secret. These options are mutually exclusive.
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync SIG(0) uses public key cryptography.
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync To use a SIG(0) key, the public key must be stored in a KEY
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync record in a zone served by the name server.
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync GSS-TSIG uses Kerberos credentials. Standard GSS-TSIG mode
b1212d1cdc6c9396aa851ef0a5388edce69806advboxsync is switched on with the <option>-g</option> flag. A
b1212d1cdc6c9396aa851ef0a5388edce69806advboxsync non-standards-compliant variant of GSS-TSIG used by Windows
24713061a674af34286ac48ad1433329cdd404f2vboxsync 2000 can be switched on with the <option>-o</option> flag.
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync </refsection>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <variablelist>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <varlistentry>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync Debug mode. This provides tracing information about the
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync update requests that are made and the replies received
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync from the name server.
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync </listitem>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync </varlistentry>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <varlistentry>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync Extra debug mode.
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync </listitem>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync </varlistentry>
9704f1d0180960069e2c4eb8fe2ddee350910e5dvboxsync <varlistentry>
9704f1d0180960069e2c4eb8fe2ddee350910e5dvboxsync <term>-k <replaceable class="parameter">keyfile</replaceable></term>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync The file containing the TSIG authentication key.
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync Keyfiles may be in two formats: a single file containing
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync a <filename>named.conf</filename>-format <command>key</command>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync statement, which may be generated automatically by
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <command>ddns-confgen</command>, or a pair of files whose names are
9704f1d0180960069e2c4eb8fe2ddee350910e5dvboxsync of the format <filename>K{name}.+157.+{random}.key</filename> and
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <filename>K{name}.+157.+{random}.private</filename>, which can be
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync The <option>-k</option> may also be used to specify a SIG(0) key used
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync to authenticate Dynamic DNS update requests. In this case, the key
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync specified is not an HMAC-MD5 key.
4bc1bbf45f30ff3ca38c2ad006836e490972c7ccvboxsync </listitem>
17d67aeb3722c094c6493a3e9a9d0cdfb9453ecdvboxsync </varlistentry>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <varlistentry>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync Local-host only mode. This sets the server address to
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync localhost (disabling the <command>server</command> so that the server
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync address cannot be overridden). Connections to the local server will
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync use a TSIG key found in <filename>/var/run/named/session.key</filename>,
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync which is automatically generated by <command>named</command> if any
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync local master zone has set <command>update-policy</command> to
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <command>local</command>. The location of this key file can be
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync </listitem>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync </varlistentry>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <varlistentry>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <term>-L <replaceable class="parameter">level</replaceable></term>
61c35c2bbfa3caf6ca8b21f6c11f45c5a796581fvboxsync Set the logging debug level. If zero, logging is disabled.
61c35c2bbfa3caf6ca8b21f6c11f45c5a796581fvboxsync </listitem>
61c35c2bbfa3caf6ca8b21f6c11f45c5a796581fvboxsync </varlistentry>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <varlistentry>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <term>-p <replaceable class="parameter">port</replaceable></term>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync Set the port to use for connections to a name server. The
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync default is 53.
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync </listitem>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync </varlistentry>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <varlistentry>
9704f1d0180960069e2c4eb8fe2ddee350910e5dvboxsync Print the list of private BIND-specific resource record
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync types whose format is understood
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync </listitem>
90bfe7905f962c9c30f653670ac7fdadbd8f27cdvboxsync </varlistentry>
90bfe7905f962c9c30f653670ac7fdadbd8f27cdvboxsync <varlistentry>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <term>-r <replaceable class="parameter">udpretries</replaceable></term>
d02610fd604cc8ab4cccf7e3fa510c06cb728ff2vboxsync The number of UDP retries. The default is 3. If zero, only
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync one update request will be made.
a48f6e21f8737ef47d30d716171ae2bcb10c3382vboxsync </listitem>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync </varlistentry>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <varlistentry>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <term>-R <replaceable class="parameter">randomdev</replaceable></term>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync Where to obtain randomness. If the operating system
73b48d036adc9de8ba80796a9f9daf1ad5c8b6b7vboxsync does not provide a <filename>/dev/random</filename> or
b723b174d7132ab6bbff3abcd83c92530065f7davboxsync equivalent device, the default source of randomness is keyboard
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync input. <filename>randomdev</filename> specifies the name of
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync a character device or file containing random data to be used
fe7115bba580b609cb1a233f8e08947d0ee0af8dvboxsync instead of the default. The special value
17d67aeb3722c094c6493a3e9a9d0cdfb9453ecdvboxsync <filename>keyboard</filename> indicates that keyboard input
fe7115bba580b609cb1a233f8e08947d0ee0af8dvboxsync should be used. This option may be specified multiple times.
fe7115bba580b609cb1a233f8e08947d0ee0af8dvboxsync </listitem>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync </varlistentry>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <varlistentry>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <term>-t <replaceable class="parameter">timeout</replaceable></term>
4d5da2bfd5523ad009912e6e0cfb8bf480160e32vboxsync The maximum time an update request can take before it is
4d5da2bfd5523ad009912e6e0cfb8bf480160e32vboxsync aborted. The default is 300 seconds. Zero can be used to
4d5da2bfd5523ad009912e6e0cfb8bf480160e32vboxsync disable the timeout.
4d5da2bfd5523ad009912e6e0cfb8bf480160e32vboxsync </listitem>
f1acc1e99894e016bd1a6ee65c56b3fc064fa4ebvboxsync </varlistentry>
09ed5ee011f3a6cd9d4742216ad3bb7dbf855641vboxsync <varlistentry>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync Print the list of IANA standard resource record types
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync whose format is understood by <command>nsupdate</command>.
c6adb272ec43d5eaadb1493cb2bf45f2f8adf588vboxsync <command>nsupdate</command> will exit after the lists are
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync printed. The <option>-T</option> option can be combined
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync Other types can be entered using "TYPEXXXXX" where "XXXXX" is the
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync decimal value of the type with no leading zeros. The rdata,
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync if present, will be parsed using the UNKNOWN rdata format,
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync (<backslash> <hash> <space> <length>
f8cec848855143b787264c5456f9015e576b59d8vboxsync <space> <hexstring>).
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync </listitem>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync </varlistentry>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <varlistentry>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <term>-u <replaceable class="parameter">udptimeout</replaceable></term>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync The UDP retry interval. The default is 3 seconds. If zero,
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync the interval will be computed from the timeout interval and
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync number of UDP retries.
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync </listitem>
5d31da34788d5a82008edfa7181f3e2776462db7vboxsync </varlistentry>
5f9dfb422a6ed57822f9c0cb94fa7df8d24acc9bvboxsync <varlistentry>
<term>-y <replaceable class="parameter"><optional>hmac:</optional>keyname:secret</replaceable></term>
> update delete oldhost.example.com A
> update add newhost.example.com 86400 A 172.16.1.1
> prereq nxdomain nickname.example.com