From beaab2727a01c68d84acad5eacb298eeecd38c58 Mon Sep 17 00:00:00 2001 From: Suzanne Goldlust Date: Thu, 4 Oct 2018 13:03:47 -0400 Subject: [PATCH] Add new file --- doc/api/network6-get.json | 47 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 doc/api/network6-get.json diff --git a/doc/api/network6-get.json b/doc/api/network6-get.json new file mode 100644 index 0000000000..2f48d204eb --- /dev/null +++ b/doc/api/network6-get.json @@ -0,0 +1,47 @@ +{ + "name": "network6-get", + "brief": "The network6-get command is used to retrieve detailed information about shared networks, including subnets currently being part of a given network.", + "description": "See ", + "support": [ "kea-dhcp4", "kea-dhcp6" ], + "avail": "1.3.0", + "hook": "subnet_cmds", + "cmd-syntax": "{ + \"command\": \"network4-get\", + \"arguments\": { + \"name\": \"floor13\" + } +}", + "resp-syntax": "{ + \"result\": 0, + \"text\": \"Info about IPv4 shared network \'floor13\' returned\", + \"arguments\": { + \"shared-networks\": [ + { + \"match-client-id\": true, + \"name\": \"floor13\", + \"option-data\": [ ], + \"rebind-timer\": 90, + \"relay\": { + \"ip-address\": \"0.0.0.0\" + }, + \"renew-timer\": 60, + \"reservation-mode\": \"all\", + \"subnet4\": [ + { + \"subnet\": \"192.0.2.0/24\", + \"id\": 5, + // many other subnet specific details here + }, + { + \"id\": 6, + \"subnet\": \"192.0.3.0/31\", + // many other subnet specific details here + } + ], + \"valid-lifetime\": 120 + } + ] + } +}", + "resp-comment": "Note that the actual response contains many additional fields that are omitted here for clarity." +} \ No newline at end of file -- 2.47.2