summaryrefslogtreecommitdiffstats
path: root/src/share/api/remote-class4-get-all.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/share/api/remote-class4-get-all.json')
-rw-r--r--src/share/api/remote-class4-get-all.json52
1 files changed, 52 insertions, 0 deletions
diff --git a/src/share/api/remote-class4-get-all.json b/src/share/api/remote-class4-get-all.json
new file mode 100644
index 0000000..639fc36
--- /dev/null
+++ b/src/share/api/remote-class4-get-all.json
@@ -0,0 +1,52 @@
+{
+ "access": "read",
+ "avail": "1.9.10",
+ "brief": [
+ "This command fetches all DHCPv4 client classes for specified servers from the configuration database."
+ ],
+ "cmd-comment": [
+ "The ``server-tags`` list is required for this command, and must not be empty."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"remote-class4-get-all\",",
+ " \"arguments\": {",
+ " \"remote\": {",
+ " <specification of the database to connect to>",
+ " },",
+ " \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
+ " }",
+ "}"
+ ],
+ "hook": "cb_cmds",
+ "name": "remote-class4-get-all",
+ "resp-comment": [
+ "The returned response contains a list of maps. Each map contains a client class name and the metadata, which provides database-specific information associated with the client class."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"2 DHCPv4 client class(es) found.\",",
+ " \"arguments\": {",
+ " \"client-classes\": [",
+ " {",
+ " <first client class specification>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <first server tag>, <second server tag>, ... ]",
+ " }",
+ " },",
+ " {",
+ " <second client class specification>,",
+ " \"metadata\": {",
+ " \"server-tags\": [ <first server tag>, ... ]",
+ " }",
+ " }",
+ " ],",
+ " \"count\": 2",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}