puppet 4.10.9-universal-darwin → 4.10.10-universal-darwin

data/man/man8/puppet-certificate_request.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\-CERTIFICATE_REQUEST" "8" "May 2015" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-CERTIFICATE_REQUEST" "8" "January 2018" "Puppet Labs, LLC" "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-certificate_request\fR \- Manage certificate requests\.
@@ -16,7 +16,7 @@ This subcommand retrieves and submits certificate signing requests (CSRs)\.
 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://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\.
 .
 .TP
 \-\-render\-as FORMAT
@@ -158,4 +158,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-certificate_revocation_list.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\-CERTIFICATE_REVOCATION_LIST" "8" "May 2015" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-CERTIFICATE_REVOCATION_LIST" "8" "January 2018" "Puppet Labs, LLC" "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-certificate_revocation_list\fR \- Manage the list of revoked certificates\.
@@ -16,7 +16,7 @@ This subcommand is primarily for retrieving the certificate revocation list from
 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://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\.
 .
 .TP
 \-\-render\-as FORMAT
@@ -136,4 +136,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" "January 2018" "Puppet Labs, LLC" "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://docs\.puppetlabs\.com/puppet/latest/reference/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://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\.
 .
 .TP
 \-\-render\-as FORMAT
@@ -114,4 +114,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" "January 2018" "Puppet Labs, LLC" "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" "January 2018" "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/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] [\-h|\-\-help] [\-l|\-\-logdest syslog|\fIfile\fR|console] [\-v|\-\-verbose] [\-w|\-\-waitforcert \fIseconds\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://docs\.puppet\.com/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,7 @@ 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
 \-\-help
@@ -56,6 +62,10 @@ 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
+\-\-user
+The user to run as\.
+.
+.TP
 \-\-verbose
 Turn on verbose reporting\.
 .
@@ -75,4 +85,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" "January 2018" "Puppet Labs, LLC" "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

data/man/man8/puppet-epp.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\-EPP" "8" "May 2015" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-EPP" "8" "January 2018" "Puppet Labs, LLC" "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/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://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\.
 .
 .TP
 \-\-render\-as FORMAT
@@ -46,10 +46,10 @@ The dump action parses and validates the EPP syntax and dumps the resulting AST
 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)
 .
 .IP
-If multiple templates are given, they are separated with a header indicating the name of the template\. This can be surpressed with the option \-\-no\-header\. The option \-\-[no\-]header has no effect whe a single template is dumped\.
+If multiple templates are given, they are separated with a header indicating the name of the template\. This can be suppressed with the option \-\-no\-header\. The option \-\-[no\-]header has no effect when a single template is dumped\.
 .
 .IP
-When debugging the epp parser itself, it may be useful to surpress the valiation step with the \fB\-\-no\-validate\fR option to observe what the parser produced from the given source\.
+When debugging the epp parser itself, it may be useful to suppress the validation step with the \fB\-\-no\-validate\fR option to observe what the parser produced from the given source\.
 .
 .IP
 This command ignores the \-\-render\-as setting/option\.
@@ -74,7 +74,7 @@ A dump of the resulting AST model unless there are syntax or validation errors\.
 \fBSYNOPSIS\fR
 .
 .IP
-puppet epp render [\-\-e \fIsource\fR] [\-\-values \fIvalues_hash\fR] [\-\-values_file \fIpp_or_yaml_file\fR] [\-\-facts \fIyaml_file\fR] [\-\-[no\-]header] \-e \fIsource\fR | [\fItemplates\fR \.\.\.]
+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 \.\.\.]
 .
 .IP
 \fBDESCRIPTION\fR
@@ -101,7 +101,10 @@ If multiple templates are given, the same set of values are given to each templa
 When multiple templates are rendered, a separating header is output between the templates showing the name of the template before the output\. The header output can be turned off with \fB\-\-no\-header\fR\. This also concatenates the template results without any added newline separators\.
 .
 .IP
-Facts for the simulated node can be feed to the rendering process by referencing a \.yaml file with facts using the \-\-facts option\. (Values can be obtained in yaml format directly from \fBfacter\fR, or from puppet for a given node)\. Note that it is not possible to simulate the reserved variable name \fB$facts\fR in any other way\.
+Facts from the node where the command is being run are used by default\.args Facts can be obtained for other nodes if they have called in, and reported their facts by using the \fB\-\-node <nodename>\fR flag\.
+.
+.IP
+Overriding node facts as well as additional facts can be given in a \.yaml or \.json file and referencing it with the \-\-facts option\. (Values can be obtained in yaml format directly from \fBfacter\fR, or from puppet for a given node)\. Note that it is not possible to simulate the reserved variable name \fB$facts\fR in any other way\.
 .
 .IP
 Note that it is not possible to set variables using the Puppet Language that have the same names as facts as this result in an error; "attempt to redefine a variable" since facts are set first\.
@@ -110,18 +113,21 @@ Note that it is not possible to set variables using the Puppet Language that hav
 Exits with 0 if there were no validation errors\. On errors, no rendered output is produced for that template file\.
 .
 .IP
