man.nsupdate.html revision 8a8a1fe98c89d0c683387b15a93b36ee7fe34b77
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<!--
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster - Copyright (C) 2004-2013 Internet Systems Consortium, Inc. ("ISC")
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster - Copyright (C) 2000-2003 Internet Software Consortium.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster -
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster - Permission to use, copy, modify, and/or distribute this software for any
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster - purpose with or without fee is hereby granted, provided that the above
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster - copyright notice and this permission notice appear in all copies.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster -
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster - PERFORMANCE OF THIS SOFTWARE.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster-->
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<!-- $Id$ -->
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<html>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<head>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<title>nsupdate</title>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<link rel="prev" href="man.named-journalprint.html" title="named-journalprint">
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<link rel="next" href="man.rndc.html" title="rndc">
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster</head>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<div class="navheader">
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<table width="100%" summary="Navigation header">
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<tr><th colspan="3" align="center"><span class="application">nsupdate</span></th></tr>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<tr>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<td width="20%" align="left">
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<a accesskey="p" href="man.named-journalprint.html">Prev</a>�</td>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<th width="60%" align="center">Manual pages</th>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<td width="20%" align="right">�<a accesskey="n" href="man.rndc.html">Next</a>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster</td>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster</tr>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster</table>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<hr>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster</div>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<div class="refentry" lang="en">
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<a name="man.nsupdate"></a><div class="titlepage"></div>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<div class="refnamediv">
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<h2>Name</h2>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<p><span class="application">nsupdate</span> &#8212; Dynamic DNS update utility</p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster</div>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<div class="refsynopsisdiv">
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<h2>Synopsis</h2>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<div class="cmdsynopsis"><p><code class="command">nsupdate</code> [<code class="option">-d</code>] [<code class="option">-D</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>] [filename]</p></div>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster</div>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<div class="refsect1" lang="en">
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<a name="id2643889"></a><h2>DESCRIPTION</h2>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<p><span><strong class="command">nsupdate</strong></span>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster is used to submit Dynamic DNS Update requests as defined in RFC 2136
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster to a name server.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster This allows resource records to be added or removed from a zone
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster without manually editing the zone file.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster A single update request can contain requests to add or remove more than
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster one
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster resource record.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster Zones that are under dynamic control via
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <span><strong class="command">nsupdate</strong></span>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster or a DHCP server should not be edited by hand.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster Manual edits could
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster conflict with dynamic updates and cause data to be lost.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster The resource records that are dynamically added or removed with
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <span><strong class="command">nsupdate</strong></span>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster have to be in the same zone.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster Requests are sent to the zone's master server.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster This is identified by the MNAME field of the zone's SOA record.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster The
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <code class="option">-d</code>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster option makes
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <span><strong class="command">nsupdate</strong></span>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster operate in debug mode.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster This provides tracing information about the update requests that are
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster made and the replies received from the name server.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster The <code class="option">-D</code> option makes <span><strong class="command">nsupdate</strong></span>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster report additional debugging information to <code class="option">-d</code>.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster The <code class="option">-L</code> option with an integer argument of zero or
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster higher sets the logging debug level. If zero, logging is disabled.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster Transaction signatures can be used to authenticate the Dynamic
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster DNS updates. These use the TSIG resource record type described
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster in RFC 2845 or the SIG(0) record described in RFC 2535 and
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster RFC 2931 or GSS-TSIG as described in RFC 3645. TSIG relies on
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster a shared secret that should only be known to
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <span><strong class="command">nsupdate</strong></span> and the name server. Currently,
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster the only supported encryption algorithm for TSIG is HMAC-MD5,
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster which is defined in RFC 2104. Once other algorithms are
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster defined for TSIG, applications will need to ensure they select
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster the appropriate algorithm as well as the key when authenticating
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster each other. For instance, suitable <span class="type">key</span> and
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <span class="type">server</span> statements would be added to
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <code class="filename">/etc/named.conf</code> so that the name server
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster can associate the appropriate secret key and algorithm with
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster the IP address of the client application that will be using
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster TSIG authentication. SIG(0) uses public key cryptography.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster To use a SIG(0) key, the public key must be stored in a KEY
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster record in a zone served by the name server.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <span><strong class="command">nsupdate</strong></span> does not read
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <code class="filename">/etc/named.conf</code>.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster GSS-TSIG uses Kerberos credentials. Standard GSS-TSIG mode
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster is switched on with the <code class="option">-g</code> flag. A
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster non-standards-compliant variant of GSS-TSIG used by Windows
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster 2000 can be switched on with the <code class="option">-o</code> flag.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<p><span><strong class="command">nsupdate</strong></span>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster uses the <code class="option">-y</code> or <code class="option">-k</code> option
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster to provide the shared secret needed to generate a TSIG record
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster for authenticating Dynamic DNS update requests, default type
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster HMAC-MD5. These options are mutually exclusive.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster When the <code class="option">-y</code> option is used, a signature is
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster generated from
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster [<span class="optional"><em class="parameter"><code>hmac:</code></em></span>]<em class="parameter"><code>keyname:secret.</code></em>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <em class="parameter"><code>keyname</code></em> is the name of the key, and
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <em class="parameter"><code>secret</code></em> is the base64 encoded shared secret.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster Use of the <code class="option">-y</code> option is discouraged because the
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster shared secret is supplied as a command line argument in clear text.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster This may be visible in the output from
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <span class="citerefentry"><span class="refentrytitle">ps</span>(1)</span>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster or in a history file maintained by the user's shell.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster With the
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <code class="option">-k</code> option, <span><strong class="command">nsupdate</strong></span> reads
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster the shared secret from the file <em class="parameter"><code>keyfile</code></em>.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster Keyfiles may be in two formats: a single file containing
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster a <code class="filename">named.conf</code>-format <span><strong class="command">key</strong></span>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster statement, which may be generated automatically by
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <span><strong class="command">ddns-confgen</strong></span>, or a pair of files whose names are
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster of the format <code class="filename">K{name}.+157.+{random}.key</code> and
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <code class="filename">K{name}.+157.+{random}.private</code>, which can be
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster generated by <span><strong class="command">dnssec-keygen</strong></span>.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster The <code class="option">-k</code> may also be used to specify a SIG(0) key used
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster to authenticate Dynamic DNS update requests. In this case, the key
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster specified is not an HMAC-MD5 key.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <span><strong class="command">nsupdate</strong></span> can be run in a local-host only mode
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster using the <code class="option">-l</code> flag. This sets the server address to
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster localhost (disabling the <span><strong class="command">server</strong></span> so that the server
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster address cannot be overridden). Connections to the local server will
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster use a TSIG key found in <code class="filename">/var/run/named/session.key</code>,
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster which is automatically generated by <span><strong class="command">named</strong></span> if any
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster local master zone has set <span><strong class="command">update-policy</strong></span> to
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <span><strong class="command">local</strong></span>. The location of this key file can be
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster overridden with the <code class="option">-k</code> option.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster By default, <span><strong class="command">nsupdate</strong></span>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster uses UDP to send update requests to the name server unless they are too
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster large to fit in a UDP request in which case TCP will be used.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster The
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <code class="option">-v</code>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster option makes
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <span><strong class="command">nsupdate</strong></span>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster use a TCP connection.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster This may be preferable when a batch of update requests is made.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster The <code class="option">-p</code> sets the default port number to use for
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster connections to a name server. The default is 53.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster The <code class="option">-t</code> option sets the maximum time an update request
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster can
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster take before it is aborted. The default is 300 seconds. Zero can be
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster used
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster to disable the timeout.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster The <code class="option">-u</code> option sets the UDP retry interval. The default
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster is
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster 3 seconds. If zero, the interval will be computed from the timeout
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster interval
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster and number of UDP retries.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster The <code class="option">-r</code> option sets the number of UDP retries. The
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster default is
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster 3. If zero, only one update request will be made.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster The <code class="option">-R <em class="replaceable"><code>randomdev</code></em></code> option
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster specifies a source of randomness. If the operating system
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster does not provide a <code class="filename">/dev/random</code> or
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster equivalent device, the default source of randomness is keyboard
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster input. <code class="filename">randomdev</code> specifies the name of
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster a character device or file containing random data to be used
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster instead of the default. The special value
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster <code class="filename">keyboard</code> indicates that keyboard input
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster should be used. This option may be specified multiple times.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster<p>
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster Other types can be entered using "TYPEXXXXX" where "XXXXX" is the
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster decimal value of the type with no leading zeros. The rdata,
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster if present, will be parsed using the UNKNOWN rdata format,
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster (&lt;backslash&gt; &lt;hash&gt; &lt;space&gt; &lt;length&gt;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster &lt;space&gt; &lt;hexstring&gt;).
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster </p>
<p>
The <code class="option">-T</code> and <code class="option">-P</code> options print out
lists of non-meta types for which the type-specific presentation
formats are known. <code class="option">-T</code> prints out the list of
IANA-assigned types. <code class="option">-P</code> prints out the list of
private types specific to <span><strong class="command">named</strong></span>. These options
may be combined. <span><strong class="command">nsupdate</strong></span> will exit after the
lists are printed.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2680779"></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>
{name}
{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>keysecret</code></em> pair.
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 commandline.
</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
commandline.
</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">[<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>
</dl></div>
<p>
</p>
<p>
Lines beginning with a semicolon are comments and are ignored.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2681981"></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="id2682032"></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="id2682115"></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="id2682172"></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-journalprint.html">Prev</a>�</td>
<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.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-journalprint</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>
</body>
</html>