summaryrefslogtreecommitdiffstats
path: root/src/share/api/class-del.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/share/api/class-del.json')
-rw-r--r--src/share/api/class-del.json31
1 files changed, 31 insertions, 0 deletions
diff --git a/src/share/api/class-del.json b/src/share/api/class-del.json
new file mode 100644
index 0000000..38c4818
--- /dev/null
+++ b/src/share/api/class-del.json
@@ -0,0 +1,31 @@
+{
+ "access": "write",
+ "avail": "1.5.0",
+ "brief": [
+ "This command removes a client class from the server configuration."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"class-del\",",
+ " \"arguments\": {",
+ " \"name\": <name of the class>",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-class-del\"/>",
+ "hook": "class_cmds",
+ "name": "class-del",
+ "resp-comment": [
+ "The command returns a result of 3 (empty) if the client class does not exist. If the client class exists, the returned result is 0 if the deletion was successful; the result is 1 if the deletion is unsuccessful."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"Class '<class-name>' deleted.\"",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}