-When designing EPP templates, it is strongly recommended to define all template arguments in the template, and to give them in a hash when calling \fBepp\fR or \fBinline_epp\fR and to use as few global variables as possible, preferrably only the $facts hash\. This makes templates more free standing and are easier to reuse, and to test\.
+When designing EPP templates, it is strongly recommended to define all template arguments in the template, and to give them in a hash when calling \fBepp\fR or \fBinline_epp\fR and to use as few global variables as possible, preferably only the $facts hash\. This makes templates more free standing and are easier to reuse, and to test\.
 .
 .IP
 \fBOPTIONS\fR \fI\-\-e <source\fR> \- Render one inline epp template given on the command line\.
 .
 .IP
-\fI\-\-facts <yaml_file\fR> \- A \.yaml file containing a hash of facts made available in $facts
+\fI\-\-facts <facts_file\fR> \- A \.yaml or \.json file containing a hash of facts made available in $facts and $trusted
 .
 .IP
 \fI\-\-[no\-]header\fR \- Whether or not to show a file name header between rendered results\.
 .
 .IP
+\fI\-\-node <node_name\fR> \- The name of the node for which facts are obtained\. Defaults to facts for the local node\.
+.
+.IP
 \fI\-\-values <values_hash\fR> \- A Hash in Puppet DSL form given as arguments to the template being rendered\.
 .
 .IP
@@ -346,4 +352,4 @@ $ puppet epp validate mymodule/template1\.epp mymodule/template2\.epp \-\-contin
 .IP "" 0
 .
 .SH "COPYRIGHT AND LICENSE"
-Copyright 2014 by Puppet Labs Apache 2 license; see COPYING
+Copyright 2014 by Puppet Inc\. Apache 2 license; see COPYING

data/man/man8/puppet-facts.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\-FACTS" "8" "May 2015" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-FACTS" "8" "January 2018" "Puppet Labs, LLC" "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-facts\fR \- Retrieve and store facts\.
@@ -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/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://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\.
 .
 .TP
 \-\-render\-as FORMAT
@@ -130,4 +130,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-file.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\-FILE" "8" "May 2015" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-FILE" "8" "January 2018" "Puppet Labs, LLC" "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-file\fR \- Retrieve and store files in a filebucket
@@ -16,7 +16,7 @@ This subcommand interacts with objects stored in a local or remote filebucket\.
 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://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\.
 .
 .TP
 \-\-render\-as FORMAT
@@ -186,4 +186,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-filebucket.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\-FILEBUCKET" "8" "May 2015" "Puppet Labs, LLC" "Puppet manual"
+.TH "PUPPET\-FILEBUCKET" "8" "January 2018" "Puppet Labs, LLC" "Puppet manual"
 .
 .SH "NAME"
 \fBpuppet\-filebucket\fR \- Store and retrieve files in a filebucket
@@ -10,7 +10,7 @@
 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 \.\.\.
+puppet filebucket \fImode\fR [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] [\-l|\-\-local] [\-r|\-\-remote] [\-s|\-\-server \fIserver\fR] [\-f|\-\-fromdate \fIdate\fR] [\-t|\-\-todate \fIdate\fR] [\-b|\-\-bucket \fIdirectory\fR] \fIfile\fR \fIfile\fR \.\.\.
 .
 .P
 Puppet filebucket can operate in three modes, with only one mode per call:
@@ -24,6 +24,12 @@ get: Return the text associated with an md5 sum\. The text is printed to stdout,
 .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\.
 .
+.P
+diff: Print a diff in unified format between two checksums in the filebucket or between a checksum and its matching file\.
+.
+.P
+list: List all files in the current local filebucket\. Listing remote filebuckets is not allowed\.
+.
 .SH "DESCRIPTION"
 This is a stand\-alone filebucket client for sending files to a local or central filebucket\.
 .
@@ -34,13 +40,17 @@ Note that \'filebucket\' defaults to using a network\-based filebucket available
 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/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://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\'\.
 .
 .TP
 \-\-debug
 Enable full debugging\.
 .
 .TP
+\-\-fromdate
+(list only) Select bucket files from \'fromdate\'
+.
+.TP
 \-\-help
 Print this help message
 .
@@ -57,6 +67,10 @@ Use a remote filebucket\. This will use the default configuration information\.
 The server to send the file to, instead of locally\.
 .
 .TP
+\-\-todate
+(list only) Select bucket files until \'todate\'
+.
+.TP
 \-\-verbose
 Print extra information\.
 .
@@ -64,13 +78,56 @@ 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 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
+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
+
+## From a Puppet master, list files in the master bucketdir
+$ puppet filebucket \-b $(puppet config print bucketdir \-\-section master) list
+d43a6ecaa892a1962398ac9170ea9bf2 2015\-05\-11 09:27:56 /tmp/TestFile
+7ae322f5791217e031dc60188f4521ef 2015\-05\-11 09:52:15 /tmp/TestFile
 .
 .fi
 .
@@ -78,4 +135,4 @@ $ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949
 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