1 files changed, 52 insertions, 0 deletions
diff --git a/src/share/api/remote-option4-global-get-all.json b/src/share/api/remote-option4-global-get-all.json
new file mode 100644
index 0000000..d64ff31
--- /dev/null
+++ b/src/share/api/remote-option4-global-get-all.json
@@ -0,0 +1,52 @@
+{
+    "access": "read",
+    "avail": "1.6.0",
+    "brief": [
+        "This command fetches all DHCPv4 global options for the server from the configuration database."
+    ],
+    "cmd-comment": [
+        "The ``server-tags`` list is mandatory and must contain exactly one server tag. Specifying an empty list, a value of ``null``, or multiple server tags will result in an error. The special server tag \"all\" is allowed, to fetch the global options shared by all servers."
+    ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"remote-option4-global-get-all\",",
+        "    \"arguments\": {",
+        "        \"remote\": {",
+        "            <specification of the database to connect to>",
+        "        },",
+        "        \"server-tags\": [ <single server tag as string> ]",
+        "    }",
+        "}"
+    ],
+    "hook": "cb_cmds",
+    "name": "remote-option4-global-get-all",
+    "resp-comment": [
+        "The returned response contains a list of maps. Each map contains a global option specification and the metadata, including database-specific information associated with the returned object. If the server tag \"all\" is included in the command, the response contains the global options shared among all servers. It excludes server-specific global options. If an explicit server tag is included in the command, the response contains all global options directly associated with the given server, and the options associated with all servers when server-specific options are not present."
+    ],
+    "resp-syntax": [
+        "{",
+        "    \"result\": 0,",
+        "    \"text\": \"2 DHCPv4 option(s) found.\",",
+        "    \"arguments\": {",
+        "        \"options\": [",
+        "            {",
+        "                <first option specification>,",
+        "                \"metadata\": {",
+        "                    \"server-tags\": [ <server tag> ]",
+        "                }",
+        "            },",
+        "            {",
+        "                <second option specification>,",
+        "                \"metadata\": {",
+        "                    \"server-tags\": [ <server tag> ]",
+        "                }",
+        "            }",
+        "        ],",
+        "        \"count\": 2",
+        "    }",
+        "}"
+    ],
+    "support": [
+        "kea-dhcp4"
+    ]
+}