summaryrefslogtreecommitdiffstats
path: root/src/share/api/lease6-get.json
blob: 3d220d50a0bcfde90cd308f85c5160d1f24864a4 (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
45
46
47
48
49
50
51
52
53
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"
    ]
}