Kea 2.7.0
isc::dhcp::DdnsParams Class Reference

Convenience container for conveying DDNS behavioral parameters It is intended to be created per Packet exchange using the selected subnet passed into functions that require them. More...

#include <srv_config.h>

Public Member Functions

 DdnsParams ()
 Default constructor.
 
 DdnsParams (const Subnet4Ptr &subnet, bool d2_client_enabled)
 Constructor for DHPCv4 subnets.
 
 DdnsParams (const Subnet6Ptr &subnet, bool d2_client_enabled)
 Constructor for DHPCv6 subnets.
 
std::string getConflictResolutionMode () const
 Returns the DDNS config resolution mode for kea-dhcp-ddns.
 
bool getEnableUpdates () const
 Returns whether or not DHCP DDNS updating is enabled.
 
std::string getGeneratedPrefix () const
 Returns the Prefix Kea should use when generating domain-names.
 
std::string getHostnameCharReplacement () const
 Returns the string to replace invalid characters when scrubbing hostnames.
 
std::string getHostnameCharSet () const
 Returns the regular expression describing invalid characters for client hostnames.
 
isc::util::str::StringSanitizerPtr getHostnameSanitizer () const
 Returns a regular expression string sanitizer.
 
bool getOverrideClientUpdate () const
 Returns whether or not Kea should perform updates, even if client requested delegation.
 
bool getOverrideNoUpdate () const
 Returns whether or not Kea should perform updates, even if client requested no updates.
 
std::string getQualifyingSuffix () const
 Returns the suffix Kea should use when to qualify partial domain-names.
 
D2ClientConfig::ReplaceClientNameMode getReplaceClientNameMode () const
 Returns how Kea should handle the domain-name supplied by the client.
 
SubnetID getSubnetId () const
 Returns the subnet-id of the subnet associated with these parameters.
 
util::Optional< double > getTtlPercent () const
 Returns percent of lease lifetime to use for TTL.
 
bool getUpdateOnRenew () const
 Returns whether or not DNS should be updated when leases renew.
 

Detailed Description

Convenience container for conveying DDNS behavioral parameters It is intended to be created per Packet exchange using the selected subnet passed into functions that require them.

Definition at line 48 of file srv_config.h.

Constructor & Destructor Documentation

◆ DdnsParams() [1/3]

isc::dhcp::DdnsParams::DdnsParams ( )
inline

Default constructor.

Definition at line 51 of file srv_config.h.

◆ DdnsParams() [2/3]

isc::dhcp::DdnsParams::DdnsParams ( const Subnet4Ptr & subnet,
bool d2_client_enabled )
inline

Constructor for DHPCv4 subnets.

Parameters
subnetPointer to Subnet4 instance to use for fetching parameter values (typically this is the selected subnet).
d2_client_enabledflag which indicates whether or not D2Client is enabled (typically the value should come from global D2Client configuration).

Definition at line 60 of file srv_config.h.

◆ DdnsParams() [3/3]

isc::dhcp::DdnsParams::DdnsParams ( const Subnet6Ptr & subnet,
bool d2_client_enabled )
inline

Constructor for DHPCv6 subnets.

Parameters
subnetPointer to Subnet6 instance to use for fetching parameter values (typically this is the selected subnet).
d2_client_enabledflag which indicates whether or not D2Client is enabled (typically the value should come from global D2Client configuration).

Definition at line 71 of file srv_config.h.

Member Function Documentation

◆ getConflictResolutionMode()

std::string isc::dhcp::DdnsParams::getConflictResolutionMode ( ) const

Returns the DDNS config resolution mode for kea-dhcp-ddns.

This value is communicated to D2 via the NCR.

Returns
the DDNS conflict resolution mode

Definition at line 1079 of file srv_config.cc.

◆ getEnableUpdates()

bool isc::dhcp::DdnsParams::getEnableUpdates ( ) const

Returns whether or not DHCP DDNS updating is enabled.

The value is the logical AND of d2_client_enabled_ and the value returned by subnet_'s getDdnsSendUpdates().

Returns
True if updates are enabled, false otherwise or if subnet_ is empty.

Definition at line 971 of file srv_config.cc.

◆ getGeneratedPrefix()

