Commit a5f8612b authored by Francis Dupont's avatar Francis Dupont

[30-implement-control-socket-for-ddns-2] Updated API doc

parent 18cbd1af
{ {
"name": "build-report", "name": "build-report",
"brief": "Returns a list of compilation options that this particular binary was built with", "brief": "Returns a list of compilation options that this particular binary was built with",
"support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ], "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.2.0", "avail": "1.2.0",
"cmd-syntax": "{ "cmd-syntax": "{
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
"brief": "Retrieves the current configuration used by the server. The configuration "brief": "Retrieves the current configuration used by the server. The configuration
is roughtly equal to the configuration file, but includes additional is roughtly equal to the configuration file, but includes additional
changes made by other commands and due to parameters inheritance.", changes made by other commands and due to parameters inheritance.",
"support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ], "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.2.0", "avail": "1.2.0",
"cmd-syntax": "{ "cmd-syntax": "{
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
"name": "config-set", "name": "config-set",
"brief": "The config-set command instructs the server to replace its current configuration with the new configuration supplied in the command's arguments.", "brief": "The config-set command instructs the server to replace its current configuration with the new configuration supplied in the command's arguments.",
"description": "See <xref linkend=\"command-config-set\"/>", "description": "See <xref linkend=\"command-config-set\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" ], "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.2.0", "avail": "1.2.0",
"cmd-syntax": "{ "cmd-syntax": "{
\"command\": \"config-set\", \"command\": \"config-set\",
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
"name": "config-test", "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.", "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\"/>", "description": "See <xref linkend=\"command-config-test\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ], "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.2.0", "avail": "1.2.0",
"cmd-syntax": "{ "cmd-syntax": "{
\"command\": \"config-test\", \"command\": \"config-test\",
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
"brief": "The config-write command instructs the Kea server to write its "brief": "The config-write command instructs the Kea server to write its
current configuration to a file on disk.", current configuration to a file on disk.",
"description": "See <xref linkend=\"command-config-write\"/>", "description": "See <xref linkend=\"command-config-write\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ], "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.2.0", "avail": "1.2.0",
"cmd-syntax": "{ "cmd-syntax": "{
\"command\": \"config-write\", \"command\": \"config-write\",
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
"name": "list-commands", "name": "list-commands",
"brief": "The list-commands command retrieves a list of all commands supported by the server.", "brief": "The list-commands command retrieves a list of all commands supported by the server.",
"description": "See <xref linkend=\"command-list-commands\"/>", "description": "See <xref linkend=\"command-list-commands\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6" , "kea-ctrl-agent" ], "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.0.0", "avail": "1.0.0",
"cmd-syntax": "{ "cmd-syntax": "{
\"command\": \"list-commands\", \"command\": \"list-commands\",
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
"name": "shutdown", "name": "shutdown",
"brief": "The shutdown command instructs the server to initiate its shutdown procedure.", "brief": "The shutdown command instructs the server to initiate its shutdown procedure.",
"description": "See <xref linkend=\"command-shutdown\"/>", "description": "See <xref linkend=\"command-shutdown\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ], "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.0.0", "avail": "1.0.0",
"cmd-syntax": "{ "cmd-syntax": "{
\"command\": \"shutdown\" \"command\": \"shutdown\"
......
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
Kea version. The returned string is the same as if Kea would Kea version. The returned string is the same as if Kea would
be run with -V command line option.", be run with -V command line option.",
"description": "See <xref linkend=\"command-version-get\"/>", "description": "See <xref linkend=\"command-version-get\"/>",
"support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ], "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
"avail": "1.2.0", "avail": "1.2.0",
"cmd-syntax": "{ "cmd-syntax": "{
\"command\": \"version-get\" \"command\": \"version-get\"
......
...@@ -795,7 +795,7 @@ This command takes no parameters.</para> ...@@ -795,7 +795,7 @@ This command takes no parameters.</para>
<screen>{ <screen>{
"result": &lt;integer&gt;, "result": &lt;integer&gt;,
"arguments": { "arguments": {
&lt;JSON configuration here, starting with Dhcp4, Dhcp6, or Control-agent object&gt; &lt;JSON configuration here, starting with Dhcp4, Dhcp6, Dhcp-ddns, or Control-agent object&gt;
} }
}</screen> }</screen>
Result is an integer representation of the status. Currently supported statuses are: Result is an integer representation of the status. Currently supported statuses are:
......
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