nsupdate.docbook revision f5d30e2864e048a42c4dc1134993ae7efdb5d6c3
436aad11e01e916f75e68a2e9cb89ac217a990d3Tinderbox User<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.0//EN"
6fe48fb46e53ffc37542853a1edb74cb481b7d94Automatic Updater "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd"
c7ef13f6c9ef4436bc804b150e0a93307b11fa27Tinderbox User [<!ENTITY mdash "&#8212;">]>
c7ef13f6c9ef4436bc804b150e0a93307b11fa27Tinderbox User<!--
a5636b773fa05a272b6876afd99309c0b3090e2fMark Andrews - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
e9e4257668ff6c4e583b0c0db2508650b0b677b8Tinderbox User - Copyright (C) 2000-2003 Internet Software Consortium.
e9e4257668ff6c4e583b0c0db2508650b0b677b8Tinderbox User -
c57668a2fbbe558c1bd21652813616f2f517c469Tinderbox User - Permission to use, copy, modify, and distribute this software for any
5e047890ac9b745db060d95f7d1b4f876511240dTinderbox User - purpose with or without fee is hereby granted, provided that the above
137fdbc214e99c4cbe57551e9e14f2015c2e42aeTinderbox User - copyright notice and this permission notice appear in all copies.
3349f0044fda807e1fd6681c833d3593a22dad86Tinderbox User -
bed0874e1a09e810575328c4bfc346a47514b69fMark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
02b47c5d62e1e827743684c28a08e871da454a2dMark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
e20309353e6246485c521278131d3fced73d7957Tinderbox User - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
e20309353e6246485c521278131d3fced73d7957Tinderbox User - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
9a5217f827ac0e006016745e5305b31dc0c7767fTinderbox User-->
3cc98b8ecedcbc8465f1cf2740b966b315662430Automatic Updater
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<!-- $Id: nsupdate.docbook,v 1.21 2005/05/13 01:35:41 marka Exp $ -->
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<refentry>
e20309353e6246485c521278131d3fced73d7957Tinderbox User <refentryinfo>
e20309353e6246485c521278131d3fced73d7957Tinderbox User <date>Jun 30, 2000</date>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews </refentryinfo>
df4ebd8217d02dafc12145b55c4d93d0255d1ec7Tinderbox User <refmeta>
efb0e886f18894a1d2489f1ad74ad14b579e11c7Mark Andrews <refentrytitle>nsupdate</refentrytitle>
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater <manvolnum>8</manvolnum>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <refmiscinfo>BIND9</refmiscinfo>
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater </refmeta>
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater <refnamediv>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <refname>nsupdate</refname>
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater <refpurpose>Dynamic DNS update utility</refpurpose>
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User </refnamediv>
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt <docinfo>
e130ab53e992670e2a2ecf043976ac09f21358d1Automatic Updater <copyright>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <year>2004</year>
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt <year>2005</year>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
24934f08b9ff81c2be711e566e8002d145573031Tinderbox User </copyright>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <copyright>
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt <year>2000</year>
24934f08b9ff81c2be711e566e8002d145573031Tinderbox User <year>2001</year>
e9e4257668ff6c4e583b0c0db2508650b0b677b8Tinderbox User <year>2002</year>
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt <year>2003</year>
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User <holder>Internet Software Consortium.</holder>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater </copyright>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater </docinfo>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater <refsynopsisdiv>
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater <cmdsynopsis>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <command>nsupdate</command>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <arg><option>-d</option></arg>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <group>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <arg><option>-y <replaceable class="parameter">keyname:secret</replaceable></option></arg>
eabc9c3c07cd956d3c436bd7614cb162dabdda76Mark Andrews <arg><option>-k <replaceable class="parameter">keyfile</replaceable></option></arg>
eabc9c3c07cd956d3c436bd7614cb162dabdda76Mark Andrews </group>
eabc9c3c07cd956d3c436bd7614cb162dabdda76Mark Andrews <arg><option>-t <replaceable class="parameter">timeout</replaceable></option></arg>
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User <arg><option>-u <replaceable class="parameter">udptimeout</replaceable></option></arg>
e20309353e6246485c521278131d3fced73d7957Tinderbox User <arg><option>-r <replaceable class="parameter">udpretries</replaceable></option></arg>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <arg><option>-v</option></arg>
24934f08b9ff81c2be711e566e8002d145573031Tinderbox User <arg>filename</arg>
e20309353e6246485c521278131d3fced73d7957Tinderbox User </cmdsynopsis>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews </refsynopsisdiv>
7feccf248d2a20a2ae48b290f58ded5abc853e9aTinderbox User
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <refsect1>
c59750de3ea3c7d5890000fb4606e8f5835a52aaTinderbox User <title>DESCRIPTION</title>
80faf1588895fd26490f82f95a7a1b771df1c324Automatic Updater <para><command>nsupdate</command>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews is used to submit Dynamic DNS Update requests as defined in RFC2136
ec7751119a08c6a7250f3187beed69a8b836d349Tinderbox User to a name server.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews This allows resource records to be added or removed from a zone
114f7780384371121918624ae2c80ecfce545683Tinderbox User without manually editing the zone file.
693c4232dfdffaff672197d4b9fea944c64cf80aAutomatic Updater A single update request can contain requests to add or remove more than
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews one
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater resource record.
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson </para>
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater <para>
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater Zones that are under dynamic control via
efb0e886f18894a1d2489f1ad74ad14b579e11c7Mark Andrews <command>nsupdate</command>
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater or a DHCP server should not be edited by hand.
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson Manual edits could
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater conflict with dynamic updates and cause data to be lost.
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater </para>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <para>
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater The resource records that are dynamically added or removed with
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User <command>nsupdate</command>
b871c7156eb037d41f53828c6fcb9cc876128962Mark Andrews have to be in the same zone.
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews Requests are sent to the zone's master server.
3349f0044fda807e1fd6681c833d3593a22dad86Tinderbox User This is identified by the MNAME field of the zone's SOA record.
3349f0044fda807e1fd6681c833d3593a22dad86Tinderbox User </para>
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews <para>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont The
3349f0044fda807e1fd6681c833d3593a22dad86Tinderbox User <option>-d</option>
3349f0044fda807e1fd6681c833d3593a22dad86Tinderbox User option makes
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont <command>nsupdate</command>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews operate in debug mode.
2ba8f584b97cbab864570e38fd26b8cb90961428Tinderbox User This provides tracing information about the update requests that are
3349f0044fda807e1fd6681c833d3593a22dad86Tinderbox User made and the replies received from the name server.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews </para>
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews <para>
bed0874e1a09e810575328c4bfc346a47514b69fMark Andrews Transaction signatures can be used to authenticate the Dynamic DNS
24bf1e02f03577db0feb50b80238c4150c96d05dAutomatic Updater updates.
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews These use the TSIG resource record type described in RFC2845 or the
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews SIG(0) record described in RFC3535 and RFC2931.
2ba8f584b97cbab864570e38fd26b8cb90961428Tinderbox User TSIG relies on a shared secret that should only be known to
a308b69ac66fadf66863484f301314d6e6a3f1d2Automatic Updater <command>nsupdate</command> and the name server.
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews Currently, the only supported encryption algorithm for TSIG is
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews HMAC-MD5, which is defined in RFC 2104.
551271d8198ae06e37edf5da519d8ee153eeac0fTinderbox User Once other algorithms are defined for TSIG, applications will need to
27c3c21f41520e8d6336d80a8094389e321cb6d2Mark Andrews ensure they select the appropriate algorithm as well as the key when
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews authenticating each other.
b871c7156eb037d41f53828c6fcb9cc876128962Mark Andrews For instance suitable
b871c7156eb037d41f53828c6fcb9cc876128962Mark Andrews <type>key</type>
b871c7156eb037d41f53828c6fcb9cc876128962Mark Andrews and
01a5c5503482fb3ba52088bf0178a7213273bf96Mark Andrews <type>server</type>
551271d8198ae06e37edf5da519d8ee153eeac0fTinderbox User statements would be added to
b871c7156eb037d41f53828c6fcb9cc876128962Mark Andrews <filename>/etc/named.conf</filename>
df4ebd8217d02dafc12145b55c4d93d0255d1ec7Tinderbox User so that the name server can associate the appropriate secret key
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater and algorithm with the IP address of the
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater client application that will be using TSIG authentication.
fe80a4909bf62b602feaf246866e9d29f7654194Automatic Updater SIG(0) uses public key cryptography. To use a SIG(0) key, the public
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater key must be stored in a KEY record in a zone served by the name server.
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater <command>nsupdate</command>
fe80a4909bf62b602feaf246866e9d29f7654194Automatic Updater does not read
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater <filename>/etc/named.conf</filename>.
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater </para>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <para><command>nsupdate</command>
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater uses the <option>-y</option> or <option>-k</option>
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews option (with an HMAC-MD5 key) to provide the shared secret needed to
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson generate
dd65eb1efb40b1c47d57963192bfc54873b219beAutomatic Updater a TSIG record for authenticating Dynamic DNS update requests.
dd65eb1efb40b1c47d57963192bfc54873b219beAutomatic Updater These options are mutually exclusive.
dd65eb1efb40b1c47d57963192bfc54873b219beAutomatic Updater With the
133e6d43fa82e80d3798be4de00f4540f485ec6cAutomatic Updater <option>-k</option>
133e6d43fa82e80d3798be4de00f4540f485ec6cAutomatic Updater option,
133e6d43fa82e80d3798be4de00f4540f485ec6cAutomatic Updater <command>nsupdate</command>
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater reads the shared secret from the file
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <parameter>keyfile</parameter>,
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater whose name is of the form
5f7586ddbd3edd11272cdd30ed613d936129328bTinderbox User <filename>K{name}.+157.+{random}.private</filename>.
5f7586ddbd3edd11272cdd30ed613d936129328bTinderbox User For historical
5f7586ddbd3edd11272cdd30ed613d936129328bTinderbox User reasons, the file
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User <filename>K{name}.+157.+{random}.key</filename>
8e5fce1f9ceba17dd7e3ff0eb287e1e999c14249Mark Andrews must also be present. When the
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User <option>-y</option>
c7ef13f6c9ef4436bc804b150e0a93307b11fa27Tinderbox User option is used, a signature is generated from
c7ef13f6c9ef4436bc804b150e0a93307b11fa27Tinderbox User <parameter>keyname:secret.</parameter>
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User <parameter>keyname</parameter>
f132a836c4e386b1af045dd8fe7106ae61b90bffAutomatic Updater is the name of the key,
d642d3857129678797a01adee14fbd70335b05a9Mark Andrews and
609b8d08176469485edce25f3c2f50365bbd3819Mark Andrews <parameter>secret</parameter>
609b8d08176469485edce25f3c2f50365bbd3819Mark Andrews is the base64 encoded shared secret.
5f33078b538b3d317917deb962bd057b2a888db1Tinderbox User Use of the
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User <option>-y</option>
8e5fce1f9ceba17dd7e3ff0eb287e1e999c14249Mark Andrews option is discouraged because the shared secret is supplied as a command
269519eeb959d905ed125f96426e01d725c3b597Tinderbox User line argument in clear text.
8711e5c73ca872d59810760af0332194cbdd619bAutomatic Updater This may be visible in the output from
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <citerefentry>
91d187ce035f39073f0732ff2a401a45c3c955fbMark Andrews <refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum>
91d187ce035f39073f0732ff2a401a45c3c955fbMark Andrews </citerefentry>
8f2c45a35dd8c40bcc9caba8f7d40ce64fc27bcdAutomatic Updater or in a history file maintained by the user's shell.
8e5fce1f9ceba17dd7e3ff0eb287e1e999c14249Mark Andrews </para>
6a9d2121152c94cb9e35832126c3f2e4d18d81edTinderbox User <para>
91d187ce035f39073f0732ff2a401a45c3c955fbMark Andrews The <option>-k</option> may also be used to specify a SIG(0) key used
91d187ce035f39073f0732ff2a401a45c3c955fbMark Andrews to authenticate Dynamic DNS update requests. In this case, the key
bc0a53583d92309bebcf93c408e2f3247ebd3d3cAutomatic Updater specified is not an HMAC-MD5 key.
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater </para>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <para>
59528addd704f8d5757b54e540520f74e588a7c7Automatic Updater By default
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <command>nsupdate</command>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater uses UDP to send update requests to the name server unless they are too
7f79131f9a8e804b93c57f3c679065cce878b726Automatic Updater large to fit in a UDP request in which case TCP will be used.
59528addd704f8d5757b54e540520f74e588a7c7Automatic Updater The
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <option>-v</option>
609b8d08176469485edce25f3c2f50365bbd3819Mark Andrews option makes
609b8d08176469485edce25f3c2f50365bbd3819Mark Andrews <command>nsupdate</command>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater use a TCP connection.
19b3dc94bce93fa76bd7e066f9298630dbc9dcb4Automatic Updater This may be preferable when a batch of update requests is made.
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater </para>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <para>
7f94d9a8162c9a96b56e66176702b66e79d8e1a2Automatic Updater The <option>-t</option> option sets the maximum time a update request
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater can
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater take before it is aborted. The default is 300 seconds. Zero can be
5ecad47f69b3fd945472ab2900a9ff826a7ce2f6Automatic Updater used
8e5fce1f9ceba17dd7e3ff0eb287e1e999c14249Mark Andrews to disable the timeout.
91d187ce035f39073f0732ff2a401a45c3c955fbMark Andrews </para>
6a9d2121152c94cb9e35832126c3f2e4d18d81edTinderbox User <para>
6a9d2121152c94cb9e35832126c3f2e4d18d81edTinderbox User The <option>-u</option> option sets the UDP retry interval. The default
7262eb86f2b465822206122921e2f357218f0cfdAutomatic Updater is
96ea71632887c58a9d00f47eb318bf76b35903c3Mark Andrews 3 seconds. If zero the interval will be computed from the timeout
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater interval
9cd5eb6fe0f26d65724b99216cb31dcdd12e4afdAutomatic Updater and number of UDP retries.
bbb069be941f649228760edcc241122933c066d2Automatic Updater </para>
9cd5eb6fe0f26d65724b99216cb31dcdd12e4afdAutomatic Updater <para>
4cda4fd158d6ded5586bacea8c388445d99611eaAutomatic Updater The <option>-r</option> option sets the number of UDP retries. The
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews default is
91d187ce035f39073f0732ff2a401a45c3c955fbMark Andrews 3. If zero only one update request will be made.
80faf1588895fd26490f82f95a7a1b771df1c324Automatic Updater </para>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews </refsect1>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater
6a9d2121152c94cb9e35832126c3f2e4d18d81edTinderbox User <refsect1>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <title>INPUT FORMAT</title>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <para><command>nsupdate</command>
27c3c21f41520e8d6336d80a8094389e321cb6d2Mark Andrews reads input from
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <parameter>filename</parameter>
551271d8198ae06e37edf5da519d8ee153eeac0fTinderbox User or standard input.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews Each command is supplied on exactly one line of input.
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater Some commands are for administrative purposes.
bbc0e1c4f47f101c4a64db3469352c49a49e734fTinderbox User The others are either update instructions or prerequisite checks on the
f751b1576ee6fef4023bf7101d10167e4fe520f3Tinderbox User contents of the zone.
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater These checks set conditions that some name or set of
a792d42c3cdd6cd4608b936c0a06437b8c2d99ccTinderbox User resource records (RRset) either exists or is absent from the zone.
da59e63e7af147a8bcef985b98b04443e04c3a0eTinderbox User These conditions must be met if the entire update request is to succeed.
da59e63e7af147a8bcef985b98b04443e04c3a0eTinderbox User Updates will be rejected if the tests for the prerequisite conditions
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User fail.
dc5552b4df5e3821783821c8d4e734c1608c446eTinderbox User </para>
cf7e98f59148b559946a7f1ca728471374f1eef3Automatic Updater <para>
930f6069e5aa157cf6987cdafd412f5757a5a558Automatic Updater Every update request consists of zero or more prerequisites
27c3c21f41520e8d6336d80a8094389e321cb6d2Mark Andrews and zero or more updates.
dc5552b4df5e3821783821c8d4e734c1608c446eTinderbox User This allows a suitably authenticated update request to proceed if some
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater specified resource records are present or missing from the zone.
cf7e98f59148b559946a7f1ca728471374f1eef3Automatic Updater A blank input line (or the <command>send</command> command)
c3fd32ed29e9e419bb56583f4272a506773b1ea0Automatic Updater causes the
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson accumulated commands to be sent as one Dynamic DNS update request to the
c3fd32ed29e9e419bb56583f4272a506773b1ea0Automatic Updater name server.
c3fd32ed29e9e419bb56583f4272a506773b1ea0Automatic Updater </para>
a382ca49c874d38ad3ac8995b49f9f27128e4ca9Automatic Updater <para>
fe600c3ad88c0bb078283a953d048087d227c0e5Tinderbox User The command formats and their meaning are as follows:
bbc0e1c4f47f101c4a64db3469352c49a49e734fTinderbox User <variablelist>
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User
e20309353e6246485c521278131d3fced73d7957Tinderbox User <varlistentry>
3857cb6fcabeb79d85de4b3e3e4ab99912b701f8Mark Andrews <term><cmdsynopsis>
d642d3857129678797a01adee14fbd70335b05a9Mark Andrews <command>server</command>
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User <arg choice="req">servername</arg>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <arg choice="opt">port</arg>
9174e44c14b1cb91a651fa1dc29470438c246ab9Automatic Updater </cmdsynopsis></term>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <listitem>
e2caa7536302de34de6cc04025abcd53dc3a499aAutomatic Updater <para>
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User Sends all dynamic update requests to the name server
8292deab031e7599cd7622aa7675fbe139ca6095Mark Andrews <parameter>servername</parameter>.
0b57424d28c9a67018107133f9fbc0a7dcf057e2Mark Andrews When no server statement is provided,
0b57424d28c9a67018107133f9fbc0a7dcf057e2Mark Andrews <command>nsupdate</command>
0b57424d28c9a67018107133f9fbc0a7dcf057e2Mark Andrews will send updates to the master server of the correct zone.
e31cfd80616deb9781902306b34a69aa7309b6cbTinderbox User The MNAME field of that zone's SOA record will identify the
e31cfd80616deb9781902306b34a69aa7309b6cbTinderbox User master
e31cfd80616deb9781902306b34a69aa7309b6cbTinderbox User server for that zone.
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews <parameter>port</parameter>
b109432c3a939bff66a463be86c371bd88efe3aaAutomatic Updater is the port number on
7d12a6b412fe47e6d6582923fd6954ab8cd0baebAutomatic Updater <parameter>servername</parameter>
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews where the dynamic update requests get sent.
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews If no port number is specified, the default DNS port number of
3351ccbd5c1961404044f8273d54dad405f53960Mark Andrews 53 is
7d12a6b412fe47e6d6582923fd6954ab8cd0baebAutomatic Updater used.
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews </para>
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews </listitem>
3351ccbd5c1961404044f8273d54dad405f53960Mark Andrews </varlistentry>
7d12a6b412fe47e6d6582923fd6954ab8cd0baebAutomatic Updater
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews <varlistentry>
0b57424d28c9a67018107133f9fbc0a7dcf057e2Mark Andrews <term><cmdsynopsis>
7d12a6b412fe47e6d6582923fd6954ab8cd0baebAutomatic Updater <command>local</command>
0b57424d28c9a67018107133f9fbc0a7dcf057e2Mark Andrews <arg choice="req">address</arg>
e8fc8c884b44371784805e1e0d3100da403dd3f1Automatic Updater <arg choice="opt">port</arg>
e8fc8c884b44371784805e1e0d3100da403dd3f1Automatic Updater </cmdsynopsis></term>
e8fc8c884b44371784805e1e0d3100da403dd3f1Automatic Updater <listitem>
e8fc8c884b44371784805e1e0d3100da403dd3f1Automatic Updater <para>
e8fc8c884b44371784805e1e0d3100da403dd3f1Automatic Updater Sends all dynamic update requests using the local
e8fc8c884b44371784805e1e0d3100da403dd3f1Automatic Updater <parameter>address</parameter>.
e8fc8c884b44371784805e1e0d3100da403dd3f1Automatic Updater
e8fc8c884b44371784805e1e0d3100da403dd3f1Automatic Updater When no local statement is provided,
e8fc8c884b44371784805e1e0d3100da403dd3f1Automatic Updater <command>nsupdate</command>
7d12a6b412fe47e6d6582923fd6954ab8cd0baebAutomatic Updater will send updates using an address and port chosen by the
b30ec46fec40a1b246f7965fbcd341fc6cfd1cc1Mark Andrews system.
82a986aaa5d3384a541b5a7d6dae8cf0726d6513Tinderbox User <parameter>port</parameter>
82a986aaa5d3384a541b5a7d6dae8cf0726d6513Tinderbox User can additionally be used to make requests come from a specific
c7ef13f6c9ef4436bc804b150e0a93307b11fa27Tinderbox User port.
01a5c5503482fb3ba52088bf0178a7213273bf96Mark Andrews If no port number is specified, the system will assign one.
82a986aaa5d3384a541b5a7d6dae8cf0726d6513Tinderbox User </para>
dc435f1033bcba88b748074987db6cfd34c057a4Tinderbox User </listitem>
b30ec46fec40a1b246f7965fbcd341fc6cfd1cc1Mark Andrews </varlistentry>
dc435f1033bcba88b748074987db6cfd34c057a4Tinderbox User
b30ec46fec40a1b246f7965fbcd341fc6cfd1cc1Mark Andrews <varlistentry>
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User <term><cmdsynopsis>
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User <command>zone</command>
59528addd704f8d5757b54e540520f74e588a7c7Automatic Updater <arg choice="req">zonename</arg>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews </cmdsynopsis></term>
e9e4257668ff6c4e583b0c0db2508650b0b677b8Tinderbox User <listitem>
e9e4257668ff6c4e583b0c0db2508650b0b677b8Tinderbox User <para>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews Specifies that all updates are to be made to the zone
e9e4257668ff6c4e583b0c0db2508650b0b677b8Tinderbox User <parameter>zonename</parameter>.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews If no
e9e4257668ff6c4e583b0c0db2508650b0b677b8Tinderbox User <parameter>zone</parameter>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews statement is provided,
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <command>nsupdate</command>
7f79131f9a8e804b93c57f3c679065cce878b726Automatic Updater will attempt determine the correct zone to update based on the
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater rest of the input.
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson </para>
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater </listitem>
efb0e886f18894a1d2489f1ad74ad14b579e11c7Mark Andrews </varlistentry>
efb0e886f18894a1d2489f1ad74ad14b579e11c7Mark Andrews
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User <varlistentry>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <term><cmdsynopsis>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <command>class</command>
e20309353e6246485c521278131d3fced73d7957Tinderbox User <arg choice="req">classname</arg>
91d187ce035f39073f0732ff2a401a45c3c955fbMark Andrews </cmdsynopsis></term>
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User <listitem>
b13d89bd89878137c81b36a36596cca3920f27a4Automatic Updater <para>
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User Specify the default class.
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User If no <parameter>class</parameter> is specified the
9cd5eb6fe0f26d65724b99216cb31dcdd12e4afdAutomatic Updater default class is
a5636b773fa05a272b6876afd99309c0b3090e2fMark Andrews <parameter>IN</parameter>.
a5636b773fa05a272b6876afd99309c0b3090e2fMark Andrews </para>
a5636b773fa05a272b6876afd99309c0b3090e2fMark Andrews </listitem>
a5636b773fa05a272b6876afd99309c0b3090e2fMark Andrews </varlistentry>
a5636b773fa05a272b6876afd99309c0b3090e2fMark Andrews
f7369b2881b5e63d69600adcedc8ba938303d30cTinderbox User <varlistentry>
f7369b2881b5e63d69600adcedc8ba938303d30cTinderbox User <term><cmdsynopsis>
d6317350b1180aa4517f2e8a92fa8fbcbf904ad8Automatic Updater <command>key</command>
bc0a4c01beede169df81a3ee5b614ed9e82339dbAutomatic Updater <arg choice="req">name</arg>
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User <arg choice="req">secret</arg>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </cmdsynopsis></term>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <listitem>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <para>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington Specifies that all updates are to be TSIG signed using the
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <parameter>keyname</parameter> <parameter>keysecret</parameter> pair.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington The <command>key</command> command
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington overrides any key specified on the command line via
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <option>-y</option> or <option>-k</option>.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </para>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </listitem>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </varlistentry>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <varlistentry>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <term><cmdsynopsis>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <command>prereq nxdomain</command>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <arg choice="req">domain-name</arg>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </cmdsynopsis></term>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <listitem>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <para>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington Requires that no resource record of any type exists with name
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <parameter>domain-name</parameter>.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </para>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </listitem>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </varlistentry>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <varlistentry>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <term><cmdsynopsis>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <command>prereq yxdomain</command>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <arg choice="req">domain-name</arg>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </cmdsynopsis></term>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <listitem>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <para>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington Requires that
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <parameter>domain-name</parameter>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington exists (has as at least one resource record, of any type).
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </para>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </listitem>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </varlistentry>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <varlistentry>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <term><cmdsynopsis>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <command>prereq nxrrset</command>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <arg choice="req">domain-name</arg>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <arg choice="opt">class</arg>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <arg choice="req">type</arg>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </cmdsynopsis></term>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <listitem>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <para>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington Requires that no resource record exists of the specified
da59e63e7af147a8bcef985b98b04443e04c3a0eTinderbox User <parameter>type</parameter>,
22d32791e5daa0bc80335a0f10ab2de95f41ccdbTinderbox User <parameter>class</parameter>
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater and
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater <parameter>domain-name</parameter>.
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater If
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater <parameter>class</parameter>
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater is omitted, IN (internet) is assumed.
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater </para>
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User </listitem>
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater </varlistentry>
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater <varlistentry>
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater <term><cmdsynopsis>
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater <command>prereq yxrrset</command>
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater <arg choice="req">domain-name</arg>
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater <arg choice="opt">class</arg>
b30ec46fec40a1b246f7965fbcd341fc6cfd1cc1Mark Andrews <arg choice="req">type</arg>
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox User </cmdsynopsis></term>
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox User <listitem>
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox User <para>
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox User This requires that a resource record of the specified
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox User <parameter>type</parameter>,
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox User <parameter>class</parameter>
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox User and
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox User <parameter>domain-name</parameter>
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox User must exist.
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox User If
02b47c5d62e1e827743684c28a08e871da454a2dMark Andrews <parameter>class</parameter>
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox User is omitted, IN (internet) is assumed.
da59e63e7af147a8bcef985b98b04443e04c3a0eTinderbox User </para>
099b86fb8136a7dff81df85cf395978c16eb254cAutomatic Updater </listitem>
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox User </varlistentry>
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox User
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox User <varlistentry>
c11c7b47726c02eb05e29ff7be56a3343146e396Tinderbox User <term><cmdsynopsis>
e10d61d84e0b735f1e8eca18644cfdb1b06cad33Tinderbox User <command>prereq yxrrset</command>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <arg choice="req">domain-name</arg>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <arg choice="opt">class</arg>
febbdb34a7f7759922e239655e7429d78d3a8d26Tinderbox User <arg choice="req">type</arg>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <arg choice="req" rep="repeat">data</arg>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater </cmdsynopsis></term>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <listitem>
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User <para>
e01f44b37ba11c9d34f4a8394f950efae5c07f33Automatic Updater The
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User <parameter>data</parameter>
c01dec514a81ecf8c17ca3ef8c3ba95e437295ebAutomatic Updater from each set of prerequisites of this form
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater sharing a common
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <parameter>type</parameter>,
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <parameter>class</parameter>,
3de6db3208d51de1e138b63b9670430c03f99694Automatic Updater and
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <parameter>domain-name</parameter>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater are combined to form a set of RRs. This set of RRs must
e20309353e6246485c521278131d3fced73d7957Tinderbox User exactly match the set of RRs existing in the zone at the
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User given
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <parameter>type</parameter>,
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <parameter>class</parameter>,
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington and
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <parameter>domain-name</parameter>.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington The
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <parameter>data</parameter>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington are written in the standard text representation of the resource
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington record's
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington RDATA.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </para>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </listitem>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </varlistentry>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <varlistentry>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <term><cmdsynopsis>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <command>update delete</command>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <arg choice="req">domain-name</arg>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <arg choice="opt">ttl</arg>
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews <arg choice="opt">class</arg>
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews <arg choice="opt">type <arg choice="opt" rep="repeat">data</arg></arg>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </cmdsynopsis></term>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <listitem>
e130ab53e992670e2a2ecf043976ac09f21358d1Automatic Updater <para>
9cd5eb6fe0f26d65724b99216cb31dcdd12e4afdAutomatic Updater Deletes any resource records named
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User <parameter>domain-name</parameter>.
a26b22914b7bf25f065afb8cdef983766dcd672bAutomatic Updater If
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <parameter>type</parameter>
9cd5eb6fe0f26d65724b99216cb31dcdd12e4afdAutomatic Updater and
79cea03ba823e2d3a34895f0ba91d7fb5ad799e7Automatic Updater <parameter>data</parameter>
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User is provided, only matching resource records will be removed.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington The internet class is assumed if
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews <parameter>class</parameter>
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews is not supplied. The
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <parameter>ttl</parameter>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington is ignored, and is only allowed for compatibility.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </para>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </listitem>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </varlistentry>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <varlistentry>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <term><cmdsynopsis>
b7aab05edae933e169d5f83c653935b17c7f0a8bMark Andrews <command>update add</command>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <arg choice="req">domain-name</arg>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <arg choice="req">ttl</arg>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <arg choice="opt">class</arg>
409ba95e573b40cf36acf97dd62ee7e9c7775851Tinderbox User <arg choice="req">type</arg>
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews <arg choice="req" rep="repeat">data</arg>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </cmdsynopsis></term>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <listitem>
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews <para>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington Adds a new resource record with the specified
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <parameter>ttl</parameter>,
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <parameter>class</parameter>
7d704e522860496310bb29c28e76064868401a9cMark Andrews and
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <parameter>data</parameter>.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </para>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </listitem>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </varlistentry>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <varlistentry>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <term><cmdsynopsis>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <command>show</command>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </cmdsynopsis></term>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <listitem>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <para>
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User Displays the current message, containing all of the
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater prerequisites and
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater updates specified since the last send.
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater </para>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater </listitem>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater </varlistentry>
56effd2e3f579fd77b1fb37d47871d1bf1286bc4Automatic Updater
42bee07ebb8152a6ec2f87f4790d87368c24704cAutomatic Updater <varlistentry>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <term><cmdsynopsis>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <command>send</command>
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User </cmdsynopsis></term>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <listitem>
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews <para>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington Sends the current message. This is equivalent to entering a
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews blank line.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </para>
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews </listitem>
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews </varlistentry>
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews <varlistentry>
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews <term><cmdsynopsis>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <command>answer</command>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </cmdsynopsis></term>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <listitem>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <para>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington Displays the answer.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </para>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </listitem>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </varlistentry>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </variablelist>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </para>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington
409ba95e573b40cf36acf97dd62ee7e9c7775851Tinderbox User <para>
89623368b8f662d458d9964b923050f33c5f75b0Tinderbox User Lines beginning with a semicolon are comments and are ignored.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington </para>
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User
febbdb34a7f7759922e239655e7429d78d3a8d26Tinderbox User </refsect1>
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User <refsect1>
91d187ce035f39073f0732ff2a401a45c3c955fbMark Andrews <title>EXAMPLES</title>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <para>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater The examples below show how
22d32791e5daa0bc80335a0f10ab2de95f41ccdbTinderbox User <command>nsupdate</command>
da59e63e7af147a8bcef985b98b04443e04c3a0eTinderbox User could be used to insert and delete resource records from the
22d32791e5daa0bc80335a0f10ab2de95f41ccdbTinderbox User <type>example.com</type>
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User zone.
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater Notice that the input in each example contains a trailing blank line so
1fdd58445074579ee3b65c871137a7a1740eb542Mark Andrews that
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User a group of commands are sent as one dynamic update request to the
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User master name server for
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User <type>example.com</type>.
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User
cc5a9ce75af9870f2cb9e2bf00548c2f7e6398d6Automatic Updater <programlisting>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater# nsupdate
ec8755f605d7dcb2de1076040e77bc2d7ec33b4aTinderbox User&gt; update delete oldhost.example.com A
8e5fce1f9ceba17dd7e3ff0eb287e1e999c14249Mark Andrews&gt; update add newhost.example.com 86400 A 172.16.1.1
609b8d08176469485edce25f3c2f50365bbd3819Mark Andrews&gt; send
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User</programlisting>
532d27b39244fadfcf8d8b4593f4c65434c9c664Automatic Updater </para>
532d27b39244fadfcf8d8b4593f4c65434c9c664Automatic Updater <para>
532d27b39244fadfcf8d8b4593f4c65434c9c664Automatic Updater Any A records for
532d27b39244fadfcf8d8b4593f4c65434c9c664Automatic Updater <type>oldhost.example.com</type>
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User are deleted.
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User and an A record for
10702d681eb650391bcaa0e2704aa3cf2dbf0e98Mark Andrews <type>newhost.example.com</type>
10702d681eb650391bcaa0e2704aa3cf2dbf0e98Mark Andrews it IP address 172.16.1.1 is added.
10702d681eb650391bcaa0e2704aa3cf2dbf0e98Mark Andrews The newly-added record has a 1 day TTL (86400 seconds)
10702d681eb650391bcaa0e2704aa3cf2dbf0e98Mark Andrews <programlisting>
10702d681eb650391bcaa0e2704aa3cf2dbf0e98Mark Andrews# nsupdate
10702d681eb650391bcaa0e2704aa3cf2dbf0e98Mark Andrews&gt; prereq nxdomain nickname.example.com
10702d681eb650391bcaa0e2704aa3cf2dbf0e98Mark Andrews&gt; update add nickname.example.com 86400 CNAME somehost.example.com
10702d681eb650391bcaa0e2704aa3cf2dbf0e98Mark Andrews&gt; send
10702d681eb650391bcaa0e2704aa3cf2dbf0e98Mark Andrews</programlisting>
10702d681eb650391bcaa0e2704aa3cf2dbf0e98Mark Andrews </para>
10702d681eb650391bcaa0e2704aa3cf2dbf0e98Mark Andrews <para>
93089a352d6903b0d7845a039de4ec2df9a0e35aTinderbox User The prerequisite condition gets the name server to check that there
93089a352d6903b0d7845a039de4ec2df9a0e35aTinderbox User are no resource records of any type for
93089a352d6903b0d7845a039de4ec2df9a0e35aTinderbox User <type>nickname.example.com</type>.
861836e5f5df62bfaea9ad8923a05278d5ab2f3dTinderbox User
e8c17c74535be290abaaa160a434ed80bf0ad2feMark Andrews If there are, the update request fails.
93089a352d6903b0d7845a039de4ec2df9a0e35aTinderbox User If this name does not exist, a CNAME for it is added.
665ba746c0585088d0c314dcfc4671aa2c7b2dc1Automatic Updater This ensures that when the CNAME is added, it cannot conflict with the
9c446b72069d0ab9f710502f4d7048e50875fccbAutomatic Updater long-standing rule in RFC1034 that a name must not exist as any other
665ba746c0585088d0c314dcfc4671aa2c7b2dc1Automatic Updater record type if it exists as a CNAME.
665ba746c0585088d0c314dcfc4671aa2c7b2dc1Automatic Updater (The rule has been updated for DNSSEC in RFC2535 to allow CNAMEs to have
93089a352d6903b0d7845a039de4ec2df9a0e35aTinderbox User RRSIG, DNSKEY and NSEC records.)
93089a352d6903b0d7845a039de4ec2df9a0e35aTinderbox User </para>
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User </refsect1>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater <refsect1>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater <title>FILES</title>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater <variablelist>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater <varlistentry>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater <term><constant>/etc/resolv.conf</constant></term>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater <listitem>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater <para>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater used to identify default name server
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater </para>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater </listitem>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater </varlistentry>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater <varlistentry>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater <term><constant>K{name}.+157.+{random}.key</constant></term>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater <listitem>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater <para>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater base-64 encoding of HMAC-MD5 key created by
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater <citerefentry>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater </citerefentry>.
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater </para>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater </listitem>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater </varlistentry>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater <varlistentry>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater <term><constant>K{name}.+157.+{random}.private</constant></term>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater <listitem>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater <para>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater base-64 encoding of HMAC-MD5 key created by
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater <citerefentry>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater </citerefentry>.
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater </para>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater </listitem>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater </varlistentry>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater </variablelist>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater </refsect1>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater
bbc0e1c4f47f101c4a64db3469352c49a49e734fTinderbox User <refsect1>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater <title>SEE ALSO</title>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater <para><citerefentry>
44e3b272904bfd85556771d30cf1bc6fa539dd03Automatic Updater <refentrytitle>RFC2136</refentrytitle>
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User </citerefentry>,
bbc0e1c4f47f101c4a64db3469352c49a49e734fTinderbox User <citerefentry>
fe84edc17e0d582cf7b4270f8df9d4742a107b1cAutomatic Updater <refentrytitle>RFC3007</refentrytitle>
a382ca49c874d38ad3ac8995b49f9f27128e4ca9Automatic Updater </citerefentry>,
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User <citerefentry>
e9e4257668ff6c4e583b0c0db2508650b0b677b8Tinderbox User <refentrytitle>RFC2104</refentrytitle>
ff8ec39ce4afc2d774ce99f2386474d2c8539cd4Automatic Updater </citerefentry>,
bf8c3776f1bf1a1270e5e0443ae5a8df022632a8Mark Andrews <citerefentry>
bf8c3776f1bf1a1270e5e0443ae5a8df022632a8Mark Andrews <refentrytitle>RFC2845</refentrytitle>
bf8c3776f1bf1a1270e5e0443ae5a8df022632a8Mark Andrews </citerefentry>,
bf8c3776f1bf1a1270e5e0443ae5a8df022632a8Mark Andrews <citerefentry>
ff8ec39ce4afc2d774ce99f2386474d2c8539cd4Automatic Updater <refentrytitle>RFC1034</refentrytitle>
31a540386a9abaf681d8952f1b2cdf5c75a0ba6cAutomatic Updater </citerefentry>,
31a540386a9abaf681d8952f1b2cdf5c75a0ba6cAutomatic Updater <citerefentry>
31a540386a9abaf681d8952f1b2cdf5c75a0ba6cAutomatic Updater <refentrytitle>RFC2535</refentrytitle>
ff8ec39ce4afc2d774ce99f2386474d2c8539cd4Automatic Updater </citerefentry>,
31a540386a9abaf681d8952f1b2cdf5c75a0ba6cAutomatic Updater <citerefentry>
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User <refentrytitle>RFC2931</refentrytitle>
e9e4257668ff6c4e583b0c0db2508650b0b677b8Tinderbox User </citerefentry>,
31a540386a9abaf681d8952f1b2cdf5c75a0ba6cAutomatic Updater <citerefentry>
ec8755f605d7dcb2de1076040e77bc2d7ec33b4aTinderbox User <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
4ea3649f028ea6a1e42377082a7ccf8f789fb950Automatic Updater </citerefentry>,
40072ce70bc4125329addb4aaa56d18a1230bc17Automatic Updater <citerefentry>
60d5d17479b47c03b9c7c86f54269718103750b8Automatic Updater <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
31a540386a9abaf681d8952f1b2cdf5c75a0ba6cAutomatic Updater </citerefentry>.
a382ca49c874d38ad3ac8995b49f9f27128e4ca9Automatic Updater </para>
e9e4257668ff6c4e583b0c0db2508650b0b677b8Tinderbox User
60d5d17479b47c03b9c7c86f54269718103750b8Automatic Updater </refsect1>
ff8ec39ce4afc2d774ce99f2386474d2c8539cd4Automatic Updater <refsect1>
ff8ec39ce4afc2d774ce99f2386474d2c8539cd4Automatic Updater <title>BUGS</title>
31a540386a9abaf681d8952f1b2cdf5c75a0ba6cAutomatic Updater <para>
31a540386a9abaf681d8952f1b2cdf5c75a0ba6cAutomatic Updater The TSIG key is redundantly stored in two separate files.
31a540386a9abaf681d8952f1b2cdf5c75a0ba6cAutomatic Updater This is a consequence of nsupdate using the DST library
ff8ec39ce4afc2d774ce99f2386474d2c8539cd4Automatic Updater for its cryptographic operations, and may change in future
31a540386a9abaf681d8952f1b2cdf5c75a0ba6cAutomatic Updater releases.
31a540386a9abaf681d8952f1b2cdf5c75a0ba6cAutomatic Updater </para>
31a540386a9abaf681d8952f1b2cdf5c75a0ba6cAutomatic Updater </refsect1>
31a540386a9abaf681d8952f1b2cdf5c75a0ba6cAutomatic Updater</refentry><!--
31a540386a9abaf681d8952f1b2cdf5c75a0ba6cAutomatic Updater - Local variables:
ff8ec39ce4afc2d774ce99f2386474d2c8539cd4Automatic Updater - mode: sgml
19dbf2e20df03f2b81ed1f347e27718084374059Automatic Updater - End:
31a540386a9abaf681d8952f1b2cdf5c75a0ba6cAutomatic Updater-->
31a540386a9abaf681d8952f1b2cdf5c75a0ba6cAutomatic Updater