keactrl.xml 8.9 KB
Newer Older
1
<!--
2
 - Copyright (C) 2014-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
-->

9
<refentry>
10
  <info>
11
    <productname>ISC Kea</productname>
12 13
    <date>Nov 9, 2018</date>
    <edition>1.5.0-beta</edition>
14
    <author>
15
      <personname/>
16 17 18 19 20 21
      <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 26 27

  <refmeta>
    <refentrytitle>keactrl</refentrytitle>
    <manvolnum>8</manvolnum>
28
    <refmiscinfo class="manual">Kea</refmiscinfo>
29 30 31 32
  </refmeta>

  <refnamediv>
    <refname>keactrl</refname>
33
    <refpurpose>Shell script for managing Kea</refpurpose>
34 35 36 37
  </refnamediv>

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

  <refsynopsisdiv>
44
    <cmdsynopsis sepchar=" ">
45
      <command>keactrl</command>
46 47 48
      <arg choice="opt" rep="norepeat">command</arg>
      <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">keactrl-config-file</replaceable></option></arg>
      <arg choice="opt" rep="norepeat"><option>-s <replaceable class="parameter">server[,server,...]</replaceable></option></arg>
49
      <arg choice="opt" rep="norepeat"><option>-v</option></arg>
50 51 52 53 54 55
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>
    <para>
56 57
      keactrl is a shell script which controls the startup, shutdown
      and reconfiguration of the Kea servers (<command>kea-dhcp4</command>,
58 59 60 61
      <command>kea-dhcp6</command>, <command>kea-dhcp-ddns</command> and
      <command>kea-ctrl-agent</command>). It also provides the means for
      checking the current status of the servers and determining the
      configuration files in use.
62 63 64 65 66 67
    </para>
  </refsect1>

  <refsect1>
    <title>CONFIGURATION FILE</title>
    <para>
68 69 70 71
     Depending on requirements, not all of the available servers need
     be run.  The keactrl configuration file sets which servers are
     enabled and which are disabled.  By default the configuration
     file is <filename>[kea-install-dir]/etc/kea/keactrl.conf</filename>.
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
    </para>
    <para>
      See the Kea Administrator's Guide for the documentation of the parameters
      in the <command>keactrl</command> configuration file.
    </para>
  </refsect1>

  <refsect1>
    <title>OPTIONS</title>
    <variablelist>
      <varlistentry>
        <term><option><replaceable class="parameter">command</replaceable></option></term>
        <listitem>
          <para>
            Command to be issued to the servers. It can be one of the following:
          </para>

          <variablelist>
            <varlistentry>
              <term>start</term>
              <listitem>
93
                <para>Start the servers.</para>
94 95 96 97 98 99
              </listitem>
            </varlistentry>

            <varlistentry>
              <term>stop</term>
              <listitem>
100
                <para>Stop the servers.</para>
101 102 103 104 105 106
              </listitem>
            </varlistentry>

            <varlistentry>
              <term>reload</term>
              <listitem>
107
                <para>Instructs the servers to re-read the kea configuration file.</para>
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
              </listitem>
            </varlistentry>

            <varlistentry>
              <term>status</term>
              <listitem>
                <para>Print the status of the servers.</para>
              </listitem>
            </varlistentry>

          </variablelist>


        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-c|--ctrl-config <replaceable class="parameter">keactrl-config-file</replaceable></option></term>
        <listitem>
          <para>
128 129 130
            Specify the <command>keactrl</command> configuration file. Without
            this switch, the <command>keactrl</command> will attempt to use the
            file <filename>[kea-install-dir]/etc/kea/keactrl.conf</filename>.
131 132 133 134 135 136 137 138
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-s|--server <replaceable class="parameter">server[,server,...]</replaceable></option></term>
        <listitem>
          <para>
139 140 141
            Specifies a subset of the enabled servers to which the command should be issued.
            The list of servers should be separated by commas with no intervening spaces.
            Acceptable values are:
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
          </para>

          <variablelist>
            <varlistentry>
              <term>dhcp4</term>
              <listitem>
                <para>DHCPv4 server (<command>kea-dhcp4</command>).</para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term>dhcp6</term>
              <listitem>
                <para>DHCPv6 server (<command>kea-dhcp6</command>).</para>
              </listitem>
            </varlistentry>

            <varlistentry>
              <term>dhcp_ddns</term>
              <listitem>
                <para>DHCP DDNS server (<command>kea-dhcp-ddns</command>).</para>
              </listitem>
            </varlistentry>

166 167 168 169 170 171 172
            <varlistentry>
              <term>ctrl_agent</term>
              <listitem>
                <para>Control Agent (<command>kea-ctrl-agent</command>).</para>
              </listitem>
            </varlistentry>

173 174 175 176 177 178 179 180 181 182 183
            <varlistentry>
              <term>all</term>
              <listitem>
                <para>All servers (default).</para>
              </listitem>
            </varlistentry>

          </variablelist>
        </listitem>
      </varlistentry>

184 185 186 187 188 189 190 191 192
      <varlistentry>
        <term><option>-v|--version</option></term>
        <listitem>
          <para>
            Prints keactrl version and quits.
          </para>
        </listitem>
      </varlistentry>

193 194 195
    </variablelist>
  </refsect1>

196 197 198 199 200 201 202 203 204 205
  <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
206
      http://oldkea.isc.org/docs/.</para>
207 208
    <para>
      Kea source code is documented in the Kea Developer's Guide. It's
209
      on-line version is available at http://oldkea.isc.org. Please
210 211 212
      follow Developer's Guide link.
    </para>
    <para>
213
      Kea project website is available at: http://oldkea.isc.org.
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
    </para>
  </refsect1>

  <refsect1>
    <title>MAILING LISTS AND SUPPORT</title>
    <para>
      There are two mailing lists available for Kea project. kea-users
      (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.
    </para>
    <para>
      ISC provides professional support for Kea services. See
      https://www.isc.org/kea/ for details.
    </para>
  </refsect1>

233 234 235 236 237 238
  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>kea-dhcp4</refentrytitle>
        <manvolnum>8</manvolnum>
239
      </citerefentry>,
240 241 242 243

      <citerefentry>
        <refentrytitle>kea-dhcp6</refentrytitle>
        <manvolnum>8</manvolnum>
244
      </citerefentry>,
245 246 247 248

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

251 252 253 254 255
      <citerefentry>
        <refentrytitle>kea-ctrl-agent</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

256 257 258 259 260
      <citerefentry>
        <refentrytitle>kea-admin</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

Tomek Mrugalski's avatar
Tomek Mrugalski committed
261 262 263 264 265
      <citerefentry>
        <refentrytitle>kea-netconf</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

266 267 268 269 270 271 272 273 274 275 276
      <citerefentry>
        <refentrytitle>perfdhcp</refentrytitle>
        <manvolnum>8</manvolnum>
      </citerefentry>,

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


277
      <citetitle>Kea Administrator's Guide</citetitle>.
278 279 280 281 282

    </para>
  </refsect1>

</refentry>