Puppet Function: validate_ipv4_address

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

Overview

validate_ipv4_address()Any

Examples:

*Usage*

The following values will pass:

  $my_ip = "1.2.3.4"
  validate_ipv4_address($my_ip)
  validate_ipv4_address("8.8.8.8", "172.16.0.1", $my_ip)

The following values will fail, causing compilation to abort:

  $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ]
  validate_ipv4_address($some_array)

Returns:

  • (Any)

    passes when the given values are valid IPv4 addresses or raise an error when they are not and fails compilation



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
# File 'modules/stdlib/lib/puppet/parser/functions/validate_ipv4_address.rb', line 5

newfunction(:validate_ipv4_address, :doc => <<-DOC
  @summary
    Validate that all values passed are valid IPv4 addresses.
    Fail compilation if any value fails this check.

  @return
    passes when the given values are valid IPv4 addresses or raise an error when they are not and fails compilation

  @example **Usage**
    The following values will pass:

      $my_ip = "1.2.3.4"
      validate_ipv4_address($my_ip)
      validate_ipv4_address("8.8.8.8", "172.16.0.1", $my_ip)

    The following values will fail, causing compilation to abort:

      $some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ]
      validate_ipv4_address($some_array)
  DOC
           ) do |args|

  function_deprecation([:validate_ipv4_address, 'This method is deprecated, please use the stdlib validate_legacy function,
                          with Stdlib::Compat::Ipv4. There is further documentation for validate_legacy function in the README.'])

  require 'ipaddr'
  rescuable_exceptions = [ArgumentError]

  if defined?(IPAddr::InvalidAddressError)
    rescuable_exceptions << IPAddr::InvalidAddressError
  end

  if args.empty?
    raise Puppet::ParseError, "validate_ipv4_address(): wrong number of arguments (#{args.length}; must be > 0)"
  end

  args.each do |arg|
    unless arg.is_a?(String)
      raise Puppet::ParseError, "#{arg.inspect} is not a string."
    end

    begin
      unless IPAddr.new(arg).ipv4?
        raise Puppet::ParseError, "#{arg.inspect} is not a valid IPv4 address."
      end
    rescue *rescuable_exceptions
      raise Puppet::ParseError, "#{arg.inspect} is not a valid IPv4 address."
    end
  end
end