mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-30 05:27:55 +00:00
Code Issues Releases Wiki Activity

[#777,!464] Reverted JSON files back to the original syntax.

Browse Source
This commit is contained in:
Tomek Mrugalski 2019-08-06 17:04:04 +02:00
parent 2c0e48ed66
commit a5b68da569
76 changed files with 1109 additions and 997 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/sphinx/api/build-report.json
View File

@ -3,8 +3,14 @@
"brief": "Returns a list of compilation options that this particular binary was built with",
"support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.2.0",
"resp-syntax": {
"result": 0,
"text": "<string with build details>"
}
"cmd-syntax": "{
\"command\": \"build-report\"
}",
"resp-syntax": "{
\"result\": 0,
\"text\": <string with build details>
}",
"resp-comment": ""
}

21
doc/sphinx/api/cache-get-by-id.json
View File

@ -4,15 +4,14 @@
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.6.0",
"hook": "host_cache",
"cmd-syntax": {
"command": "cache-get-by-id",
"arguments": {
"hw-address": "01:02:03:04:05:06"
}
},
"resp-syntax": {
"result": 0,
"text": "2 entries returned.",
"arguments": "<list of host reservations>"
}
"cmd-syntax": "{
\"command\": \"cache-get-by-id\",
\"arguments\": {
\"hw-address\": \"01:02:03:04:05:06\"
}",
"resp-syntax": "{
\"result\": 0
\"text\": \"2 entries returned.\"
\"arguments\": <list of host reservations>
}"
}

10
doc/sphinx/api/cache-get.json
View File

@ -5,9 +5,9 @@
"avail": "1.4.0",
"hook": "host_cache",
"resp-syntax": {
"result": 0,
"text": "123 entries returned.",
"arguments": "<list of host reservations>"
}
"resp-syntax": "{
\"result\": 0
\"text\": \"123 entries returned.\"
\"arguments\": <list of host reservations>
}"
}

73
doc/sphinx/api/cache-insert.json
View File

@ -5,40 +5,41 @@
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.4.0",
"hook": "host_cache",
"cmd-syntax": [{
"command": "cache-insert",
"arguments": {
"hw-address": "01:02:03:04:05:06",
"subnet-id4": 4,
"subnet-id6": 0,
"ip-address": "192.0.2.100",
"hostname": "somehost.example.org",
"client-classes4": [ ],
"client-classes6": [ ],
"option-data4": [ ],
"option-data6": [ ],
"next-server": "192.0.0.2",
"server-hostname": "server-hostname.example.org",
"boot-file-name": "bootfile.efi",
"host-id": 0
}
}, {
"command": "cache-insert",
"arguments": {
"hw-address": "01:02:03:04:05:06",
"subnet-id4": 0,
"subnet-id6": 6,
"ip-addresses": [ "2001:db8::cafe:babe" ],
"prefixes": [ "2001:db8:dead:beef::/64" ],
"hostname": "",
"client-classes4": [ ],
"client-classes6": [ ],
"option-data4": [ ],
"option-data6": [ ],
"next-server": "0.0.0.0",
"server-hostname": "",
"boot-file-name": "",
"host-id": 0
}
}]
"cmd-syntax": "{
\"command\": \"cache-insert\",
\"arguments\": {
\"hw-address\": \"01:02:03:04:05:06\",
\"subnet-id4\": 4,
\"subnet-id6\": 0,
\"ip-address\": \"192.0.2.100\",
\"hostname\": \"somehost.example.org\",
\"client-classes4\": [ ],
\"client-classes6\": [ ],
\"option-data4\": [ ],
\"option-data6\": [ ],
\"next-server\": \"192.0.0.2\",
\"server-hostname\": \"server-hostname.example.org\",
\"boot-file-name\": \"bootfile.efi\",
\"host-id\": 0
}
},
{
\"command\": \"cache-insert\",
\"arguments\": {
\"hw-address\": \"01:02:03:04:05:06\",
\"subnet-id4\": 0,
\"subnet-id6\": 6,
\"ip-addresses\": [ \"2001:db8::cafe:babe\" ],
\"prefixes\": [ \"2001:db8:dead:beef::/64\" ],
\"hostname\": \"\",
\"client-classes4\": [ ],
\"client-classes6\": [ ],
\"option-data4\": [ ],
\"option-data6\": [ ],
\"next-server\": \"0.0.0.0\",
\"server-hostname\": \"\",
\"boot-file-name\": \"\",
\"host-id\": 0
}
}"
}

8
doc/sphinx/api/cache-load.json
View File

@ -5,8 +5,8 @@
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.4.0",
"hook": "host_cache",
"cmd-syntax": {
"command": "cache-load",
"arguments": "/tmp/kea-host-cache.json"
}
"cmd-syntax": "{
\"command\": \"cache-load\",
\"arguments\": \"/tmp/kea-host-cache.json\"
}"
}

30
doc/sphinx/api/cache-remove.json
View File

@ -5,18 +5,20 @@
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.4.0",
"hook": "host_cache",
"cmd-syntax": [{
"command": "cache-remove",
"arguments": {
"ip-address": "192.0.2.1",
"subnet-id": 123
}
}, {
"command": "cache-remove",
"arguments": {
"duid": "00:01:ab:cd:f0:a1:c2:d3:e4",
"subnet-id": 123
},
"comment": "Another example that removes IPv6 host identifier by DUID and specific subnet-id is:"
}]
"cmd-syntax": "{
\"command\": \"cache-remove\",
\"arguments\": {
\"ip-address\": \"192.0.2.1\",
\"subnet-id\": 123
}
}
Another example that removes IPv6 host identifier by DUID and specific subnet-id is:
{
\"command\": \"cache-remove\",
\"arguments\": {
\"duid\": \"00:01:ab:cd:f0:a1:c2:d3:e4\",
\"subnet-id\": 123
}
}"
}

10
doc/sphinx/api/cache-size.json
View File

@ -5,9 +5,9 @@
"avail": "1.6.0",
"hook": "host_cache",
"resp-syntax": {
"result": 0,
"text": "123 entries.",
"arguments": { "size": 123 }
}
"resp-syntax": "{
\"result\": 0
\"text\": \"123 entries.\"
\"arguments\": { \"size\": 123 }
}"
}

8
doc/sphinx/api/cache-write.json
View File

@ -5,9 +5,9 @@
"avail": "1.4.0",
"hook": "host_cache",
"cmd-syntax": {
"command": "cache-write",
"arguments": "/path/to/the/file.json"
},
"cmd-syntax": "{
\"command\": \"cache-write\",
\"arguments\": \"/path/to/the/file.json\"
}",
"cmd-comment": "The command takes one mandatory argument that specifies a filename path of a file to be written."
}

47
doc/sphinx/api/class-add.json
View File

@ -1,28 +1,33 @@
{
"name": "class-add",
"brief": "This command is used to create and add a new class to the existing server configuration.",
"brief": "This command is used to create and add a new class to the existing
server configuration.",
"description": "See <xref linkend=\"command-class-add\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.5.0",
"hook": "class_cmds",
"cmd-syntax": {
"command": "class-add",
"arguments": {
"client-classes": [ {
"name": "<name of the class>",
"test": "<test expression to be evaluated on incoming packets>",
"option-data": [ "<option values here>" ],
"option-def": [ "<option defintions here>" ],
"next-server": "<ipv4 address>",
"server-hostname": "<string>",
"boot-file-name": "<name of the boot file>"
} ]
}
},
"cmd-comment": "The <command>next-server</command>, <command>server-hostname</command> and <command>boot-file-name</command> are DHCPv4 specific. Only one client class can be added with a single command. ",
"resp-syntax": {
"result": 0,
"text": "Class '<class-name>' added."
},
"resp-comment": "The command will be successful (result 0), unless the class name is a duplicate or another error occurs (result 1)."
"cmd-syntax": "{
\"command\": \"class-add\",
\"arguments\": {
\"client-classes\": [ {
\"name\": <name of the class>,
\"test\": <test expression to be evaluated on incoming packets>,
\"option-data\": [ <option values here> ],
\"option-def\": [ <option defintions here> ],
\"next-server\": <ipv4 address>,
\"server-hostname\": <string>,
\"boot-file-name\": <name of the boot file>
} ]
}
}",
"cmd-comment": "The <command>next-server</command>,
<command>server-hostname</command> and
<command>boot-file-name</command> are DHCPv4 specific. Only
one client class can be added with a single command. ",
"resp-syntax": "{
\"result\": 0,
\"text\": \"Class '<class-name>' added.\",
}",
"resp-comment": "The command will be successful (result 0), unless the
class name is a duplicate or another error occurs (result 1)."
}

25
doc/sphinx/api/class-del.json
View File

@ -5,16 +5,19 @@
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.5.0",
"hook": "class_cmds",
"cmd-syntax": {
"command": "class-del",
"arguments": {
"name": "<name of the class>"
}
},
"resp-syntax": {
"result": 0,
"text": "Class '<class-name>' deleted."
},
"resp-comment": "The command will return a result of 3 (empty) if the client class doesn't exist. If the client class exists, the retured result is 0 if the deletion was successful and the result is 1 if the deletion is unsuccessful."
"cmd-syntax": "{
\"command\": \"class-del\",
\"arguments\": {
\"name\": <name of the class>
}
}",
"resp-syntax": "{
\"result\": 0,
\"text\": \"Class '<class-name>' deleted.\"
}",
"resp-comment": "The command will return a result of 3 (empty) if the client
class doesn't exist. If the client class exists, the retured
result is 0 if the deletion was successful and the result is 1
if the deletion is unsuccessful."
}

