Puppet Function: dnsquery::mx

Defined in:
vendor_modules/dnsquery/lib/puppet/functions/dnsquery/mx.rb
Function type:
Ruby 4.x API

Overview

dnsquery::mx(Stdlib::Fqdn $domain, Optional[Optional[Dnsquery::Config_info]] $config_info, Optional[Callable] &$block) ⇒ Array[Dnsquery::Mx]

Retrieves DNS MX records for a domain and returns them as an array.

Parameters:

  • domain (Stdlib::Fqdn) —

    the dns domain to lookup

  • config_info (Optional[Optional[Dnsquery::Config_info]]) —

    used to override the config for Resolve::DNS.new

  • &block (Optional[Callable]) —

    an optional lambda to return a default value in case the lookup fails

Returns:

  • (Array[Dnsquery::Mx]) —

    An array of hashes representing the mx records for domain



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'vendor_modules/dnsquery/lib/puppet/functions/dnsquery/mx.rb', line 6

Puppet::Functions.create_function(:'dnsquery::mx') do
  # @param domain the dns domain to lookup
  # @param config_info used to override the config for Resolve::DNS.new
  # @param block an optional lambda to return a default value in case the lookup fails
  # @return An array of hashes representing the mx records for domain
  dispatch :dns_mx do
    param 'Stdlib::Fqdn', :domain
    optional_param 'Optional[Dnsquery::Config_info]', :config_info
    optional_block_param :block
    return_type 'Array[Dnsquery::Mx]'
  end

  def dns_mx(domain, config_info = nil)
    resolver = PuppetX::Voxpupuli::Dnsquery::Utils.resolver(config_info)
    ret = resolver.getresources(
      domain, Resolv::DNS::Resource::IN::MX
    ).map do |res|
      {
        'preference' => res.preference,
        'exchange' => res.exchange.to_s
      }
    end
    block_given? && ret.empty? ? yield : ret
  rescue Resolv::ResolvError
    block_given? ? yield : raise
  end
end