%PDF- %PDF-
Direktori : /backups/router/usr/local/share/kea/api/ |
Current File : //backups/router/usr/local/share/kea/api/reservation-get.json |
{ "access": "read", "avail": "1.2.0", "brief": [ "This command retrieves an existing host reservation." ], "cmd-comment": [ "The host reservation can be identified by either the (subnet-id, ip-address) pair or a triplet of (subnet-id, identifier-type, identifier). Operation-target is optional; default is 'all'." ], "cmd-syntax": [ "{", " \"command\": \"reservation-get\",", " \"arguments\": {", " \"subnet-id\": <integer>,", " \"identifier-type\": <one of 'hw-address', 'duid', 'circuit-id', 'client-id' and 'flex-id'>,", " \"identifier\": <string>,", " \"operation-target\": <string (memory, database, all, default)>", " }", "}" ], "hook": "host_cmds", "name": "reservation-get", "resp-comment": [ "The arguments object appears only if a host is found. Many fields in the arguments object appear only if a specific field is set." ], "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\": [ <comma-separated structures defining options> ],", " \"prefixes\": [ <comma-separated IPv6 prefixes> ],", " \"client-classes\": [ <comma-separated strings> ],", " \"server-hostname\": <string>,", " \"subnet-id\": <integer>,", " \"user-context\": <any valid JSON>", " }", "}" ], "support": [ "kea-dhcp4", "kea-dhcp6" ] }