From: Suzanne Goldlust Date: Tue, 18 Dec 2018 23:39:26 +0000 (-0500) Subject: Update keactrl.xml X-Git-Tag: 481-remote-subnet4-set-inconsistent-work-when-id-subnet-is-duplicated_base~90 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=f2a880ad38b74dc3f27de8223aa62ee25ced9e2a;p=thirdparty%2Fkea.git Update keactrl.xml --- diff --git a/doc/guide/keactrl.xml b/doc/guide/keactrl.xml index 46140e1792..9d42dec732 100644 --- a/doc/guide/keactrl.xml +++ b/doc/guide/keactrl.xml @@ -3,7 +3,7 @@ - - This Source Code Form is subject to the terms of the Mozilla Public - License, v. 2.0. If a copy of the MPL was not distributed with this - - file, You can obtain one at http://mozilla.org/MPL/2.0/. + - file, you can obtain one at http://mozilla.org/MPL/2.0/. --> @@ -12,10 +12,10 @@
Overview - keactrl is a shell script which controls the startup, shutdown + keactrl is a shell script which controls the startup, shutdown, and reconfiguration of the Kea servers (kea-dhcp4, kea-dhcp6, kea-dhcp-ddns, - kea-ctrl-agent and + kea-ctrl-agent, and kea-netconf). It also provides the means for checking the current status of the servers and determining the configuration files in use. @@ -59,8 +59,8 @@ keactrl <command> [-c keactrl-config-file] [-s server[,server,..]] The keactrl Configuration File Depending on requirements, not all of the available servers need - be run. The keactrl configuration file sets which servers are - enabled and which are disabled. The default configuration + to be run. The keactrl configuration file sets which servers are + enabled and which are disabled. The default configuration file is [kea-install-dir]/etc/kea/keactrl.conf, but this can be overridden on a per-command basis using the -c switch. @@ -114,14 +114,14 @@ kea_verbose=no The dhcp4, dhcp6, - dhcp_ddns, ctrl_agent + dhcp_ddns, ctrl_agent, and netconf parameters set to "yes" will configure keactrl to manage (start, reconfigure) all servers, i.e. kea-dhcp4, kea-dhcp6, kea-dhcp-ddns, - kea-ctrl-agent and kea-netconf. + kea-ctrl-agent, and kea-netconf. When any of these parameters is set - to "no" the keactrl will ignore + to "no," the keactrl will ignore the corresponding server when starting or reconfiguring Kea. Some daemons (ddns and netconf) are disabled by default. @@ -133,7 +133,7 @@ kea_verbose=no location needs to be altered for any reason, the paths specified with the dhcp4_srv, dhcp6_srv, dhcp_ddns_srv - ctrl_agent_srv and netconf_srv + ctrl_agent_srv, and netconf_srv parameters should be modified. @@ -143,7 +143,7 @@ kea_verbose=no is set to "yes" the logging level of the server is set to DEBUG. Modification of the logging severity in a configuration file, as described in , will have no effect as long - as the kea_verbose is set to "yes". Setting + as the kea_verbose is set to "yes." Setting it to "no" will cause the server to use the logging levels specified in the Kea configuration file for respective loggers. If no logging configuration is specified, the default settings will be @@ -152,7 +152,7 @@ kea_verbose=no - The verbosity for the server is set when it is started. Once + The verbosity for the server is set when it is started. Once started, the verbosity can be only changed by stopping the server and starting it again with the new value of the kea_verbose parameter. @@ -179,8 +179,8 @@ kea_verbose=no or inactive) and the names of the configuration files in use. - version - prints out a version of the - keactrl tool itself, but also the Kea daemons. + version - prints out the version of the + keactrl tool itself, and also the Kea daemons. @@ -198,7 +198,7 @@ INFO/keactrl: Starting kea-netconf -c /usr/local/etc/kea/kea-netconf.conf -d Kea's servers create PID files upon startup. These files are used - by keactrl to determine whether or not a given server is running. If + by keactrl to determine whether a given server is running. If one or more servers are running when the start command is issued, the output will look similar to the following: @@ -210,11 +210,11 @@ INFO/keactrl: kea-ctrl-agent appears to be running, see: PID 10931, PID file: /u INFO/keactrl: kea-netconf appears to be running, see: PID 10123, PID file: /usr/local/var/kea/kea.kea-netconf.pid. During normal shutdowns these PID files are deleted. They may, however, - be left over as remnants following a system crash. It is possible, - though highly unlikely, that upon system restart the PIDs they contain - actually refer to processes unrelated to Kea. This condition will cause + be left over as remnants following a system crash. It is possible, + though highly unlikely, that upon system restart the PIDs they contain may + actually refer to processes unrelated to Kea. This condition will cause keactrl to decide that the servers are running, when in fact they are - not. In such a case the PID files as listed in the keactrl output + not. In such a case the PID files as listed in the keactrl output must be manually deleted. @@ -227,7 +227,7 @@ INFO/keactrl: Stopping kea-dhcp-ddns... INFO/keactrl: Stopping kea-ctrl-agent... INFO/keactrl: Stopping kea-netconf... - Note that the stop will attempt to stop all servers + Note that the stop command will attempt to stop all servers regardless of whether they are "enabled" in the keactrl.conf. If any of the servers are not running, an informational message is displayed as in the stop command output below. @@ -258,8 +258,8 @@ 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. - Note that as of 1.5.0 kea-netconf does not support SIGHUP signal yet. - If its configuration has changed, please stop and start it. + Note that as of 1.5.0, kea-netconf does not yet support SIGHUP signal. + If its configuration has changed, please stop and restart it. This limitation will be removed in upcoming Kea releases. $ keactrl stop @@ -274,7 +274,7 @@ INFO/keactrl: kea-netconf isn't running. NETCONF is an optional feature that is disabled by default and can be enabled during compilation. If Kea was compiled without NETCONF support, - keactrl will do it's best to not bother the user with information about + keactrl will do its best to not bother the user with information about it. The netconf entries will still be present in the keactrl.conf file, but netconf status will not be shown and other commands will ignore it. @@ -283,14 +283,14 @@ INFO/keactrl: kea-netconf isn't running. Currently keactrl does not report configuration failures when the server is started or reconfigured. To check if - the server's configuration succeeded the Kea log must be examined + the server's configuration succeeded, the Kea log must be examined for errors. By default, this is written to the syslog file. Sometimes it is useful to check which servers are running. The - status reports this, typical output looking like: + status reports this, with typical output that looks like: $ keactrl status DHCPv4 server: active @@ -313,8 +313,8 @@ keactrl configuration file: /usr/local/etc/kea/keactrl.conf Overriding the Server Selection The optional -s switch allows - the selection of the servers to which keactrl - command is issued. For example, the following + the selection of the servers to which the keactrl + command is issued. For example, the following instructs keactrl to stop the kea-dhcp4 and kea-dhcp6 servers and leave the kea-dhcp-ddns and @@ -326,9 +326,9 @@ 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-ctrl-agent. + will start only the kea-dhcp4 and + kea-dhcp-ddns servers, and not + kea-dhcp6 or kea-ctrl-agent. $ keactrl start -s dhcp4,dhcp_ddns @@ -340,9 +340,9 @@ keactrl configuration file: /usr/local/etc/kea/keactrl.conf On start and reload, keactrl will check if the servers given as parameters to the -s switch are - enabled in the keactrl configuration file: - if not, the server will be ignored. For stop however, - this check is not made: the command is applied to all listed servers, + enabled in the keactrl configuration file; + if not, the server will be ignored. For stop, however, + this check is not made; the command is applied to all listed servers, regardless of whether they have been enabled in the file. @@ -351,19 +351,19 @@ keactrl configuration file: /usr/local/etc/kea/keactrl.conf command line option: - dhcp4 for kea-dhcp4. + dhcp4 for kea-dhcp4. - dhcp6 for kea-dhcp6. + dhcp6 for kea-dhcp6. - dhcp_ddns for kea-dhcp-ddns. + dhcp_ddns for kea-dhcp-ddns. - ctrl_agent for kea-ctrl-agent. + ctrl_agent for kea-ctrl-agent. - netconf for kea-netconf. + netconf for kea-netconf. all for all servers (default).