src/share/api/statistic-sample-count-set.json


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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"
    ]
}