From: Francis Dupont Date: Wed, 2 Sep 2020 14:19:26 +0000 (+0200) Subject: [#1271] Removed obsolete .rst files X-Git-Tag: Kea-1.9.0~96 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8a1d28a539b86ec607c4eaeb4672ea5d04a29fac;p=thirdparty%2Fkea.git [#1271] Removed obsolete .rst files --- diff --git a/src/bin/admin/kea-admin.rst b/src/bin/admin/kea-admin.rst deleted file mode 100644 index 6abd175699..0000000000 --- a/src/bin/admin/kea-admin.rst +++ /dev/null @@ -1,101 +0,0 @@ -kea-admin -8 -Kea -kea-admin -Shell script for managing Kea databases -2014-2020 -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 -particular, it features database initialization, database version -checking and database schema upgrade. - -OPTIONS -======= - -``command`` - Command to be issued to the servers. It can be one of the following: - - db-init - Initializes a new database schema. This is useful - during a new Kea installation. The database is initialized to the - latest version supported by the version of the software being - installed. - - db-version - Reports the database backend version number. This - is not necessarily equal to the Kea version number as each backend - has its own versioning scheme. - - db-upgrade - Conducts a database schema upgrade. This is useful when upgrading Kea. - - lease-dump - Dumps the contents of the lease database (for MySQL, - PostgreSQL, or CQL backends) to a CSV (comma-separated values) text - file. The first line of the file contains the column names. This is - meant to be used as a diagnostic tool, so it provides a portable, - human-readable form of the lease data. - - stats-recount - Recounts lease statistics for MySQL or PostgreSQL database. - -``backend`` - Specifies 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. - -``-p|--password password`` - Specifies the password when connecting to a database. If not - 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. - -``-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 - used. - -``-o|--output output_file`` - Required for lease-dump, Specifies the file to which the lease data - will be dumped. - -``-v|--version`` - Prints kea-admin version and quits. - -``-4`` - 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 - the -4 option. - -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. diff --git a/src/bin/agent/kea-ctrl-agent.rst b/src/bin/agent/kea-ctrl-agent.rst deleted file mode 100644 index 85dd729003..0000000000 --- a/src/bin/agent/kea-ctrl-agent.rst +++ /dev/null @@ -1,97 +0,0 @@ -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 -=========== - -The ``kea-ctrl-agent`` provides a REST service for controlling Kea -services. The received HTTP requests are decapsulated and forwarded to -the respective Kea services in JSON format. Received JSON responses are -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 -========= - -The arguments are as follows: - -``-v`` - Display the version. - -``-V`` - Display the extended version. - -``-W`` - Display the configuration report. - -``-d`` - Verbose mode sets the logging level to debug. This is primarily for - development purposes in stand-alone mode. - -``-c`` - Configuration file including 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 - particular, service and client sockets are not opened, and hook - libraries are not loaded. - -DOCUMENTATION -============= - -Kea comes with an extensive Kea User's Guide documentation that covers -all aspects of running the Kea software - compilation, installation, -configuration, configuration examples and many 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 -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 -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. - -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 -(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 -on both of those lists. - -ISC provides professional support for Kea services. See -https://www.isc.org/kea/ for details. - -HISTORY -======= - -The ``kea-ctrl-agent`` was first coded in December 2016 by Marcin -Siodelski. - -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. diff --git a/src/bin/d2/kea-dhcp-ddns.rst b/src/bin/d2/kea-dhcp-ddns.rst deleted file mode 100644 index 240e1fb572..0000000000 --- a/src/bin/d2/kea-dhcp-ddns.rst +++ /dev/null @@ -1,95 +0,0 @@ -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 -=========== - -The ``kea-dhcp-ddns`` service process requests to update 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 -========= - -The arguments are as follows: - -``-v`` - Display the version. - -``-V`` - Display the extended version. - -``-W`` - Display the configuration report. - -``-d`` - Verbose mode sets the logging level to debug. 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. - -``-t`` - Check the syntax of the configuration file and report the first error - if any. Note that not all parameters are completely checked, in - particular, service socket is not opened. - -DOCUMENTATION -============= - -Kea comes with an extensive Kea User's Guide documentation that covers -all aspects of running the Kea software - compilation, installation, -configuration, configuration examples and many 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 -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 -version is available at https://jenkins.isc.org/job/Kea_doc/doxygen/. - -Kea project website is available at: https://kea.isc.org. - -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 -(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 -on both of those lists. - -ISC provides professional support for Kea services. See -https://www.isc.org/kea/ for details. - -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 -DHCP-DDNS server binary was renamed to kea-dhcp-ddns in July 2014. Kea -1.0.0 was released in December 2015. - -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. diff --git a/src/bin/dhcp4/kea-dhcp4.rst b/src/bin/dhcp4/kea-dhcp4.rst deleted file mode 100644 index 53f35e323f..0000000000 --- a/src/bin/dhcp4/kea-dhcp4.rst +++ /dev/null @@ -1,105 +0,0 @@ -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 -=========== - -The ``kea-dhcp4`` daemon provides the DHCPv4 server implementation. - -ARGUMENTS -========= - -The arguments are as follows: - -``-v`` - Display the version. - -``-V`` - Display the extended version. - -``-W`` - Display the configuration report. - -``-d`` - Enable the debug mode with extra verbosity. - -``-c`` - Configuration file including the configuration for 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, - 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 - useful for testing purposes only. - -``-P`` - Client port number (1-65535) to which the server responds. This is - useful for testing purposes only. - -DOCUMENTATION -============= - -Kea comes with an extensive Kea User's Guide documentation that covers -all aspects of running the Kea software - compilation, installation, -configuration, configuration examples and many 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 -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 -version is available at https://jenkins.isc.org/job/Kea_doc/doxygen/. - -Kea project website is available at: https://kea.isc.org. - -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 -(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 -on both of those lists. - -ISC provides professional support for Kea services. See -https://www.isc.org/kea/ for details. - -HISTORY -======= - -The ``b10-dhcp4`` daemon was first coded in November 2011 by Tomek -Mrugalski. - -In the mid 2014 Kea was decoupled from the BIND10 framework and became a -standalone DHCP server. The DHCPv4 server binary was renamed to -kea-dhcp4. Kea 1.0.0 was released in December 2015. - -SEE ALSO -======== - -kea-dhcp6 8, kea-dhcp-ddns 8, kea-ctrl-agent 8, kea-admin 8, keactrl 8, -kea-netconf 8, perfdhcp 8, kea-lfc 8, Kea Administrator's Guide. diff --git a/src/bin/dhcp6/kea-dhcp6.rst b/src/bin/dhcp6/kea-dhcp6.rst deleted file mode 100644 index 5086315f8c..0000000000 --- a/src/bin/dhcp6/kea-dhcp6.rst +++ /dev/null @@ -1,104 +0,0 @@ -kea-dhcp6 -8 -Kea -kea-dhcp6 -DHCPv6 server in Kea -2011-2019 -Internet Systems Consortium, Inc. ("ISC") -kea-dhcp6 --v --V --W --d --c -config-file --t -config-file --p -server-port-number --P -client-port-number -DESCRIPTION -=========== - -The ``kea-dhcp6`` daemon provides the DHCPv6 server implementation. - -ARGUMENTS -========= - -The arguments are as follows: - -``-v`` - Display the version. - -``-V`` - Display the extended version. - -``-W`` - Display the configuration report. - -``-d`` - Enable the debug mode with extra verbosity. - -``-c`` - Configuration file including the configuration for DHCPv6 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, - 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 - useful for testing purposes only. - -``-P`` - Client port number (1-65535) to which the server responds. This is - useful for testing purposes only. - -DOCUMENTATION -============= - -Kea comes with an extensive Kea User's Guide documentation that covers -all aspects of running the Kea software - compilation, installation, -configuration, configuration examples and many 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 -distribution. Kea user documentation is availalable on-line at -https://kb.isc.org/docs/kea-administrator-reference-manual . - -Kea source code is documented in the Kea Developer's Guide. Its on-line -version is available at https://jenkins.isc.org/job/Kea_doc/doxygen/. - -Kea project website is available at: https://kea.isc.org. - -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 -(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 -on both of those lists. - -ISC provides professional support for Kea services. See -https://www.isc.org/kea/ for details. - -HISTORY -======= - -The ``b10-dhcp6`` daemon was first coded in June 2011 by Tomek -Mrugalski. - -Kea became a standalone server and the BIND10 framework was removed. The -DHCPv6 server binary was renamed to kea-dhcp6 in July 2014. - -SEE ALSO -======== - -kea-dhcp4 8, kea-dhcp-ddns 8, kea-ctrl-agent 8, kea-admin 8, keactrl 8, -kea-netconf 8, perfdhcp 8, kea-lfc 8, Kea Administrator's Guide. diff --git a/src/bin/keactrl/keactrl.rst b/src/bin/keactrl/keactrl.rst deleted file mode 100644 index fb5b8d0332..0000000000 --- a/src/bin/keactrl/keactrl.rst +++ /dev/null @@ -1,121 +0,0 @@ -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 -reconfiguration of the Kea servers (``kea-dhcp4``, ``kea-dhcp6``, -``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. - -CONFIGURATION FILE -================== - -Depending on requirements, not all of the available servers need be run. -The keactrl configuration file sets 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 -parameters in the ``keactrl`` configuration file. - -OPTIONS -======= - -``command`` - Command to be issued to the servers. It can be one of the following: - - start - Start the servers. - - stop - Stop the servers. - - reload - Instructs the servers to re-read the kea configuration file. This - command is not supported by the Netconf agent. - - status - Print the status of the servers. - -``-c|--ctrl-config keactrl-config-file`` - Specify the ``keactrl`` configuration file. Without this switch, the - ``keactrl`` will attempt to use the file - ``[kea-install-dir]/etc/kea/keactrl.conf``. - -``-s|--server server[,server,...]`` - Specifies a subset of the enabled servers to which the command should - be issued. The list of servers should be separated by commas with no - intervening spaces. Acceptable values are: - - dhcp4 - DHCPv4 server (``kea-dhcp4``). - - dhcp6 - DHCPv6 server (``kea-dhcp6``). - - dhcp_ddns - DHCP DDNS server (``kea-dhcp-ddns``). - - ctrl_agent - Control Agent (``kea-ctrl-agent``). - - netconf - Netconf agent (``kea-netconf``). - - all - All servers (default) including Netconf if it was configured to be - built. - -``-v|--version`` - Prints keactrl version and quits. - -DOCUMENTATION -============= - -Kea comes with an extensive Kea User's Guide documentation that covers -all aspects of running the Kea software - compilation, installation, -configuration, configuration examples and many 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 -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 -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 mailing lists available for 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 -on both of those lists. - -ISC provides professional support for Kea services. See -https://www.isc.org/kea/ for details. - -SEE 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. diff --git a/src/bin/lfc/kea-lfc.rst b/src/bin/lfc/kea-lfc.rst deleted file mode 100644 index 1a99c24a9d..0000000000 --- a/src/bin/lfc/kea-lfc.rst +++ /dev/null @@ -1,138 +0,0 @@ -kea-lfc -8 -Kea -kea-lfc -Lease File Cleanup process in Kea -2015-2018 -Internet Systems Consortium, Inc. ("ISC") -kea-lfc --4|-6 --c -config-file --p -pid-file --x -previous-file --i -copy-file --o -output-file --f -finish-file --v --V --W --d --h -DESCRIPTION -=========== - -The ``kea-lfc`` service process removes redundant information from the -files used to provide persistent storage for the memfile data base -backend. The service is written to run as a stand alone process. While -it can be started externally, there is usually no need to do this. It -will be run on a periodic basis by the Kea DHCP servers. - -ARGUMENTS -========= - -The arguments are as follows: - -``-d`` - Verbose mode sets the logging level to debug. This is primarily for - development purposes in stand-alone mode. - -``-v`` - version causes the version stamp to be printed. - -``-V`` - Version causes a longer form of the version stamp to be printed. - -``-W`` - Display the configuration report. - -``-h`` - Help causes the usage string to be printed. - -``-4 | -6`` - The protocol version of the lease files, must be one of 4 or 6. - -``-c`` - Configuration file including the configuration for ``kea-lfc`` - process. It may also contain configuration entries for other Kea - services. Currently ``kea-lfc`` gets all of its arguments from the - command line, in the future it will be extended to get some arguments - from the config file. - -``-p`` - PID file - When the ``kea-lfc`` process starts it attempts to - determine if another instance of the process is already running by - examining the pid file. If one is already running the new process is - terminated. If one isn't running it writes its pid into the pid file. - -``-x`` - Previous or ex lease file - When ``kea-lfc`` starts this is the - result of any previous run of ``kea-lfc``. When ``kea-lfc`` finishes - it is the result of this run. If ``kea-lfc`` is interrupted before - completing, this file may not exist. - -``-i`` - Input or copy of lease file - Before the DHCP server invokes - ``kea-lfc`` it will move the current lease file here and then call - ``kea-lfc`` with this file. - -``-o`` - Output lease file - The temporary file ``kea-lfc`` should use to - write the leases. Upon completion of writing this this file it will - be moved to the finish file (see below). - -``-f`` - Finish or completion file - Another temporary file ``kea-lfc`` uses - for bookkeeping. When ``kea-lfc`` completes writing the output file - it moves it to this file name. After ``kea-lfc`` finishes deleting - the other files (previous and input) it moves this file to previous - lease file. By moving the files in this fashion the ``kea-lfc`` and - the DHCP server processes can determine the correct file to use even - if one of the processes was interrupted before completing its task. - -DOCUMENTATION -============= - -Kea comes with an extensive Kea User's Guide documentation that covers -all aspects of running the Kea software - compilation, installation, -configuration, configuration examples and many 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 -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 -version is available at https://jenkins.isc.org/job/Kea_doc/doxygen/. - -Kea project website is available at: https://kea.isc.org. - -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 -(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 -on both of those lists. - -ISC provides professional support for Kea services. See -https://www.isc.org/kea/ for details. - -HISTORY -======= - -The ``kea-lfc`` process was first coded in January 2015 by the ISC -Kea/DHCP team. - -SEE ALSO -======== - -kea-dhcp4 8, kea-dhcp6 8, kea-dhcp-ddns 8, kea-ctrl-agent 8, kea-admin -8, kea-netconf 8, keactrl 8, perfdhcp 8, Kea Administrator's Guide. diff --git a/src/bin/netconf/kea-netconf.rst b/src/bin/netconf/kea-netconf.rst deleted file mode 100644 index 9ab690c2ff..0000000000 --- a/src/bin/netconf/kea-netconf.rst +++ /dev/null @@ -1,92 +0,0 @@ -kea-netconf -8 -Kea -kea-netconf -NETCONF agent for Kea environment -2018 -Internet Systems Consortium, Inc. ("ISC") -kea-netconf --v --V --W --d --c -config-file --t -config-file -DESCRIPTION -=========== - -The ``kea-netconf`` agent provides a YANG/NETCONF interface for the Kea -environment. - -ARGUMENTS -========= - -The arguments are as follows: - -``-v`` - Display the version. - -``-V`` - Display the extended version. - -``-W`` - Display the configuration report. - -``-d`` - Enable the debug mode with extra verbosity. - -``-c`` - Configuration file including the configuration for NETCONF agent. - -``-t`` - Check the syntax of the configuration file and report 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 -============= - -Kea comes with an extensive Kea User's Guide documentation that covers -all aspects of running the Kea software - compilation, installation, -configuration, configuration examples and many 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 -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 -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. - -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 -(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 -on both of those lists. - -ISC provides professional support for Kea services. See -https://www.isc.org/kea/ for details. - -HISTORY -======= - -Early prototypes of kea-netconf implementation were written during IETF -Hackathons in Berlin, London and Montreal. An actual production ready -implementation was started in August 2018 by Tomek Mrugalski and Francis -Dupont. - -SEE ALSO -======== - -kea-dhcp4 8, kea-dhcp6 8, kea-dhcp-ddns 8, kea-ctrl-agent 8, kea-admin -8, keactrl 8, perfdhcp 8, kea-lfc 8, Kea Administrator's Guide. diff --git a/src/bin/perfdhcp/perfdhcp.rst b/src/bin/perfdhcp/perfdhcp.rst deleted file mode 100644 index 90150b3fb8..0000000000 --- a/src/bin/perfdhcp/perfdhcp.rst +++ /dev/null @@ -1,504 +0,0 @@ -perfdhcp -8 -Kea -perfdhcp -DHCP benchmarking tool -2016-2018 -Internet Systems Consortium, Inc. ("ISC") -perfdhcp --1 --4|-6 --A -encapsulation-level --b -base --B --c --d -drop-time --D -max-drop --e -lease-type --E -time-offset --f -renew-rate --F -release-rate --g -thread-mode --h --i --I -ip-offset --l -local-address|interface --L -local-port --M -mac-list-file --n -num-request --N -remote-port --O -random-offset --o -code,hexstring --p -test-period --P -preload --r -rate --R -num-clients --s -seed --S -srvid-offset --t -report --T -template-file --v --W -exit-wait-time --w -wrapped --x -diagnostic-selector --X -xid-offset -server -DESCRIPTION -=========== - -``perfdhcp`` is a DHCP benchmarking tool. It provides a way of measuring -the performance of DHCP servers by generating large amounts of traffic -from simulated multiple clients. It is able to test both IPv4 and IPv6 -servers, and provides statistics concerning response times and the -number of requests that are dropped. - -By default, tests are run using the full four-packet exchange sequence -(DORA for DHCPv4, SARR for DHCPv6). An option is provided to run tests -using the initial two-packet exchange (DO and SA) instead. It is also -possible to configure perfdhcp to send DHCPv6 RENEW and RELEASE messages -at a specified rate in parallel with the DHCPv6 four-way exchanges. - -When running a performance test, ``perfdhcp`` will exchange packets with -the server under test as fast as possible unless the ``-r`` is given to -limit the request rate. The length of the test can be limited by setting -a threshold on any or all of the number of requests made by -``perfdhcp``, the elapsed time, or the number of requests dropped by the -server. - -TEMPLATES -========= - -To allow the contents of packets sent to the server to be customized, -``perfdhcp`` allows the specification of template files that determine -the contents of the packets. For example, the customized packet may -contain a DHCPv6 ORO to request a set of options to be returned by the -server, or it may contain the Client FQDN option to request that server -performs DNS updates. This may be used to discover performance -bottlenecks for different server configurations (e.g. DDNS enabled or -disabled). - -Up to two template files can be specified on the command line, each file -representing the contents of a particular type of packet, the type being -determined by the test being carried out. For example, if testing -DHCPv6: - -- With no template files specified on the command line, ``perfdhcp`` - will generate both SOLICIT and REQUEST packets. - -- With one template file specified, that file will be used as the - pattern for SOLICIT packets: ``perfdhcp`` will generate the REQUEST - packets. - -- With two template files given on the command line, the first will be - used as the pattern for SOLICIT packets, the second as the pattern - for REQUEST packets. - -(Similar determination applies to DHCPv4's DISCOVER and REQUEST -packets.) - -The template file holds the DHCP packet represented as a stream of ASCII -hexadecimal digits and it excludes any IP/UDP stack headers. The -template file must not contain any characters other than hexadecimal -digits and spaces. Spaces are discarded when the template file is parsed -(so in the file, '12B4' is the same as '12 B4' which is the same as '1 2 -B 4') - -The template files should be used in conjunction with the command line -parameters which specify offsets of the data fields being modified in -outbound packets. For example, the ``-E - time-offset`` switch specifies the offset of the DHCPv6 -Elapsed Time option in the packet template. If the offset is specified, -perfdhcp will inject the current elapsed time value into this field -before sending the packet to the server. - -In many scenarios, ``perfdhcp`` needs to simulate multiple clients -(having unique client identifier). Since packets for each client are -generated from the same template file, it is necessary to randomize the -client identifier (or HW address in DHCPv4) in the packet created from -it. The ``-O - random-offset`` option allows specification of the offset in -the template where randomization should be performed. It is important to -note that this offset points to the end (not the beginning) of the -client identifier (or HW address field). The number of bytes being -randomized depends on the number of simulated clients. If the number of -simulated clients is between 1 and 255, only one byte (to which -randomization offset points) will be randomized. If the number of -simulated clients is between 256 and 65535, two bytes will be -randomized. Note, that two last bytes of the client identifier will be -randomized in this case: the byte which randomization offset parameter -points to, and the one which precedes it (random-offset - 1). If the -number of simulated clients exceeds 65535, three bytes will be -randomized; and so on. - -Templates may be currently used to generate packets being sent to the -server in 4-way exchanges, i.e. SOLICIT, REQUEST (DHCPv6) and DISCOVER, -REQUEST (DHCPv4). They cannot be used when RENEW or RELEASE packets are -being sent. - -OPTIONS -======= - -``-1`` - Take the server-ID option from the first received message. - -``-4`` - DHCPv4 operation; this is the default. It is incompatible with the - ``-6`` option. - -``-6`` - DHCPv6 operation. This is incompatible with the ``-4`` option. - -``-b basetype=value`` - The base MAC or DUID used to simulate different clients. The basetype - may be "mac" or "duid". (The keyword "ether" may alternatively used - for MAC.) The ``-b`` option can be specified multiple times. The MAC - address must consist of six octets separated by single (:) or double - (::) colons, for example: mac=00:0c:01:02:03:04. The DUID value is a - hexadecimal string: it must be at least six octets long and must not - be longer than 64 bytes and the length must be less than 128 - hexadecimal digits, for example: duid=0101010101010101010110111F14. - -``-d drop-time`` - Specify the time after which a request is treated as having been - lost. The value is given in seconds and may contain a fractional - component. The default is 1 second. - -``-e lease-type`` - Specifies the type of lease being requested from the server. It may - be one of the following: - - address-only - Only regular addresses (v4 or v6) will be requested. - - prefix-only - Only IPv6 prefixes will be requested. - - address-and-prefix - Both IPv6 addresses and prefixes will be requested. - - The ``-e prefix-only`` and ``-e - address-and-prefix`` forms may not be used - with the ``-4`` option. - -``-f renew-rate`` - Rate at which DHCPv4 or DHCPv6 renew requests are sent to a server. - This value is only valid when used in conjunction with the exchange - rate (given by ``-r rate``). Furthermore the sum of this value and - the release-rate (given by ``-F - rate``) must be equal to or less than the - exchange rate. - -``-g thread-mode`` - thread-mode can be either 'single' or 'multi'. In multi-thread mode - packets are received in separate thread. This allows better - utilisation of CPUs. In single CPU system it is better to run in 1 - thread to avoid blocking of threads each other. If more than 1 CPU is - present in the system then multi-thread mode is default otherwise - single-thread is default. - -``-h`` - Print help and exit. - -``-i`` - Do only the initial part of the exchange: DISCOVER-OFFER if ``-4`` is - selected, SOLICIT-ADVERTISE if ``-6`` is chosen. - - ``-i`` is incompatible with the following options: ``-1``, ``-d``, - ``-D``, ``-E``, ``-S``, ``-I`` and ``-F``. In addition, it cannot be - used with multiple instances of ``-O``, ``-T`` and ``-X``. - -``-l local-addr|interface`` - For DHCPv4 operation, specify the local hostname/address to use when - communicating with the server. By default, the interface address - through which traffic would normally be routed to the server is used. - For DHCPv6 operation, specify the name of the network interface - through which exchanges are initiated. - -``-L local-port`` - Specify the local port to use. This must be zero or a positive - integer up to 65535. A value of 0 (the default) allows ``perfdhcp`` - to choose its own port. - -``-M mac-list-file`` - A text file containing a list of MAC addresses, one per line. If - provided, a MAC address will be chosen randomly from this list for - every new exchange. In the DHCPv6 case, MAC addresses are used to - generate DUID-LLs. This parameter must not be used in conjunction - with the -b parameter. - -``-N remote-port`` - Specify the remote port to use. This must be zero or a positive - integer up to 65535. A value of 0 (the default) allows ``perfdhcp`` - to choose the standard service port. - -``-o code,hexstring`` - This forces perfdhcp to insert specified extra option (or options if - used several times) into packets being transmitted. The code - specifies option code and the hexstring is a hexadecimal string that - defines the content of the option. Care should be taken as perfdhcp - does not offer any kind of logic behind those options. They're simply - inserted into packets being sent as is. Be careful not to insert - options that are already inserted. For example, to insert client - class identifier (option code 60) with a string 'docsis', you can use - -o 60,646f63736973. The ``-o`` may be used multiple times. It is - necessary to specify protocol family (either ``-4`` or ``-6``) before - using ``-o``. - -``-P preload`` - Initiate preload exchanges back to back at startup. preload must be 0 - (the default) or a positive integer. - -``-r rate`` - Initiate rate DORA/SARR (or if ``-i`` is given, DO/SA) exchanges per - second. A periodic report is generated showing the number of - exchanges which were not completed, as well as the average response - latency. The program continues until interrupted, at which point a - final report is generated. - -``-R num-clients`` - Specify how many different clients are used. With a value of 1 (the - default), all requests seem to come from the same client. num-clients - must be a positive number. - -``-s seed`` - Specify the seed for randomization, making runs of ``perfdhcp`` - repeatable. seed is 0 or a positive integer. The value 0 means that a - seed is not used; this is the default. - -``-T template-file`` - The name of a file containing the template to use as a stream of - hexadecimal digits. This may be specified up to two times and - controls the contents of the packets sent (see the "TEMPLATES" - section above). - -``-v`` - Print the version of this program. - -``-W exit-wait-time`` - Specifies exit-wait-time parameter, that makes perfdhcp wait for - exit-wait-time us after an exit condition has been met to receive all - packets without sending any new packets. Expressed in microseconds. - If not specified, 0 is used (i.e. exit immediately after exit - conditions are met). - -``-w wrapped`` - Command to call with a single parameter of "start" or "stop" at the - beginning/end of the program. - -``-x diagnostic-selector`` - Include extended diagnostics in the output. diagnostic-selector is a - string of single-keywords specifying the operations for which verbose - output is desired. The selector key letters are: - - a - Print the decoded command line arguments. - - e - Print the exit reason. - - i - Print rate processing details. - - s - Print the first server-ID. - - t - When finished, print timers of all successful exchanges. - - T - When finished, print templates - -DHCPv4-Only Options -------------------- - -The following options only apply for DHCPv4 (i.e. when ``-4`` is given). - -``-B`` - Force broadcast handling. - -DHCPv6-Only Options -------------------- - -The following options only apply for DHCPv6 (i.e. when ``-6`` is given). - -``-c`` - Add a rapid commit option (exchanges will be SOLICIT-ADVERTISE). - -``-F release-rate`` - Rate at which IPv6 RELEASE requests are sent to a server. This value - is only valid when used in conjunction with the exchange rate (given - by ``-r rate``). Furthermore the sum of this value and the renew-rate - (given by ``-f rate``) must be equal to or less than the exchange - rate. - -``-A encapsulation-level`` - Specifies that relayed traffic must be generated. The argument - specifies the level of encapsulation, i.e. how many relay agents are - simulated. Currently the only supported encapsulation-level value is - 1, which means that the generated traffic is an equivalent of the - traffic passing through a single relay agent. - -Template-Related Options ------------------------- - -The following options may only be used in conjunction with ``-T`` and -control how ``perfdhcp`` modifies the template. The options may be -specified multiple times on the command line; each occurrence affects -the corresponding template file (see "TEMPLATES" above). - --E -time-offset -Offset of the (DHCPv4) secs field or (DHCPv6) elapsed-time option in the -(second i.e. REQUEST) template and must be 0 or a positive integer: a -value of 0 disables this. - --I -ip-offset -Offset of the (DHCPv4) IP address in the requested-IP option / (DHCPv6) -IA_NA option in the (second/request) template. - --O -random-offset -Offset of the last octet to randomize in the template. random-offset -must be an integer greater than 3. The ``-T`` switch must be given to -use this option. - --S -srvid-offset -Offset of the server-ID option in the (second/request) template. -srvid-offset must be a positive integer, and the switch can only be used -when the template option (``-T``) is also given. - --X -xid-offset -Offset of the transaction ID (xid) in the template. xid-offset must be a -positive integer, and the switch can only be used when the template -option (``-T``) is also given. - -Options Controlling a Test --------------------------- - -``-D max-drop`` - Abort the test immediately if max-drop requests have been dropped. - Use ``-D - 0`` to abort if even a single request has - been dropped. max-drop must be a positive integer. If max-drop - includes the suffix '%', it specifies a maximum percentage of - requests that may be dropped before abort. In this case, testing of - the threshold begins after 10 requests have been expected to be - received. - -``-n num-requests`` - Initiate num-request transactions. No report is generated until all - transactions have been initiated/waited-for, after which a report is - generated and the program terminates. - -``-p test-period`` - Send requests for test-period, which is specified in the same manner - as ``-d``. This can be used as an alternative to ``-n``, or both - options can be given, in which case the testing is completed when - either limit is reached. - -``-t interval`` - Sets the delay (in seconds) between two successive reports. - -Arguments ---------- - -server - Server to test, specified as an IP address. In the DHCPv6 case, the - special name 'all' can be used to refer to - All_DHCP_Relay_Agents_and_Servers (the multicast address FF02::1:2), - or the special name 'servers' to refer to All_DHCP_Servers (the - multicast address FF05::1:3). The server is mandatory except where - the ``-l`` option is given to specify an interface, in which case it - defaults to 'all'. - -ERRORS -====== - -``perfdhcp`` can report the following errors in the packet exchange: - -tooshort - A message was received that was too short. - -orphans - Received a message which doesn't match one sent to the server (i.e. - it is a duplicate message, a message that has arrived after an - excessive delay, or one that is just not recognized). - -locallimit - Reached local system limits when sending a message. - -EXIT STATUS -=========== - -``perfdhcp`` can exit with one of the following status codes: - -0 - Success. - -1 - General error. - -2 - Error in command-line arguments. - -3 - No general failures in operation, but one or more exchanges were - unsuccessful. - -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 -(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 -on both of those lists. - -ISC provides professional support for Kea services. See -https://www.isc.org/kea/ for details. - -HISTORY -======= - -The ``perfdhcp`` tool was initially coded in October 2011 by John -DuBois, Francis Dupont and Marcin Siodelski of ISC. Kea 1.0.0 that -included perfdhcp was released in December 2015. - -SEE ALSO -======== - -kea-dhcp4 8, kea-dhcp6 8, kea-dhcp-ddns 8, kea-ctrl-agent 8, kea-admin -8, kea-netconf 8, keactrl 8, kea-lfc 8, Kea Administrator's Guide. diff --git a/src/bin/shell/kea-shell.rst b/src/bin/shell/kea-shell.rst deleted file mode 100644 index b10483f97e..0000000000 --- a/src/bin/shell/kea-shell.rst +++ /dev/null @@ -1,113 +0,0 @@ -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 ---auth-user ---auth-password ---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 it sent of HTTP and a response is -retrieved. That response is displayed out on the standard output. - -ARGUMENTS -========= - -The arguments are as follows: - -``-h`` - Displays help regarding command line parameters. - -``-v`` - Display the version. - -``--host`` - Specifies the host to connect to. Control Agent must be running at - 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. - -``--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 - parameter is useful only with a reverse proxy. - -``--auth-user`` - Specifies the user id for basic HTTP authentication. If not specified - or specified as the empty string authentication is not used. - -``--auth-password`` - Specifies the password for basic HTTP authentication. If not specified - but the user id is specified an empty password is used. - -``--timeout`` - Specifies the connection timeout in seconds. If not specified, 10 - (seconds) is used. - -``--service`` - Specifies the service that is the target of a command. If not - specified, Control Agent will be targeted. May be used more than once - to specify multiple targets. - -``command`` - Specifies the command to be sent to CA. If not specified, - "list-commands" is used. - -DOCUMENTATION -============= - -Kea comes with an extensive Kea User's Guide documentation that covers -all aspects of running the Kea software - compilation, installation, -configuration, configuration examples and many 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 -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 -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. - -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 -(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 -on both of those lists. - -ISC provides professional support for Kea services. See -https://www.isc.org/kea/ for details. - -HISTORY -======= - -The ``kea-shell`` was first coded in March 2017 by Tomek Mrugalski. - -SEE 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.