]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
Add new file
authorSuzanne Goldlust <sgoldlust@isc.org>
Thu, 4 Oct 2018 20:38:32 +0000 (16:38 -0400)
committerTomek Mrugalski <tomasz@isc.org>
Tue, 29 Oct 2019 17:57:13 +0000 (18:57 +0100)
doc/api/statistic-reset.json [new file with mode: 0644]

diff --git a/doc/api/statistic-reset.json b/doc/api/statistic-reset.json
new file mode 100644 (file)
index 0000000..32b9d1a
--- /dev/null
@@ -0,0 +1,14 @@
+{
+    "name": "statistic-reset",
+    "brief": "The statistic-reset command sets the specified statistic to its neutral value: 0 for integer, 0.0 for float, 0h0m0s0us for time duration and \"\" for string type. It takes a single string parameter called name that specifies the statistic name.",
+    "description": "See <xref linkend=\"command-statistic-reset\"/>",
+    "support": [ "kea-dhcp4", "kea-dhcp6" ],
+    "avail": "1.0.0",
+    "cmd-syntax": "{
+    \"command\": \"statistic-reset\",
+    \"arguments\": {
+        \"name\": \"pkt4-received\"
+    }
+}",
+    "cmd-comment": "If the specific statistic is found and reset was successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered (e.g. requested statistic was not found), the server will return a status code of 1 (error) and the text field will contain the error description.",
+}
\ No newline at end of file