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

DESCRIPTION

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

CONFIGURATION FILE

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

OPTIONS

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

DOCUMENTATION

70       Kea comes with an extensive Kea User's Guide documentation that covers
71       all aspects of running the Kea software - compilation, installation,
72       configuration, configuration examples and many more. Kea also features
73       a Kea Messages Manual, which lists all possible messages Kea can print
74       with a brief description for each of them. Both documents are typically
75       available in various formats (txt, html, pdf) with your Kea
76       distribution. The on-line version is available at
77       http://kea.isc.org/docs/.
78
79       Kea source code is documented in the Kea Developer's Guide. It's
80       on-line version is available at http://kea.isc.org. Please follow
81       Developer's Guide link.
82
83       Kea project website is available at: http://kea.isc.org.
84

MAILING LISTS AND SUPPORT

86       There are two mailing lists available for Kea project. kea-users
87       (kea-users at lists.isc.org) is intended for Kea users, while kea-dev
88       (kea-dev at lists.isc.org) is intended for Kea developers, prospective
89       contributors and other advanced users. Both lists are available at
90       http://lists.isc.org. The community provides best effort type of
91       support on both of those lists.
92
93       ISC provides professional support for Kea services. See
94       https://www.isc.org/kea/ for details.
95

SEE ALSO

97       kea-dhcp4(8), kea-dhcp6(8), kea-dhcp-ddns(8), kea-ctrl-agent(8), kea-
98       admin(8), perfdhcp(8), kea-lfc(8), Kea Administrator's Guide.
99

AUTHOR

101       The Kea software has been written by a number of engineers working for
102       ISC: Tomek Mrugalski, Stephen Morris, Marcin Siodelski, Thomas
103       Markwalder, Francis Dupont, Jeremy C. Reed, Wlodek Wencel and Shawn
104       Routhier. That list is roughly in the chronological order in which the
105       authors made their first contribution. For a complete list of authors
106       and contributors, see AUTHORS file.
107

109       Copyright © 2014-2017 Internet Systems Consortium, Inc. ("ISC")
110
111
112
113ISC Kea 1.3.0                    Oct. 27, 2017                      KEACTRL(8)
Impressum