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 a way to  check  the
16       current  status of the servers and determine the configuration files in
17       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 uses the file [kea-install-dir]/etc/kea/keactrl.conf.
45
46       -s|--server server[,server,...]
47              Specifies  a  subset of the enabled servers to which the command
48              should be issued. The list of servers  should  be  separated  by
49              commas, with no intervening spaces. Acceptable values are:
50
51              dhcp4  DHCPv4 server (kea-dhcp4).
52
53              dhcp6  DHCPv6 server (kea-dhcp6).
54
55              dhcp_ddns
56                     DHCP DDNS server (kea-dhcp-ddns).
57
58              ctrl_agent
59                     Control Agent (kea-ctrl-agent).
60
61              netconf
62                     NETCONF agent (kea-netconf).
63
64              all    All servers, including NETCONF if it was configured to be
65                     built. This is the default.
66
67       -v|--version
68              Prints the keactrl version and quits.
69

DOCUMENTATION

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

MAILING LISTS AND SUPPORT

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

SEE ALSO

96       kea-dhcp4(8),    kea-dhcp6(8),   kea-dhcp-ddns(8),   kea-ctrl-agent(8),
97       kea-admin(8), kea-netconf(8), perfdhcp(8), kea-lfc(8), Kea  Administra‐
98       tor Reference Manual.
99

AUTHOR

101       Internet Systems Consortium
102

104       2019-2022, Internet Systems Consortium
105
106
107
108
1092.2.0                            Jul 27, 2022                       KEACTRL(8)
Impressum