NAME¶
puppet-apply - Apply Puppet manifests locally
SYNOPSIS¶
Applies a standalone Puppet manifest to the local system.
USAGE¶
puppet apply [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose]
[-e|--execute] [--detailed-exitcodes] [-L|--loadclasses] [-l|--logdest
syslog|eventlog|
FILE|console] [--noop] [--catalog
catalog]
[--write-catalog-summary]
file
DESCRIPTION¶
This is the standalone puppet execution tool; use it to apply individual
manifests.
When provided with a modulepath, via command line or config file, puppet apply
can effectively mimic the catalog that would be served by puppet master with
access to the same modules, although there are some subtle differences. When
combined with scheduling and an automated system for pushing manifests, this
can be used to implement a serverless Puppet site.
Most users should use ´puppet agent´ and ´puppet
master´ for site-wide manifests.
OPTIONS¶
Note that any setting that´s valid in the configuration file is also a
valid long argument. For example, ´tags´ is a valid setting, so
you can specify ´--tags
class,
tag´ as an argument.
See the configuration file documentation at
https://docs.puppetlabs.com/references/stable/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.
- •
- --detailed-exitcodes: Provide transaction information via exit codes. If
this is enabled, an exit code of ´2´ means there were
changes, an exit code of ´4´ means there were failures
during the transaction, and an exit code of ´6´ means there
were both changes and failures.
- •
- --help: Print this help message
- •
- --loadclasses: Load any stored classes. ´puppet agent´
caches configured classes (usually at /etc/puppetlabs/puppet/classes.txt),
and setting this option causes all of those classes to be set in your
puppet manifest.
- •
- --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.
- •
- --execute: Execute a specific piece of Puppet code
- •
- --test: Enable the most common options used for testing. These are
´verbose´, ´detailed-exitcodes´ and
´show_diff´.
- •
- --verbose: Print extra information.
- •
- --catalog: Apply a JSON catalog (such as one generated with ´puppet
master --compile´). You can either specify a JSON file or pipe in
JSON from standard input.
- •
- --write-catalog-summary After compiling the catalog saves the resource
list and classes list to the node in the state directory named classes.txt
and resources.txt
-
EXAMPLE¶
$ puppet apply -l /tmp/manifest.log manifest.pp
$ puppet apply --modulepath=/root/dev/modules -e "include ntpd::server"
$ puppet apply --catalog catalog.json
AUTHOR¶
Luke Kanies
COPYRIGHT¶
Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
