c40265eba0c99708887d68e67901924065ba2514Brian Wellington<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"

557a0ad5156aefc96dce27978a920eadf85c9d55Mark Andrews "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"

75c0816e8295e180f4bc7f10db3d0d880383bc1cMark Andrews [<!ENTITY mdash "&#8212;">]>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<refentry id="man.nsupdate">

71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews <refentryinfo>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <date>April 18, 2014</date>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </refentryinfo>

5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <refmeta>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentrytitle><application>nsupdate</application></refentrytitle>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <manvolnum>1</manvolnum>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews <refmiscinfo>BIND9</refmiscinfo>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </refmeta>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refnamediv>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refname><application>nsupdate</application></refname>

3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews <refpurpose>Dynamic DNS update utility</refpurpose>

3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews </refnamediv>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <docinfo>

71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews <copyright>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <year>2004</year>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <year>2005</year>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <year>2006</year>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <year>2007</year>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <year>2008</year>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <year>2009</year>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews <year>2010</year>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews <year>2011</year>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews <year>2012</year>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews <year>2014</year>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews <year>2015</year>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews <holder>Internet Systems Consortium, Inc. ("ISC")</holder>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews </copyright>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews <copyright>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews <year>2000</year>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews <year>2001</year>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews <year>2002</year>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <year>2003</year>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <holder>Internet Software Consortium.</holder>

71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews </copyright>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </docinfo>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refsynopsisdiv>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <cmdsynopsis>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <command>nsupdate</command>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-d</option></arg>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-D</option></arg>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-L <replaceable class="parameter">level</replaceable></option></arg>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <group>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-g</option></arg>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-o</option></arg>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-l</option></arg>

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 </group>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-t <replaceable class="parameter">timeout</replaceable></option></arg>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-u <replaceable class="parameter">udptimeout</replaceable></option></arg>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-r <replaceable class="parameter">udpretries</replaceable></option></arg>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-R <replaceable class="parameter">randomdev</replaceable></option></arg>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-v</option></arg>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-T</option></arg>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-P</option></arg>

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews <arg><option>-V</option></arg>

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews <arg>filename</arg>

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews </cmdsynopsis>

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews </refsynopsisdiv>

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews

a057e8e33baa5fa369be28a9680585200ce3ff73Mark Andrews <refsect1>

a057e8e33baa5fa369be28a9680585200ce3ff73Mark Andrews <title>DESCRIPTION</title>

a057e8e33baa5fa369be28a9680585200ce3ff73Mark Andrews <para><command>nsupdate</command>

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews is used to submit Dynamic DNS Update requests as defined in RFC 2136

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews to a name server.

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews This allows resource records to be added or removed from a zone

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews without manually editing the zone file.

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews A single update request can contain requests to add or remove more than

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews one

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews resource record.

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews </para>

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews <para>

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews Zones that are under dynamic control via

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews <command>nsupdate</command>

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews or a DHCP server should not be edited by hand.

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews Manual edits could

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews conflict with dynamic updates and cause data to be lost.

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews </para>

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews <para>

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews The resource records that are dynamically added or removed with

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews <command>nsupdate</command>

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews have to be in the same zone.

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews Requests are sent to the zone's master server.

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews This is identified by the MNAME field of the zone's SOA record.

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews </para>

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews <para>

a057e8e33baa5fa369be28a9680585200ce3ff73Mark Andrews Transaction signatures can be used to authenticate the Dynamic

a057e8e33baa5fa369be28a9680585200ce3ff73Mark Andrews DNS updates. These use the TSIG resource record type described

a057e8e33baa5fa369be28a9680585200ce3ff73Mark Andrews in RFC 2845 or the SIG(0) record described in RFC 2535 and

a057e8e33baa5fa369be28a9680585200ce3ff73Mark Andrews RFC 2931 or GSS-TSIG as described in RFC 3645.

a057e8e33baa5fa369be28a9680585200ce3ff73Mark Andrews </para>

