man.nsupdate.html revision 8ec3c085233cedb22b05da36e2773c8f357a7e45
8664a1bd40814ed0b42eacfc5eb354b598dfd6dfTinderbox User - Copyright (C) 2004-2009 Internet Systems Consortium, Inc. ("ISC")
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence - Copyright (C) 2000-2003 Internet Software Consortium.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews - Permission to use, copy, modify, and/or distribute this software for any
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews - purpose with or without fee is hereby granted, provided that the above
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley - copyright notice and this permission notice appear in all copies.
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
9c3531d72aeaad6c5f01efe6a1c82023e1379e4dDavid Lawrence - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
26cf4737b3e84c3a686a5eacebf22ac39e57d4caMark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley - PERFORMANCE OF THIS SOFTWARE.
5c7d67e3e68f8dbc45ffd4e1ea94696899b7b966Bob Halley<!-- $Id: man.nsupdate.html,v 1.63 2009/10/06 01:14:41 tbox Exp $ -->
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
386d3a99c190bad55edf44d076e6bd087e230ab8Tatuya JINMEI 神明達哉<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
386d3a99c190bad55edf44d076e6bd087e230ab8Tatuya JINMEI 神明達哉<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
386d3a99c190bad55edf44d076e6bd087e230ab8Tatuya JINMEI 神明達哉<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley<link rel="prev" href="man.named.html" title="named">
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley<link rel="next" href="man.rndc.html" title="rndc">
801dceea23d11975f5a5ae6ccbdf1dbde6b7af13David Lawrence<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
9cd6d409b78a6f833b681c13a68fbdc7c024fe66David Lawrence<table width="100%" summary="Navigation header">
801dceea23d11975f5a5ae6ccbdf1dbde6b7af13David Lawrence<tr><th colspan="3" align="center"><span class="application">nsupdate</span></th></tr>
4b87939256ede703385e9cab92d3c58d03c31098Mark Andrews<a accesskey="p" href="man.named.html">Prev</a>�</td>
1a69a1a78cfaa86f3b68bbc965232b7876d4da2aDavid Lawrence<th width="60%" align="center">Manual pages</th>
eefea43215016bce437ab4a7441b2851fd182960David Lawrence<td width="20%" align="right">�<a accesskey="n" href="man.rndc.html">Next</a>
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt<a name="man.nsupdate"></a><div class="titlepage"></div>
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉<p><span class="application">nsupdate</span> — Dynamic DNS update utility</p>
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt<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>] [filename]</p></div>
ae8b7e02a8e5d7febba7d79b2c759add95a48f60Brian Wellington<a name="id2613933"></a><h2>DESCRIPTION</h2>
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt<p><span><strong class="command">nsupdate</strong></span>
ae8b7e02a8e5d7febba7d79b2c759add95a48f60Brian Wellington is used to submit Dynamic DNS Update requests as defined in RFC2136
1b32bc7da1da9059abd68d6dd15b23e8a442afa3Brian Wellington to a name server.
1b32bc7da1da9059abd68d6dd15b23e8a442afa3Brian Wellington This allows resource records to be added or removed from a zone
0d89afffb26d5e53a761fc425dab3dda07c7e191Brian Wellington without manually editing the zone file.
1b32bc7da1da9059abd68d6dd15b23e8a442afa3Brian Wellington A single update request can contain requests to add or remove more than
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt resource record.
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 Zones that are under dynamic control via
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt <span><strong class="command">nsupdate</strong></span>
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt or a DHCP server should not be edited by hand.
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt Manual edits could
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt conflict with dynamic updates and cause data to be lost.
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt The resource records that are dynamically added or removed with
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt <span><strong class="command">nsupdate</strong></span>
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt have to be in the same zone.
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt Requests are sent to the zone's master server.
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt This is identified by the MNAME field of the zone's SOA record.
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt option makes
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt <span><strong class="command">nsupdate</strong></span>
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt operate in debug mode.
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt This provides tracing information about the update requests that are
62f016d5d301713c72a59e83d3ab41170a77f674Mark Andrews made and the replies received from the name server.
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 The <code class="option">-D</code> option makes <span><strong class="command">nsupdate</strong></span>
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 report additional debugging information to <code class="option">-d</code>.
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 The <code class="option">-L</code> option with an integer argument of zero or
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 higher sets the logging debug level. If zero, logging is disabled.
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 Transaction signatures can be used to authenticate the Dynamic
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 DNS updates. These use the TSIG resource record type described
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 in RFC2845 or the SIG(0) record described in RFC3535 and
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 RFC2931 or GSS-TSIG as described in RFC3645. TSIG relies on
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 a shared secret that should only be known to
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 <span><strong class="command">nsupdate</strong></span> and the name server. Currently,
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 the only supported encryption algorithm for TSIG is HMAC-MD5,
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 which is defined in RFC 2104. Once other algorithms are
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 defined for TSIG, applications will need to ensure they select
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 the appropriate algorithm as well as the key when authenticating
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 each other. For instance, suitable <span class="type">key</span> and
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 <span class="type">server</span> statements would be added to
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 <code class="filename">/etc/named.conf</code> so that the name server
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 can associate the appropriate secret key and algorithm with
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 the IP address of the client application that will be using
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 TSIG authentication. SIG(0) uses public key cryptography.
d7201de09b85929a86b157f4b2d91667c68c6b52Automatic Updater To use a SIG(0) key, the public key must be stored in a KEY
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 record in a zone served by the name server.
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 <span><strong class="command">nsupdate</strong></span> does not read
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 <code class="filename">/etc/named.conf</code>.
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 GSS-TSIG uses Kerberos credentials.
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt<p><span><strong class="command">nsupdate</strong></span>
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt uses the <code class="option">-y</code> or <code class="option">-k</code> option
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt to provide the shared secret needed to generate a TSIG record
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt for authenticating Dynamic DNS update requests, default type
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 HMAC-MD5. These options are mutually exclusive.
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 When the <code class="option">-y</code> option is used, a signature is
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 generated from
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 [<span class="optional"><em class="parameter"><code>hmac:</code></em></span>]<em class="parameter"><code>keyname:secret.</code></em>
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 <em class="parameter"><code>keyname</code></em> is the name of the key, and
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 <em class="parameter"><code>secret</code></em> is the base64 encoded shared secret.
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 Use of the <code class="option">-y</code> option is discouraged because the
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 shared secret is supplied as a command line argument in clear text.
62f016d5d301713c72a59e83d3ab41170a77f674Mark Andrews This may be visible in the output from
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 <span class="citerefentry"><span class="refentrytitle">ps</span>(1)</span>
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 or in a history file maintained by the user's shell.
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 <code class="option">-k</code> option, <span><strong class="command">nsupdate</strong></span> reads
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 the shared secret from the file <em class="parameter"><code>keyfile</code></em>.
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 Keyfiles may be in two formats: a single file containing
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 a <code class="filename">named.conf</code>-format <span><strong class="command">key</strong></span>
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 statement, which may be generated automatically by
62f016d5d301713c72a59e83d3ab41170a77f674Mark Andrews <span><strong class="command">ddns-confgen</strong></span>, or a pair of files whose names are
62f016d5d301713c72a59e83d3ab41170a77f674Mark Andrews of the format <code class="filename">K{name}.+157.+{random}.key</code> and
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt <code class="filename">K{name}.+157.+{random}.private</code>, which can be
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt generated by <span><strong class="command">dnssec-keygen</strong></span>.
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt The <code class="option">-k</code> may also be used to specify a SIG(0) key used
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt to authenticate Dynamic DNS update requests. In this case, the key
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt specified is not an HMAC-MD5 key.
8fec8134ea13c2c082c3e63f1ce0afd851e45a91Tatuya JINMEI 神明達哉 <span><strong class="command">nsupdate</strong></span> can be run in a local-host only mode
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 using the <code class="option">-l</code> flag. This sets the server address to
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 localhost (disabling the <span><strong class="command">server</strong></span> so that the server
a829555ed724caa56b1ff7716d7eda2266491eafBob Halley address cannot be overridden). Connections to the local server will
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein use a TSIG key found in <code class="filename">/var/run/named/ddns.key</code>,
03dd96d177e4ed6771be7fb5f86a3a9d5f17be4eBob Halley which is automatically generated by <span><strong class="command">named</strong></span> if any
03dd96d177e4ed6771be7fb5f86a3a9d5f17be4eBob Halley local master zone has set <span><strong class="command">update-policy</strong></span> to
03dd96d177e4ed6771be7fb5f86a3a9d5f17be4eBob Halley <span><strong class="command">local</strong></span>. The location of this key file can be
03dd96d177e4ed6771be7fb5f86a3a9d5f17be4eBob Halley overridden with the <code class="option">-k</code> option.
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein By default, <span><strong class="command">nsupdate</strong></span>
03dd96d177e4ed6771be7fb5f86a3a9d5f17be4eBob Halley uses UDP to send update requests to the name server unless they are too
03dd96d177e4ed6771be7fb5f86a3a9d5f17be4eBob Halley large to fit in a UDP request in which case TCP will be used.
a829555ed724caa56b1ff7716d7eda2266491eafBob Halley option makes
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley <span><strong class="command">nsupdate</strong></span>
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley use a TCP connection.
03dd96d177e4ed6771be7fb5f86a3a9d5f17be4eBob Halley This may be preferable when a batch of update requests is made.
97f1a75cf072c2cab98b4bc28c4d2491cfcd3086Bob Halley The <code class="option">-p</code> sets the default port number to use for
97f1a75cf072c2cab98b4bc28c4d2491cfcd3086Bob Halley connections to a name server. The default is 53.
2f012d936b5ccdf6520c96a4de23721dc58a2221Automatic Updater The <code class="option">-t</code> option sets the maximum time an update request
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley take before it is aborted. The default is 300 seconds. Zero can be
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley to disable the timeout.
dd324bd791a766c48d90ce9e43d1ab1446378983Bob Halley The <code class="option">-u</code> option sets the UDP retry interval. The default
dd324bd791a766c48d90ce9e43d1ab1446378983Bob Halley 3 seconds. If zero, the interval will be computed from the timeout
dd324bd791a766c48d90ce9e43d1ab1446378983Bob Halley and number of UDP retries.
dd324bd791a766c48d90ce9e43d1ab1446378983Bob Halley The <code class="option">-r</code> option sets the number of UDP retries. The
dd324bd791a766c48d90ce9e43d1ab1446378983Bob Halley 3. If zero, only one update request will be made.
9cd6d409b78a6f833b681c13a68fbdc7c024fe66David Lawrence The <code class="option">-R <em class="replaceable"><code>randomdev</code></em></code> option
4b87939256ede703385e9cab92d3c58d03c31098Mark Andrews specifies a source of randomness. If the operating system
dd324bd791a766c48d90ce9e43d1ab1446378983Bob Halley does not provide a <code class="filename">/dev/random</code> or
dd324bd791a766c48d90ce9e43d1ab1446378983Bob Halley equivalent device, the default source of randomness is keyboard
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence input. <code class="filename">randomdev</code> specifies the name of
dd324bd791a766c48d90ce9e43d1ab1446378983Bob Halley a character device or file containing random data to be used
dd324bd791a766c48d90ce9e43d1ab1446378983Bob Halley instead of the default. The special value
dd324bd791a766c48d90ce9e43d1ab1446378983Bob Halley <code class="filename">keyboard</code> indicates that keyboard input
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt should be used. This option may be specified multiple times.
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt<p><span><strong class="command">nsupdate</strong></span>
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt reads input from
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 or standard input.
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley Each command is supplied on exactly one line of input.
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley Some commands are for administrative purposes.
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley The others are either update instructions or prerequisite checks on the
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley contents of the zone.
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley These checks set conditions that some name or set of
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley resource records (RRset) either exists or is absent from the zone.
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley These conditions must be met if the entire update request is to succeed.
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley Updates will be rejected if the tests for the prerequisite conditions
4b87939256ede703385e9cab92d3c58d03c31098Mark Andrews Every update request consists of zero or more prerequisites
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley and zero or more updates.
4b87939256ede703385e9cab92d3c58d03c31098Mark Andrews This allows a suitably authenticated update request to proceed if some
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley specified resource records are present or missing from the zone.
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley A blank input line (or the <span><strong class="command">send</strong></span> command)
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley accumulated commands to be sent as one Dynamic DNS update request to the
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt name server.
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt The command formats and their meaning are as follows:
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 <span><strong class="command">server</strong></span>
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt Sends all dynamic update requests to the name server
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt <em class="parameter"><code>servername</code></em>.
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt When no server statement is provided,
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt <span><strong class="command">nsupdate</strong></span>
634a52966f2324e6d5ceda191fd873ba1cfeb936Evan Hunt will send updates to the master server of the correct zone.
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt The MNAME field of that zone's SOA record will identify the
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt server for that zone.
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt is the port number on
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 <em class="parameter"><code>servername</code></em>
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 where the dynamic update requests get sent.
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 If no port number is specified, the default DNS port number of
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 <span><strong class="command">local</strong></span>
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley Sends all dynamic update requests using the local
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley When no local statement is provided,
03dd96d177e4ed6771be7fb5f86a3a9d5f17be4eBob Halley <span><strong class="command">nsupdate</strong></span>
03dd96d177e4ed6771be7fb5f86a3a9d5f17be4eBob Halley will send updates using an address and port chosen by the
dd324bd791a766c48d90ce9e43d1ab1446378983Bob Halley can additionally be used to make requests come from a specific
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley If no port number is specified, the system will assign one.
dd324bd791a766c48d90ce9e43d1ab1446378983Bob Halley <span><strong class="command">zone</strong></span>
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt Specifies that all updates are to be made to the zone
dd324bd791a766c48d90ce9e43d1ab1446378983Bob Halley <em class="parameter"><code>zonename</code></em>.
33e482fa3e8befab0d9aaf32ed47b4695e0e6ba3Andreas Gustafsson <em class="parameter"><code>zone</code></em>
33e482fa3e8befab0d9aaf32ed47b4695e0e6ba3Andreas Gustafsson statement is provided,
838f13fbdc513895d1826201a11531dbde9de04aBrian Wellington <span><strong class="command">nsupdate</strong></span>
dde4382b7fd55c945ef7f4ae5792099ae3a09883Brian Wellington will attempt determine the correct zone to update based on the
a6f31a3fd079f37ad0a7c75ef2d50842cd01811cBrian Wellington rest of the input.
d8afbf2f30213b2638a4d77207913db576089c02Michael Sawyer <span><strong class="command">class</strong></span>
a6f31a3fd079f37ad0a7c75ef2d50842cd01811cBrian Wellington Specify the default class.
aa3f41bafce993fbd2109ea3803cbce909db1c95Brian Wellington If no <em class="parameter"><code>class</code></em> is specified, the
838f13fbdc513895d1826201a11531dbde9de04aBrian Wellington default class is
838f13fbdc513895d1826201a11531dbde9de04aBrian Wellington <em class="parameter"><code>IN</code></em>.
d8afbf2f30213b2638a4d77207913db576089c02Michael Sawyer <span><strong class="command">ttl</strong></span>
ae8b7e02a8e5d7febba7d79b2c759add95a48f60Brian Wellington Specify the default time to live for records to be added.
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley The value <em class="parameter"><code>none</code></em> will clear the default
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley <span><strong class="command">key</strong></span>
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley Specifies that all updates are to be TSIG-signed using the
97f1a75cf072c2cab98b4bc28c4d2491cfcd3086Bob Halley <em class="parameter"><code>keyname</code></em> <em class="parameter"><code>keysecret</code></em> pair.
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley The <span><strong class="command">key</strong></span> command
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley overrides any key specified on the command line via
4b87939256ede703385e9cab92d3c58d03c31098Mark Andrews <code class="option">-y</code> or <code class="option">-k</code>.
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt <span><strong class="command">prereq nxdomain</strong></span>
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt {domain-name}
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley Requires that no resource record of any type exists with name
4b87939256ede703385e9cab92d3c58d03c31098Mark Andrews <em class="parameter"><code>domain-name</code></em>.
4b87939256ede703385e9cab92d3c58d03c31098Mark Andrews <span><strong class="command">prereq yxdomain</strong></span>
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt {domain-name}
48565891e8f2f8c77b87908b4893f693a08e9ba9Brian Wellington Requires that
48565891e8f2f8c77b87908b4893f693a08e9ba9Brian Wellington <em class="parameter"><code>domain-name</code></em>
48565891e8f2f8c77b87908b4893f693a08e9ba9Brian Wellington exists (has as at least one resource record, of any type).
48565891e8f2f8c77b87908b4893f693a08e9ba9Brian Wellington <span><strong class="command">prereq nxrrset</strong></span>
48565891e8f2f8c77b87908b4893f693a08e9ba9Brian Wellington {domain-name}
48565891e8f2f8c77b87908b4893f693a08e9ba9Brian Wellington Requires that no resource record exists of the specified
48565891e8f2f8c77b87908b4893f693a08e9ba9Brian Wellington <em class="parameter"><code>class</code></em>
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt <em class="parameter"><code>domain-name</code></em>.
48565891e8f2f8c77b87908b4893f693a08e9ba9Brian Wellington <em class="parameter"><code>class</code></em>
48565891e8f2f8c77b87908b4893f693a08e9ba9Brian Wellington is omitted, IN (internet) is assumed.
48565891e8f2f8c77b87908b4893f693a08e9ba9Brian Wellington <span><strong class="command">prereq yxrrset</strong></span>
4b87939256ede703385e9cab92d3c58d03c31098Mark Andrews {domain-name}
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley This requires that a resource record of the specified
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt <em class="parameter"><code>domain-name</code></em>
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt is omitted, IN (internet) is assumed.
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt <span><strong class="command">prereq yxrrset</strong></span>
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt {domain-name}
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt from each set of prerequisites of this form
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt sharing a common
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt <em class="parameter"><code>domain-name</code></em>
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 are combined to form a set of RRs. This set of RRs must
bed86971bf7eb315e9c64f75bba331917f4557cfBob Halley exactly match the set of RRs existing in the zone at the
62f016d5d301713c72a59e83d3ab41170a77f674Mark Andrews <em class="parameter"><code>domain-name</code></em>.
62f016d5d301713c72a59e83d3ab41170a77f674Mark Andrews are written in the standard text representation of the resource
bed86971bf7eb315e9c64f75bba331917f4557cfBob Halley <span><strong class="command">update delete</strong></span>
bed86971bf7eb315e9c64f75bba331917f4557cfBob Halley {domain-name}
62f016d5d301713c72a59e83d3ab41170a77f674Mark Andrews [type [data...]]
bed86971bf7eb315e9c64f75bba331917f4557cfBob Halley Deletes any resource records named
bed86971bf7eb315e9c64f75bba331917f4557cfBob Halley <em class="parameter"><code>domain-name</code></em>.
bed86971bf7eb315e9c64f75bba331917f4557cfBob Halley is provided, only matching resource records will be removed.
bed86971bf7eb315e9c64f75bba331917f4557cfBob Halley The internet class is assumed if
91cd0f93ad34d23e8b09dca337120f64fbe8f0a1Andreas Gustafsson <em class="parameter"><code>class</code></em>
bed86971bf7eb315e9c64f75bba331917f4557cfBob Halley is not supplied. The
bed86971bf7eb315e9c64f75bba331917f4557cfBob Halley is ignored, and is only allowed for compatibility.
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence <span><strong class="command">update add</strong></span>
62f016d5d301713c72a59e83d3ab41170a77f674Mark Andrews {domain-name}
bed86971bf7eb315e9c64f75bba331917f4557cfBob Halley Adds a new resource record with the specified
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson <span><strong class="command">show</strong></span>
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 Displays the current message, containing all of the
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 prerequisites and
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson updates specified since the last send.
386d3a99c190bad55edf44d076e6bd087e230ab8Tatuya JINMEI 神明達哉 <span><strong class="command">send</strong></span>
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson Sends the current message. This is equivalent to entering a
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 <span><strong class="command">answer</strong></span>
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 Displays the answer.
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 <span><strong class="command">debug</strong></span>
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 Turn on debugging.
6da7c87a77ecfd9ccce36f96b4ccd20e1b9cccf1Tatuya JINMEI 神明達哉 Lines beginning with a semicolon are comments and are ignored.
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson The examples below show how
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson <span><strong class="command">nsupdate</strong></span>
1f1d36a87b65186d9f89aac7f456ab1fd2a39ef6Andreas Gustafsson could be used to insert and delete resource records from the
6da7c87a77ecfd9ccce36f96b4ccd20e1b9cccf1Tatuya JINMEI 神明達哉 Notice that the input in each example contains a trailing blank line so
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson a group of commands are sent as one dynamic update request to the
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson master name server for
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson> update delete oldhost.example.com A
6da7c87a77ecfd9ccce36f96b4ccd20e1b9cccf1Tatuya JINMEI 神明達哉> update add newhost.example.com 86400 A 172.16.1.1
6da7c87a77ecfd9ccce36f96b4ccd20e1b9cccf1Tatuya JINMEI 神明達哉 Any A records for
6da7c87a77ecfd9ccce36f96b4ccd20e1b9cccf1Tatuya JINMEI 神明達哉 <span class="type">oldhost.example.com</span>
6da7c87a77ecfd9ccce36f96b4ccd20e1b9cccf1Tatuya JINMEI 神明達哉 And an A record for
6da7c87a77ecfd9ccce36f96b4ccd20e1b9cccf1Tatuya JINMEI 神明達哉 <span class="type">newhost.example.com</span>
6da7c87a77ecfd9ccce36f96b4ccd20e1b9cccf1Tatuya JINMEI 神明達哉 with IP address 172.16.1.1 is added.
6da7c87a77ecfd9ccce36f96b4ccd20e1b9cccf1Tatuya JINMEI 神明達哉 The newly-added record has a 1 day TTL (86400 seconds).
6da7c87a77ecfd9ccce36f96b4ccd20e1b9cccf1Tatuya JINMEI 神明達哉> prereq nxdomain nickname.example.com
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson> update add nickname.example.com 86400 CNAME somehost.example.com
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson The prerequisite condition gets the name server to check that there
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson are no resource records of any type for
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson <span class="type">nickname.example.com</span>.
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson If there are, the update request fails.
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson If this name does not exist, a CNAME for it is added.
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson This ensures that when the CNAME is added, it cannot conflict with the
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson long-standing rule in RFC1034 that a name must not exist as any other
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson record type if it exists as a CNAME.
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson (The rule has been updated for DNSSEC in RFC2535 to allow CNAMEs to have
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein RRSIG, DNSKEY and NSEC records.)
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein<dt><span class="term"><code class="constant">/etc/resolv.conf</code></span></dt>
1d90a73d6d0aa3f82c7e8d638e0013c331835eedAndreas Gustafsson used to identify default name server
1d90a73d6d0aa3f82c7e8d638e0013c331835eedAndreas Gustafsson<dt><span class="term"><code class="constant">/var/run/named/ddns.key</code></span></dt>
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson sets the default TSIG key for use in local-only mode
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson<dt><span class="term"><code class="constant">K{name}.+157.+{random}.key</code></span></dt>
6da7c87a77ecfd9ccce36f96b4ccd20e1b9cccf1Tatuya JINMEI 神明達哉 base-64 encoding of HMAC-MD5 key created by
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson <span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>.
6da7c87a77ecfd9ccce36f96b4ccd20e1b9cccf1Tatuya JINMEI 神明達哉<dt><span class="term"><code class="constant">K{name}.+157.+{random}.private</code></span></dt>
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson base-64 encoding of HMAC-MD5 key created by
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson <span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>.
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉<p><span class="citerefentry"><span class="refentrytitle">RFC2136</span></span>,
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson <span class="citerefentry"><span class="refentrytitle">RFC3007</span></span>,
307d2084502eddc7ce921e5ce439aec3531d90e0Tatuya JINMEI 神明達哉 <span class="citerefentry"><span class="refentrytitle">RFC2104</span></span>,
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson <span class="citerefentry"><span class="refentrytitle">RFC2845</span></span>,
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson <span class="citerefentry"><span class="refentrytitle">RFC1034</span></span>,
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson <span class="citerefentry"><span class="refentrytitle">RFC2535</span></span>,
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson <span class="citerefentry"><span class="refentrytitle">RFC2931</span></span>,
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson <span class="citerefentry"><span class="refentrytitle">ddns-confgen</span>(8)</span>,
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson <span class="citerefentry"><span class="refentrytitle">dnssec-keygen</span>(8)</span>.
6da7c87a77ecfd9ccce36f96b4ccd20e1b9cccf1Tatuya JINMEI 神明達哉 The TSIG key is redundantly stored in two separate files.
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson This is a consequence of nsupdate using the DST library
8e7ce54bef167f582c675ac76c373009595578a3Andreas Gustafsson for its cryptographic operations, and may change in future
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley<a accesskey="p" href="man.named.html">Prev</a>�</td>
96f55bdc736f8559b3a57260db6f0e964c44070dBob Halley<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
bed86971bf7eb315e9c64f75bba331917f4557cfBob Halley<td width="40%" align="right">�<a accesskey="n" href="man.rndc.html">Next</a>
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
b99bfa184bc9375421b5df915eea7dfac6a68a99Evan Hunt<td width="40%" align="right" valign="top">�<span class="application">rndc</span>