1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY mdash "—">]>
<!--
- Copyright (C) 2014-2017 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>
<productname>ISC Kea</productname>
<date>Sep. 28, 2016</date>
<edition>1.1.0</edition>
<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
contributors, see AUTHORS file.</contrib>
<orgname>Internet Systems Consortium, Inc.</orgname>
</author>
</refentryinfo>
<refmeta>
<refentrytitle>keactrl</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class="manual">Kea</refmiscinfo>
</refmeta>
<refnamediv>
<refname>keactrl</refname>
<refpurpose>Shell script for managing Kea</refpurpose>
</refnamediv>
<docinfo>
<copyright>
<year>2014-2016</year>
<holder>Internet Systems Consortium, Inc. ("ISC")</holder>
</copyright>
</docinfo>
<refsynopsisdiv>
<cmdsynopsis>
<command>keactrl</command>
<arg>command</arg>
<arg><option>-c <replaceable class="parameter">keactrl-config-file</replaceable></option></arg>
<arg><option>-s <replaceable class="parameter">server[,server,...]</replaceable></option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>
keactrl is a shell script which controls the startup, shutdown
and reconfiguration of the Kea servers (<command>kea-dhcp4</command>,
<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.
</para>
</refsect1>
<refsect1>
<title>CONFIGURATION FILE</title>
<para>
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>.
</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>
<para>Start the servers.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>stop</term>
<listitem>
<para>Stop the servers.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>reload</term>
<listitem>
<para>Instructs the servers to re-read the kea configuration file.</para>
</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>
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>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-s|--server <replaceable class="parameter">server[,server,...]</replaceable></option></term>
<listitem>
<para>
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:
</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>
<varlistentry>
<term>ctrl_agent</term>
<listitem>
<para>Control Agent (<command>kea-ctrl-agent</command>).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>all</term>
<listitem>
<para>All servers (default).</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<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
http://kea.isc.org/docs/.</para>
<para>
Kea source code is documented in the Kea Developer's Guide. It's
on-line version is available at http://kea.isc.org. Please
follow Developer's Guide link.
</para>
<para>
Kea project website is available at: http://kea.isc.org.
</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>
<refsect1>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>kea-dhcp4</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>kea-dhcp6</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>kea-dhcp-ddns</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>kea-ctrl-agent</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>kea-admin</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<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>
</refentry>
|
