diff options
| author | Razvan Becheriu <razvan@isc.org> | 2021-01-20 16:16:38 +0100 |
|---|---|---|
| committer | Razvan Becheriu <razvan@isc.org> | 2021-01-22 18:15:20 +0100 |
| commit | 248e8e162a45729db3337bf50d3d17374f0cecff (patch) | |
| tree | 0902a956ce06217850a07f25ddcdff04c2a437c6 /doc | |
| parent | [#1601] addressed review comments (diff) | |
| download | kea-248e8e162a45729db3337bf50d3d17374f0cecff.tar.xz kea-248e8e162a45729db3337bf50d3d17374f0cecff.zip | |
[#1601] added ChangeLog and updated documentation
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/sphinx/arm/ctrl-channel.rst | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/sphinx/arm/ctrl-channel.rst b/doc/sphinx/arm/ctrl-channel.rst index e4c2071cb3..0245b27eae 100644 --- a/doc/sphinx/arm/ctrl-channel.rst +++ b/doc/sphinx/arm/ctrl-channel.rst @@ -557,6 +557,13 @@ 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. :: @@ -567,12 +574,29 @@ if the ``dhcp-enable`` command is not sent before this time elapses. } } +:: + + { + "command": "dhcp-disable", + "arguments": { + "max-period": 20, + "origin": "user" + } + } + .. _command-dhcp-enable: The dhcp-enable Command ----------------------- The ``dhcp-enable`` command globally enables the DHCP service. +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. :: @@ -580,6 +604,15 @@ The ``dhcp-enable`` command globally enables the DHCP service. "command": "dhcp-enable" } +:: + + { + "command": "dhcp-enable", + "arguments": { + "origin": "user" + } + } + .. _command-status-get: The status-get Command |