kea-dhcp4.xml 7.09 KB
Newer Older
1
<!--
2
 - Copyright (C) 2011-2018 Internet Systems Consortium, Inc. ("ISC")
3
 -
4 5 6
 - 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/.
7
-->
8
<!-- Converted by db4-upgrade version 1.1 -->
9
<refentry>
10

11
  <info>
12
    <productname>ISC Kea</productname>
13 14
    <date>Nov 9, 2018</date>
    <edition>1.5.0-beta</edition>
15 16 17 18 19 20 21
    <author>
      <contrib>The Kea software has been written by a number of
        engineers working for ISC: Tomek Mrugalski, Stephen Morris, Marcin
        Siodelski, Thomas Markwalder, Francis Dupont, Jeremy C. Reed,
        Wlodek Wencel and Shawn Routhier.  That list is roughly in the
        chronological order in which the authors made their first
        contribution. For a complete list of authors and
22 23
        contributors, see AUTHORS file.</contrib><orgname>Internet Systems Consortium, Inc.</orgname></author>
  </info>
24 25

  <refmeta>
26
    <refentrytitle>kea-dhcp4</refentrytitle>
27
    <manvolnum>8</manvolnum>
28
    <refmiscinfo class="manual">Kea</refmiscinfo>
29 30 31
  </refmeta>

  <refnamediv>
32 33
    <refname>kea-dhcp4</refname>
    <refpurpose>DHCPv4 server in Kea</refpurpose>
34 35 36 37
  </refnamediv>

  <docinfo>
    <copyright>
38
      <year>2011-2018</year>
39 40 41 42 43
      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
    </copyright>
  </docinfo>

  <refsynopsisdiv>
44
    <cmdsynopsis sepchar=" ">
45
      <command>kea-dhcp4</command>
46 47 48 49
      <arg choice="opt" rep="norepeat"><option>-v</option></arg>
      <arg choice="opt" rep="norepeat"><option>-V</option></arg>
      <arg choice="opt" rep="norepeat"><option>-W</option></arg>
      <arg choice="opt" rep="norepeat"><option>-d</option></arg>
50 51 52
      <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">config-file</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">config-file</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">port-number</replaceable></option></arg>
53 54 55 56 57 58
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>
    <para>
59 60
      The <command>kea-dhcp4</command> daemon provides the
       DHCPv4 server implementation.
61 62 63 64 65 66 67 68 69 70 71 72 73 74
    </para>

  </refsect1>

  <refsect1>
    <title>ARGUMENTS</title>

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

    <variablelist>

      <varlistentry>
        <term><option>-v</option></term>
        <listitem><para>
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
          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>
          Enable the debug mode with extra verbosity.
97 98 99
        </para></listitem>
      </varlistentry>

100 101 102 103 104 105 106
      <varlistentry>
        <term><option>-c</option></term>
        <listitem><para>
          Configuration file including the configuration for DHCPv4 server.
          It may also contain configuration entries for other Kea services.
        </para></listitem>
      </varlistentry>
107

108 109 110 111 112 113 114 115 116 117
      <varlistentry>
        <term><option>-t</option></term>
        <listitem><para> Check the configuration file
          and report the first error if any. Note
          that not all parameters are completely checked, in
          particular, service and control channel sockets
          are not opened, and hook libraries are not loaded.
        </para></listitem>
      </varlistentry>

118 119 120 121 122 123 124 125 126
      <varlistentry>
        <term><option>-p</option></term>
        <listitem><para>
          Port number (1-65535) on which the server listens. This is useful
          for testing purposes only.
        </para></listitem>
      </varlistentry>

    </variablelist>
127 128
  </refsect1>

129 130 131 132 133 134 135 136 137 138
  <refsect1>
    <title>DOCUMENTATION</title>
    <para>Kea comes with an extensive Kea User's Guide documentation
      that covers all aspects of running the Kea software -
      compilation, installation, configuration, configuration examples
      and many more. Kea also features a Kea Messages Manual, which
      lists all possible messages Kea can print with a brief
      description for each of them. Both documents are typically
      available in various formats (txt, html, pdf) with your Kea
      distribution. The on-line version is available at
139
      http://oldkea.isc.org/docs/.</para>
140 141
    <para>
      Kea source code is documented in the Kea Developer's Guide. It's
142
      on-line version is available at http://oldkea.isc.org. Please
143 144 145
      follow Developer's Guide link.
    </para>
    <para>
146
      Kea project website is available at: http://oldkea.isc.org.
147 148 149 150 151 152 153
    </para>
  </refsect1>

  <refsect1>
    <title>MAILING LISTS AND SUPPORT</title>
    <para>
      There are two mailing lists available for Kea project. kea-users
154 155 156 157 158
      (kea-users at lists.isc.org) is intended for Kea users, while kea-dev
      (kea-dev at lists.isc.org) is intended for Kea developers, prospective
      contributors and other advanced users.  Both lists are available at
      http://lists.isc.org. The community provides best effort type of support
      on both of those lists.
159 160 161 162 163 164 165
    </para>
    <para>
      ISC provides professional support for Kea services. See
      https://www.isc.org/kea/ for details.
    </para>
  </refsect1>

166 167 168 169 170 171
  <refsect1>
    <title>HISTORY</title>
    <para>
      The <command>b10-dhcp4</command> daemon was first coded in
      November 2011 by Tomek Mrugalski.
    </para>
172
    <para>
173 174 175
      In the mid 2014 Kea was decoupled from the BIND10 framework and became a
      standalone DHCP server. The DHCPv4 server binary was renamed to
      kea-dhcp4. Kea 1.0.0 was released in December 2015.
176
    </para>
177
  </refsect1>
178

179 180 181 182 183 184 185 186 187 188 189 190 191
  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>kea-dhcp6</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

      <citerefentry>
        <refentrytitle>kea-dhcp-ddns</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

192 193 194 195 196
      <citerefentry>
        <refentrytitle>kea-ctrl-agent</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

197 198 199 200 201 202 203 204 205 206
      <citerefentry>
        <refentrytitle>kea-admin</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

      <citerefentry>
        <refentrytitle>keactrl</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

Tomek Mrugalski's avatar
Tomek Mrugalski committed
207 208 209 210 211
      <citerefentry>
        <refentrytitle>kea-netconf</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
      <citerefentry>
        <refentrytitle>perfdhcp</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

      <citerefentry>
        <refentrytitle>kea-lfc</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

      <citetitle>Kea Administrator's Guide</citetitle>.

    </para>
  </refsect1>

227
</refentry>