Blame bin/nsupdate/nsupdate.docbook

Packit 5ce601
Packit 5ce601
 - Copyright (C) Internet Systems Consortium, Inc. ("ISC")
Packit 5ce601
 -
Packit 5ce601
 - This Source Code Form is subject to the terms of the Mozilla Public
Packit 5ce601
 - License, v. 2.0. If a copy of the MPL was not distributed with this
Packit Service 704ed8
 - file, you can obtain one at https://mozilla.org/MPL/2.0/.
Packit 5ce601
 -
Packit 5ce601
 - See the COPYRIGHT file distributed with this work for additional
Packit 5ce601
 - information regarding copyright ownership.
Packit 5ce601
-->
Packit 5ce601
Packit 5ce601
Packit Service d3afd5
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.nsupdate">
Packit 5ce601
  <info>
Packit 5ce601
    <date>2014-04-18</date>
Packit 5ce601
  </info>
Packit 5ce601
  <refentryinfo>
Packit 5ce601
    <corpname>ISC</corpname>
Packit 5ce601
    <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
Packit 5ce601
  </refentryinfo>
Packit 5ce601
Packit 5ce601
  <refmeta>
Packit 5ce601
    <refentrytitle><application>nsupdate</application></refentrytitle>
Packit 5ce601
    <manvolnum>1</manvolnum>
Packit Service d3afd5
    <refmiscinfo>BIND9</refmiscinfo>
Packit 5ce601
  </refmeta>
Packit 5ce601
  <refnamediv>
Packit 5ce601
    <refname><application>nsupdate</application></refname>
Packit 5ce601
    <refpurpose>Dynamic DNS update utility</refpurpose>
Packit 5ce601
  </refnamediv>
Packit 5ce601
Packit 5ce601
  <docinfo>
Packit 5ce601
    <copyright>
Packit 5ce601
      <year>2000</year>
Packit 5ce601
      <year>2001</year>
Packit 5ce601
      <year>2002</year>
Packit 5ce601
      <year>2003</year>
Packit 5ce601
      <year>2004</year>
Packit 5ce601
      <year>2005</year>
Packit 5ce601
      <year>2006</year>
Packit 5ce601
      <year>2007</year>
Packit 5ce601
      <year>2008</year>
Packit 5ce601
      <year>2009</year>
Packit 5ce601
      <year>2010</year>
Packit 5ce601
      <year>2011</year>
Packit 5ce601
      <year>2012</year>
Packit 5ce601
      <year>2014</year>
Packit 5ce601
      <year>2015</year>
Packit 5ce601
      <year>2016</year>
Packit 5ce601
      <year>2017</year>
Packit 5ce601
      <year>2018</year>
Packit 5ce601
      <year>2019</year>
Packit 5ce601
      <year>2020</year>
Packit 5ce601
      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
Packit 5ce601
    </copyright>
Packit 5ce601
  </docinfo>
Packit 5ce601
Packit 5ce601
  <refsynopsisdiv>
Packit 5ce601
    <cmdsynopsis sepchar=" ">
Packit 5ce601
      <command>nsupdate</command>
Packit 5ce601
      <arg choice="opt" rep="norepeat"><option>-d</option></arg>
Packit 5ce601
      <arg choice="opt" rep="norepeat"><option>-D</option></arg>
Packit 5ce601
      <arg choice="opt" rep="norepeat"><option>-i</option></arg>
Packit 5ce601
      <arg choice="opt" rep="norepeat"><option>-L <replaceable class="parameter">level</replaceable></option></arg>
Packit 5ce601
      <group choice="opt" rep="norepeat">
Packit 5ce601
	<arg choice="opt" rep="norepeat"><option>-g</option></arg>
Packit 5ce601
	<arg choice="opt" rep="norepeat"><option>-o</option></arg>
Packit 5ce601
	<arg choice="opt" rep="norepeat"><option>-l</option></arg>
Packit 5ce601
	<arg choice="opt" rep="norepeat"><option>-y <replaceable class="parameter"><optional>hmac:</optional>keyname:secret</replaceable></option></arg>
Packit 5ce601
	<arg choice="opt" rep="norepeat"><option>-k <replaceable class="parameter">keyfile</replaceable></option></arg>
Packit 5ce601
      </group>
Packit 5ce601
      <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">timeout</replaceable></option></arg>
Packit 5ce601
      <arg choice="opt" rep="norepeat"><option>-u <replaceable class="parameter">udptimeout</replaceable></option></arg>
Packit 5ce601
      <arg choice="opt" rep="norepeat"><option>-r <replaceable class="parameter">udpretries</replaceable></option></arg>
Packit 5ce601
      <arg choice="opt" rep="norepeat"><option>-R <replaceable class="parameter">randomdev</replaceable></option></arg>
Packit 5ce601
      <arg choice="opt" rep="norepeat"><option>-v</option></arg>
Packit 5ce601
      <arg choice="opt" rep="norepeat"><option>-T</option></arg>
Packit 5ce601
      <arg choice="opt" rep="norepeat"><option>-P</option></arg>
Packit 5ce601
      <arg choice="opt" rep="norepeat"><option>-V</option></arg>
Packit 5ce601
      <arg choice="opt" rep="norepeat">filename</arg>
Packit 5ce601
    </cmdsynopsis>
Packit 5ce601
  </refsynopsisdiv>
Packit 5ce601
Packit 5ce601
  <refsection><info><title>DESCRIPTION</title></info>
Packit 5ce601
Packit 5ce601
    <para><command>nsupdate</command>
Packit 5ce601
      is used to submit Dynamic DNS Update requests as defined in RFC 2136
Packit 5ce601
      to a name server.
Packit 5ce601
      This allows resource records to be added or removed from a zone
Packit 5ce601
      without manually editing the zone file.
Packit 5ce601
      A single update request can contain requests to add or remove more than
Packit 5ce601
      one
Packit 5ce601
      resource record.
Packit 5ce601
    </para>
Packit 5ce601
    <para>
Packit 5ce601
      Zones that are under dynamic control via
Packit 5ce601
      <command>nsupdate</command>
Packit 5ce601
      or a DHCP server should not be edited by hand.
