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