man.nsupdate.html revision 548a24c3d36837aa5f0e64f7bb8c7308909ffa89
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC")
6a42ab64276ff832a47e009be1208f7c7d4da22dAutomatic Updater - Copyright (C) 2000-2003 Internet Software Consortium.
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - Permission to use, copy, modify, and/or distribute this software for any
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - purpose with or without fee is hereby granted, provided that the above
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater - copyright notice and this permission notice appear in all copies.
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
b6b8f8a0362da8c749021c4b6376cfb96047912bTinderbox User - PERFORMANCE OF THIS SOFTWARE.
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
b6b8f8a0362da8c749021c4b6376cfb96047912bTinderbox User<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater<link rel="prev" href="man.named-rrchecker.html" title="named-rrchecker">
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater<link rel="next" href="man.rndc.html" title="rndc">
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater<table width="100%" summary="Navigation header">
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater<tr><th colspan="3" align="center"><span class="application">nsupdate</span></th></tr>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<a accesskey="p" href="man.named-rrchecker.html">Prev</a>�</td>
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater<th width="60%" align="center">Manual pages</th>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<td width="20%" align="right">�<a accesskey="n" href="man.rndc.html">Next</a>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<a name="man.nsupdate"></a><div class="titlepage"></div>
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater<p><span class="application">nsupdate</span> — Dynamic DNS update utility</p>
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater<div class="cmdsynopsis"><p><code class="command">nsupdate</code> [<code class="option">-d</code>] [<code class="option">-D</code>] [<code class="option">-L <em class="replaceable"><code>level</code></em></code>] [[<code class="option">-g</code>] | [<code class="option">-o</code>] | [<code class="option">-l</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>] [<code class="option">-T</code>] [<code class="option">-P</code>] [<code class="option">-V</code>] [filename]</p></div>
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater<p><span><strong class="command">nsupdate</strong></span>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt is used to submit Dynamic DNS Update requests as defined in RFC 2136
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater to a name server.
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater This allows resource records to be added or removed from a zone
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater without manually editing the zone file.
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater A single update request can contain requests to add or remove more than
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater resource record.
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater Zones that are under dynamic control via
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater <span><strong class="command">nsupdate</strong></span>
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater or a DHCP server should not be edited by hand.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User Manual edits could
ed4475f3f583f6137b4ff7fea775c5363a4fdb29Automatic Updater conflict with dynamic updates and cause data to be lost.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User The resource records that are dynamically added or removed with
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <span><strong class="command">nsupdate</strong></span>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User have to be in the same zone.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User Requests are sent to the zone's master server.
ed4475f3f583f6137b4ff7fea775c5363a4fdb29Automatic Updater This is identified by the MNAME field of the zone's SOA record.
ed4475f3f583f6137b4ff7fea775c5363a4fdb29Automatic Updater Transaction signatures can be used to authenticate the Dynamic
ed4475f3f583f6137b4ff7fea775c5363a4fdb29Automatic Updater DNS updates. These use the TSIG resource record type described
ed4475f3f583f6137b4ff7fea775c5363a4fdb29Automatic Updater in RFC 2845 or the SIG(0) record described in RFC 2535 and
ed4475f3f583f6137b4ff7fea775c5363a4fdb29Automatic Updater RFC 2931 or GSS-TSIG as described in RFC 3645.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt TSIG relies on
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User a shared secret that should only be known to
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <span><strong class="command">nsupdate</strong></span> and the name server.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User For instance, suitable <span class="type">key</span> and
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <span class="type">server</span> statements would be added to
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <code class="filename">/etc/named.conf</code> so that the name server
ed4475f3f583f6137b4ff7fea775c5363a4fdb29Automatic Updater can associate the appropriate secret key and algorithm with
ed4475f3f583f6137b4ff7fea775c5363a4fdb29Automatic Updater the IP address of the client application that will be using
d060d8669f5558690e7faf4a1c12fe5c02a7c60dAutomatic Updater TSIG authentication. You can use <span><strong class="command">ddns-confgen</strong></span>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User to generate suitable configuration fragments.
d060d8669f5558690e7faf4a1c12fe5c02a7c60dAutomatic Updater <span><strong class="command">nsupdate</strong></span>
d060d8669f5558690e7faf4a1c12fe5c02a7c60dAutomatic Updater uses the <code class="option">-y</code> or <code class="option">-k</code> options
d060d8669f5558690e7faf4a1c12fe5c02a7c60dAutomatic Updater to provide the TSIG shared secret. These options are mutually exclusive.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User SIG(0) uses public key cryptography.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User To use a SIG(0) key, the public key must be stored in a KEY
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User record in a zone served by the name server.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User GSS-TSIG uses Kerberos credentials. Standard GSS-TSIG mode
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User is switched on with the <code class="option">-g</code> flag. A
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User non-standards-compliant variant of GSS-TSIG used by Windows
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User 2000 can be switched on with the <code class="option">-o</code> flag.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User Debug mode. This provides tracing information about the
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User update requests that are made and the replies received
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt from the name server.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User Extra debug mode.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User<dt><span class="term">-k <em class="replaceable"><code>keyfile</code></em></span></dt>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User The file containing the TSIG authentication key.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User Keyfiles may be in two formats: a single file containing
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User a <code class="filename">named.conf</code>-format <span><strong class="command">key</strong></span>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User statement, which may be generated automatically by
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <span><strong class="command">ddns-confgen</strong></span>, or a pair of files whose names are
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt of the format <code class="filename">K{name}.+157.+{random}.key</code> and
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <code class="filename">K{name}.+157.+{random}.private</code>, which can be
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User generated by <span><strong class="command">dnssec-keygen</strong></span>.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt The <code class="option">-k</code> may also be used to specify a SIG(0) key used
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt to authenticate Dynamic DNS update requests. In this case, the key
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt specified is not an HMAC-MD5 key.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User Local-host only mode. This sets the server address to
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User localhost (disabling the <span><strong class="command">server</strong></span> so that the server
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User address cannot be overridden). Connections to the local server will
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User use a TSIG key found in <code class="filename">/var/run/named/session.key</code>,
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User which is automatically generated by <span><strong class="command">named</strong></span> if any
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User local master zone has set <span><strong class="command">update-policy</strong></span> to
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <span><strong class="command">local</strong></span>. The location of this key file can be
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User overridden with the <code class="option">-k</code> option.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<dt><span class="term">-L <em class="replaceable"><code>level</code></em></span></dt>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User Set the logging debug level. If zero, logging is disabled.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User Set the port to use for connections to a name server. The
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User default is 53.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User Print the list of private BIND-specific resource record
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User types whose format is understood
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User by <span><strong class="command">nsupdate</strong></span>. See also
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User<dt><span class="term">-r <em class="replaceable"><code>udpretries</code></em></span></dt>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User The number of UDP retries. The default is 3. If zero, only
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User one update request will be made.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<dt><span class="term">-R <em class="replaceable"><code>randomdev</code></em></span></dt>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User Where to obtain randomness. If the operating system
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User does not provide a <code class="filename">/dev/random</code> or
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User equivalent device, the default source of randomness is keyboard
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User input. <code class="filename">randomdev</code> specifies the name of
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User a character device or file containing random data to be used
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User instead of the default. The special value
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <code class="filename">keyboard</code> indicates that keyboard input
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User should be used. This option may be specified multiple times.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<dt><span class="term">-t <em class="replaceable"><code>timeout</code></em></span></dt>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User The maximum time an update request can take before it is
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User aborted. The default is 300 seconds. Zero can be used to
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User disable the timeout.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User Print the list of IANA standard resource record types
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User whose format is understood by <span><strong class="command">nsupdate</strong></span>.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <span><strong class="command">nsupdate</strong></span> will exit after the lists are
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User printed. The <code class="option">-T</code> option can be combined
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User with the <code class="option">-P</code> option.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User Other types can be entered using "TYPEXXXXX" where "XXXXX" is the
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User decimal value of the type with no leading zeros. The rdata,
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User if present, will be parsed using the UNKNOWN rdata format,
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User (<backslash> <hash> <space> <length>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <space> <hexstring>).
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User<dt><span class="term">-u <em class="replaceable"><code>udptimeout</code></em></span></dt>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User The UDP retry interval. The default is 3 seconds. If zero,
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User the interval will be computed from the timeout interval and
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User number of UDP retries.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User Use TCP even for small update requests.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User By default, <span><strong class="command">nsupdate</strong></span>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User uses UDP to send update requests to the name server unless they are too
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User large to fit in a UDP request in which case TCP will be used.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User TCP may be preferable when a batch of update requests is made.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User Print the version number and exit.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User<dt><span class="term">-y <em class="replaceable"><code>[<span class="optional">hmac:</span>]keyname:secret</code></em></span></dt>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User Literal TSIG authentication key.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <em class="parameter"><code>keyname</code></em> is the name of the key, and
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <em class="parameter"><code>secret</code></em> is the base64 encoded shared secret.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <em class="parameter"><code>hmac</code></em> is the name of the key algorithm;
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User valid choices are <code class="literal">hmac-md5</code>,
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <code class="literal">hmac-sha1</code>, <code class="literal">hmac-sha224</code>,
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <code class="literal">hmac-sha256</code>, <code class="literal">hmac-sha384</code>, or
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <code class="literal">hmac-sha512</code>. If <em class="parameter"><code>hmac</code></em>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User is not specified, the default is <code class="literal">hmac-md5</code>.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User NOTE: Use of the <code class="option">-y</code> option is discouraged because the
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User shared secret is supplied as a command line argument in clear text.
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater This may be visible in the output from
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater <span class="citerefentry"><span class="refentrytitle">ps</span>(1)</span>
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater or in a history file maintained by the user's shell.
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater<a name="id2691203"></a><h2>INPUT FORMAT</h2>
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater<p><span><strong class="command">nsupdate</strong></span>
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater reads input from
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater <em class="parameter"><code>filename</code></em>
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater or standard input.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User Each command is supplied on exactly one line of input.
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater Some commands are for administrative purposes.
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater The others are either update instructions or prerequisite checks on the
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater contents of the zone.
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater These checks set conditions that some name or set of
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt resource records (RRset) either exists or is absent from the zone.
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater These conditions must be met if the entire update request is to succeed.
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater Updates will be rejected if the tests for the prerequisite conditions
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater Every update request consists of zero or more prerequisites
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater and zero or more updates.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User This allows a suitably authenticated update request to proceed if some
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater specified resource records are present or missing from the zone.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt A blank input line (or the <span><strong class="command">send</strong></span> command)
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User accumulated commands to be sent as one Dynamic DNS update request to the
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User The command formats and their meaning are as follows:
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <span><strong class="command">server</strong></span>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User Sends all dynamic update requests to the name server
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <em class="parameter"><code>servername</code></em>.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User When no server statement is provided,
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <span><strong class="command">nsupdate</strong></span>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User will send updates to the master server of the correct zone.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User The MNAME field of that zone's SOA record will identify the
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt server for that zone.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User is the port number on
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <em class="parameter"><code>servername</code></em>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User where the dynamic update requests get sent.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User If no port number is specified, the default DNS port number of
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <span><strong class="command">local</strong></span>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User Sends all dynamic update requests using the local
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <em class="parameter"><code>address</code></em>.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt When no local statement is provided,
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <span><strong class="command">nsupdate</strong></span>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User will send updates using an address and port chosen by the
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User can additionally be used to make requests come from a specific
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User If no port number is specified, the system will assign one.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <span><strong class="command">zone</strong></span>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt Specifies that all updates are to be made to the zone
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <em class="parameter"><code>zonename</code></em>.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User statement is provided,
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <span><strong class="command">nsupdate</strong></span>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User will attempt determine the correct zone to update based on the
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User rest of the input.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <span><strong class="command">class</strong></span>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User Specify the default class.
731cc132f22dbc9e0ecd7035dce314a61076d31bAutomatic Updater If no <em class="parameter"><code>class</code></em> is specified, the
731cc132f22dbc9e0ecd7035dce314a61076d31bAutomatic Updater default class is
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <span><strong class="command">ttl</strong></span>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User Specify the default time to live for records to be added.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User The value <em class="parameter"><code>none</code></em> will clear the default
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <span><strong class="command">key</strong></span>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User [hmac:] {keyname}
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User Specifies that all updates are to be TSIG-signed using the
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <em class="parameter"><code>keyname</code></em> <em class="parameter"><code>secret</code></em> pair.
7c6b9b263898daf28d657f65dbd75c330ca4aa13Automatic Updater If <em class="parameter"><code>hmac</code></em> is specified, then it sets the
24abfe433efd98bb2099b867fb14d049b2f1f531Tinderbox User signing algorithm in use; the default is
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <code class="literal">hmac-md5</code>. The <span><strong class="command">key</strong></span>
7c6b9b263898daf28d657f65dbd75c330ca4aa13Automatic Updater command overrides any key specified on the command line via
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <code class="option">-y</code> or <code class="option">-k</code>.
7c6b9b263898daf28d657f65dbd75c330ca4aa13Automatic Updater <span><strong class="command">gsstsig</strong></span>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User Use GSS-TSIG to sign the updated. This is equivalent to
7c6b9b263898daf28d657f65dbd75c330ca4aa13Automatic Updater specifying <code class="option">-g</code> on the commandline.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <span><strong class="command">oldgsstsig</strong></span>
7c6b9b263898daf28d657f65dbd75c330ca4aa13Automatic Updater Use the Windows 2000 version of GSS-TSIG to sign the updated.
7c6b9b263898daf28d657f65dbd75c330ca4aa13Automatic Updater This is equivalent to specifying <code class="option">-o</code> on the
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <span><strong class="command">realm</strong></span>
b68a2d272b958eb2c40cce59ee33e71c5f5f521bTinderbox User When using GSS-TSIG use <em class="parameter"><code>realm_name</code></em> rather
b68a2d272b958eb2c40cce59ee33e71c5f5f521bTinderbox User than the default realm in <code class="filename">krb5.conf</code>. If no
b68a2d272b958eb2c40cce59ee33e71c5f5f521bTinderbox User realm is specified the saved realm is cleared.
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater <span><strong class="command">check-names</strong></span>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User Turn on or off check-names processing on records to
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User be added. Check-names has no effect on prerequisites
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User or records to be deleted. By default check-names
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User processing is on. If check-names processing fails
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater the record will not be added to the UPDATE message.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <span><strong class="command">[<span class="optional">prereq</span>] nxdomain</strong></span>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User {domain-name}
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User Requires that no resource record of any type exists with name
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <em class="parameter"><code>domain-name</code></em>.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <span><strong class="command">[<span class="optional">prereq</span>] yxdomain</strong></span>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User {domain-name}
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User Requires that
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <em class="parameter"><code>domain-name</code></em>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User exists (has as at least one resource record, of any type).
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <span><strong class="command">[<span class="optional">prereq</span>] nxrrset</strong></span>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User {domain-name}
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt Requires that no resource record exists of the specified
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <em class="parameter"><code>type</code></em>,
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <em class="parameter"><code>class</code></em>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <em class="parameter"><code>domain-name</code></em>.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <em class="parameter"><code>class</code></em>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User is omitted, IN (internet) is assumed.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <span><strong class="command">[<span class="optional">prereq</span>] yxrrset</strong></span>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User {domain-name}
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater This requires that a resource record of the specified
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <em class="parameter"><code>class</code></em>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <em class="parameter"><code>domain-name</code></em>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <em class="parameter"><code>class</code></em>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User is omitted, IN (internet) is assumed.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <span><strong class="command">[<span class="optional">prereq</span>] yxrrset</strong></span>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User {domain-name}
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User from each set of prerequisites of this form
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User sharing a common
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <em class="parameter"><code>type</code></em>,
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <em class="parameter"><code>class</code></em>,
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <em class="parameter"><code>domain-name</code></em>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User are combined to form a set of RRs. This set of RRs must
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User exactly match the set of RRs existing in the zone at the
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater <em class="parameter"><code>type</code></em>,
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <em class="parameter"><code>domain-name</code></em>.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User are written in the standard text representation of the resource
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <span><strong class="command">[<span class="optional">update</span>] del[<span class="optional">ete</span>]</strong></span>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User {domain-name}
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User [type [data...]]
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User Deletes any resource records named
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <em class="parameter"><code>domain-name</code></em>.
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater <em class="parameter"><code>type</code></em>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User is provided, only matching resource records will be removed.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User The internet class is assumed if
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <em class="parameter"><code>class</code></em>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User is not supplied. The
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User is ignored, and is only allowed for compatibility.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <span><strong class="command">[<span class="optional">update</span>] add</strong></span>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User {domain-name}
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User Adds a new resource record with the specified
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <em class="parameter"><code>class</code></em>
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater <em class="parameter"><code>data</code></em>.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <span><strong class="command">show</strong></span>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User Displays the current message, containing all of the
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater prerequisites and
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt updates specified since the last send.
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User <span><strong class="command">send</strong></span>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt Sends the current message. This is equivalent to entering a
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <span><strong class="command">answer</strong></span>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User Displays the answer.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <span><strong class="command">debug</strong></span>
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User Turn on debugging.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <span><strong class="command">version</strong></span>
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater Print version number.
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater <span><strong class="command">help</strong></span>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User Print a list of commands.
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater Lines beginning with a semicolon are comments and are ignored.
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater The examples below show how
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater <span><strong class="command">nsupdate</strong></span>
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater could be used to insert and delete resource records from the
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater Notice that the input in each example contains a trailing blank line so
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater a group of commands are sent as one dynamic update request to the
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater master name server for
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater> update delete oldhost.example.com A
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater> update add newhost.example.com 86400 A 172.16.1.1
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater Any A records for
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater <span class="type">oldhost.example.com</span>
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater And an A record for
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater <span class="type">newhost.example.com</span>
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater with IP address 172.16.1.1 is added.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User The newly-added record has a 1 day TTL (86400 seconds).
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater> prereq nxdomain nickname.example.com
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater> update add nickname.example.com 86400 CNAME somehost.example.com
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater The prerequisite condition gets the name server to check that there
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater are no resource records of any type for
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <span class="type">nickname.example.com</span>.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User If there are, the update request fails.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User If this name does not exist, a CNAME for it is added.
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater This ensures that when the CNAME is added, it cannot conflict with the
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User long-standing rule in RFC 1034 that a name must not exist as any other
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User record type if it exists as a CNAME.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User (The rule has been updated for DNSSEC in RFC 2535 to allow CNAMEs to have
90c38ab4e6904126bec2f2f57f60cd834ce759cbAutomatic Updater RRSIG, DNSKEY and NSEC records.)
548a24c3d36837aa5f0e64f7bb8c7308909ffa89Tinderbox User<dt><span class="term"><code class="constant">/etc/resolv.conf</code></span></dt>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User used to identify default name server
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<dt><span class="term"><code class="constant">/var/run/named/session.key</code></span></dt>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User sets the default TSIG key for use in local-only mode
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater<dt><span class="term"><code class="constant">K{name}.+157.+{random}.key</code></span></dt>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User base-64 encoding of HMAC-MD5 key created by
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User <span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>.
d060d8669f5558690e7faf4a1c12fe5c02a7c60dAutomatic Updater<dt><span class="term"><code class="constant">K{name}.+157.+{random}.private</code></span></dt>
d060d8669f5558690e7faf4a1c12fe5c02a7c60dAutomatic Updater base-64 encoding of HMAC-MD5 key created by
d060d8669f5558690e7faf4a1c12fe5c02a7c60dAutomatic Updater <span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>.
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater <span class="citerefentry"><span class="refentrytitle">ddns-confgen</span>(8)</span>,
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater <span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>.
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater The TSIG key is redundantly stored in two separate files.
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater This is a consequence of nsupdate using the DST library
b6b8f8a0362da8c749021c4b6376cfb96047912bTinderbox User for its cryptographic operations, and may change in future
b6b8f8a0362da8c749021c4b6376cfb96047912bTinderbox User<table width="100%" summary="Navigation footer">
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater<a accesskey="p" href="man.named-rrchecker.html">Prev</a>�</td>
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
0c6ada0a814f3c5417daa1654129bc2af56ed504Automatic Updater<td width="40%" align="right">�<a accesskey="n" href="man.rndc.html">Next</a>