Packit 5ce601
      Manual edits could
Packit 5ce601
      conflict with dynamic updates and cause data to be lost.
Packit 5ce601
    </para>
Packit 5ce601
    <para>
Packit 5ce601
      The resource records that are dynamically added or removed with
Packit 5ce601
      <command>nsupdate</command>
Packit 5ce601
      have to be in the same zone.
Packit 5ce601
      Requests are sent to the zone's master server.
Packit 5ce601
      This is identified by the MNAME field of the zone's SOA record.
Packit 5ce601
    </para>
Packit 5ce601
    <para>
Packit 5ce601
      Transaction signatures can be used to authenticate the Dynamic
Packit 5ce601
      DNS updates.  These use the TSIG resource record type described
Packit 5ce601
      in RFC 2845 or the SIG(0) record described in RFC 2535 and
Packit 5ce601
      RFC 2931 or GSS-TSIG as described in RFC 3645.
Packit 5ce601
    </para>
Packit 5ce601
    <para>
Packit 5ce601
      TSIG relies on
Packit 5ce601
      a shared secret that should only be known to
Packit 5ce601
      <command>nsupdate</command> and the name server.
Packit 5ce601
      For instance, suitable <type>key</type> and
Packit 5ce601
      <type>server</type> statements would be added to
Packit 5ce601
      <filename>/etc/named.conf</filename> so that the name server
Packit 5ce601
      can associate the appropriate secret key and algorithm with
Packit 5ce601
      the IP address of the client application that will be using
Packit 5ce601
      TSIG authentication. You can use <command>ddns-confgen</command>
Packit 5ce601
      to generate suitable configuration fragments.
Packit 5ce601
      <command>nsupdate</command>
Packit 5ce601
      uses the <option>-y</option> or <option>-k</option> options
Packit 5ce601
      to provide the TSIG shared secret.  These options are mutually exclusive.
Packit 5ce601
    </para>
Packit 5ce601
    <para>
Packit 5ce601
      SIG(0) uses public key cryptography.
Packit 5ce601
      To use a SIG(0) key, the public key must be stored in a KEY
Packit 5ce601
      record in a zone served by the name server.
Packit 5ce601
    </para>
Packit 5ce601
    <para>
Packit 5ce601
      GSS-TSIG uses Kerberos credentials.  Standard GSS-TSIG mode
Packit 5ce601
      is switched on with the <option>-g</option> flag.  A
Packit 5ce601
      non-standards-compliant variant of GSS-TSIG used by Windows
Packit 5ce601
      2000 can be switched on with the <option>-o</option> flag.
Packit 5ce601
    </para>
Packit 5ce601
  </refsection>
Packit 5ce601
Packit 5ce601
  <refsection><info><title>OPTIONS</title></info>
Packit 5ce601
Packit 5ce601
Packit 5ce601
    <variablelist>
Packit 5ce601
      <varlistentry>
Packit 5ce601
	<term>-d</term>
Packit 5ce601
	<listitem>
Packit 5ce601
	  <para>
Packit 5ce601
	    Debug mode. This provides tracing information about the
Packit 5ce601
	    update requests that are made and the replies received
Packit 5ce601
	    from the name server.
Packit 5ce601
	  </para>
Packit 5ce601
	</listitem>
Packit 5ce601
      </varlistentry>
Packit 5ce601
Packit 5ce601
      <varlistentry>
Packit 5ce601
	<term>-D</term>
Packit 5ce601
	<listitem>
Packit 5ce601
	  <para>
Packit 5ce601
	    Extra debug mode.
Packit 5ce601
	  </para>
Packit 5ce601
	</listitem>
Packit 5ce601
      </varlistentry>
Packit 5ce601
Packit 5ce601
      <varlistentry>
Packit 5ce601
	<term>-i</term>
Packit 5ce601
	<listitem>
Packit 5ce601
	  <para>
Packit 5ce601
	    Force interactive mode, even when standard input is not a terminal.
Packit 5ce601
	  </para>
Packit 5ce601
	</listitem>
Packit 5ce601
      </varlistentry>
Packit 5ce601
Packit 5ce601
      <varlistentry>
Packit 5ce601
	<term>-k <replaceable class="parameter">keyfile</replaceable></term>
Packit 5ce601
	<listitem>
Packit 5ce601
	  <para>
Packit 5ce601
	    The file containing the TSIG authentication key.
Packit 5ce601
	    Keyfiles may be in two formats: a single file containing
Packit 5ce601
	    a <filename>named.conf</filename>-format <command>key</command>
Packit 5ce601
	    statement, which may be generated automatically by
Packit 5ce601
	    <command>ddns-confgen</command>, or a pair of files whose names are
Packit 5ce601
	    of the format <filename>K{name}.+157.+{random}.key</filename> and
Packit 5ce601
	    <filename>K{name}.+157.+{random}.private</filename>, which can be
Packit 5ce601
	    generated by <command>dnssec-keygen</command>.
Packit 5ce601
	    The <option>-k</option> may also be used to specify a SIG(0) key used
Packit 5ce601
	    to authenticate Dynamic DNS update requests.  In this case, the key
Packit 5ce601
	    specified is not an HMAC-MD5 key.
Packit 5ce601
	  </para>
Packit 5ce601
	</listitem>
Packit 5ce601
      </varlistentry>
Packit 5ce601
Packit 5ce601
      <varlistentry>
Packit 5ce601
	<term>-l</term>
Packit 5ce601
	<listitem>
Packit 5ce601
	  <para>
Packit 5ce601
	    Local-host only mode. This sets the server address to
Packit 5ce601
	    localhost (disabling the <command>server</command> so that the server
Packit 5ce601
	    address cannot be overridden).  Connections to the local server will
Packit 5ce601
	    use a TSIG key found in <filename>/var/run/named/session.key</filename>,
Packit 5ce601
	    which is automatically generated by <command>named</command> if any
Packit 5ce601
	    local master zone has set <command>update-policy</command> to
Packit 5ce601
	    <command>local</command>.  The location of this key file can be
Packit 5ce601
	    overridden with the <option>-k</option> option.
Packit 5ce601
	  </para>
