mirror of
https://gitlab.isc.org/isc-projects/kea
synced 2025-08-30 21:45:37 +00:00
[3414] References to b10-dhcp* modified to reference kea-dhcp*.
This commit is contained in:
@@ -26,7 +26,7 @@ namespace d2 {
|
||||
const char* D2Controller::d2_app_name_ = "DHCP-DDNS";
|
||||
|
||||
/// @brief Defines the executable name. This is passed into the base class
|
||||
const char* D2Controller::d2_bin_name_ = "b10-dhcp-ddns";
|
||||
const char* D2Controller::d2_bin_name_ = "kea-dhcp-ddns";
|
||||
|
||||
DControllerBasePtr&
|
||||
D2Controller::instance() {
|
||||
|
@@ -26,7 +26,7 @@ namespace d2 {
|
||||
const char* D2Controller::d2_app_name_ = "DhcpDdns";
|
||||
|
||||
/// @brief Defines the executable name. This is passed into the base class
|
||||
const char* D2Controller::d2_bin_name_ = "b10-dhcp-ddns";
|
||||
const char* D2Controller::d2_bin_name_ = "kea-dhcp-ddns";
|
||||
|
||||
DControllerBasePtr&
|
||||
D2Controller::instance() {
|
||||
|
@@ -205,7 +205,7 @@
|
||||
"commands": [
|
||||
{
|
||||
"command_name": "shutdown",
|
||||
"command_description": "Shuts down b10-dhcp-ddns module server.",
|
||||
"command_description": "Shuts down kea-dhcp-ddns module server.",
|
||||
"command_args": [
|
||||
{
|
||||
"item_name": "type",
|
||||
|
@@ -30,7 +30,7 @@
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>b10-dhcp-ddns</refname>
|
||||
<refname>kea-dhcp-ddns</refname>
|
||||
<refpurpose>DHCP-DDNS process in Kea</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
|
@@ -25,7 +25,7 @@ using namespace isc::d2;
|
||||
using namespace std;
|
||||
|
||||
/// This file contains entry point (main() function) for standard DHCP-DDNS
|
||||
/// process, b10-dhcp-ddns, component for BIND10 framework. It fetches
|
||||
/// process, kea-dhcp-ddns, component for BIND10 framework. It fetches
|
||||
/// the D2Controller singleton instance and invokes its launch method.
|
||||
/// The exit value of the program will be EXIT_SUCCESS if there were no
|
||||
/// errors, EXIT_FAILURE otherwise.
|
||||
|
@@ -16,7 +16,7 @@
|
||||
@page dhcp4 DHCPv4 Server Component
|
||||
|
||||
BIND10 offers DHCPv4 server implementation. It is implemented as
|
||||
b10-dhcp4 component. Its primary code is located in
|
||||
kea-dhcp4 component. Its primary code is located in
|
||||
isc::dhcp::Dhcpv4Srv class. It uses \ref libdhcp extensively,
|
||||
especially isc::dhcp::Pkt4, isc::dhcp::Option and
|
||||
isc::dhcp::IfaceMgr classes. Currently this code offers skeleton
|
||||
@@ -99,19 +99,19 @@ client. In this case the server will return one of the DHCPv4 Client FQDN or
|
||||
Host Name %Option in its response with the name which was selected for the
|
||||
client to indicate that this name will be used to perform DNS update.
|
||||
|
||||
The b10-dhcp-ddns process is responsible for the actual communication with the
|
||||
DNS, i.e. to send DNS update messages. The b10-dhcp4 module is responsible for
|
||||
The kea-dhcp-ddns process is responsible for the actual communication with the
|
||||
DNS, i.e. to send DNS update messages. The kea-dhcp4 module is responsible for
|
||||
generating @ref isc::dhcp_ddns::NameChangeRequest and sending it to
|
||||
the b10-dhcp-ddns module. The @ref isc::dhcp_ddns::NameChangeRequest object
|
||||
the kea-dhcp-ddns module. The @ref isc::dhcp_ddns::NameChangeRequest object
|
||||
represents changes to the DNS bindings, related to acquisition, renewal or
|
||||
release of the DHCP lease. The b10-dhcp4 module implements the simple FIFO queue
|
||||
release of the DHCP lease. The kea-dhcp4 module implements the simple FIFO queue
|
||||
of the NameChangeRequest objects. The module logic, which processes the incoming
|
||||
DHCPv4 Client FQDN and Host Name Options puts these requests into the FIFO queue.
|
||||
|
||||
@todo Currently the FIFO queue is not processed after the NameChangeRequests are
|
||||
generated and added to it. In the future implementation steps it is planned to
|
||||
create a code which will check if there are any outstanding requests in the queue
|
||||
and send them to the b10-dhcp-ddns module when server is idle waiting for DHCP
|
||||
and send them to the kea-dhcp-ddns module when server is idle waiting for DHCP
|
||||
messages.
|
||||
|
||||
When client gets an address from the server, a DHCPv4 server may generate 0, 1
|
||||
@@ -121,10 +121,10 @@ update for any other reason.
|
||||
|
||||
Server may generate 1 NameChangeRequest in a case when client acquired a new
|
||||
lease or it releases an existing lease. In the former case, the NameChangeRequest
|
||||
type is CHG_ADD, which indicates that the b10-dhcp-ddns module should add a new
|
||||
type is CHG_ADD, which indicates that the kea-dhcp-ddns module should add a new
|
||||
DNS binding for the client, and it is assumed that there is no DNS binding for
|
||||
this client already. In the latter case, the NameChangeRequest type is CHG_REMOVE
|
||||
to indicate to the b10-dhcp-ddns module that an existing DNS binding should be
|
||||
to indicate to the kea-dhcp-ddns module that an existing DNS binding should be
|
||||
removed from the DNS. The binding consists of the forward and reverse mapping.
|
||||
The server may only remove the mapping which it had added. Therefore, the lease
|
||||
database holds the information which updates (no update, reverse only update,
|
||||
|
@@ -346,28 +346,28 @@
|
||||
"item_type": "string",
|
||||
"item_optional": true,
|
||||
"item_default": "127.0.0.1",
|
||||
"item_description" : "IP address of b10-dhcp-ddns (IPv4 or IPv6)"
|
||||
"item_description" : "IP address of kea-dhcp-ddns (IPv4 or IPv6)"
|
||||
},
|
||||
{
|
||||
"item_name": "server-port",
|
||||
"item_type": "integer",
|
||||
"item_optional": true,
|
||||
"item_default": 53001,
|
||||
"item_description" : "port number of b10-dhcp-ddns"
|
||||
"item_description" : "port number of kea-dhcp-ddns"
|
||||
},
|
||||
{
|
||||
"item_name": "sender-ip",
|
||||
"item_type": "string",
|
||||
"item_optional": true,
|
||||
"item_default": "",
|
||||
"item_description" : "IP address from which to send to b10-dhcp-ddns (IPv4 or IPv6)"
|
||||
"item_description" : "IP address from which to send to kea-dhcp-ddns (IPv4 or IPv6)"
|
||||
},
|
||||
{
|
||||
"item_name": "sender-port",
|
||||
"item_type": "integer",
|
||||
"item_optional": true,
|
||||
"item_default": 0,
|
||||
"item_description" : "port number from which to send to b10-dhcp-ddns"
|
||||
"item_description" : "port number from which to send to kea-dhcp-ddns"
|
||||
},
|
||||
{
|
||||
"item_name": "max-queue-size",
|
||||
@@ -381,7 +381,7 @@
|
||||
"item_type": "string",
|
||||
"item_optional": true,
|
||||
"item_default": "UDP",
|
||||
"item_description" : "Socket protocol to use with b10-dhcp-ddns"
|
||||
"item_description" : "Socket protocol to use with kea-dhcp-ddns"
|
||||
},
|
||||
{
|
||||
"item_name": "ncr-format",
|
||||
|
@@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2012 Internet Systems Consortium, Inc. ("ISC")
|
||||
// Copyright (C) 2012, 2014 Internet Systems Consortium, Inc. ("ISC")
|
||||
//
|
||||
// Permission to use, copy, modify, and/or distribute this software for any
|
||||
// purpose with or without fee is hereby granted, provided that the above
|
||||
@@ -12,7 +12,7 @@
|
||||
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
||||
// PERFORMANCE OF THIS SOFTWARE.
|
||||
|
||||
/// Defines the logger used by the top-level component of b10-dhcp4.
|
||||
/// Defines the logger used by the top-level component of kea-dhcp4.
|
||||
|
||||
#include <dhcp4/dhcp4_log.h>
|
||||
|
||||
|
@@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2012 Internet Systems Consortium, Inc. ("ISC")
|
||||
// Copyright (C) 2012, 2014 Internet Systems Consortium, Inc. ("ISC")
|
||||
//
|
||||
// Permission to use, copy, modify, and/or distribute this software for any
|
||||
// purpose with or without fee is hereby granted, provided that the above
|
||||
@@ -50,7 +50,7 @@ const int DBG_DHCP4_DETAIL = DBGLVL_TRACE_DETAIL;
|
||||
// This level is used to log the contents of packets received and sent.
|
||||
const int DBG_DHCP4_DETAIL_DATA = DBGLVL_TRACE_DETAIL_DATA;
|
||||
|
||||
/// Define the logger for the "dhcp4" module part of b10-dhcp4. We could define
|
||||
/// Define the logger for the "dhcp4" module part of kea-dhcp4. We could define
|
||||
/// a logger in each file, but we would want to define a common name to avoid
|
||||
/// spelling mistakes, so it is just one small step from there to define a
|
||||
/// module-common logger.
|
||||
|
@@ -77,7 +77,7 @@ change is committed by the administrator.
|
||||
A debug message indicating that the DHCPv4 server has received an
|
||||
updated configuration from the BIND 10 configuration system.
|
||||
|
||||
% DHCP4_DDNS_REQUEST_SEND_FAILED failed sending a request to b10-dhcp-ddns, error: %1, ncr: %2
|
||||
% DHCP4_DDNS_REQUEST_SEND_FAILED failed sending a request to kea-dhcp-ddns, error: %1, ncr: %2
|
||||
This error message indicates that DHCP4 server attempted to send a DDNS
|
||||
update reqeust to the DHCP-DDNS server. This is most likely a configuration or
|
||||
networking error.
|
||||
@@ -177,7 +177,7 @@ failure.
|
||||
|
||||
% DHCP4_NCR_CREATION_FAILED failed to generate name change requests for DNS: %1
|
||||
This message indicates that server was unable to generate NameChangeRequests
|
||||
which should be sent to the b10-dhcp_ddns module to create
|
||||
which should be sent to the kea-dhcp_ddns module to create
|
||||
new DNS records for the lease being acquired or to update existing records
|
||||
for the renewed lease. The reason for the failure is printed in the logged
|
||||
message.
|
||||
|
@@ -1916,7 +1916,7 @@ Dhcpv4Srv::d2ClientErrorHandler(const
|
||||
dhcp_ddns::NameChangeRequestPtr& ncr) {
|
||||
LOG_ERROR(dhcp4_logger, DHCP4_DDNS_REQUEST_SEND_FAILED).
|
||||
arg(result).arg((ncr ? ncr->toText() : " NULL "));
|
||||
// We cannot communicate with b10-dhcp-ddns, suspend futher updates.
|
||||
// We cannot communicate with kea-dhcp-ddns, suspend futher updates.
|
||||
/// @todo We may wish to revisit this, but for now we will simpy turn
|
||||
/// them off.
|
||||
CfgMgr::instance().getD2ClientMgr().suspendUpdates();
|
||||
|
@@ -174,7 +174,7 @@ public:
|
||||
|
||||
/// @brief Implements the error handler for DHCP_DDNS IO errors
|
||||
///
|
||||
/// Invoked when a NameChangeRequest send to b10-dhcp-ddns completes with
|
||||
/// Invoked when a NameChangeRequest send to kea-dhcp-ddns completes with
|
||||
/// a failed status. These are communications errors, not data related
|
||||
/// failures.
|
||||
///
|
||||
@@ -490,7 +490,7 @@ protected:
|
||||
/// This creates the @c isc::dhcp_ddns::NameChangeRequest; emits a
|
||||
/// the debug message which indicates whether the request being added is
|
||||
/// to remove DNS entry or add a new entry; and then sends the request
|
||||
/// to the D2ClientMgr for transmission to b10-dhcp-ddns.
|
||||
/// to the D2ClientMgr for transmission to kea-dhcp-ddns.
|
||||
///
|
||||
/// @param chg_type A type of the NameChangeRequest (ADD or REMOVE).
|
||||
/// @param lease A lease for which the NameChangeRequest is created and
|
||||
|
@@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2011-2012 Internet Systems Consortium, Inc. ("ISC")
|
||||
// Copyright (C) 2011-2012, 2014 Internet Systems Consortium, Inc. ("ISC")
|
||||
//
|
||||
// Permission to use, copy, modify, and/or distribute this software for any
|
||||
// purpose with or without fee is hereby granted, provided that the above
|
||||
@@ -37,7 +37,7 @@ using namespace std;
|
||||
|
||||
namespace {
|
||||
|
||||
const char* const DHCP4_NAME = "b10-dhcp4";
|
||||
const char* const DHCP4_NAME = "kea-dhcp4";
|
||||
|
||||
const char* const DHCP4_LOGGER_NAME = "kea";
|
||||
|
||||
|
@@ -16,7 +16,7 @@
|
||||
@page dhcp6 DHCPv6 Server Component
|
||||
|
||||
BIND10 offers DHCPv6 server implementation. It is implemented as
|
||||
b10-dhcp6 component. Its primary code is located in
|
||||
kea-dhcp6 component. Its primary code is located in
|
||||
isc::dhcp::Dhcpv6Srv class. It uses \ref libdhcp extensively,
|
||||
especially lib::dhcp::Pkt6, isc::dhcp::Option and
|
||||
isc::dhcp::IfaceMgr classes. Currently this code offers skeleton
|
||||
@@ -38,7 +38,7 @@
|
||||
|
||||
@section dhcpv6ConfigParser Configuration Parser in DHCPv6
|
||||
|
||||
b10-dhcp6 component uses BIND10 cfgmgr for commands and configuration. During
|
||||
kea-dhcp6 component uses BIND10 cfgmgr for commands and configuration. During
|
||||
initial configuration (See \ref
|
||||
isc::dhcp::ControlledDhcpv6Srv::establishSession()), the configuration handler
|
||||
callback is installed (see isc::dhcp::ControlledDhcpv6Srv::dhcp6ConfigHandler().
|
||||
@@ -104,10 +104,10 @@ DNS update to the client and that the server performs the reverse update only. C
|
||||
version of the DHCPv6 server does not support delegation of the forward update
|
||||
to the client. The implementation of this feature is planned for the future releases.
|
||||
|
||||
The b10-dhcp-ddns process is responsible for the actual communication with the DNS
|
||||
server, i.e. to send DNS Update messages. The b10-dhcp6 module is responsible
|
||||
The kea-dhcp-ddns process is responsible for the actual communication with the DNS
|
||||
server, i.e. to send DNS Update messages. The kea-dhcp6 module is responsible
|
||||
for generating so called @ref isc::dhcp_ddns::NameChangeRequest and sending it to the
|
||||
b10-dhcp-ddns module. The @ref isc::dhcp_ddns::NameChangeRequest object represents changes to the
|
||||
kea-dhcp-ddns module. The @ref isc::dhcp_ddns::NameChangeRequest object represents changes to the
|
||||
DNS bindings, related to acquisition, renewal or release of the lease. The bind10-dhcp6
|
||||
module implements the simple FIFO queue of the NameChangeRequest objects. The module
|
||||
logic, which processes the incoming DHCPv6 Client FQDN Options puts these requests
|
||||
@@ -116,7 +116,7 @@ into the FIFO queue.
|
||||
@todo Currently the FIFO queue is not processed after the NameChangeRequests are
|
||||
generated and added to it. In the future implementation steps it is planned to create
|
||||
a code which will check if there are any outstanding requests in the queue and
|
||||
send them to the b10-dhcp-ddns module when server is idle waiting for DHCP messages.
|
||||
send them to the kea-dhcp-ddns module when server is idle waiting for DHCP messages.
|
||||
|
||||
In the simplest case, when client gets one address from the server, a DHCPv6 server
|
||||
may generate 0, 1 or 2 NameChangeRequests during single message processing.
|
||||
@@ -125,10 +125,10 @@ Server generates no NameChangeRequests if it is not configured to update DNS
|
||||
|
||||
Server may generate 1 NameChangeRequest in a situation when a client acquires a
|
||||
new lease or it releases an existing lease. In the former case, the NameChangeRequest
|
||||
type is CHG_ADD, which indicates that the b10-dhcp-ddns module should add a new DNS
|
||||
type is CHG_ADD, which indicates that the kea-dhcp-ddns module should add a new DNS
|
||||
binding for the client, and it is assumed that there is no DNS binding for this
|
||||
client already. In the latter case, the NameChangeRequest type is CHG_REMOVE to
|
||||
indicate to the b10-dhcp-ddns module that the existing DNS binding should be removed
|
||||
indicate to the kea-dhcp-ddns module that the existing DNS binding should be removed
|
||||
from the DNS. The binding consists of the forward and reverse mapping.
|
||||
A server may only remove the mapping which it had added. Therefore, the lease database
|
||||
holds an information which updates (no update, reverse only update, forward only update,
|
||||
|
@@ -383,28 +383,28 @@
|
||||
"item_type": "string",
|
||||
"item_optional": true,
|
||||
"item_default": "127.0.0.1",
|
||||
"item_description" : "IP address of b10-dhcp-ddns (IPv4 or IPv6)"
|
||||
"item_description" : "IP address of kea-dhcp-ddns (IPv4 or IPv6)"
|
||||
},
|
||||
{
|
||||
"item_name": "server-port",
|
||||
"item_type": "integer",
|
||||
"item_optional": true,
|
||||
"item_default": 53001,
|
||||
"item_description" : "port number of b10-dhcp-ddns"
|
||||
"item_description" : "port number of kea-dhcp-ddns"
|
||||
},
|
||||
{
|
||||
"item_name": "sender-ip",
|
||||
"item_type": "string",
|
||||
"item_optional": true,
|
||||
"item_default": "",
|
||||
"item_description" : "IP address from which to send to b10-dhcp-ddns (IPv4 or IPv6)"
|
||||
"item_description" : "IP address from which to send to kea-dhcp-ddns (IPv4 or IPv6)"
|
||||
},
|
||||
{
|
||||
"item_name": "sender-port",
|
||||
"item_type": "integer",
|
||||
"item_optional": true,
|
||||
"item_default": 0,
|
||||
"item_description" : "port number from which to send to b10-dhcp-ddns"
|
||||
"item_description" : "port number from which to send to kea-dhcp-ddns"
|
||||
},
|
||||
{
|
||||
"item_name": "max-queue-size",
|
||||
@@ -418,7 +418,7 @@
|
||||
"item_type": "string",
|
||||
"item_optional": true,
|
||||
"item_default": "UDP",
|
||||
"item_description" : "Socket protocol to use with b10-dhcp-ddns"
|
||||
"item_description" : "Socket protocol to use with kea-dhcp-ddns"
|
||||
},
|
||||
{
|
||||
"item_name": "ncr-format",
|
||||
|
@@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2012 Internet Systems Consortium, Inc. ("ISC")
|
||||
// Copyright (C) 2012, 2014 Internet Systems Consortium, Inc. ("ISC")
|
||||
//
|
||||
// Permission to use, copy, modify, and/or distribute this software for any
|
||||
// purpose with or without fee is hereby granted, provided that the above
|
||||
|
@@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2012 Internet Systems Consortium, Inc. ("ISC")
|
||||
// Copyright (C) 2012, 2014 Internet Systems Consortium, Inc. ("ISC")
|
||||
//
|
||||
// Permission to use, copy, modify, and/or distribute this software for any
|
||||
// purpose with or without fee is hereby granted, provided that the above
|
||||
@@ -25,7 +25,7 @@ namespace dhcp {
|
||||
/// \brief DHCP6 Logging
|
||||
///
|
||||
/// Defines the levels used to output debug messages in the non-library part of
|
||||
/// the b10-dhcp6 program. Higher numbers equate to more verbose (and detailed)
|
||||
/// the kea-dhcp6 program. Higher numbers equate to more verbose (and detailed)
|
||||
/// output.
|
||||
|
||||
// Debug levels used to log information during startup and shutdown.
|
||||
@@ -50,7 +50,7 @@ const int DBG_DHCP6_DETAIL = DBGLVL_TRACE_DETAIL;
|
||||
// This level is used to log the contents of packets received and sent.
|
||||
const int DBG_DHCP6_DETAIL_DATA = DBGLVL_TRACE_DETAIL_DATA;
|
||||
|
||||
/// Define the logger for the "dhcp6" module part of b10-dhcp6. We could define
|
||||
/// Define the logger for the "dhcp6" module part of kea-dhcp6. We could define
|
||||
/// a logger in each file, but we would want to define a common name to avoid
|
||||
/// spelling mistakes, so it is just one small step from there to define a
|
||||
/// module-common logger.
|
||||
|
@@ -105,7 +105,7 @@ that the DNS Update has been performed for it, but the FQDN held in the lease
|
||||
database has invalid format and can't be transformed to the canonical on-wire
|
||||
format.
|
||||
|
||||
% DHCP6_DDNS_REQUEST_SEND_FAILED failed sending a request to b10-dhcp-ddns, error: %1, ncr: %2
|
||||
% DHCP6_DDNS_REQUEST_SEND_FAILED failed sending a request to kea-dhcp-ddns, error: %1, ncr: %2
|
||||
This error message indicates that IPv6 DHCP server failed to send a DDNS
|
||||
update reqeust to the DHCP-DDNS server. This is most likely a configuration or
|
||||
networking error.
|
||||
|
@@ -130,7 +130,7 @@ public:
|
||||
|
||||
/// @brief Implements the error handler for DHCP_DDNS IO errors
|
||||
///
|
||||
/// Invoked when a NameChangeRequest send to b10-dhcp-ddns completes with
|
||||
/// Invoked when a NameChangeRequest send to kea-dhcp-ddns completes with
|
||||
/// a failed status. These are communications errors, not data related
|
||||
/// failures.
|
||||
///
|
||||
@@ -673,7 +673,7 @@ protected:
|
||||
volatile bool shutdown_;
|
||||
|
||||
/// Holds a list of @c isc::dhcp_ddns::NameChangeRequest objects, which
|
||||
/// are waiting for sending to b10-dhcp-ddns module.
|
||||
/// are waiting for sending to kea-dhcp-ddns module.
|
||||
std::queue<isc::dhcp_ddns::NameChangeRequest> name_change_reqs_;
|
||||
};
|
||||
|
||||
|
@@ -12,7 +12,7 @@ kea_config_file=@sysconfdir@/@PACKAGE@/kea.conf
|
||||
exec_prefix=@exec_prefix@
|
||||
dhcp4_srv=@libexecdir@/@PACKAGE@/kea-dhcp4
|
||||
dhcp6_srv=@libexecdir@/@PACKAGE@/kea-dhcp6
|
||||
dhcp_ddns_srv=@libexecdir@/@PACKAGE@/b10-dhcp-ddns
|
||||
dhcp_ddns_srv=@libexecdir@/@PACKAGE@/kea-dhcp-ddns
|
||||
|
||||
# Start DHCPv4 server?
|
||||
dhcp4=yes
|
||||
|
@@ -27,7 +27,7 @@ KEACTRL_CFG_FILE=@abs_top_builddir@/src/bin/keactrl/tests/keactrl_test.conf
|
||||
# Path to the Kea log file.
|
||||
LOG_FILE=@abs_top_builddir@/src/bin/keactrl/tests/test.log
|
||||
# Binaries' names
|
||||
wildcard_name="b10-dhcp"
|
||||
wildcard_name="kea-dhcp"
|
||||
kea4_name="${wildcard_name}4"
|
||||
kea6_name="${wildcard_name}6"
|
||||
d2_name="${wildcard_name}-ddns"
|
||||
|
@@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2013 Internet Systems Consortium, Inc. ("ISC")
|
||||
// Copyright (C) 2013-2014 Internet Systems Consortium, Inc. ("ISC")
|
||||
//
|
||||
// Permission to use, copy, modify, and/or distribute this software for any
|
||||
// purpose with or without fee is hereby granted, provided that the above
|
||||
@@ -125,7 +125,7 @@ the library will unload.
|
||||
|
||||
### Configuring the DHCP Modules
|
||||
it must be configured as a hook library for the
|
||||
desired DHCP server modules. Note that the user_chk library is installed alongside the BIND10 libraries in "<install-dir>/lib" where <install-dir> is determined by the --prefix option of the configure script. It defaults to "/usr/local". Assuming the default value then, configuring b10-dhcp4 to load the user_chk
|
||||
desired DHCP server modules. Note that the user_chk library is installed alongside the BIND10 libraries in "<install-dir>/lib" where <install-dir> is determined by the --prefix option of the configure script. It defaults to "/usr/local". Assuming the default value then, configuring kea-dhcp4 to load the user_chk
|
||||
library could be done with the following BIND10 configuration commands:
|
||||
|
||||
@code
|
||||
|
@@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2013 Internet Systems Consortium, Inc. ("ISC")
|
||||
// Copyright (C) 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
|
||||
//
|
||||
// Permission to use, copy, modify, and/or distribute this software for any
|
||||
// purpose with or without fee is hereby granted, provided that the above
|
||||
@@ -12,7 +12,7 @@
|
||||
// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
||||
// PERFORMANCE OF THIS SOFTWARE.
|
||||
|
||||
/// Defines the logger used by the top-level component of b10-dhcp_ddns.
|
||||
/// Defines the logger used by the top-level component of kea-dhcp_ddns.
|
||||
|
||||
#include <dhcp_ddns/dhcp_ddns_log.h>
|
||||
|
||||
|
@@ -17,7 +17,7 @@
|
||||
|
||||
/// @file d2_client_cfg.h Defines the D2ClientConfig class.
|
||||
/// This file defines the classes Kea uses to manage configuration needed to
|
||||
/// act as a client of the b10-dhcp-ddns module (aka D2).
|
||||
/// act as a client of the kea-dhcp-ddns module (aka D2).
|
||||
///
|
||||
#include <asiolink/io_address.h>
|
||||
#include <dhcp_ddns/ncr_io.h>
|
||||
@@ -78,14 +78,14 @@ public:
|
||||
/// @brief Constructor
|
||||
///
|
||||
/// @param enable_updates Enables DHCP-DDNS updates
|
||||
/// @param server_ip IP address of the b10-dhcp-ddns server (IPv4 or IPv6)
|
||||
/// @param server_port IP port of the b10-dhcp-ddns server
|
||||
/// @param sender_ip IP address of the b10-dhcp-ddns server (IPv4 or IPv6)
|
||||
/// @param sender_port IP port of the b10-dhcp-ddns server
|
||||
/// @param server_ip IP address of the kea-dhcp-ddns server (IPv4 or IPv6)
|
||||
/// @param server_port IP port of the kea-dhcp-ddns server
|
||||
/// @param sender_ip IP address of the kea-dhcp-ddns server (IPv4 or IPv6)
|
||||
/// @param sender_port IP port of the kea-dhcp-ddns server
|
||||
/// @param max_queue_size maximum NCRs allowed in sender's queue
|
||||
/// @param ncr_protocol Socket protocol to use with b10-dhcp-ddns
|
||||
/// @param ncr_protocol Socket protocol to use with kea-dhcp-ddns
|
||||
/// Currently only UDP is supported.
|
||||
/// @param ncr_format Format of the b10-dhcp-ddns requests.
|
||||
/// @param ncr_format Format of the kea-dhcp-ddns requests.
|
||||
/// Currently only JSON format is supported.
|
||||
/// @param always_include_fqdn Enables always including the FQDN option in
|
||||
/// DHCP responses.
|
||||
@@ -126,12 +126,12 @@ public:
|
||||
return(enable_updates_);
|
||||
}
|
||||
|
||||
/// @brief Return the IP address of b10-dhcp-ddns (IPv4 or IPv6).
|
||||
/// @brief Return the IP address of kea-dhcp-ddns (IPv4 or IPv6).
|
||||
const isc::asiolink::IOAddress& getServerIp() const {
|
||||
return(server_ip_);
|
||||
}
|
||||
|
||||
/// @brief Return the IP port of b10-dhcp-ddns.
|
||||
/// @brief Return the IP port of kea-dhcp-ddns.
|
||||
size_t getServerPort() const {
|
||||
return(server_port_);
|
||||
}
|
||||
@@ -151,12 +151,12 @@ public:
|
||||
return(max_queue_size_);
|
||||
}
|
||||
|
||||
/// @brief Return the socket protocol to use with b10-dhcp-ddns.
|
||||
/// @brief Return the socket protocol to use with kea-dhcp-ddns.
|
||||
const dhcp_ddns::NameChangeProtocol& getNcrProtocol() const {
|
||||
return(ncr_protocol_);
|
||||
}
|
||||
|
||||
/// @brief Return the b10-dhcp-ddns request format.
|
||||
/// @brief Return the kea-dhcp-ddns request format.
|
||||
const dhcp_ddns::NameChangeFormat& getNcrFormat() const {
|
||||
return(ncr_format_);
|
||||
}
|
||||
@@ -221,10 +221,10 @@ private:
|
||||
/// @brief Indicates whether or not DHCP DDNS updating is enabled.
|
||||
bool enable_updates_;
|
||||
|
||||
/// @brief IP address of the b10-dhcp-ddns server (IPv4 or IPv6).
|
||||
/// @brief IP address of the kea-dhcp-ddns server (IPv4 or IPv6).
|
||||
isc::asiolink::IOAddress server_ip_;
|
||||
|
||||
/// @brief IP port of the b10-dhcp-ddns server.
|
||||
/// @brief IP port of the kea-dhcp-ddns server.
|
||||
size_t server_port_;
|
||||
|
||||
/// @brief IP address on which the client should send
|
||||
@@ -236,11 +236,11 @@ private:
|
||||
/// @brief Maxium number of NCRs allowed to queue waiting to send
|
||||
size_t max_queue_size_;
|
||||
|
||||
/// @brief The socket protocol to use with b10-dhcp-ddns.
|
||||
/// @brief The socket protocol to use with kea-dhcp-ddns.
|
||||
/// Currently only UDP is supported.
|
||||
dhcp_ddns::NameChangeProtocol ncr_protocol_;
|
||||
|
||||
/// @brief Format of the b10-dhcp-ddns requests.
|
||||
/// @brief Format of the kea-dhcp-ddns requests.
|
||||
/// Currently only JSON format is supported.
|
||||
dhcp_ddns::NameChangeFormat ncr_format_;
|
||||
|
||||
|
@@ -17,7 +17,7 @@
|
||||
|
||||
/// @file d2_client_mgr.h Defines the D2ClientMgr class.
|
||||
/// This file defines the class Kea uses to act as a client of the
|
||||
/// b10-dhcp-ddns module (aka D2).
|
||||
/// kea-dhcp-ddns module (aka D2).
|
||||
///
|
||||
#include <asiolink/io_address.h>
|
||||
#include <dhcp_ddns/ncr_io.h>
|
||||
@@ -35,7 +35,7 @@ namespace isc {
|
||||
namespace dhcp {
|
||||
|
||||
/// @brief Defines the type for D2 IO error handler.
|
||||
/// This callback is invoked when a send to b10-dhcp-ddns completes with a
|
||||
/// This callback is invoked when a send to kea-dhcp-ddns completes with a
|
||||
/// failed status. This provides the application layer (Kea) with a means to
|
||||
/// handle the error appropriately.
|
||||
///
|
||||
@@ -51,9 +51,9 @@ boost::function<void(const dhcp_ddns::NameChangeSender::Result result,
|
||||
/// @brief D2ClientMgr isolates Kea from the details of being a D2 client.
|
||||
///
|
||||
/// Provides services for managing the current dhcp-ddns configuration and
|
||||
/// as well as communications with b10-dhcp-ddns. Regarding configuration it
|
||||
/// as well as communications with kea-dhcp-ddns. Regarding configuration it
|
||||
/// provides services to store, update, and access the current dhcp-ddns
|
||||
/// configuration. As for b10-dhcp-ddns communications, D2ClientMgr creates
|
||||
/// configuration. As for kea-dhcp-ddns communications, D2ClientMgr creates
|
||||
/// maintains a NameChangeSender appropriate to the current configuration and
|
||||
/// provides services to start, stop, and post NCRs to the sender. Additionally
|
||||
/// there are methods to examine the queue of requests currently waiting for
|
||||
@@ -247,7 +247,7 @@ public:
|
||||
template <class T>
|
||||
void adjustDomainName(const T& fqdn, T& fqdn_resp);
|
||||
|
||||
/// @brief Enables sending NameChangeRequests to b10-dhcp-ddns
|
||||
/// @brief Enables sending NameChangeRequests to kea-dhcp-ddns
|
||||
///
|
||||
/// Places the NameChangeSender into send mode. This instructs the
|
||||
/// sender to begin dequeuing and transmitting requests and to accept
|
||||
@@ -270,7 +270,7 @@ public:
|
||||
void startSender(D2ClientErrorHandler error_handler,
|
||||
isc::asiolink::IOService& io_service);
|
||||
|
||||
/// @brief Enables sending NameChangeRequests to b10-dhcp-ddns
|
||||
/// @brief Enables sending NameChangeRequests to kea-dhcp-ddns
|
||||
///
|
||||
/// Places the NameChangeSender into send mode. This instructs the
|
||||
/// sender to begin dequeuing and transmitting requests and to accept
|
||||
@@ -293,7 +293,7 @@ public:
|
||||
/// messages for transmission, false otherwise.
|
||||
bool amSending() const;
|
||||
|
||||
/// @brief Disables sending NameChangeRequests to b10-dhcp-ddns
|
||||
/// @brief Disables sending NameChangeRequests to kea-dhcp-ddns
|
||||
///
|
||||
/// Takes the NameChangeSender out of send mode. The sender will stop
|
||||
/// transmitting requests, though any queued requests remain queued.
|
||||
@@ -303,10 +303,10 @@ public:
|
||||
/// may throw NCRSenderExceptions exceptions.
|
||||
void stopSender();
|
||||
|
||||
/// @brief Send the given NameChangeRequests to b10-dhcp-ddns
|
||||
/// @brief Send the given NameChangeRequests to kea-dhcp-ddns
|
||||
///
|
||||
/// Passes NameChangeRequests to the NCR sender for transmission to
|
||||
/// b10-dhcp-ddns. If the sender rejects the message, the client's error
|
||||
/// kea-dhcp-ddns. If the sender rejects the message, the client's error
|
||||
/// handler will be invoked. The most likely cause for rejection is
|
||||
/// the senders' queue has reached maximum capacity.
|
||||
///
|
||||
|
@@ -150,39 +150,39 @@ the new parameters.
|
||||
|
||||
% DHCPSRV_DHCP_DDNS_ERROR_EXCEPTION error handler for DHCP_DDNS IO generated an expected exception: %1
|
||||
This is an error message that occurs when an attempt to send a request to
|
||||
b10-dhcp-ddns fails there registered error handler threw an uncaught exception.
|
||||
kea-dhcp-ddns fails there registered error handler threw an uncaught exception.
|
||||
This is a programmatic error which should not occur. By convention, the error
|
||||
handler should not propagate exceptions. Please report this error.
|
||||
|
||||
% DHCPSRV_DHCP_DDNS_HANDLER_NULL error handler for DHCP_DDNS IO is not set.
|
||||
This is an error message that occurs when an attempt to send a request to
|
||||
b10-dhcp-ddns fails and there is no registered error handler. This is a
|
||||
kea-dhcp-ddns fails and there is no registered error handler. This is a
|
||||
programmatic error which should never occur and should be reported.
|
||||
|
||||
% DHCPSRV_DHCP_DDNS_NCR_REJECTED NameChangeRequest rejected by the sender: %1, ncr: %2
|
||||
This is an error message indicating that NameChangeSender used to deliver DDNS
|
||||
update requests to b10-dhcp-ddns rejected the request. This most likely cause
|
||||
update requests to kea-dhcp-ddns rejected the request. This most likely cause
|
||||
is the sender's queue has reached maximum capacity. This would imply that
|
||||
requests are being generated faster than they can be delivered.
|
||||
|
||||
% DHCPSRV_DHCP_DDNS_NCR_SENT NameChangeRequest sent to b10-dhcp-ddns: %1
|
||||
% DHCPSRV_DHCP_DDNS_NCR_SENT NameChangeRequest sent to kea-dhcp-ddns: %1
|
||||
A debug message issued when a NameChangeRequest has been successfully sent to
|
||||
b10-dhcp-ddns.
|
||||
kea-dhcp-ddns.
|
||||
|
||||
% DHCPSRV_DHCP_DDNS_SENDER_STARTED NameChangeRequest sender has been started: %1
|
||||
A informational message issued when a communications with b10-dhcp-ddns has
|
||||
A informational message issued when a communications with kea-dhcp-ddns has
|
||||
been successfully started.
|
||||
|
||||
% DHCPSRV_DHCP_DDNS_SENDER_STOPPED NameChangeRequest sender has been stopped.
|
||||
A informational message issued when a communications with b10-dhcp-ddns has
|
||||
A informational message issued when a communications with kea-dhcp-ddns has
|
||||
been stopped. This normally occurs during reconfiguration and as part of normal
|
||||
shutdown. It may occur if b10-dhcp-ddns communications breakdown.
|
||||
shutdown. It may occur if kea-dhcp-ddns communications breakdown.
|
||||
|
||||
% DHCPSRV_DHCP_DDNS_SUSPEND_UPDATES DHCP_DDNS updates are being suspended.
|
||||
This is a warning message indicating the DHCP_DDNS updates have been turned
|
||||
off. This should only occur if IO errors communicating with b10-dhcp-ddns
|
||||
off. This should only occur if IO errors communicating with kea-dhcp-ddns
|
||||
have been experienced. Any such errors should have preceding entries in the
|
||||
log with details. No further attempts to communicate with b10-dhcp-ddns will
|
||||
log with details. No further attempts to communicate with kea-dhcp-ddns will
|
||||
be made without intervention.
|
||||
|
||||
% DHCPSRV_HOOK_LEASE4_RENEW_SKIP DHCPv4 lease was not renewed because a callout set the skip flag.
|
||||
|
@@ -72,8 +72,8 @@ public:
|
||||
|
||||
/// @brief Updates the D2ClientMgr's configuration to DDNS enabled.
|
||||
///
|
||||
/// @param server_address IP address of b10-dhcp-ddns.
|
||||
/// @param server_port IP port number of b10-dhcp-ddns.
|
||||
/// @param server_address IP address of kea-dhcp-ddns.
|
||||
/// @param server_port IP port number of kea-dhcp-ddns.
|
||||
/// @param protocol NCR protocol to use. (Currently only UDP is
|
||||
/// supported).
|
||||
void enableDdns(const std::string& server_address,
|
||||
|
@@ -853,8 +853,8 @@
|
||||
<refsect1>
|
||||
<title>SEE ALSO</title>
|
||||
<para>
|
||||
<citerefentry><refentrytitle>b10-dhcp4</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>b10-dhcp6</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>kea-dhcp4</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>kea-dhcp6</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
|
||||
<citetitle>BIND 10 Guide</citetitle>,
|
||||
<citetitle>DHCP Performance Guide</citetitle>.
|
||||
</para>
|
||||
|
Reference in New Issue
Block a user