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
9645e67e
Commit
9645e67e
authored
Jul 17, 2019
by
Suzanne Goldlust
Committed by
Michal Nowikowski
Jul 30, 2019
Browse files
Edit man page text and formatting for Docbook-to-Sphinx conversion
parent
ed72d1de
Changes
3
Expand all
Hide whitespace changes
Inline
Side-by-side
doc/sphinx/man/kea-shell.8.rst
View file @
9645e67e
:orphan:
kea-shell
8
Kea
kea-shell
Text client for Control Agent process
2017-2018
Internet Systems Consortium, Inc. ("ISC")
kea-shell
-h
-v
--host
--port
--path
--timeout
--service
command
DESCRIPTION
===========
..
Copyright (C) Internet Systems Consortium, Inc. ("ISC")
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/.
See the COPYRIGHT file distributed with this work for additional
information regarding copyright ownership.
.. highlight: console
.. kea-shell:
kea-shell - Text client for Control Agent process
-------------------------------------------------
Synopsis
~~~~~~~~
:program:`kea-shell [**-h**] [**-v**] [**--host**] [**--port**] [**--path**] [**--timeout**] [**--service**] [**command**]
Description
~~~~~~~~~~~
The ``kea-shell`` provides a REST client for the Kea Control Agent (CA).
It takes command as a command-line parameter that is being sent to CA
with proper JSON encapsulation. Optional arguments may be specified on
the standard input. The request i
t
sent
of
HTTP and a response is
retrieved
. That response is
displayed
out
on the standard output.
the standard input. The request i
s
sent
via
HTTP and a response is
retrieved
,
displayed on the standard output.
A
RGUMENTS
=========
A
rguments
~~~~~~~~~
The arguments are as follows:
``-h``
Displays help regarding command
line parameters.
Displays help regarding command
-
line parameters.
``-v``
Display the version.
Display
s
the version.
``--host``
Specifies the host to connect to. Control Agent must be running at
Specifies the host to connect to. Control Agent must be running at
the
specified host. If not specified, 127.0.0.1 is used.
``--port``
Specifies the TCP port to connect to. Control Agent must be listening
at specified port. If not specified, 8000 is used.
at
the
specified port. If not specified, 8000 is used.
``--path``
Specifies the path in the URL to connect to. If not specified, empty
path is used. As Control Agent listens at the empty path this
Specifies the path in the URL to connect to. If not specified,
an
empty
path is used. As Control Agent listens at the empty path
,
this
parameter is useful only with a reverse proxy.
``--timeout``
...
...
@@ -62,44 +66,44 @@ The arguments are as follows:
Specifies the command to be sent to CA. If not specified,
"list-commands" is used.
D
OCUMENTATION
=============
D
ocumentation
~~~~~~~~~~~~~
Kea comes with an extensive Kea
User's Guide documentation
that covers
Kea comes with an extensive Kea
Administrator Reference Manual
that covers
all aspects of running the Kea software - compilation, installation,
configuration, configuration examples and m
any
more. Kea also features a
configuration, configuration examples
,
and m
uch
more. Kea also features a
Kea Messages Manual, which lists all possible messages Kea can print
with a brief description for each of them. Both documents are
typically
available in various formats (txt, html, pdf) with
your
Kea
with a brief description for each of them. Both documents are
available in various formats (
.
txt,
.
html,
.
pdf) with
the
Kea
distribution. The Kea documentation is available at
https://kb.isc.org/docs/kea-administrator-reference-manual .
Kea source code is documented in the Kea Developer's Guide. Its on
-
line
Kea source code is documented in the Kea Developer's Guide. Its online
version is available at https://jenkins.isc.org/job/Kea_doc/doxygen/.
Kea project website is available at:
https://gitlab.isc.org/isc-projects/kea.
The Kea project website is available at https://kea.isc.org.
M
AILING LISTS AND SUPPORT
=========================
M
ailing Lists and Support
~~~~~~~~~~~~~~~~~~~~~~~~~
There are two mailing lists available for Kea project. kea-users
(kea-users at lists.isc.org) is intended for Kea users, while kea-dev
There are two
public
mailing lists available for
the
Kea project.
**
kea-users
**
(kea-users at lists.isc.org) is intended for Kea users, while
**
kea-dev
**
(kea-dev at lists.isc.org) is intended for Kea developers, prospective
contributors and other advanced users. Both lists are available at
http://lists.isc.org. The community provides best
effort
type of
support
contributors
,
and other advanced users. Both lists are available at
http
s
://lists.isc.org. The community provides best
-
effort support
on both of those lists.
ISC provides professional support for Kea services. See
https://www.isc.org/kea/ for details.
H
ISTORY
=======
H
istory
~~~~~~~
The ``kea-shell`` was first coded in March 2017 by Tomek Mrugalski.
S
EE ALSO
========
S
ee Also
~~~~~~~~
kea-ctrl-agent 8, kea-dhcp4 8, kea-dhcp6 8, kea-dhcp-ddns 8, kea-admin
8, keactrl 8, perfdhcp 8, kea-lfc 8, Kea Administrator's Guide.
:manpage:`kea-dhcp4(8)`, :manpage:`kea-dhcp6(8)`, :manpage:`kea-dhcp-ddns(8)`,
:manpage:`kea-ctrl-agent(8)`, :manpage:`kea-admin(8)`, :manpage:`keactrl(8)`,
:manpage:`perfdhcp(8)`, :manpage:`kea-lfc(8)`, Kea Administrator Reference Manual.
doc/sphinx/man/keactrl.8.rst
View file @
9645e67e
:orphan:
keactrl
8
Kea
keactrl
Shell script for managing Kea
2014-2018
Internet Systems Consortium, Inc. ("ISC")
keactrl
command
-c
keactrl-config-file
-s
server[,server,...]
-v
DESCRIPTION
===========
keactrl is a shell script which controls the startup, shutdown and
..
Copyright (C) Internet Systems Consortium, Inc. ("ISC")
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/.
See the COPYRIGHT file distributed with this work for additional
information regarding copyright ownership.
.. highlight: console
.. _keactrl:
keactrl - Shell script for managing Kea
---------------------------------------
Synopsis
~~~~~~~~
:program:`keactrl` [**command**] [**-c** keactrl-config-file] [**-s** server[,server,...]] [**-v**]
Description
~~~~~~~~~~~
``keactrl`` is a shell script which controls the startup, shutdown, and
reconfiguration of the Kea servers (``kea-dhcp4``, ``kea-dhcp6``,
``kea-dhcp-ddns``, ``kea-ctrl-agent`` and ``kea-netconf``). It also
``kea-dhcp-ddns``, ``kea-ctrl-agent``
,
and ``kea-netconf``). It also
provides the means for checking the current status of the servers and
determining the configuration files in use.
C
ONFIGURATION FILE
==================
C
onfiguration File
~~~~~~~~~~~~~~~~~~
Depending on requirements, not all of the available servers need be run.
The keactrl configuration file se
t
s which servers are enabled and which
Depending on
the user's
requirements, not all of the available servers need be run.
The
``
keactrl
``
configuration file s
pecifi
es which servers are enabled and which
are disabled. By default the configuration file is
``[kea-install-dir]/etc/kea/keactrl.conf``.
See the Kea Administrator
's Guide for the
documentation of the
See the Kea Administrator
Reference Manual for
documentation of the
parameters in the ``keactrl`` configuration file.
O
PTIONS
=======
O
ptions
~~~~~~~
``command``
C
ommand to be issued to the servers. It can be one of the following:
Specifies the c
ommand to be issued to the servers. It can be one of the following:
start
Start the servers.
**
start
**
Start
s
the servers.
stop
Stop the servers.
**
stop
**
Stop
s
the servers.
reload
Instructs the servers to re-read the
k
ea configuration file. This
**
reload
**
Instructs the servers to re-read the
K
ea configuration file. This
command is not supported by the Netconf agent.
status
Print the status of the servers.
**
status
**
Print
s
the status of the servers.
``-c|--ctrl-config keactrl-config-file``
Specif
y
the ``keactrl`` configuration file. Without this switch,
the
``keactrl``
will
attempt to use the file
Specif
ies
the ``keactrl`` configuration file. Without this switch,
``keactrl`` attempt
s
to use the file
``[kea-install-dir]/etc/kea/keactrl.conf``.
``-s|--server server[,server,...]``
...
...
@@ -63,61 +69,61 @@ OPTIONS
be issued. The list of servers should be separated by commas with no
intervening spaces. Acceptable values are:
dhcp4
**
dhcp4
**
DHCPv4 server (``kea-dhcp4``).
dhcp6
**
dhcp6
**
DHCPv6 server (``kea-dhcp6``).
dhcp_ddns
**
dhcp_ddns
**
DHCP DDNS server (``kea-dhcp-ddns``).
ctrl_agent
**
ctrl_agent
**
Control Agent (``kea-ctrl-agent``).
netconf
**
netconf
**
Netconf agent (``kea-netconf``).
all
All servers
(default)
including Netconf if it was configured to be
built.
**
all
**
All servers
,
including Netconf if it was configured to be
built.
This is the default.
``-v|--version``
Prints keactrl version and quits.
Prints
the ``
keactrl
``
version and quits.
D
OCUMENTATION
=============
D
ocumentation
~~~~~~~~~~~~~
Kea comes with an extensive Kea
User's Guide documentation
that covers
Kea comes with an extensive Kea
Administrator Reference Manual
that covers
all aspects of running the Kea software - compilation, installation,
configuration, configuration examples and m
any
more. Kea also features a
configuration, configuration examples
,
and m
uch
more. Kea also features a
Kea Messages Manual, which lists all possible messages Kea can print
with a brief description for each of them. Both documents are
typically
available in various formats (txt, html, pdf) with
your
Kea
with a brief description for each of them. Both documents are
available in various formats (
.
txt,
.
html,
.
pdf) with
the
Kea
distribution. The Kea documentation is available at
https://kb.isc.org/docs/kea-administrator-reference-manual .
Kea source code is documented in the Kea Developer's Guide. Its on
-
line
Kea source code is documented in the Kea Developer's Guide. Its online
version is available at https://jenkins.isc.org/job/Kea_doc/doxygen/.
The Kea project website is available at
:
https://kea.isc.org.
The Kea project website is available at https://kea.isc.org.
M
AILING LISTS AND SUPPORT
=========================
M
ailing Lists and Support
~~~~~~~~~~~~~~~~~~~~~~~~~
There are two mailing lists available for Kea project. kea-users
(kea-users at lists.isc.org) is intended for Kea users, while kea-dev
There are two
public
mailing lists available for
the
Kea project.
**
kea-users
**
(kea-users at lists.isc.org) is intended for Kea users, while
**
kea-dev
**
(kea-dev at lists.isc.org) is intended for Kea developers, prospective
contributors and other advanced users. Both lists are available at
http://lists.isc.org. The community provides best
effort
type of
support
contributors
,
and other advanced users. Both lists are available at
http
s
://lists.isc.org. The community provides best
-
effort support
on both of those lists.
ISC provides professional support for Kea services. See
https://www.isc.org/kea/ for details.
S
EE ALSO
========
S
ee Also
~~~~~~~~
kea-dhcp4 8, kea-dhcp6 8, kea-dhcp-ddns 8, kea-ctrl-agent 8, kea-netconf
8, kea-admin 8, kea-netconf 8, perfdhcp 8, kea-lfc 8, Kea
Administrator's Guide
.
:manpage:`kea-dhcp4(8)`, :manpage:`kea-dhcp6(8)`, :manpage:`kea-dhcp-ddns(8)`,
:manpage:`kea-ctrl-agent(8)`, :manpage:`kea-admin(8)`, :manpage:`kea-netconf(8)`,
:manpage:`perfdhcp(8)`, :manpage:`kea-lfc(8)`, Kea Administrator Reference Manual
.
doc/sphinx/man/perfdhcp.8.rst
View file @
9645e67e
This diff is collapsed.
Click to expand it.
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