Packit 5ce601
	</listitem>
Packit 5ce601
      </varlistentry>
Packit 5ce601
Packit 5ce601
      <varlistentry>
Packit 5ce601
	<term>-L <replaceable class="parameter">level</replaceable></term>
Packit 5ce601
	<listitem>
Packit 5ce601
	  <para>
Packit 5ce601
	    Set the logging debug level.  If zero, logging is disabled.
Packit 5ce601
	  </para>
Packit 5ce601
	</listitem>
Packit 5ce601
      </varlistentry>
Packit 5ce601
Packit 5ce601
      <varlistentry>
Packit 5ce601
	<term>-p <replaceable class="parameter">port</replaceable></term>
Packit 5ce601
	<listitem>
Packit 5ce601
	  <para>
Packit 5ce601
	    Set the port to use for connections to a name server. The
Packit 5ce601
	    default is 53.
Packit 5ce601
	  </para>
Packit 5ce601
	</listitem>
Packit 5ce601
      </varlistentry>
Packit 5ce601
Packit 5ce601
      <varlistentry>
Packit 5ce601
	<term>-P</term>
Packit 5ce601
	<listitem>
Packit 5ce601
	  <para>
Packit 5ce601
	    Print the list of private BIND-specific resource record
Packit 5ce601
	    types whose format is understood
Packit 5ce601
	    by <command>nsupdate</command>. See also
Packit 5ce601
	    the <option>-T</option> option.
Packit 5ce601
	  </para>
Packit 5ce601
	</listitem>
Packit 5ce601
      </varlistentry>
Packit 5ce601
Packit 5ce601
      <varlistentry>
Packit 5ce601
	<term>-r <replaceable class="parameter">udpretries</replaceable></term>
Packit 5ce601
	<listitem>
Packit 5ce601
	  <para>
Packit 5ce601
	    The number of UDP retries. The default is 3. If zero, only
Packit 5ce601
	    one update request will be made.
Packit 5ce601
	  </para>
Packit 5ce601
	</listitem>
Packit 5ce601
      </varlistentry>
Packit 5ce601
Packit 5ce601
      <varlistentry>
Packit 5ce601
	<term>-R <replaceable class="parameter">randomdev</replaceable></term>
Packit 5ce601
	<listitem>
Packit 5ce601
	<para>
Packit 5ce601
	  Where to obtain randomness. If the operating system
Packit 5ce601
	  does not provide a <filename>/dev/random</filename> or
Packit 5ce601
	  equivalent device, the default source of randomness is keyboard
Packit 5ce601
	  input.  <filename>randomdev</filename> specifies the name of
Packit 5ce601
	  a character device or file containing random data to be used
Packit 5ce601
	  instead of the default.  The special value
Packit 5ce601
	  <filename>keyboard</filename> indicates that keyboard input
Packit 5ce601
	  should be used.  This option may be specified multiple times.
Packit 5ce601
	</para>
Packit 5ce601
	</listitem>
Packit 5ce601
      </varlistentry>
Packit 5ce601
Packit 5ce601
      <varlistentry>
Packit 5ce601
	<term>-t <replaceable class="parameter">timeout</replaceable></term>
Packit 5ce601
	<listitem>
Packit 5ce601
	  <para>
Packit 5ce601
	    The maximum time an update request can take before it is
Packit 5ce601
	    aborted. The default is 300 seconds. Zero can be used to
Packit 5ce601
	    disable the timeout.
Packit 5ce601
	  </para>
Packit 5ce601
	</listitem>
Packit 5ce601
      </varlistentry>
Packit 5ce601
Packit 5ce601
      <varlistentry>
Packit 5ce601
	<term>-T</term>
Packit 5ce601
	<listitem>
Packit 5ce601
	  <para>
Packit 5ce601
	    Print the list of IANA standard resource record types
Packit 5ce601
	    whose format is understood by <command>nsupdate</command>.
Packit 5ce601
	    <command>nsupdate</command> will exit after the lists are
Packit 5ce601
	    printed. The <option>-T</option> option can be combined
Packit 5ce601
	    with the <option>-P</option> option.
Packit 5ce601
	  </para>
Packit 5ce601
	  <para>
Packit 5ce601
	    Other types can be entered using "TYPEXXXXX" where "XXXXX" is the
Packit 5ce601
	    decimal value of the type with no leading zeros.  The rdata,
Packit 5ce601
	    if present, will be parsed using the UNKNOWN rdata format,
Packit 5ce601
	    (<backslash> <hash> <space> <length>
Packit 5ce601
	    <space> <hexstring>).
Packit 5ce601
	  </para>
Packit 5ce601
	</listitem>
Packit 5ce601
      </varlistentry>
Packit 5ce601
Packit 5ce601
      <varlistentry>
Packit 5ce601
	<term>-u <replaceable class="parameter">udptimeout</replaceable></term>
Packit 5ce601
	<listitem>
Packit 5ce601
	  <para>
Packit 5ce601
	    The UDP retry interval. The default is 3 seconds. If zero,
Packit 5ce601
	    the interval will be computed from the timeout interval and
Packit 5ce601
	    number of UDP retries.
Packit 5ce601
	  </para>
Packit 5ce601
	</listitem>
Packit 5ce601
      </varlistentry>
Packit 5ce601
Packit 5ce601
      <varlistentry>
Packit 5ce601
	<term>-v</term>
Packit 5ce601
	<listitem>
Packit 5ce601
	  <para>
Packit 5ce601
	    Use TCP even for small update requests.
Packit 5ce601
	    By default, <command>nsupdate</command>
Packit 5ce601
	    uses UDP to send update requests to the name server unless they are too
Packit 5ce601
	    large to fit in a UDP request in which case TCP will be used.
Packit 5ce601
	    TCP may be preferable when a batch of update requests is made.
Packit 5ce601
	  </para>
Packit 5ce601
	</listitem>
Packit 5ce601
      </varlistentry>
Packit 5ce601
Packit 5ce601
      <varlistentry>
Packit 5ce601
	<term>-V</term>
Packit 5ce601
	<listitem>
Packit 5ce601
	  <para>
