summaryrefslogtreecommitdiffstats
path: root/src/share/api/statistic-sample-count-set.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/share/api/statistic-sample-count-set.json')
-rw-r--r--src/share/api/statistic-sample-count-set.json25
1 files changed, 25 insertions, 0 deletions
diff --git a/src/share/api/statistic-sample-count-set.json b/src/share/api/statistic-sample-count-set.json
new file mode 100644
index 0000000..1e8e17e
--- /dev/null
+++ b/src/share/api/statistic-sample-count-set.json
@@ -0,0 +1,25 @@
+{
+ "access": "write",
+ "avail": "1.6.0",
+ "brief": [
+ "This command sets a size-based limit for a single statistic. It takes two parameters: a string called name and an integer value called max-samples."
+ ],
+ "cmd-comment": [
+ "The server responds with a message about a successfully set limit for the given statistic, with a result of 0 indicating success, and an empty parameters field. If an error is encountered (e.g. the requested statistic was not found), the server returns a status code of 1 (error) and the text field contains the error description."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"statistic-sample-count-set\",",
+ " \"arguments\": {",
+ " \"name\": \"pkt4-received\",",
+ " \"max-samples\": 100",
+ " }",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-statistic-sample-count-set\"/>",
+ "name": "statistic-sample-count-set",
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}