59
doc/sphinx/api/class-get.json
View File

@ -1,33 +1,40 @@
{
"name": "class-get",
"brief": "This command is used to return detailed information about an existing client class.",
"brief": "This command is used to return detailed information about an
existing client class.",
"description": "See <xref linkend=\"command-class-get\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.5.0",
"hook": "class_cmds",
"cmd-syntax": {
"command": "class-get",
"arguments": {
"name": "<name of the class>"
}
},
"resp-syntax": {
"result": 0,
"text": "Class '<class-name>' definition returned",
"arguments": {
"client-classes": [
{
"name": "<name of the class>",
"only-if-required": "<only if required boolean value>",
"test": "<test expression to be evaluated on incoming packets>",
"option-data": [ "<option values here>" ],
"option-def": [ "<option defintions here>" ],
"next-server": "<ipv4 address>",
"server-hostname": "<string>",
"boot-file-name": "<name of the boot file>"
}
]
}
},
"resp-comment": "The returned information depends on the DHCP server type, i.e. some parameters are specific to DHCPv4 server. Also, some parameters may not be returned if they are not set for the client class. If the class with specified name doesn't exist a result of 3 (empty) is returned. If the client class is found, the result of 0 is returned. If there is an error while processing the command, the result of 1 is returned."
"cmd-syntax": "{
\"command\": \"class-get\",
\"arguments\": {
\"name\": <name of the class>
}
}",
"resp-syntax": "{
\"result\": 0,
\"text\": \"Class '<class-name>' definition returned\",
\"arguments\": {
\"client-classes\": [
{
\"name\": <name of the class>,
\"only-if-required\": <only if required boolean value>,
\"test\": <test expression to be evaluated on incoming packets>,
\"option-data\": [ <option values here> ],
\"option-def\": [ <option defintions here> ],
\"next-server\": <ipv4 address>,
\"server-hostname\": <string>,
\"boot-file-name\": <name of the boot file>
}
]
}
}",
"resp-comment": "The returned information depends on the DHCP server type,
i.e. some parameters are specific to DHCPv4 server. Also,
some parameters may not be returned if they are not set for
the client class. If the class with specified name doesn't
exist a result of 3 (empty) is returned. If the client class
is found, the result of 0 is returned. If there is an error
while processing the command, the result of 1 is returned."
}

43
doc/sphinx/api/class-list.json
View File

@ -1,24 +1,35 @@
{
"name": "class-list",
"brief": "This command is used to retrieve a list of all client classes from the server configuration.",
"brief": "This command is used to retrieve a list of all client
classes from the server configuration.",
"description": "See <xref linkend=\"command-class-list\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.5.0",
"hook": "class_cmds",
"cmd-syntax": "{
\"command\": \"class-list\"
}",
"cmd-comment": "This command includes no arguments.",
"resp-syntax": {
"result": 0,
"text": "<number of> classes found",
"arguments": {
"client-classes": [
{
"name": "<first class name>"
},
{
"name": "<second class name>"
}
]
}
},
"resp-comment": "The returned list of classes merely contains their names. In order to retrieve full information about one of these classes use <xref linkend=\"command-class-get\"/>. The returned result is 3 (empty) if no classes are found. If the command is processed successfully and the list of client classes is not empty, the result of 0 is returned. If there is an error while processing the command, the result of 1 is returned."
"resp-syntax": "{
\"result\": 0,
\"text\": \"<number of> classes found\",
\"arguments\": {
\"client-classes\": [
{
\"name\": <first class name>
},
{
\"name\": <second class name>
}
]
}
}",
"resp-comment": "The returned list of classes merely contains their names.
In order to retrieve full information about one of these
classes use <xref linkend=\"command-class-get\"/>.
The returned result is 3 (empty) if no classes are found.
If the command is processed successfully and the list of
client classes is not empty, the result of 0 is returned.
If there is an error while processing the command, the
result of 1 is returned."
}

49
doc/sphinx/api/class-update.json
View File

@ -1,28 +1,35 @@
{
"name": "class-update",
"brief": "This command is used to update an existing client class in the server configuration.",
"brief": "This command is used to update an existing client class in
the server configuration.",
"description": "See <xref linkend=\"command-class-update\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.5.0",
"hook": "class_cmds",
"cmd-syntax": {
"command": "class-update",
"arguments": {
"client-classes": [ {
"name": "<name of the class>",
"test": "<test expression to be evaluated on incoming packets>",
"option-data": [ "<option values here>" ],
"option-def": [ "<option defintions here>" ],
"next-server": "<ipv4 address>",
"server-hostname": "<string>",
"boot-file-name": "<name of the boot file>"
} ]
}
},
"cmd-comment": "The <command>next-server</command>, <command>server-hostname</command> and <command>boot-file-name</command> are DHCPv4 specific. Only one client class can be updated with a single command. ",
"resp-syntax": {
"result": 0,
"text": "Class '<class-name>' updated."
},
"resp-comment": "The command will return the result of 3 (empty) if the client class doesn't exist. If the client class exists, the retured result is 0 if the update was successful and the result is 1 if the update is unsuccessful."
"cmd-syntax": "{
\"command\": \"class-update\",
\"arguments\": {
\"client-classes\": [ {
\"name\": <name of the class>,
\"test\": <test expression to be evaluated on incoming packets>,
\"option-data\": [ <option values here> ],
\"option-def\": [ <option defintions here> ],
\"next-server\": <ipv4 address>,
\"server-hostname\": <string>,
\"boot-file-name\": <name of the boot file>
} ]
}
}",
"cmd-comment": "The <command>next-server</command>,
<command>server-hostname</command> and
<command>boot-file-name</command> are DHCPv4 specific. Only
one client class can be updated with a single command. ",
"resp-syntax": "{
\"result\": 0,
\"text\": \"Class '<class-name>' updated.\",
}",
"resp-comment": "The command will return the result of 3 (empty) if the client
class doesn't exist. If the client class exists, the retured
result is 0 if the update was successful and the result is 1
if the update is unsuccessful."
}

16
doc/sphinx/api/config-get.json
View File

@ -1,12 +1,20 @@
{
"name": "config-get",
"brief": "Retrieves the current configuration used by the server. The configuration is roughtly equal to the configuration file, but includes additional changes made by other commands and due to parameters inheritance.",
"brief": "Retrieves the current configuration used by the server. The configuration
is roughtly equal to the configuration file, but includes additional
changes made by other commands and due to parameters inheritance.",
"support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.2.0",
"cmd-syntax": "{
\"command\": \"config-get\"
}",
"cmd-comment": "This command takes no parameters.",
"resp-syntax": {
"result": "<integer>",
"arguments": "<JSON configuration here, starting with Dhcp4, Dhcp6, or Control-agent object>"
"resp-syntax": "{
\"result\": <integer>,
\"arguments\": {
<JSON configuration here, starting with Dhcp4, Dhcp6, or Control-agent object>
}
}"
}

5
doc/sphinx/api/config-reload.json
View File

@ -3,5 +3,8 @@
"brief": "The config-reload command instructs Kea to load again the configuration file that was used previously.",
"description": "See <xref linkend=\"command-config-reload\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.2.0"
"avail": "1.2.0",
"cmd-syntax": "{
\"command\": \"config-reload\"
}"
}

24
doc/sphinx/api/config-set.json
View File

@ -4,17 +4,17 @@
"description": "See <xref linkend=\"command-config-set\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.2.0",
"cmd-syntax": {
"command": "config-set",
"arguments": {
"<server>": {
}
"cmd-syntax": "{
\"command\": \"config-set\",
\"arguments\": {
\"<server>\": {
}
},
"cmd-comment": "where <server> is the configuration element name for a given server such as 'Dhcp4' or 'Dhcp6'",
"resp-syntax": [{
"result": 0, "text": "Configuration successful."
}, {
"result": 1, "text": "unsupported parameter: BOGUS (<string>:16:26)"
}]
}
}",
"cmd-comment": "where &lt;server&gt; is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\"",
"resp-syntax": " {\"result\": 0, \"text\": \"Configuration successful.\" }
or
{\"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }"
}

24
doc/sphinx/api/config-test.json
View File

@ -4,17 +4,17 @@
"description": "See <xref linkend=\"command-config-test\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.2.0",
"cmd-syntax": {
"command": "config-test",
"arguments": {
"<server>": {
}
"cmd-syntax": "{
\"command\": \"config-test\",
\"arguments\": {
\"<server>\": {
}
},
"cmd-comment": "where <server> is the configuration element name for a given server such as 'Dhcp4' or 'Dhcp6'",
"resp-syntax": [{
"result": 0, "text": "Configuration seems sane..."
}, {
"result": 1, "text": "unsupported parameter: BOGUS (<string>:16:26)"
}]
}
}",
"cmd-comment": "where &gt;server&lt; is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\"",
"resp-syntax": "{\"result\": 0, \"text\": \"Configuration seems sane...\" }
or
{\"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }"
}

13
doc/sphinx/api/config-write.json
View File

