diff options
Diffstat (limited to 'src/share/api/lease6-get.json')
| -rw-r--r-- | src/share/api/lease6-get.json | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/src/share/api/lease6-get.json b/src/share/api/lease6-get.json new file mode 100644 index 0000000..3d220d5 --- /dev/null +++ b/src/share/api/lease6-get.json @@ -0,0 +1,54 @@ +{ + "access": "read", + "avail": "1.3.0", + "brief": [ + "This command queries the lease database and retrieves existing leases." + ], + "cmd-comment": [ + "lease6-get returns a result that indicates the outcome of the operation and lease details, if found." + ], + "cmd-syntax": [ + "{", + " \"command\": \"lease6-get\",", + " \"arguments\": {", + " \"ip-address\": \"2001:db8:1234:ab::\",", + " \"type\": \"IA_PD\"", + " }", + "}" + ], + "resp-comment": [ + "Result 0 is returned when at least one lease is found, 1 when parameters are malformed or missing,", + "3 is returned if no leases are found with specified parameter." + ], + "resp-syntax": [ + " {", + " \"arguments\": {", + " \"leases\": [", + " {", + " \"cltt\": 1600439560,", + " \"duid\": \"00:01:00:01:26:f7:81:88:00:0c:01:02:03:04\",", + " \"fqdn-fwd\": false,", + " \"fqdn-rev\": false,", + " \"hostname\": \"foobar.example.org\",", + " \"hw-address\": \"00:0c:01:02:03:04\",", + " \"iaid\": 1,", + " \"ip-address\": \"2001:db8:1::\",", + " \"preferred-lft\": 3000,", + " \"state\": 0,", + " \"subnet-id\": 1,", + " \"type\": \"IA_NA\",", + " \"valid-lft\": 4000", + " }", + " ]", + " },", + " \"result\": 0,", + " \"text\": \"1 IPv6 lease(s) found.\"", + " }" + ], + "description": "See <xref linkend=\"idp58\"/>", + "hook": "lease_cmds", + "name": "lease6-get", + "support": [ + "kea-dhcp6" + ] +} |