kea/src/bin/d2/kea-dhcp-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) 2013, 2014, 2015  Internet Systems Consortium, Inc. ("ISC")
 -
 - This Source Code Form is subject to the terms of the Mozilla Public
 - License, v. 2.0. If a copy of the MPL was not distributed with this
 - file, You can obtain one at http://mozilla.org/MPL/2.0/.
-->

<refentry>

  <refentryinfo>
    <date>June 10, 2015</date>
  </refentryinfo>

  <refmeta>
    <refentrytitle>kea-dhcp-ddns</refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo>Kea</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>kea-dhcp-ddns</refname>
    <refpurpose>DHCP-DDNS process in Kea</refpurpose>
  </refnamediv>

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

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>kea-dhcp-ddns</command>
      <arg><option>-v</option></arg>
      <arg><option>-V</option></arg>
      <arg><option>-W</option></arg>
      <arg><option>-d</option></arg>
      <arg><option>-s</option></arg>
    </cmdsynopsis>
  </refsynopsisdiv>


  <refsect1>
    <title>DESCRIPTION</title>
    <para>
      The <command>kea-dhcp-ddns</command> service process requests to
      update DNS mapping based on DHCP lease change events. The service
      may run either as a Kea module (integrated mode) or as a individual
      process (stand-alone mode) dependent upon command line arguments. The
      default is integrated mode.  Stand alone operation is strictly for
      development purposes and is not suited for production.
    </para>

  </refsect1>

  <refsect1>
    <title>ARGUMENTS</title>

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

    <variablelist>

      <varlistentry>
        <term><option>-v</option></term>
        <listitem><para>
          Display the version.
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-V</option></term>
        <listitem><para>
          Display the extended version.
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-W</option></term>
        <listitem><para>
          Display the configuration report.
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-d</option></term>
        <listitem><para>
          Verbose mode sets the logging level to debug. This is primarily
          for development purposes in stand-alone mode.
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-c</option></term>
        <listitem><para>
          Configuration file including the configuration for DHCP-DDNS server.
          It may also contain configuration entries for other Kea services.
        </para></listitem>
      </varlistentry>

    </variablelist>
  </refsect1>

  <refsect1>
    <title>HISTORY</title>
    <para>
      The <command>b10-dhcp-ddns</command> process was first coded in
      May 2013 by the ISC Kea/DHCP team.
    </para>
    <para>
      Kea became a standalone server and the BIND10 framework was
      removed. The DHCP-DDNS server binary was renamed to kea-dhcp-ddns
      in July 2014.
    </para>
  </refsect1>
</refentry><!--
 - Local variables:
 - mode: sgml
 - End:
-->