Puppet Function: getvar

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

Overview

getvar() ⇒ Any

Lookup a variable in a remote namespace.

For example:

$foo = getvar('site::data::foo')
# Equivalent to $foo = $site::data::foo

This is useful if the namespace itself is stored in a string:

$datalocation = 'site::data'
$bar = getvar("${datalocation}::bar")
# Equivalent to $bar = $site::data::

Returns:

  • (Any) 


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 'lib/puppet/parser/functions/getvar.rb', line 5

newfunction(:getvar, :type => :rvalue, :doc => <<-'DOC') do |args|
  Lookup a variable in a remote namespace.

  For example:

      $foo = getvar('site::data::foo')
      # Equivalent to $foo = $site::data::foo

  This is useful if the namespace itself is stored in a string:

      $datalocation = 'site::data'
      $bar = getvar("${datalocation}::bar")
      # Equivalent to $bar = $site::data::bar
  DOC

  unless args.length == 1
    raise Puppet::ParseError, "getvar(): wrong number of arguments (#{args.length}; must be 1)"
  end

  begin
    result = nil
    catch(:undefined_variable) do
      result = lookupvar((args[0]).to_s)
    end

    # avoid relying on incosistent behaviour around ruby return values from catch
    result
  rescue Puppet::ParseError # rubocop:disable Lint/HandleExceptions : Eat the exception if strict_variables = true is set
  end
end