puppet 2.6.18 → 2.7.1

data/man/man8/puppet-certificate_revocation_list.8

@@ -0,0 +1,165 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-CERTIFICATE_REVOCATION_LIST" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-certificate_revocation_list\fR \- Manage the list of revoked certificates\.
+.
+.SH "SYNOPSIS"
+puppet certificate_revocation_list \fIaction\fR [\-\-terminus TERMINUS]
+.
+.SH "DESCRIPTION"
+This subcommand is primarily for retrieving the certificate revocation list from the CA\.
+.
+.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 \- Delete the certificate revocation list\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet certificate_revocation_list destroy [\-\-terminus TERMINUS] \fIdummy_text\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Deletes the certificate revocation list\. This cannot be done over REST, but it is possible to delete the locally cached copy or the local CA\'s copy of the CRL\.
+.
+.IP
+\fBRETURNS\fR
+.
+.IP
+Nothing\.
+.
+.IP
+\fBNOTES\fR
+.
+.IP
+Although this action always deletes the CRL from the specified terminus, it requires a dummy argument; this is a known bug\.
+.
+.TP
+\fBfind\fR \- Retrieve the certificate revocation list\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet certificate_revocation_list find [\-\-terminus TERMINUS] \fIdummy_text\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Retrieve the certificate revocation list\.
+.
+.IP
+\fBRETURNS\fR
+.
+.IP
+The certificate revocation list\. When used from the Ruby API: returns an OpenSSL::X509::CRL object\.
+.
+.IP
+RENDERING ISSUES: this should usually be rendered as a string (\'\-\-render\-as s\')\.
+.
+.IP
+\fBNOTES\fR
+.
+.IP
+Although this action always returns the CRL from the specified terminus, it requires a dummy argument; this is a known bug\.
+.
+.TP
+\fBinfo\fR \- Print the default terminus class for this face\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet certificate_revocation_list 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 certificate_revocation_list save [\-\-terminus TERMINUS]
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Invalid for this subcommand\.
+.
+.TP
+\fBsearch\fR \- Invalid for this subcommand\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet certificate_revocation_list search [\-\-terminus TERMINUS] \fIquery\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Invalid for this subcommand\.
+.
+.SH "EXAMPLES"
+\fBfind\fR
+.
+.P
+Retrieve a copy of the puppet master\'s CRL:
+.
+.P
+$ puppet certificate_revocation_list find crl \-\-terminus rest
+.
+.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
+\fBca\fR
+.
+.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-config.8

@@ -0,0 +1,80 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-CONFIG" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-config\fR \- Interact with Puppet\'s configuration options\.
+.
+.SH "SYNOPSIS"
+puppet config \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
+\fBprint\fR \- Examine Puppet\'s current configuration settings\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet config print (all | \fIsetting\fR [\fIsetting\fR \.\.\.]
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Prints the value of a single configuration option or a list of configuration options\.
+.
+.IP
+This action is an alternate interface to the information available with \fBpuppet <subcommand> \-\-configprint\fR\.
+.
+.IP
+\fBRETURNS\fR
+.
+.IP
+A single value when called with one config setting, and a list of settings and values when called with multiple options or "all\."
+.
+.IP
+\fBNOTES\fR
+.
+.IP
+By default, this action reads the configuration in agent mode\. Use the \'\-\-mode\' and \'\-\-environment\' flags to examine other configuration domains\.
+.
+.SH "EXAMPLES"
+\fBprint\fR
+.
+.P
+Get puppet\'s runfile directory:
+.
+.P
+$ puppet config print rundir
+.
+.P
+Get a list of important directories from the master\'s config:
+.
+.P
+$ puppet config print all \-\-mode master | grep \-E "(path|dir)"
+.
+.SH "COPYRIGHT AND LICENSE"
+Copyright 2011 by Puppet Labs Apache 2 license; see COPYING

data/man/man8/puppet-describe.8

@@ -0,0 +1,51 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-DESCRIBE" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-describe\fR \- Display help about resource types
+.
+.SH "SYNOPSIS"
+Prints help about Puppet resource types, providers, and metaparameters\.
+.
+.SH "USAGE"
+puppet describe [\-h|\-\-help] [\-s|\-\-short] [\-p|\-\-providers] [\-l|\-\-list] [\-m|\-\-meta]
+.
+.SH "OPTIONS"
+.
+.TP
+\-\-help
+Print this help text
+.
+.TP
+\-\-providers
+Describe providers in detail for each type
+.
+.TP
+\-\-list
+List all types
+.
+.TP
+\-\-meta
+List all metaparameters
+.
+.TP
+\-\-short
+List only parameters without detail
+.
+.SH "EXAMPLE"
+.
+.nf
+
+$ puppet describe \-\-list
+$ puppet describe file \-\-providers
+$ puppet describe user \-s \-m
+.
+.fi
+.
+.SH "AUTHOR"
+David Lutterkort
+.
+.SH "COPYRIGHT"
+Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License

data/man/man8/puppet-device.8

@@ -0,0 +1,86 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-DEVICE" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-device\fR \- Manage remote network devices
+.
+.SH "SYNOPSIS"
+Retrieves all configurations from the puppet master and apply them to the remote devices configured in /etc/puppet/device\.conf\.
+.
+.P
+Currently must be run out periodically, using cron or something similar\.
+.
+.SH "USAGE"
+puppet device [\-d|\-\-debug] [\-\-detailed\-exitcodes] [\-V|\-\-version]
+.
+.IP "" 4
+.
+.nf
+
+            [\-h|\-\-help] [\-l|\-\-logdest syslog|<file>|console]
+            [\-v|\-\-verbose] [\-w|\-\-waitforcert <seconds>]
+.
+.fi
+.
+.IP "" 0
+.
+.SH "DESCRIPTION"
+Once the client has a signed certificate for a given remote device, it will retrieve its configuration and apply it\.
+.
+.SH "USAGE NOTES"
+One need a /etc/puppet/device\.conf file with the following content:
+.
+.P
+[remote\.device\.fqdn] type \fItype\fR url \fIurl\fR
+.
+.P
+where: * type: the current device type (the only value at this time is cisco) * url: an url allowing to connect to the device
+.
+.P
+Supported url must conforms to: scheme://user:password@hostname/?query
+.
+.P
+with: * scheme: either ssh or telnet * user: username, can be omitted depending on the switch/router configuration * password: the connection password * query: this is device specific\. Cisco devices supports an enable parameter whose value would be the enable password\.
+.
+.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\.
+.
+.TP
+\-\-debug
+Enable full debugging\.
+.
+.TP
+\-\-detailed\-exitcodes
+Provide transaction information via exit codes\. If this is enabled, an exit code of \'2\' means there were changes, and an exit code of \'4\' means that there were failures during the transaction\. This option only makes sense in conjunction with \-\-onetime\.
+.
+.TP
+\-\-help
+Print this help message
+.
+.TP
+\-\-logdest
+Where to send messages\. Choose between syslog, the console, and a log file\. Defaults to sending messages to syslog, or the console if debugging or verbosity is enabled\.
+.
+.TP
+\-\-verbose
+Turn on verbose reporting\.
+.
+.TP
+\-\-waitforcert
+This option only matters for daemons that do not yet have certificates and it is enabled by default, with a value of 120 (seconds)\. This causes +puppet agent+ to connect to the server every 2 minutes and ask it to sign a certificate request\. This is useful for the initial setup of a puppet client\. You can turn off waiting for certificates by specifying a time of 0\.
+.
+.SH "EXAMPLE"
+.
+.nf
+
+  $ puppet device \-\-server puppet\.domain\.com
+.
+.fi
+.
+.SH "AUTHOR"
+Brice Figureau
+.
+.SH "COPYRIGHT"
+Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License

data/man/man8/puppet-doc.8

@@ -0,0 +1,101 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-DOC" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-doc\fR \- Generate Puppet documentation and references
+.
+.SH "SYNOPSIS"
+Generates a reference for all Puppet types\. Largely meant for internal Puppet Labs use\.
+.
+.SH "USAGE"
+puppet doc [\-a|\-\-all] [\-h|\-\-help] [\-o|\-\-outputdir \fIrdoc\-outputdir\fR] [\-m|\-\-mode text|pdf|rdoc] [\-r|\-\-reference \fIreference\-name\fR] [\-\-charset \fIcharset\fR] [\fImanifest\-file\fR]
+.
+.SH "DESCRIPTION"
+If mode is not \'rdoc\', then this command generates a Markdown document describing all installed Puppet types or all allowable arguments to puppet executables\. It is largely meant for internal use and is used to generate the reference document available on the Puppet Labs web site\.
+.
+.P
+In \'rdoc\' mode, this command generates an html RDoc hierarchy describing the manifests that are in \'manifestdir\' and \'modulepath\' configuration directives\. The generated documentation directory is doc by default but can be changed with the \'outputdir\' option\.
+.
+.P
+If the command is run with the name of a manifest file as an argument, puppet doc will output a single manifest\'s documentation on stdout\.
+.
+.SH "OPTIONS"
+.
+.TP
+\-\-all
+Output the docs for all of the reference types\. In \'rdoc\' modes, this also outputs documentation for all resources
+.
+.TP
+\-\-help
+Print this help message
+.
+.TP
+\-\-outputdir
+Specifies the directory where to output the rdoc documentation in \'rdoc\' mode\.
+.
+.TP
+\-\-mode
+Determine the output mode\. Valid modes are \'text\', \'pdf\' and \'rdoc\'\. The \'pdf\' mode creates PDF formatted files in the /tmp directory\. The default mode is \'text\'\. In \'rdoc\' mode you must provide \'manifests\-path\'
+.
+.TP
+\-\-reference
+Build a particular reference\. Get a list of references by running \'puppet doc \-\-list\'\.
+.
+.TP
+\-\-charset
+Used only in \'rdoc\' mode\. It sets the charset used in the html files produced\.
+.
+.SH "EXAMPLE"
+.
+.nf
+
+$ puppet doc \-r type > /tmp/type_reference\.markdown
+.
+.fi
+.
+.P
+or
+.
+.IP "" 4
+.
+.nf
+
+$ puppet doc \-\-outputdir /tmp/rdoc \-\-mode rdoc /path/to/manifests
+.
+.fi
+.
+.IP "" 0
+.
+.P
+or
+.
+.IP "" 4
+.
+.nf
+
+$ puppet doc /etc/puppet/manifests/site\.pp
+.
+.fi
+.
+.IP "" 0
+.
+.P
+or
+.
+.IP "" 4
+.
+.nf
+
+$ puppet doc \-m pdf \-r configuration
+.
+.fi
+.
+.IP "" 0
+.
+.SH "AUTHOR"
+Luke Kanies
+.
+.SH "COPYRIGHT"
+Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License