puppet 5.0.0 → 6.0.0

data/man/man8/puppet-agent.8

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
-.\" https://github.com/rtomayko/ronn/tree/0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-AGENT" "8" "May 2015" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-AGENT" "8" "September 2018" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-agent\fR \- The puppet agent daemon
@@ -13,7 +13,7 @@ Retrieves the client configuration from the puppet master and applies it to the
 This service may be run as a daemon, run periodically using cron (or something similar), or run interactively for testing purposes\.
 .
 .SH "USAGE"
-puppet agent [\-\-certname \fINAME\fR] [\-D|\-\-daemonize|\-\-no\-daemonize] [\-d|\-\-debug] [\-\-detailed\-exitcodes] [\-\-digest \fIDIGEST\fR] [\-\-disable [MESSAGE]] [\-\-enable] [\-\-fingerprint] [\-h|\-\-help] [\-l|\-\-logdest syslog|eventlog|\fIFILE\fR|console] [\-\-masterport \fIPORT\fR] [\-\-noop] [\-o|\-\-onetime] [\-t|\-\-test] [\-v|\-\-verbose] [\-V|\-\-version] [\-w|\-\-waitforcert \fISECONDS\fR]
+puppet agent [\-\-certname \fINAME\fR] [\-D|\-\-daemonize|\-\-no\-daemonize] [\-d|\-\-debug] [\-\-detailed\-exitcodes] [\-\-digest \fIDIGEST\fR] [\-\-disable [MESSAGE]] [\-\-enable] [\-\-fingerprint] [\-h|\-\-help] [\-l|\-\-logdest syslog|eventlog|\fIABS FILEPATH\fR|console] [\-\-masterport \fIPORT\fR] [\-\-noop] [\-o|\-\-onetime] [\-\-sourceaddress \fIIP_ADDRESS\fR] [\-t|\-\-test] [\-v|\-\-verbose] [\-V|\-\-version] [\-w|\-\-waitforcert \fISECONDS\fR]
 .
 .SH "DESCRIPTION"
 This is the main puppet client\. Its job is to retrieve the local machine\'s configuration from a remote server and apply it\. In order to successfully communicate with the remote server, the client must have a certificate signed by a certificate authority that the server trusts; the recommended method for this, at the moment, is to run a certificate authority as part of the puppet server (which is the default)\. The client will connect and request a signed certificate, and will continue connecting until it receives one\.
@@ -25,19 +25,22 @@ Once the client has a signed certificate, it will retrieve its configuration and
 \'puppet agent\' does its best to find a compromise between interactive use and daemon use\. Run with no arguments and no configuration, it will go into the background, attempt to get a signed certificate, and retrieve and apply its configuration every 30 minutes\.
 .
 .P
-Some flags are meant specifically for interactive use \-\- in particular, \'test\', \'tags\' or \'fingerprint\' are useful\. \'test\' enables verbose logging, causes the daemon to stay in the foreground, exits if the server\'s configuration is invalid (this happens if, for instance, you\'ve left a syntax error on the server), and exits after running the configuration once (rather than hanging around as a long\-running process)\.
+Some flags are meant specifically for interactive use \-\- in particular, \'test\', \'tags\' and \'fingerprint\' are useful\.
 .
 .P
-\'tags\' allows you to specify what portions of a configuration you want to apply\. Puppet elements are tagged with all of the class or definition names that contain them, and you can use the \'tags\' flag to specify one of these names, causing only configuration elements contained within that class or definition to be applied\. This is very useful when you are testing new configurations \-\- for instance, if you are just starting to manage \'ntpd\', you would put all of the new elements into an \'ntpd\' class, and call puppet with \'\-\-tags ntpd\', which would only apply that small portion of the configuration during your testing, rather than applying the whole thing\.
+\'\-\-test\' does a single run in the foreground with verbose logging, then exits\. It will also exit if it can\'t get a valid catalog\. The exit code after running with \'\-\-test\' is 0 if the catalog was successfully applied, and 1 if the run either failed or wasn\'t attempted (due to another run already in progress)\.
 .
 .P