Packit 5ce601
	    Print the version number and exit.
Packit 5ce601
	  </para>
Packit 5ce601
	</listitem>
Packit 5ce601
      </varlistentry>
Packit 5ce601
Packit 5ce601
      <varlistentry>
Packit 5ce601
	<term>-y <replaceable class="parameter"><optional>hmac:</optional>keyname:secret</replaceable></term>
Packit 5ce601
	<listitem>
Packit 5ce601
	  <para>
Packit 5ce601
	    Literal TSIG authentication key.
Packit 5ce601
	    <parameter>keyname</parameter> is the name of the key, and
Packit 5ce601
	    <parameter>secret</parameter> is the base64 encoded shared secret.
Packit 5ce601
	    <parameter>hmac</parameter> is the name of the key algorithm;
Packit 5ce601
	    valid choices are <literal>hmac-md5</literal>,
Packit 5ce601
	    <literal>hmac-sha1</literal>, <literal>hmac-sha224</literal>,
Packit 5ce601
	    <literal>hmac-sha256</literal>, <literal>hmac-sha384</literal>, or
Packit 5ce601
	    <literal>hmac-sha512</literal>.  If <parameter>hmac</parameter>
Packit 5ce601
	    is not specified, the default is <literal>hmac-md5</literal>
Packit 5ce601
	    or if MD5 was disabled <literal>hmac-sha256</literal>.
Packit 5ce601
	  </para>
Packit 5ce601
	  <para>
Packit 5ce601
	    NOTE: Use of the <option>-y</option> option is discouraged because the
Packit 5ce601
	    shared secret is supplied as a command line argument in clear text.
Packit 5ce601
	    This may be visible in the output from
Packit 5ce601
	    <citerefentry>
Packit 5ce601
	      <refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum>
Packit 5ce601
	    </citerefentry>
Packit 5ce601
	    or in a history file maintained by the user's shell.
Packit 5ce601
	  </para>
Packit 5ce601
	</listitem>
Packit 5ce601
      </varlistentry>
Packit 5ce601
Packit 5ce601
    </variablelist>
Packit 5ce601
  </refsection>
Packit 5ce601
Packit 5ce601
  <refsection><info><title>INPUT FORMAT</title></info>
Packit 5ce601
Packit 5ce601
    <para><command>nsupdate</command>
Packit 5ce601
      reads input from
Packit 5ce601
      <parameter>filename</parameter>
Packit 5ce601
      or standard input.
Packit 5ce601
      Each command is supplied on exactly one line of input.
Packit 5ce601
      Some commands are for administrative purposes.
Packit 5ce601
      The others are either update instructions or prerequisite checks on the
Packit 5ce601
      contents of the zone.
Packit 5ce601
      These checks set conditions that some name or set of
Packit 5ce601
      resource records (RRset) either exists or is absent from the zone.
Packit 5ce601
      These conditions must be met if the entire update request is to succeed.
Packit 5ce601
      Updates will be rejected if the tests for the prerequisite conditions
Packit 5ce601
      fail.
Packit 5ce601
    </para>
Packit 5ce601
    <para>
Packit 5ce601
      Every update request consists of zero or more prerequisites
Packit 5ce601
      and zero or more updates.
Packit 5ce601
      This allows a suitably authenticated update request to proceed if some
Packit 5ce601
      specified resource records are present or missing from the zone.
Packit 5ce601
      A blank input line (or the <command>send</command> command)
Packit 5ce601
      causes the
Packit 5ce601
      accumulated commands to be sent as one Dynamic DNS update request to the
Packit 5ce601
      name server.
Packit 5ce601
    </para>
Packit 5ce601
    <para>
Packit 5ce601
      The command formats and their meaning are as follows:
Packit 5ce601
      <variablelist>
Packit 5ce601
Packit 5ce601
	<varlistentry>
Packit 5ce601
	  <term>
Packit 5ce601
	      <command>server</command>
Packit 5ce601
	      <arg choice="req" rep="norepeat">servername</arg>
Packit 5ce601
	      <arg choice="opt" rep="norepeat">port</arg>
Packit 5ce601
	    </term>
Packit 5ce601
	  <listitem>
Packit 5ce601
	    <para>
Packit 5ce601
	      Sends all dynamic update requests to the name server
Packit 5ce601
	      <parameter>servername</parameter>.
Packit 5ce601
	      When no server statement is provided,
Packit 5ce601
	      <command>nsupdate</command>
Packit 5ce601
	      will send updates to the master server of the correct zone.
Packit 5ce601
	      The MNAME field of that zone's SOA record will identify the
Packit 5ce601
	      master
Packit 5ce601
	      server for that zone.
Packit 5ce601
	      <parameter>port</parameter>
Packit 5ce601
	      is the port number on
Packit 5ce601
	      <parameter>servername</parameter>
Packit 5ce601
	      where the dynamic update requests get sent.
Packit 5ce601
	      If no port number is specified, the default DNS port number of
Packit 5ce601
	      53 is
Packit 5ce601
	      used.
Packit 5ce601
	    </para>
Packit 5ce601
	  </listitem>
Packit 5ce601
	</varlistentry>
Packit 5ce601
Packit 5ce601
	<varlistentry>
Packit 5ce601
	  <term>
Packit 5ce601
	      <command>local</command>
Packit 5ce601
	      <arg choice="req" rep="norepeat">address</arg>
Packit 5ce601
	      <arg choice="opt" rep="norepeat">port</arg>
Packit 5ce601
	    </term>
Packit 5ce601
	  <listitem>
Packit 5ce601
	    <para>
Packit 5ce601
	      Sends all dynamic update requests using the local
Packit 5ce601
	      <parameter>address</parameter>.
Packit 5ce601
Packit 5ce601
	      When no local statement is provided,
Packit 5ce601
	      <command>nsupdate</command>
Packit 5ce601
	      will send updates using an address and port chosen by the
Packit 5ce601
	      system.
Packit 5ce601
	      <parameter>port</parameter>
Packit 5ce601
	      can additionally be used to make requests come from a specific
Packit 5ce601
	      port.
Packit 5ce601
	      If no port number is specified, the system will assign one.
