puppet 5.3.4 → 6.29.0

data/man/man8/puppet-device.8

@@ -1,46 +1,67 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-DEVICE" "8" "June 2017" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-DEVICE" "8" "January 2023" "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] [\-\-deviceconfig \fIfile\fR] [\-h|\-\-help] [\-l|\-\-logdest syslog|\fIfile\fR|console] [\-v|\-\-verbose] [\-w|\-\-waitforcert \fIseconds\fR] [\-t|\-\-target \fIdevice\fR] [\-V|\-\-version]
+puppet device [\-h|\-\-help] [\-v|\-\-verbose] [\-d|\-\-debug] [\-l|\-\-logdest syslog|\fIfile\fR|console] [\-\-detailed\-exitcodes] [\-\-deviceconfig \fIfile\fR] [\-w|\-\-waitforcert \fIseconds\fR] [\-\-libdir \fIdirectory\fR] [\-a|\-\-apply \fIfile\fR] [\-f|\-\-facts] [\-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\.
 .
 .TP
-\-\-debug
+\-\-help, \-h
+Print this help message
+.
+.TP
+\-\-verbose, \-v
+Turn on verbose reporting\.
+.
+.TP
+\-\-debug, \-d
 Enable full debugging\.
 .
 .TP
+\-\-logdest, \-l
+Where to send log messages\. Choose between \'syslog\' (the POSIX syslog service), \'console\', or the path to a log file\. If debugging or verbosity is enabled, this defaults to \'console\'\. Otherwise, it defaults to \'syslog\'\. Multiple destinations can be set using a comma separated list (eg: \fB/path/file1,console,/path/file2\fR)"
+.
+.IP
+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
 \-\-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 preceding exit codes happened\.
 .
@@ -49,33 +70,45 @@ Provide transaction information via exit codes\. If this is enabled, an exit cod
 Path to the device config file for puppet device\. Default: $confdir/device\.conf
 .
 .TP
-\-\-help
-Print this help message
+\-\-waitforcert, \-w
+This option only matters for targets that do not yet have certificates and it is enabled by default, with a value of 120 (seconds)\. This causes +puppet device+ to poll the server every 2 minutes and ask it to sign a certificate request\. This is useful for the initial setup of a target\. You can turn off waiting for certificates by specifying a time of 0\.
 .
 .TP
-\-\-logdest
-Where to send log messages\. Choose between \'syslog\' (the POSIX syslog service), \'console\', or the path to a log file\. If debugging or verbosity is enabled, this defaults to \'console\'\. Otherwise, it defaults to \'syslog\'\.
+\-\-libdir
+Override the per\-device libdir with a local directory\. Specifying a libdir also disables pluginsync\. This is useful for testing\.
 .
 .IP
-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\.
+A path ending with \'\.jsonl\' will receive structured output in JSON Lines format\.
+.
+.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 filtered 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
-\-\-verbose
-Turn on verbose reporting\.
+\-\-to_yaml
+Output found resources in yaml format, suitable to use with Hiera and create_resources\.
 .
 .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\.
+\-\-user
+The user to run as\.
 .
 .SH "EXAMPLE"
 .
 .nf
 
-  $ puppet device \-\-server puppet\.domain\.com
+  $ puppet device \-\-target remotehost \-\-verbose
 .
 .fi
 .
@@ -83,4 +116,4 @@ This option only matters for daemons that do not yet have certificates and it is
 Brice Figureau
 .
 .SH "COPYRIGHT"
-Copyright (c) 2011 Puppet Inc\., LLC Licensed under the Apache 2\.0 License
+Copyright (c) 2011\-2018 Puppet Inc\., LLC Licensed under the Apache 2\.0 License

data/man/man8/puppet-doc.8

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-DOC" "8" "June 2017" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-DOC" "8" "January 2023" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-doc\fR \- Generate Puppet references

data/man/man8/puppet-epp.8

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-EPP" "8" "June 2017" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-EPP" "8" "January 2023" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-epp\fR \- Interact directly with the EPP template parser/renderer\.
@@ -13,7 +13,7 @@ puppet epp \fIaction\fR
 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/puppet/latest/reference/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
@@ -29,18 +29,34 @@ Whether to log debug information\.
 .
 .SH "ACTIONS"
 .
-.TP
-\fBdump\fR \- Outputs a dump of the internal template parse tree for debugging
-\fBSYNOPSIS\fR
+.IP "\(bu" 4
+\fBdump\fR \- Outputs a dump of the internal template parse tree for debugging: \fBSYNOPSIS\fR
 .
 .IP
-puppet epp dump [\-\-e \fIsource\fR] [\-\-[no\-]validate] [\-\-[no\-]header] \-e \fIsource\fR | [\fItemplates\fR \.\.\.]
+puppet epp dump [\-\-e \fIsource\fR] [\-\-[no\-]validate] [\-\-format \fIold, pn, or json\fR] [\-\-pretty] [\-\-[no\-]header] [\-\-format \fIold|pn|json\fR] [\-\-pretty] { \-e \fIsource\fR | [\fItemplates\fR \.\.\.] }
 .
 .IP
 \fBDESCRIPTION\fR
 .
 .IP
-The dump action parses and validates the EPP syntax and dumps the resulting AST model in a human readable (but not necessarily an easy to understand) format\. The output format of the dumped tree is intended for epp parser debugging purposes and is not API, and may thus change between versions without deprecation warnings\.
+The dump action parses and validates the EPP syntax and dumps the resulting AST model in a human readable (but not necessarily an easy to understand) format\.
+.
+.IP
+The output format can be controlled using the \-\-format \fIold|pn|json\fR where:
+.
+.IP "\(bu" 4
+\'old\' is the default, but now deprecated format which is not API\.
+.
+.IP "\(bu" 4
+\'pn\' is the Puppet Extended S\-Expression Notation\.
+.
+.IP "\(bu" 4
+\'json\' outputs the same graph as \'pn\' but with JSON syntax\.
+.
+.IP "" 0
+.
+.IP
+The output will be "pretty printed" when the option \-\-pretty is given together with \-\-format \'pn\' or \'json\'\. This option has no effect on the \'old\' format\.
 .
 .IP
 The command accepts one or more templates (\.epp) files, or an \-e followed by the template source text\. The given templates can be paths to template files, or references to templates in modules when given on the form \fImodulename\fR/\fItemplate\-name\fR\.epp\. If no arguments are given, the stdin is read (unless it is attached to a terminal)
@@ -58,9 +74,15 @@ This command ignores the \-\-render\-as setting/option\.
 \fBOPTIONS\fR \fI\-\-e <source\fR> \- Dump one epp source expression given on the command line\.
 .
 .IP
+\fI\-\-format <old, pn, or json\fR> \- Get result in \'old\' (deprecated format), \'pn\' (new format), or \'json\' (new format in JSON)\.
+.
+.IP
 \fI\-\-[no\-]header\fR \- Whether or not to show a file name header between files\.
 .
 .IP
+\fI\-\-pretty\fR \- Pretty print output\. Only applicable together with \-\-format pn or json
+.
+.IP
 \fI\-\-[no\-]validate\fR \- Whether or not to validate the parsed result, if no\-validate only syntax errors are reported\.
 .
 .IP
@@ -69,9 +91,8 @@ This command ignores the \-\-render\-as setting/option\.
 .IP
 A dump of the resulting AST model unless there are syntax or validation errors\.
 .
-.TP
-\fBrender\fR \- Renders an epp template as text
-\fBSYNOPSIS\fR
+.IP "\(bu" 4
+\fBrender\fR \- Renders an epp template as text: \fBSYNOPSIS\fR
 .
 .IP
 puppet epp render [\-\-node \fInode_name\fR] [\-\-e \fIsource\fR] [\-\-values \fIvalues_hash\fR] [\-\-values_file \fIpp_or_yaml_file\fR] [\-\-facts \fIfacts_file\fR] [\-\-[no\-]header] \-e \fIsource\fR | [\fItemplates\fR \.\.\.]
@@ -139,9 +160,8 @@ When designing EPP templates, it is strongly recommended to define all template
 .IP
 A rendered result of one or more given templates\.
 .
-.TP
-\fBvalidate\fR \- Validate the syntax of one or more EPP templates\.
-\fBSYNOPSIS\fR
+.IP "\(bu" 4
+\fBvalidate\fR \- Validate the syntax of one or more EPP templates\.: \fBSYNOPSIS\fR
 .
 .IP
 puppet epp validate [\-\-[no\-]continue_on_error] [\fItemplate\fR] [\fItemplate\fR \.\.\.]
@@ -170,6 +190,8 @@ Exits with 0 if there were no validation errors\.
 .IP
 Nothing, or encountered syntax errors\.
 .
+.IP "" 0
+.
 .SH "EXAMPLES"
 \fBrender\fR
 .

data/man/man8/puppet-facts.8

@@ -1,13 +1,13 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-FACTS" "8" "June 2017" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-FACTS" "8" "January 2023" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-facts\fR \- Retrieve and store facts\.
 .
 .SH "SYNOPSIS"
-puppet facts \fIaction\fR [\-\-terminus _TERMINUS] [\-\-extra HASH]
+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)\.
@@ -16,7 +16,7 @@ This subcommand manages facts, which are collections of normalized system inform
 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/puppet/latest/reference/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
