Puppet Function: simplib::host_is_me

Defined in:
lib/puppet/functions/simplib/host_is_me.rb
Function type:
Ruby 4.x API

Overview

Detect if a local system identifier hostname/IPv4 address matches a specified hostname/IPv4 address or an entry in a list of hostnames and/or IPv4 addresses

Signatures:

  • simplib::host_is_me(Simplib::Host $host) ⇒ Boolean

    Returns true if a local system hostname/IPv4 address matches the specified host.

    Parameters:

    • host (Simplib::Host) —

      Hostname/IPv4 address to compare against; ‘127.0.0.1` is never matched, use `localhost` instead

    Returns:

    • (Boolean) —

      true if a local system hostname/IPv4 address matches the specified host

  • simplib::host_is_me(Array[Simplib::Host] $hosts) ⇒ Boolean

    Returns true if a local system hostname/IPv4 address matches any of the specified hosts.

    Parameters:

    • hosts (Array[Simplib::Host]) —

      Array of Hostnames and/or IPv4 addresses to compare against; ‘127.0.0.1` is never matched, use `localhost` instead

    Returns:

    • (Boolean) —

      true if a local system hostname/IPv4 address matches any of the specified hosts



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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/puppet/functions/simplib/host_is_me.rb', line 5

Puppet::Functions.create_function(:'simplib::host_is_me') do

  # @param host Hostname/IPv4 address to compare against;
  #   `127.0.0.1` is never matched, use `localhost` instead
  # @return [Boolean] true if a local system hostname/IPv4 address matches
  #   the specified host
  dispatch :host_is_me do
    required_param 'Simplib::Host', :host
  end

  # @param hosts Array of Hostnames and/or IPv4 addresses to compare
  #   against; `127.0.0.1` is never matched, use `localhost` instead
  # @return [Boolean] true if a local system hostname/IPv4 address matches
  #   any of the specified hosts
  dispatch :hostlist_contains_me do
    required_param 'Array[Simplib::Host]', :hosts
  end

  def host_is_me(host)
    hostlist_contains_me(Array(host))
  end

  def hostlist_contains_me(hosts)
    retval = false
    scope = closure_scope

    host_identifiers = [
      scope['facts']['fqdn'],
      scope['facts']['hostname'],
      'localhost',
      'localhost.localdomain'
    ]

    # add non-local IPv4 addresses
    host_identifiers += call_function('simplib::ipaddresses', true)

    hosts.each do |id|
      if host_identifiers.include?(id)
        retval = true
        break
      end
    end

    retval
  end
end