-\'fingerprint\' is a one\-time flag\. In this mode \'puppet agent\' will run once and display on the console (and in the log) the current certificate (or certificate request) fingerprint\. Providing the \'\-\-digest\' option allows to use a different digest algorithm to generate the fingerprint\. The main use is to verify that before signing a certificate request on the master, the certificate request the master received is the same as the one the client sent (to prevent against man\-in\-the\-middle attacks when signing certificates)\.
+\'\-\-tags\' allows you to specify what portions of a configuration you want to apply\. Puppet elements are tagged with all of the class or definition names that contain them, and you can use the \'tags\' flag to specify one of these names, causing only configuration elements contained within that class or definition to be applied\. This is very useful when you are testing new configurations \-\- for instance, if you are just starting to manage \'ntpd\', you would put all of the new elements into an \'ntpd\' class, and call puppet with \'\-\-tags ntpd\', which would only apply that small portion of the configuration during your testing, rather than applying the whole thing\.
+.
+.P
+\'\-\-fingerprint\' is a one\-time flag\. In this mode \'puppet agent\' will run once and display on the console (and in the log) the current certificate (or certificate request) fingerprint\. Providing the \'\-\-digest\' option allows to use a different digest algorithm to generate the fingerprint\. The main use is to verify that before signing a certificate request on the master, the certificate request the master received is the same as the one the client sent (to prevent against man\-in\-the\-middle attacks when signing certificates)\.
 .
 .SH "OPTIONS"
 Note that any Puppet setting that\'s valid in the configuration file is also a valid long argument\. For example, \'server\' is a valid setting, so you can specify \'\-\-server \fIservername\fR\' as an argument\. Boolean settings translate into \'\-\-setting\' and \'\-\-no\-setting\' pairs\.
 .
 .P
-See the configuration file documentation at https://docs\.puppetlabs\.com/references/stable/configuration\.html for the full list of acceptable settings\. A commented list of all settings can also be generated by running puppet agent with \'\-\-genconfig\'\.
+See the configuration file documentation at https://puppet\.com/docs/puppet/latest/configuration\.html for the full list of acceptable settings\. A commented list of all settings can also be generated by running puppet agent with \'\-\-genconfig\'\.
 .
 .TP
 \-\-certname
@@ -57,7 +60,22 @@ 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, 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\.
+Provide extra information about the run via exit codes; only works if \'\-\-test\' or \'\-\-onetime\' is also specified\. If enabled, \'puppet agent\' will use the following exit codes:
+.
+.IP
+0: The run succeeded with no changes or failures; the system was already in the desired state\.
+.
+.IP
+1: The run failed, or wasn\'t attempted due to another run already in progress\.
+.
+.IP
+2: The run succeeded, and some resources were changed\.
+.
+.IP
+4: The run succeeded, and some resources failed\.
+.
+.IP
+6: The run succeeded, and included both changes and failures\.
 .
 .TP
 \-\-digest
@@ -92,6 +110,10 @@ Display the current certificate or certificate signing request fingerprint and t
 Print this help message
 .
 .TP
+\-\-job\-id
+Attach the specified job id to the catalog request and the report used for this agent run\. This option only works when \'\-\-onetime\' is used\.
+.
+.TP
 \-\-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\. If debugging or verbosity is enabled, this defaults to \'console\'\. Otherwise, it defaults to \'syslog\' on POSIX systems and \'eventlog\' on Windows\.
 .