@ -1,13 +1,14 @@
{
"name": "config-write",
"brief": "The config-write command instructs the Kea server to write its current configuration to a file on disk.",
"brief": "The config-write command instructs the Kea server to write its
current configuration to a file on disk.",
"description": "See <xref linkend=\"command-config-write\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.2.0",
"cmd-syntax": {
"command": "config-write",
"arguments": {
"filename": "config-modified-2017-03-15.json"
}
"cmd-syntax": "{
\"command\": \"config-write\",
\"arguments\": {
\"filename\": \"config-modified-2017-03-15.json\"
}
}"
}

10
doc/sphinx/api/dhcp-disable.json
View File

@ -4,10 +4,10 @@
"description": "See <xref linkend=\"command-dhcp-disable\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.4.0",
"cmd-syntax": {
"command": "dhcp-disable",
"arguments": {
"max-period": 20
}
"cmd-syntax": "{
\"command\": \"dhcp-disable\",
\"arguments\": {
\"max-period\": 20
}
}"
}

5
doc/sphinx/api/dhcp-enable.json
View File

@ -3,5 +3,8 @@
"brief": "The dhcp-enable command globally enables the DHCP service.",
"description": "See <xref linkend=\"command-dhcp-enable\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.4.0"
"avail": "1.4.0",
"cmd-syntax": "{
\"command\": \"dhcp-enable\"
}"
}

6
doc/sphinx/api/ha-heartbeat.json
View File

@ -1,9 +1,13 @@
{
"name": "ha-heartbeat",
"brief": "This command is sent internally by Kea partner when operating in High Availability (HA) mode. It will retrieve the server HA state and clock value.",
"brief": "This command is sent internally by Kea partner when operating
in High Availability (HA) mode. It will retrieve the server HA state and clock value.",
"description": "See <xref linkend=\"ha-server-states\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.4.0",
"hook": "high_availability",
"cmd-syntax": "{
\"command\": \"ha-heartbeat\",
}",
"resp-comment": "The response to this command is different from the typical command response. The response will include server state (see <xref linkend=\"ha-server-states\"/> plus the current clock value."
}

13
doc/sphinx/api/ha-scopes.json
View File

@ -5,12 +5,11 @@
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.4.0",
"hook": "high_availability",
"cmd-syntax": {
"command": "ha-scopes",
"service": [ "<service, typically 'dhcp4' or 'dhcp6'>" ],
"arguments": {
"scopes": [ "HA_server1", "HA_server2" ]
}
},
"cmd-syntax": "{
\"command\": \"ha-scopes\",
\"service\": [ <service, typically \"dhcp4\" or \"dhcp6\"> ],
\"arguments\": {
\"scopes\": [ \"HA_server1\", \"HA_server2\" ]
}",
"cmd-comment": "In the example given, the arguments configure the server to handle traffic from both HA_server1 and HA_server2 scopes."
}

17
doc/sphinx/api/ha-sync.json
View File

@ -1,16 +1,17 @@
{
"name": "ha-sync",
"brief": "The command is issued to instruct the server running in HA mode to synchronize its local lease database with the selected peer.",
"brief": "The command is issued to instruct the server running in HA mode to
synchronize its local lease database with the selected peer.",
"description": "See <xref linkend=\"command-ha-sync\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.4.0",
"hook": "high_availability",
"cmd-syntax": {
"command": "ha-sync",
"service": [ "<service affected: 'dhcp4' or 'dhcp6'" ],
"arguments": {
"server-name": "<name of the partner server>",
"max-period": "<integer, in seconds>"
}
"cmd-syntax": "{
\"command\": \"ha-sync\",
\"service\": [ <service affected: \"dhcp4\" or \"dhcp6\" ],
\"arguments\": {
\"server-name\": <name of the partner server>,
\"max-period\": <integer, in seconds>
}
}"
}

14
doc/sphinx/api/lease4-add.json
View File

@ -5,12 +5,12 @@
"support": [ "kea-dhcp4"],
"avail": "1.3.0",
"hook": "lease_cmds",
"cmd-syntax": {
"command": "lease4-add",
"arguments": {
"ip-address": "192.0.2.202",
"hw-address": "1a:1b:1c:1d:1e:1f"
}
},
"cmd-syntax": "{
\"command\": \"lease4-add\",
\"arguments\": {
\"ip-address\": \"192.0.2.202\",
\"hw-address\": \"1a:1b:1c:1d:1e:1f\"
}
}",
"cmd-comment": "Note that Kea 1.4 requires an additional argument, subnet-ID, which is optional as of Kea 1.5. A number of other more detailed optional arguments are also supported."
}

14
doc/sphinx/api/lease4-del.json
View File

@ -5,11 +5,11 @@
"support": [ "kea-dhcp4"],
"avail": "1.3.0",
"hook": "lease_cmds",
"cmd-syntax": {
"command": "lease4-del",
"arguments": {
"ip-address": "192.0.2.202"
}
},
"cmd-syntax": "{
\"command\": \"lease4-del\",
\"arguments\": {
\"ip-address\": \"192.0.2.202\"
}
}",
"cmd-comment": "Specify the lease to be deleted either by IP address, or by identifier-type and identifier value. Currently supported identifiers are \"hw-address\" and \"client-id\"."
}
}

8
doc/sphinx/api/lease4-get-all.json
View File

@ -5,9 +5,9 @@
"support": [ "kea-dhcp4"],
"avail": "1.4.0",
"hook": "lease_cmds",
"cmd-syntax": {
"command": "lease4-get-all",
"arguments": "subnets"
},
"cmd-syntax": "{
\"command\": \"lease4-get-all\"
\"arguments\": \"subnets\"
}",
"cmd-comment": "The lease4-get-all command may result in very large responses."
}

44
doc/sphinx/api/lease4-get.json
View File

@ -5,27 +5,27 @@
"support": [ "kea-dhcp4"],
"avail": "1.3.0",
"hook": "lease_cmds",
"cmd-syntax": {
"command": "lease4-get",
"arguments": {
"ip-address": "192.0.2.1"
}
},
"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."
},
"cmd-syntax": "{
\"command\": \"lease4-get\",
\"arguments\": {
\"ip-address\": \"192.0.2.1\"
}
}",
"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.\"
}",
"resp-comment": "lease4-get returns a result that indicates a result of the operation and lease details, if found. It has one of the following values: 0 (success), 1 (error) or 2 (empty)."
}

20
doc/sphinx/api/lease4-update.json
View File

@ -5,14 +5,14 @@
"support": [ "kea-dhcp4"],
"avail": "1.3.0",
"hook": "lease_cmds",
"cmd-syntax": {
"command": "lease4-update",
"arguments": {
"ip-address": "192.0.2.1",
"hostname": "newhostname.example.org",
"hw-address": "1a:1b:1c:1d:1e:1f",
"subnet-id": 44,
"force-create": true
}
}
"cmd-syntax": "{
\"command\": \"lease4-update\",
\"arguments\": {
\"ip-address\": \"192.0.2.1\",
\"hostname\": \"newhostname.example.org\",
\"hw-address\": \"1a:1b:1c:1d:1e:1f\",
\"subnet-id\": 44,
\"force-create\": true
}
}"
}

12
doc/sphinx/api/lease4-wipe.json
View File

@ -5,10 +5,10 @@
"support": [ "kea-dhcp4"],
"avail": "1.3.0",
"hook": "lease_cmds",
"cmd-syntax": {
"command": "lease4-wipe",
"arguments": {
"subnet-id": 44
}
}
"cmd-syntax": "{
\"command\": \"lease4-wipe\",
\"arguments\": {
\"subnet-id\": 44
}
}"
}

25
doc/sphinx/api/lease6-add.json
View File

@ -5,19 +5,16 @@
"support": [ "kea-dhcp6" ],
"avail": "1.3.0",
"hook": "lease_cmds",
"cmd-syntax": {
"command": "lease6-add",
"arguments": {
"subnet-id": 66,
"ip-address": "2001:db8::3",
"duid": "1a:1b:1c:1d:1e:1f:20:21:22:23:24",
"iaid": 1234
}
},
"cmd-syntax": "{
\"command\": \"lease6-add\",
\"arguments\": {
\"subnet-id\": 66,
\"ip-address\": \"2001:db8::3\",
\"duid\": \"1a:1b:1c:1d:1e:1f:20:21:22:23:24\",
\"iaid\": 1234
}
}",
"cmd-comment": "lease6-add can be also used to add leases for IPv6 prefixes..",
"resp-syntax": [{
"result": 0, "text": "Lease added."
}, {
"result": 1, "text": "missing parameter 'ip-address' (<string>:3:19)"
}]
"resp-syntax": "{ \"result\": 0, \"text\": \"Lease added.\" }
{ \"result\": 1, \"text\": \"missing parameter 'ip-address' (<string>:3:19)\" }"
}

72
doc/sphinx/api/lease6-bulk-apply.json
View File

