Sha256: 40af4d6069dba0bde14b3cbd1a5595776e2879faea56caf3310931c09ee047bc

Contents?: true

Size: 922 Bytes

Versions: 71

Compression:

Stored size: 922 Bytes

Contents

# frozen_string_literal: true

require 'bolt/error'

# Returns a hash of the 'vars' (variables) assigned to a target.
#
# Vars can be assigned through the inventory file or `set_var` function.
# Plan authors can call this function on a target to get the variable hash
# for that target.
Puppet::Functions.create_function(:vars) do
  # @param target The Target object to get variables from. See {get_targets}.
  # @return A hash of the 'vars' (variables) assigned to a target.
  # @example Get vars for a target
  #   $target.vars
  dispatch :vars do
    param 'Target', :target
    return_type 'Hash[String, Data]'
  end

  def vars(target)
    inventory = Puppet.lookup(:bolt_inventory)
    # Bolt executor not expected when invoked from apply block
    executor = Puppet.lookup(:bolt_executor) { nil }
    # Send Analytics Report
    executor&.report_function_call(self.class.name)

    inventory.vars(target)
  end
end

Version data entries

71 entries across 71 versions & 1 rubygems

Version Path
bolt-4.0.0 bolt-modules/boltlib/lib/puppet/functions/vars.rb
bolt-3.29.0 bolt-modules/boltlib/lib/puppet/functions/vars.rb
bolt-3.28.0 bolt-modules/boltlib/lib/puppet/functions/vars.rb
bolt-3.27.4 bolt-modules/boltlib/lib/puppet/functions/vars.rb
bolt-3.27.2 bolt-modules/boltlib/lib/puppet/functions/vars.rb
bolt-3.27.1 bolt-modules/boltlib/lib/puppet/functions/vars.rb
bolt-3.26.2 bolt-modules/boltlib/lib/puppet/functions/vars.rb
bolt-3.26.1 bolt-modules/boltlib/lib/puppet/functions/vars.rb
bolt-3.25.0 bolt-modules/boltlib/lib/puppet/functions/vars.rb
bolt-3.24.0 bolt-modules/boltlib/lib/puppet/functions/vars.rb
bolt-3.23.1 bolt-modules/boltlib/lib/puppet/functions/vars.rb
bolt-3.23.0 bolt-modules/boltlib/lib/puppet/functions/vars.rb
bolt-3.22.1 bolt-modules/boltlib/lib/puppet/functions/vars.rb
bolt-3.22.0 bolt-modules/boltlib/lib/puppet/functions/vars.rb
bolt-3.21.0 bolt-modules/boltlib/lib/puppet/functions/vars.rb
bolt-3.20.0 bolt-modules/boltlib/lib/puppet/functions/vars.rb
bolt-3.19.0 bolt-modules/boltlib/lib/puppet/functions/vars.rb
bolt-3.18.0 bolt-modules/boltlib/lib/puppet/functions/vars.rb
bolt-3.17.0 bolt-modules/boltlib/lib/puppet/functions/vars.rb
bolt-3.16.1 bolt-modules/boltlib/lib/puppet/functions/vars.rb