@@ -111,8 +133,12 @@ Use \'noop\' mode where the daemon runs in a no\-op or dry\-run mode\. This is u
 Run the configuration once\. Runs a single (normally daemonized) Puppet run\. Useful for interactively running puppet agent when used in conjunction with the \-\-no\-daemonize option\. (This is a Puppet setting, and can go in puppet\.conf\. Note the special \'no\-\' prefix for boolean settings on the command line\.)
 .
 .TP
+\-\-sourceaddress
+Set the source IP address for transactions\. This defaults to automatically selected\. (This is a Puppet setting, and can go in puppet\.conf\.)
+.
+.TP
 \-\-test
-Enable the most common options used for testing\. These are \'onetime\', \'verbose\', \'ignorecache\', \'no\-daemonize\', \'no\-usecacheonfailure\', \'detailed\-exitcodes\', \'no\-splay\', and \'show_diff\'\.
+Enable the most common options used for testing\. These are \'onetime\', \'verbose\', \'no\-daemonize\', \'no\-usecacheonfailure\', \'detailed\-exitcodes\', \'no\-splay\', and \'show_diff\'\.
 .
 .TP
 \-\-verbose
@@ -157,4 +183,4 @@ Close file descriptors for log files and reopen them\. Used with logrotate\.
 Luke Kanies
 .
 .SH "COPYRIGHT"
-Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License
+Copyright (c) 2011 Puppet Inc\., LLC Licensed under the Apache 2\.0 License

data/man/man8/puppet-apply.8

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
-.\" https://github.com/rtomayko/ronn/tree/0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-APPLY" "8" "May 2015" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-APPLY" "8" "September 2018" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-apply\fR \- Apply Puppet manifests locally
@@ -10,7 +10,7 @@
 Applies a standalone Puppet manifest to the local system\.
 .
 .SH "USAGE"
-puppet apply [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] [\-e|\-\-execute] [\-\-detailed\-exitcodes] [\-L|\-\-loadclasses] [\-l|\-\-logdest syslog|eventlog|\fIFILE\fR|console] [\-\-noop] [\-\-catalog \fIcatalog\fR] [\-\-write\-catalog\-summary] \fIfile\fR
+puppet apply [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] [\-e|\-\-execute] [\-\-detailed\-exitcodes] [\-L|\-\-loadclasses] [\-l|\-\-logdest syslog|eventlog|\fIABS FILEPATH\fR|console] [\-\-noop] [\-\-catalog \fIcatalog\fR] [\-\-write\-catalog\-summary] \fIfile\fR
 .
 .SH "DESCRIPTION"
 This is the standalone puppet execution tool; use it to apply individual manifests\.
@@ -25,13 +25,28 @@ Most users should use \'puppet agent\' and \'puppet master\' for site\-wide mani
 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 \fIclass\fR,\fItag\fR\' as an argument\.
 .
 .P
-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\'\.
+See the configuration file documentation at https://puppet\.com/docs/puppet/latest/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\'\.
 .
 .IP "\(bu" 4
 \-\-debug: Enable full debugging\.
 .
 .IP "\(bu" 4
-\-\-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\.
+\-\-detailed\-exitcodes: Provide extra information about the run via exit codes\. If enabled, \'puppet apply\' will use the following exit codes:
+.
+.IP
+0: The run succeeded with no changes or failures; the system was already in the desired state\.
+.
+.IP
+1: The run failed\.
+.
+.IP
+2: The run succeeded, and some resources were changed\.
+.
+.IP
+4: The run succeeded, and some resources failed\.
+.
+.IP
+6: The run succeeded, and included both changes and failures\.
 .
 .IP "\(bu" 4
 \-\-help: Print this help message
@@ -79,4 +94,4 @@ $ puppet apply \-\-catalog catalog\.json
 Luke Kanies
 .
 .SH "COPYRIGHT"
-Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License
+Copyright (c) 2011 Puppet Inc\., LLC Licensed under the Apache 2\.0 License

data/man/man8/puppet-catalog.8

@@ -1,13 +1,13 @@
 .\" generated with Ronn/v0.7.3
-.\" https://github.com/rtomayko/ronn/tree/0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-CATALOG" "8" "May 2015" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-CATALOG" "8" "September 2018" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-catalog\fR \- Compile, save, view, and convert catalogs\.
 .
 .SH "SYNOPSIS"
-puppet catalog \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH]
+puppet catalog \fIaction\fR [\-\-terminus _TERMINUS] [\-\-extra HASH]
 .
 .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\'\.
@@ -16,7 +16,7 @@ This subcommand deals with catalogs, which are compiled per\-node artifacts gene
 Note that any setting 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 and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
 .
 .P
-See the configuration file documentation at \fIhttps://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\.
+See the configuration file documentation at \fIhttps://puppet\.com/docs/puppet/latest/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
 \-\-render\-as FORMAT
@@ -35,7 +35,7 @@ Whether to log debug information\.
 A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\.
 .
 .TP
-\-\-terminus TERMINUS
+\-\-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
@@ -51,7 +51,7 @@ The terminus for an action is often determined by context, but occasionally need
 \fBSYNOPSIS\fR
 .
 .IP
-puppet catalog apply [\-\-terminus TERMINUS] [\-\-extra HASH]
+puppet catalog apply [\-\-terminus _TERMINUS] [\-\-extra HASH]
 .
 .IP
 \fBDESCRIPTION\fR
@@ -70,7 +70,7 @@ Nothing\. When used from the Ruby API, returns a Puppet::Transaction::Report obj
 \fBSYNOPSIS\fR
 .
 .IP
