Puppet Function: options_lookup

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

Overview

options_lookup() ⇒ Any

This fuction takes two arguments (option, and default value) and looks for the given option key in the calling modules options hash, and returns the value. The function is intended to be used in templates. If no option is found in the options hash, default value (second argument), is returned.

Default value of no

<%= scope.function_options_lookup(['PasswordAuthentication', 'no']) %>

Empty default value

<%= scope.function_options_lookup(['PasswordAuthentication', '']) %>

Fact or param based default value

<%= scope.function_options_lookup(['Listen', ipaddress]) %>

Lookup inside a custom hash - in this case client_options

<%= scope.function_options_lookup(['PasswordAuthentication', 'no', 'client_options']) %>

Returns:

  • (Any) 


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
 
# File 'lib/puppet/parser/functions/options_lookup.rb', line 24

newfunction(:options_lookup, :type => :rvalue, :doc => <<-EOS
This fuction takes two arguments (option, and default value) and looks for the given
option key in the calling modules options hash, and returns the value.
The function is intended to be used in templates.
If no option is found in the options hash, default value (second argument), is returned.

Default value of no
<%= scope.function_options_lookup(['PasswordAuthentication', 'no']) %>
Empty default value
<%= scope.function_options_lookup(['PasswordAuthentication', '']) %>
Fact or param based default value
 <%= scope.function_options_lookup(['Listen', ipaddress]) %>
Lookup inside a custom hash - in this case client_options
 <%= scope.function_options_lookup(['PasswordAuthentication', 'no', 'client_options']) %>

EOS
) do |args|

  raise ArgumentError, ("options_lookup(): wrong number of arguments (#{args.length}; must be 2 or 3)") if (args.length != 2 and args.length != 3)

  value = ''
  option_name = args[0]
  default_val = args[1]
  hash_name = args[2]
  module_name = parent_module_name

  hash_name = "options" if (hash_name == :undefined || hash_name == '' || hash_name == nil)
  value = lookupvar("#{module_name}::#{hash_name}")["#{option_name}"] if (lookupvar("#{module_name}::#{hash_name}").size > 0)
  value = "#{default_val}" if (value == :undefined || value == '' || value == nil)

  return value
end