@ -4,55 +4,61 @@
"support": [ "kea-dhcp6" ],
"avail": "1.6.0",
"hook": "lease_cmds",
"cmd-syntax": {
"command": "lease6-bulk-apply",
"arguments": {
"deleted-leases": [
"cmd-syntax": "{
\"command\": \"lease6-bulk-apply\",
\"arguments\": {
\"deleted-leases\": [
{
"ip-address": "2001:db8:abcd::",
"type": "IA_PD"
\"ip-address\": \"2001:db8:abcd::\",
\"type\": \"IA_PD\",
...
},
{
"ip-address": "2001:db8:abcd::234",
"type": "IA_NA"
\"ip-address\": \"2001:db8:abcd::234\",
\"type\": \"IA_NA\",
...
}
],
"leases": [
\"leases\": [
{
"subnet-id": 66,
"ip-address": "2001:db8:cafe::",
"type": "IA_PD"
\"subnet-id\": 66,
\"ip-address\": \"2001:db8:cafe::\",
\"type\": \"IA_PD\",
...
},
{
"subnet-id": 66,
"ip-address": "2001:db8:abcd::333",
"type": "IA_NA"
\"subnet-id\": 66,
\"ip-address\": \"2001:db8:abcd::333\",
\"type\": \"IA_NA\",
...
}
]
}
},
"cmd-comment": "If any of the leases is malformed, all changes are rolled back. If the leases are well formed but the operation fails for one or more leases, the these leases are listed in the response but the changes are preserved for all leases for which the operation was successful. The 'deleted-leases' and 'leases' are optional parameters but one of them must be specified.",
"resp-syntax": {
"result": 0,
"text": "IPv6 leases bulk apply completed.",
"arguments": {
"failed-deleted-leases": [
}",
"cmd-comment": "If any of the leases is malformed, all changes are rolled back. If the leases are well formed but the operation fails for one or more leases, the these leases are listed in the response but the changes are preserved for all leases for which the operation was successful. The \"deleted-leases\" and \"leases\" are optional parameters but one of them must be specified.",
"resp-syntax": " {
{
\"result\": 0,
\"text\": IPv6 leases bulk apply completed.
\"arguments\": {
\"failed-deleted-leases\": [
{
"ip-address": "2001:db8:abcd::",
"type": "IA_PD",
"result": "<control result>",
"error-message": "<error message>"
\"ip-address\": \"2001:db8:abcd::\",
\"type\": \"IA_PD\",
\"result\": <control result>,
\"error-message\": <error message>
}
],
"failed-leases": [
\"failed-leases\": [
{
"ip-address": "2001:db8:cafe::",
"type": "IA_PD",
"result": "<control result>",
"error-message": "<error message>"
\"ip-address\": \"2001:db8:cafe::\",
\"type\": \"IA_PD\",
\"result\" <control result>,
\"error-message\": <error message>
}
]
}
},
"resp-comment": "The 'failed-deleted-leases' holds the list of leases which failed to delete. This includes leases which were not found in the database. The 'failed-leases' includes the list of leases which failed to create or update. For each lease for which there was an error while processing the lease, inserting it into the database etc. the result is set to 1. For each lease which was not deleted because the server didn't find it in the database the result of 3 is returned."
}
}",
"resp-comment": "The \"failed-deleted-leases\" holds the list of leases which failed to delete. This includes leases which were not found in the database. The \"failed-leases\" includes the list of leases which failed to create or update. For each lease for which there was an error while processing the lease, inserting it into the database etc. the result is set to 1. For each lease which was not deleted because the server didn't find it in the database the result of 3 is returned."
}

12
doc/sphinx/api/lease6-del.json
View File

@ -5,11 +5,11 @@
"support": [ "kea-dhcp6" ],
"avail": "1.3.0",
"hook": "lease_cmds",
"cmd-syntax": {
"command": "lease6-del",
"arguments": {
"ip-address": "192.0.2.202"
}
},
"cmd-syntax": "{
\"command\": \"lease6-del\",
\"arguments\": {
\"ip-address\": \"192.0.2.202\"
}
}",
"cmd-comment": "lease6-del returns a result that indicates a outcome of the operation. It has one of the following values: 0 (success), 1 (error) or 3 (empty)."
}

88
doc/sphinx/api/lease6-get-all.json
View File

@ -5,49 +5,49 @@
"support": [ "kea-dhcp6" ],
"avail": "1.3.0",
"hook": "lease_cmds",
"cmd-syntax": {
"command": "lease6-get-all",
"arguments": {
"subnets": [ 1, 2, 3, 4 ]
}
},
"resp-syntax": {
"arguments": {
"leases": [
{
"cltt": 12345678,
"duid": "42:42:42:42:42:42:42:42",
"fqdn-fwd": false,
"fqdn-rev": true,
"hostname": "myhost.example.com.",
"hw-address": "08:08:08:08:08:08",
"iaid": 1,
"ip-address": "2001:db8:2::1",
"preferred-lft": 500,
"state": 0,
"subnet-id": 44,
"type": "IA_NA",
"valid-lft": 3600
},
{
"cltt": 12345678,
"duid": "21:21:21:21:21:21:21:21",
"fqdn-fwd": false,
"fqdn-rev": true,
"hostname": "",
"iaid": 1,
"ip-address": "2001:db8:0:0:2::",
"preferred-lft": 500,
"prefix-len": 80,
"state": 0,
"subnet-id": 44,
"type": "IA_PD",
"valid-lft": 3600
}
]
},
"result": 0,
"text": "2 IPv6 lease(s) found."
"cmd-syntax": "{
\"command\": \"lease6-get-all\",
\"arguments\": {
\"subnets\": [ 1, 2, 3, 4 ]
}
}",
"resp-syntax": "{
\"arguments\": {
\"leases\": [
{
\"cltt\": 12345678,
\"duid\": \"42:42:42:42:42:42:42:42\",
\"fqdn-fwd\": false,
\"fqdn-rev\": true,
\"hostname\": \"myhost.example.com.\",
\"hw-address\": \"08:08:08:08:08:08\",
\"iaid\": 1,
\"ip-address\": \"2001:db8:2::1\",
\"preferred-lft\": 500,
\"state\": 0,
\"subnet-id\": 44,
\"type\": \"IA_NA\",
\"valid-lft\": 3600
},
{
\"cltt\": 12345678,
\"duid\": \"21:21:21:21:21:21:21:21\",
\"fqdn-fwd\": false,
\"fqdn-rev\": true,
\"hostname\": \"\",
\"iaid\": 1,
\"ip-address\": \"2001:db8:0:0:2::\",
\"preferred-lft\": 500,
\"prefix-len\": 80,
\"state\": 0,
\"subnet-id\": 44,
\"type\": \"IA_PD\",
\"valid-lft\": 3600
}
]
},
\"result\": 0,
\"text\": \"2 IPv6 lease(s) found.\"
}",
"resp-comment": "The lease6-get-all command may result in very large responses."
}
}

16
doc/sphinx/api/lease6-get.json
View File

@ -5,12 +5,12 @@
"support": [ "kea-dhcp6" ],
"avail": "1.3.0",
"hook": "lease_cmds",
"cmd-syntax": {
"command": "lease6-get",
"arguments": {
"ip-address": "2001:db8:1234:ab::",
"type": "IA_PD"
}
},
"cmd-syntax": "{
\"command\": \"lease6-get\",
\"arguments\": {
\"ip-address\": \"2001:db8:1234:ab::\",
\"type\": \"IA_PD\"
}
}",
"cmd-comment": "lease6-get returns a result that indicates a result of the operation and lease details, if found. It has one of the following values: 0 (success), 1 (error) or 2 (empty)."
}
}

23
doc/sphinx/api/lease6-update.json
View File

@ -5,15 +5,16 @@
"support": [ "kea-dhcp6" ],
"avail": "1.3.0",
"hook": "lease_cmds",
"cmd-syntax": {
"command": "lease6-update",
"arguments": {
"ip-address": "2001:db8::1",
"duid": "88:88:88:88:88:88:88:88",
"iaid": 7654321,
"hostname": "newhostname.example.org",
"subnet-id": 66,
"force-create": false
}
}
"cmd-syntax": "{
\"command\": \"lease6-update\",
\"arguments\": {
\"ip-address\": \"2001:db8::1\",
\"duid\": \"88:88:88:88:88:88:88:88\",
\"iaid\": 7654321,
\"hostname\": \"newhostname.example.org\",
\"subnet-id\": 66,
\"force-create\": false
}
}
"
}

12
doc/sphinx/api/lease6-wipe.json
View File

@ -5,11 +5,11 @@
"support": [ "kea-dhcp6" ],
"avail": "1.3.0",
"hook": "lease_cmds",
"cmd-syntax": {
"command": "lease6-wipe",
"arguments": {
"subnet-id": 66
}
},
"cmd-syntax": "{
\"command\": \"lease6-wipe\",
\"arguments\": {
\"subnet-id\": 66
}
}",
"cmd-comment": "Note: not all backends support this command."
}

10
doc/sphinx/api/leases-reclaim.json
View File

@ -4,10 +4,10 @@
"description": "See <xref linkend=\"command-leases-reclaim\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.0.0",
"cmd-syntax": {
"command": "leases-reclaim",
"arguments": {
"remove": true
}
"cmd-syntax": "{
\"command\": \"leases-reclaim\",
\"arguments\": {
\"remove\": true
}
}"
}

8
doc/sphinx/api/libreload.json
View File

@ -4,9 +4,9 @@
"description": "See <xref linkend=\"command-libreload\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.2.0",
"cmd-syntax": {
"command": "libreload",
"arguments": { }
},
"cmd-syntax": "{
\"command\": \"libreload\",
\"arguments\": { }
}",
"cmd-comment": "The server will respond with a result of 0 indicating success, or 1 indicating a failure."
}

8
doc/sphinx/api/list-commands.json
View File