a057e8e33baa5fa369be28a9680585200ce3ff73Mark Andrews <para>

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews TSIG relies on

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews a shared secret that should only be known to

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews <command>nsupdate</command> and the name server.

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews For instance, suitable <type>key</type> and

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews <type>server</type> statements would be added to

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews <filename>/etc/named.conf</filename> so that the name server

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews can associate the appropriate secret key and algorithm with

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews the IP address of the client application that will be using

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews TSIG authentication. You can use <command>ddns-confgen</command>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews to generate suitable configuration fragments.

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews <command>nsupdate</command>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews uses the <option>-y</option> or <option>-k</option> options

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews to provide the TSIG shared secret. These options are mutually exclusive.

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews </para>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews <para>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews SIG(0) uses public key cryptography.

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews To use a SIG(0) key, the public key must be stored in a KEY

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews record in a zone served by the name server.

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews </para>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <para>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein GSS-TSIG uses Kerberos credentials. Standard GSS-TSIG mode

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews is switched on with the <option>-g</option> flag. A

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews non-standards-compliant variant of GSS-TSIG used by Windows

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews 2000 can be switched on with the <option>-o</option> flag.

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews </para>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews </refsect1>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refsect1>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <title>OPTIONS</title>

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews <variablelist>

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews <varlistentry>

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews <term>-d</term>

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews <listitem>

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews <para>

3a3705ef7747327df182bf8d009333d2472253d5Mark Andrews Debug mode. This provides tracing information about the

3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews update requests that are made and the replies received

3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews from the name server.

3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews </para>

3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews </listitem>

3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews </varlistentry>

3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews

3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews <varlistentry>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term>-D</term>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <listitem>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <para>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews Extra debug mode.

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews </para>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews </listitem>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews </varlistentry>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term>-k <replaceable class="parameter">keyfile</replaceable></term>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <listitem>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <para>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The file containing the TSIG authentication key.

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews Keyfiles may be in two formats: a single file containing

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein a <filename>named.conf</filename>-format <command>key</command>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews statement, which may be generated automatically by

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews <command>ddns-confgen</command>, or a pair of files whose names are

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews of the format <filename>K{name}.+157.+{random}.key</filename> and

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews <filename>K{name}.+157.+{random}.private</filename>, which can be

285254345ce5ab270848f8c11f7be146793f1e00Mark Andrews generated by <command>dnssec-keygen</command>.

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews The <option>-k</option> may also be used to specify a SIG(0) key used

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews to authenticate Dynamic DNS update requests. In this case, the key

285254345ce5ab270848f8c11f7be146793f1e00Mark Andrews specified is not an HMAC-MD5 key.

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews </para>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews </listitem>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews </varlistentry>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews <varlistentry>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews <term>-l</term>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews <listitem>

3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews <para>

3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews Local-host only mode. This sets the server address to

3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews localhost (disabling the <command>server</command> so that the server

3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews address cannot be overridden). Connections to the local server will

3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews use a TSIG key found in <filename>/var/run/named/session.key</filename>,

3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews which is automatically generated by <command>named</command> if any

3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews 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 overridden with the <option>-k</option> option.

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </para>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </listitem>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term>-L <replaceable class="parameter">level</replaceable></term>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <listitem>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <para>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Set the logging debug level. If zero, logging is disabled.

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </para>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </listitem>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term>-p <replaceable class="parameter">port</replaceable></term>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <listitem>

7208386cd37a2092c70eddf80cf29519b16c4c80Mark Andrews <para>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Set the port to use for connections to a name server. The

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein default is 53.

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </para>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </listitem>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term>-P</term>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <listitem>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <para>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Print the list of private BIND-specific resource record

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein types whose format is understood

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein by <command>nsupdate</command>. See also

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the <option>-T</option> option.

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </para>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </listitem>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term>-r <replaceable class="parameter">udpretries</replaceable></term>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <listitem>

71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews <para>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The number of UDP retries. The default is 3. If zero, only

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein one update request will be made.

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </para>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </listitem>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein

71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews <varlistentry>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term>-R <replaceable class="parameter">randomdev</replaceable></term>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <listitem>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <para>

60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Where to obtain 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

71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews 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 </para>

</listitem>

</varlistentry>

<varlistentry>

<term>-t <replaceable class="parameter">timeout</replaceable></term>

<listitem>

<para>

The maximum time an update request can take before it is

aborted. The default is 300 seconds. Zero can be used to

disable the timeout.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>-T</term>

<listitem>

<para>

Print the list of IANA standard resource record types

