diff options
| -rw-r--r-- | doc/sphinx/arm/hooks-ha.rst | 5 | ||||
| -rw-r--r-- | src/share/api/ha-maintenance-notify.json | 8 |
2 files changed, 10 insertions, 3 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. diff --git a/src/share/api/ha-maintenance-notify.json b/src/share/api/ha-maintenance-notify.json index ea482858a0..0d5067a0ab 100644 --- a/src/share/api/ha-maintenance-notify.json +++ b/src/share/api/ha-maintenance-notify.json @@ -10,8 +10,9 @@ "cmd-comment": [ "This command includes a boolean argument which, if false, indicates", "that the server should transition to the in-maintenance state.", - "If the argument is set to true it instructs the server to revert from", - "the in-maintenance state to its previous state.", + "If the cancel argument is set to true it instructs the server to revert from", + "the in-maintenance state to its previous state. The state argument informs", + "the recipient about the state of this server.", "This command is not meant to be used by the administrator. It is", "merely used for internal communication between the HA partners." ], @@ -19,7 +20,8 @@ "{", " \"command\": \"ha-maintenance-notify\",", " \"arguments\": {", - " \"cancel\": true", + " \"cancel\": true,", + " \"state\": \"ready\"", " }", "}" ], |