@@ -47,11 +47,39 @@ The terminus for an action is often determined by context, but occasionally need
 .SH "ACTIONS"
 .
 .TP
+\fBdiff\fR \- Compare Facter 3 output with Facter 4 output
+\fBSYNOPSIS\fR
+.
+.IP
+puppet facts diff [\-\-terminus _TERMINUS] [\-\-structured] [\-\-exclude \fIregex\fR]
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Compares output from facter 3 with Facter 4 and prints the differences
+.
+.IP
+\fBOPTIONS\fR \fI\-\-exclude <regex\fR> \- Regex used to exclude specific facts from diff\.
+.
+.IP
+\fI\-\-structured\fR \- Render the different facts as structured\.
+.
+.IP
+\fBRETURNS\fR
+.
+.IP
+Differences between Facter 3 and Facter 4 output as an array\.
+.
+.IP
+\fBNOTES\fR
+.
+.TP
 \fBfind\fR \- Retrieve a node\'s facts\.
 \fBSYNOPSIS\fR
 .
 .IP
-puppet facts [\-\-terminus _TERMINUS] [\-\-extra HASH] [\fInode_certname\fR]
+puppet facts [\-\-terminus _TERMINUS] [\fInode_certname\fR]
 .
 .IP
 \fBDESCRIPTION\fR