whose format is understood by <command>nsupdate</command>.

<command>nsupdate</command> will exit after the lists are

printed. The <option>-T</option> option can be combined

with the <option>-P</option> option.

</para>

<para>

Other types can be entered using "TYPEXXXXX" where "XXXXX" is the

decimal value of the type with no leading zeros. The rdata,

if present, will be parsed using the UNKNOWN rdata format,

(&lt;backslash&gt; &lt;hash&gt; &lt;space&gt; &lt;length&gt;

&lt;space&gt; &lt;hexstring&gt;).

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>-u <replaceable class="parameter">udptimeout</replaceable></term>

<listitem>

<para>

The UDP retry interval. The default is 3 seconds. If zero,

the interval will be computed from the timeout interval and

number of UDP retries.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>-v</term>

<listitem>

<para>

Use TCP even for small update requests.

By default, <command>nsupdate</command>

uses UDP to send update requests to the name server unless they are too

large to fit in a UDP request in which case TCP will be used.

TCP may be preferable when a batch of update requests is made.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>-V</term>

<listitem>

<para>

Print the version number and exit.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>-y <replaceable class="parameter"><optional>hmac:</optional>keyname:secret</replaceable></term>

<listitem>

<para>

Literal TSIG authentication key.

<parameter>keyname</parameter> is the name of the key, and

<parameter>secret</parameter> is the base64 encoded shared secret.

<parameter>hmac</parameter> is the name of the key algorithm;

valid choices are <literal>hmac-md5</literal>,

<literal>hmac-sha1</literal>, <literal>hmac-sha224</literal>,

<literal>hmac-sha256</literal>, <literal>hmac-sha384</literal>, or

<literal>hmac-sha512</literal>. If <parameter>hmac</parameter>

is not specified, the default is <literal>hmac-md5</literal>.

</para>

<para>

NOTE: Use of the <option>-y</option> option is discouraged because the

shared secret is supplied as a command line argument in clear text.

This may be visible in the output from

<citerefentry>

<refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum>

</citerefentry>

or in a history file maintained by the user's shell.

</para>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

<refsect1>

<title>INPUT FORMAT</title>

<para><command>nsupdate</command>

reads input from

<parameter>filename</parameter>

or standard input.

Each command is supplied on exactly one line of input.

Some commands are for administrative purposes.

The others are either update instructions or prerequisite checks on the

contents of the zone.

These checks set conditions that some name or set of

resource records (RRset) either exists or is absent from the zone.

These conditions must be met if the entire update request is to succeed.

Updates will be rejected if the tests for the prerequisite conditions

fail.

</para>

<para>

Every update request consists of zero or more prerequisites

and zero or more updates.

This allows a suitably authenticated update request to proceed if some

specified resource records are present or missing from the zone.

A blank input line (or the <command>send</command> command)

causes the

accumulated commands to be sent as one Dynamic DNS update request to the

name server.

</para>

<para>

The command formats and their meaning are as follows:

<variablelist>

<varlistentry>

<term>

<command>server</command>

<arg choice="req">servername</arg>

<arg choice="opt">port</arg>

</term>

<listitem>

<para>

Sends all dynamic update requests to the name server

<parameter>servername</parameter>.

When no server statement is provided,

<command>nsupdate</command>

will send updates to the master server of the correct zone.

The MNAME field of that zone's SOA record will identify the

master

server for that zone.

<parameter>port</parameter>

is the port number on

<parameter>servername</parameter>

where the dynamic update requests get sent.

If no port number is specified, the default DNS port number of

53 is

used.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<command>local</command>

<arg choice="req">address</arg>

<arg choice="opt">port</arg>

</term>

<listitem>

<para>

Sends all dynamic update requests using the local

<parameter>address</parameter>.

When no local statement is provided,

<command>nsupdate</command>

will send updates using an address and port chosen by the

system.

<parameter>port</parameter>

can additionally be used to make requests come from a specific

port.

If no port number is specified, the system will assign one.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<command>zone</command>

<arg choice="req">zonename</arg>

</term>

<listitem>

<para>

Specifies that all updates are to be made to the zone

<parameter>zonename</parameter>.

If no

<parameter>zone</parameter>

statement is provided,

<command>nsupdate</command>

will attempt determine the correct zone to update based on the

rest of the input.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<command>class</command>

<arg choice="req">classname</arg>

</term>

<listitem>

