bolt-modules/boltlib/lib/puppet/functions/run_command.rb in bolt-2.16.0 vs bolt-modules/boltlib/lib/puppet/functions/run_command.rb in bolt-2.17.0

- old
+ new

@@ -11,10 +11,11 @@ # @param command A command to run on target. # @param targets A pattern identifying zero or more targets. See {get_targets} for accepted patterns. # @param options A hash of additional options. # @option options [Boolean] _catch_errors Whether to catch raised errors. # @option options [String] _run_as User to run as using privilege escalation. + # @option options [Hash] _env_vars Map of environment variables to set # @return A list of results, one entry per target. # @example Run a command on targets # run_command('hostname', $targets, '_catch_errors' => true) dispatch :run_command do param 'String[1]', :command @@ -28,9 +29,10 @@ # @param targets A pattern identifying zero or more targets. See {get_targets} for accepted patterns. # @param description A description to be output when calling this function. # @param options A hash of additional options. # @option options [Boolean] _catch_errors Whether to catch raised errors. # @option options [String] _run_as User to run as using privilege escalation. + # @option options [Hash] _env_vars Map of environment variables to set # @return A list of results, one entry per target. # @example Run a command on targets # run_command('hostname', $targets, 'Get hostname') dispatch :run_command_with_description do param 'String[1]', :command