Puppet Function: has_interface_with

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

Overview

has_interface_with()Any

Valid kinds are `macaddress`, `netmask`, `ipaddress` and `network`.

Examples:

*Usage*

has_interface_with("macaddress", "x:x:x:x:x:x") # Returns `false`
has_interface_with("ipaddress", "127.0.0.1") # Returns `true`

If no “kind” is given, then the presence of the interface is checked:

has_interface_with("lo") # Returns `true`

Returns:

  • (Any)

    boolean values `true` or `false`



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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# File 'modules/stdlib/lib/puppet/parser/functions/has_interface_with.rb', line 5

newfunction(:has_interface_with, :type => :rvalue, :doc => <<-DOC
  @summary
    Returns boolean based on kind and value.

  @return
    boolean values `true` or `false`

  Valid kinds are `macaddress`, `netmask`, `ipaddress` and `network`.

  @example **Usage**
    has_interface_with("macaddress", "x:x:x:x:x:x") # Returns `false`
    has_interface_with("ipaddress", "127.0.0.1") # Returns `true`

  @example If no "kind" is given, then the presence of the interface is checked:
    has_interface_with("lo") # Returns `true`
  DOC
           ) do |args|

  raise(Puppet::ParseError, "has_interface_with(): Wrong number of arguments given (#{args.size} for 1 or 2)") if args.empty? || args.size > 2

  interfaces = lookupvar('interfaces')

  # If we do not have any interfaces, then there are no requested attributes
  return false if interfaces == :undefined || interfaces.nil?

  interfaces = interfaces.split(',')

  if args.size == 1
    return interfaces.member?(args[0])
  end

  kind, value = args

  # Bug with 3.7.1 - 3.7.3  when using future parser throws :undefined_variable
  # https://tickets.puppetlabs.com/browse/PUP-3597
  factval = nil
  begin
    catch :undefined_variable do
      factval = lookupvar(kind)
    end
  rescue Puppet::ParseError # rubocop:disable Lint/HandleExceptions : Eat the exception if strict_variables = true is set
  end
  if factval == value
    return true
  end

  result = false
  interfaces.each do |iface|
    iface.downcase!
    factval = nil
    begin
      # Bug with 3.7.1 - 3.7.3 when using future parser throws :undefined_variable
      # https://tickets.puppetlabs.com/browse/PUP-3597
      catch :undefined_variable do
        factval = lookupvar("#{kind}_#{iface}")
      end
    rescue Puppet::ParseError # rubocop:disable Lint/HandleExceptions : Eat the exception if strict_variables = true is set
    end
    if value == factval
      result = true
      break
    end
  end

  result
end