-puppet catalog download [\-\-terminus TERMINUS] [\-\-extra HASH]
+puppet catalog download [\-\-terminus _TERMINUS] [\-\-extra HASH]
 .
 .IP
 \fBDESCRIPTION\fR
@@ -98,7 +98,7 @@ When used from the Ruby API, this action has a side effect of leaving Puppet::Re
 \fBSYNOPSIS\fR
 .
 .IP
-puppet catalog find [\-\-terminus TERMINUS] [\-\-extra HASH] \fIcertname\fR
+puppet catalog find [\-\-terminus _TERMINUS] [\-\-extra HASH] \fIcertname\fR
 .
 .IP
 \fBDESCRIPTION\fR
@@ -117,7 +117,7 @@ A serialized catalog\. When used from the Ruby API, returns a Puppet::Resource::
 \fBSYNOPSIS\fR
 .
 .IP
-puppet catalog info [\-\-terminus TERMINUS] [\-\-extra HASH]
+puppet catalog info [\-\-terminus _TERMINUS] [\-\-extra HASH]
 .
 .IP
 \fBDESCRIPTION\fR
@@ -130,7 +130,7 @@ Prints the default terminus class for this subcommand\. Note that different run
 \fBSYNOPSIS\fR
 .
 .IP
-puppet catalog save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR
+puppet catalog save [\-\-terminus _TERMINUS] [\-\-extra HASH] \fIkey\fR
 .
 .IP
 \fBDESCRIPTION\fR
@@ -143,7 +143,7 @@ API only: create or overwrite an object\. As the Faces framework does not curren
 \fBSYNOPSIS\fR
 .
 .IP
-puppet catalog select [\-\-terminus TERMINUS] [\-\-extra HASH] \fIhost\fR \fIresource_type\fR
+puppet catalog select [\-\-terminus _TERMINUS] [\-\-extra HASH] \fIhost\fR \fIresource_type\fR
 .
 .IP
 \fBDESCRIPTION\fR
@@ -249,9 +249,6 @@ This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \
 \fBrest\fR
 .
 .IP "\(bu" 4
-\fBstatic_compiler\fR
-.
-.IP "\(bu" 4
 \fBstore_configs\fR
 .
 .IP "\(bu" 4
@@ -260,4 +257,4 @@ This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \
 .IP "" 0
 .
 .SH "COPYRIGHT AND LICENSE"
-Copyright 2011 by Puppet Labs Apache 2 license; see COPYING
+Copyright 2011 by Puppet Inc\. Apache 2 license; see COPYING

data/man/man8/puppet-config.8

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
-.\" https://github.com/rtomayko/ronn/tree/0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-CONFIG" "8" "May 2015" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-CONFIG" "8" "September 2018" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-config\fR \- Interact with Puppet\'s settings\.
@@ -10,13 +10,13 @@
 puppet config \fIaction\fR [\-\-section SECTION_NAME]
 .
 .SH "DESCRIPTION"
-This subcommand can inspect and modify settings from Puppet\'s \'puppet\.conf\' configuration file\. For documentation about individual settings, see https://docs\.puppetlabs\.com/references/latest/configuration\.html\.
+This subcommand can inspect and modify settings from Puppet\'s \'puppet\.conf\' configuration file\. For documentation about individual settings, see https://puppet\.com/docs/puppet/latest/configuration\.html\.
 .
 .SH "OPTIONS"
 Note that any setting 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 and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
 .
 .P
-See the configuration file documentation at \fIhttps://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\.
+See the configuration file documentation at \fIhttps://puppet\.com/docs/puppet/latest/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
 \-\-render\-as FORMAT
@@ -43,6 +43,25 @@ Less commonly used is the \'user\' section, which affects puppet apply\. Any oth
 .SH "ACTIONS"
 .
 .TP
