diff options
| author | Marcin Siodelski <marcin@isc.org> | 2024-04-24 21:04:18 +0200 |
|---|---|---|
| committer | Marcin Siodelski <marcin@isc.org> | 2024-04-26 13:38:59 +0200 |
| commit | 0025845104fbd3d30684721b28c7401c62c43cfc (patch) | |
| tree | d89a47db3d824758f0097c530a797e127db9607e /doc/sphinx/arm | |
| parent | [#1914] Use IOService::stopAndPoll (diff) | |
| download | kea-0025845104fbd3d30684721b28c7401c62c43cfc.tar.xz kea-0025845104fbd3d30684721b28c7401c62c43cfc.zip | |
[#3344] Use origin-id instead of origin
The HA partners now send the commands with both origin-id and origin to
provide backward compatibility between different Kea versions.
Diffstat (limited to 'doc/sphinx/arm')
| -rw-r--r-- | doc/sphinx/arm/ctrl-channel.rst | 9 | ||||
| -rw-r--r-- | doc/sphinx/arm/hooks-ha.rst | 6 |
2 files changed, 13 insertions, 2 deletions
diff --git a/doc/sphinx/arm/ctrl-channel.rst b/doc/sphinx/arm/ctrl-channel.rst index b6a5cd849c..d4d92e363b 100644 --- a/doc/sphinx/arm/ctrl-channel.rst +++ b/doc/sphinx/arm/ctrl-channel.rst @@ -721,12 +721,17 @@ communication between HA partners and should not be specified in the administrator's commands, as it may interfere with HA operation. The administrator should either omit this parameter or set it to "user". +Introduction of ``origin-id`` deprecates the use of the ``origin`` parameter +in the messages exchanged between the Kea HA partners. The ``origin-id`` parameter +must not be used in messages sent by the user. + :: { "command": "dhcp-disable", "arguments": { "max-period": 20, + "origin-id": 2002, "origin": "user" } } @@ -750,6 +755,10 @@ administrator's commands, as it may interfere with HA operation. The administrator should either omit this parameter or set it to "user". +Introduction of ``origin-id`` deprecates the use of the ``origin`` parameter +in the messages exchanged between the Kea HA partners. The ``origin-id`` parameter +must not be used in messages sent by the user. + :: { diff --git a/doc/sphinx/arm/hooks-ha.rst b/doc/sphinx/arm/hooks-ha.rst index 96c4bb5fe3..866599105d 100644 --- a/doc/sphinx/arm/hooks-ha.rst +++ b/doc/sphinx/arm/hooks-ha.rst @@ -2366,7 +2366,7 @@ responding to clients. "command": "ha-sync-complete-notify", "service": [ "dhcp4" ], "arguments": { - "origin": 2000, + "origin-id": 2000, "server-name": "server2" } } @@ -2375,9 +2375,11 @@ The optional ``server-name`` parameter specifies a name of one of the partners b to the HA relationship this command pertains to. This parameter can be omitted if the server receiving this command has only one HA relationship in the configuration. -The ``origin`` parameter is used to select the HA service for which the receiving server should +The ``origin-id`` parameter is used to select the HA service for which the receiving server should enable the DHCP service when it receives this notification. This is the same origin the sending server used previously to disable the DHCP service before synchronization. +The ``origin-id`` parameter deprecates the ``origin`` parameter used in some earlier +Kea versions. It elicits the response: |