Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
ISC Open Source Projects
Kea
Commits
7289e654
Commit
7289e654
authored
Dec 22, 2016
by
Thomas Markwalder
Browse files
[5046] Added documentation to the admin guide for set-config
parent
0bfc6341
Changes
3
Hide whitespace changes
Inline
Side-by-side
doc/guide/ctrl-channel.xml
View file @
7289e654
...
...
@@ -161,6 +161,65 @@ will be sent to Kea and the responses received from Kea printed to standard outp
</para>
</section>
<!-- end of command-list-commands -->
<section
id=
"command-set-config"
>
<title>
set-config
</title>
<para>
The
<emphasis>
set-config
</emphasis>
command instructs the server to replace
its current configuration with the new configuration supplied in the
command's arguments. The supplied configuration is expected to be the full
configuration for the target server along with an optional Logger
configuration. While optional, the Logger configuration is highly
recommended as without it the server will revert to its default logging
configuration. The structure of the command is as follows:
</para>
<screen>
{
"command": "set-config",
"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": "set-config",
"arguments": {
"Dhcp6": {
:
},
"Logging": {
:
}
}
}
</screen>
<para>
If the new configuration proves to be invalid the server will retain
its current configuration. Please note that the new configuration is
retained in memory only. If the server is restarted or a configuration
reload is triggered via a signal, the server will use the configuration
stored in its configuration file.
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 successful." }
or
{"result": 1, "text": "unsupported parameter: BOGUS (
<
string
>
:16:26)" }
</screen>
</para>
</section>
<!-- end of command-set-config -->
<section
id=
"command-shutdown"
>
<title>
shutdown
</title>
...
...
@@ -182,6 +241,8 @@ will be sent to Kea and the responses received from Kea printed to standard outp
</para>
</section>
<!-- end of command-shutdown -->
</section>
<!-- end of commands supported by both servers -->
</chapter>
doc/guide/dhcp4-srv.xml
View file @
7289e654
...
...
@@ -3659,17 +3659,30 @@ src/lib/dhcpsrv/cfg_host_operations.cc -->
<para>
Communication over control channel is conducted using JSON structures.
See the Control Channel section in the Kea Developer's Guide for more details.
See the Control Channel section in the Kea Developer's Guide for more
details.
</para>
<para>
The DHCPv4 server supports the following operational commands:
<itemizedlist>
<listitem>
leases-reclaim
</listitem>
<listitem>
list-commands
</listitem>
<listitem>
set-config
</listitem>
<listitem>
shutdown
</listitem>
</itemizedlist>
as described in
<xref
linkend=
"commands-common"
/>
. In addition,
it supports the following statistics related commands:
<itemizedlist>
<listitem>
statistic-get
</listitem>
<listitem>
statistic-reset
</listitem>
<listitem>
statistic-remove
</listitem>
<listitem>
statistic-get-all
</listitem>
<listitem>
statistic-reset-all
</listitem>
<listitem>
statistic-remove-all
</listitem>
</itemizedlist>
as described here
<xref
linkend=
"command-stats"
/>
.
</para>
<para>
The DHCPv4 server supports
<command>
statistic-get
</command>
,
<command>
statistic-reset
</command>
,
<command>
statistic-remove
</command>
,
<command>
statistic-get-all
</command>
,
<command>
statistic-reset-all
</command>
and
<command>
statistic-remove-all
</command>
, specified in
<xref
linkend=
"command-stats"
/>
. It also supports
<command>
list-commands
</command>
and
<command>
shutdown
</command>
,
specified in
<xref
linkend=
"command-list-commands"
/>
and
<xref
linkend=
"command-shutdown"
/>
, respectively.
</para>
</section>
<section
id=
"dhcp4-std"
>
...
...
doc/guide/dhcp6-srv.xml
View file @
7289e654
...
...
@@ -4067,16 +4067,27 @@ If not specified, the default value is:
See the Control Channel section in the Kea Developer's Guide for more details.
</para>
<para>
The DHCPv6 server supports
<command>
statistic-get
</command>
,
<command>
statistic-reset
</command>
,
<command>
statistic-remove
</command>
,
<command>
statistic-get-all
</command>
,
<command>
statistic-reset-all
</command>
and
<command>
statistic-remove-all
</command>
, specified in
<xref
linkend=
"command-stats"
/>
. It also supports
<command>
list-commands
</command>
and
<command>
shutdown
</command>
,
specified in
<xref
linkend=
"command-list-commands"
/>
and
<xref
linkend=
"command-shutdown"
/>
, respectively.
</para>
</section>
<para>
The DHCPv6 server supports the following operational commands:
<itemizedlist>
<listitem>
leases-reclaim
</listitem>
<listitem>
list-commands
</listitem>
<listitem>
set-config
</listitem>
<listitem>
shutdown
</listitem>
</itemizedlist>
as described in
<xref
linkend=
"commands-common"
/>
. In addition,
it supports the following statistics related commands:
<itemizedlist>
<listitem>
statistic-get
</listitem>
<listitem>
statistic-reset
</listitem>
<listitem>
statistic-remove
</listitem>
<listitem>
statistic-get-all
</listitem>
<listitem>
statistic-reset-all
</listitem>
<listitem>
statistic-remove-all
</listitem>
</itemizedlist>
as described here
<xref
linkend=
"command-stats"
/>
.
</para>
</section>
<section>
<title>
User context in IPv6 pools
</title>
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment