Puppet Function: has_ip_address

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

Overview

has_ip_address() ⇒ Any

Returns true if the client has the requested IP address on some interface.

This function iterates through the 'interfaces' fact and checks the 'ipaddress_IFACE' facts, performing a simple string comparison.

Returns:

  • (Any) 


6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'puppet/modules/stdlib/lib/puppet/parser/functions/has_ip_address.rb', line 6

newfunction(:has_ip_address, :type => :rvalue, :doc => <<-EOS
Returns true if the client has the requested IP address on some interface.

This function iterates through the 'interfaces' fact and checks the
'ipaddress_IFACE' facts, performing a simple string comparison.
  EOS
) do |args|

  raise(Puppet::ParseError, "has_ip_address(): Wrong number of arguments " +
        "given (#{args.size} for 1)") if args.size != 1

  Puppet::Parser::Functions.autoloader.load(:has_interface_with) \
    unless Puppet::Parser::Functions.autoloader.loaded?(:has_interface_with)

  function_has_interface_with(['ipaddress', args[0]])

end