Packit 5ce601
	    </para>
Packit 5ce601
	  </listitem>
Packit 5ce601
	</varlistentry>
Packit 5ce601
Packit 5ce601
	<varlistentry>
Packit 5ce601
	  <term>
Packit 5ce601
	      <command>zone</command>
Packit 5ce601
	      <arg choice="req" rep="norepeat">zonename</arg>
Packit 5ce601
	    </term>
Packit 5ce601
	  <listitem>
Packit 5ce601
	    <para>
Packit 5ce601
	      Specifies that all updates are to be made to the zone
Packit 5ce601
	      <parameter>zonename</parameter>.
Packit 5ce601
	      If no
Packit 5ce601
	      <parameter>zone</parameter>
Packit 5ce601
	      statement is provided,
Packit 5ce601
	      <command>nsupdate</command>
Packit 5ce601
	      will attempt determine the correct zone to update based on the
Packit 5ce601
	      rest of the input.
Packit 5ce601
	    </para>
Packit 5ce601
	  </listitem>
Packit 5ce601
	</varlistentry>
Packit 5ce601
Packit 5ce601
	<varlistentry>
Packit 5ce601
	  <term>
Packit 5ce601
	      <command>class</command>
Packit 5ce601
	      <arg choice="req" rep="norepeat">classname</arg>
Packit 5ce601
	    </term>
Packit 5ce601
	  <listitem>
Packit 5ce601
	    <para>
Packit 5ce601
	      Specify the default class.
Packit 5ce601
	      If no <parameter>class</parameter> is specified, the
Packit 5ce601
	      default class is
Packit 5ce601
	      <parameter>IN</parameter>.
Packit 5ce601
	    </para>
Packit 5ce601
	  </listitem>
Packit 5ce601
	</varlistentry>
Packit 5ce601
Packit 5ce601
	<varlistentry>
Packit 5ce601
	  <term>
Packit 5ce601
	      <command>ttl</command>
Packit 5ce601
	      <arg choice="req" rep="norepeat">seconds</arg>
Packit 5ce601
	    </term>
Packit 5ce601
	  <listitem>
Packit 5ce601
	    <para>
Packit 5ce601
	      Specify the default time to live for records to be added.
Packit 5ce601
	      The value <parameter>none</parameter> will clear the default
Packit 5ce601
	      ttl.
Packit 5ce601
	    </para>
Packit 5ce601
	  </listitem>
Packit 5ce601
	</varlistentry>
Packit 5ce601
Packit 5ce601
	<varlistentry>
Packit 5ce601
	  <term>
Packit 5ce601
	      <command>key</command>
Packit 5ce601
	      <arg choice="opt" rep="norepeat">hmac:</arg><arg choice="req" rep="norepeat">keyname</arg>
Packit 5ce601
	      <arg choice="req" rep="norepeat">secret</arg>
Packit 5ce601
	    </term>
Packit 5ce601
	  <listitem>
Packit 5ce601
	    <para>
Packit 5ce601
	      Specifies that all updates are to be TSIG-signed using the
Packit 5ce601
	      <parameter>keyname</parameter> <parameter>secret</parameter> pair.
Packit 5ce601
	      If <parameter>hmac</parameter> is specified, then it sets the
Packit 5ce601
	      signing algorithm in use; the default is
Packit 5ce601
	      <literal>hmac-md5</literal> or if MD5 was disabled
Packit 5ce601
	      <literal>hmac-sha256</literal>.  The <command>key</command>
Packit 5ce601
	      command overrides any key specified on the command line via
Packit 5ce601
	      <option>-y</option> or <option>-k</option>.
Packit 5ce601
	    </para>
Packit 5ce601
	  </listitem>
Packit 5ce601
	</varlistentry>
Packit 5ce601
Packit 5ce601
	<varlistentry>
Packit 5ce601
	  <term>
Packit 5ce601
	    <command>gsstsig</command>
Packit 5ce601
	  </term>
Packit 5ce601
	  <listitem>
Packit 5ce601
	    <para>
Packit 5ce601
	      Use GSS-TSIG to sign the updated.  This is equivalent to
Packit 5ce601
	      specifying <option>-g</option> on the command line.
Packit 5ce601
	    </para>
Packit 5ce601
	  </listitem>
Packit 5ce601
	</varlistentry>
Packit 5ce601
Packit 5ce601
	<varlistentry>
Packit 5ce601
	  <term>
Packit 5ce601
	    <command>oldgsstsig</command>
Packit 5ce601
	  </term>
Packit 5ce601
	  <listitem>
Packit 5ce601
	    <para>
Packit 5ce601
	      Use the Windows 2000 version of GSS-TSIG to sign the updated.
Packit 5ce601
	      This is equivalent to specifying <option>-o</option> on the
Packit 5ce601
	      command line.
Packit 5ce601
	    </para>
Packit 5ce601
	  </listitem>
Packit 5ce601
	</varlistentry>
Packit 5ce601
Packit 5ce601
	<varlistentry>
Packit 5ce601
	  <term>
Packit 5ce601
	    <command>realm</command>
Packit 5ce601
	    <arg choice="req" rep="norepeat"><optional>realm_name</optional></arg>
Packit 5ce601
	  </term>
Packit 5ce601
	  <listitem>
Packit 5ce601
	    <para>
Packit 5ce601
	      When using GSS-TSIG use <parameter>realm_name</parameter> rather
Packit 5ce601
	      than the default realm in <filename>krb5.conf</filename>.  If no
Packit 5ce601
	      realm is specified the saved realm is cleared.
Packit 5ce601
	    </para>
Packit 5ce601
	  </listitem>
Packit 5ce601
	</varlistentry>
Packit 5ce601
Packit 5ce601
	<varlistentry>
Packit 5ce601
	  <term>
Packit 5ce601
	    <command>check-names</command>
Packit 5ce601
	    <arg choice="req" rep="norepeat"><optional>yes_or_no</optional></arg>
Packit 5ce601
	  </term>
Packit 5ce601
	  <listitem>
Packit 5ce601
	    <para>
Packit 5ce601
	      Turn on or off check-names processing on records to
