puppet 2.6.18 → 2.7.1

data/man/man8/puppet-facts.8

@@ -0,0 +1,217 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-FACTS" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-facts\fR \- Retrieve and store facts\.
+.
+.SH "SYNOPSIS"
+puppet facts \fIaction\fR [\-\-terminus TERMINUS]
+.
+.SH "DESCRIPTION"
+This subcommand manages facts, which are collections of normalized system information used by Puppet\. It can read facts directly from the local system (with the default \fBfacter\fR terminus), look up facts reported by other systems, and submit facts to the puppet master\.
+.
+.P
+When used with the \fBrest\fR terminus, this subcommand is essentially a front\-end to the inventory service REST API\. See the inventory service documentation at \fIhttp://docs\.puppetlabs\.com/guides/inventory_service\.html\fR for more detail\.
+.
+.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 facts destroy [\-\-terminus TERMINUS] \fIkey\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Invalid for this subcommand\.
+.
+.TP
+\fBfind\fR \- Retrieve a node\'s facts\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet facts find [\-\-terminus TERMINUS] \fInode_certname\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Retrieve a node\'s facts\.
+.
+.IP
+\fBRETURNS\fR
+.
+.IP
+A hash containing some metadata and (under the "values" key) the set of facts for the requested node\. When used from the Ruby API: A Puppet::Node::Facts object\.
+.
+.IP
+RENDERING ISSUES: Facts cannot currently be rendered as a string; use yaml or json\.
+.
+.IP
+\fBNOTES\fR
+.
+.IP
+When using the \fBfacter\fR terminus, the host argument is ignored\.
+.
+.TP
+\fBinfo\fR \- Print the default terminus class for this face\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet facts 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 facts 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 facts search [\-\-terminus TERMINUS] \fIquery\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Invalid for this subcommand\.
+.
+.TP
+\fBupload\fR \- Upload local facts to the puppet master\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet facts upload [\-\-terminus TERMINUS]
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Reads facts from the local system using the \fBfacter\fR terminus, then saves the returned facts using the rest terminus\.
+.
+.IP
+\fBRETURNS\fR
+.
+.IP
+Nothing\.
+.
+.IP
+\fBNOTES\fR
+.
+.IP
+This action requires that the puppet master\'s \fBauth\.conf\fR file allow save access to the \fBfacts\fR REST terminus\. Puppet agent does not use this facility, and it is turned off by default\. See \fIhttp://docs\.puppetlabs\.com/guides/rest_auth_conf\.html\fR for more details\.
+.
+.SH "EXAMPLES"
+\fBfind\fR
+.
+.P
+Get facts from the local system:
+.
+.P
+$ puppet facts find x
+.
+.P
+Ask the puppet master for facts for an arbitrary node:
+.
+.P
+$ puppet facts find somenode\.puppetlabs\.lan \-\-terminus rest
+.
+.P
+Query a DB\-backed inventory directly (bypassing the REST API):
+.
+.P
+$ puppet facts find somenode\.puppetlabs\.lan \-\-terminus inventory_active_record \-\-mode master
+.
+.P
+\fBupload\fR
+.
+.P
+Upload facts:
+.
+.P
+$ puppet facts upload
+.
+.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
+\fBcouch\fR
+.
+.IP "\(bu" 4
+\fBfacter\fR
+.
+.IP "\(bu" 4
+\fBinventory_active_record\fR
+.
+.IP "\(bu" 4
+\fBmemory\fR
+.
+.IP "\(bu" 4
+\fBnetwork_device\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-file.8

