puppet 2.6.18 → 2.7.1

data/man/man8/puppet-node.8

@@ -0,0 +1,171 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-NODE" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-node\fR \- View and manage node definitions\.
+.
+.SH "SYNOPSIS"
+puppet node \fIaction\fR [\-\-terminus TERMINUS]
+.
+.SH "DESCRIPTION"
+This subcommand interacts with node objects, which are used by Puppet to build a catalog\. A node object consists of the node\'s facts, environment, node parameters (exposed in the parser as top\-scope variables), and classes\.
+.
+.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
+\fBdestroy\fR \- Invalid for this subcommand\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet node destroy [\-\-terminus TERMINUS] \fIkey\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Invalid for this subcommand\.
+.
+.TP
+\fBfind\fR \- Retrieve a node object\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet node find [\-\-terminus TERMINUS] \fIhost\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Retrieve a node object\.
+.
+.IP
+\fBRETURNS\fR
+.
+.IP
+A hash containing the node\'s \fBclasses\fR, \fBenvironment\fR, \fBexpiration\fR, \fBname\fR, \fBparameters\fR (its facts, combined with any ENC\-set parameters), and \fBtime\fR\. When used from the Ruby API: a Puppet::Node object\.
+.
+.IP
+RENDERING ISSUES: Rendering as string and json are currently broken; node objects can only be rendered as yaml\.
+.
+.TP
+\fBinfo\fR \- Print the default terminus class for this face\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet node 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 \- Invalid for this subcommand\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet node save [\-\-terminus TERMINUS]
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Invalid for this subcommand\.
+.
+.TP
+\fBsearch\fR \- Invalid for this subcommand\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet node search [\-\-terminus TERMINUS] \fIquery\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Invalid for this subcommand\.
+.
+.SH "EXAMPLES"
+\fBfind\fR
+.
+.P
+Retrieve an "empty" (no classes, no ENC\-imposed parameters, and an environment of "production") node:
+.
+.P
+$ puppet node find somenode\.puppetlabs\.lan \-\-terminus plain \-\-render\-as yaml
+.
+.P
+Retrieve a node using the puppet master\'s configured ENC:
+.
+.P
+$ puppet node find somenode\.puppetlabs\.lan \-\-terminus exec \-\-mode master \-\-render\-as yaml
+.
+.P
+Retrieve the same node from the puppet master:
+.
+.P
+$ puppet node find somenode\.puppetlabs\.lan \-\-terminus rest \-\-render\-as yaml
+.
+.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
+\fBexec\fR
+.
+.IP "\(bu" 4
+\fBldap\fR
+.
+.IP "\(bu" 4
+\fBmemory\fR
+.
+.IP "\(bu" 4
+\fBplain\fR
+.
+.IP "\(bu" 4
+\fBrest\fR
+.
+.IP "\(bu" 4
+\fByaml\fR
+.
+.IP "" 0
+.
+.SH "COPYRIGHT AND LICENSE"
+Copyright 2011 by Puppet Labs Apache 2 license; see COPYING

data/man/man8/puppet-parser.8

@@ -0,0 +1,71 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-PARSER" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-parser\fR \- Interact directly with the parser\.
+.
+.SH "SYNOPSIS"
+puppet parser \fIaction\fR
+.
+.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\.
+.
+.SH "ACTIONS"
+.
+.TP
+\fBvalidate\fR \- Validate the syntax of one or more Puppet manifests\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet parser validate [\fImanifest\fR] [\fImanifest\fR \.\.\.]
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+This action validates Puppet DSL syntax without compiling a catalog or syncing any resources\. If no manifest files are provided, it will validate the default site manifest\.
+.
+.IP
+\fBRETURNS\fR
+.
+.IP
+Nothing, or the first syntax error encountered\.
+.
+.SH "EXAMPLES"
+\fBvalidate\fR
+.
+.P
+Validate the default site manifest at /etc/puppet/manifests/site\.pp:
+.
+.P
+$ puppet parser validate
+.
+.P
+Validate two arbitrary manifest files:
+.
+.P
+$ puppet parser validate init\.pp vhost\.pp
+.
+.SH "COPYRIGHT AND LICENSE"
+Copyright 2011 by Puppet Labs Apache 2 license; see COPYING

data/man/man8/puppet-plugin.8

