Puppet Function: is_ip_address

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

Overview

is_ip_address()Boolean

> *Note: *Deprecated* Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).

Returns:

  • (Boolean)

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

newfunction(:is_ip_address, :type => :rvalue, :doc => <<-DOC
  @summary
    **Deprecated:** Returns true if the string passed to this function is a valid IP address.

  @return [Boolean]
    Returns `true` or `false`

  > **Note:* **Deprecated** Will be removed in a future version of stdlib. See
  [`validate_legacy`](#validate_legacy).
  DOC
           ) do |arguments|

  require 'ipaddr'

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

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

  begin
    ip = IPAddr.new(arguments[0])
  rescue ArgumentError
    return false
  end

  return true if ip.ipv4? || ip.ipv6?
  return false
end