@@ -0,0 +1,225 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-FILE" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-file\fR \- Retrieve and store files in a filebucket
+.
+.SH "SYNOPSIS"
+puppet file \fIaction\fR [\-\-terminus TERMINUS]
+.
+.SH "DESCRIPTION"
+This subcommand interacts with objects stored in a local or remote filebucket\. File objects are accessed by their MD5 sum; see the examples for the relevant syntax\.
+.
+.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 file destroy [\-\-terminus TERMINUS] \fIkey\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Invalid for this subcommand\.
+.
+.TP
+\fBdownload\fR \- Download a file into the local filebucket\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet file download [\-\-terminus TERMINUS] ( {md5}\fIchecksum\fR | \fIpuppet_url\fR )
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Downloads a file from the puppet master\'s filebucket and duplicates it in the local filebucket\. This action\'s checksum syntax differs from \fBfind\fR\'s, and it can accept a <puppet:///> URL\.
+.
+.IP
+\fBRETURNS\fR
+.
+.IP
+Nothing\.
+.
+.TP
+\fBfind\fR \- Retrieve a file from the filebucket\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet file find [\-\-terminus TERMINUS] md5/\fImd5sum\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Retrieve a file from the filebucket\.
+.
+.IP
+\fBRETURNS\fR
+.
+.IP
+The file object with the specified checksum\.
+.
+.IP
+RENDERING ISSUES: Rendering as a string returns the contents of the file object; rendering as yaml returns a hash of metadata about said file, including but not limited to its contents\. Rendering as json is currently broken, and returns a hash containing only the contents of the file\.
+.
+.TP
+\fBinfo\fR \- Print the default terminus class for this face\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet file 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 file 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 file search [\-\-terminus TERMINUS] \fIquery\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Invalid for this subcommand\.
+.
+.TP
+\fBstore\fR \- Store a file in the local filebucket\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet file store [\-\-terminus TERMINUS] \fIfile\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Store a file in the local filebucket\.
+.
+.IP
+\fBRETURNS\fR
+.
+.IP
+Nothing\.
+.
+.TP
+\fBupload\fR \- Upload a file to the remote filebucket\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet file upload [\-\-terminus TERMINUS] \fIfile\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Upload a file to the remote filebucket\.
+.
+.SH "EXAMPLES"
+\fBdownload\fR
+.
+.P
+Download a file by URL:
+.
+.P
+$ puppet file download puppet:///modules/editors/vim/\.vimrc
+.
+.P
+Download a file by MD5 sum:
+.
+.P
+$ puppet file download {md5}8f798d4e754db0ac89186bbaeaf0af18
+.
+.P
+\fBfind\fR
+.
+.P
+Retrieve the contents of a file:
+.
+.P
+$ puppet file find md5/9aedba7f413c97dc65895b1cd9421f2c \-\-render\-as s
+.
+.P
+\fBstore\fR
+.
+.P
+Store a file:
+.
+.P
+$ puppet file store /root/\.bashrc
+.
+.SH "NOTES"
+To retrieve the unmunged contents of a file, you must call find with \-\-render\-as s\. Rendering as yaml will return a hash of metadata about the file, including its contents\.
+.
+.P
+This subcommand does not interact with the \fBclientbucketdir\fR (the default local filebucket for puppet agent); it interacts with the primary "master"\-type filebucket located in the \fBbucketdir\fR\. If you wish to interact with puppet agent\'s default filebucket, you\'ll need to set the \fI\-\-bucketdir\fR option appropriately when invoking actions\.
+.
+.P
+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
+\fBfile\fR
+.
+.IP "\(bu" 4
+\fBrest\fR
+.
+.IP "" 0
+.
+.SH "COPYRIGHT AND LICENSE"
+Copyright 2011 by Puppet Labs Apache 2 license; see COPYING

data/man/man8/puppet-filebucket.8

@@ -0,0 +1,81 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-FILEBUCKET" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-filebucket\fR \- Store and retrieve files in a filebucket
+.
+.SH "SYNOPSIS"
+A stand\-alone Puppet filebucket client\.
+.
+.SH "USAGE"
+puppet filebucket \fImode\fR [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] [\-l|\-\-local] [\-r|\-\-remote] [\-s|\-\-server \fIserver\fR] [\-b|\-\-bucket \fIdirectory\fR] \fIfile\fR \fIfile\fR \.\.\.
+.
+.P
+Puppet filebucket can operate in three modes, with only one mode per call:
+.
+.P
+backup: Send one or more files to the specified file bucket\. Each sent file is printed with its resulting md5 sum\.
+.
+.P
+get: Return the text associated with an md5 sum\. The text is printed to stdout, and only one file can be retrieved at a time\.
+.
+.P
+restore: Given a file path and an md5 sum, store the content associated with the sum into the specified file path\. You can specify an entirely new path to this argument; you are not restricted to restoring the content to its original location\.
+.
+.SH "DESCRIPTION"
+This is a stand\-alone filebucket client for sending files to a local or central filebucket\.
+.
+.P
+Note that \'filebucket\' defaults to using a network\-based filebucket available on the server named \'puppet\'\. To use this, you\'ll have to be running as a user with valid Puppet certificates\. Alternatively, you can use your local file bucket by specifying \'\-\-local\'\.
+.
+.SH "OPTIONS"
+Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument\. For example, \'ssldir\' is a valid configuration parameter, so you can specify \'\-\-ssldir \fIdirectory\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 with \'\-\-genconfig\'\.
+.
+.TP
+\-\-debug
+Enable full debugging\.
+.
+.TP
+\-\-help
+Print this help message
+.
+.TP
+\-\-local
+Use the local filebucket\. This will use the default configuration information\.
+.
+.TP
+\-\-remote
+Use a remote filebucket\. This will use the default configuration information\.
+.
+.TP
+\-\-server
+The server to send the file to, instead of locally\.
+.
+.TP
+\-\-verbose
+Print extra information\.
+.
+.TP
+\-\-version
+Print version information\.
+.
+.SH "EXAMPLE"
+.
+.nf
+
+$ puppet filebucket backup /etc/passwd
+/etc/passwd: 429b225650b912a2ee067b0a4cf1e949
+$ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949
+.
+.fi
+.
+.SH "AUTHOR"
+Luke Kanies
+.
+.SH "COPYRIGHT"
+Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License