@ -4,9 +4,9 @@
"description": "See <xref linkend=\"command-list-commands\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.0.0",
"cmd-syntax": {
"command": "list-commands",
"arguments": { }
},
"cmd-syntax": "{
\"command\": \"list-commands\",
\"arguments\": { }
}",
"cmd-comment": "The server will respond with a list of all supported commands."
}

68
doc/sphinx/api/network4-add.json
View File

@ -5,42 +5,42 @@
"support": [ "kea-dhcp4"],
"avail": "1.3.0",
"hook": "subnet_cmds",
"cmd-syntax": {
"command": "network4-add",
"arguments": {
"shared-networks": [ {
"name": "floor13",
"subnet4": [
"cmd-syntax": "{
\"command\": \"network4-add\",
\"arguments\": {
\"shared-networks\": [ {
\"name\": \"floor13\",
\"subnet4\": [
{
\"id\": 100,
\"pools\": [ { \"pool\": \"192.0.2.2-192.0.2.99\" } ],
\"subnet\": \"192.0.2.0/24\",
\"option-data\": [
{
"id": 100,
"pools": [ { "pool": "192.0.2.2-192.0.2.99" } ],
"subnet": "192.0.2.0/24",
"option-data": [
{
"name": "routers",
"data": "192.0.2.1"
}
]
},
\"name\": \"routers\",
\"data\": \"192.0.2.1\"
}
]
},
{
\"id\": 101,
\"pools\": [ { \"pool\": \"192.0.3.2-192.0.3.99\" } ],
\"subnet\": \"192.0.3.0/24\",
\"option-data\": [
{
"id": 101,
"pools": [ { "pool": "192.0.3.2-192.0.3.99" } ],
"subnet": "192.0.3.0/24",
"option-data": [
{
"name": "routers",
"data": "192.0.3.1"
}
]
} ]
\"name\": \"routers\",
\"data\": \"192.0.3.1\"
}
]
} ]
}
},
"resp-syntax": {
"arguments": {
"shared-networks": [ { "name": "floor13" } ]
},
"result": 0,
"text": "A new IPv4 shared network 'floor13' added"
} ]
}
}",
"resp-syntax": "{
\"arguments\": {
\"shared-networks\": [ { \"name\": \"floor13\" } ]
},
\"result\": 0,
\"text\": \"A new IPv4 shared network 'floor13' added\"
}"
}

32
doc/sphinx/api/network4-del.json
View File

@ -5,21 +5,21 @@
"support": [ "kea-dhcp4"],
"avail": "1.3.0",
"hook": "subnet_cmds",
"cmd-syntax": {
"command": "network4-del",
"arguments": {
"name": "floor13"
}
},
"resp-syntax": {
"arguments": {
"shared-networks": [
{
"name": "floor13"
}
]
},
"result": 0,
"text": "IPv4 shared network 'floor13' deleted"
"cmd-syntax": "{
\"command\": \"network4-del\",
\"arguments\": {
\"name\": \"floor13\"
}
}",
"resp-syntax": "{
\"arguments\": {
\"shared-networks\": [
{
\"name\": \"floor13\"
}
]
},
\"result\": 0,
\"text\": \"IPv4 shared network 'floor13' deleted\"
}"
}

68
doc/sphinx/api/network4-get.json
View File

@ -5,41 +5,43 @@
"support": [ "kea-dhcp4"],
"avail": "1.3.0",
"hook": "subnet_cmds",
"cmd-syntax": {
"command": "network4-get",
"arguments": {
"name": "floor13"
}
},
"resp-syntax": {
"result": 0,
"text": "Info about IPv4 shared network 'floor13' returned",
"arguments": {
"shared-networks": [
"cmd-syntax": "{
\"command\": \"network4-get\",
\"arguments\": {
\"name\": \"floor13\"
}
}",
"resp-syntax": "{
\"result\": 0,
\"text\": \"Info about IPv4 shared network 'floor13' returned\",
\"arguments\": {
\"shared-networks\": [
{
\"match-client-id\": true,
\"name\": \"floor13\",
\"option-data\": [ ],
\"rebind-timer\": 90,
\"relay\": {
\"ip-address\": \"0.0.0.0\"
},
\"renew-timer\": 60,
\"reservation-mode\": \"all\",
\"subnet4\": [
{
"match-client-id": true,
"name": "floor13",
"option-data": [ ],
"rebind-timer": 90,
"relay": {
"ip-address": "0.0.0.0"
},
"renew-timer": 60,
"reservation-mode": "all",
"subnet4": [
{
"subnet": "192.0.2.0/24",
"id": 5
},
{
"id": 6,
"subnet": "192.0.3.0/31"
}
],
"valid-lifetime": 120
\"subnet\": \"192.0.2.0/24\",
\"id\": 5,
// many other subnet specific details here
},
{
\"id\": 6,
\"subnet\": \"192.0.3.0/31\",
// many other subnet specific details here
}
]
],
\"valid-lifetime\": 120
}
},
]
}
}",
"resp-comment": "Note that the actual response contains many additional fields that are omitted here for clarity."
}

23
doc/sphinx/api/network4-list.json
View File

@ -5,14 +5,17 @@
"support": [ "kea-dhcp4"],
"avail": "1.3.0",
"hook": "subnet_cmds",
"resp-syntax": {
"arguments": {
"shared-networks": [
{ "name": "floor1" },
{ "name": "office" }
]
},
"result": 0,
"text": "2 IPv4 network(s) found"
}
"cmd-syntax": "{
\"command\": \"network4-list\"
}",
"resp-syntax": "{
\"arguments\": {
\"shared-networks\": [
{ \"name\": \"floor1\" },
{ \"name\": \"office\" }
]
},
\"result\": 0,
\"text\": \"2 IPv4 network(s) found\"
}"
}

20
doc/sphinx/api/network4-subnet-add.json
View File

@ -5,15 +5,15 @@
"support": [ "kea-dhcp4"],
"avail": "1.3.0",
"hook": "subnet_cmds",
"cmd-syntax": {
"command": "network4-subnet-add",
"arguments": {
"name": "floor13",
"id": 5
}
},
"resp-syntax": {
"result": 0,
"text": "IPv4 subnet 10.0.0.0/8 (id 5) is now part of shared network 'floor1'"
"cmd-syntax": "{
\"command\": \"network4-subnet-add\",
\"arguments\": {
\"name\": \"floor13\",
\"id\": 5
}
}",
"resp-syntax": "{
\"result\": 0,
\"text\": \"IPv4 subnet 10.0.0.0/8 (id 5) is now part of shared network 'floor1'\"
}"
}

20
doc/sphinx/api/network4-subnet-del.json
View File

@ -5,15 +5,15 @@
"support": [ "kea-dhcp4"],
"avail": "1.3.0",
"hook": "subnet_cmds",
"cmd-syntax": {
"command": "network4-subnet-del",
"arguments": {
"name": "floor13",
"id": 5
}
},
"resp-syntax": {
"result": 0,
"text": "IPv4 subnet 10.0.0.0/8 (id 5) is now removed from shared network 'floor13'"
"cmd-syntax": "{
\"command\": \"network4-subnet-del\",
\"arguments\": {
\"name\": \"floor13\",
\"id\": 5
}
}",
"resp-syntax": "{
\"result\": 0,
\"text\": \"IPv4 subnet 10.0.0.0/8 (id 5) is now removed from shared network 'floor13'\"
}"
}

72
doc/sphinx/api/network6-add.json
View File

@ -1,47 +1,47 @@
{
"name": "network6-add",
"name": "network6-add",
"brief": "The network6-add command is used to add a new shared network.",
"description": "See <xref linkend=\"idp75\"/>",
"support": [ "kea-dhcp6" ],
"avail": "1.3.0",
"hook": "subnet_cmds",
"cmd-syntax": {
"command": "network4-add",
"arguments": {
"shared-networks": [ {
"name": "floor13",
"subnet4": [
"cmd-syntax": "{
\"command\": \"network4-add\",
\"arguments\": {
\"shared-networks\": [ {
\"name\": \"floor13\",
\"subnet4\": [
{
\"id\": 100,
\"pools\": [ { \"pool\": \"192.0.2.2-192.0.2.99\" } ],
\"subnet\": \"192.0.2.0/24\",
\"option-data\": [
{
"id": 100,
"pools": [ { "pool": "192.0.2.2-192.0.2.99" } ],
"subnet": "192.0.2.0/24",
"option-data": [
{
"name": "routers",
"data": "192.0.2.1"
}
]
},
\"name\": \"routers\",
\"data\": \"192.0.2.1\"
}
]
},
{
\"id\": 101,
\"pools\": [ { \"pool\": \"192.0.3.2-192.0.3.99\" } ],
\"subnet\": \"192.0.3.0/24\",
\"option-data\": [
{
"id": 101,
"pools": [ { "pool": "192.0.3.2-192.0.3.99" } ],
"subnet": "192.0.3.0/24",
"option-data": [
{
"name": "routers",
"data": "192.0.3.1"
}
]
} ]
\"name\": \"routers\",
\"data\": \"192.0.3.1\"
}
]
} ]
}
},
"cmd-comment": "The network6-add uses the same syntax for both the query and the response. However, there are some parameters that are IPv4-only (e.g. match-client-id) and some are IPv6-only (e.g. interface-id).",
"resp-syntax": {
"arguments": {
"shared-networks": [ { "name": "floor13" } ]
},
"result": 0,
"text": "A new IPv4 shared network 'floor13' added"
} ]
}
}",
"cmd-comment": "The network6-add uses the same syntax for both the query and the response. However, there are some parameters that are IPv4-only (e.g. match-client-id) and some are IPv6-only (e.g. interface-id).",
"resp-syntax": "{
\"arguments\": {
\"shared-networks\": [ { \"name\": \"floor13\" } ]
},
\"result\": 0,
\"text\": \"A new IPv4 shared network 'floor13' added\"
}"
}