Packit 5ce601
	      be added.  Check-names has no effect on prerequisites
Packit 5ce601
	      or records to be deleted.  By default check-names
Packit 5ce601
	      processing is on.  If check-names processing fails
Packit 5ce601
	      the record will not be added to the UPDATE message.
Packit 5ce601
	    </para>
Packit 5ce601
	  </listitem>
Packit 5ce601
	</varlistentry>
Packit 5ce601
Packit 5ce601
	<varlistentry>
Packit 5ce601
	  <term>
Packit 5ce601
	      <command><optional>prereq</optional> nxdomain</command>
Packit 5ce601
	      <arg choice="req" rep="norepeat">domain-name</arg>
Packit 5ce601
	    </term>
Packit 5ce601
	  <listitem>
Packit 5ce601
	    <para>
Packit 5ce601
	      Requires that no resource record of any type exists with name
Packit 5ce601
	      <parameter>domain-name</parameter>.
Packit 5ce601
	    </para>
Packit 5ce601
	  </listitem>
Packit 5ce601
	</varlistentry>
Packit 5ce601
Packit 5ce601
Packit 5ce601
	<varlistentry>
Packit 5ce601
	  <term>
Packit 5ce601
	      <command><optional>prereq</optional> yxdomain</command>
Packit 5ce601
	      <arg choice="req" rep="norepeat">domain-name</arg>
Packit 5ce601
	    </term>
Packit 5ce601
	  <listitem>
Packit 5ce601
	    <para>
Packit 5ce601
	      Requires that
Packit 5ce601
	      <parameter>domain-name</parameter>
Packit 5ce601
	      exists (has as at least one resource record, of any type).
Packit 5ce601
	    </para>
Packit 5ce601
	  </listitem>
Packit 5ce601
	</varlistentry>
Packit 5ce601
Packit 5ce601
	<varlistentry>
Packit 5ce601
	  <term>
Packit 5ce601
	      <command><optional>prereq</optional> nxrrset</command>
Packit 5ce601
	      <arg choice="req" rep="norepeat">domain-name</arg>
Packit 5ce601
	      <arg choice="opt" rep="norepeat">class</arg>
Packit 5ce601
	      <arg choice="req" rep="norepeat">type</arg>
Packit 5ce601
	    </term>
Packit 5ce601
	  <listitem>
Packit 5ce601
	    <para>
Packit 5ce601
	      Requires that no resource record exists of the specified
Packit 5ce601
	      <parameter>type</parameter>,
Packit 5ce601
	      <parameter>class</parameter>
Packit 5ce601
	      and
Packit 5ce601
	      <parameter>domain-name</parameter>.
Packit 5ce601
	      If
Packit 5ce601
	      <parameter>class</parameter>
Packit 5ce601
	      is omitted, IN (internet) is assumed.
Packit 5ce601
	    </para>
Packit 5ce601
	  </listitem>
Packit 5ce601
	</varlistentry>
Packit 5ce601
Packit 5ce601
Packit 5ce601
	<varlistentry>
Packit 5ce601
	  <term>
Packit 5ce601
	      <command><optional>prereq</optional> yxrrset</command>
Packit 5ce601
	      <arg choice="req" rep="norepeat">domain-name</arg>
Packit 5ce601
	      <arg choice="opt" rep="norepeat">class</arg>
Packit 5ce601
	      <arg choice="req" rep="norepeat">type</arg>
Packit 5ce601
	    </term>
Packit 5ce601
	  <listitem>
Packit 5ce601
	    <para>
Packit 5ce601
	      This requires that a resource record of the specified
Packit 5ce601
	      <parameter>type</parameter>,
Packit 5ce601
	      <parameter>class</parameter>
Packit 5ce601
	      and
Packit 5ce601
	      <parameter>domain-name</parameter>
Packit 5ce601
	      must exist.
Packit 5ce601
	      If
Packit 5ce601
	      <parameter>class</parameter>
Packit 5ce601
	      is omitted, IN (internet) is assumed.
Packit 5ce601
	    </para>
Packit 5ce601
	  </listitem>
Packit 5ce601
	</varlistentry>
Packit 5ce601
Packit 5ce601
	<varlistentry>
Packit 5ce601
	  <term>
Packit 5ce601
	      <command><optional>prereq</optional> yxrrset</command>
Packit 5ce601
	      <arg choice="req" rep="norepeat">domain-name</arg>
Packit 5ce601
	      <arg choice="opt" rep="norepeat">class</arg>
Packit 5ce601
	      <arg choice="req" rep="norepeat">type</arg>
Packit 5ce601
	      <arg choice="req" rep="repeat">data</arg>
Packit 5ce601
	    </term>
Packit 5ce601
	  <listitem>
Packit 5ce601
	    <para>
Packit 5ce601
	      The
Packit 5ce601
	      <parameter>data</parameter>
Packit 5ce601
	      from each set of prerequisites of this form
Packit 5ce601
	      sharing a common
Packit 5ce601
	      <parameter>type</parameter>,
Packit 5ce601
	      <parameter>class</parameter>,
Packit 5ce601
	      and
Packit 5ce601
	      <parameter>domain-name</parameter>
Packit 5ce601
	      are combined to form a set of RRs.  This set of RRs must
Packit 5ce601
	      exactly match the set of RRs existing in the zone at the
Packit 5ce601
	      given
Packit 5ce601
	      <parameter>type</parameter>,
Packit 5ce601
	      <parameter>class</parameter>,
Packit 5ce601
	      and
Packit 5ce601
	      <parameter>domain-name</parameter>.
Packit 5ce601
	      The
Packit 5ce601
	      <parameter>data</parameter>
Packit 5ce601
	      are written in the standard text representation of the resource
Packit 5ce601
	      record's
Packit 5ce601
	      RDATA.
Packit 5ce601
	    </para>
Packit 5ce601
	  </listitem>
Packit 5ce601
	</varlistentry>
Packit 5ce601
Packit 5ce601
	<varlistentry>
Packit 5ce601
	  <term>
Packit 5ce601
	      <command><optional>update</optional> del<optional>ete</optional></command>
Packit 5ce601
	      <arg choice="req" rep="norepeat">domain-name</arg>
