mirror of
https://gitlab.isc.org/isc-projects/kea
synced 2025-08-30 13:37:55 +00:00
[5213] Documentation updated.
This commit is contained in:
@@ -252,7 +252,7 @@ $ curl -X POST -H "Content-Type: application/json" -d '{ "command": "config-get"
|
|||||||
configuration used by the server. This command does not take any
|
configuration used by the server. This command does not take any
|
||||||
parameters. The configuration returned is roughly equal to the
|
parameters. The configuration returned is roughly equal to the
|
||||||
configuration that was loaded using -c command line option during server
|
configuration that was loaded using -c command line option during server
|
||||||
start-up or later set using set-config command. However, there may be
|
start-up or later set using config-set command. However, there may be
|
||||||
certain differences. Comments are not retained. If the original
|
certain differences. Comments are not retained. If the original
|
||||||
configuration used file inclusion, the returned configuration will
|
configuration used file inclusion, the returned configuration will
|
||||||
include all parameters from all the included files.</para>
|
include all parameters from all the included files.</para>
|
||||||
@@ -282,7 +282,7 @@ $ curl -X POST -H "Content-Type: application/json" -d '{ "command": "config-get"
|
|||||||
configuration for the target server along with an optional Logger
|
configuration for the target server along with an optional Logger
|
||||||
configuration. As for the <command>-t</command> command some sanity checks
|
configuration. As for the <command>-t</command> command some sanity checks
|
||||||
are not performed so it is possible a configuration which successfully
|
are not performed so it is possible a configuration which successfully
|
||||||
passes this command will still fail in <command>set-config</command>
|
passes this command will still fail in <command>config-set</command>
|
||||||
command or at launch time.
|
command or at launch time.
|
||||||
The structure of the command is as follows:
|
The structure of the command is as follows:
|
||||||
</para>
|
</para>
|
||||||
@@ -422,11 +422,11 @@ $ curl -X POST -H "Content-Type: application/json" -d '{ "command": "config-get"
|
|||||||
</para>
|
</para>
|
||||||
</section> <!-- end of command-list-commands -->
|
</section> <!-- end of command-list-commands -->
|
||||||
|
|
||||||
<section id="command-set-config">
|
<section id="command-config-set">
|
||||||
<title>set-config</title>
|
<title>config-set</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
The <emphasis>set-config</emphasis> command instructs the server to replace
|
The <emphasis>config-set</emphasis> command instructs the server to replace
|
||||||
its current configuration with the new configuration supplied in the
|
its current configuration with the new configuration supplied in the
|
||||||
command's arguments. The supplied configuration is expected to be the full
|
command's arguments. The supplied configuration is expected to be the full
|
||||||
configuration for the target server along with an optional Logger
|
configuration for the target server along with an optional Logger
|
||||||
@@ -436,7 +436,7 @@ $ curl -X POST -H "Content-Type: application/json" -d '{ "command": "config-get"
|
|||||||
</para>
|
</para>
|
||||||
<screen>
|
<screen>
|
||||||
{
|
{
|
||||||
"command": "set-config",
|
"command": "config-set",
|
||||||
"arguments": {
|
"arguments": {
|
||||||
"<server>": {
|
"<server>": {
|
||||||
},
|
},
|
||||||
@@ -451,7 +451,7 @@ $ curl -X POST -H "Content-Type: application/json" -d '{ "command": "config-get"
|
|||||||
</para>
|
</para>
|
||||||
<screen>
|
<screen>
|
||||||
{
|
{
|
||||||
"command": "set-config",
|
"command": "config-set",
|
||||||
"arguments": {
|
"arguments": {
|
||||||
"Dhcp6": {
|
"Dhcp6": {
|
||||||
:
|
:
|
||||||
@@ -479,7 +479,7 @@ $ curl -X POST -H "Content-Type: application/json" -d '{ "command": "config-get"
|
|||||||
{"result": 1, "text": "unsupported parameter: BOGUS (<string>:16:26)" }
|
{"result": 1, "text": "unsupported parameter: BOGUS (<string>:16:26)" }
|
||||||
</screen>
|
</screen>
|
||||||
</para>
|
</para>
|
||||||
</section> <!-- end of command-set-config -->
|
</section> <!-- end of command-config-set -->
|
||||||
|
|
||||||
<section id="command-shutdown">
|
<section id="command-shutdown">
|
||||||
<title>shutdown</title>
|
<title>shutdown</title>
|
||||||
|
@@ -3725,11 +3725,11 @@ src/lib/dhcpsrv/cfg_host_operations.cc -->
|
|||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
<listitem>build-report</listitem>
|
<listitem>build-report</listitem>
|
||||||
<listitem>config-get</listitem>
|
<listitem>config-get</listitem>
|
||||||
|
<listitem>config-set</listitem>
|
||||||
<listitem>config-test</listitem>
|
<listitem>config-test</listitem>
|
||||||
<listitem>config-write</listitem>
|
<listitem>config-write</listitem>
|
||||||
<listitem>leases-reclaim</listitem>
|
<listitem>leases-reclaim</listitem>
|
||||||
<listitem>list-commands</listitem>
|
<listitem>list-commands</listitem>
|
||||||
<listitem>set-config</listitem>
|
|
||||||
<listitem>shutdown</listitem>
|
<listitem>shutdown</listitem>
|
||||||
<listitem>version-get</listitem>
|
<listitem>version-get</listitem>
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
|
@@ -3944,11 +3944,11 @@ If not specified, the default value is:
|
|||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
<listitem>build-report</listitem>
|
<listitem>build-report</listitem>
|
||||||
<listitem>config-get</listitem>
|
<listitem>config-get</listitem>
|
||||||
|
<listitem>config-set</listitem>
|
||||||
<listitem>config-test</listitem>
|
<listitem>config-test</listitem>
|
||||||
<listitem>config-write</listitem>
|
<listitem>config-write</listitem>
|
||||||
<listitem>leases-reclaim</listitem>
|
<listitem>leases-reclaim</listitem>
|
||||||
<listitem>list-commands</listitem>
|
<listitem>list-commands</listitem>
|
||||||
<listitem>set-config</listitem>
|
|
||||||
<listitem>shutdown</listitem>
|
<listitem>shutdown</listitem>
|
||||||
<listitem>version-get</listitem>
|
<listitem>version-get</listitem>
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
|
Reference in New Issue
Block a user