summaryrefslogtreecommitdiffstats
path: root/src/share/api/remote-option-def4-get-all.json
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 12:15:43 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 12:15:43 +0000
commitf5f56e1a1c4d9e9496fcb9d81131066a964ccd23 (patch)
tree49e44c6f87febed37efb953ab5485aa49f6481a7 /src/share/api/remote-option-def4-get-all.json
parentInitial commit. (diff)
downloadisc-kea-upstream.tar.xz
isc-kea-upstream.zip
Adding upstream version 2.4.1.upstream/2.4.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/share/api/remote-option-def4-get-all.json')
-rw-r--r--src/share/api/remote-option-def4-get-all.json52
1 files changed, 52 insertions, 0 deletions
diff --git a/src/share/api/remote-option-def4-get-all.json b/src/share/api/remote-option-def4-get-all.json
new file mode 100644
index 0000000..df6752d
--- /dev/null
+++ b/src/share/api/remote-option-def4-get-all.json
@@ -0,0 +1,52 @@
+{
+ "access": "read",
+ "avail": "1.6.0",
+ "brief": [
+ "This command fetches all DHCPv4 option definitions 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 option definitions shared by all servers."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-option-def4-get-all\",",
+ " \"arguments\": {",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <single server tag as string> ]",
+ " }",
+ "}"
+ ],
+ "hook": "cb_cmds",
+ "name": "remote-option-def4-get-all",
+ "resp-comment": [
+ "The returned response contains a list of maps. Each map contains an option definition specification and the metadata, including database-specific information associated with the returned objects. If the server tag \"all\" is included in the command, the response contains the option definitions shared among all servers. It excludes server-specific option definitions. If an explicit server tag is included in the command, the response contains all option definitions directly associated with the given server, and the option definitions associated with all servers when server-specific option definitions are not present."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"2 DHCPv4 option definition(s) found.\",",
+ " \"arguments\": {",
+ " \"option-defs\": [",
+ " {",
+ " <first option definition>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <server tag> ]",
+ " }",
+ " },",
+ " {",
+ " <second option definition>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <server tag> ]",
+ " }",
+ " }",
+ " ],",
+ " \"count\": 2",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}