summaryrefslogtreecommitdiffstats
path: root/src/share/api/stat-lease4-get.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/share/api/stat-lease4-get.json')
-rw-r--r--src/share/api/stat-lease4-get.json38
1 files changed, 38 insertions, 0 deletions
diff --git a/src/share/api/stat-lease4-get.json b/src/share/api/stat-lease4-get.json
new file mode 100644
index 0000000..5deb196
--- /dev/null
+++ b/src/share/api/stat-lease4-get.json
@@ -0,0 +1,38 @@
+{
+ "access": "read",
+ "avail": "1.4.0",
+ "brief": [
+ "This command fetches lease statistics for a range of known IPv4 subnets."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"stat-lease4-get\"",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-stat-lease4-get\"/>",
+ "hook": "stat_cmds",
+ "name": "stat-lease4-get",
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"stat-lease4-get: 2 rows found\",",
+ " \"arguments\": {",
+ " \"result-set\": {",
+ " \"columns\": [ \"subnet-id\",",
+ " \"total-addresses\",",
+ " \"cumulative-assigned-addresses\",",
+ " \"assigned-addresses\",",
+ " \"declined-addresses\" ],",
+ " \"rows\": [",
+ " [ 10, 256, 200, 111, 0 ],",
+ " [ 20, 4098, 5000, 2034, 4 ]",
+ " ],",
+ " \"timestamp\": \"2018-05-04 15:03:37.000000\"",
+ " }",
+ " }",
+ " }"
+ ],
+ "support": [
+ "kea-dhcp4"
+ ]
+}