Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
KEA-CTRL-AGENT(8)		      Kea		     KEA-CTRL-AGENT(8)

NAME
       kea-ctrl-agent -	Control	Agent process in Kea

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

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

ARGUMENTS
       The arguments are as follows:

       -v     Displays the Kea version.

       -V     Displays the extended Kea	version.

       -W     Displays the configuration report.

       -d     Sets the logging level to	debug with extra  verbosity.  This  is
	      primarily	for development	purposes in stand-alone	mode.

       -c config-file
	      Specifies	 the file with the configuration for the Control Agent
	      server. It may also contain configuration	entries	for other  Kea
	      services.

       -t config-file
	      Checks  the  syntax  of  the  configuration file and reports the
	      first error, if any. Note	that not all parameters	are completely
	      checked; in particular,  service	and  client  sockets  are  not
	      opened, and hook libraries are not loaded.

DOCUMENTATION
       Kea  comes  with	 an  extensive Kea Administrator Reference Manual that
       covers all aspects of running the Kea software -	compilation, installa-
       tion, configuration, configuration examples, and	much  more.  Kea  also
       features	 a  Kea	Messages Manual, which lists all possible messages Kea
       can print with a	brief description for each of them. Both documents are
       available in various formats (.txt, .html, .pdf)	with the Kea distribu-
       tion. The Kea documentation is available	at https://kea.readthedocs.io.

       Kea source code is documented in	the Kea	Developer's  Guide,  available
       at https://reports.kea.isc.org/dev_guide/.

       The Kea project website is available at https://kea.isc.org.

MAILING	LISTS AND SUPPORT
       There  are  two	public	mailing	 lists	available for the Kea project.
       kea-users (kea-users at lists.isc.org) is intended for Kea users, while
       kea-dev (kea-dev	at lists.isc.org)  is  intended	 for  Kea  developers,
       prospective  contributors,  and	other  advanced	 users.	Both lists are
       available at https://lists.isc.org. The community provides  best-effort
       support on both of those	lists.

       ISC    provides	  professional	 support   for	 Kea   services.   See
       https://www.isc.org/kea/	for details.

HISTORY
       The kea-ctrl-agent was first coded in December 2016 by  Marcin  Siodel-
       ski.

SEE ALSO
       kea-dhcp4(8), kea-dhcp6(8), kea-dhcp-ddns(8), kea-admin(8), keactrl(8),
       perfdhcp(8), kea-lfc(8),	Kea Administrator Reference Manual.

AUTHOR
       Internet	Systems	Consortium

COPYRIGHT
       2019-2025, Internet Systems Consortium

2.7.7				 Mar 24, 2025		     KEA-CTRL-AGENT(8)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=kea-ctrl-agent&sektion=8&manpath=FreeBSD+Ports+14.3.quarterly>

home | help