Puppet Function: getvar

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

Overview

getvar()Any

> *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. The new function also has support for digging into a structured value. See the built-in [`getvar`](puppet.com/docs/puppet/latest/function.html#getvar) funct

Examples:

Example usage

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

Where namespace is stored in a string

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

Returns:

  • (Any)

    undef - if variable does not exist



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

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

  @return
    undef - if variable does not exist

  @example Example usage
    $foo = getvar('site::data::foo') # Equivalent to $foo = $site::data::foo

  @example Where namespace is stored in a string
    $datalocation = 'site::data'
    $bar = getvar("${datalocation}::bar") # Equivalent to $bar = $site::data::bar

  > **Note:** from Puppet 6.0.0, the compatible function with the same name in Puppet core
  will be used instead of this function. The new function also has support for
  digging into a structured value. See the built-in
  [`getvar`](https://puppet.com/docs/puppet/latest/function.html#getvar) function
  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 inconsistent 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