7#ifndef DHCPSRV_CONFIG_H
8#define DHCPSRV_CONFIG_H
35#include <boost/shared_ptr.hpp>
60 : subnet_(
boost::dynamic_pointer_cast<
Subnet>(subnet)),
61 d2_client_enabled_(d2_client_enabled) {}
71 : subnet_(
boost::dynamic_pointer_cast<
Subnet>(subnet)),
72 d2_client_enabled_(d2_client_enabled) {}
157 return (subnet_->getID());
168 bool d2_client_enabled_;
287 return (cfg_option_def_);
298 return (cfg_option_def_);
308 return (cfg_option_);
318 return (cfg_option_);
326 return (cfg_subnets4_);
335 return (cfg_shared_networks4_);
344 return (cfg_shared_networks6_);
352 return (cfg_subnets4_);
360 return (cfg_subnets6_);
368 return (cfg_subnets6_);
410 return (cfg_expiration_);
419 return (cfg_expiration_);
446 return (cfg_db_access_);
455 return (cfg_db_access_);
464 return (cfg_host_operations4_);
473 return (cfg_host_operations4_);
482 return (cfg_host_operations6_);
491 return (cfg_host_operations6_);
498 return (cfg_consist_);
508 return (cfg_mac_source_);
516 return (cfg_mac_source_);
523 return (control_socket_);
530 control_socket_ = control_socket;
537 return (dhcp_queue_control_);
544 dhcp_queue_control_ = dhcp_queue_control;
551 return (dhcp_multi_threading_);
558 dhcp_multi_threading_ = dhcp_multi_threading;
566 return (class_dictionary_);
574 return (class_dictionary_);
581 class_dictionary_ = dictionary;
588 return (hooks_config_);
595 return (hooks_config_);
744 virtual void merge(ConfigBase& other);
767 decline_timer_ = decline_timer;
776 return (decline_timer_);
786 echo_v4_client_id_ = echo;
793 return (echo_v4_client_id_);
803 dhcp4o6_port_ = port;
812 return (dhcp4o6_port_);
819 return (d2_client_config_);
826 return (d2_client_config_);
833 d2_client_config_ = d2_client_config;
843 return (configured_globals_);
853 return (configured_globals_);
862 return (configured_globals_->get(name));
871 return (configured_globals_->get(index));
881 configured_globals_->clear();
897 configured_globals_->set(name, value);
911 const std::string& name)
const;
955 reservations_lookup_first_ = first;
964 return (reservations_lookup_first_);
977 lenient_option_parsing_ = value;
984 return lenient_option_parsing_;
1128 uint32_t decline_timer_;
1131 bool echo_v4_client_id_;
1137 uint16_t dhcp4o6_port_;
1150 bool lenient_option_parsing_;
1158 bool reservations_lookup_first_;
Wrapper class that holds MAC/hardware address sources.
ReplaceClientNameMode
Defines the client name replacement modes.
Convenience container for conveying DDNS behavioral parameters It is intended to be created per Packe...
std::string getHostnameCharReplacement() const
Returns the string to replace invalid characters when scrubbing hostnames.
bool getUseConflictResolution() const
Returns whether or not keah-dhcp-ddns should use conflict resolution.
D2ClientConfig::ReplaceClientNameMode getReplaceClientNameMode() const
Returns how Kea should handle the domain-name supplied by the client.
std::string getGeneratedPrefix() const
Returns the Prefix Kea should use when generating domain-names.
isc::util::str::StringSanitizerPtr getHostnameSanitizer() const
Returns a regular expression string sanitizer.
std::string getHostnameCharSet() const
Returns the regular expression describing invalid characters for client hostnames.
SubnetID getSubnetId() const
Returns the subnet-id of the subnet associated with these parameters.
DdnsParams(const Subnet4Ptr &subnet, bool d2_client_enabled)
Constructor for DHPCv4 subnets.
std::string getQualifyingSuffix() const
Returns the suffix Kea should use when to qualify partial domain-names.
bool getUpdateOnRenew() const
Returns whether or not DNS should be updated when leases renew.
bool getOverrideNoUpdate() const
Returns whether or not Kea should perform updates, even if client requested no updates.
DdnsParams(const Subnet6Ptr &subnet, bool d2_client_enabled)
Constructor for DHPCv6 subnets.
DdnsParams()
Default constructor.
bool getEnableUpdates() const
Returns whether or not DHCP DDNS updating is enabled.
bool getOverrideClientUpdate() const
Returns whether or not Kea should perform updates, even if client requested delegation.
Specifies current DHCP configuration.
ClientClassDictionaryPtr getClientClassDictionary()
Returns pointer to the dictionary of global client class definitions.
static const uint32_t CFGSEL_SUBNET4
Number of IPv4 subnets.
ConstCfgOptionDefPtr getCfgOptionDef() const
Returns pointer to the const object representing user-defined option definitions.
static void moveDdnsParams(isc::data::ElementPtr srv_elem)
Moves deprecated parameters from dhcp-ddns element to global element.
const ConstCfgOptionPtr getCfgOption() const
Returns pointer to the const object holding options.
void setDhcp4o6Port(uint16_t port)
Sets DHCP4o6 IPC port.
void addConfiguredGlobal(const std::string &name, isc::data::ConstElementPtr value)
Adds a parameter to the collection configured globals.
CfgGlobalsPtr getConfiguredGlobals()
Returns non-const pointer to configured global parameters.
ConstCfgGlobalsPtr getConfiguredGlobals() const
Returns const pointer to configured global parameters.
void setLenientOptionParsing(bool const value)
Set lenient option parsing compatibility flag.
bool getReservationsLookupFirst() const
Returns whether the server does host reservations lookup before lease lookup.
const ClientClassDictionaryPtr getClientClassDictionary() const
Returns pointer to const dictionary of global client class definitions.
const D2ClientConfigPtr getD2ClientConfig() const
Returns pointer to const D2 client configuration.
void clearConfiguredGlobals()
Removes all configured global parameters.
void setClientClassDictionary(const ClientClassDictionaryPtr &dictionary)
Sets the client class dictionary.
ConstCfgSubnets6Ptr getCfgSubnets6() const
Returns pointer to const object holding subnets configuration for DHCPv6.
virtual void merge(ConfigBase &other)
Merges the configuration specified as a parameter into this configuration.
void extractConfiguredGlobals(isc::data::ConstElementPtr config)
Saves scalar elements from the global scope of a configuration.
static const uint32_t CFGSEL_ALL
Whole config.
ConstCfgDUIDPtr getCfgDUID() const
Returns const pointer to the object holding configuration of the server identifier.
bool nequals(const SrvConfig &other) const
Compares two objects for inequality.
bool operator!=(const SrvConfig &other) const
other An object to be compared with this object.
isc::data::ConstElementPtr getConfiguredGlobal(std::string name) const
Returns pointer to a given configured global parameter.
CfgSharedNetworks6Ptr getCfgSharedNetworks6() const
Returns pointer to non-const object holding configuration of shared networks in DHCPv6.
static const uint32_t CFGSEL_ALL6
IPv6 related config.
void setD2ClientConfig(const D2ClientConfigPtr &d2_client_config)
Sets the D2 client configuration.
static const uint32_t CFGSEL_NONE
Nothing selected.
void applyDefaultsConfiguredGlobals(const isc::data::SimpleDefaults &defaults)
Applies defaults to global parameters.
void setIPReservationsUnique(const bool unique)
Configures the server to allow or disallow specifying multiple hosts with the same IP address/subnet.
void configureLowerLevelLibraries() const
Convenience method to propagate configuration parameters through inversion of control.
static const uint32_t CFGSEL_IFACE4
Number of enabled ifaces.
CfgDUIDPtr getCfgDUID()
Returns pointer to the object holding configuration of the server identifier.
bool sequenceEquals(const SrvConfig &other)
Compares configuration sequence with other sequence.
static const uint32_t CFGSEL_GLOBALS
Configured globals.
isc::data::ConstElementPtr getConfiguredGlobal(int index) const
Returns pointer to a given configured global parameter.
CfgConsistencyPtr getConsistency()
Returns const pointer to object holding sanity checks flags.
CfgSubnets4Ptr getCfgSubnets4()
Returns pointer to non-const object holding subnets configuration for DHCPv4.
CfgSubnets6Ptr getCfgSubnets6()
Returns pointer to non-const object holding subnets configuration for DHCPv6.
CfgOptionDefPtr getCfgOptionDef()
Return pointer to non-const object representing user-defined option definitions.
uint16_t getDhcp4o6Port() const
Returns DHCP4o6 IPC port.
D2ClientConfigPtr getD2ClientConfig()
Returns pointer to the D2 client configuration.
bool operator==(const SrvConfig &other) const
Equality operator.
CfgRSOOPtr getCfgRSOO()
Returns pointer to the non-const object representing set of RSOO-enabled options.
CfgHostOperationsPtr getCfgHostOperations6()
Returns pointer to the object holding general configuration for host reservations in DHCPv6.
void setReservationsLookupFirst(const bool first)
Sets whether the server does host reservations lookup before lease lookup.
ConstCfgHostOperationsPtr getCfgHostOperations6() const
Returns const pointer to the object holding general configuration for host reservations in DHCPv6.
const isc::data::ConstElementPtr getDHCPMultiThreading() const
Returns DHCP multi threading information.
bool getEchoClientId() const
Returns whether server should send back client-id in DHCPv4.
void setDHCPQueueControl(const isc::data::ConstElementPtr dhcp_queue_control)
Sets information about the dhcp queue control.
void sanityChecksLifetime(const std::string &name) const
Conducts sanity checks on global lifetime parameters.
ConstCfgIfacePtr getCfgIface() const
Returns const pointer to interface configuration.
ConstCfgExpirationPtr getCfgExpiration() const
Returns pointer to the const object holding configuration pertaining to processing expired leases.
std::string getConfigSummary(const uint32_t selection) const
Returns summary of the configuration in the textual format.
const isc::data::ConstElementPtr getDHCPQueueControl() const
Returns DHCP queue control information.
const isc::hooks::HooksConfig & getHooksConfig() const
Returns const reference to configured hooks libraries.
bool equals(const SrvConfig &other) const
Compares two objects for equality.
uint32_t getSequence() const
Returns configuration sequence number.
CfgIfacePtr getCfgIface()
Returns non-const pointer to interface configuration.
static const uint32_t CFGSEL_DDNS
DDNS enabled/disabled.
void setDeclinePeriod(const uint32_t decline_timer)
Sets decline probation-period.
uint32_t getDeclinePeriod() const
Returns probation-period.
void removeStatistics()
Removes statistics.
ConstCfgHostsPtr getCfgHosts() const
Returns pointer to the const objects representing host reservations for different IPv4 and IPv6 subne...
CfgExpirationPtr getCfgExpiration()
Returns pointer to the object holding configuration pertaining to processing expired leases.
const CfgMACSource & getMACSources() const
Returns const reference to an array that stores MAC/hardware address sources.
CfgOptionPtr getCfgOption()
Returns pointer to the non-const object holding options.
virtual isc::data::ElementPtr toElement() const
Unparse a configuration object.
bool getLenientOptionParsing() const
Get lenient option parsing compatibility flag.
ConstCfgRSOOPtr getCfgRSOO() const
Returns pointer to the const object representing set of RSOO-enabled options.
static const uint32_t CFGSEL_SUBNET6
Number of IPv6 subnets.
isc::hooks::HooksConfig & getHooksConfig()
Returns non-const reference to configured hooks libraries.
void updateStatistics()
Updates statistics.
ConstCfgDbAccessPtr getCfgDbAccess() const
Returns const pointer to the object holding configuration of the lease and host database connection p...
static const uint32_t CFGSEL_SUBNET
Number of all subnets.
static const uint32_t CFGSEL_ALL4
IPv4 related config.
void setDHCPMultiThreading(const isc::data::ConstElementPtr dhcp_multi_threading)
Sets information about the dhcp multi threading.
CfgDbAccessPtr getCfgDbAccess()
Returns pointer to the object holding configuration of the lease and host database connection paramet...
void setEchoClientId(const bool echo)
Sets whether server should send back client-id in DHCPv4.
void copy(SrvConfig &new_config) const
Copies the current configuration to a new configuration.
CfgSharedNetworks4Ptr getCfgSharedNetworks4() const
Returns pointer to non-const object holding configuration of shared networks in DHCPv4;.
CfgHostsPtr getCfgHosts()
Returns pointer to the non-const objects representing host reservations for different IPv4 and IPv6 s...
void setControlSocketInfo(const isc::data::ConstElementPtr &control_socket)
Sets information about the control socket.
static const uint32_t CFGSEL_IFACE6
Number of v6 ifaces.
ConstCfgSubnets4Ptr getCfgSubnets4() const
Returns pointer to const object holding subnets configuration for DHCPv4.
static const uint32_t CFGSEL_CFG_CTL
Config control info.
const isc::data::ConstElementPtr getControlSocketInfo() const
Returns information about control socket.
DdnsParamsPtr getDdnsParams(const Subnet4Ptr &subnet) const
Fetches the DDNS parameters for a given DHCPv4 subnet.
SrvConfig()
Default constructor.
ConstCfgHostOperationsPtr getCfgHostOperations4() const
Returns const pointer to the object holding general configuration for host reservations in DHCPv4.
CfgHostOperationsPtr getCfgHostOperations4()
Returns pointer to the object holding general configuration for host reservations in DHCPv4.
CfgMACSource & getMACSources()
Returns non-const reference to an array that stores MAC/hardware address sources.
Wrapper class that holds hooks libraries configuration.
Base class for all configurations.
Defines classes for storing client class definitions.
Defines the D2ClientConfig class.
boost::shared_ptr< const Element > ConstElementPtr
std::vector< SimpleDefault > SimpleDefaults
This specifies all default values in a given scope (e.g. a subnet).
boost::shared_ptr< Element > ElementPtr
boost::shared_ptr< const CfgOptionDef > ConstCfgOptionDefPtr
Const pointer.
boost::shared_ptr< CfgDUID > CfgDUIDPtr
Pointer to the Non-const object.
boost::shared_ptr< CfgHostOperations > CfgHostOperationsPtr
Pointer to the Non-const object.
boost::shared_ptr< const CfgDUID > ConstCfgDUIDPtr
Pointer to the const object.
boost::shared_ptr< const CfgGlobals > ConstCfgGlobalsPtr
Const shared pointer to a CfgGlobals instance.
boost::shared_ptr< Subnet > SubnetPtr
A generic pointer to either Subnet4 or Subnet6 object.
boost::shared_ptr< Subnet4 > Subnet4Ptr
A pointer to a Subnet4 object.
boost::shared_ptr< const CfgHosts > ConstCfgHostsPtr
Const pointer.
boost::shared_ptr< D2ClientConfig > D2ClientConfigPtr
Defines a pointer for D2ClientConfig instances.
boost::shared_ptr< const SrvConfig > ConstSrvConfigPtr
Const pointer to the SrvConfig.
boost::shared_ptr< CfgOption > CfgOptionPtr
Non-const pointer.
boost::shared_ptr< CfgOptionDef > CfgOptionDefPtr
Non-const pointer.
boost::shared_ptr< CfgDbAccess > CfgDbAccessPtr
A pointer to the CfgDbAccess.
boost::shared_ptr< const CfgExpiration > ConstCfgExpirationPtr
Pointer to the const object.
boost::shared_ptr< const CfgIface > ConstCfgIfacePtr
A pointer to the const CfgIface.
boost::shared_ptr< Subnet6 > Subnet6Ptr
A pointer to a Subnet6 object.
boost::shared_ptr< const CfgDbAccess > ConstCfgDbAccessPtr
A pointer to the const CfgDbAccess.
boost::shared_ptr< const CfgRSOO > ConstCfgRSOOPtr
Pointer to the const object.
boost::shared_ptr< const CfgHostOperations > ConstCfgHostOperationsPtr
Pointer to the const object.
boost::shared_ptr< CfgIface > CfgIfacePtr
A pointer to the CfgIface .
boost::shared_ptr< DdnsParams > DdnsParamsPtr
Defines a pointer for DdnsParams instances.
boost::shared_ptr< SrvConfig > SrvConfigPtr
Non-const pointer to the SrvConfig.
boost::shared_ptr< CfgSubnets6 > CfgSubnets6Ptr
Non-const pointer.
boost::shared_ptr< CfgExpiration > CfgExpirationPtr
boost::shared_ptr< CfgGlobals > CfgGlobalsPtr
Non-const shared pointer to a CfgGlobals instance.
boost::shared_ptr< ClientClassDictionary > ClientClassDictionaryPtr
Defines a pointer to a ClientClassDictionary.
boost::shared_ptr< CfgSharedNetworks6 > CfgSharedNetworks6Ptr
Pointer to the configuration of IPv6 shared networks.
uint32_t SubnetID
Defines unique IPv4 or IPv6 subnet identifier.
boost::shared_ptr< CfgHosts > CfgHostsPtr
Non-const pointer.
boost::shared_ptr< CfgSubnets4 > CfgSubnets4Ptr
Non-const pointer.
boost::shared_ptr< const CfgSubnets4 > ConstCfgSubnets4Ptr
Const pointer.
boost::shared_ptr< const CfgSubnets6 > ConstCfgSubnets6Ptr
Const pointer.
boost::shared_ptr< CfgConsistency > CfgConsistencyPtr
Type used to for pointing to CfgConsistency structure.
boost::shared_ptr< CfgSharedNetworks4 > CfgSharedNetworks4Ptr
Pointer to the configuration of IPv4 shared networks.
boost::shared_ptr< CfgRSOO > CfgRSOOPtr
Pointer to the Non-const object.
boost::shared_ptr< const CfgOption > ConstCfgOptionPtr
Const pointer.
boost::shared_ptr< StringSanitizer > StringSanitizerPtr
Type representing the pointer to the StringSanitizer.
Defines the logger used by the top-level component of kea-lfc.