summaryrefslogtreecommitdiffstats
path: root/src/share/api/class-list.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/share/api/class-list.json')
-rw-r--r--src/share/api/class-list.json48
1 files changed, 48 insertions, 0 deletions
diff --git a/src/share/api/class-list.json b/src/share/api/class-list.json
new file mode 100644
index 0000000..17544c8
--- /dev/null
+++ b/src/share/api/class-list.json
@@ -0,0 +1,48 @@
+{
+ "access": "read",
+ "avail": "1.5.0",
+ "brief": [
+ "This command retrieves a list of all client classes from the server configuration."
+ ],
+ "cmd-comment": [
+ "This command includes no arguments."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"class-list\"",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-class-list\"/>",
+ "hook": "class_cmds",
+ "name": "class-list",
+ "resp-comment": [
+ "The returned list of classes merely contains their names.",
+ "In order to retrieve full information about one of these",
+ "classes, use :ref:`command-class-get`.",
+ "The returned result is 3 (empty) if no classes are found.",
+ "If the command is processed successfully and the list of",
+ "client classes is not empty, the result of 0 is returned.",
+ "If there is an error while processing the command, the",
+ "result of 1 is returned."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"'<number of>' classes found\",",
+ " \"arguments\": {",
+ " \"client-classes\": [",
+ " {",
+ " \"name\": <first class name>",
+ " },",
+ " {",
+ " \"name\": <second class name>",
+ " }",
+ " ]",
+ " }",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}