1KEA-CTRL-AGENT(8) Kea KEA-CTRL-AGENT(8)
2
3
4
6 kea-ctrl-agent - Control Agent process in Kea
7
9 kea-ctrl-agent [-v] [-V] [-W] [-d] [-cconfig-file] [-tconfig-file]
10
12 The kea-ctrl-agent provides a REST service for controlling Kea
13 services. The received HTTP requests are decapsulated and forwarded to
14 the respective Kea services in JSON format. Received JSON responses are
15 encapsulated within HTTP responses and returned to the controlling
16 entity. Some commands may be handled by the Control Agent directly, and
17 not forwarded to any Kea service.
18
20 The arguments are as follows:
21
22 -v
23 Display the version.
24
25 -V
26 Display the extended version.
27
28 -W
29 Display the configuration report.
30
31 -d
32 Verbose mode sets the logging level to debug. This is primarily for
33 development purposes in stand-alone mode.
34
35 -c
36 Configuration file including the configuration for the Control
37 Agent server. It may also contain configuration entries for other
38 Kea services.
39
40 -t
41 Check the syntax of the configuration file and report the first
42 error if any. Note that not all parameters are completely checked,
43 in particular, service and client sockets are not opened, and hook
44 libraries are not loaded.
45
47 Kea comes with an extensive Kea User's Guide documentation that covers
48 all aspects of running the Kea software - compilation, installation,
49 configuration, configuration examples and many more. Kea also features
50 a Kea Messages Manual, which lists all possible messages Kea can print
51 with a brief description for each of them. Both documents are typically
52 available in various formats (txt, html, pdf) with your Kea
53 distribution. The Kea documentation is available at
54 https://kb.isc.org/docs/kea-administrator-reference-manual .
55
56 Kea source code is documented in the Kea Developer's Guide. Its on-line
57 version is available at https://jenkins.isc.org/job/Kea_doc/doxygen/.
58
59 Kea project website is available at:
60 https://gitlab.isc.org/isc-projects/kea.
61
63 There are two mailing lists available for Kea project. kea-users
64 (kea-users at lists.isc.org) is intended for Kea users, while kea-dev
65 (kea-dev at lists.isc.org) is intended for Kea developers, prospective
66 contributors and other advanced users. Both lists are available at
67 http://lists.isc.org. The community provides best effort type of
68 support on both of those lists.
69
70 ISC provides professional support for Kea services. See
71 https://www.isc.org/kea/ for details.
72
74 The kea-ctrl-agent was first coded in December 2016 by Marcin
75 Siodelski.
76
78 kea-dhcp4(8), kea-dhcp6(8), kea-dhcp-ddns(8), kea-admin(8), keactrl(8),
79 perfdhcp(8), kea-lfc(8), Kea Administrator's Guide.
80
82 The Kea software has been written by a number of engineers working for
83 ISC: Tomek Mrugalski, Stephen Morris, Marcin Siodelski, Thomas
84 Markwalder, Francis Dupont, Jeremy C. Reed, Wlodek Wencel and Shawn
85 Routhier. That list is roughly in the chronological order in which the
86 authors made their first contribution. For a complete list of authors
87 and contributors, see AUTHORS file.
88
90 Copyright © 2016-2018 Internet Systems Consortium, Inc. ("ISC")
91
92
93
94ISC Kea 1.5.0 Dec 14, 2018 KEA-CTRL-AGENT(8)