]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[master] removed invalid characters from docs
authorWlodek Wencel <wlodek@isc.org>
Thu, 14 Jun 2018 17:54:50 +0000 (19:54 +0200)
committerWlodek Wencel <wlodek@isc.org>
Thu, 14 Jun 2018 17:54:50 +0000 (19:54 +0200)
doc/guide/hooks.xml
doc/guide/logging.xml

index ae7053aea8996d938e27570d858bb0bb7a13eb55..dd2177d25349b769ef333243b636710988706e88 100644 (file)
@@ -351,8 +351,8 @@ $ <userinput>ls -l /usr/local/lib/hooks/*.so</userinput>
               <entry>Kea 0.8</entry>
               <entry>
                 <simplelist>
-                  <member>kea-&#xFEFF;dhcp4</member>
-                  <member>kea-&#xFEFF;dhcp6</member>
+                  <member>kea-dhcp4</member>
+                  <member>kea-dhcp6</member>
                 </simplelist>
               </entry>
               <entry>Reads known users list from a file. Unknown users
@@ -369,8 +369,8 @@ $ <userinput>ls -l /usr/local/lib/hooks/*.so</userinput>
               <entry>Kea 1.1.0</entry>
               <entry>
                 <simplelist>
-                  <member>kea-&#xFEFF;dhcp4</member>
-                  <member>kea-&#xFEFF;dhcp6</member>
+                  <member>kea-dhcp4</member>
+                  <member>kea-dhcp6</member>
                 </simplelist>
               </entry>
               <entry>This library provides hooks that record a detailed log of
@@ -389,8 +389,8 @@ $ <userinput>ls -l /usr/local/lib/hooks/*.so</userinput>
               <entry>Kea 1.2.0</entry>
               <entry>
                 <simplelist>
-                  <member>kea-&#xFEFF;dhcp4</member>
-                  <member>kea-&#xFEFF;dhcp6</member>
+                  <member>kea-dhcp4</member>
+                  <member>kea-dhcp6</member>
                 </simplelist>
               </entry>
               <entry>Kea software provides a way to handle host reservations
@@ -415,8 +415,8 @@ $ <userinput>ls -l /usr/local/lib/hooks/*.so</userinput>
               <entry>Kea 1.2.0</entry>
               <entry>
                 <simplelist>
-                  <member>kea-&#xFEFF;dhcp4</member>
-                  <member>kea-&#xFEFF;dhcp6</member>
+                  <member>kea-dhcp4</member>
+                  <member>kea-dhcp6</member>
                 </simplelist>
               </entry>
               <entry>Kea provides a way to store host reservations in a
@@ -438,8 +438,8 @@ $ <userinput>ls -l /usr/local/lib/hooks/*.so</userinput>
               <entry>Kea 1.3.0</entry>
               <entry>
                 <simplelist>
-                  <member>kea-&#xFEFF;dhcp4</member>
-                  <member>kea-&#xFEFF;dhcp6</member>
+                  <member>kea-dhcp4</member>
+                  <member>kea-dhcp6</member>
                 </simplelist>
               </entry>
               <entry>In deployments in which subnet configuration needs to
@@ -460,8 +460,8 @@ $ <userinput>ls -l /usr/local/lib/hooks/*.so</userinput>
               <entry>Kea 1.3.0</entry>
               <entry>
                 <simplelist>
-                  <member>kea-&#xFEFF;dhcp4</member>
-                  <member>kea-&#xFEFF;dhcp6</member>
+                  <member>kea-dhcp4</member>
+                  <member>kea-dhcp6</member>
                 </simplelist>
               </entry>
               <entry>The lease commands hook library offers a number of new
@@ -484,8 +484,8 @@ $ <userinput>ls -l /usr/local/lib/hooks/*.so</userinput>
               <entry>Kea 1.4.0</entry>
               <entry>
                 <simplelist>
-                  <member>kea-&#xFEFF;dhcp4</member>
-                  <member>kea-&#xFEFF;dhcp6</member>
+                  <member>kea-dhcp4</member>
+                  <member>kea-dhcp6</member>
                 </simplelist>
               </entry>
               <entry>Minimizing a risk of DHCP service unavailability is
@@ -515,8 +515,8 @@ $ <userinput>ls -l /usr/local/lib/hooks/*.so</userinput>
               <entry>Kea 1.4.0</entry>
               <entry>
                 <simplelist>
-                  <member>kea-&#xFEFF;dhcp4</member>
-                  <member>kea-&#xFEFF;dhcp6</member>
+                  <member>kea-dhcp4</member>
+                  <member>kea-dhcp6</member>
                 </simplelist>
               </entry>
               <entry>The RADIUS Hook library allows Kea to interact with the
@@ -534,8 +534,8 @@ $ <userinput>ls -l /usr/local/lib/hooks/*.so</userinput>
               <entry>Kea 1.4.0</entry>
               <entry>
                 <simplelist>
-                  <member>kea-&#xFEFF;dhcp4</member>
-                  <member>kea-&#xFEFF;dhcp6</member>
+                  <member>kea-dhcp4</member>
+                  <member>kea-dhcp6</member>
                 </simplelist>
               </entry>
               <entry>Some of the database backends, such as RADIUS, are
index 2a815ca5aab82005d149907e90a047057721ded6..a6d3a1463dccee211ae9be3aedbff8c2b6e2b624 100644 (file)
                 </row>
               </thead>
               <tbody>
-                <row><entry><command>kea-&#xFEFF;ctrl-&#xFEFF;agent</command></entry><entry>core</entry><entry>The root logger for the Control Agent exposing RESTful control API. All components used by the Control Agent inherit the settings from this logger.</entry></row>
-                <row><entry><command>kea-&#xFEFF;ctrl-&#xFEFF;agent.http</command></entry><entry>core</entry><entry>A logger which outputs log messages related to receiving, parsing and sending HTTP messages.</entry></row>
-                <row><entry><command>kea-&#xFEFF;dhcp4</command></entry><entry>core</entry><entry>The root logger for the DHCPv4 server. All components used by the DHCPv4 server inherit the settings from this logger.</entry></row>
-                <row><entry><command>kea-&#xFEFF;dhcp6</command></entry><entry>core</entry><entry>The root logger for the DHCPv6 server. All components used by the DHCPv6 server inherit the settings from this logger.</entry></row>
-                <row><entry><simplelist type="horiz"><member><command>kea-&#xFEFF;dhcp4.alloc-&#xFEFF;engine</command></member><member><command>kea-&#xFEFF;dhcp6.alloc-&#xFEFF;engine</command></member></simplelist></entry><entry>core</entry><entry>Used by the lease allocation engine, which is responsible for managing leases in the lease database, i.e. create, modify and remove DHCP leases as a result of processing messages from the clients.</entry></row>
-                <row><entry><simplelist type="horiz"><member><command>kea-&#xFEFF;dhcp4.bad-&#xFEFF;packets</command></member><member><command>kea-&#xFEFF;dhcp6.bad-&#xFEFF;packets</command></member></simplelist></entry><entry>core</entry><entry>Used by the DHCP servers for logging inbound client packets that were dropped or to which the server responded with a DHCPNAK. It allows administrators to configure a separate log output that contains only packet drop and reject entries.</entry></row>
-                <row><entry><simplelist type="horiz"><member><command>kea-&#xFEFF;dhcp4.callouts</command></member><member><command>kea-&#xFEFF;dhcp6.callouts</command></member></simplelist></entry><entry>core</entry><entry>Used to log messages pertaining to the callouts registration and execution for the particular hook point.</entry></row>
-                <row><entry><simplelist type="horiz"><member><command>kea-&#xFEFF;dhcp4.commands</command></member><member><command>kea-&#xFEFF;dhcp6.commands</command></member></simplelist></entry><entry>core</entry><entry>Used to log messages relating to the handling of commands received by the the DHCP server over the command channel.</entry></row>
-                <row><entry><simplelist type="horiz"><member><command>kea-&#xFEFF;dhcp4.ddns</command></member><member><command>kea-&#xFEFF;dhcp6.ddns</command></member></simplelist></entry><entry>core</entry><entry>Used by the DHCP server to log messages related to the Client FQDN and Hostname option processing. It also includes log messages related to the relevant DNS updates.</entry></row>
-                <row><entry><command>kea-&#xFEFF;dhcp4.dhcp4</command></entry><entry>core</entry><entry>Used by the DHCPv4 server daemon to log basic operations.</entry></row>
-                <row><entry><simplelist type="horiz"><member><command>kea-&#xFEFF;dhcp4.dhcpsrv</command></member><member><command>kea-&#xFEFF;dhcp6.dhcpsrv</command></member></simplelist></entry><entry>core</entry><entry>The base loggers for the libkea-dhcpsrv library.</entry></row>
-                <row><entry><simplelist type="horiz"><member><command>kea-&#xFEFF;dhcp4.eval</command></member><member><command>kea-&#xFEFF;dhcp6.eval</command></member></simplelist></entry><entry>core</entry><entry>Used to log messages relating to the client classification expression evaluation code.</entry></row>
-                <row><entry><simplelist type="horiz"><member><command>kea-&#xFEFF;dhcp4.host-cache-hooks</command></member><member><command>kea-&#xFEFF;dhcp6.host-cache-hooks</command></member></simplelist></entry><entry>libdhcp_host_cache premium hook library</entry><entry>This logger is used to log messages related to operation of the Host Cache Hook Library.</entry></row>
-                <row><entry><simplelist type="horiz"><member><command>kea-&#xFEFF;dhcp4.flex-id-hooks</command></member><member><command>kea-&#xFEFF;dhcp6.flex-id-hooks</command></member></simplelist></entry><entry>libdhcp_flex_id premium hook library</entry><entry>This logger is used to log messages related to operation of the Flexible Identifiers Hook Library.</entry></row>
-                <row><entry><simplelist type="horiz"><member><command>kea-&#xFEFF;dhcp4.ha-hooks</command></member><member><command>kea-&#xFEFF;dhcp6.ha-hooks</command></member></simplelist></entry><entry>libdhcp_ha hook library</entry><entry>This logger is used to log messages related to operation of the High Availability Hook Library.</entry></row>
-                <row><entry><simplelist type="horiz"><member><command>kea-&#xFEFF;dhcp4.hooks</command></member><member><command>kea-&#xFEFF;dhcp6.hooks</command></member></simplelist></entry><entry>core</entry><entry>Used to log messages related to management of hooks libraries, e.g. registration and deregistration of the libraries, and to the initialization of the callouts execution for various hook points within the DHCP server.</entry></row>
-                <row><entry><simplelist type="horiz"><member><command>kea-&#xFEFF;dhcp4.host-&#xFEFF;cmds-&#xFEFF;hooks</command></member><member><command>kea-&#xFEFF;dhcp6.host-&#xFEFF;cmds-&#xFEFF;hooks</command></member></simplelist></entry><entry>libdhcp_host_cmds premium hook library</entry><entry>This logger is used to log messages related to operation of the Host Cmds hooks library. In general these will pertain to loading and unloading the library and the execution of commands by the library.</entry></row>
-                <row><entry><simplelist type="horiz"><member><command>kea-&#xFEFF;dhcp4.hosts</command></member><member><command>kea-&#xFEFF;dhcp6.hosts</command></member></simplelist></entry><entry>core</entry><entry>Used within the libdhcpsrv and it logs messages related to the management of the DHCP host reservations, i.e. retrieval of the reservations and adding new reservations.</entry></row>
-                <row><entry><simplelist type="horiz"><member><command>kea-&#xFEFF;dhcp4.lease-&#xFEFF;cmds-&#xFEFF;hooks</command></member><member><command>kea-&#xFEFF;dhcp6.lease-&#xFEFF;cmds-&#xFEFF;hooks</command></member></simplelist></entry><entry>libdhcp_lease_cmds hook library</entry><entry>This logger is used to log messages related to operation of the Lease Cmds hooks library. In general these will pertain to loading and unloading the library and the execution of commands by the library.</entry></row>
-                <row><entry><simplelist type="horiz"><member><command>kea-&#xFEFF;dhcp4.leases</command></member><member><command>kea-&#xFEFF;dhcp6.leases</command></member></simplelist></entry><entry>core</entry><entry>Used by the DHCP server to log messages related to the lease allocation. The messages include detailed information about the allocated or offered leases, errors during the lease allocation etc.</entry></row>
-                <row><entry><simplelist type="horiz"><member><command>kea-&#xFEFF;dhcp4.legal-log-hooks</command></member><member><command>kea-&#xFEFF;dhcp6.legal-log-hooks</command></member></simplelist></entry><entry>libdhcp_legal_log premium hook library</entry><entry>This logger is used to log messages related to operation of the Forensic Logging Hooks Library.</entry></row>
-                <row><entry><simplelist type="horiz"><member><command>kea-&#xFEFF;dhcp4.options</command></member><member><command>kea-&#xFEFF;dhcp4.options</command></member></simplelist></entry><entry>core</entry><entry>Used by the DHCP server to log messages related to processing of the options in the DHCP messages, i.e. parsing options, encoding options into on-&#xFEFF;wire format and packet classification using options contained in the received packets.</entry></row>
-                <row><entry><simplelist type="horiz"><member><command>kea-&#xFEFF;dhcp4.packets</command></member><member><command>kea-&#xFEFF;dhcp6.packets</command></member></simplelist></entry><entry>core</entry><entry>This logger is mostly used to log messages related to transmission of the DHCP packets, i.e. packet reception and sending a response. Such messages include information about the source and destination IP addresses and interfaces used to transmit packets. The logger is also used to log messages related to subnet selection, as this selection is usually based on the IP addresses, relay addresses and/or interface names, which can be retrieved from the received packet, even before the DHCP message carried in the packet is parsed.</entry></row>
-                <row><entry><simplelist type="horiz"><member><command>kea-&#xFEFF;dhcp4.radius-hooks</command></member><member><command>kea-&#xFEFF;dhcp6.radius-hooks</command></member></simplelist></entry><entry>libdhcp_radius premium hook library</entry><entry>This logger is used to log messages related to operation of the Radius Hook Library.</entry></row>
-                <row><entry><simplelist type="horiz"><member><command>kea-&#xFEFF;dhcp4.stat-&#xFEFF;cmds-&#xFEFF;hooks</command></member><member><command>kea-&#xFEFF;dhcp6.stat-&#xFEFF;cmds-&#xFEFF;hooks</command></member></simplelist></entry><entry>libdhcp_stat_cmds hook library</entry><entry>This logger is used to log messages related to operation of the Stats Cmds hooks library. In general these will pertain to loading and unloading the library and the execution of commands by the library.</entry></row>
-                <row><entry><simplelist type="horiz"><member><command>kea-&#xFEFF;dhcp4.subnet-&#xFEFF;cmds-&#xFEFF;hooks</command></member><member><command>kea-&#xFEFF;dhcp6.subnet-&#xFEFF;cmds-&#xFEFF;hooks</command></member></simplelist></entry><entry>libdhcp_subnet_cmds hook library</entry><entry>This logger is used to log messages related to operation of the Subnet Cmds hooks library. In general these will pertain to loading and unloading the library and the execution of commands by the library.</entry></row>
+                <row><entry><command>kea-ctrl-agent</command></entry><entry>core</entry><entry>The root logger for the Control Agent exposing RESTful control API. All components used by the Control Agent inherit the settings from this logger.</entry></row>
+                <row><entry><command>kea-ctrl-agent.http</command></entry><entry>core</entry><entry>A logger which outputs log messages related to receiving, parsing and sending HTTP messages.</entry></row>
+                <row><entry><command>kea-dhcp4</command></entry><entry>core</entry><entry>The root logger for the DHCPv4 server. All components used by the DHCPv4 server inherit the settings from this logger.</entry></row>
+                <row><entry><command>kea-dhcp6</command></entry><entry>core</entry><entry>The root logger for the DHCPv6 server. All components used by the DHCPv6 server inherit the settings from this logger.</entry></row>
+                <row><entry><simplelist type="horiz"><member><command>kea-dhcp4.alloc-engine</command></member><member><command>kea-dhcp6.alloc-engine</command></member></simplelist></entry><entry>core</entry><entry>Used by the lease allocation engine, which is responsible for managing leases in the lease database, i.e. create, modify and remove DHCP leases as a result of processing messages from the clients.</entry></row>
+                <row><entry><simplelist type="horiz"><member><command>kea-dhcp4.bad-packets</command></member><member><command>kea-dhcp6.bad-packets</command></member></simplelist></entry><entry>core</entry><entry>Used by the DHCP servers for logging inbound client packets that were dropped or to which the server responded with a DHCPNAK. It allows administrators to configure a separate log output that contains only packet drop and reject entries.</entry></row>
+                <row><entry><simplelist type="horiz"><member><command>kea-dhcp4.callouts</command></member><member><command>kea-dhcp6.callouts</command></member></simplelist></entry><entry>core</entry><entry>Used to log messages pertaining to the callouts registration and execution for the particular hook point.</entry></row>
+                <row><entry><simplelist type="horiz"><member><command>kea-dhcp4.commands</command></member><member><command>kea-dhcp6.commands</command></member></simplelist></entry><entry>core</entry><entry>Used to log messages relating to the handling of commands received by the the DHCP server over the command channel.</entry></row>
+                <row><entry><simplelist type="horiz"><member><command>kea-dhcp4.ddns</command></member><member><command>kea-dhcp6.ddns</command></member></simplelist></entry><entry>core</entry><entry>Used by the DHCP server to log messages related to the Client FQDN and Hostname option processing. It also includes log messages related to the relevant DNS updates.</entry></row>
+                <row><entry><command>kea-dhcp4.dhcp4</command></entry><entry>core</entry><entry>Used by the DHCPv4 server daemon to log basic operations.</entry></row>
+                <row><entry><simplelist type="horiz"><member><command>kea-dhcp4.dhcpsrv</command></member><member><command>kea-dhcp6.dhcpsrv</command></member></simplelist></entry><entry>core</entry><entry>The base loggers for the libkea-dhcpsrv library.</entry></row>
+                <row><entry><simplelist type="horiz"><member><command>kea-dhcp4.eval</command></member><member><command>kea-dhcp6.eval</command></member></simplelist></entry><entry>core</entry><entry>Used to log messages relating to the client classification expression evaluation code.</entry></row>
+                <row><entry><simplelist type="horiz"><member><command>kea-dhcp4.host-cache-hooks</command></member><member><command>kea-dhcp6.host-cache-hooks</command></member></simplelist></entry><entry>libdhcp_host_cache premium hook library</entry><entry>This logger is used to log messages related to operation of the Host Cache Hook Library.</entry></row>
+                <row><entry><simplelist type="horiz"><member><command>kea-dhcp4.flex-id-hooks</command></member><member><command>kea-dhcp6.flex-id-hooks</command></member></simplelist></entry><entry>libdhcp_flex_id premium hook library</entry><entry>This logger is used to log messages related to operation of the Flexible Identifiers Hook Library.</entry></row>
+                <row><entry><simplelist type="horiz"><member><command>kea-dhcp4.ha-hooks</command></member><member><command>kea-dhcp6.ha-hooks</command></member></simplelist></entry><entry>libdhcp_ha hook library</entry><entry>This logger is used to log messages related to operation of the High Availability Hook Library.</entry></row>
+                <row><entry><simplelist type="horiz"><member><command>kea-dhcp4.hooks</command></member><member><command>kea-dhcp6.hooks</command></member></simplelist></entry><entry>core</entry><entry>Used to log messages related to management of hooks libraries, e.g. registration and deregistration of the libraries, and to the initialization of the callouts execution for various hook points within the DHCP server.</entry></row>
+                <row><entry><simplelist type="horiz"><member><command>kea-dhcp4.host-cmds-hooks</command></member><member><command>kea-dhcp6.host-cmds-hooks</command></member></simplelist></entry><entry>libdhcp_host_cmds premium hook library</entry><entry>This logger is used to log messages related to operation of the Host Cmds hooks library. In general these will pertain to loading and unloading the library and the execution of commands by the library.</entry></row>
+                <row><entry><simplelist type="horiz"><member><command>kea-dhcp4.hosts</command></member><member><command>kea-dhcp6.hosts</command></member></simplelist></entry><entry>core</entry><entry>Used within the libdhcpsrv and it logs messages related to the management of the DHCP host reservations, i.e. retrieval of the reservations and adding new reservations.</entry></row>
+                <row><entry><simplelist type="horiz"><member><command>kea-dhcp4.lease-cmds-hooks</command></member><member><command>kea-dhcp6.lease-cmds-hooks</command></member></simplelist></entry><entry>libdhcp_lease_cmds hook library</entry><entry>This logger is used to log messages related to operation of the Lease Cmds hooks library. In general these will pertain to loading and unloading the library and the execution of commands by the library.</entry></row>
+                <row><entry><simplelist type="horiz"><member><command>kea-dhcp4.leases</command></member><member><command>kea-dhcp6.leases</command></member></simplelist></entry><entry>core</entry><entry>Used by the DHCP server to log messages related to the lease allocation. The messages include detailed information about the allocated or offered leases, errors during the lease allocation etc.</entry></row>
+                <row><entry><simplelist type="horiz"><member><command>kea-dhcp4.legal-log-hooks</command></member><member><command>kea-dhcp6.legal-log-hooks</command></member></simplelist></entry><entry>libdhcp_legal_log premium hook library</entry><entry>This logger is used to log messages related to operation of the Forensic Logging Hooks Library.</entry></row>
+                <row><entry><simplelist type="horiz"><member><command>kea-dhcp4.options</command></member><member><command>kea-dhcp4.options</command></member></simplelist></entry><entry>core</entry><entry>Used by the DHCP server to log messages related to processing of the options in the DHCP messages, i.e. parsing options, encoding options into on-wire format and packet classification using options contained in the received packets.</entry></row>
+                <row><entry><simplelist type="horiz"><member><command>kea-dhcp4.packets</command></member><member><command>kea-dhcp6.packets</command></member></simplelist></entry><entry>core</entry><entry>This logger is mostly used to log messages related to transmission of the DHCP packets, i.e. packet reception and sending a response. Such messages include information about the source and destination IP addresses and interfaces used to transmit packets. The logger is also used to log messages related to subnet selection, as this selection is usually based on the IP addresses, relay addresses and/or interface names, which can be retrieved from the received packet, even before the DHCP message carried in the packet is parsed.</entry></row>
+                <row><entry><simplelist type="horiz"><member><command>kea-dhcp4.radius-hooks</command></member><member><command>kea-dhcp6.radius-hooks</command></member></simplelist></entry><entry>libdhcp_radius premium hook library</entry><entry>This logger is used to log messages related to operation of the Radius Hook Library.</entry></row>
+                <row><entry><simplelist type="horiz"><member><command>kea-dhcp4.stat-cmds-hooks</command></member><member><command>kea-dhcp6.stat-cmds-hooks</command></member></simplelist></entry><entry>libdhcp_stat_cmds hook library</entry><entry>This logger is used to log messages related to operation of the Stats Cmds hooks library. In general these will pertain to loading and unloading the library and the execution of commands by the library.</entry></row>
+                <row><entry><simplelist type="horiz"><member><command>kea-dhcp4.subnet-cmds-hooks</command></member><member><command>kea-dhcp6.subnet-cmds-hooks</command></member></simplelist></entry><entry>libdhcp_subnet_cmds hook library</entry><entry>This logger is used to log messages related to operation of the Subnet Cmds hooks library. In general these will pertain to loading and unloading the library and the execution of commands by the library.</entry></row>
                 <row><entry><command>kea-dhcp-ddns</command></entry><entry>core</entry><entry>The root logger for the kea-dhcp-ddns daemon. All components used by this daemon inherit the settings from this logger if there is no specialized logger provided.</entry></row>
                 <row><entry><command>kea-dhcp-ddns.dctl</command></entry><entry>core</entry><entry>The logger used by the kea-dhcp-ddns daemon for logging basic information about the process, received signals and triggered reconfigurations.</entry></row>
                 <row><entry><command>kea-dhcp-ddns.dhcpddns</command></entry><entry>core</entry><entry>The logger used by the kea-dhcp-ddns daemon for logging events related to DDNS operations.</entry></row>