From a971a1cdc4b792e7765aa9bfa01899c28b2da0e1 Mon Sep 17 00:00:00 2001 From: Suzanne Goldlust Date: Thu, 17 Jan 2019 15:02:39 -0500 Subject: [PATCH] Update hooks-stat-cmds.xml --- doc/guide/hooks-stat-cmds.xml | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/doc/guide/hooks-stat-cmds.xml b/doc/guide/hooks-stat-cmds.xml index 271d79b722..6cce835815 100644 --- a/doc/guide/hooks-stat-cmds.xml +++ b/doc/guide/hooks-stat-cmds.xml @@ -85,16 +85,17 @@ subnet-id - The ID of the subnet for which lease statistics should be fetched. Use this to get statistics for a single subnet. If the subnet does not exist, the command result - code will be 3 (i.e. CONTROL_RESULT_EMPTY). + code is 3 (i.e. CONTROL_RESULT_EMPTY). subnet-range - A pair of subnet IDs which describe an inclusive range of subnets for which statistics should - be retrieved. Note that fuzzy values are supported, thus allowing - for a query for statistics using approximate ID values. If the - range does not include any known subnets, the command result code - will be 3 (i.e. CONTROL_RESULT_EMPTY). + be retrieved. The range may include one or more IDs that correspond + to no subnet: in this case, the command will only output lease + statistics for those that exist. However, if the range does not + include any known subnets, the command result code is 3 + (i.e. CONTROL_RESULT_EMPTY). first-subnet-id - The ID of the first @@ -114,7 +115,7 @@ subnets, this can result in a large response. - The following command would fetch lease statistics for all known subnets from a kea-dhcp4 server: + The following command fetches lease statistics for all known subnets from a kea-dhcp4 server: { "command": "stat-lease4-get" @@ -122,7 +123,7 @@ - The following command would fetch lease statistcis for subnet ID 10 from a kea-dhcp6 server: + The following command fetches lease statistics for subnet ID 10 from a kea-dhcp6 server: { "command": "stat-lease6-get", @@ -133,7 +134,7 @@ - The following command would fetch lease statistics for all subnets from subnet IDs 10 through 50 from a kea-dhcp4 server: + The following command fetches lease statistics for all subnets with IDs in the range 10 through 50 from a kea-dhcp4 server: { "command": "stat-lease4-get", -- 2.47.2