path: root/man/man8/puppet-catalog.8

.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "PUPPET\-CATALOG" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
.
.SH "NAME"
\fBpuppet\-catalog\fR \- Compile, save, view, and convert catalogs\.
.
.SH "SYNOPSIS"
puppet catalog \fIaction\fR [\-\-terminus TERMINUS]
.
.SH "DESCRIPTION"
This subcommand deals with catalogs, which are compiled per\-node artifacts generated from a set of Puppet manifests\. By default, it interacts with the compiling subsystem and compiles a catalog using the default manifest and \fBcertname\fR, but you can change the source of the catalog with the \fB\-\-terminus\fR option\. You can also choose to print any catalog in \'dot\' format (for easy graph viewing with OmniGraffle or Graphviz) with \'\-\-render\-as dot\'\.
.
.SH "OPTIONS"
Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR is a valid configuration parameter, so you can specify \fB\-\-server <servername>\fR as an argument\.
.
.P
See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
.
.TP
\-\-mode MODE
The run mode to use for the current action\. Valid modes are \fBuser\fR, \fBagent\fR, and \fBmaster\fR\.
.
.TP
\-\-render\-as FORMAT
The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\.
.
.TP
\-\-verbose
Whether to log verbosely\.
.
.TP
\-\-debug
Whether to log debug information\.
.
.TP
\-\-terminus TERMINUS
Indirector faces expose indirected subsystems of Puppet\. These subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR) from an arbitrary number of pluggable backends\. In Puppet parlance, these backends are called terminuses\.
.
.IP
Almost all indirected subsystems have a \fBrest\fR terminus that interacts with the puppet master\'s data\. Most of them have additional terminuses for various local data models, which are in turn used by the indirected subsystem on the puppet master whenever it receives a remote request\.
.
.IP
The terminus for an action is often determined by context, but occasionally needs to be set explicitly\. See the "Notes" section of this face\'s manpage for more details\.
.
.SH "ACTIONS"
.
.TP
\fBapply\fR \- Find and apply a catalog\.
\fBSYNOPSIS\fR
.
.IP
puppet catalog apply [\-\-terminus TERMINUS]
.
.IP
\fBDESCRIPTION\fR
.
.IP
Finds and applies a catalog\. This action takes no arguments, but the source of the catalog can be managed with the \fB\-\-terminus\fR option\.
.
.IP
\fBRETURNS\fR
.
.IP
Nothing\. When used from the Ruby API, returns a Puppet::Transaction::Report object\.
.
.TP
\fBdestroy\fR \- Invalid for this subcommand\.
\fBSYNOPSIS\fR
.
.IP
puppet catalog destroy [\-\-terminus TERMINUS] \fIkey\fR
.
.IP
\fBDESCRIPTION\fR
.
.IP
Invalid for this subcommand\.
.
.TP
\fBdownload\fR \- Download this node\'s catalog from the puppet master server\.
\fBSYNOPSIS\fR
.
.IP
puppet catalog download [\-\-terminus TERMINUS]
.
.IP
\fBDESCRIPTION\fR
.
.IP
Retrieves a catalog from the puppet master and saves it to the local yaml cache\. This action always contacts the puppet master and will ignore alternate termini\.
.
.IP
The saved catalog can be used in any subsequent catalog action by specifying \'\-\-terminus yaml\' for that action\.
.
.IP
\fBRETURNS\fR
.
.IP
Nothing\.
.
.IP
\fBNOTES\fR
.
.IP
When used from the Ruby API, this action has a side effect of leaving Puppet::Resource::Catalog\.indirection\.terminus_class set to yaml\. The terminus must be explicitly re\-set for subsequent catalog actions\.
.
.TP
\fBfind\fR \- Retrieve the catalog for a node\.
\fBSYNOPSIS\fR
.
.IP
puppet catalog find [\-\-terminus TERMINUS] \fIcertname\fR
.
.IP
\fBDESCRIPTION\fR
.
.IP
Retrieve the catalog for a node\.
.
.IP
\fBRETURNS\fR
.
.IP
A serialized catalog\. When used from the Ruby API, returns a Puppet::Resource::Catalog object\.
.
.TP
\fBinfo\fR \- Print the default terminus class for this face\.
\fBSYNOPSIS\fR
.
.IP
puppet catalog info [\-\-terminus TERMINUS]
.
.IP
\fBDESCRIPTION\fR
.
.IP
Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-mode\' option\.
.
.TP
\fBsave\fR \- API only: create or overwrite an object\.
\fBSYNOPSIS\fR
.
.IP
puppet catalog save [\-\-terminus TERMINUS]
.
.IP
\fBDESCRIPTION\fR
.
.IP
API only: create or overwrite an object\. As the Faces framework does not currently accept data from STDIN, save actions cannot currently be invoked from the command line\.
.
.TP
\fBsearch\fR \- Invalid for this subcommand\.
\fBSYNOPSIS\fR
.
.IP
puppet catalog search [\-\-terminus TERMINUS] \fIquery\fR
.
.IP
\fBDESCRIPTION\fR
.
.IP
Invalid for this subcommand\.
.
.TP
\fBselect\fR \- Retrieve a catalog and filter it for resources of a given type\.
\fBSYNOPSIS\fR
.
.IP
puppet catalog select [\-\-terminus TERMINUS] \fIhost\fR \fIresource_type\fR
.
.IP
\fBDESCRIPTION\fR
.
.IP
Retrieves a catalog for the specified host, then searches it for all resources of the requested type\.
.
.IP
\fBRETURNS\fR
.
.IP
A list of resource references ("Type[title]")\. When used from the API, returns an array of Puppet::Resource objects excised from a catalog\.
.
.IP
\fBNOTES\fR
.
.IP
By default, this action will retrieve a catalog from Puppet\'s compiler subsystem; you must call the action with \fB\-\-terminus rest\fR if you wish to retrieve a catalog from the puppet master\.
.
.IP
FORMATTING ISSUES: This action cannot currently render useful yaml; instead, it returns an entire catalog\. Use json instead\.
.
.SH "EXAMPLES"
\fBapply\fR
.
.P
Apply the locally cached catalog:
.
.P
$ puppet catalog apply \-\-terminus yaml
.
.P
Retrieve a catalog from the master and apply it, in one step:
.
.P
$ puppet catalog apply \-\-terminus rest
.
.P
From \fBsecret_agent\.rb\fR (API example):
.
.IP "" 4
.
.nf

