1PUPPET-SCRIPT(8)                 Puppet manual                PUPPET-SCRIPT(8)
2
3
4

NAME

6       puppet-script  - Run a puppet manifests as a script without compiling a
7       catalog
8

SYNOPSIS

10       Runs a puppet language script without compiling a catalog.
11

USAGE

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

DESCRIPTION

18       This is a standalone puppet script runner tool; use it  to  run  puppet
19       code without compiling a catalog.
20
21       When  provided with a modulepath, via command line or config file, pup‐
22       pet script can load functions, types, tasks and plans from modules.
23

OPTIONS

25       Note that any setting that´s valid in the configuration file is also  a
26       valid  long argument. For example, ´environment´ is a valid setting, so
27       you can specify ´--environment mytest´ as an argument.
28
29       See   the   configuration   file    documentation    at    https://pup‐
30       pet.com/docs/puppet/latest/configuration.html  for the full list of ac‐
31       ceptable parameters. A commented list of all configuration options  can
32       also be generated by running puppet with ´--genconfig´.
33
34       --debug
35              Enable full debugging.
36
37       --help Print this help message
38
39       --logdest
40              Where  to  send log messages. Choose between ´syslog´ (the POSIX
41              syslog service), ´eventlog´ (the Windows Event Log),  ´console´,
42              or  the path to a log file. Defaults to ´console´. Multiple des‐
43              tinations  can  be  set  using  a  comma  separated  list   (eg:
44              /path/file1,console,/path/file2)"
45
46              A  path  ending  with  ´.json´ will receive structured output in
47              JSON format. The log file will not have an ending ´]´  automati‐
48              cally  written  to it due to the appending nature of logging. It
49              must be appended manually to make the content valid JSON.
50
51              A path ending with ´.jsonl´ will receive  structured  output  in
52              JSON Lines format.
53
54       --noop Use  ´noop´  mode  where Puppet runs in a no-op or dry-run mode.
55              This is useful for seeing what changes Puppet will make  without
56              actually executing the changes. Applies to tasks only.
57
58       --execute
59              Execute a specific piece of Puppet code
60
61       --verbose
62              Print extra information.
63

EXAMPLE

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

AUTHOR

69       Henrik Lindberg
70

72       Copyright  (c)  2017 Puppet Inc., LLC Licensed under the Apache 2.0 Li‐
73       cense
74
75
76
77Puppet, Inc.                     October 2021                 PUPPET-SCRIPT(8)
Impressum