[#3655] Updated ha-maintenance-notify doc

diff --git a/doc/sphinx/arm/hooks-ha.rst b/doc/sphinx/arm/hooks-ha.rst
index f070a995034a289ee954243d1b0286ba4656cc0e..73969a8fb87ce1e824ec6c0ed4fa27a3d9eb63ea 100644 (file)
--- 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 ea482858a09cedaf07ef0a8eeb95ece74fc56bd6..0d5067a0ab77b9b66bd5746d3fbc6cf19094fdd6 100644 (file)
--- 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\"",
         "    }",
         "}"
     ],