summaryrefslogtreecommitdiffstats
path: root/src/share/api/lease4-get.json
blob: 3b76a10b34969c9a07d20a8e3b36ec7acd054637 (plain)
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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
{
    "access": "read",
    "avail": "1.3.0",
    "brief": [
        "This command queries the lease database and retrieves existing leases."
    ],
    "cmd-syntax": [
        "{",
        "    \"command\": \"lease4-get\",",
        "    \"arguments\": {",
        "        \"ip-address\": \"192.0.2.1\"",
        "    }",
        "}"
    ],
    "description": "See <xref linkend=\"idp58\"/>",
    "hook": "lease_cmds",
    "name": "lease4-get",
    "resp-comment": [
        "lease4-get returns a result that indicates the outcome of the operation and lease details,",
        "if found. It has one of the following values: 0 (success), 1 (error), or 3 (empty). ",
        "Result 3 is returned if no leases are found with specified IP address."
    ],
    "resp-syntax": [
        "{",
        "  \"arguments\": {",
        "    \"client-id\": \"42:42:42:42:42:42:42:42\",",
        "    \"cltt\": 12345678,",
        "    \"fqdn-fwd\": false,",
        "    \"fqdn-rev\": true,",
        "    \"hostname\": \"myhost.example.com.\",",
        "    \"hw-address\": \"08:08:08:08:08:08\",",
        "    \"ip-address\": \"192.0.2.1\",",
        "    \"state\": 0,",
        "    \"subnet-id\": 44,",
        "    \"valid-lft\": 3600",
        "  },",
        "  \"result\": 0,",
        "  \"text\": \"IPv4 lease found.\"",
        "}"
    ],
    "support": [
        "kea-dhcp4"
    ]
}