std::string isc::dhcp::DdnsParams::getGeneratedPrefix ( ) const

Returns the Prefix Kea should use when generating domain-names.

Returns
The value from the subnet_ or an empty string if subnet_ is empty.

Definition at line 1006 of file srv_config.cc.

◆ getHostnameCharReplacement()

std::string isc::dhcp::DdnsParams::getHostnameCharReplacement ( ) const

Returns the string to replace invalid characters when scrubbing hostnames.

Meaningful only if hostname_char_set_ is not empty.

Returns
The value from the subnet_ or an empty string if subnet_ is empty.

Definition at line 1033 of file srv_config.cc.

Referenced by getHostnameSanitizer().

◆ getHostnameCharSet()

std::string isc::dhcp::DdnsParams::getHostnameCharSet ( ) const

Returns the regular expression describing invalid characters for client hostnames.

If empty, host name scrubbing should not be done.

Returns
The value from the subnet_ or an empty string if subnet_ is empty.

Definition at line 1024 of file srv_config.cc.

Referenced by getHostnameSanitizer().

◆ getHostnameSanitizer()

util::str::StringSanitizerPtr isc::dhcp::DdnsParams::getHostnameSanitizer ( ) const

Returns a regular expression string sanitizer.

If the value returned by getHostnameCharSet() is not empty, then it is used in conjunction the value returned by getHostnameCharReplacment() (which may be empty) to create and return a StringSanitizer instance. Otherwise it will return an empty pointer.

Returns
pointer to the StringSanitizer instance or an empty pointer
Exceptions
BadValueif the compilation fails.

Definition at line 1042 of file srv_config.cc.

References getHostnameCharReplacement(), getHostnameCharSet(), and isc_throw.

+ Here is the call graph for this function:

◆ getOverrideClientUpdate()

bool isc::dhcp::DdnsParams::getOverrideClientUpdate ( ) const

Returns whether or not Kea should perform updates, even if client requested delegation.

Returns
The value from the subnet_ or false if subnet_ is empty.

Definition at line 988 of file srv_config.cc.

◆ getOverrideNoUpdate()

bool isc::dhcp::DdnsParams::getOverrideNoUpdate ( ) const

Returns whether or not Kea should perform updates, even if client requested no updates.

Returns
The value from the subnet_ or false if subnet_ is empty.

Definition at line 980 of file srv_config.cc.

◆ getQualifyingSuffix()

std::string isc::dhcp::DdnsParams::getQualifyingSuffix ( ) const

Returns the suffix Kea should use when to qualify partial domain-names.

Returns
The value from the subnet_ or an empty string if subnet_ is empty.

Definition at line 1015 of file srv_config.cc.

◆ getReplaceClientNameMode()

D2ClientConfig::ReplaceClientNameMode isc::dhcp::DdnsParams::getReplaceClientNameMode ( ) const

Returns how Kea should handle the domain-name supplied by the client.

Returns
The value from the subnet_ or RCM_NEVER if subnet_ is empty.

Definition at line 997 of file srv_config.cc.

References isc::dhcp::D2ClientConfig::RCM_NEVER.

◆ getSubnetId()

SubnetID isc::dhcp::DdnsParams::getSubnetId ( ) const
inline

Returns the subnet-id of the subnet associated with these parameters.

Returns
value of subnet-id (or 0 if no subnet is associated)

Definition at line 162 of file srv_config.h.

◆ getTtlPercent()

util::Optional< double > isc::dhcp::DdnsParams::getTtlPercent ( ) const

Returns percent of lease lifetime to use for TTL.

This value, if greater than zero, is used to calculate the lease lifetime passed to D2 in the NCR. Otherwise the value is calculated per RFC 4702.

Returns
TTL percent as an Optional.

Definition at line 1070 of file srv_config.cc.

◆ getUpdateOnRenew()

bool isc::dhcp::DdnsParams::getUpdateOnRenew ( ) const

Returns whether or not DNS should be updated when leases renew.

If this is true, DNS should always be updated when leases are extended (i.e. renewed/rebound) even if the DNS information has not changed.

Returns
True if updates should always be performed.

Definition at line 1061 of file srv_config.cc.


The documentation for this class was generated from the following files: