puppet-script man page

puppet-script — Run a puppet manifests as a script without compiling a catalog

Synopsis

Runs a puppet language script without compiling a catalog.

Usage

puppet script [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose] [-e|--execute] [-l|--logdest syslog|eventlog|FILE|console] [--noop] file

Description

This is a standalone puppet script runner tool; use it to run puppet code without compiling a catalog.

When provided with a modulepath, via command line or config file, puppet script can load functions, types, tasks and plans from modules.

Options

Note that any setting that´s valid in the configuration file is also a valid long argument. For example, ´environment´ is a valid setting, so you can specify ´--environment mytest´ as an argument.

See the configuration file documentation at https://puppet.com/docs/puppet/latest/configuration.html for the full list of acceptable parameters. A commented list of all configuration options can also be generated by running puppet with ´--genconfig´.

--debug

Enable full debugging.

--help

Print this help message

--logdest

Where to send log messages. Choose between ´syslog´ (the POSIX syslog service), ´eventlog´ (the Windows Event Log), ´console´, or the path to a log file. Defaults to ´console´.

A path ending with ´.json´ will receive structured output in JSON format. The log file will not have an ending ´]´ automatically written to it due to the appending nature of logging. It must be appended manually to make the content valid JSON.

--noop

Use ´noop´ mode where Puppet runs in a no-op or dry-run mode. This is useful for seeing what changes Puppet will make without actually executing the changes. Applies to tasks only.

--execute

Execute a specific piece of Puppet code

--verbose

Print extra information.

Example

$ puppet script -l /tmp/manifest.log manifest.pp
$ puppet script --modulepath=/root/dev/modules -e ´notice("hello world")´

Author

Henrik Lindberg

Info

January 2019 Puppet, Inc. Puppet manual