kea/src/bin/ddns/b10-ddns.xml

<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
	       [<!ENTITY mdash "&#8212;">]>
<!--
 - Copyright (C) 2011-2012  Internet Systems Consortium, Inc. ("ISC")
 -
 - Permission to use, copy, modify, and/or distribute this software for any
 - purpose with or without fee is hereby granted, provided that the above
 - copyright notice and this permission notice appear in all copies.
 -
 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 - PERFORMANCE OF THIS SOFTWARE.
-->

<refentry>

  <refentryinfo>
    <date>June 18, 2012</date>
  </refentryinfo>

  <refmeta>
    <refentrytitle>b10-ddns</refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo>BIND10</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>b10-ddns</refname>
    <refpurpose>Dynamic DNS update service</refpurpose>
  </refnamediv>

  <docinfo>
    <copyright>
      <year>2011-2012</year>
      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
    </copyright>
  </docinfo>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>b10-ddns</command>
        <group choice="opt">
          <arg choice="plain"><option>-v</option></arg>
          <arg choice="plain"><option>--verbose</option></arg>
        </group>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>
    <para>The <command>b10-ddns</command> daemon provides the BIND 10
      Dynamic Update (DDNS) service, as specified in RFC 2136.
      Normally it is started by the
      <citerefentry><refentrytitle>bind10</refentrytitle><manvolnum>8</manvolnum></citerefentry>
      boss process.
    </para>

    <para>
      When the <command>b10-auth</command> authoritative DNS server
      receives an UPDATE request, it internally forwards the request
      to <command>b10-ddns</command>, which handles the rest of the
      request processing.
      When the processing is completed <command>b10-ddns</command>
      will send a response to the client with the RCODE set to the
      value as specified in RFC 2136.
      If the zone has been changed as a result, it will internally
      notify <command>b10-auth</command> and
      <command>b10-xfrout</command> so the new version of the zone will
      be served, and other secondary servers will be notified via the
      DNS notify protocol.
    </para>

    <para>
      This daemon communicates with BIND 10 over a
      <citerefentry><refentrytitle>b10-msgq</refentrytitle><manvolnum>8</manvolnum></citerefentry>
      C-Channel connection.  If this connection is not established,
      <command>b10-ddns</command> will exit.
      The <command>b10-ddns</command> daemon also depends on some other
      BIND 10 components (either directly or indirectly):
      <citerefentry><refentrytitle>b10-auth</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>b10-xfrout</refentrytitle><manvolnum>8</manvolnum></citerefentry>, and
      <citerefentry><refentrytitle>b10-zonemgr</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
    </para>

    <para>
     <command>b10-ddns</command> receives its configurations from
<citerefentry><refentrytitle>b10-cfgmgr</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
    </para>
  </refsect1>

  <refsect1>
    <title>ARGUMENTS</title>

    <para>The arguments are as follows:</para>

    <variablelist>

      <varlistentry>
        <term>
          <option>-h</option>,
          <option>--help</option>
        </term>
        <listitem>
          <para>
            Print the command line arguments and exit.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>-v</option>,
          <option>--verbose</option>
        </term>
        <listitem>
          <para>
            This value is ignored at this moment, but is provided for
            compatibility with the <command>bind10</command> Boss process.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>CONFIGURATION AND COMMANDS</title>
    <para>
      The configurable settings are:
    </para>
    <para>
      <varname>zones</varname>
      The zones option is a list of configuration items for specific
      zones that can be updated with DDNS. Each entry is a map that
      can contain the following items:
      <varname>origin</varname> is a textual domain name of the zone;
      <varname>class</varname> (text) is the RR class of the zone; and
      <varname>update_acl</varname> is an ACL that controls
      permission for updates.
      See the BIND 10 Guide for configuration details.
      Note that not listing a zone in this list does not directly
      mean update requests for the zone are rejected, but the end
      result is the same because the default ACL for updates is to
      deny all requests.
    </para>

    <para>
      The module commands are:
    </para>
    <para>
      <command>shutdown</command> exits <command>b10-ddns</command>.
      This has an optional <varname>pid</varname> argument to
      select the process ID to stop.
      (Note that the BIND 10 boss process may restart this service
      if configured.)
    </para>

  </refsect1>


  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>b10-auth</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>b10-cfgmgr</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>b10-msgq</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>b10-xfrout</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>b10-zonemgr</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>bind10</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citetitle>BIND 10 Guide</citetitle>.
    </para>
  </refsect1>

  <refsect1>
    <title>HISTORY</title>
    <para>
      The <command>b10-ddns</command> daemon was first implemented
      in December 2011 for the ISC BIND 10 project.
      The first functional version was released in June 2012.
    </para>
  </refsect1>
</refentry><!--
 - Local variables:
 - mode: sgml
 - End:
-->