REFERENCE.md

Reference

Table of Contents

Classes

• dnsclient: Manage DNS resolver

Classes

dnsclient

This module manages /etc/resolv.conf.

Parameters

The following parameters are available in the dnsclient class:

• nameservers
• nameserver_limit
• options
• search
• domain
• sortlist
• custom_lines
• resolver_config_file
• resolver_config_file_ensure
• resolver_config_file_owner
• resolver_config_file_group
• resolver_config_file_mode
• resolver_config_backup

nameservers

Data type: Array[Stdlib::IP::Address]

Array of nameservers. The default use Google's public name servers.

Default value: ['8.8.8.8', '8.8.4.4']

nameserver_limit

Data type: Optional[Integer[0]]

Integer of the number of nameservers to allow in the resolv.conf NOTE: If 'nameservers' is over this limit, only the first X nameservers will be used where X is set by this limit. The nameservers over the limit will be discarded.

Default value: undef

options

Data type: Array

Array of options. Set to [] if no options line should be present.

Default value: ['rotate', 'timeout:1']

search

Data type: Optional[Array[String[1]]]

Optional array of domains for search list. This is mutually exclusive with domain.

Default value: undef

domain

Data type: Optional[Stdlib::Fqdn]

Optional domain setting. This is mutually exclusive with search.

Default value: undef

sortlist

Data type: Optional[Array[String[1]]]

Optional array of sortlist entries

Default value: undef

custom_lines

Data type: Array[String[1]]

Array of lines that will be added to the end of /etc/resolv.conf

Default value: []

resolver_config_file

Data type: Stdlib::Absolutepath

Path to resolv.conf

Default value: '/etc/resolv.conf'

resolver_config_file_ensure

Data type: String[1]

Value of ensure attribute for the /etc/resolv.conf file resource

Default value: 'file'

resolver_config_file_owner

Data type: String[1]

User of /etc/resolv.conf

Default value: 'root'

resolver_config_file_group

Data type: String[1]

Group of /etc/resolv.conf

Default value: 'root'

resolver_config_file_mode

Data type: Stdlib::Filemode

Mode of /etc/resolv.conf in octal format

Default value: '0644'

resolver_config_backup

Data type: Optional[Variant[Boolean, String[1]]]

Sets the 'backup' parameter for /etc/resolv.conf

Default value: undef