[5108] Updated keactrl section in User's Guide.

doc/guide/keactrl.xml

@@ -11,9 +11,10 @@
       <title>Overview</title>
       <para>keactrl is a shell script which controls the startup, shutdown
       and reconfiguration of the Kea servers (<command>kea-dhcp4</command>,
-      <command>kea-dhcp6</command> and <command>kea-dhcp-ddns</command>). It
-      also provides the means for checking the current status of the servers
-      and determining the configuration files in use.
+      <command>kea-dhcp6</command>, <command>kea-dhcp-ddns</command> and
+      <command>kea-ctrl-agent</command>). It also provides the means for
+      checking the current status of the servers and determining the
+      configuration files in use.
       </para>
     </section>
 
@@ -66,19 +67,20 @@ keactrl &lt;command&gt; [-c keactrl-config-file] [-s server[,server,..]]
 <screen>
 # 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
       </para>
 
       <para>
-        The <parameter>dhcp4</parameter>, <parameter>dhcp6</parameter> and
-        <parameter>dhcp_ddns</parameter> parameters set to "yes" configure
-        <command>keactrl</command> to manage (start, reconfigure) all servers,
-        i.e. <command>kea-dhcp4</command>, <command>kea-dhcp6</command> and
-        <command>kea-dhcp-ddns</command>. When any of these parameters is set to
-        "no" the <command>keactrl</command> will ignore
+        The <parameter>dhcp4</parameter>, <parameter>dhcp6</parameter>,
+        <parameter>dhcp_ddns</parameter> and <parameter>ctrl_agent</parameter>
+        parameters set to "yes" configure <command>keactrl</command> to manage
+        (start, reconfigure) all servers, i.e. <command>kea-dhcp4</command>,
+        <command>kea-dhcp6</command>, <command>kea-dhcp-ddns</command> and
+        <command>kea-ctrl-agent</command>. When any of these parameters is set
+        to "no" the <command>keactrl</command> will ignore
         the corresponding server when starting or reconfiguring Kea.
       </para>
 
@@ -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 <parameter>dhcp4_srv</parameter>,
-        <parameter>dhcp6_srv</parameter> and <parameter>dhcp_ddns_srv</parameter>
-        parameters should be modified.
+        <parameter>dhcp6_srv</parameter>, <parameter>dhcp_ddns_srv</parameter>
+        and <parameter>ctrl_agent_srv</parameter> parameters should be modified.
       </para>
 
       <para>
@@ -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
 </screen>
       </para>
 
@@ -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.
 </screen>
       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...
 </screen>
       Note that the <command>stop</command> will attempt to stop all servers
       regardless of whether they are "enabled" in the <filename>keactrl.conf</filename>.
@@ -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.
 </screen>
       </para>
 
@@ -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...
 </screen>
       If any of the servers are not running, an informational message
       is displayed as in the <command>reload</command> 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.
 </screen>
       </para>
 
@@ -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
 </screen>
@@ -261,7 +274,8 @@ keactrl configuration file: /usr/local/etc/kea/keactrl.conf
         command is issued.  For example, the following
         instructs <command>keactrl</command> to stop the
         <command>kea-dhcp4</command> and <command>kea-dhcp6</command> servers
-        and leave the <command>kea-dhcp-ddns</command> server running:
+        and leave the <command>kea-dhcp-ddns</command> and
+        <command>kea-ctrl-agent</command> running:
 <screen>
 <userinput>$ keactrl stop -s dhcp4,dhcp6</userinput>
 </screen>
@@ -270,8 +284,8 @@ keactrl configuration file: /usr/local/etc/kea/keactrl.conf
       <para>
         Similarly, the following
         will only start the <command>kea-dhcp4</command> and
-        <command>kea-dhcp-ddns</command> servers and not
-        <command>kea-dhcp6</command>.
+        <command>kea-dhcp-ddns</command> servers and not:
+        <command>kea-dhcp6</command>, <command>kea-ctrl-agent</command>.
 <screen>
 <userinput>$ keactrl start -s dhcp4,dhcp_ddns</userinput>
 </screen>
@@ -303,6 +317,9 @@ keactrl configuration file: /usr/local/etc/kea/keactrl.conf
             <command>dhcp_ddns</command> for <command>kea-dhcp-ddns.</command>
           </simpara></listitem>
           <listitem><simpara>
+            <command>ctrl_agent</command> for <command>kea-ctrl-agent.</command>
+          </simpara></listitem>
+          <listitem><simpara>
             <command>all</command> for all servers (default).
           </simpara></listitem>
         </itemizedlist>