+\fBdelete\fR \- Delete a Puppet setting\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet config delete [\-\-section SECTION_NAME] (\fIsetting\fR
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Deletes a setting from the specified section\. (The default is the section \'main\')\.
+.
+.IP
+\fBNOTES\fR
+.
+.IP
+By default, this action deletes the configuration setting from the \'main\' configuration domain\. Use the \'\-\-section\' flags to delete settings from other configuration domains\.
+.
+.TP
 \fBprint\fR \- Examine Puppet\'s current settings\.
 \fBSYNOPSIS\fR
 .
@@ -56,7 +75,7 @@ puppet config print [\-\-section SECTION_NAME] (all | \fIsetting\fR [\fIsetting\
 Prints the value of a single setting or a list of settings\.
 .
 .IP
-This action is an alternate interface to the information available with \fBpuppet <subcommand> \-\-configprint\fR\.
+This action is a replacement interface to the information available with \fBpuppet <subcommand> \-\-configprint\fR\.
 .
 .IP
 \fBNOTES\fR
@@ -84,6 +103,21 @@ Updates values in the \fBpuppet\.conf\fR configuration file\.
 By default, this action manipulates the configuration in the \'main\' section\. Use the \'\-\-section\' flag to manipulate other configuration domains\.
 .
 .SH "EXAMPLES"
+\fBdelete\fR
+.
+.P
+Delete the setting \'setting_name\' from the \'main\' configuration domain:
+.
+.P
+$ puppet config delete setting_name
+.
+.P
+Delete the setting \'setting_name\' from the \'master\' configuration domain:
+.
+.P
+$ puppet config delete setting_name \-\-section master
+.
+.P
 \fBprint\fR
 .
 .P
@@ -114,4 +148,4 @@ Set the vardir for only the agent:
 $ puppet config set vardir /opt/puppetlabs/puppet/cache \-\-section agent
 .
 .SH "COPYRIGHT AND LICENSE"
-Copyright 2011 by Puppet Labs Apache 2 license; see COPYING
+Copyright 2011 by Puppet Inc\. Apache 2 license; see COPYING

data/man/man8/puppet-describe.8

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
-.\" https://github.com/rtomayko/ronn/tree/0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-DESCRIBE" "8" "May 2015" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-DESCRIBE" "8" "September 2018" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-describe\fR \- Display help about resource types
@@ -48,4 +48,4 @@ $ puppet describe user \-s \-m
 David Lutterkort
 .
 .SH "COPYRIGHT"
-Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License
+Copyright (c) 2011 Puppet Inc\., LLC Licensed under the Apache 2\.0 License

data/man/man8/puppet-device.8

@@ -1,37 +1,43 @@
 .\" generated with Ronn/v0.7.3
-.\" https://github.com/rtomayko/ronn/tree/0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-DEVICE" "8" "May 2015" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-DEVICE" "8" "September 2018" "Puppet, Inc." "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/puppetlabs/puppet/device\.conf\.
+Retrieves catalogs from the Puppet master and applies them to remote devices\.
 .
 .P
-Currently must be run out periodically, using cron or something similar\.
+This subcommand can be run manually; or periodically using cron, a scheduled task, or a similar tool\.
 .
 .SH "USAGE"
-puppet device [\-d|\-\-debug] [\-\-detailed\-exitcodes] [\-V|\-\-version] [\-h|\-\-help] [\-l|\-\-logdest syslog|\fIfile\fR|console] [\-v|\-\-verbose] [\-w|\-\-waitforcert \fIseconds\fR]
+puppet device [\-d|\-\-debug] [\-\-detailed\-exitcodes] [\-\-deviceconfig \fIfile\fR] [\-h|\-\-help] [\-l|\-\-logdest syslog|\fIfile\fR|console] [\-v|\-\-verbose] [\-w|\-\-waitforcert \fIseconds\fR] [\-f|\-\-facts] [\-a|\-\-apply \fIfile\fR] [\-r|\-\-resource \fItype\fR [name]] [\-t|\-\-target \fIdevice\fR] [\-\-user=\fIuser\fR] [\-V|\-\-version]
 .
 .SH "DESCRIPTION"
-Once the client has a signed certificate for a given remote device, it will retrieve its configuration and apply it\.
+Devices require a proxy Puppet agent to request certificates, collect facts, retrieve and apply catalogs, and store reports\.
 .
 .SH "USAGE NOTES"
-One need a /etc/puppetlabs/puppet/device\.conf file with the following content:
+Devices managed by the puppet\-device subcommand on a Puppet agent are configured in device\.conf, which is located at $confdir/device\.conf by default, and is configurable with the $deviceconfig setting\.
 .
 .P
-[remote\.device\.fqdn] type \fItype\fR url \fIurl\fR
+The device\.conf file is an INI\-like file, with one section per device:
 .
 .P
-where: * type: the current device type (the only value at this time is cisco) * url: an url allowing to connect to the device
+[\fIDEVICE_CERTNAME\fR] type \fITYPE\fR url \fIURL\fR debug
 .
 .P
-Supported url must conforms to: scheme://user:password@hostname/?query
+The section name specifies the certname of the device\.
 .
 .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\.
+The values for the type and url properties are specific to each type of device\.
+.
+.P
+The optional debug property specifies transport\-level debugging, and is limited to telnet and ssh transports\.
+.
+.P
+See https://puppet\.com/docs/puppet/latest/config_file_device\.html for details\.
 .
 .SH "OPTIONS"
 Note that any setting 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\.
@@ -42,7 +48,11 @@ Enable full debugging\.
 .
 .TP
 \-\-detailed\-exitcodes
-Provide transaction information via exit codes\. If this is enabled, an exit code of \'1\' means at least one device had a compile failure, an exit code of \'2\' means at least one device had resource changes, and an exit code of \'4\' means at least one device had resource failures\. Exit codes of \'3\', \'5\', \'6\', or \'7\' means that a bitwise combination of the preceeding exit codes happened\.
+Provide transaction information via exit codes\. If this is enabled, an exit code of \'1\' means at least one device had a compile failure, an exit code of \'2\' means at least one device had resource changes, and an exit code of \'4\' means at least one device had resource failures\. Exit codes of \'3\', \'5\', \'6\', or \'7\' means that a bitwise combination of the preceding exit codes happened\.
+.
+.TP
+\-\-deviceconfig
+Path to the device config file for puppet device\. Default: $confdir/device\.conf
 .
 .TP
 \-\-help
@@ -56,6 +66,30 @@ Where to send log messages\. Choose between \'syslog\' (the POSIX syslog service
 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\.
 .
 .TP
+\-\-apply
+Apply a manifest against a remote target\. Target must be specified\.
+.
+.TP
+\-\-facts
+Displays the facts of a remote target\. Target must be specified\.
+.
+.TP
+\-\-resource
+Displays a resource state as Puppet code, roughly equivalent to \fBpuppet resource\fR\. Can be filterd by title\. Requires \-\-target be specified\.
+.
+.TP
+\-\-target
+Target a specific device/certificate in the device\.conf\. Doing so will perform a device run against only that device/certificate\.
+.
+.TP
+\-\-to_yaml
+Output found resources in yaml format, suitable to use with Hiera and create_resources\.
+.
+.TP
+\-\-user
+The user to run as\.
+.
+.TP
 \-\-verbose
 Turn on verbose reporting\.
 .
@@ -67,7 +101,7 @@ This option only matters for daemons that do not yet have certificates and it is
 .
 .nf
 
-  $ puppet device \-\-server puppet\.domain\.com
+  $ puppet device \-\-target remotehost \-\-verbose
 .
 .fi
 .
@@ -75,4 +109,4 @@ This option only matters for daemons that do not yet have certificates and it is
 Brice Figureau
 .
 .SH "COPYRIGHT"
-Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License
+Copyright (c) 2011 Puppet Inc\., LLC Licensed under the Apache 2\.0 License

data/man/man8/puppet-doc.8

@@ -1,19 +1,19 @@
 .\" generated with Ronn/v0.7.3
-.\" https://github.com/rtomayko/ronn/tree/0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-DOC" "8" "May 2015" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-DOC" "8" "September 2018" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-doc\fR \- Generate Puppet references
 .
 .SH "SYNOPSIS"
-Generates a reference for all Puppet types\. Largely meant for internal Puppet Labs use\. (Deprecated)
+Generates a reference for all Puppet types\. Largely meant for internal Puppet Inc\. use\. (Deprecated)
 .
 .SH "USAGE"
 puppet doc [\-h|\-\-help] [\-l|\-\-list] [\-r|\-\-reference \fIreference\-name\fR]
 .
 .SH "DESCRIPTION"
-This deprecated command generates a Markdown document to stdout 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\.
+This deprecated command generates a Markdown document to stdout 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 Inc\. web site\.
 .
 .P
 For Puppet module documentation (and all other use cases) this command has been superseded by the "puppet\-strings" module \- see https://github\.com/puppetlabs/puppetlabs\-strings for more information\.
@@ -43,4 +43,4 @@ $ puppet doc \-r type > /tmp/type_reference\.markdown
 Luke Kanies
 .
 .SH "COPYRIGHT"
-Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2\.0 License
+Copyright (c) 2011 Puppet Inc\., LLC Licensed under the Apache 2\.0 License