summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRazvan Becheriu <razvan@isc.org>2021-01-22 14:29:40 +0100
committerRazvan Becheriu <razvan@isc.org>2021-01-22 18:15:20 +0100
commitf638379c92f3e54243a345ad54ab2aa24e6916d7 (patch)
tree75025a2ccc8666f4f83e519e459a639850b05c36 /doc
parent[#1601] fixed documentation examples (diff)
downloadkea-f638379c92f3e54243a345ad54ab2aa24e6916d7.tar.xz
kea-f638379c92f3e54243a345ad54ab2aa24e6916d7.zip
[#1601] multiple changes:
* added a timer for each origin type: USER_COMMAND and HA_COMMAND * added missing unittests
Diffstat (limited to 'doc')
-rw-r--r--doc/sphinx/arm/ctrl-channel.rst16
1 files changed, 9 insertions, 7 deletions
diff --git a/doc/sphinx/arm/ctrl-channel.rst b/doc/sphinx/arm/ctrl-channel.rst
index 0245b27eae..b1a81faa70 100644
--- a/doc/sphinx/arm/ctrl-channel.rst
+++ b/doc/sphinx/arm/ctrl-channel.rst
@@ -557,13 +557,15 @@ synchronization of the lease databases at startup, or recovery after a
failure. The optional parameter "max-period" specifies the time in
seconds after which the DHCP service should be automatically re-enabled,
if the ``dhcp-enable`` command is not sent before this time elapses.
-Since Kea 1.9.4 there is an additional "origin" parameter which specifies
-the source of the command: either user requested or internally required by
-the HA library. If not specified, the command is considered to be requested
-by user. Valid values for the 'origin' parameter are: 'user' (which is the
-default value) and 'ha-partner'. Using the 'ha-partner' value is not
-recommended because it can interfere with the HA mechanics and can result
-in undesired effects.
+Since Kea 1.9.4 there is an additional "origin" parameter that specifies the
+command source. A server administrator should typically omit this parameter
+because the default value "user" indicates that the administrator sent the
+command. This command can also be sent by the partner server running HA hooks
+library. In that case, the partner server sets the parameter to "ha-partner".
+This value is reserved for the communication between HA partners and should not
+be specified in the administrator's commands because it may interfere with the
+HA operation. The administrator should either omit this parameter or set it to
+"user".
::