@@ -79,7 +107,7 @@ When using the \fBfacter\fR terminus, the host argument is ignored\.
 \fBSYNOPSIS\fR
 .
 .IP
-puppet facts info [\-\-terminus _TERMINUS] [\-\-extra HASH]
+puppet facts info [\-\-terminus _TERMINUS]
 .
 .IP
 \fBDESCRIPTION\fR
@@ -92,7 +120,7 @@ Prints the default terminus class for this subcommand\. Note that different run
 \fBSYNOPSIS\fR
 .
 .IP
-puppet facts save [\-\-terminus _TERMINUS] [\-\-extra HASH] \fIkey\fR
+puppet facts save [\-\-terminus _TERMINUS] \fIkey\fR
 .
 .IP
 \fBDESCRIPTION\fR
@@ -100,7 +128,93 @@ puppet facts save [\-\-terminus _TERMINUS] [\-\-extra HASH] \fIkey\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
+\fBshow\fR \- Retrieve current node\'s facts\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet facts show [\-\-terminus _TERMINUS] [\-\-config\-file \fIpath\fR] [\-\-custom\-dir \fIpath\fR] [\-\-external\-dir \fIpath\fR] [\-\-no\-block] [\-\-no\-cache] [\-\-show\-legacy] [\-\-value\-only] [\fIfacts\fR]
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Reads facts from the local system using \fBfacter\fR terminus\. A query can be provided to retrieve just a specific fact or a set of facts\.
+.
+.IP
+\fBOPTIONS\fR \fI\-\-config\-file <path\fR> \- The location of the config file for Facter\.
+.
+.IP
+\fI\-\-custom\-dir <path\fR> \- The path to a directory that contains custom facts\.
+.
+.IP
+\fI\-\-external\-dir <path\fR> \- The path to a directory that contains external facts\.
+.
+.IP
+\fI\-\-no\-block\fR \- Disable fact blocking mechanism\.
+.
+.IP
+\fI\-\-no\-cache\fR \- Disable fact caching mechanism\.
+.
+.IP
+\fI\-\-show\-legacy\fR \- Show legacy facts when querying all facts\.
+.
+.IP
+\fI\-\-value\-only\fR \- Show only the value when the action is called with a single query
+.
+.IP
+\fBRETURNS\fR
+.
+.IP
+The output of facter with added puppet specific facts\.
+.
+.IP
+\fBNOTES\fR
+.
+.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 \fBPUT\fR or \fBsave\fR access to the \fB/puppet/v3/facts\fR API endpoint\.
+.
+.IP
+For details on configuring Puppet Server\'s \fBauth\.conf\fR, see:
+.
+.IP
+\fIhttps://puppet\.com/docs/puppetserver/latest/config_file_auth\.html\fR
+.
+.IP
+For legacy Rack\-based Puppet Masters, see:
+.
+.IP
+\fIhttps://puppet\.com/docs/puppet/latest/config_file_auth\.html\fR
+.
 .SH "EXAMPLES"
