Commit 38835b62 authored by Marcin Siodelski's avatar Marcin Siodelski
Browse files

[3466] Added manual page for keactrl.

parent 4b82d088
/keactrl
/kea.conf
/keactrl.conf
/keactrl.8
......@@ -7,8 +7,22 @@ SUBDIRS = . tests
sbin_SCRIPTS = keactrl
CONFIGFILES = keactrl.conf kea.conf
DISTCLEANFILES = keactrl $(CONFIGFILES)
EXTRA_DIST = keactrl.in keactrl.conf.in kea.conf.in
man_MANS = keactrl.8
DISTCLEANFILES = keactrl $(CONFIGFILES) $(man_MANS)
EXTRA_DIST = keactrl.in keactrl.conf.in kea.conf.in $(man_MANS) keactrl.xml
if GENERATE_DOCS
keactrl.8: keactrl.xml
@XSLTPROC@ --novalid --xinclude --nonet -o $@ http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $(builddir)/keactrl.xml
else
$(man_MANS):
@echo Man generation disabled. Creating dummy $@. Configure with --enable-generate-docs to enable it.
@echo Man generation disabled. Remove this file, configure with --enable-generate-docs, and rebuild Kea > $@
endif
if INSTALL_CONFIGURATIONS
......
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY mdash "&#8212;">]>
<!--
- Copyright (C) 2014 Internet Systems Consortium, Inc. ("ISC")
-
- Permission to use, copy, modify, and/or distribute this software for any
- purpose with or without fee is hereby granted, provided that the above
- copyright notice and this permission notice appear in all copies.
-
- THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
- REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
- AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
- INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
<refentry>
<refentryinfo>
<date>July 3, 2014</date>
</refentryinfo>
<refmeta>
<refentrytitle>keactrl</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo>Kea</refmiscinfo>
</refmeta>
<refnamediv>
<refname>keactrl</refname>
<refpurpose>Shell script for managing the Kea servers</refpurpose>
</refnamediv>
<docinfo>
<copyright>
<year>2014</year>
<holder>Internet Systems Consortium, Inc. ("ISC")</holder>
</copyright>
</docinfo>
<refsynopsisdiv>
<cmdsynopsis>
<command>keactrl</command>
<arg>command</arg>
<arg><option>-c <replaceable class="parameter">keactrl-config-file</replaceable></option></arg>
<arg><option>-s <replaceable class="parameter">server[,server,...]</replaceable></option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>
<command>keactrl</command> is a shell script which controls the startup,
shutdown and reconfiguration of the Kea servers, i.e.
<command>kea-dhcp4</command>, <command>kea-dhcp6</command> and
<command>kea-dhcp-ddns</command>. It also provides the means for
checking the current status of the servers and returns the information
whether the servers are active or inactive and also configuration data
being used.
</para>
</refsect1>
<refsect1>
<title>CONFIGURATION FILE</title>
<para>
<command>keactrl</command> starts servers in background and returns.
Depending on the needs of the server's Administrator it is possible
to select which of them are started and which are not. This is
specified in the <filename>keactrl.conf</filename> file which by default
is installed in [kea-install-dir]/etc/kea/.
</para>
<para>
See the Kea Administrator's Guide for the documentation of the parameters
in the <command>keactrl</command> configuration file.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term><option><replaceable class="parameter">command</replaceable></option></term>
<listitem>
<para>
Command to be issued to the servers. It can be one of the following:
</para>
<variablelist>
<varlistentry>
<term>start</term>
<listitem>
<para>Start servers.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>stop</term>
<listitem>
<para>Stop servers.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>reload</term>
<listitem>
<para>Reconfigure servers.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>status</term>
<listitem>
<para>Print the status of the servers.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-c|--ctrl-config <replaceable class="parameter">keactrl-config-file</replaceable></option></term>
<listitem>
<para>
Override the default location of the <command>keactrl</command>
configuration file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-s|--server <replaceable class="parameter">server[,server,...]</replaceable></option></term>
<listitem>
<para>
Specify a comma separated list of servers to which the command
should be issued. The acceptable values are:
</para>
<variablelist>
<varlistentry>
<term>dhcp4</term>
<listitem>
<para>DHCPv4 server (<command>kea-dhcp4</command>).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>dhcp6</term>
<listitem>
<para>DHCPv6 server (<command>kea-dhcp6</command>).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>dhcp_ddns</term>
<listitem>
<para>DHCP DDNS server (<command>kea-dhcp-ddns</command>).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>all</term>
<listitem>
<para>All servers (default).</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>kea-dhcp4</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>
<citerefentry>
<refentrytitle>kea-dhcp6</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>
<citerefentry>
<refentrytitle>kea-dhcp-ddns</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>
</para>
</refsect1>
</refentry>
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