Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Kea
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
Operations
Operations
Incidents
Packages & Registries
Packages & Registries
Container Registry
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Sebastian Schrader
Kea
Commits
aad3f203
Commit
aad3f203
authored
Mar 15, 2017
by
Tomek Mrugalski
🛰
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
[5151] New commands documented.
parent
1e5e7ef4
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
55 additions
and
0 deletions
+55
-0
doc/guide/ctrl-channel.xml
doc/guide/ctrl-channel.xml
+51
-0
doc/guide/dhcp4-srv.xml
doc/guide/dhcp4-srv.xml
+2
-0
doc/guide/dhcp6-srv.xml
doc/guide/dhcp6-srv.xml
+2
-0
No files found.
doc/guide/ctrl-channel.xml
View file @
aad3f203
...
...
@@ -113,6 +113,57 @@ will be sent to Kea and the responses received from Kea printed to standard outp
<section
id=
"commands-common"
>
<title>
Commands Supported by Both the DHCPv4 and DHCPv6 Servers
</title>
<section
id=
"command-config-get"
>
<title>
config-get
</title>
<para>
The
<emphasis>
config-get
</emphasis>
command retrieves the current
configuration used by the server. This command does not take any
parameters. The configuration returned is roughly equal to the
configuration that was loaded using -c command line option during server
start-up or later set using set-config command. However, there may be
certain differences. Comments are not retained. If the original
configuration used file inclusion, the returned configuration will
include all parameters from all the included files.
</para>
<para>
Note that returned configuration is not redacted, i.e. it will
contain database passwords in plain text if those were specified in the
original configuration. Care should be taken to not expose the command
channel to unprivileged users.
</para>
<para>
An example command invocation looks like this:
<screen>
{
"command": "config-get"
}
</screen>
</para>
</section>
<section
id=
"command-config-write"
>
<title>
config-write
</title>
<para>
The
<emphasis>
config-write
</emphasis>
command instructs Kea server
to write its current configuration to a file on disk. It takes one
optional argument called
<emphasis>
filename
</emphasis>
that specifies
the name of the file to write configuration to. If not specifed, the
name used when starting Kea (passed as -c argument) will be used. Note
that the filename specified must not contain .. or backslashes. Kea
should be able to write its files only in the directory it is running
and any attempts to step out of that directory is rejected.
</para>
<para>
An example command invocation looks like this:
<screen>
{
"command": "config-write",
"parameters": {
"filename": "config-modified-2017-03-15.json"
}
}
</screen>
</para>
</section>
<section
id=
"command-leases-reclaim"
>
<title>
leases-reclaim
</title>
<para>
...
...
doc/guide/dhcp4-srv.xml
View file @
aad3f203
...
...
@@ -3723,6 +3723,8 @@ src/lib/dhcpsrv/cfg_host_operations.cc -->
<para>
The DHCPv4 server supports the following operational commands:
<itemizedlist>
<listitem>
config-get
</listitem>
<listitem>
config-write
</listitem>
<listitem>
leases-reclaim
</listitem>
<listitem>
list-commands
</listitem>
<listitem>
set-config
</listitem>
...
...
doc/guide/dhcp6-srv.xml
View file @
aad3f203
...
...
@@ -4131,6 +4131,8 @@ If not specified, the default value is:
<para>
The DHCPv6 server supports the following operational commands:
<itemizedlist>
<listitem>
config-get
</listitem>
<listitem>
config-write
</listitem>
<listitem>
leases-reclaim
</listitem>
<listitem>
list-commands
</listitem>
<listitem>
set-config
</listitem>
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a 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