From: Marcin Siodelski Date: Tue, 11 Jul 2017 08:42:01 +0000 (+0200) Subject: [5108] Updated keactrl section in User's Guide. X-Git-Tag: trac5333_base~2^2~1 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=67dd7b47bd2f6d9a33133f295193e0e766d47aa7;p=thirdparty%2Fkea.git [5108] Updated keactrl section in User's Guide. --- diff --git a/doc/guide/keactrl.xml b/doc/guide/keactrl.xml index 8122cd3894..a39be5cf56 100644 --- a/doc/guide/keactrl.xml +++ b/doc/guide/keactrl.xml @@ -11,9 +11,10 @@ Overview keactrl is a shell script which controls the startup, shutdown and reconfiguration of the Kea servers (kea-dhcp4, - kea-dhcp6 and kea-dhcp-ddns). It - also provides the means for checking the current status of the servers - and determining the configuration files in use. + kea-dhcp6, kea-dhcp-ddns and + kea-ctrl-agent). It also provides the means for + checking the current status of the servers and determining the + configuration files in use. @@ -66,19 +67,20 @@ keactrl <command> [-c keactrl-config-file] [-s server[,server,..]] # This is a configuration file for keactrl script which controls # the startup, shutdown, reconfiguration and gathering the status -# of the Kea servers. +# of the Kea's processes. # prefix holds the location where the Kea is installed. -prefix=/usr/local +prefix=@prefix@ # Location of Kea configuration file. -kea_config_file=${prefix}/etc/kea/kea.conf +kea_config_file=@sysconfdir@/@PACKAGE@/kea.conf # Location of Kea binaries. -exec_prefix=${prefix} -dhcp4_srv=${exec_prefix}/sbin/kea/kea-dhcp4 -dhcp6_srv=${exec_prefix}/sbin/kea/kea-dhcp6 -dhcp_ddns_srv=${exec_prefix}/sbin/kea/kea-dhcp-ddns +exec_prefix=@exec_prefix@ +dhcp4_srv=@sbindir@/kea-dhcp4 +dhcp6_srv=@sbindir@/kea-dhcp6 +dhcp_ddns_srv=@sbindir@/kea-dhcp-ddns +ctrl_agent_srv=@sbindir@/kea-ctrl-agent # Start DHCPv4 server? dhcp4=yes @@ -87,7 +89,10 @@ dhcp4=yes dhcp6=yes # Start DHCP DDNS server? -dhcp_ddns=yes +dhcp_ddns=no + +# Start Control Agent? +ctrl_agent=yes # Be verbose? kea_verbose=no @@ -95,12 +100,13 @@ kea_verbose=no - The dhcp4, dhcp6 and - dhcp_ddns parameters set to "yes" configure - keactrl to manage (start, reconfigure) all servers, - i.e. kea-dhcp4, kea-dhcp6 and - kea-dhcp-ddns. When any of these parameters is set to - "no" the keactrl will ignore + The dhcp4, dhcp6, + dhcp_ddns and ctrl_agent + parameters set to "yes" configure keactrl to manage + (start, reconfigure) all servers, i.e. kea-dhcp4, + kea-dhcp6, kea-dhcp-ddns and + kea-ctrl-agent. When any of these parameters is set + to "no" the keactrl will ignore the corresponding server when starting or reconfiguring Kea. @@ -110,8 +116,8 @@ kea_verbose=no should work for most installations. If the default location needs to be altered for any reason, the paths specified with the dhcp4_srv, - dhcp6_srv and dhcp_ddns_srv - parameters should be modified. + dhcp6_srv, dhcp_ddns_srv + and ctrl_agent_srv parameters should be modified. @@ -165,6 +171,7 @@ kea_verbose=no INFO/keactrl: Starting kea-dhcp4 -c /usr/local/etc/kea/kea.conf -d INFO/keactrl: Starting kea-dhcp6 -c /usr/local/etc/kea/kea.conf -d INFO/keactrl: Starting kea-dhcp-ddns -c /usr/local/etc/kea/kea.conf -d +INFO/keactrl: Starting kea-ctrl-agent -c /usr/local/etc/kea/kea.conf -d @@ -177,6 +184,7 @@ INFO/keactrl: Starting kea-dhcp-ddns -c /usr/local/etc/kea/kea.conf -d INFO/keactrl: kea-dhcp4 appears to be running, see: PID 10918, PID file: /usr/local/var/kea/kea.kea-dhcp4.pid. INFO/keactrl: kea-dhcp6 appears to be running, see: PID 10924, PID file: /usr/local/var/kea/kea.kea-dhcp6.pid. INFO/keactrl: kea-dhcp-ddns appears to be running, see: PID 10930, PID file: /usr/local/var/kea/kea.kea-dhcp-ddns.pid. +INFO/keactrl: kea-ctrl-agent appears to be running, see: PID 10931, PID file: /usr/local/var/kea/kea.kea-ctrl-agent.pid. During normal shutdowns these PID files are deleted. They may, however, be left over as remnants following a system crash. It is possible, @@ -193,6 +201,7 @@ INFO/keactrl: kea-dhcp-ddns appears to be running, see: PID 10930, PID file: /us INFO/keactrl: Stopping kea-dhcp4... INFO/keactrl: Stopping kea-dhcp6... INFO/keactrl: Stopping kea-dhcp-ddns... +INFO/keactrl: Stopping kea-ctrl-agent... Note that the stop will attempt to stop all servers regardless of whether they are "enabled" in the keactrl.conf. @@ -203,6 +212,7 @@ INFO/keactrl: Stopping kea-dhcp-ddns... INFO/keactrl: kea-dhcp4 isn't running. INFO/keactrl: kea-dhcp6 isn't running. INFO/keactrl: kea-dhcp-ddns isn't running. +INFO/keactrl: kea-ctrl-agent isn't running. @@ -219,6 +229,7 @@ INFO/keactrl: kea-dhcp-ddns isn't running. INFO/keactrl: Reloading kea-dhcp4... INFO/keactrl: Reloading kea-dhcp6... INFO/keactrl: Reloading kea-dhcp-ddns... +INFO/keactrl: Reloading kea-ctrl-agent... If any of the servers are not running, an informational message is displayed as in the reload command output below. @@ -227,6 +238,7 @@ INFO/keactrl: Reloading kea-dhcp-ddns... INFO/keactrl: kea-dhcp4 isn't running. INFO/keactrl: kea-dhcp6 isn't running. INFO/keactrl: kea-dhcp-ddns isn't running. +INFO/keactrl: kea-ctrl-agent isn't running. @@ -247,6 +259,7 @@ INFO/keactrl: kea-dhcp-ddns isn't running. DHCPv4 server: active DHCPv6 server: inactive DHCP DDNS: active +Control Agent: active Kea configuration file: /usr/local/etc/kea/kea.conf keactrl configuration file: /usr/local/etc/kea/keactrl.conf @@ -261,7 +274,8 @@ keactrl configuration file: /usr/local/etc/kea/keactrl.conf command is issued. For example, the following instructs keactrl to stop the kea-dhcp4 and kea-dhcp6 servers - and leave the kea-dhcp-ddns server running: + and leave the kea-dhcp-ddns and + kea-ctrl-agent running: $ keactrl stop -s dhcp4,dhcp6 @@ -270,8 +284,8 @@ keactrl configuration file: /usr/local/etc/kea/keactrl.conf Similarly, the following will only start the kea-dhcp4 and - kea-dhcp-ddns servers and not - kea-dhcp6. + kea-dhcp-ddns servers and not: + kea-dhcp6, kea-ctrl-agent. $ keactrl start -s dhcp4,dhcp_ddns @@ -302,6 +316,9 @@ keactrl configuration file: /usr/local/etc/kea/keactrl.conf dhcp_ddns for kea-dhcp-ddns. + + ctrl_agent for kea-ctrl-agent. + all for all servers (default).