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 re‐
14       configuration  of the Kea servers (kea-dhcp4, kea-dhcp6, kea-dhcp-ddns,
15       kea-ctrl-agent, and kea-netconf). It also provides the means for check‐
16       ing the current status of the servers and determining the configuration
17       files in use.
18

CONFIGURATION FILE

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

OPTIONS

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

DOCUMENTATION

72       Kea  comes  with  an  extensive Kea Administrator Reference Manual that
73       covers all aspects of running the Kea software - compilation, installa‐
74       tion,  configuration,  configuration  examples, and much more. Kea also
75       features a Kea Messages Manual, which lists all possible  messages  Kea
76       can print with a brief description for each of them. Both documents are
77       available in various formats (.txt, .html, .pdf) with the Kea distribu‐
78       tion. The Kea documentation is available at https://kea.readthedocs.io.
79
80       Kea  source code is documented in the Kea Developer's Guide. Its online
81       version is available at https://reports.kea.isc.org/dev_guide/.
82
83       The Kea project website is available at https://kea.isc.org.
84

MAILING LISTS AND SUPPORT

86       There are two public mailing  lists  available  for  the  Kea  project.
87       kea-users (kea-users at lists.isc.org) is intended for Kea users, while
88       kea-dev (kea-dev at lists.isc.org)  is  intended  for  Kea  developers,
89       prospective  contributors,  and  other  advanced  users. Both lists are
90       available at https://lists.isc.org. The community provides  best-effort
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),
98       kea-admin(8),  kea-netconf(8), perfdhcp(8), kea-lfc(8), Kea Administra‐
99       tor Reference Manual.
100

AUTHOR

102       Internet Systems Consortium
103

105       2019-2022, Internet Systems Consortium
106
107
108
109
1102.0.2                            Mar 03, 2022                       KEACTRL(8)
Impressum