Go to main content

man pages section 8: System Administration Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

puppet-script (8)

Name

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

Synopsis

Runs a puppet language script without compiling a catalog.

Description

PUPPET-SCRIPT(8)                 Puppet manual                PUPPET-SCRIPT(8)



NAME
       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, pup-
       pet 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://docs.puppet-
       labs.com/puppet/latest/reference/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 ']'  automati-
              cally  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

COPYRIGHT
       Copyright (c) 2017 Puppet Inc.,  LLC  Licensed  under  the  Apache  2.0
       License



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | system/management/puppet |
       +---------------+--------------------------+
       |Stability      | Volatile                 |
       +---------------+--------------------------+
NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source  was  downloaded  from  https://github.com/puppetlabs/puppet/ar-
       chive/5.5.0.tar.gz

       Further information about this software can be found on the open source
       community website at http://puppetlabs.com/.



Puppet, Inc.                      March 2018                  PUPPET-SCRIPT(8)