@@ -0,0 +1,77 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-PLUGIN" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-plugin\fR \- Interact with the Puppet plugin system\.
+.
+.SH "SYNOPSIS"
+puppet plugin \fIaction\fR
+.
+.SH "DESCRIPTION"
+This subcommand provides network access to the puppet master\'s store of plugins\.
+.
+.P
+The puppet master serves Ruby code collected from the \fBlib\fR directories of its modules\. These plugins can be used on agent nodes to extend Facter and implement custom types and providers\. Plugins are normally downloaded by puppet agent during the course of a run\.
+.
+.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\.
+.
+.SH "ACTIONS"
+.
+.TP
+\fBdownload\fR \- Download plugins from the puppet master\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet plugin download
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Downloads plugins from the configured puppet master\. Any plugins downloaded in this way will be used in all subsequent Puppet activity\. This action modifies files on disk\.
+.
+.IP
+\fBRETURNS\fR
+.
+.IP
+A list of the files downloaded, or a confirmation that no files were downloaded\. When used from the Ruby API, this action returns an array of the files downloaded, which will be empty if none were retrieved\.
+.
+.SH "EXAMPLES"
+\fBdownload\fR
+.
+.P
+Retrieve plugins from the puppet master:
+.
+.P
+$ puppet plugin download
+.
+.P
+Retrieve plugins from the puppet master (API example):
+.
+.P
+$ Puppet::Face[:plugin, \'0\.0\.1\']\.download
+.
+.SH "COPYRIGHT AND LICENSE"
+Copyright 2011 by Puppet Labs Apache 2 license; see COPYING

data/man/man8/puppet-queue.8

@@ -0,0 +1,55 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-QUEUE" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-queue\fR \- Queuing daemon for asynchronous storeconfigs
+.
+.SH "SYNOPSIS"
+Retrieves serialized storeconfigs records from a queue and processes them in order\.
+.
+.SH "USAGE"
+puppet queue [\-d|\-\-debug] [\-v|\-\-verbose]
+.
+.SH "DESCRIPTION"
+This application runs as a daemon and processes storeconfigs data, retrieving the data from a stomp server message queue and writing it to a database\.
+.
+.P
+For more information, including instructions for properly setting up your puppet master and message queue, see the documentation on setting up asynchronous storeconfigs at: http://projects\.puppetlabs\.com/projects/1/wiki/Using_Stored_Configuration
+.
+.SH "OPTIONS"
+Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument\. For example, \'server\' is a valid configuration parameter, so you can specify \'\-\-server \fIservername\fR\' as an argument\.
+.
+.P
+See the configuration file documentation at http://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 queue with \'\-\-genconfig\'\.
+.
+.TP
+\-\-debug
+Enable full debugging\.
+.
+.TP
+\-\-help
+Print this help message
+.
+.TP
+\-\-verbose
+Turn on verbose reporting\.
+.
+.TP
+\-\-version
+Print the puppet version number and exit\.
+.
+.SH "EXAMPLE"
+.
+.nf
+
+$ puppet queue
+.
+.fi
+.
+.SH "AUTHOR"
+Luke Kanies
+.
+.SH "COPYRIGHT"
+Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License

data/man/man8/puppet-report.8

@@ -0,0 +1,187 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-REPORT" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-report\fR \- Create, display, and submit reports\.
+.
+.SH "SYNOPSIS"
+puppet report \fIaction\fR [\-\-terminus TERMINUS]
+.
+.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
+\fBdestroy\fR \- Invalid for this face\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet report destroy [\-\-terminus TERMINUS] \fIkey\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Invalid for this face\.
+.
+.TP
+\fBfind\fR \- Invalid for this face\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet report find [\-\-terminus TERMINUS] \fIkey\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Invalid for this face\.
+.
+.TP
+\fBinfo\fR \- Print the default terminus class for this face\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet report 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: submit a report\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet report save [\-\-terminus TERMINUS] \fIreport\fR
+.
+.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\.
+.
+.IP
+\fBRETURNS\fR
+.
+.IP
+Nothing\.
+.
+.TP
+\fBsearch\fR \- Invalid for this face\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet report search [\-\-terminus TERMINUS] \fIquery\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Invalid for this face\.
+.
+.TP
+\fBsubmit\fR \- API only: submit a report with error handling\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet report submit [\-\-terminus TERMINUS] \fIreport\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+API only: Submits a report to the puppet master\. This action is essentially a shortcut and wrapper for the \fBsave\fR action with the \fBrest\fR terminus, and provides additional details in the event of a failure\.
+.
+.SH "EXAMPLES"
+\fBsave\fR
+.
+.P
+From the implementation of \fBpuppet report submit\fR (API example):
+.
+.IP "" 4
+.
+.nf
+
+begin
+  Puppet::Transaction::Report\.indirection\.terminus_class = :rest
+  Puppet::Face[:report, "0\.0\.1"]\.save(report)
+  Puppet\.notice "Uploaded report for #{report\.name}"
+rescue => detail
+  puts detail\.backtrace if Puppet[:trace]
+  Puppet\.err "Could not send report: #{detail}"
+end
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fBsubmit\fR
+.
+.P
+From secret_agent\.rb (API example):
+.
+.IP "" 4
+.
+.nf
+
+# \.\.\.
+report  = Puppet::Face[:catalog, \'0\.0\.1\']\.apply
+Puppet::Face[:report, \'0\.0\.1\']\.submit(report)
+return report
+.
+.fi
+.
+.IP "" 0
+.
+.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
+\fBprocessor\fR
+.
+.IP "\(bu" 4
+\fBrest\fR
+.
+.IP "\(bu" 4
+\fByaml\fR
+.
+.IP "" 0
+.
+.SH "COPYRIGHT AND LICENSE"
+Copyright 2011 by Puppet Labs Apache 2 license; see COPYING