Commit 2810c44a authored by Marcin Siodelski's avatar Marcin Siodelski
Browse files

[#643,!421] Created API docs for remote-server* commands.

parent 4c60b02e
......@@ -156,6 +156,14 @@ EXTRA_DIST += api/remote-subnet6-set.json
EXTRA_DIST += api/reservation-add.json api/reservation-del.json
EXTRA_DIST += api/reservation-get.json api/reservation-get-all.json
EXTRA_DIST += api/reservation-get-page.json api/shutdown.json
EXTRA_DIST += api/remote-server4-del.json
EXTRA_DIST += api/remote-server4-get.json
EXTRA_DIST += api/remote-server4-get-all.json
EXTRA_DIST += api/remote-server4-set.json
EXTRA_DIST += api/remote-server6-del.json
EXTRA_DIST += api/remote-server6-get.json
EXTRA_DIST += api/remote-server6-get-all.json
EXTRA_DIST += api/remote-server6-set.json
EXTRA_DIST += api/statistic-get-all.json api/statistic-get.json
EXTRA_DIST += api/statistic-remove-all.json api/statistic-remove.json
EXTRA_DIST += api/statistic-reset-all.json api/statistic-reset.json
......
......@@ -5,7 +5,7 @@
"avail": "1.6.0",
"hook": "cb_cmds",
"cmd-syntax": "{
\"command\": \"remote-global-parameter4-get-all\"
\"command\": \"remote-global-parameter4-get-all\",
\"arguments\": {
\"remote\": {
<specification of the database to connect to>
......
......@@ -5,7 +5,7 @@
"avail": "1.6.0",
"hook": "cb_cmds",
"cmd-syntax": "{
\"command\": \"remote-global-parameter4-get\"
\"command\": \"remote-global-parameter4-get\",
\"arguments\": {
\"parameters\": [ <parameter name> ],
\"remote\": {
......
{
"name": "remote-server4-del",
"brief": "This command is used to delete information about a DHCPv4 server from the configuration database. Any configuration explicitly associated with the deleted server is automatically disassociated. In addition, configuration elements not shareable with other servers (e.g. global DHCP parameters) are deleted. The shareable configuration (e.g. subnets, shared networks) is not deleted as it may be used by other servers.",
"support": [ "kea-dhcp4" ],
"avail": "1.6.0",
"hook": "cb_cmds",
"cmd-syntax": "{
\"command\": \"remote-server4-del\",
\"arguments\": {
\"servers\": [
{
\"server-tag\": <server name>
}
],
\"remote\": {
<specification of the database to connect to>
}
}
}",
"cmd-comment": "This command carries the list including exactly one map with the tag of the server to be deleted.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"1 DHCPv4 server(s) deleted.\"
\"arguments\": {
\"count\": 1
}
}"
}
{
"name": "remote-server4-get-all",
"brief": "This command is used to fetch information about all DHCPv4 servers specified by the user.",
"support": [ "kea-dhcp4" ],
"avail": "1.6.0",
"hook": "cb_cmds",
"cmd-syntax": "{
\"command\": \"remote-server4-get-all\",
\"arguments\": {
\"remote\": {
<specification of the database to connect to>
}
}
}",
"cmd-comment": "This command contains no arguments besides the optional <command>remote</command>.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"DHCPv4 servers found.\",
\"arguments\": {
\"servers\": [
{
\"server-tag\": <first server tag>
\"description\": <first server description>
},
{
\"server-tag\": <second server tag>
\"description\": <second server description>
}
],
\"count\": 2
}
}",
"resp-comment": "The returned response contain a list of maps. Each map contains a server tag uniquely identifying a server and the user defined description of the server. The Kea Configuration Backend uses the keyword <command>all</command> to associate parts of the configuration with all servers. Internally, it creates the logical server <command>all</command> for this purpose. However, this logical server is not returned as a result of the <command>remote-server4-get-all</command>. Only the user defined servers are returned."
}
{
"name": "remote-server4-get",
"brief": "This command is used to fetch the information about the DHCPv4 server, such as server tag and description.",
"support": [ "kea-dhcp4" ],
"avail": "1.6.0",
"hook": "cb_cmds",
"cmd-syntax": "{
\"command\": \"remote-server4-get\",
\"arguments\": {
\"servers\": [
{
\"server-tag\": <server tag>
}
],
\"remote\": {
<specification of the database to connect to>
}
}
}",
"cmd-comment": "This command carries the list including exactly one map with the tag of the server to be fetched.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"DHCP server <server tag> found.\",
\"arguments\": {
\"servers\": [
{
\"server-tag\": <server tag>,
\"description\": <server description>
}
],
\"count\": 1
}
}",
"resp-comment": "The server tag is the unique identifier of the server, used to associate the configuration elements in the database with the particular server instance. The returned server description is specified by the user when setting the server information."
}
{
"name": "remote-server4-set",
"brief": "This command is used to create or replace information about the DHCPv4 server in the database.",
"support": [ "kea-dhcp4" ],
"avail": "1.6.0",
"hook": "cb_cmds",
"cmd-syntax": "{
\"command\": \"remote-server4-set\",
\"arguments\": {
\"servers\": [
{
\"server-tag\": <server tag>,
\"description\": <server description>
}
],
\"remote\": {
<specification of the database to connect to>
}
}
}",
"cmd-comment": "The provided list must contain exactly one server specification. The <command>server-tag</command> must be unique accross all servers within the configuration database. The <command>description</command> is the arbitrary text describing the server, its location within the network etc.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"DHCPv4 server successfully set.\",
\"arguments\": {
\"servers\": [
{
\"server-tag\": <server tag>,
\"description\": <server description>
}
]
}
}"
}
{
"name": "remote-server6-del",
"brief": "This command is used to delete information about a DHCPv6 server from the configuration database. Any configuration explicitly associated with the deleted server is automatically disassociated. In addition, configuration elements not shareable with other servers (e.g. global DHCP parameters) are deleted. The shareable configuration (e.g. subnets, shared networks) is not deleted as it may be used by other servers.",
"support": [ "kea-dhcp6" ],
"avail": "1.6.0",
"hook": "cb_cmds",
"cmd-syntax": "{
\"command\": \"remote-server6-del\",
\"arguments\": {
\"servers\": [
{
\"server-tag\": <server name>
}
],
\"remote\": {
<specification of the database to connect to>
}
}
}",
"cmd-comment": "This command carries the list including exactly one map with the tag of the server to be deleted.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"1 DHCPv6 server(s) deleted.\"
\"arguments\": {
\"count\": 1
}
}"
}
{
"name": "remote-server6-get-all",
"brief": "This command is used to fetch information about all DHCPv6 servers specified by the user.",
"support": [ "kea-dhcp6" ],
"avail": "1.6.0",
"hook": "cb_cmds",
"cmd-syntax": "{
\"command\": \"remote-server6-get-all\",
\"arguments\": {
\"remote\": {
<specification of the database to connect to>
}
}
}",
"cmd-comment": "This command contains no arguments besides the optional <command>remote</command>.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"DHCPv6 servers found.\",
\"arguments\": {
\"servers\": [
{
\"server-tag\": <first server tag>
\"description\": <first server description>
},
{
\"server-tag\": <second server tag>
\"description\": <second server description>
}
],
\"count\": 2
}
}",
"resp-comment": "The returned response contain a list of maps. Each map contains a server tag uniquely identifying a server and the user defined description of the server. The Kea Configuration Backend uses the keyword <command>all</command> to associate parts of the configuration with all servers. Internally, it creates the logical server <command>all</command> for this purpose. However, this logical server is not returned as a result of the <command>remote-server6-get-all</command>. Only the user defined servers are returned."
}
{
"name": "remote-server6-get",
"brief": "This command is used to fetch the information about the DHCPv6 server, such as server tag and description.",
"support": [ "kea-dhcp6" ],
"avail": "1.6.0",
"hook": "cb_cmds",
"cmd-syntax": "{
\"command\": \"remote-server6-get\",
\"arguments\": {
\"servers\": [
{
\"server-tag\": <server tag>
}
],
\"remote\": {
<specification of the database to connect to>
}
}
}",
"cmd-comment": "This command carries the list including exactly one map with the tag of the server to be fetched.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"DHCP server <server tag> found.\",
\"arguments\": {
\"servers\": [
{
\"server-tag\": <server tag>,
\"description\": <server description>
}
],
\"count\": 1
}
}",
"resp-comment": "The server tag is the unique identifier of the server, used to associate the configuration elements in the database with the particular server instance. The returned server description is specified by the user when setting the server information."
}
{
"name": "remote-server6-set",
"brief": "This command is used to create or replace information about the DHCPv6 server in the database.",
"support": [ "kea-dhcp6" ],
"avail": "1.6.0",
"hook": "cb_cmds",
"cmd-syntax": "{
\"command\": \"remote-server6-set\",
\"arguments\": {
\"servers\": [
{
\"server-tag\": <server tag>,
\"description\": <server description>
}
],
\"remote\": {
<specification of the database to connect to>
}
}
}",
"cmd-comment": "The provided list must contain exactly one server specification. The <command>server-tag</command> must be unique accross all servers within the configuration database. The <command>description</command> is the arbitrary text describing the server, its location within the network etc.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"DHCPv6 server successfully set.\",
\"arguments\": {
\"servers\": [
{
\"server-tag\": <server tag>,
\"description\": <server description>
}
]
}
}"
}
......@@ -83,6 +83,14 @@ remote-option6-global-del
remote-option6-global-get
remote-option6-global-get-all
remote-option6-global-set
remote-server4-del
remote-server4-get
remote-server4-get-all
remote-server4-set
remote-server6-del
remote-server6-get
remote-server6-get-all
remote-server6-set
remote-subnet4-del-by-id
remote-subnet4-del-by-prefix
remote-subnet4-get-by-id
......
This diff is collapsed.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment