1KEA-CTRL-AGENT(8)                     Kea                    KEA-CTRL-AGENT(8)
2
3
4

NAME

6       kea-ctrl-agent - Control Agent process in Kea
7

SYNOPSIS

9       kea-ctrl-agent [-v] [-V] [-W] [-d] [-c config-file] [-t config-file]
10

DESCRIPTION

12       The  kea-ctrl-agent  provides  a  REST service for controlling Kea ser‐
13       vices. The received HTTP requests are decapsulated and forwarded to the
14       respective Kea services in JSON format. Received JSON responses are en‐
15       capsulated within HTTP responses and returned to  the  controlling  en‐
16       tity.  Some  commands may be handled by the Control Agent directly, and
17       not forwarded to any Kea service.
18

ARGUMENTS

20       The arguments are as follows:
21
22       -v     Displays the version.
23
24       -V     Displays the extended version.
25
26       -W     Displays the configuration report.
27
28       -d     Sets the logging level to debug with extra  verbosity.  This  is
29              primarily for development purposes in stand-alone mode.
30
31       -c config-file
32              Specifies  the file with the configuration for the Control Agent
33              server. It may also contain configuration entries for other  Kea
34              services.
35
36       -t config-file
37              Checks  the  syntax  of  the  configuration file and reports the
38              first error, if any. Note that not all parameters are completely
39              checked;  in  particular,  service  and  client  sockets are not
40              opened, and hook libraries are not loaded.
41

DOCUMENTATION

43       Kea comes with an extensive Kea  Administrator  Reference  Manual  that
44       covers all aspects of running the Kea software - compilation, installa‐
45       tion, configuration, configuration examples, and much  more.  Kea  also
46       features  a  Kea Messages Manual, which lists all possible messages Kea
47       can print with a brief description for each of them. Both documents are
48       available in various formats (.txt, .html, .pdf) with the Kea distribu‐
49       tion. The Kea documentation is available at https://kea.readthedocs.io.
50
51       Kea source code is documented in the Kea Developer's  Guide,  available
52       at https://reports.kea.isc.org/dev_guide/.
53
54       The Kea project website is available at https://kea.isc.org.
55

MAILING LISTS AND SUPPORT

57       There  are  two  public  mailing  lists  available for the Kea project.
58       kea-users (kea-users at lists.isc.org) is intended for Kea users, while
59       kea-dev  (kea-dev  at  lists.isc.org)  is  intended for Kea developers,
60       prospective contributors, and other  advanced  users.  Both  lists  are
61       available  at https://lists.isc.org. The community provides best-effort
62       support on both of those lists.
63
64       ISC   provides   professional   support   for   Kea    services.    See
65       https://www.isc.org/kea/ for details.
66

HISTORY

68       The  kea-ctrl-agent  was first coded in December 2016 by Marcin Siodel‐
69       ski.
70

SEE ALSO

72       kea-dhcp4(8), kea-dhcp6(8), kea-dhcp-ddns(8), kea-admin(8), keactrl(8),
73       perfdhcp(8), kea-lfc(8), Kea Administrator Reference Manual.
74

AUTHOR

76       Internet Systems Consortium
77

79       2019-2023, Internet Systems Consortium
80
81
82
83
84 2.4.1                           Nov 30, 2023                KEA-CTRL-AGENT(8)
Impressum