1KEACTRL(8)                            Kea                           KEACTRL(8)
2
3
4

NAME

6       keactrl - Shell script for managing Kea
7

SYNOPSIS

9       keactrl [command] [-c keactrl-config-file] [-s server[,server,...]]
10               [-v]
11

DESCRIPTION

13       keactrl is a shell script which controls the startup, shutdown and
14       reconfiguration of the Kea servers (kea-dhcp4, kea-dhcp6,
15       kea-dhcp-ddns, kea-ctrl-agent and kea-netconf). It also provides the
16       means for checking the current status of the servers and determining
17       the configuration files in use.
18

CONFIGURATION FILE

20       Depending on requirements, not all of the available servers need be
21       run. The keactrl configuration file sets which servers are enabled and
22       which are disabled. By default the configuration file is
23       [kea-install-dir]/etc/kea/keactrl.conf.
24
25       See the Kea Administrator's Guide for the documentation of the
26       parameters in the keactrl configuration file.
27

OPTIONS

29       command
30           Command to be issued to the servers. It can be one of the
31           following:
32
33           start
34               Start the servers.
35
36           stop
37               Stop the servers.
38
39           reload
40               Instructs the servers to re-read the kea configuration file.
41               This command is not supported by the Netconf agent.
42
43           status
44               Print the status of the servers.
45
46       -c|--ctrl-config keactrl-config-file
47           Specify the keactrl configuration file. Without this switch, the
48           keactrl will attempt to use the file
49           [kea-install-dir]/etc/kea/keactrl.conf.
50
51       -s|--server server[,server,...]
52           Specifies a subset of the enabled servers to which the command
53           should be issued. The list of servers should be separated by commas
54           with no intervening spaces. Acceptable values are:
55
56           dhcp4
57               DHCPv4 server (kea-dhcp4).
58
59           dhcp6
60               DHCPv6 server (kea-dhcp6).
61
62           dhcp_ddns
63               DHCP DDNS server (kea-dhcp-ddns).
64
65           ctrl_agent
66               Control Agent (kea-ctrl-agent).
67
68           netconf
69               Netconf agent (kea-netconf).
70
71           all
72               All servers (default) including Netconf if it was configured to
73               be built.
74
75       -v|--version
76           Prints keactrl version and quits.
77

DOCUMENTATION

79       Kea comes with an extensive Kea User's Guide documentation that covers
80       all aspects of running the Kea software - compilation, installation,
81       configuration, configuration examples and many more. Kea also features
82       a Kea Messages Manual, which lists all possible messages Kea can print
83       with a brief description for each of them. Both documents are typically
84       available in various formats (txt, html, pdf) with your Kea
85       distribution. The Kea documentation is available at
86       https://kb.isc.org/docs/kea-administrator-reference-manual .
87
88       Kea source code is documented in the Kea Developer's Guide. Its on-line
89       version is available at https://jenkins.isc.org/job/Kea_doc/doxygen/.
90
91       The Kea project website is available at: https://kea.isc.org.
92

MAILING LISTS AND SUPPORT

94       There are two mailing lists available for Kea project. kea-users
95       (kea-users at lists.isc.org) is intended for Kea users, while kea-dev
96       (kea-dev at lists.isc.org) is intended for Kea developers, prospective
97       contributors and other advanced users. Both lists are available at
98       http://lists.isc.org. The community provides best effort type of
99       support on both of those lists.
100
101       ISC provides professional support for Kea services. See
102       https://www.isc.org/kea/ for details.
103

SEE ALSO

105       kea-dhcp4(8), kea-dhcp6(8), kea-dhcp-ddns(8), kea-ctrl-agent(8), kea-
106       netconf(8), kea-admin(8), kea-netconf(8), perfdhcp(8), kea-lfc(8), Kea
107       Administrator's Guide.
108

AUTHOR

110           The Kea software has been written by a number of engineers working
111           for ISC: Tomek Mrugalski, Stephen Morris, Marcin Siodelski, Thomas
112           Markwalder, Francis Dupont, Jeremy C. Reed, Wlodek Wencel and Shawn
113           Routhier. That list is roughly in the chronological order in which
114           the authors made their first contribution. For a complete list of
115           authors and contributors, see AUTHORS file.
116

118       Copyright © 2014-2018 Internet Systems Consortium, Inc. ("ISC")
119
120
121
122ISC Kea 1.5.0                    Dec 14, 2018                       KEACTRL(8)
Impressum