nsupdate.html revision 0c6ada0a814f3c5417daa1654129bc2af56ed504
205c10066a0acfeac52d1a135671f41d207b8557Automatic Updater - Copyright (C) 2004-2008 Internet Systems Consortium, Inc. ("ISC")
205c10066a0acfeac52d1a135671f41d207b8557Automatic Updater - Copyright (C) 2000-2003 Internet Software Consortium.
0c39b3ed9409ecb277d5e32fa763a4e4d6598df8Automatic Updater - Permission to use, copy, modify, and distribute this software for any
46da3117812814a29432a8d9a9ccf8acdbfdadceAutomatic Updater - purpose with or without fee is hereby granted, provided that the above
2bb3422dc683c013db7042f5736240de6b86f182Automatic Updater - copyright notice and this permission notice appear in all copies.
2ec4ab21838e218863d052ebfa3e106e04f50820Evan Hunt - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
ea854b585041ad19f70f7af15e08144ef2c2bd1bMark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
78cb74fab4665da2e2641ba909c6f59f74cc4193Automatic Updater - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
cd0aa2d941d1438fabb5337f1f38c49478edf71dAutomatic Updater - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
90ff38a0d8deaf5f9c2aa5916d99b2e572d28738Automatic Updater - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
ac4e70ff8955669341f435bc0a734a17c01af124Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<!-- $Id: nsupdate.html,v 1.38 2008/06/18 01:12:16 tbox Exp $ -->
56874aef380a64a2c183b7c282c3e7a361d67fa1Automatic Updater<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
58be84825d7f5de30e50eb7206b37227ecd8055bAutomatic Updater<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<a name="man.nsupdate"></a><div class="titlepage"></div>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<p><span class="application">nsupdate</span> — Dynamic DNS update utility</p>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson<div class="cmdsynopsis"><p><code class="command">nsupdate</code> [<code class="option">-d</code>] [[<code class="option">-y <em class="replaceable"><code>[<span class="optional">hmac:</span>]keyname:secret</code></em></code>] | [<code class="option">-k <em class="replaceable"><code>keyfile</code></em></code>]] [<code class="option">-t <em class="replaceable"><code>timeout</code></em></code>] [<code class="option">-u <em class="replaceable"><code>udptimeout</code></em></code>] [<code class="option">-r <em class="replaceable"><code>udpretries</code></em></code>] [<code class="option">-R <em class="replaceable"><code>randomdev</code></em></code>] [<code class="option">-v</code>] [filename]</p></div>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson<a name="id2543433"></a><h2>DESCRIPTION</h2>
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater<p><span><strong class="command">nsupdate</strong></span>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater is used to submit Dynamic DNS Update requests as defined in RFC2136
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater to a name server.
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt This allows resource records to be added or removed from a zone
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater without manually editing the zone file.
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater A single update request can contain requests to add or remove more than
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater resource record.
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt Zones that are under dynamic control via
2d2dc37599979c83495510f8af8d1756753aa2c5Automatic Updater <span><strong class="command">nsupdate</strong></span>
2d2dc37599979c83495510f8af8d1756753aa2c5Automatic Updater or a DHCP server should not be edited by hand.
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt Manual edits could
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater conflict with dynamic updates and cause data to be lost.
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater The resource records that are dynamically added or removed with
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <span><strong class="command">nsupdate</strong></span>
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater have to be in the same zone.
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater Requests are sent to the zone's master server.
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater This is identified by the MNAME field of the zone's SOA record.
eabc9c3c07cd956d3c436bd7614cb162dabdda76Mark Andrews option makes
eabc9c3c07cd956d3c436bd7614cb162dabdda76Mark Andrews <span><strong class="command">nsupdate</strong></span>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington operate in debug mode.
9cd5eb6fe0f26d65724b99216cb31dcdd12e4afdAutomatic Updater This provides tracing information about the update requests that are
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews made and the replies received from the name server.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews Transaction signatures can be used to authenticate the Dynamic DNS
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews These use the TSIG resource record type described in RFC2845 or the
db5b7e2cdf150c46e8242d3e2e3ad3f5c7300258Automatic Updater SIG(0) record described in RFC3535 and RFC2931.
80faf1588895fd26490f82f95a7a1b771df1c324Automatic Updater TSIG relies on a shared secret that should only be known to
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <span><strong class="command">nsupdate</strong></span> and the name server.
1a06700908f5a1d9f4a8d51285a0fd971e2f9117Automatic Updater Currently, the only supported encryption algorithm for TSIG is
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews HMAC-MD5, which is defined in RFC 2104.
db5b7e2cdf150c46e8242d3e2e3ad3f5c7300258Automatic Updater Once other algorithms are defined for TSIG, applications will need to
693c4232dfdffaff672197d4b9fea944c64cf80aAutomatic Updater ensure they select the appropriate algorithm as well as the key when
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews authenticating each other.
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater For instance, suitable
efb0e886f18894a1d2489f1ad74ad14b579e11c7Mark Andrews statements would be added to
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater <code class="filename">/etc/named.conf</code>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson so that the name server can associate the appropriate secret key
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater and algorithm with the IP address of the
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater client application that will be using TSIG authentication.
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson 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.
dd65eb1efb40b1c47d57963192bfc54873b219beAutomatic Updater <span><strong class="command">nsupdate</strong></span>
9174e44c14b1cb91a651fa1dc29470438c246ab9Automatic Updater<p><span><strong class="command">nsupdate</strong></span>
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews uses the <code class="option">-y</code> or <code class="option">-k</code> option
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont to provide the shared secret needed to generate a TSIG record
0c39b3ed9409ecb277d5e32fa763a4e4d6598df8Automatic Updater for authenticating Dynamic DNS update requests, default type
0c39b3ed9409ecb277d5e32fa763a4e4d6598df8Automatic Updater HMAC-MD5. These options are mutually exclusive. With the
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont <code class="option">-k</code> option, <span><strong class="command">nsupdate</strong></span> reads
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews the shared secret from the file <em class="parameter"><code>keyfile</code></em>,
f9119ad8f6114b2255e7545bf5cd187f4db0a89bAutomatic Updater whose name is of the form
9174e44c14b1cb91a651fa1dc29470438c246ab9Automatic Updater <code class="filename">K{name}.+157.+{random}.private</code>. For
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews historical reasons, the file
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews <code class="filename">K{name}.+157.+{random}.key</code> must also be
08e3b6797706a13054bad749dea04e94b514b8e7Automatic Updater present. When the <code class="option">-y</code> option is used, a
dd65eb1efb40b1c47d57963192bfc54873b219beAutomatic Updater signature is generated from
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews [<span class="optional"><em class="parameter"><code>hmac:</code></em></span>]<em class="parameter"><code>keyname:secret.</code></em>
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews <em class="parameter"><code>keyname</code></em> is the name of the key, and
b29e5c56eb74a6de1a84c29879afc90ffc6b1436Automatic Updater <em class="parameter"><code>secret</code></em> is the base64 encoded shared
418cc932318b1d67f88a36904d88d8a5a0a2ba09Automatic Updater secret. Use of the <code class="option">-y</code> option is discouraged
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews because the shared secret is supplied as a command line
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews argument in clear text. This may be visible in the output
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater <span class="citerefentry"><span class="refentrytitle">ps</span>(1)</span> or in a history file maintained by the user's
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater The <code class="option">-k</code> may also be used to specify a SIG(0) key used
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater to authenticate Dynamic DNS update requests. In this case, the key
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater specified is not an HMAC-MD5 key.
fe80a4909bf62b602feaf246866e9d29f7654194Automatic Updater <span><strong class="command">nsupdate</strong></span>
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater uses UDP to send update requests to the name server unless they are too
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater large to fit in a UDP request in which case TCP will be used.
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews option makes
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <span><strong class="command">nsupdate</strong></span>
dd65eb1efb40b1c47d57963192bfc54873b219beAutomatic Updater use a TCP connection.
dd65eb1efb40b1c47d57963192bfc54873b219beAutomatic Updater This may be preferable when a batch of update requests is made.
133e6d43fa82e80d3798be4de00f4540f485ec6cAutomatic Updater The <code class="option">-t</code> option sets the maximum time an update request
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater take before it is aborted. The default is 300 seconds. Zero can be
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater to disable the timeout.
27794bebe2634b5ac374e78972649c79300b876aAutomatic Updater The <code class="option">-u</code> option sets the UDP retry interval. The default
0ce87e5749aabb8eef1e0a37e4bd6e6ffa1d7196Automatic Updater 3 seconds. If zero, the interval will be computed from the timeout
be63e68c516117af6af8850904e46a89c7d4423eAutomatic Updater and number of UDP retries.
f4029eb7463e99df00618de89f0bee5ac062a237Automatic Updater The <code class="option">-r</code> option sets the number of UDP retries. The
d145b64cacc8d9cda51f9924ec70cd4661c3e2cfAutomatic Updater 3. If zero, only one update request will be made.
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater The <code class="option">-R <em class="replaceable"><code>randomdev</code></em></code> option
f4029eb7463e99df00618de89f0bee5ac062a237Automatic Updater specifies a source of randomness. If the operating system
e628576d3b3d91c8954679077f4c208f1e43b433Automatic Updater does not provide a <code class="filename">/dev/random</code> or
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater equivalent device, the default source of randomness is keyboard
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater input. <code class="filename">randomdev</code> specifies the name of
bc0a53583d92309bebcf93c408e2f3247ebd3d3cAutomatic Updater a character device or file containing random data to be used
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater instead of the default. The special value
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <code class="filename">keyboard</code> indicates that keyboard input
59528addd704f8d5757b54e540520f74e588a7c7Automatic Updater should be used. This option may be specified multiple times.
59528addd704f8d5757b54e540520f74e588a7c7Automatic Updater<a name="id2543682"></a><h2>INPUT FORMAT</h2>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater<p><span><strong class="command">nsupdate</strong></span>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater reads input from
c453a50776145e9c1c3fc9c846cfa11f42505081Automatic Updater <em class="parameter"><code>filename</code></em>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater or standard input.
19b3dc94bce93fa76bd7e066f9298630dbc9dcb4Automatic Updater Each command is supplied on exactly one line of input.
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater Some commands are for administrative purposes.
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater The others are either update instructions or prerequisite checks on the
7f94d9a8162c9a96b56e66176702b66e79d8e1a2Automatic Updater contents of the zone.
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater These checks set conditions that some name or set of
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater resource records (RRset) either exists or is absent from the zone.
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater These conditions must be met if the entire update request is to succeed.
59528addd704f8d5757b54e540520f74e588a7c7Automatic Updater Updates will be rejected if the tests for the prerequisite conditions
7262eb86f2b465822206122921e2f357218f0cfdAutomatic Updater Every update request consists of zero or more prerequisites
96ea71632887c58a9d00f47eb318bf76b35903c3Mark Andrews and zero or more updates.
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater This allows a suitably authenticated update request to proceed if some
9cd5eb6fe0f26d65724b99216cb31dcdd12e4afdAutomatic Updater specified resource records are present or missing from the zone.
bbb069be941f649228760edcc241122933c066d2Automatic Updater A blank input line (or the <span><strong class="command">send</strong></span> command)
4cda4fd158d6ded5586bacea8c388445d99611eaAutomatic Updater accumulated commands to be sent as one Dynamic DNS update request to the
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews name server.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews The command formats and their meaning are as follows:
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <span><strong class="command">server</strong></span>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater Sends all dynamic update requests to the name server
957a8884fb712885cdd8ef0474f5ff95ddc46b20Automatic Updater <em class="parameter"><code>servername</code></em>.
b109432c3a939bff66a463be86c371bd88efe3aaAutomatic Updater When no server statement is provided,
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <span><strong class="command">nsupdate</strong></span>
995eaa289ba9709c64ef89b3776e53c36adc0010Automatic Updater will send updates to the master server of the correct zone.
9cd5eb6fe0f26d65724b99216cb31dcdd12e4afdAutomatic Updater The MNAME field of that zone's SOA record will identify the
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington server for that zone.
9cd5eb6fe0f26d65724b99216cb31dcdd12e4afdAutomatic Updater <em class="parameter"><code>port</code></em>
cf7e98f59148b559946a7f1ca728471374f1eef3Automatic Updater is the port number on
96713299d08c0735c18ebe8772dd2cc1ecd4356aAutomatic Updater <em class="parameter"><code>servername</code></em>
bf9b61c7904437745aeeb0f7d5036b35dad2a8a5Automatic Updater where the dynamic update requests get sent.
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater If no port number is specified, the default DNS port number of
361bec4bdec45042897fb479b7071cd05bbd56b9Automatic Updater <span><strong class="command">local</strong></span>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater Sends all dynamic update requests using the local
3857cb6fcabeb79d85de4b3e3e4ab99912b701f8Mark Andrews <em class="parameter"><code>address</code></em>.
7858b0168b866c0c2878fc4ea31fb5e581c1a6a9Automatic Updater When no local statement is provided,
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <span><strong class="command">nsupdate</strong></span>
9174e44c14b1cb91a651fa1dc29470438c246ab9Automatic Updater will send updates using an address and port chosen by the
e2caa7536302de34de6cc04025abcd53dc3a499aAutomatic Updater <em class="parameter"><code>port</code></em>
56e7dc0c24b04210dcbffb180a9e35644fb820daAutomatic Updater can additionally be used to make requests come from a specific
8292deab031e7599cd7622aa7675fbe139ca6095Mark Andrews If no port number is specified, the system will assign one.
7d12a6b412fe47e6d6582923fd6954ab8cd0baebAutomatic Updater <span><strong class="command">zone</strong></span>
b109432c3a939bff66a463be86c371bd88efe3aaAutomatic Updater Specifies that all updates are to be made to the zone
7d12a6b412fe47e6d6582923fd6954ab8cd0baebAutomatic Updater <em class="parameter"><code>zonename</code></em>.
3351ccbd5c1961404044f8273d54dad405f53960Mark Andrews statement is provided,
7d12a6b412fe47e6d6582923fd6954ab8cd0baebAutomatic Updater <span><strong class="command">nsupdate</strong></span>
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews will attempt determine the correct zone to update based on the
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews rest of the input.
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews <span><strong class="command">class</strong></span>
7d12a6b412fe47e6d6582923fd6954ab8cd0baebAutomatic Updater Specify the default class.
7d12a6b412fe47e6d6582923fd6954ab8cd0baebAutomatic Updater If no <em class="parameter"><code>class</code></em> is specified, the
7d12a6b412fe47e6d6582923fd6954ab8cd0baebAutomatic Updater default class is
7d12a6b412fe47e6d6582923fd6954ab8cd0baebAutomatic Updater <em class="parameter"><code>IN</code></em>.
7d12a6b412fe47e6d6582923fd6954ab8cd0baebAutomatic Updater <span><strong class="command">key</strong></span>
e8fc8c884b44371784805e1e0d3100da403dd3f1Automatic Updater Specifies that all updates are to be TSIG-signed using the
e8fc8c884b44371784805e1e0d3100da403dd3f1Automatic Updater <em class="parameter"><code>keyname</code></em> <em class="parameter"><code>keysecret</code></em> pair.
e8fc8c884b44371784805e1e0d3100da403dd3f1Automatic Updater The <span><strong class="command">key</strong></span> command
e8fc8c884b44371784805e1e0d3100da403dd3f1Automatic Updater overrides any key specified on the command line via
e8fc8c884b44371784805e1e0d3100da403dd3f1Automatic Updater <code class="option">-y</code> or <code class="option">-k</code>.
7d12a6b412fe47e6d6582923fd6954ab8cd0baebAutomatic Updater <span><strong class="command">prereq nxdomain</strong></span>
807ffe7aba4095b2f25c75ac1459f9efcd017eebMark Andrews {domain-name}
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater Requires that no resource record of any type exists with name
59528addd704f8d5757b54e540520f74e588a7c7Automatic Updater <em class="parameter"><code>domain-name</code></em>.
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <span><strong class="command">prereq yxdomain</strong></span>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews {domain-name}
4b2cb1422c7c600fbc13b1cb06a8b4693bc11af8Mark Andrews Requires that
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <em class="parameter"><code>domain-name</code></em>
06f5acb11f1c32228d93eefd1eb841dbfb1c7f4dAutomatic Updater exists (has as at least one resource record, of any type).
f2770f6b39a9b2a98afb7a11ed105f73f1570c1eAutomatic Updater <span><strong class="command">prereq nxrrset</strong></span>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington Requires that no resource record exists of the specified
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <em class="parameter"><code>type</code></em>,
b109432c3a939bff66a463be86c371bd88efe3aaAutomatic Updater <em class="parameter"><code>class</code></em>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <em class="parameter"><code>domain-name</code></em>.
9cd5eb6fe0f26d65724b99216cb31dcdd12e4afdAutomatic Updater <em class="parameter"><code>class</code></em>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater is omitted, IN (internet) is assumed.
bc0a4c01beede169df81a3ee5b614ed9e82339dbAutomatic Updater <span><strong class="command">prereq yxrrset</strong></span>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington {domain-name}
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington This requires that a resource record of the specified
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <em class="parameter"><code>type</code></em>,
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <em class="parameter"><code>class</code></em>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <em class="parameter"><code>domain-name</code></em>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <em class="parameter"><code>class</code></em>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington is omitted, IN (internet) is assumed.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <span><strong class="command">prereq yxrrset</strong></span>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington {domain-name}
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <em class="parameter"><code>data</code></em>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington from each set of prerequisites of this form
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington sharing a common
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <em class="parameter"><code>type</code></em>,
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <em class="parameter"><code>class</code></em>,
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <em class="parameter"><code>domain-name</code></em>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington are combined to form a set of RRs. This set of RRs must
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington exactly match the set of RRs existing in the zone at the
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <em class="parameter"><code>type</code></em>,
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <em class="parameter"><code>class</code></em>,
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <em class="parameter"><code>domain-name</code></em>.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <em class="parameter"><code>data</code></em>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington are written in the standard text representation of the resource
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <span><strong class="command">update delete</strong></span>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington {domain-name}
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington [type [data...]]
a26b22914b7bf25f065afb8cdef983766dcd672bAutomatic Updater Deletes any resource records named
9cd5eb6fe0f26d65724b99216cb31dcdd12e4afdAutomatic Updater <em class="parameter"><code>domain-name</code></em>.
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater <em class="parameter"><code>type</code></em>
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater <em class="parameter"><code>data</code></em>
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater is provided, only matching resource records will be removed.
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater The internet class is assumed if
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater <em class="parameter"><code>class</code></em>
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater is not supplied. The
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater <em class="parameter"><code>ttl</code></em>
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater is ignored, and is only allowed for compatibility.
ae7e54b14c946e0984c191554db9abb4893f9349Automatic Updater <span><strong class="command">update add</strong></span>
aa1d397c4736cd86540555193d71e55fa3b37b2aMark Andrews Adds a new resource record with the specified
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <em class="parameter"><code>class</code></em>
d4ef65050feac78554addf6e16a06c6e2e0bd331Brian Wellington <em class="parameter"><code>data</code></em>.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <span><strong class="command">show</strong></span>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington Displays the current message, containing all of the
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington prerequisites and
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington updates specified since the last send.
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <span><strong class="command">send</strong></span>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater Sends the current message. This is equivalent to entering a
c01dec514a81ecf8c17ca3ef8c3ba95e437295ebAutomatic Updater <span><strong class="command">answer</strong></span>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater Displays the answer.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington Lines beginning with a semicolon are comments and are ignored.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington The examples below show how
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <span><strong class="command">nsupdate</strong></span>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington could be used to insert and delete resource records from the
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington Notice that the input in each example contains a trailing blank line so
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington a group of commands are sent as one dynamic update request to the
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington master name server for
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington> update delete oldhost.example.com A
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington> update add newhost.example.com 86400 A 172.16.1.1
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater Any A records for
9cd5eb6fe0f26d65724b99216cb31dcdd12e4afdAutomatic Updater <span class="type">oldhost.example.com</span>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington And an A record for
9cd5eb6fe0f26d65724b99216cb31dcdd12e4afdAutomatic Updater <span class="type">newhost.example.com</span>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington with IP address 172.16.1.1 is added.
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews The newly-added record has a 1 day TTL (86400 seconds).
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington> prereq nxdomain nickname.example.com
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington> update add nickname.example.com 86400 CNAME somehost.example.com
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington The prerequisite condition gets the name server to check that there
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington are no resource records of any type for
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <span class="type">nickname.example.com</span>.
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews If there are, the update request fails.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington If this name does not exist, a CNAME for it is added.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington This ensures that when the CNAME is added, it cannot conflict with the
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews long-standing rule in RFC1034 that a name must not exist as any other
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington record type if it exists as a CNAME.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington (The rule has been updated for DNSSEC in RFC2535 to allow CNAMEs to have
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington RRSIG, DNSKEY and NSEC records.)
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<dt><span class="term"><code class="constant">/etc/resolv.conf</code></span></dt>
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington used to identify default name server
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<dt><span class="term"><code class="constant">K{name}.+157.+{random}.key</code></span></dt>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater base-64 encoding of HMAC-MD5 key created by
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>.
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater<dt><span class="term"><code class="constant">K{name}.+157.+{random}.private</code></span></dt>
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater base-64 encoding of HMAC-MD5 key created by
ce9cad6bb04869c5e94d9dc721032b25117f9210Automatic Updater <span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington<p><span class="citerefentry"><span class="refentrytitle">RFC2136</span></span>,
9cd5eb6fe0f26d65724b99216cb31dcdd12e4afdAutomatic Updater <span class="citerefentry"><span class="refentrytitle">RFC3007</span></span>,
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <span class="citerefentry"><span class="refentrytitle">RFC2104</span></span>,
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews <span class="citerefentry"><span class="refentrytitle">RFC2845</span></span>,
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <span class="citerefentry"><span class="refentrytitle">RFC1034</span></span>,
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews <span class="citerefentry"><span class="refentrytitle">RFC2535</span></span>,
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington <span class="citerefentry"><span class="refentrytitle">RFC2931</span></span>,
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
7adcb4de92bf4383a4c5624c4ed256736d02bc6dMark Andrews <span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington The TSIG key is redundantly stored in two separate files.
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington This is a consequence of nsupdate using the DST library
9e3a7b0faf417a10f5f689edf288807b2d5eedc5Brian Wellington for its cryptographic operations, and may change in future