+\fBdiff\fR
+.
+.P
+get differences between facter versions: $ puppet facts diff
+.
+.P
 \fBfind\fR
 .
 .P
@@ -109,6 +223,24 @@ Get facts from the local system:
 .P
 $ puppet facts find
 .
+.P
+\fBshow\fR
+.
+.P
+retrieve facts:
+.
+.P
+$ puppet facts show os
+.
+.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:
 .
@@ -116,12 +248,18 @@ This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \
 \fBfacter\fR
 .
 .IP "\(bu" 4
+\fBjson\fR
+.
+.IP "\(bu" 4
 \fBmemory\fR
 .
 .IP "\(bu" 4
 \fBnetwork_device\fR
 .
 .IP "\(bu" 4
+\fBrest\fR
+.
+.IP "\(bu" 4
 \fBstore_configs\fR
 .
 .IP "\(bu" 4

data/man/man8/puppet-filebucket.8

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-FILEBUCKET" "8" "June 2017" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-FILEBUCKET" "8" "January 2023" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-filebucket\fR \- Store and retrieve files in a filebucket
@@ -34,13 +34,32 @@ list: List all files in the current local filebucket\. Listing remote filebucket
 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\'\.
+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\', or by specifying \'\-\-bucket\' with a local path\.
+.
+.IP "" 4
+.
+.nf
+
+  find /opt/puppetlabs/server/data/puppetserver/bucket \-type f \-mtime +45 \-atime +45 \-print0 | xargs \-0 rm
+.
+.fi
+.
+.IP "" 0
+.
+.IP "\(bu" 4
+Restrict the directory to a maximum size after which the oldest items are removed\.
+.
+.IP "" 0
 .
 .SH "OPTIONS"
 Note that any setting that\'s valid in the configuration file is also a valid long argument\. For example, \'ssldir\' is a valid setting, so you can specify \'\-\-ssldir \fIdirectory\fR\' as an argument\.
 .
 .P
-See the configuration file documentation at https://docs\.puppetlabs\.com/puppet/latest/reference/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\'\.
+.
+.TP
+\-\-bucket
+Specify a local filebucket path\. This overrides the default path set in \'$clientbucketdir\'\.
 .
 .TP
 \-\-debug
@@ -48,27 +67,31 @@ Enable full debugging\.
 .
 .TP
 \-\-fromdate
-(list only) Select bucket files from \'fromdate\'
+(list only) Select bucket files from \'fromdate\'\.
 .
 .TP
 \-\-help
-Print this help message
+Print this help message\.
 .
 .TP
 \-\-local
-Use the local filebucket\. This will use the default configuration information\.
+Use the local filebucket\. This uses the default configuration information and the bucket located at the \'$clientbucketdir\' setting by default\. If \'\-\-bucket\' is set, puppet uses that path instead\.
 .
 .TP
 \-\-remote
-Use a remote filebucket\. This will use the default configuration information\.
+Use a remote filebucket\. This uses the default configuration information and the bucket located at the \'$bucketdir\' setting by default\.
+.
+.TP
+\-\-server_list
+A list of comma separated servers; only the first entry is used for file storage\. This setting takes precidence over \fBserver\fR\.
 .
 .TP
 \-\-server