<para>

Specify the default class.

If no <parameter>class</parameter> is specified, the

default class is

<parameter>IN</parameter>.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<command>ttl</command>

<arg choice="req">seconds</arg>

</term>

<listitem>

<para>

Specify the default time to live for records to be added.

The value <parameter>none</parameter> will clear the default

ttl.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<command>key</command>

<arg choice="opt">hmac:</arg><arg choice="req">keyname</arg>

<arg choice="req">secret</arg>

</term>

<listitem>

<para>

Specifies that all updates are to be TSIG-signed using the

<parameter>keyname</parameter> <parameter>secret</parameter> pair.

If <parameter>hmac</parameter> is specified, then it sets the

signing algorithm in use; the default is

<literal>hmac-md5</literal>. The <command>key</command>

command overrides any key specified on the command line via

<option>-y</option> or <option>-k</option>.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<command>gsstsig</command>

</term>

<listitem>

<para>

Use GSS-TSIG to sign the updated. This is equivalent to

specifying <option>-g</option> on the commandline.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<command>oldgsstsig</command>

</term>

<listitem>

<para>

Use the Windows 2000 version of GSS-TSIG to sign the updated.

This is equivalent to specifying <option>-o</option> on the

commandline.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<command>realm</command>

<arg choice="req"><optional>realm_name</optional></arg>

</term>

<listitem>

<para>

When using GSS-TSIG use <parameter>realm_name</parameter> rather

than the default realm in <filename>krb5.conf</filename>. If no

realm is specified the saved realm is cleared.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<command>check-names</command>

<arg choice="req"><optional>yes_or_no</optional></arg>

</term>

<listitem>

<para>

Turn on or off check-names processing on records to

be added. Check-names has no effect on prerequisites

or records to be deleted. By default check-names

processing is on. If check-names processing fails

the record will not be added to the UPDATE message.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<command><optional>prereq</optional> nxdomain</command>

<arg choice="req">domain-name</arg>

</term>

<listitem>

<para>

Requires that no resource record of any type exists with name

<parameter>domain-name</parameter>.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<command><optional>prereq</optional> yxdomain</command>

<arg choice="req">domain-name</arg>

</term>

<listitem>

<para>

Requires that

<parameter>domain-name</parameter>

exists (has as at least one resource record, of any type).

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<command><optional>prereq</optional> nxrrset</command>

<arg choice="req">domain-name</arg>

<arg choice="opt">class</arg>

<arg choice="req">type</arg>

</term>

<listitem>

<para>

Requires that no resource record exists of the specified

<parameter>type</parameter>,

<parameter>class</parameter>

and

<parameter>domain-name</parameter>.

If

<parameter>class</parameter>

is omitted, IN (internet) is assumed.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<command><optional>prereq</optional> yxrrset</command>

<arg choice="req">domain-name</arg>

<arg choice="opt">class</arg>

<arg choice="req">type</arg>

</term>

<listitem>

<para>

This requires that a resource record of the specified

<parameter>type</parameter>,

<parameter>class</parameter>

and

<parameter>domain-name</parameter>

must exist.

If

<parameter>class</parameter>

is omitted, IN (internet) is assumed.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<command><optional>prereq</optional> yxrrset</command>

<arg choice="req">domain-name</arg>

<arg choice="opt">class</arg>

<arg choice="req">type</arg>

<arg choice="req" rep="repeat">data</arg>

</term>

<listitem>

<para>

The

<parameter>data</parameter>

from each set of prerequisites of this form

sharing a common

<parameter>type</parameter>,

<parameter>class</parameter>,

and

<parameter>domain-name</parameter>

are combined to form a set of RRs. This set of RRs must

exactly match the set of RRs existing in the zone at the

given

<parameter>type</parameter>,

<parameter>class</parameter>,

and

<parameter>domain-name</parameter>.

The

<parameter>data</parameter>

are written in the standard text representation of the resource

record's

RDATA.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<command><optional>update</optional> del<optional>ete</optional></command>

<arg choice="req">domain-name</arg>

<arg choice="opt">ttl</arg>

<arg choice="opt">class</arg>

<arg choice="opt">type <arg choice="opt" rep="repeat">data</arg></arg>

</term>

<listitem>

<para>

Deletes any resource records named

<parameter>domain-name</parameter>.

If

<parameter>type</parameter>

and

<parameter>data</parameter>

is provided, only matching resource records will be removed.

