Puppet Function: validate_ip_address

Defined in:
vendor_modules/stdlib/lib/puppet/functions/validate_ip_address.rb
Function type:
Ruby 4.x API

Summary

Validate the passed value represents an ip_address.

Overview

validate_ip_address(Any $scope, Any *$args) ⇒ Boolean

Parameters:

  • scope (Any) —

    The main value that will be passed to the method

  • *args (Any) —

    Any additional values that are to be passed to the method

Returns:

  • (Boolean) —

    `true` or `false` A boolean value returned from the called function.



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

Puppet::Functions.create_function(:validate_ip_address) do
  # @param scope
  #   The main value that will be passed to the method
  #
  # @param args
  #   Any additional values that are to be passed to the method
  #
  # @return [Boolean] `true` or `false`
  #   A boolean value returned from the called function.
  dispatch :deprecation_gen do
    param 'Any', :scope
    repeated_param 'Any', :args
  end
  # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff
  #   -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1.
  def call(scope, *args)
    manipulated_args = [scope] + args
    self.class.dispatcher.dispatch(self, scope, manipulated_args)
  end

  def deprecation_gen(scope, *args)
    call_function('deprecation', 'validate_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.')
    scope.send('function_validate_ip_address', args)
  end
end