Commit 3f38c867 authored by Suzanne Goldlust's avatar Suzanne Goldlust Committed by Michal Nowikowski
Browse files

Text edits and formatting changes for Docbook-to-Sphinx conversion

parent 0b325593
:orphan:
kea-admin
8
Kea
kea-admin
Shell script for managing Kea databases
2014-2018
Internet Systems Consortium, Inc. ("ISC")
kea-admin
command
backend
-u
database username
-p
database password
-n
database name
-d
scripts directory
-4 \| -6
-o
output file
-v
DESCRIPTION
===========
kea-admin is a shell script which offers database maintenance. In
..
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-admin:
kea-admin - Shell script for managing Kea databases
---------------------------------------------------
Synopsis
~~~~~~~~
:program:`kea-admin` [command] [backend] [**-u** database username] [**-p** database password] [**-n** database name] [**-d** scripts directory] [**-4** | **-6**] [**-o** output file] [**-v**]
Description
~~~~~~~~~~~
``kea-admin`` is a shell script which offers database maintenance. In
particular, it features database initialization, database version
checking and database schema upgrade.
checking, and database schema upgrade.
OPTIONS
=======
Arguments
~~~~~~~~~
``command``
Command to be issued to the servers. It can be one of the following:
Specifies the command to be issued to the servers. It can be one of the following:
lease-init
Initializes a new lease database. Useful during first Kea
**lease-init**
Initializes a new lease database, which is useful during the first Kea
installation. The database is initialized to the latest version
supported by the version of the software.
lease-version
Reports lease database version. This is not necessarily equal to
Kea version as each backend has its own versioning scheme.
**lease-version**
Reports the lease database version. This is not necessarily the same as the
Kea version, as each backend has its own versioning scheme.
lease-upgrade
Conducts lease database upgrade. This is useful when migrating
**lease-upgrade**
Conducts a lease database upgrade. This is useful when migrating
between old and new Kea versions.
lease-dump
**lease-dump**
Dumps the contents of the lease database (MySQL and PostgreSQL
backends) to text file. The content of the file consists of
comma-separated-values (CSV) where each line in the file contains
all of the values for a single lease. The first line of file is a
backends) to a text file. The content of the file consists of
comma-separated values (CSV) where each line in the file contains
all of the values for a single lease. The first line of the file is a
header line containing the column names.
``backend``
Specifies backend type. Currently allowed backends are: memfile,
mysql and pgsql.
Specifies the backend type. Currently allowed backends are: memfile,
mysql, and pgsql.
``-u|--user username``
Specify the username when connecting to a database. If not specified,
the default value of keatest is used.
Specifies the username when connecting to a database. If not specified,
the default value of **keatest** is used.
``-p|--password password``
Specifies the password when connecting to a database. If not
specified, the default value of keatest is used.
specified, the default value of **keatest** is used.
``-n|--name database-name``
Specifies the database name to connect to. If not specified, the
default value of keatest is used.
Specifies the name of the database to connect to. If not specified, the
default value of **keatest** is used.
``-d|--directory script-directory``
Used for override scripts directory. That script is used during
upgrades, database initialization and possibly other operations. If
not specified, the default value of (prefix)/share/kea/scripts/ is
Specifies the override scripts directory. That script is used during
upgrades, database initialization, and possibly other operations. If
not specified, the default value of ``(prefix)/share/kea/scripts/`` is
used.
``-o|--output output_file``
Required for lease-dump, Specifies the file to which the lease data
will be dumped.
Specifies the file to which the lease data will be dumped. Required for lease-dump.
``-v|--version``
Prints kea-admin version and quits.
Prints the ``kea-admin`` version and quits.
``-4``
Directs kea-admin to lease-dump the DHCPv4 leases. Incompatible with
Directs ``kea-admin`` to lease-dump the DHCPv4 leases. Incompatible with
the -6 option.
``-6``
Directs kea-admin to lease-dump the DHCPv6 leases. Incompatible with
Directs ``kea-admin`` to lease-dump the DHCPv6 leases. Incompatible with
the -4 option.
SEE ALSO
========
Documentation
~~~~~~~~~~~~~
Kea comes with an extensive Kea Administrator Reference Manual that covers
all aspects of running the Kea software - compilation, installation,
configuration, configuration examples, and much 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
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 online
version is available at https://jenkins.isc.org/job/Kea_doc/doxygen/.
The Kea project website is available at https://kea.isc.org.
Mailing Lists and Support
~~~~~~~~~~~~~~~~~~~~~~~~~
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
https://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.
See Also
~~~~~~~~
keactrl 8, kea-dhcp4 8, kea-dhcp6 8, kea-dhcp-ddns 8, kea-ctrl-agent 8,
kea-netconf 8, keactrl 8, perfdhcp 8, Kea Administrator Guide.
:manpage:`kea-dhcp4(8)`, :manpage:`kea-dhcp6(8)`,
:manpage:`kea-dhcp-ddns(8)`, :manpage:`kea-ctrl-agent(8)`, :manpage:`keactrl(8)`,
:manpage:`perfdhcp(8)`, :manpage:`kea-netconf(8)`, Kea Administrator Reference Manual.
:orphan:
kea-ctrl-agent
8
Kea
kea-ctrl-agent
Control Agent process in Kea
2016-2018
Internet Systems Consortium, Inc. ("ISC")
kea-ctrl-agent
-v
-V
-W
-d
-c
config-file
-t
config-file
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-ctrl-agent:
kea-ctrl-agent - Control Agent process in Kea
---------------------------------------------
Synopsis
~~~~~~~~
:program:`kea-ctrl-agent` [**-v**] [**-V**] [**-W**] [**-d**] [**-c** config-file] [**-t** config-file]
Description
~~~~~~~~~~~
The ``kea-ctrl-agent`` provides a REST service for controlling Kea
services. The received HTTP requests are decapsulated and forwarded to
......@@ -26,74 +30,74 @@ encapsulated within HTTP responses and returned to the controlling
entity. Some commands may be handled by the Control Agent directly, and
not forwarded to any Kea service.
ARGUMENTS
=========
Arguments
~~~~~~~~~
The arguments are as follows:
``-v``
Display the version.
Displays the version.
``-V``
Display the extended version.
Displays the extended version.
``-W``
Display the configuration report.
Displays the configuration report.
``-d``
Verbose mode sets the logging level to debug. This is primarily for
Sets the logging level to debug with extra verbosity. This is primarily for
development purposes in stand-alone mode.
``-c``
Configuration file including the configuration for the Control Agent
``-c config-file``
Specifies the file with the configuration for the Control Agent
server. It may also contain configuration entries for other Kea
services.
``-t``
Check the syntax of the configuration file and report the first error
if any. Note that not all parameters are completely checked, in
``-t config-file``
Checks the syntax of the configuration file and reports the first error,
if any. Note that not all parameters are completely checked; in
particular, service and client sockets are not opened, and hook
libraries are not loaded.
DOCUMENTATION
=============
Documentation
~~~~~~~~~~~~~
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 many more. Kea also features a
configuration, configuration examples, and much 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.
MAILING LISTS AND SUPPORT
=========================
Mailing 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
https://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.
HISTORY
=======
History
~~~~~~~
The ``kea-ctrl-agent`` was first coded in December 2016 by Marcin
Siodelski.
SEE ALSO
========
See Also
~~~~~~~~
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-admin(8)`, :manpage:`keactrl(8)`,
:manpage:`perfdhcp(8)`, :manpage:`kea-lfc(8)`, Kea Administrator Reference Manual.
:orphan:
kea-dhcp-ddns
8
Kea
kea-dhcp-ddns
DHCP-DDNS process in Kea
2013-2018
Internet Systems Consortium, Inc. ("ISC")
kea-dhcp-ddns
-v
-V
-W
-d
-c
config-file
-t
config-file
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-dhcp-ddns:
kea-dhcp-ddns - DHCP-DDNS process in Kea
----------------------------------------
Synopsis
~~~~~~~~
:program:`kea-dhcp-ddns` [**-v**] [**-V**] [**-W**] [**-d**] [**-c** config-file] [**-t** config-file]
Description
===========
The ``kea-dhcp-ddns`` service process requests to update DNS mapping
The ``kea-dhcp-ddns`` service process requests an update of DNS mapping
based on DHCP lease change events. It runs as a separate process that
expects to receive Name Change Requests from Kea DHCP servers.
ARGUMENTS
=========
Arguments
~~~~~~~~~
The arguments are as follows:
``-v``
Display the version.
Displays the version.
``-V``
Display the extended version.
Displays the extended version.
``-W``
Display the configuration report.
Displays the configuration report.
``-d``
Verbose mode sets the logging level to debug. This is primarily for
Sets the logging level to debug with extra verbosity. This is primarily for
development purposes in stand-alone mode.
``-c``
Configuration file including the configuration for DHCP-DDNS server.
It may also contain configuration entries for other Kea services.
``-c config-file``
Specifies the configuration file with the configuration for the DHCP-DDNS server. It
may also contain configuration entries for other Kea services.
``-t``
Check the syntax of the configuration file and report the first error
``-t config-file``
Checks the syntax of the configuration file and reports the first error
if any. Note that not all parameters are completely checked, in
particular, service socket is not opened.
DOCUMENTATION
=============
Documentation
~~~~~~~~~~~~~
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 many more. Kea also features a
configuration, configuration examples, and much 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://kea.isc.org.
The Kea project website is available at https://kea.isc.org.
MAILING LISTS AND SUPPORT
=========================
Mailing 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
https://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.
HISTORY
=======
History
~~~~~~~
The ``b10-dhcp-ddns`` process was first coded in May 2013 by Thomas
Markwalder.
Kea became a standalone server and the BIND10 framework was removed. The
Kea became a standalone server and the BIND 10 framework was removed. The
DHCP-DDNS server binary was renamed to kea-dhcp-ddns in July 2014. Kea
1.0.0 was released in December 2015.
SEE ALSO
========
See Also
~~~~~~~~
kea-dhcp4 8, kea-dhcp6 8, kea-ctrl-agent 8, kea-admin 8, keactrl 8,
kea-netconf 8, perfdhcp 8, kea-lfc 8, Kea Administrator's Guide.
:manpage:`kea-dhcp4(8)`, :manpage:`kea-dhcp6(8)`,
:manpage:`kea-ctrl-agent(8)`, :manpage:`kea-admin(8)`, :manpage:`keactrl(8)`,
:manpage:`perfdhcp(8)`, :manpage:`kea-netconf(8)`, :manpage:`kea-lfc(8)`,
Kea Administrator Reference Manual.
:orphan:
kea-dhcp4
8
Kea
kea-dhcp4
DHCPv4 server in Kea
2011-2018
Internet Systems Consortium, Inc. ("ISC")
kea-dhcp4
-v
-V
-W
-d
-c
config-file
-t
config-file
-p
server-port-number
-P
client-port-number
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-dhcp4:
kea-dhcp4 - DHCPv4 server in Kea
--------------------------------
Synopsis
~~~~~~~~
:program:`kea-dhcp4` [**-v**] [**-V**] [**-W**] [**-d**] [**-c** config-file] [**-t** config-file] [**-p** server-port-number] [**-P** client-port-number]
Description
~~~~~~~~~~~
The ``kea-dhcp4`` daemon provides the DHCPv4 server implementation.
ARGUMENTS
=========
Arguments
~~~~~~~~~
The arguments are as follows:
``-v``
Display the version.
Displays the version.
``-V``
Display the extended version.
Displays the extended version.
``-W``
Display the configuration report.
Displays the configuration report.
``-d``
Enable the debug mode with extra verbosity.
Enables the debug mode with extra verbosity.
``-c``
Configuration file including the configuration for DHCPv4 server. It
``-c config-file``
Specifies the configuration file with the configuration for the DHCPv4 server. It
may also contain configuration entries for other Kea services.
``-t``
Check the configuration file and report the first error if any. Note
that not all parameters are completely checked, in particular,
``-t config-file``
Checks the configuration file and reports the first error, if any. Note
that not all parameters are completely checked; in particular,
service and control channel sockets are not opened, and hook
libraries are not loaded.
``-p``
Server port number (1-65535) on which the server listens. This is
``-p server-port-number``
Specifies the server port number (1-65535) on which the server listens. This is
useful for testing purposes only.
``-P``
Client port number (1-65535) to which the server responds. This is
``-P client-port-number``
Specifies the client port number (1-65535) to which the server responds. This is
useful for testing purposes only.
DOCUMENTATION
=============
Documentation
~~~~~~~~~~~~~
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 many more. Kea also features a
configuration, configuration examples, and much 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://kea.isc.org.
The Kea project website is available at https://kea.isc.org.
MAILING LISTS AND SUPPORT
=========================
Mailing 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
https://lists.isc.org. The community provides best-effort support
on both of those lists.
ISC provides professional support for Kea services. See