diff options
Diffstat (limited to 'doc/guide/ctrl-channel.xml')
-rw-r--r-- | doc/guide/ctrl-channel.xml | 59 |
1 files changed, 57 insertions, 2 deletions
diff --git a/doc/guide/ctrl-channel.xml b/doc/guide/ctrl-channel.xml index abfefcdd4d..266282ff39 100644 --- a/doc/guide/ctrl-channel.xml +++ b/doc/guide/ctrl-channel.xml @@ -154,7 +154,62 @@ will be sent to Kea and the responses received from Kea printed to standard outp } </screen> </para> - </section> + </section> <!-- end of command-config-get --> + + <section id="command-config-test"> + <title>config-test</title> + + <para> + The <emphasis>config-test</emphasis> command instructs the server to check + whether the new configuration supplied in the command's arguments can + be loaded. The supplied configuration is expected to be the full + configuration for the target server along with an optional Logger + configuration. As for the <command>-t</command> command some sanity checks + are not performed so it is possible a configuration which successfully + passes this command will still fail in <command>set-config</command> + command or at launch time. + The structure of the command is as follows: + </para> +<screen> +{ + "command": "config-test", + "arguments": { + "<server>": { + }, + "Logging": { + } + } +} +</screen> + <para> + where <server> is the configuration element name for a given server + such as "Dhcp4" or "Dhcp6". For example: + </para> +<screen> +{ + "command": "config-test", + "arguments": { + "Dhcp6": { + : + }, + "Logging": { + : + } + } +} +</screen> + <para> + The server's response will contain a numeric code, "result" (0 for success, + non-zero on failure), and a string, "text", describing the outcome: +<screen> + {"result": 0, "text": "Configuration seems sane..." } + + or + + {"result": 1, "text": "unsupported parameter: BOGUS (<string>:16:26)" } +</screen> + </para> + </section> <!-- end of command-config-test --> <section id="command-config-write"> <title>config-write</title> @@ -178,7 +233,7 @@ will be sent to Kea and the responses received from Kea printed to standard outp } </screen> </para> - </section> + </section> <!-- end of command-config-write --> <section id="command-leases-reclaim"> <title>leases-reclaim</title> |