Puppet Function: dns_mx

Defined in:
lib/puppet/parser/functions/dns_mx.rb
Function type:
Ruby 3.x API

Overview

dns_mx() ⇒ Any

Retrieves DNS MX records and returns it as an array. Each record in the array will be an array of [preference, exchange] arrays. Second argument is optional and can be either ‘preference’ or ‘exchange’, if supplied an array of only those elements is returned.

Returns:

  • (Any) 


2
3
4
5
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
 
# File 'lib/puppet/parser/functions/dns_mx.rb', line 2

newfunction(:dns_mx, :type => :rvalue, :arity => -2, :doc => <<-EOS
  Retrieves DNS MX records and returns it as an array. Each record in the
  array will be an array of [preference, exchange] arrays.
  Second argument is optional and can be either 'preference' or 'exchange',
  if supplied an array of only those elements is returned.
  EOS
) do |arguments|
  require 'resolv'

  raise(ArgumentError, "dns_mx(): Wrong number of arguments " +
        "given (#{arguments.size} for 1 or 2)") if arguments.size > 2

  ret = Resolv::DNS.new.getresources(arguments[0],Resolv::DNS::Resource::IN::MX).collect do |res|
    if arguments.size == 1 then
      [res.preference, res.exchange.to_s]
    else
      case arguments[1]
      when 'preference'
        res.preference
      when 'exchange'
        res.exchange.to_s
      else
        raise ArgumentError, "dns_mx(): invalid value #{arguments[1]} for second argument"
      end
    end
  end
  raise Resolv::ResolvError, "DNS result has no information for #{arguments[0]}" if ret.empty?
  ret
end