{
    "name": "reservation-get",
    "brief": "Attempts to retrieve an existing host reservation",
    "support": [ "kea-dhcp4", "kea-dhcp6" ],
    "hook": "host_cmds",
    "avail": "1.2.0",

    "cmd-syntax": "{
    \"command\": \"reservation-get\",
    \"arguments\": {
        \"subnet-id\": <integer>,
        \"identifier-type\": <string with one value out of: hw-address|duid|circuit-id|client-id|flex-id>,
        \"identifier\": <string>;
    }
}",

    "cmd-comment": "The host reservation can be identified by either (subnet-id, ip-address) pair or a triplet of (subnet-id, identifier-type, identifier).",

    "resp-syntax": "{
    \"result\": <integer>,
    \"text\": <string>,
    \"arguments\": {
        \"boot-file-name\": <string>,
        \"comment\": <string>
        \"client-id\": <string>,
        \"circuit-id\": <string>,
        \"duid\": <string>,
        \"flex-id\": <string>,
        \"ip-address\": <string (IPv4 address)>,
        \"ip-addresses\": [ <comma separated strings> ],
        \"hw-address\": <string>,
        \"hostname\": <string>,
        \"next-server\": <string (IPv4 address)>,
        \"option-data-list\": [ <comma separated structures defining options> ],
        \"prefixes\": [ <comma separated IPv6 prefixes> ],
        \"reservation-client-classes\": [ <comma separated strings> ],
        \"server-hostname\": <string>,
        \"subnet-id\": <integer>,
        \"user-context\": <any valid JSON>,
    }
}",

    "resp-comment": "Arguments object appear only if a host is found. Many fields in the arguments
object appear only if specific field is set."
}
