From: Tomek Mrugalski <tomasz@isc.org>
Date: Fri, 5 Oct 2018 17:59:41 +0000 (+0200)
Subject: [#10,!3] Added 4 missing files for ha-* commands.
X-Git-Tag: 176-update-to-sysrepo-0-7-6-release_base~77
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=aad75c9a7adfbabf023771dde0b4d985dcfe0940;p=thirdparty%2Fkea.git

[#10,!3] Added 4 missing files for ha-* commands.
---

diff --git a/doc/api/ha-continue.json b/doc/api/ha-continue.json
new file mode 100644
index 0000000000..c61b3f43cf
--- /dev/null
+++ b/doc/api/ha-continue.json
@@ -0,0 +1,8 @@
+{
+    "name": "ha-continue",
+    "brief": "This command is used to resume the operation of the paused HA state machine.",
+    "description": "See <xref linkend=\"anchor-in-the-docs\"/>",
+    "support": [ "kea-dhcp4", "kea-dhcp6" ],
+    "avail": "1.4.0",
+    "hook": "high_availability"
+}
diff --git a/doc/api/ha-heartbeat.json b/doc/api/ha-heartbeat.json
new file mode 100644
index 0000000000..46dd851c17
--- /dev/null
+++ b/doc/api/ha-heartbeat.json
@@ -0,0 +1,12 @@
+{
+    "name": "ha-heartbeat",
+    "brief": "This command is sent internally by Kea partner when operating
+              in High Availability (HA) mode. It should not be used by users,
+              unless you want to implement complete HA replacement.",
+    "description": "See <xref linkend=\"ha-server-states\"/>",
+    "support": [ "kea-dhcp4", "kea-dhcp6" ],
+    "avail": "1.4.0",
+    "hook": "high_availability",
+    "cmd-syntax": "tbd",
+    "resp-syntax": "tbd"
+}
diff --git a/doc/api/ha-scopes.json b/doc/api/ha-scopes.json
new file mode 100644
index 0000000000..d88eaa7168
--- /dev/null
+++ b/doc/api/ha-scopes.json
@@ -0,0 +1,17 @@
+{
+    "name": "ha-scopes",
+    "brief": "This command allows for modifying the High Availability (HA) scopes
+              that the server is serving.a sentence or two explaining what this command does",
+    "description": "See <xref linkend=\"command-ha-scopes\"/>",
+    "support": [ "kea-dhcp4", "kea-dhcp6" ],
+    "avail": "1.4.0",
+    "hook": "high_availability",
+    "cmd-syntax": "{
+    \"command\": \"ha-scopes\",
+    \"service\": [ <service, typically \"dhcp4\" or \"dhcp6\"> ],
+    \"arguments\": {
+        \"scopes\": [ \"HA_server1\", \"HA_server2\" ]
+    }
+}
+"
+}
diff --git a/doc/api/ha-sync.json b/doc/api/ha-sync.json
new file mode 100644
index 0000000000..282ca606d8
--- /dev/null
+++ b/doc/api/ha-sync.json
@@ -0,0 +1,17 @@
+{
+    "name": "ha-sync",
+    "brief": "The command is issued to instruct the server running in HA mode to 
+              synchronize its local lease database with the selected peer.",
+    "description": "See <xref linkend=\"command-ha-sync\"/>",
+    "support": [ "kea-dhcp4", "kea-dhcp6" ],
+    "avail": "1.4.0",
+    "hook": "high_availability",
+    "cmd-syntax": "{
+    \"command\": \"ha-sync\",
+    \"service\": [ <service affected: \"dhcp4\" or \"dhcp6\" ],
+    \"arguments\": {
+        \"server-name\": <name of the partner server>,
+        \"max-period\": <integer, in seconds>
+    }
+}"
+}