Commit 191194ff authored by Tomek Mrugalski's avatar Tomek Mrugalski 🛰
Browse files

[#10,!3] Various small corrections in the json files

parent 538f7e51
......@@ -2,7 +2,7 @@
"name": "config-test",
"brief": "The config-test command instructs the server to check whether the new configuration supplied in the command's arguments can be loaded.",
"description": "See <xref linkend=\"command-config-test\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ],
"avail": "1.2.0",
"cmd-syntax": "{
\"command\": \"config-test\",
......
{
"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" ],
"support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ],
"avail": "1.2.0",
"cmd-syntax": "{
\"command\": \"config-write\",
......
......@@ -2,7 +2,7 @@
"name": "list-commands",
"brief": "The list-commands command retrieves a list of all commands supported by the server.",
"description": "See <xref linkend=\"command-list-commands\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" , "ca" ],
"support": [ "kea-dhcp4", "kea-dhcp6" , "kea-ctrl-agent" ],
"avail": "1.0.0",
"cmd-syntax": "{
\"command\": \"list-commands\",
......
{
"name": "network4-list",
"brief": "The network4-list command is used to retrieve full list of currently configured shared networks.",
"description": "See <xref linkend=\"idp73\"/>",
"description": "See <xref linkend=\"command-networkX-list\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.3.0",
"hook": "subnet_cmds",
......
{
"name": "network6-del",
"brief": "The network6-del command is used to delete existing shared networks.",
"description": "See <xref linkend=\"idp76\"/>",
"description": "See <xref linkend=\"command-network6-del\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.3.0",
"hook": "subnet_cmds",
......@@ -11,7 +11,8 @@
\"name\": \"floor13\"
}
}",
"cmd-comment": "The network6-del command uses exactly the same syntax for both the command and the response.",
"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": "network6-list",
"brief": "The network6-list command is used to retrieve full list of currently configured shared networks.",
"description": "See <xref linkend=\"idp73\"/>",
"description": "See <xref linkend=\"command-networkX-list\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.3.0",
"hook": "subnet_cmds",
......
......@@ -2,10 +2,11 @@
"name": "shutdown",
"brief": "The shutdown command instructs the server to initiate its shutdown procedure.",
"description": "See <xref linkend=\"command-shutdown\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ],
"avail": "1.0.0",
"cmd-syntax": "{
\"command\": \"shutdown\"
}",
"cmd-comment": "The server will respond with a confirmation that the shutdown procedure has been initiated."
"cmd-comment": "The server will respond with a confirmation that the shutdown
procedure has been initiated."
}
{
"name": "stat-lease4-get",
"brief": "The stat-lease4-get command fetches lease statistics for a range of known subnets.",
"description": "See <xref linkend=\"idp81\"/>",
"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", "kea-dhcp6" ],
"avail": "1.4.0",
"hook": "stat_cmds",
......@@ -13,7 +14,10 @@
\"text\": \"stat-lease4-get: 2 rows found\",
\"arguments\": {
\"result-set\": {
\"columns\": [ \"subnet-id\", \"total-addresses\", \"assigned-addresses\", \"declined-addresses\" ]
\"columns\": [ \"subnet-id\",
\"total-addresses\",
\"assigned-addresses\",
\"declined-addresses\" ]
\"rows\": [
[ 10, 256, 111, 0 ],
[ 20, 4098, 2034, 4 ]
......
{
"name": "stat-lease6-get",
"brief": "The stat-lease6-get command fetches lease statistics for a range of known subnets.",
"description": "See <xref linkend=\"idp81\"/>",
"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-dhcp4", "kea-dhcp6" ],
"avail": "1.4.0",
"hook": "stat_cmds",
......
......@@ -8,5 +8,5 @@
\"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.",
}
\ No newline at end of file
"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."
}
......@@ -10,5 +10,5 @@
\"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.",
}
\ No newline at end of file
"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."
}
......@@ -26,5 +26,5 @@
}
]
}
}",
}
\ No newline at end of file
}"
}
{
"name": "subnet4-del",
"brief": "This command is used to remove a subnet from the server\'s configuration. This command has no effect on other configured subnets but removing a subnet has certain implications which the server\'s administrator should be aware of.",
"brief": "This command is used to remove a subnet from the server's configuration. This command has no effect on other configured subnets but removing a subnet has certain implications which the server's administrator should be aware of.",
"description": "See <xref linkend=\"idp71\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.3.0",
......@@ -22,5 +22,5 @@
}
]
}
}",
}
\ No newline at end of file
}"
}
......@@ -26,5 +26,5 @@
}
]
}
}",
}
\ No newline at end of file
}"
}
......@@ -26,5 +26,5 @@
}
]
}
}",
}
\ No newline at end of file
}"
}
{
"name": "subnet6-del",
"brief": "This command is used to remove a subnet from the server\'s configuration. This command has no effect on other configured subnets but removing a subnet has certain implications which the server\'s administrator should be aware of.",
"brief": "This command is used to remove a subnet from the server's configuration. This command has no effect on other configured subnets but removing a subnet has certain implications which the server's administrator should be aware of.",
"description": "See <xref linkend=\"idp72\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"avail": "1.3.0",
......@@ -20,5 +20,5 @@
\"subnet\": \"2001:db8:1::/64\"
}
]
}",
}
\ No newline at end of file
}"
}
......@@ -26,5 +26,5 @@
}
]
}
}",
}
\ No newline at end of file
}"
}
{
"name": "version-get",
"brief": "The version-get command returns on the control channel what the command line -v argument displays with in arguments the extended version, i.e., what the command line -V argument displays.",
"brief": "The version-get command returns on the control channel what the
command line -v argument displays with in arguments the extended
version, i.e., what the command line -V argument displays.",
"description": "See <xref linkend=\"command-version-get\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ],
"support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ],
"avail": "1.2.0",
"cmd-syntax": "{
\"command\": \"version-get\"
}",
}
\ No newline at end of file
}"
}
......@@ -12,6 +12,7 @@ config-test
config-write
dhcp-disable
dhcp-enable
ha-continue
ha-heartbeat
ha-scopes
ha-sync
......
......@@ -139,7 +139,8 @@
<section xml:id="ha-server-states">
<title>Server States</title>
<para>The DHCP server operating within an HA setup runs a state machine
<para id="command-ha-heartbeat">The DHCP server operating
within an HA setup runs a state machine
and the state of the server can be retrieved by its peers using the
<command>ha-heartbeat</command> command sent over the RESTful API. If
the partner server doesn't respond to the <command>ha-heartbeat</command>
......@@ -1292,7 +1293,7 @@
HA hook library which are available for the administrator.
</para>
<section xml:id="ha-sync-command">
<section xml:id="command-ha-sync">
<title>ha-sync command</title>
<para>The <command>ha-sync</command> is issued to instruct the
server to synchronize its local lease database with the
......@@ -1346,7 +1347,7 @@
</para>
</section> <!-- ha-sync-command -->
<section xml:id="ha-scopes-command">
<section xml:id="command-ha-scopes">
<title>ha-scopes command</title>
<para>This command allows for modifying the HA scopes that the
server is serving. Consult <xref linkend="ha-load-balancing-config"/>
......@@ -1357,7 +1358,7 @@
<screen>
{
"command": "ha-scopes",
"service": [ "dhcp4 "],
"service": [ "dhcp4" ],
"arguments": {
"scopes": [ "HA_server1", "HA_server2" ]
}
......@@ -1381,7 +1382,7 @@
</para>
</section> <!-- ha-scopes-command -->
<section xml:id="ha-continue-command">
<section xml:id="command-ha-continue">
<title>ha-continue command</title>
<para>This command is used to resume the operation of the paused HA
state machine as described in the <xref linkend="ha-pause-state-machine"/>.
......
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