Packit 5ce601
	      <arg choice="opt" rep="norepeat">ttl</arg>
Packit 5ce601
	      <arg choice="opt" rep="norepeat">class</arg>
Packit 5ce601
	      <arg choice="opt" rep="norepeat">type <arg choice="opt" rep="repeat">data</arg></arg>
Packit 5ce601
	    </term>
Packit 5ce601
	  <listitem>
Packit 5ce601
	    <para>
Packit 5ce601
	      Deletes any resource records named
Packit 5ce601
	      <parameter>domain-name</parameter>.
Packit 5ce601
	      If
Packit 5ce601
	      <parameter>type</parameter>
Packit 5ce601
	      and
Packit 5ce601
	      <parameter>data</parameter>
Packit 5ce601
	      is provided, only matching resource records will be removed.
Packit 5ce601
	      The internet class is assumed if
Packit 5ce601
	      <parameter>class</parameter>
Packit 5ce601
	      is not supplied.  The
Packit 5ce601
	      <parameter>ttl</parameter>
Packit 5ce601
	      is ignored, and is only allowed for compatibility.
Packit 5ce601
	    </para>
Packit 5ce601
	  </listitem>
Packit 5ce601
	</varlistentry>
Packit 5ce601
Packit 5ce601
	<varlistentry>
Packit 5ce601
	  <term>
Packit 5ce601
	      <command><optional>update</optional> add</command>
Packit 5ce601
	      <arg choice="req" rep="norepeat">domain-name</arg>
Packit 5ce601
	      <arg choice="req" rep="norepeat">ttl</arg>
Packit 5ce601
	      <arg choice="opt" rep="norepeat">class</arg>
Packit 5ce601
	      <arg choice="req" rep="norepeat">type</arg>
Packit 5ce601
	      <arg choice="req" rep="repeat">data</arg>
Packit 5ce601
	    </term>
Packit 5ce601
	  <listitem>
Packit 5ce601
	    <para>
Packit 5ce601
	      Adds a new resource record with the specified
Packit 5ce601
	      <parameter>ttl</parameter>,
Packit 5ce601
	      <parameter>class</parameter>
Packit 5ce601
	      and
Packit 5ce601
	      <parameter>data</parameter>.
Packit 5ce601
	    </para>
Packit 5ce601
	  </listitem>
Packit 5ce601
	</varlistentry>
Packit 5ce601
Packit 5ce601
	<varlistentry>
Packit 5ce601
	  <term>
Packit 5ce601
	      <command>show</command>
Packit 5ce601
	    </term>
Packit 5ce601
	  <listitem>
Packit 5ce601
	    <para>
Packit 5ce601
	      Displays the current message, containing all of the
Packit 5ce601
	      prerequisites and
Packit 5ce601
	      updates specified since the last send.
Packit 5ce601
	    </para>
Packit 5ce601
	  </listitem>
Packit 5ce601
	</varlistentry>
Packit 5ce601
Packit 5ce601
	<varlistentry>
Packit 5ce601
	  <term>
Packit 5ce601
	      <command>send</command>
Packit 5ce601
	    </term>
Packit 5ce601
	  <listitem>
Packit 5ce601
	    <para>
Packit 5ce601
	      Sends the current message.  This is equivalent to entering a
Packit 5ce601
	      blank line.
Packit 5ce601
	    </para>
Packit 5ce601
	  </listitem>
Packit 5ce601
	</varlistentry>
Packit 5ce601
Packit 5ce601
	<varlistentry>
Packit 5ce601
	  <term>
Packit 5ce601
	      <command>answer</command>
Packit 5ce601
	    </term>
Packit 5ce601
	  <listitem>
Packit 5ce601
	    <para>
Packit 5ce601
	      Displays the answer.
Packit 5ce601
	    </para>
Packit 5ce601
	  </listitem>
Packit 5ce601
	</varlistentry>
Packit 5ce601
Packit 5ce601
	<varlistentry>
Packit 5ce601
	  <term>
Packit 5ce601
	      <command>debug</command>
Packit 5ce601
	    </term>
Packit 5ce601
	  <listitem>
Packit 5ce601
	    <para>
Packit 5ce601
	      Turn on debugging.
Packit 5ce601
	    </para>
Packit 5ce601
	  </listitem>
Packit 5ce601
	</varlistentry>
Packit 5ce601
Packit 5ce601
	<varlistentry>
Packit 5ce601
	  <term>
Packit 5ce601
	      <command>version</command>
Packit 5ce601
	    </term>
Packit 5ce601
	  <listitem>
Packit 5ce601
	    <para>
Packit 5ce601
	      Print version number.
Packit 5ce601
	    </para>
Packit 5ce601
	  </listitem>
Packit 5ce601
	</varlistentry>
Packit 5ce601
Packit 5ce601
	<varlistentry>
Packit 5ce601
	  <term>
Packit 5ce601
	      <command>help</command>
Packit 5ce601
	    </term>
Packit 5ce601
	  <listitem>
Packit 5ce601
	    <para>
Packit 5ce601
	      Print a list of commands.
Packit 5ce601
	    </para>
Packit 5ce601
	  </listitem>
Packit 5ce601
	</varlistentry>
Packit 5ce601
Packit 5ce601
      </variablelist>
Packit 5ce601
    </para>
Packit 5ce601
Packit 5ce601
    <para>
Packit 5ce601
      Lines beginning with a semicolon are comments and are ignored.
Packit 5ce601
    </para>
Packit 5ce601
Packit 5ce601
  </refsection>
Packit 5ce601
Packit 5ce601
  <refsection><info><title>EXAMPLES</title></info>
Packit 5ce601
Packit 5ce601
    <para>
Packit 5ce601
      The examples below show how
Packit 5ce601
      <command>nsupdate</command>
Packit 5ce601
      could be used to insert and delete resource records from the
Packit 5ce601
      <type>example.com</type>
Packit 5ce601
      zone.
Packit 5ce601
      Notice that the input in each example contains a trailing blank line so
Packit 5ce601
      that
Packit 5ce601
      a group of commands are sent as one dynamic update request to the
Packit 5ce601
      master name server for
Packit 5ce601
      <type>example.com</type>.
Packit 5ce601
Packit 5ce601
      <programlisting>
Packit 5ce601
# nsupdate
Packit 5ce601
> update delete oldhost.example.com A
Packit 5ce601
> update add newhost.example.com 86400 A 172.16.1.1
Packit 5ce601
> send
Packit 5ce601
</programlisting>
Packit 5ce601
    </para>
Packit 5ce601
    <para>
Packit 5ce601
      Any A records for
Packit 5ce601
      <type>oldhost.example.com</type>
Packit 5ce601
      are deleted.
Packit 5ce601
      And an A record for
Packit 5ce601
      <type>newhost.example.com</type>
Packit 5ce601
      with IP address 172.16.1.1 is added.
Packit 5ce601
      The newly-added record has a 1 day TTL (86400 seconds).
Packit 5ce601
      <programlisting>
Packit 5ce601
# nsupdate
Packit 5ce601
> prereq nxdomain nickname.example.com
Packit 5ce601
> update add nickname.example.com 86400 CNAME somehost.example.com
Packit 5ce601
> send
Packit 5ce601
</programlisting>
Packit 5ce601
    </para>
Packit 5ce601
    <para>
Packit 5ce601
      The prerequisite condition gets the name server to check that there
Packit 5ce601
      are no resource records of any type for
Packit 5ce601
      <type>nickname.example.com</type>.
Packit 5ce601
Packit 5ce601
      If there are, the update request fails.
Packit 5ce601
      If this name does not exist, a CNAME for it is added.
Packit 5ce601
      This ensures that when the CNAME is added, it cannot conflict with the
Packit 5ce601
      long-standing rule in RFC 1034 that a name must not exist as any other
Packit 5ce601
      record type if it exists as a CNAME.
Packit 5ce601
      (The rule has been updated for DNSSEC in RFC 2535 to allow CNAMEs to have
Packit 5ce601
      RRSIG, DNSKEY and NSEC records.)
Packit 5ce601
    </para>
Packit 5ce601
  </refsection>
Packit 5ce601
Packit 5ce601
  <refsection><info><title>FILES</title></info>
Packit 5ce601
Packit 5ce601
Packit 5ce601
    <variablelist>
Packit 5ce601
      <varlistentry>
Packit 5ce601
	<term><constant>/etc/resolv.conf</constant></term>
Packit 5ce601
	<listitem>
Packit 5ce601
	  <para>
Packit 5ce601
	    used to identify default name server
Packit 5ce601
	  </para>
Packit 5ce601
	</listitem>
Packit 5ce601
      </varlistentry>
Packit 5ce601
Packit 5ce601
      <varlistentry>
Packit 5ce601
	<term><constant>/var/run/named/session.key</constant></term>
Packit 5ce601
	<listitem>
Packit 5ce601
	  <para>
Packit 5ce601
	    sets the default TSIG key for use in local-only mode
Packit 5ce601
	  </para>
Packit 5ce601
	</listitem>
Packit 5ce601
      </varlistentry>
Packit 5ce601
Packit 5ce601
      <varlistentry>
Packit 5ce601
	<term><constant>K{name}.+157.+{random}.key</constant></term>
Packit 5ce601
	<listitem>
Packit 5ce601
	  <para>
Packit 5ce601
	    base-64 encoding of HMAC-MD5 key created by
Packit 5ce601
	    <citerefentry>
Packit 5ce601
	      <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
Packit 5ce601
	    </citerefentry>.
Packit 5ce601
	  </para>
Packit 5ce601
	</listitem>
Packit 5ce601
      </varlistentry>
Packit 5ce601
Packit 5ce601
      <varlistentry>
Packit 5ce601
	<term><constant>K{name}.+157.+{random}.private</constant></term>
Packit 5ce601
	<listitem>
Packit 5ce601
	  <para>
Packit 5ce601
	    base-64 encoding of HMAC-MD5 key created by
Packit 5ce601
	    <citerefentry>
Packit 5ce601
	      <refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
Packit 5ce601
	    </citerefentry>.
Packit 5ce601
	  </para>
Packit 5ce601
	</listitem>
Packit 5ce601
      </varlistentry>
Packit 5ce601
Packit 5ce601
    </variablelist>
Packit 5ce601
  </refsection>
Packit 5ce601
Packit 5ce601
  <refsection><info><title>SEE ALSO</title></info>
Packit 5ce601
Packit 5ce601
    <para>
Packit 5ce601
      <citetitle>RFC 2136</citetitle>,
Packit 5ce601
      <citetitle>RFC 3007</citetitle>,
Packit 5ce601
      <citetitle>RFC 2104</citetitle>,
Packit 5ce601
      <citetitle>RFC 2845</citetitle>,
Packit 5ce601
      <citetitle>RFC 1034</citetitle>,
Packit 5ce601
      <citetitle>RFC 2535</citetitle>,
Packit 5ce601
      <citetitle>RFC 2931</citetitle>,
Packit 5ce601
      <citerefentry>
Packit 5ce601
	<refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
Packit 5ce601
      </citerefentry>,
Packit 5ce601
      <citerefentry>
Packit 5ce601
	<refentrytitle>ddns-confgen</refentrytitle><manvolnum>8</manvolnum>
Packit 5ce601
      </citerefentry>,
Packit 5ce601
      <citerefentry>
Packit 5ce601
	<refentrytitle>dnssec-keygen</refentrytitle><manvolnum>8</manvolnum>
Packit 5ce601
      </citerefentry>.
Packit 5ce601
    </para>
Packit 5ce601
  </refsection>
Packit 5ce601
Packit 5ce601
  <refsection><info><title>BUGS</title></info>
Packit 5ce601
Packit 5ce601
    <para>
Packit 5ce601
      The TSIG key is redundantly stored in two separate files.
Packit 5ce601
      This is a consequence of nsupdate using the DST library
Packit 5ce601
      for its cryptographic operations, and may change in future
Packit 5ce601
      releases.
Packit 5ce601
    </para>
Packit 5ce601
  </refsection>
Packit 5ce601
Packit 5ce601
</refentry>