-The server to send the file to, instead of locally\.
+The server to use for file storage\. This setting is only used if \fBserver_list\fR is not set\.
 .
 .TP
 \-\-todate
-(list only) Select bucket files until \'todate\'
+(list only) Select bucket files until \'todate\'\.
 .
 .TP
 \-\-verbose
@@ -78,38 +101,61 @@ Print extra information\.
 \-\-version
 Print version information\.
 .
-.SH "EXAMPLE"
+.SH "EXAMPLES"
 .
 .nf
 
+## Backup a file to the filebucket, then restore it to a temporary directory
 $ puppet filebucket backup /etc/passwd
 /etc/passwd: 429b225650b912a2ee067b0a4cf1e949
 $ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949
+
 ## Diff between two files in the filebucket
 $ puppet filebucket \-l diff d43a6ecaa892a1962398ac9170ea9bf2 7ae322f5791217e031dc60188f4521ef
 1a2
 > again
-## Diff between the file in the filebucket and the current one
+
+## Diff between the file in the filebucket and a local file
 $ puppet filebucket \-l diff d43a6ecaa892a1962398ac9170ea9bf2 /tmp/testFile
 1a2
 > again
+
+## Backup a file to the filebucket and observe that it keeps each backup separate
 $ puppet filebucket \-l list
 d43a6ecaa892a1962398ac9170ea9bf2 2015\-05\-11 09:27:56 /tmp/TestFile
+
 $ echo again >> /tmp/TestFile
+
 $ puppet filebucket \-l backup /tmp/TestFile
 /tmp/TestFile: 7ae322f5791217e031dc60188f4521ef
-$ puppet filebucket \-l  list
+
+$ puppet filebucket \-l list
 d43a6ecaa892a1962398ac9170ea9bf2 2015\-05\-11 09:27:56 /tmp/TestFile
 7ae322f5791217e031dc60188f4521ef 2015\-05\-11 09:52:15 /tmp/TestFile
+
+## List files in a filebucket within date ranges
 $ puppet filebucket \-l \-f 2015\-01\-01 \-t 2015\-01\-11 list
 <Empty Output>
+
 $ puppet filebucket \-l \-f 2015\-05\-10 list
 d43a6ecaa892a1962398ac9170ea9bf2 2015\-05\-11 09:27:56 /tmp/TestFile
 7ae322f5791217e031dc60188f4521ef 2015\-05\-11 09:52:15 /tmp/TestFile
+
 $ puppet filebucket \-l \-f "2015\-05\-11 09:30:00" list
 7ae322f5791217e031dc60188f4521ef 2015\-05\-11 09:52:15 /tmp/TestFile
+
 $ puppet filebucket \-l \-t "2015\-05\-11 09:30:00" list
 d43a6ecaa892a1962398ac9170ea9bf2 2015\-05\-11 09:27:56 /tmp/TestFile
+## Manage files in a specific local filebucket
+$ puppet filebucket \-b /tmp/TestBucket backup /tmp/TestFile2
+/tmp/TestFile2: d41d8cd98f00b204e9800998ecf8427e
+$ puppet filebucket \-b /tmp/TestBucket list
+d41d8cd98f00b204e9800998ecf8427e 2015\-05\-11 09:33:22 /tmp/TestFile2
+
+## From a Puppet Server, list files in the server bucketdir
+$ puppet filebucket \-b $(puppet config print bucketdir \-\-section server) list
+d43a6ecaa892a1962398ac9170ea9bf2 2015\-05\-11 09:27:56 /tmp/TestFile
+7ae322f5791217e031dc60188f4521ef 2015\-05\-11 09:52:15 /tmp/TestFile
 .
 .fi
 .

data/man/man8/puppet-generate.8

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "PUPPET\-GENERATE" "8" "June 2017" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-GENERATE" "8" "January 2023" "Puppet, Inc." "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-generate\fR \- Generates Puppet code from Ruby definitions\.
@@ -13,7 +13,7 @@ puppet generate \fIaction\fR
 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/puppet/latest/reference/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