The internet class is assumed if

<parameter>class</parameter>

is not supplied. The

<parameter>ttl</parameter>

is ignored, and is only allowed for compatibility.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<command><optional>update</optional> add</command>

<arg choice="req">domain-name</arg>

<arg choice="req">ttl</arg>

<arg choice="opt">class</arg>

<arg choice="req">type</arg>

<arg choice="req" rep="repeat">data</arg>

</term>

<listitem>

<para>

Adds a new resource record with the specified

<parameter>ttl</parameter>,

<parameter>class</parameter>

and

<parameter>data</parameter>.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<command>show</command>

</term>

<listitem>

<para>

Displays the current message, containing all of the

prerequisites and

updates specified since the last send.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<command>send</command>

</term>

<listitem>

<para>

Sends the current message. This is equivalent to entering a

blank line.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<command>answer</command>

</term>

<listitem>

<para>

Displays the answer.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<command>debug</command>

</term>

<listitem>

<para>

Turn on debugging.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<command>version</command>

</term>

<listitem>

<para>

Print version number.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<command>help</command>

</term>

<listitem>

<para>

Print a list of commands.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

<para>

Lines beginning with a semicolon are comments and are ignored.

</para>

</refsect1>

<refsect1>

<title>EXAMPLES</title>

<para>

The examples below show how

<command>nsupdate</command>

could be used to insert and delete resource records from the

<type>example.com</type>

zone.

Notice that the input in each example contains a trailing blank line so

that

a group of commands are sent as one dynamic update request to the

master name server for

<type>example.com</type>.

<programlisting>

# nsupdate

&gt; update delete oldhost.example.com A

&gt; update add newhost.example.com 86400 A 172.16.1.1

&gt; send

</programlisting>

</para>

<para>

Any A records for

<type>oldhost.example.com</type>

are deleted.

And an A record for

<type>newhost.example.com</type>

with IP address 172.16.1.1 is added.

The newly-added record has a 1 day TTL (86400 seconds).

<programlisting>

# nsupdate

&gt; prereq nxdomain nickname.example.com

&gt; update add nickname.example.com 86400 CNAME somehost.example.com

&gt; send

</programlisting>

</para>

<para>

The prerequisite condition gets the name server to check that there

are no resource records of any type for

<type>nickname.example.com</type>.

If there are, the update request fails.

If this name does not exist, a CNAME for it is added.

This ensures that when the CNAME is added, it cannot conflict with the

long-standing rule in RFC 1034 that a name must not exist as any other

record type if it exists as a CNAME.

(The rule has been updated for DNSSEC in RFC 2535 to allow CNAMEs to have

RRSIG, DNSKEY and NSEC records.)

</para>

</refsect1>

<refsect1>

<title>FILES</title>

<variablelist>

<varlistentry>

<term><constant>/etc/resolv.conf</constant></term>

<listitem>

<para>

used to identify default name server

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><constant>/var/run/named/session.key</constant></term>

<listitem>

<para>

sets the default TSIG key for use in local-only mode

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><constant>K{name}.+157.+{random}.key</constant></term>

<listitem>

<para>

base-64 encoding of HMAC-MD5 key created by

<citerefentry>

<refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>

</citerefentry>.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><constant>K{name}.+157.+{random}.private</constant></term>

<listitem>

<para>

base-64 encoding of HMAC-MD5 key created by

<citerefentry>

<refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>

</citerefentry>.

</para>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

<refsect1>

<title>SEE ALSO</title>

<para>

<citetitle>RFC 2136</citetitle>,

<citetitle>RFC 3007</citetitle>,

<citetitle>RFC 2104</citetitle>,

<citetitle>RFC 2845</citetitle>,

<citetitle>RFC 1034</citetitle>,

<citetitle>RFC 2535</citetitle>,

<citetitle>RFC 2931</citetitle>,

<citerefentry>

<refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>

</citerefentry>,

<citerefentry>

<refentrytitle>ddns-confgen</refentrytitle><manvolnum>8</manvolnum>

</citerefentry>,

<citerefentry>

<refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>

</citerefentry>.

</para>

</refsect1>

<refsect1>

<title>BUGS</title>

<para>

The TSIG key is redundantly stored in two separate files.

This is a consequence of nsupdate using the DST library

for its cryptographic operations, and may change in future

releases.

</para>

</refsect1>

</refentry><!--