# \.\.\.
Puppet::Face[:catalog, \'0\.0\.1\']\.download
# (Termini are singletons; catalog\.download has a side effect of
# setting the catalog terminus to yaml)
report  = Puppet::Face[:catalog, \'0\.0\.1\']\.apply
# \.\.\.
.
.fi
.
.IP "" 0
.
.P
\fBdownload\fR
.
.P
Retrieve and store a catalog:
.
.P
$ puppet catalog download
.
.P
From \fBsecret_agent\.rb\fR (API example):
.
.IP "" 4
.
.nf

Puppet::Face[:plugin, \'0\.0\.1\']\.download
Puppet::Face[:facts, \'0\.0\.1\']\.upload
Puppet::Face[:catalog, \'0\.0\.1\']\.download
# \.\.\.
.
.fi
.
.IP "" 0
.
.P
\fBselect\fR
.
.P
Ask the puppet master for a list of managed file resources for a node:
.
.P
$ puppet catalog select \-\-terminus rest somenode\.magpie\.lan file
.
.SH "NOTES"
This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR actions for an indirected subsystem of Puppet\. Valid termini for this face include:
.
.IP "\(bu" 4
\fBactive_record\fR
.
.IP "\(bu" 4
\fBcompiler\fR
.
.IP "\(bu" 4
\fBqueue\fR
.
.IP "\(bu" 4
\fBrest\fR
.
.IP "\(bu" 4
\fBstatic_compiler\fR
.
.IP "\(bu" 4
\fByaml\fR
.
.IP "" 0
.
.SH "COPYRIGHT AND LICENSE"
Copyright 2011 by Puppet Labs Apache 2 license; see COPYING