27
doc/sphinx/api/network6-del.json
View File

@ -5,18 +5,19 @@
"support": [ "kea-dhcp6" ],
"avail": "1.3.0",
"hook": "subnet_cmds",
"cmd-syntax": {
"command": "network4-del",
"arguments": {
"name": "floor13"
}
},
"cmd-comment": "The network6-del command uses exactly the same syntax for both the command and the response.",
"resp-syntax": {
"command": "network4-del",
"arguments": {
"name": "floor13",
"subnets-action": "delete"
}
"cmd-syntax": "{
\"command\": \"network4-del\",
\"arguments\": {
\"name\": \"floor13\"
}
}",
"cmd-comment": "The network6-del command uses exactly the same syntax for
both the command and the response.",
"resp-syntax": "{
\"command\": \"network4-del\",
\"arguments\": {
\"name\": \"floor13\",
\"subnets-action\": \"delete\"
}
}"
}

68
doc/sphinx/api/network6-get.json
View File

@ -5,41 +5,43 @@
"support": [ "kea-dhcp6" ],
"avail": "1.3.0",
"hook": "subnet_cmds",
"cmd-syntax": {
"command": "network4-get",
"arguments": {
"name": "floor13"
}
},
"resp-syntax": {
"result": 0,
"text": "Info about IPv4 shared network 'floor13' returned",
"arguments": {
"shared-networks": [
"cmd-syntax": "{
\"command\": \"network4-get\",
\"arguments\": {
\"name\": \"floor13\"
}
}",
"resp-syntax": "{
\"result\": 0,
\"text\": \"Info about IPv4 shared network 'floor13' returned\",
\"arguments\": {
\"shared-networks\": [
{
\"match-client-id\": true,
\"name\": \"floor13\",
\"option-data\": [ ],
\"rebind-timer\": 90,
\"relay\": {
\"ip-address\": \"0.0.0.0\"
},
\"renew-timer\": 60,
\"reservation-mode\": \"all\",
\"subnet4\": [
{
"match-client-id": true,
"name": "floor13",
"option-data": [ ],
"rebind-timer": 90,
"relay": {
"ip-address": "0.0.0.0"
},
"renew-timer": 60,
"reservation-mode": "all",
"subnet4": [
{
"subnet": "192.0.2.0/24",
"id": 5
},
{
"id": 6,
"subnet": "192.0.3.0/31"
}
],
"valid-lifetime": 120
\"subnet\": \"192.0.2.0/24\",
\"id\": 5,
// many other subnet specific details here
},
{
\"id\": 6,
\"subnet\": \"192.0.3.0/31\",
// many other subnet specific details here
}
]
],
\"valid-lifetime\": 120
}
},
]
}
}",
"resp-comment": "Note that the actual response contains many additional fields that are omitted here for clarity."
}

23
doc/sphinx/api/network6-list.json
View File

@ -5,15 +5,18 @@
"support": [ "kea-dhcp6" ],
"avail": "1.3.0",
"hook": "subnet_cmds",
"cmd-syntax": "{
\"command\": \"network4-list\"
}",
"cmd-comment": "network6-list follows exactly the same syntax for both the query and the response.",
"resp-syntax": {
"arguments": {
"shared-networks": [
{ "name": "floor1" },
{ "name": "office" }
]
},
"result": 0,
"text": "2 IPv4 network(s) found"
}
"resp-syntax": "{
\"arguments\": {
\"shared-networks\": [
{ \"name\": \"floor1\" },
{ \"name\": \"office\" }
]
},
\"result\": 0,
\"text\": \"2 IPv4 network(s) found\"
}"
}

22
doc/sphinx/api/network6-subnet-add.json
View File

@ -5,16 +5,16 @@
"support": [ "kea-dhcp6" ],
"avail": "1.3.0",
"hook": "subnet_cmds",
"cmd-syntax": {
"command": "network4-subnet-add",
"arguments": {
"name": "floor13",
"id": 5
}
},
"cmd-comment": "The network6-subnet-add command uses exactly the same syntax for both the command and the response.",
"resp-syntax": {
"result": 0,
"text": "IPv4 subnet 10.0.0.0/8 (id 5) is now part of shared network 'floor1'"
"cmd-syntax": "{
\"command\": \"network4-subnet-add\",
\"arguments\": {
\"name\": \"floor13\",
\"id\": 5
}
}",
"cmd-comment": "The network6-subnet-add command uses exactly the same syntax for both the command and the response.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"IPv4 subnet 10.0.0.0/8 (id 5) is now part of shared network 'floor1'\"
}"
}

22
doc/sphinx/api/network6-subnet-del.json
View File

@ -5,16 +5,16 @@
"support": [ "kea-dhcp6" ],
"avail": "1.3.0",
"hook": "subnet_cmds",
"cmd-syntax": {
"command": "network4-subnet-del",
"arguments": {
"name": "floor13",
"id": 5
}
},
"cmd-comment": "The network6-subnet-del command uses exactly the same syntax for both the command and the response.",
"resp-syntax": {
"result": 0,
"text": "IPv4 subnet 10.0.0.0/8 (id 5) is now removed from shared network 'floor13'"
"cmd-syntax": "{
\"command\": \"network4-subnet-del\",
\"arguments\": {
\"name\": \"floor13\",
\"id\": 5
}
}",
"cmd-comment": "The network6-subnet-del command uses exactly the same syntax for both the command and the response.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"IPv4 subnet 10.0.0.0/8 (id 5) is now removed from shared network 'floor13'\"
}"
}

70
doc/sphinx/api/reservation-add.json
View File

@ -1,34 +1,54 @@
{
"name": "reservation-add",
"brief": "adds a new host reservation. The reservation may include IPv4 address, IPv6 addresses, IPv6 prefixes, various identifiers, a class the client will be assigned to, DHCPv4 and DHCPv6 options and more.",
"brief": "adds a new host reservation. The reservation may include IPv4 address,
IPv6 addresses, IPv6 prefixes, various identifiers, a class
the client will be assigned to, DHCPv4 and DHCPv6 options and
more.",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"hook": "host_cmds",
"avail": "1.2.0",
"description": "See <xref linkend=\"cmd-reservation-add\"/>",
"cmd-syntax": {
"command": "reservation-add",
"arguments": {
"reservation": {
"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>"
}
"cmd-syntax": "{
\"command\": \"reservation-add\",
\"arguments\": {
\"reservation\": {
\"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>,
}
},
"cmd-comment": "Note the ip-address, client-id, next-server, server-hostname and boot-file-name are IPv4 specific. duid, ip-addresses and prefixes are IPv6 specific."
}
}",
"cmd-comment": "Note the ip-address, client-id, next-server, server-hostname and
boot-file-name are IPv4 specific. duid, ip-addresses and prefixes are
IPv6 specific.",
"resp-syntax": "
{
\"result\": <integer>,
\"text\": <string>
}",
"resp-comment": "Result is an integer representation of the status. Currently supported statuses are:
<itemizedlist>
<listitem><para>0 - success</para></listitem>
<listitem><para>1 - error</para></listitem>
<listitem><para>2 - unsupported</para></listitem>
<listitem><para>3 - empty (command was completed successfully, but no data was affected or returned)
</para></listitem>
</itemizedlist>"
}

18
doc/sphinx/api/reservation-del.json
View File

@ -5,14 +5,14 @@
"hook": "host_cmds",
"avail": "1.2.0",
"cmd-syntax": {
"command": "reservation-del",
"arguments": {
"subnet-id": "<integer>",
"ip-address": "<string>",
"identifier-type": "<one of 'hw-address', 'duid', 'circuit-id', 'client-id' and 'flex-id'>",
"identifier": "<string>"
}
},
"cmd-syntax": "{
\"command\": \"reservation-del\",
\"arguments\": {
\"subnet-id\": <integer>,
\"ip-address\": <string>,
\"identifier-type\": <one of \"hw-address\", \"duid\", \"circuit-id\", \"client-id\" and \"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)."
}

11
doc/sphinx/api/reservation-get-all.json
View File

@ -5,11 +5,10 @@
"hook": "host_cmds",
"avail": "1.6.0",
"cmd-syntax": {
"command": "reservation-get-all",
"arguments": {
"subnet-id": "<integer>"
}
},
"cmd-syntax": "{
\"command\": \"reservation-get-all\",
\"arguments\": {
\"subnet-id\": <integer>
}",
"resp-comment": "reservation-get-all command may result in very large responses."
}

18
doc/sphinx/api/reservation-get-page.json
View File

