summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMarcin Siodelski <marcin@isc.org>2024-11-27 19:21:11 +0100
committerMarcin Siodelski <marcin@isc.org>2024-12-04 10:21:45 +0100
commit282050ae4f9dbf5cbc0e6d3a80b22daf811622b5 (patch)
treed052cdc5861fb3986a08a52fa18d012f170dc660 /doc
parent[#3655] Added ChangeLog for #3655 (diff)
downloadkea-282050ae4f9dbf5cbc0e6d3a80b22daf811622b5.tar.xz
kea-282050ae4f9dbf5cbc0e6d3a80b22daf811622b5.zip
[#3655] Updated ha-maintenance-notify doc
Diffstat (limited to 'doc')
-rw-r--r--doc/sphinx/arm/hooks-ha.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/sphinx/arm/hooks-ha.rst b/doc/sphinx/arm/hooks-ha.rst
index f070a99503..73969a8fb8 100644
--- a/doc/sphinx/arm/hooks-ha.rst
+++ b/doc/sphinx/arm/hooks-ha.rst
@@ -2280,10 +2280,15 @@ previous state. See the :ref:`ha-maintenance` section for details.
"service": [ "dhcp4" ],
"arguments": {
"cancel": false,
+ "state": "ready",
"server-name": "server2"
}
}
+The ``state`` argument informs the recipient about the state of this server. The
+recipient can instantly resume the operation of the state machine without sending
+a heartbeat to check the partner's state.
+
The optional ``server-name`` parameter specifies the name of one of the partners in
the HA relationship that this command pertains to. This parameter can be omitted if the
server receiving this command has only one HA relationship in its configuration.