summaryrefslogtreecommitdiffstats
path: root/src/share/api/class-update.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/class-update.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/class-update.json')
-rw-r--r--src/share/api/class-update.json42
1 files changed, 42 insertions, 0 deletions
diff --git a/src/share/api/class-update.json b/src/share/api/class-update.json
new file mode 100644
index 0000000..c3b8284
--- /dev/null
+++ b/src/share/api/class-update.json
@@ -0,0 +1,42 @@
+{
+ "access": "write",
+ "avail": "1.5.0",
+ "brief": [
+ "This command updates an existing client class in the server configuration."
+ ],
+ "cmd-comment": [
+ "The ``next-server``, ``server-hostname``, and ``boot-file-name`` are DHCPv4-specific. Only one client class can be updated with a single command. "
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"class-update\",",
+ " \"arguments\": {",
+ " \"client-classes\": [ {",
+ " \"name\": <name of the class>,",
+ " \"test\": <test expression to be evaluated on incoming packets>,",
+ " \"option-data\": [ <option values here> ],",
+ " \"option-def\": [ <option definitions here> ],",
+ " \"next-server\": <ipv4 address>,",
+ " \"server-hostname\": <string>,",
+ " \"boot-file-name\": <name of the boot file>",
+ " } ]",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-class-update\"/>",
+ "hook": "class_cmds",
+ "name": "class-update",
+ "resp-comment": [
+ "The command returns the result of 3 (empty) if the client class does not exist. If the client class exists, the returned result is 0 if the update was successful, or 1 if the update is unsuccessful."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"Class '<class-name>' updated.\"",
+ "}"
+ ],
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}