@ -5,14 +5,14 @@
"hook": "host_cmds",
"avail": "1.6.0",
"cmd-syntax": {
"command": "reservation-get-page",
"arguments": {
"subnet-id": "<integer>",
"limit": "<integer>",
"source-index": "<integer>",
"from": "<integer>"
}
},
"cmd-syntax": "{
\"command\": \"reservation-get-page\",
\"arguments\": {
\"subnet-id\": <integer>,
\"limit\": <integer>,
\"source-index\": <integer>,
\"from\": <integer>
}
}",
"cmd-comment": "the subnet id and the page size limit are mandatory. The source index and from host id are optional and default to 0. Values to use to next the next page are returned in responses in a next map."
}

65
doc/sphinx/api/reservation-get.json
View File

@ -5,40 +5,41 @@
"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-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-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."
"resp-comment": "Arguments object appear only if a host is found. Many fields in the arguments
object appear only if specific field is set."
}

6
doc/sphinx/api/shutdown.json
View File

@ -4,5 +4,9 @@
"description": "See <xref linkend=\"command-shutdown\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.0.0",
"cmd-comment": "The server will respond with a confirmation that the shutdown procedure has been initiated."
"cmd-syntax": "{
\"command\": \"shutdown\"
}",
"cmd-comment": "The server will respond with a confirmation that the shutdown
procedure has been initiated."
}

41
doc/sphinx/api/stat-lease4-get.json
View File

@ -1,28 +1,29 @@
{
"name": "stat-lease4-get",
"brief": "The stat-lease4-get command fetches lease statistics for a range of known IPv4 subnets.",
"brief": "The stat-lease4-get command fetches lease statistics for a range
of known IPv4 subnets.",
"description": "See <xref linkend=\"command-stat-lease4-get\"/>",
"support": [ "kea-dhcp4" ],
"avail": "1.4.0",
"hook": "stat_cmds",
"cmd-syntax": {
"command": "stat-lease4-get"
},
"resp-syntax": {
"result": 0,
"text": "stat-lease4-get: 2 rows found",
"arguments": {
"result-set": {
"columns": [ "subnet-id",
"total-addresses",
"assigned-addresses",
"declined-addresses" ],
"rows": [
[ 10, 256, 111, 0 ],
[ 20, 4098, 2034, 4 ]
],
"timestamp": "2018-05-04 15:03:37.000000"
}
}
"cmd-syntax": "{
\"command\": \"stat-lease4-get\"
}",
"resp-syntax": "{
\"result\": 0,
\"text\": \"stat-lease4-get: 2 rows found\",
\"arguments\": {
\"result-set\": {
\"columns\": [ \"subnet-id\",
\"total-addresses\",
\"assigned-addresses\",
\"declined-addresses\" ]
\"rows\": [
[ 10, 256, 111, 0 ],
[ 20, 4098, 2034, 4 ]
],
\"timestamp\": \"2018-05-04 15:03:37.000000\"
}
}
}"
}

43
doc/sphinx/api/stat-lease6-get.json
View File

@ -1,29 +1,30 @@
{
"name": "stat-lease6-get",
"brief": "The stat-lease6-get command fetches lease statistics for a range of known IPv6 subnets.",
"brief": "The stat-lease6-get command fetches lease statistics for a range
of known IPv6 subnets.",
"description": "See <xref linkend=\"command-stat-lease6-get\"/>",
"support": [ "kea-dhcp6" ],
"avail": "1.4.0",
"hook": "stat_cmds",
"cmd-syntax": {
"command": "stat-lease6-get",
"arguments": {
"subnet-id" : 10
}
},
"resp-syntax": {
"result": 0,
"text": "stat-lease6-get: 2 rows found",
"arguments": {
"result-set": {
"columns": [ "subnet-id", "total-nas", "assigned-nas", "declined-nas", "total-pds", "assigned-pds" ],
"rows": [
[ 10, 4096, 2400, 3, 0, 0],
[ 20, 0, 0, 0, 1048, 233 ],
[ 30, 256, 60, 0, 1048, 15 ]
],
"timestamp": "2018-05-04 15:03:37.000000"
}
}
"cmd-syntax": "{
\"command\": \"stat-lease6-get\",
\"arguments\": {
\"subnet-id\" : 10
}
}",
"resp-syntax": "{
\"result\": 0,
\"text\": \"stat-lease6-get: 2 rows found\",
\"arguments\": {
\"result-set\": {
\"columns\": [ \"subnet-id\", \"total-nas\", \"assigned-nas\", \"declined-nas\", \"total-pds\", \"assigned-pds\" ]
\"rows\": [
[ 10, 4096, 2400, 3, 0, 0],
[ 20, 0, 0, 0, 1048, 233 ]
[ 30, 256, 60, 0, 1048, 15 ]
],
\"timestamp\": \"2018-05-04 15:03:37.000000\"
}
}
}"
}

8
doc/sphinx/api/statistic-get-all.json
View File

@ -4,9 +4,9 @@
"description": "See <xref linkend=\"command-statistic-get-all\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.0.0",
"cmd-syntax": {
"command": "statistic-get-all",
"arguments": { }
},
"cmd-syntax": "{
\"command\": \"statistic-get-all\",
\"arguments\": { }
}",
"cmd-comment": "The server will respond with details of all recorded statistics, with result set to 0 indicating that it iterated over all statistics (even when the total number of statistics is zero)."
}

14
doc/sphinx/api/statistic-get.json
View File

@ -4,11 +4,11 @@
"description": "See <xref linkend=\"command-statistic-get\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.0.0",
"cmd-syntax": {
"command": "statistic-get",
"arguments": {
"name": "pkt4-received"
}
},
"cmd-comment": "The server will respond with details of the requested statistic, with a result set to 0 indicating success and the specified statistic as the value of the 'arguments' parameter."
"cmd-syntax": "{
\"command\": \"statistic-get\",
\"arguments\": {
\"name\": \"pkt4-received\"
}
}",
"cmd-comment": "The server will respond with details of the requested statistic, with a result set to 0 indicating success and the specified statistic as the value of the \"arguments\" parameter."
}

8
doc/sphinx/api/statistic-remove-all.json
View File

@ -4,9 +4,9 @@
"description": "See <xref linkend=\"command-statistic-remove-all\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.0.0",
"cmd-syntax": {
"command": "statistic-remove-all",
"arguments": { }
},
"cmd-syntax": "{
\"command\": \"statistic-remove-all\",
\"arguments\": { }
}",
"cmd-comment": "If the removal of all statistics was successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered, the server will return a status code of 1 (error) and the text field will contain the error description."
}

12
doc/sphinx/api/statistic-remove.json
View File

@ -4,11 +4,11 @@
"description": "See <xref linkend=\"command-statistic-remove\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.0.0",
"cmd-syntax": {
"command": "statistic-remove",
"arguments": {
"name": "pkt4-received"
}
},
"cmd-syntax": "{
\"command\": \"statistic-remove\",
\"arguments\": {
\"name\": \"pkt4-received\"
}
}",
"cmd-comment": "If the specific statistic is found and its removal was successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered (e.g. requested statistic was not found), the server will return a status code of 1 (error) and the text field will contain the error description."
}

8
doc/sphinx/api/statistic-reset-all.json
View File

@ -4,9 +4,9 @@
"description": "See <xref linkend=\"command-statistic-reset-all\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.0.0",
"cmd-syntax": {
"command": "statistic-reset-all",
"arguments": { }
},
"cmd-syntax": "{
\"command\": \"statistic-reset-all\",
\"arguments\": { }
}",
"cmd-comment": "If the operation is successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered, the server will return a status code of 1 (error) and the text field will contain the error description."
}

12
doc/sphinx/api/statistic-reset.json
View File

@ -4,11 +4,11 @@
"description": "See <xref linkend=\"command-statistic-reset\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.0.0",
"cmd-syntax": {
"command": "statistic-reset",
"arguments": {
"name": "pkt4-received"
}
},
"cmd-syntax": "{
\"command\": \"statistic-reset\",
\"arguments\": {
\"name\": \"pkt4-received\"
}
}",
"cmd-comment": "If the specific statistic is found and reset was successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered (e.g. requested statistic was not found), the server will return a status code of 1 (error) and the text field will contain the error description."
}

41
doc/sphinx/api/subnet4-add.json
View File

@ -5,25 +5,26 @@
"support": [ "kea-dhcp4"],
"avail": "1.3.0",
"hook": "subnet_cmds",
"cmd-syntax": {
"command": "subnet4-add",
"arguments": {
"subnets": [ {
"id": 123,
"subnet": "10.20.30.0/24"
} ]
}
},
"resp-syntax": {
"result": 0,
"text": "IPv4 subnet added",
"arguments": {
"subnets": [
{
"id": 123,
"subnet": "10.20.30.0/24"
}
]
}
"cmd-syntax": "{
\"command\": \"subnet4-add\",
\"arguments\": {
\"subnets\": [ {
\"id\": 123,
\"subnet\": \"10.20.30.0/24\",
...
} ]
}
}",
"resp-syntax": "{
\"result\": 0,
\"text\": \"IPv4 subnet added\",
\"arguments\": {
\"subnets\": [
{
\"id\": 123,
\"subnet\": \"10.20.30.0/24\"
}
]
}
}"
}

34
doc/sphinx/api/subnet4-del.json
View File

@ -5,22 +5,22 @@
"support": [ "kea-dhcp4"],
"avail": "1.3.0",
"hook": "subnet_cmds",
"cmd-syntax": {
"command": "subnet4-del",
"arguments": {
"id": 123
}
},
"resp-syntax": {
"result": 0,
"text": "IPv4 subnet 192.0.2.0/24 (id 123) deleted",
"arguments": {
"subnets": [
{
"id": 123,
"subnet": "192.0.2.0/24"
}
]
}
"cmd-syntax": "{
\"command\": \"subnet4-del\",
\"arguments\": {
\"id\": 123
}
}",
"resp-syntax": "{
\"result\": 0,
\"text\": \"IPv4 subnet 192.0.2.0/24 (id 123) deleted\",
\"arguments\": {
\"subnets\": [
{
\"id\": 123,
\"subnet\": \"192.0.2.0/24\"
}
]
}
}"
}

40
doc/sphinx/api/subnet4-get.json
View File

@ -5,24 +5,26 @@
"support": [ "kea-dhcp4" ],
"avail": "1.3.0",
"hook": "subnet_cmds",
"cmd-syntax": {
"command": "subnet4-get",
"arguments": {
"id": 10
}
},
"resp-syntax": {
"result": 0,
"text": "Info about IPv4 subnet 10.0.0.0/8 (id 10) returned",
"arguments": {
"subnets": [
{
"subnet": "10.0.0.0/8",
"id": 1,
"option-data": [
]
}
]
}
"cmd-syntax": "{
\"command\": \"subnet4-get\",
\"arguments\": {
\"id\": 10
}
}",
"resp-syntax": "{
\"result\": 0,
\"text\": \"Info about IPv4 subnet 10.0.0.0/8 (id 10) returned\",
\"arguments\": {
\"subnets\": [
{
\"subnet\": \"10.0.0.0/8\",
\"id\": 1,
\"option-data\": [
....
]
...
}
]
}
}"
}

37
doc/sphinx/api/subnet4-list.json
View File

@ -5,24 +5,23 @@
"support": [ "kea-dhcp4"],
"avail": "1.3.0",
"hook": "subnet_cmds",
"cmd-syntax": {
"command": "subnet4-list"
},
"resp-syntax": {
"result": 0,
"text": "2 IPv4 subnets found",
"arguments": {
"subnets": [
{
"id": 10,
"subnet": "10.0.0.0/8"
},
{
"id": 100,
"subnet": "192.0.2.0/24"
}
]
"cmd-syntax": "{
\"command\": \"subnet4-list\"
}",
"resp-syntax": "{
\"result\": 0,
\"text\": \"2 IPv4 subnets found\",
\"arguments\": {
\"subnets\": [
{
\"id\": 10,
\"subnet\": \"10.0.0.0/8\"
},
{
\"id\": 100,
\"subnet\": \"192.0.2.0/24\"
}
},
]
}",
"resp-comment": "If no IPv4 subnets are found, an error code is returned along with the error description."
}
}

41
doc/sphinx/api/subnet4-update.json
View File

@ -5,25 +5,26 @@
"support": [ "kea-dhcp4"],
"avail": "1.6.0",
"hook": "subnet_cmds",
"cmd-syntax": {
"command": "subnet4-update",
"arguments": {
"subnets": [ {
"id": 123,
"subnet": "10.20.30.0/24"
} ]
}
},
"resp-syntax": {
"result": 0,
"text": "IPv4 subnet updated",
"arguments": {
"subnets": [
{
"id": 123,
"subnet": "10.20.30.0/24"
}
]
}
"cmd-syntax": "{
\"command\": \"subnet4-update\",
\"arguments\": {
\"subnets\": [ {
\"id\": 123,
\"subnet\": \"10.20.30.0/24\",
...
} ]
}
}",
"resp-syntax": "{
\"result\": 0,
\"text\": \"IPv4 subnet updated\",
\"arguments\": {
\"subnets\": [
{
\"id\": 123,
\"subnet\": \"10.20.30.0/24\"
}
]
}
}"
}

41
doc/sphinx/api/subnet6-add.json
View File

@ -5,25 +5,26 @@
"support": [ "kea-dhcp6" ],
"avail": "1.3.0",
"hook": "subnet_cmds",
"cmd-syntax": {
"command": "subnet6-add",
"arguments": {
"subnet6": [ {
"id": 234,
"subnet": "2001:db8:1::/64"
} ]
}
},
"resp-syntax": {
"result": 0,
"text": "IPv6 subnet added",
"arguments": {
"subnet6": [
{
"id": 234,
"subnet": "2001:db8:1::/64"
}
]
}
"cmd-syntax": "{
\"command\": \"subnet6-add\",
\"arguments\": {
\"subnet6\": [ {
\"id\": 234,
\"subnet\": \"2001:db8:1::/64\",
...
} ]
}
}",
"resp-syntax": "{
\"result\": 0,
\"text\": \"IPv6 subnet added\",
\"arguments\": {
\"subnet6\": [
{
\"id\": 234,
\"subnet\": \"2001:db8:1::/64\"
}
]
}
}"
}

30
doc/sphinx/api/subnet6-del.json
View File

@ -5,20 +5,20 @@
"support": [ "kea-dhcp6" ],
"avail": "1.3.0",
"hook": "subnet_cmds",
"cmd-syntax": {
"command": "subnet6-del",
"arguments": {
"id": 234
}
},
"resp-syntax": {
"result": 0,
"text": "IPv6 subnet 2001:db8:1::/64 (id 234) deleted",
"subnets": [
{
"id": 234,
"subnet": "2001:db8:1::/64"
}
]
"cmd-syntax": "{
\"command\": \"subnet6-del\",
\"arguments\": {
\"id\": 234
}
}",
"resp-syntax": "{
\"result\": 0,
\"text\": \"IPv6 subnet 2001:db8:1::/64 (id 234) deleted\",
\"subnets\": [
{
\"id\": 234,
\"subnet\": \"2001:db8:1::/64\"
}
]
}"
}

40
doc/sphinx/api/subnet6-get.json
View File

@ -5,24 +5,26 @@
"support": [ "kea-dhcp6" ],
"avail": "1.3.0",
"hook": "subnet_cmds",
"cmd-syntax": {
"command": "subnet6-get",
"arguments": {
"id": 11
}
},
"resp-syntax": {
"result": 0,
"text": "Info about IPv6 subnet 2001:db8:1::/64 (id 11) returned",
"arguments": {
"subnets": [
{
"subnet": "2001:db8:1::/64",
"id": 1,
"option-data": [
]
}
]
}
"cmd-syntax": "{
\"command\": \"subnet6-get\",
\"arguments\": {
\"id\": 11
}
}",
"resp-syntax": "{
\"result\": 0,
\"text\": \"Info about IPv6 subnet 2001:db8:1::/64 (id 11) returned\",
\"arguments\": {
\"subnets\": [
{
\"subnet\": \"2001:db8:1::/64\",
\"id\": 1,
\"option-data\": [
...
]
....
}
]
}
}"
}

37
doc/sphinx/api/subnet6-list.json
View File

@ -5,24 +5,23 @@
"support": [ "kea-dhcp6" ],
"avail": "1.3.0",
"hook": "subnet_cmds",
"cmd-syntax": {
"command": "subnet6-list"
},
"resp-syntax": {
"result": 0,
"text": "2 IPv6 subnets found",
"arguments": {
"subnets": [
{
"id": 11,
"subnet": "2001:db8:1::/64"
},
{
"id": 233,
"subnet": "3000::/16"
}
]
"cmd-syntax": "{
\"command\": \"subnet6-list\"
}",
"resp-syntax": "{
\"result\": 0,
\"text\": \"2 IPv6 subnets found\",
\"arguments\": {
\"subnets\": [
{
\"id\": 11,
\"subnet\": \"2001:db8:1::/64\"
},
{
\"id\": 233,
\"subnet\": \"3000::/16\"
}
},
]
}",
"resp-comment": "If no IPv6 subnets are found, an error code is returned along with the error description."
}
}

41
doc/sphinx/api/subnet6-update.json
View File

@ -5,25 +5,26 @@
"support": [ "kea-dhcp6" ],
"avail": "1.6.0",
"hook": "subnet_cmds",
"cmd-syntax": {
"command": "subnet6-update",
"arguments": {
"subnet6": [ {
"id": 234,
"subnet": "2001:db8:1::/64"
} ]
}
},
"resp-syntax": {
"result": 0,
"text": "IPv6 subnet updated",
"arguments": {
"subnet6": [
{
"id": 234,
"subnet": "2001:db8:1::/64"
}
]
}
"cmd-syntax": "{
\"command\": \"subnet6-update\",
\"arguments\": {
\"subnet6\": [ {
\"id\": 234,
\"subnet\": \"2001:db8:1::/64\",
...
} ]
}
}",
"resp-syntax": "{
\"result\": 0,
\"text\": \"IPv6 subnet updated\",
\"arguments\": {
\"subnet6\": [
{
\"id\": 234,
\"subnet\": \"2001:db8:1::/64\"
}
]
}
}"
}

9
doc/sphinx/api/version-get.json
View File

@ -1,7 +1,12 @@
{
"name": "version-get",
"brief": "The version-get command returns extended information about Kea version. The returned string is the same as if Kea would be run with -V command line option.",
"brief": "The version-get command returns extended information about
Kea version. The returned string is the same as if Kea would
be run with -V command line option.",
"description": "See <xref linkend=\"command-version-get\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.2.0"
"avail": "1.2.0",
"cmd-syntax": "{
\"command\": \"version-get\"
}"
}