From e1e9973c1e3d3a55a4c40ba644ebd200fbaae03e Mon Sep 17 00:00:00 2001 From: Jenkins CI Date: Thu, 17 Oct 2024 02:38:01 +0000 Subject: [PATCH] (packaging) Updating references for main --- man/man5/puppet.conf.5 | 2 +- man/man8/puppet-agent.8 | 2 +- man/man8/puppet-apply.8 | 2 +- man/man8/puppet-catalog.8 | 2 +- man/man8/puppet-config.8 | 2 +- man/man8/puppet-describe.8 | 2 +- man/man8/puppet-device.8 | 2 +- man/man8/puppet-doc.8 | 2 +- man/man8/puppet-epp.8 | 2 +- man/man8/puppet-facts.8 | 2 +- man/man8/puppet-filebucket.8 | 2 +- man/man8/puppet-generate.8 | 2 +- man/man8/puppet-help.8 | 2 +- man/man8/puppet-lookup.8 | 2 +- man/man8/puppet-module.8 | 2 +- man/man8/puppet-node.8 | 2 +- man/man8/puppet-parser.8 | 2 +- man/man8/puppet-plugin.8 | 2 +- man/man8/puppet-report.8 | 2 +- man/man8/puppet-resource.8 | 2 +- man/man8/puppet-script.8 | 2 +- man/man8/puppet-ssl.8 | 2 +- man/man8/puppet.8 | 2 +- references/configuration.md | 4 +- references/function.md | 4 +- references/man/agent.md | 56 ++++++++---- references/man/apply.md | 40 ++++++--- references/man/catalog.md | 66 ++++++++++---- references/man/config.md | 56 +++++++----- references/man/describe.md | 32 +++++-- references/man/device.md | 48 ++++++---- references/man/doc.md | 36 +++++--- references/man/epp.md | 160 ++++++++++++++++++++++++++------- references/man/facts.md | 52 +++++++---- references/man/filebucket.md | 50 ++++++++--- references/man/generate.md | 44 ++++++--- references/man/help.md | 32 ++++--- references/man/lookup.md | 81 ++++++++++------- references/man/module.md | 46 ++++++---- references/man/node.md | 50 +++++++---- references/man/overview.md | 4 +- references/man/parser.md | 41 ++++++--- references/man/plugin.md | 36 +++++--- references/man/report.md | 44 ++++++--- references/man/resource.md | 48 +++++++--- references/man/script.md | 36 +++++--- references/man/ssl.md | 32 ++++--- references/metaparameter.md | 4 +- references/report.md | 4 +- references/type.md | 8 +- references/types/exec.md | 4 +- references/types/file.md | 4 +- references/types/filebucket.md | 4 +- references/types/group.md | 4 +- references/types/notify.md | 4 +- references/types/overview.md | 4 +- references/types/package.md | 4 +- references/types/resources.md | 4 +- references/types/schedule.md | 4 +- references/types/service.md | 4 +- references/types/stage.md | 4 +- references/types/tidy.md | 8 +- references/types/user.md | 4 +- 63 files changed, 837 insertions(+), 379 deletions(-) diff --git a/man/man5/puppet.conf.5 b/man/man5/puppet.conf.5 index bc15d113816..e413e18de61 100644 --- a/man/man5/puppet.conf.5 +++ b/man/man5/puppet.conf.5 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPETCONF" "5" "September 2024" "Puppet, Inc." "Puppet manual" +.TH "PUPPETCONF" "5" "October 2024" "Puppet, Inc." "Puppet manual" . .SH "Configuration settings" . diff --git a/man/man8/puppet-agent.8 b/man/man8/puppet-agent.8 index 01dc8f05efd..d579ddedd7c 100644 --- a/man/man8/puppet-agent.8 +++ b/man/man8/puppet-agent.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-AGENT" "8" "September 2024" "Puppet, Inc." "Puppet manual" +.TH "PUPPET\-AGENT" "8" "October 2024" "Puppet, Inc." "Puppet manual" . .SH "NAME" \fBpuppet\-agent\fR \- The puppet agent daemon diff --git a/man/man8/puppet-apply.8 b/man/man8/puppet-apply.8 index c169244cba4..75de2b9b194 100644 --- a/man/man8/puppet-apply.8 +++ b/man/man8/puppet-apply.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-APPLY" "8" "September 2024" "Puppet, Inc." "Puppet manual" +.TH "PUPPET\-APPLY" "8" "October 2024" "Puppet, Inc." "Puppet manual" . .SH "NAME" \fBpuppet\-apply\fR \- Apply Puppet manifests locally diff --git a/man/man8/puppet-catalog.8 b/man/man8/puppet-catalog.8 index 74e53c7ab60..04bba56b7e7 100644 --- a/man/man8/puppet-catalog.8 +++ b/man/man8/puppet-catalog.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-CATALOG" "8" "September 2024" "Puppet, Inc." "Puppet manual" +.TH "PUPPET\-CATALOG" "8" "October 2024" "Puppet, Inc." "Puppet manual" . .SH "NAME" \fBpuppet\-catalog\fR \- Compile, save, view, and convert catalogs\. diff --git a/man/man8/puppet-config.8 b/man/man8/puppet-config.8 index c6b2ad6bc0f..59777ee4312 100644 --- a/man/man8/puppet-config.8 +++ b/man/man8/puppet-config.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-CONFIG" "8" "September 2024" "Puppet, Inc." "Puppet manual" +.TH "PUPPET\-CONFIG" "8" "October 2024" "Puppet, Inc." "Puppet manual" . .SH "NAME" \fBpuppet\-config\fR \- Interact with Puppet\'s settings\. diff --git a/man/man8/puppet-describe.8 b/man/man8/puppet-describe.8 index c59a29e8d6e..b82b8b503b2 100644 --- a/man/man8/puppet-describe.8 +++ b/man/man8/puppet-describe.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-DESCRIBE" "8" "September 2024" "Puppet, Inc." "Puppet manual" +.TH "PUPPET\-DESCRIBE" "8" "October 2024" "Puppet, Inc." "Puppet manual" . .SH "NAME" \fBpuppet\-describe\fR \- Display help about resource types diff --git a/man/man8/puppet-device.8 b/man/man8/puppet-device.8 index 9789aedae12..04a216d98b1 100644 --- a/man/man8/puppet-device.8 +++ b/man/man8/puppet-device.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-DEVICE" "8" "September 2024" "Puppet, Inc." "Puppet manual" +.TH "PUPPET\-DEVICE" "8" "October 2024" "Puppet, Inc." "Puppet manual" . .SH "NAME" \fBpuppet\-device\fR \- Manage remote network devices diff --git a/man/man8/puppet-doc.8 b/man/man8/puppet-doc.8 index 5a702fe37e9..8a9dbb1517f 100644 --- a/man/man8/puppet-doc.8 +++ b/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" "September 2024" "Puppet, Inc." "Puppet manual" +.TH "PUPPET\-DOC" "8" "October 2024" "Puppet, Inc." "Puppet manual" . .SH "NAME" \fBpuppet\-doc\fR \- Generate Puppet references diff --git a/man/man8/puppet-epp.8 b/man/man8/puppet-epp.8 index 5658f388870..8298ce967fd 100644 --- a/man/man8/puppet-epp.8 +++ b/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" "September 2024" "Puppet, Inc." "Puppet manual" +.TH "PUPPET\-EPP" "8" "October 2024" "Puppet, Inc." "Puppet manual" . .SH "NAME" \fBpuppet\-epp\fR \- Interact directly with the EPP template parser/renderer\. diff --git a/man/man8/puppet-facts.8 b/man/man8/puppet-facts.8 index 71fc5154996..1a03632f69d 100644 --- a/man/man8/puppet-facts.8 +++ b/man/man8/puppet-facts.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-FACTS" "8" "September 2024" "Puppet, Inc." "Puppet manual" +.TH "PUPPET\-FACTS" "8" "October 2024" "Puppet, Inc." "Puppet manual" . .SH "NAME" \fBpuppet\-facts\fR \- Retrieve and store facts\. diff --git a/man/man8/puppet-filebucket.8 b/man/man8/puppet-filebucket.8 index aec9d72b68e..21b0612dade 100644 --- a/man/man8/puppet-filebucket.8 +++ b/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" "September 2024" "Puppet, Inc." "Puppet manual" +.TH "PUPPET\-FILEBUCKET" "8" "October 2024" "Puppet, Inc." "Puppet manual" . .SH "NAME" \fBpuppet\-filebucket\fR \- Store and retrieve files in a filebucket diff --git a/man/man8/puppet-generate.8 b/man/man8/puppet-generate.8 index 00de0e0d673..ccc603c107d 100644 --- a/man/man8/puppet-generate.8 +++ b/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" "September 2024" "Puppet, Inc." "Puppet manual" +.TH "PUPPET\-GENERATE" "8" "October 2024" "Puppet, Inc." "Puppet manual" . .SH "NAME" \fBpuppet\-generate\fR \- Generates Puppet code from Ruby definitions\. diff --git a/man/man8/puppet-help.8 b/man/man8/puppet-help.8 index 6d78857d88c..4f82e63bc7a 100644 --- a/man/man8/puppet-help.8 +++ b/man/man8/puppet-help.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-HELP" "8" "September 2024" "Puppet, Inc." "Puppet manual" +.TH "PUPPET\-HELP" "8" "October 2024" "Puppet, Inc." "Puppet manual" . .SH "NAME" \fBpuppet\-help\fR \- Display Puppet help\. diff --git a/man/man8/puppet-lookup.8 b/man/man8/puppet-lookup.8 index 82ce3bd0019..15b2a89fbcd 100644 --- a/man/man8/puppet-lookup.8 +++ b/man/man8/puppet-lookup.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-LOOKUP" "8" "September 2024" "Puppet, Inc." "Puppet manual" +.TH "PUPPET\-LOOKUP" "8" "October 2024" "Puppet, Inc." "Puppet manual" . .SH "NAME" \fBpuppet\-lookup\fR \- Interactive Hiera lookup diff --git a/man/man8/puppet-module.8 b/man/man8/puppet-module.8 index ed64845dab1..7619b8f45fe 100644 --- a/man/man8/puppet-module.8 +++ b/man/man8/puppet-module.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-MODULE" "8" "September 2024" "Puppet, Inc." "Puppet manual" +.TH "PUPPET\-MODULE" "8" "October 2024" "Puppet, Inc." "Puppet manual" . .SH "NAME" \fBpuppet\-module\fR \- Creates, installs and searches for modules on the Puppet Forge\. diff --git a/man/man8/puppet-node.8 b/man/man8/puppet-node.8 index 1248cf4b4cc..0ae64fbc8b0 100644 --- a/man/man8/puppet-node.8 +++ b/man/man8/puppet-node.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-NODE" "8" "September 2024" "Puppet, Inc." "Puppet manual" +.TH "PUPPET\-NODE" "8" "October 2024" "Puppet, Inc." "Puppet manual" . .SH "NAME" \fBpuppet\-node\fR \- View and manage node definitions\. diff --git a/man/man8/puppet-parser.8 b/man/man8/puppet-parser.8 index dd6f70084db..323208c8d96 100644 --- a/man/man8/puppet-parser.8 +++ b/man/man8/puppet-parser.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-PARSER" "8" "September 2024" "Puppet, Inc." "Puppet manual" +.TH "PUPPET\-PARSER" "8" "October 2024" "Puppet, Inc." "Puppet manual" . .SH "NAME" \fBpuppet\-parser\fR \- Interact directly with the parser\. diff --git a/man/man8/puppet-plugin.8 b/man/man8/puppet-plugin.8 index 0fbe0e69716..2dbbee7cca1 100644 --- a/man/man8/puppet-plugin.8 +++ b/man/man8/puppet-plugin.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-PLUGIN" "8" "September 2024" "Puppet, Inc." "Puppet manual" +.TH "PUPPET\-PLUGIN" "8" "October 2024" "Puppet, Inc." "Puppet manual" . .SH "NAME" \fBpuppet\-plugin\fR \- Interact with the Puppet plugin system\. diff --git a/man/man8/puppet-report.8 b/man/man8/puppet-report.8 index 6e0ae558996..d0bfb06d6e1 100644 --- a/man/man8/puppet-report.8 +++ b/man/man8/puppet-report.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-REPORT" "8" "September 2024" "Puppet, Inc." "Puppet manual" +.TH "PUPPET\-REPORT" "8" "October 2024" "Puppet, Inc." "Puppet manual" . .SH "NAME" \fBpuppet\-report\fR \- Create, display, and submit reports\. diff --git a/man/man8/puppet-resource.8 b/man/man8/puppet-resource.8 index 28dab796bab..8cf3b4abc7c 100644 --- a/man/man8/puppet-resource.8 +++ b/man/man8/puppet-resource.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-RESOURCE" "8" "September 2024" "Puppet, Inc." "Puppet manual" +.TH "PUPPET\-RESOURCE" "8" "October 2024" "Puppet, Inc." "Puppet manual" . .SH "NAME" \fBpuppet\-resource\fR \- The resource abstraction layer shell diff --git a/man/man8/puppet-script.8 b/man/man8/puppet-script.8 index 211c69dafab..d074ac8dc08 100644 --- a/man/man8/puppet-script.8 +++ b/man/man8/puppet-script.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-SCRIPT" "8" "September 2024" "Puppet, Inc." "Puppet manual" +.TH "PUPPET\-SCRIPT" "8" "October 2024" "Puppet, Inc." "Puppet manual" . .SH "NAME" \fBpuppet\-script\fR \- Run a puppet manifests as a script without compiling a catalog diff --git a/man/man8/puppet-ssl.8 b/man/man8/puppet-ssl.8 index 1b9d49fe571..16fe32a2df5 100644 --- a/man/man8/puppet-ssl.8 +++ b/man/man8/puppet-ssl.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET\-SSL" "8" "September 2024" "Puppet, Inc." "Puppet manual" +.TH "PUPPET\-SSL" "8" "October 2024" "Puppet, Inc." "Puppet manual" . .SH "NAME" \fBpuppet\-ssl\fR \- Manage SSL keys and certificates for puppet SSL clients diff --git a/man/man8/puppet.8 b/man/man8/puppet.8 index abc0c8ffd29..7269bd27494 100644 --- a/man/man8/puppet.8 +++ b/man/man8/puppet.8 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "PUPPET" "8" "September 2024" "Puppet, Inc." "Puppet manual" +.TH "PUPPET" "8" "October 2024" "Puppet, Inc." "Puppet manual" . .SH "NAME" \fBpuppet\fR \- an automated configuration management tool diff --git a/references/configuration.md b/references/configuration.md index cae70d17d50..59a4e93ea50 100644 --- a/references/configuration.md +++ b/references/configuration.md @@ -1,6 +1,6 @@ --- layout: default -built_from_commit: d0ec909330b5a98b868eae9a4aae37bbfca96e7a +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: Configuration Reference toc: columns canonical: "/puppet/latest/configuration.html" @@ -8,7 +8,7 @@ canonical: "/puppet/latest/configuration.html" # Configuration Reference -> **NOTE:** This page was generated from the Puppet source code on 2024-09-30 11:26:05 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:21 +0000 diff --git a/references/function.md b/references/function.md index be07092486c..d3faae9a597 100644 --- a/references/function.md +++ b/references/function.md @@ -1,6 +1,6 @@ --- layout: default -built_from_commit: f78896bb8131670bca861ce0bbbd06ae1a8e36f8 +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: Built-in function reference canonical: "/puppet/latest/function.html" toc_levels: 2 @@ -9,7 +9,7 @@ toc: columns # Built-in function reference -> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 16:24:44 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:43 +0000 diff --git a/references/man/agent.md b/references/man/agent.md index 0035c24d568..5f8fdc681e0 100644 --- a/references/man/agent.md +++ b/references/man/agent.md @@ -1,35 +1,43 @@ --- layout: default -built_from_commit: 70303b65ae864066c583e1436011ff135847f6ad +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Man Page: puppet agent' canonical: "/puppet/latest/man/agent.html" --- # Man Page: puppet agent -> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 17:41:46 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:47 +0000 + +NAME +==== -## NAME **puppet-agent** - The puppet agent daemon -## SYNOPSIS +SYNOPSIS +======== + Retrieves the client configuration from the Puppet master and applies it to the local host. This service may be run as a daemon, run periodically using cron (or something similar), or run interactively for testing purposes. -## USAGE +USAGE +===== + puppet agent \[\--certname *NAME*\] \[-D\|\--daemonize\|\--no-daemonize\] \[-d\|\--debug\] \[\--detailed-exitcodes\] \[\--digest *DIGEST*\] \[\--disable \[MESSAGE\]\] \[\--enable\] \[\--fingerprint\] \[-h\|\--help\] \[-l\|\--logdest syslog\|eventlog\|*ABS FILEPATH*\|console\] \[\--serverport *PORT*\] \[\--noop\] \[-o\|\--onetime\] -\[\--sourceaddress *IP_ADDRESS*\] \[-t\|\--test\] \[-v\|\--verbose\] +\[\--sourceaddress *IP\_ADDRESS*\] \[-t\|\--test\] \[-v\|\--verbose\] \[-V\|\--version\] \[-w\|\--waitforcert *SECONDS*\] -## DESCRIPTION +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 @@ -42,7 +50,9 @@ connecting until it receives one. Once the client has a signed certificate, it will retrieve its configuration and apply it. -## USAGE NOTES +USAGE NOTES +=========== + \'puppet agent\' does its best to find a compromise between interactive use and daemon use. If you run it with no arguments and no configuration, it goes into the background, attempts to get a signed @@ -69,6 +79,8 @@ one of the following exit codes: - 6: The run succeeded, and included both changes and failures. +- + \'\--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 @@ -89,11 +101,13 @@ 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). -\'\--skip_tags\' is a flag used to filter resources. If this is set, +\'\--skip\_tags\' is a flag used to filter resources. If this is set, then only resources not tagged with the specified tags will be applied. Values must be comma-separated. -## OPTIONS +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 *servername*\' as an argument. Boolean @@ -226,7 +240,7 @@ be generated by running puppet agent with \'\--genconfig\'. - \--test: Enable the most common options used for testing. These are \'onetime\', \'verbose\', \'no-daemonize\', \'no-usecacheonfailure\', \'detailed-exitcodes\', \'no-splay\', and - \'show_diff\'. + \'show\_diff\'. - \--trace Prints stack traces on some errors. (This is a Puppet setting, and can go in puppet.conf. Note the special \'no-\' prefix @@ -244,16 +258,22 @@ be generated by running puppet agent with \'\--genconfig\'. waiting for certificates by specifying a time of 0. (This is a Puppet setting, and can go in puppet.conf.) -- \--write_catalog_summary After compiling the catalog saves the +- \--write\_catalog\_summary After compiling the catalog saves the resource list and classes list to the node in the state directory named classes.txt and resources.txt (This is a Puppet setting, and can go in puppet.conf.) -## EXAMPLE +- + +EXAMPLE +======= + $ puppet agent --server puppet.domain.com -## DIAGNOSTICS +DIAGNOSTICS +=========== + Puppet agent accepts the following signals: SIGHUP @@ -274,9 +294,13 @@ SIGUSR2 : Close file descriptors for log files and reopen them. Used with logrotate. -## AUTHOR +AUTHOR +====== + Luke Kanies -## COPYRIGHT +COPYRIGHT +========= + Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License diff --git a/references/man/apply.md b/references/man/apply.md index ae8201de411..c6f14194f2c 100644 --- a/references/man/apply.md +++ b/references/man/apply.md @@ -1,28 +1,36 @@ --- layout: default -built_from_commit: 70303b65ae864066c583e1436011ff135847f6ad +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Man Page: puppet apply' canonical: "/puppet/latest/man/apply.html" --- # Man Page: puppet apply -> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 17:41:46 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:47 +0000 + +NAME +==== -## NAME **puppet-apply** - Apply Puppet manifests locally -## SYNOPSIS +SYNOPSIS +======== + Applies a standalone Puppet manifest to the local system. -## USAGE +USAGE +===== + puppet apply \[-h\|\--help\] \[-V\|\--version\] \[-d\|\--debug\] \[-v\|\--verbose\] \[-e\|\--execute\] \[\--detailed-exitcodes\] \[-L\|\--loadclasses\] \[-l\|\--logdest syslog\|eventlog\|*ABS FILEPATH*\|console\] \[\--noop\] \[\--catalog *catalog*\] \[\--write-catalog-summary\] *file* -## DESCRIPTION +DESCRIPTION +=========== + This is the standalone puppet execution tool; use it to apply individual manifests. @@ -36,7 +44,9 @@ site. Most users should use \'puppet agent\' and \'puppet master\' for site-wide manifests. -## OPTIONS +OPTIONS +======= + Any setting that\'s valid in the configuration file is a valid long argument for puppet apply. For example, \'tags\' is a valid setting, so you can specify \'\--tags *class*,*tag*\' as an argument. @@ -91,7 +101,7 @@ configuration options by running puppet with \'\--genconfig\'. - \--execute: Execute a specific piece of Puppet code - \--test: Enable the most common options used for testing. These are - \'verbose\', \'detailed-exitcodes\' and \'show_diff\'. + \'verbose\', \'detailed-exitcodes\' and \'show\_diff\'. - \--verbose: Print extra information. @@ -103,16 +113,24 @@ configuration options by running puppet with \'\--genconfig\'. resource list and classes list to the node in the state directory named classes.txt and resources.txt -## EXAMPLE +- + +EXAMPLE +======= + $ puppet apply -e 'notify { "hello world": }' $ puppet apply -l /tmp/manifest.log manifest.pp $ puppet apply --modulepath=/root/dev/modules -e "include ntpd::server" $ puppet apply --catalog catalog.json -## AUTHOR +AUTHOR +====== + Luke Kanies -## COPYRIGHT +COPYRIGHT +========= + Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License diff --git a/references/man/catalog.md b/references/man/catalog.md index 17ccdde027b..d2065300df1 100644 --- a/references/man/catalog.md +++ b/references/man/catalog.md @@ -1,21 +1,27 @@ --- layout: default -built_from_commit: 70303b65ae864066c583e1436011ff135847f6ad +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Man Page: puppet catalog' canonical: "/puppet/latest/man/catalog.html" --- # Man Page: puppet catalog -> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 17:41:46 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:47 +0000 + +NAME +==== -## NAME **puppet-catalog** - Compile, save, view, and convert catalogs. -## SYNOPSIS +SYNOPSIS +======== + puppet catalog *action* \[\--terminus \_TERMINUS\] -## DESCRIPTION +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 @@ -24,12 +30,14 @@ catalog with the **\--terminus** option. You can also choose to print any catalog in \'dot\' format (for easy graph viewing with OmniGraffle or Graphviz) with \'\--render-as dot\'. -## OPTIONS +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, **server** and **run_mode** are valid +present action. For example, **server** and **run\_mode** are valid settings, so you can specify **\--server \**, or -**\--run_mode \** as an argument. +**\--run\_mode \** as an argument. See the configuration file documentation at *https://puppet.com/docs/puppet/latest/configuration.html* for the full @@ -68,7 +76,9 @@ options can also be generated by running puppet with **\--genconfig**. occasionally needs to be set explicitly. See the \"Notes\" section of this face\'s manpage for more details. -## ACTIONS +ACTIONS +======= + **apply** - Find and apply a catalog. : **SYNOPSIS** @@ -123,7 +133,7 @@ options can also be generated by running puppet with **\--genconfig**. **NOTES** When used from the Ruby API, this action has a side effect of - leaving Puppet::Resource::Catalog.indirection.terminus_class set to + leaving Puppet::Resource::Catalog.indirection.terminus\_class set to yaml. The terminus must be explicitly re-set for subsequent catalog actions. @@ -132,13 +142,13 @@ options can also be generated by running puppet with **\--genconfig**. : **SYNOPSIS** puppet catalog find \[\--terminus \_TERMINUS\] - \[\--facts_for_catalog\] *certname*, *facts* + \[\--facts\_for\_catalog\] *certname*, *facts* **DESCRIPTION** Retrieve the catalog for the node from which the command is run. - **OPTIONS** *\--facts_for_catalog* - Not implemented for the CLI; + **OPTIONS** *\--facts\_for\_catalog* - Not implemented for the CLI; facts are collected internally. **RETURNS** @@ -156,7 +166,7 @@ options can also be generated by running puppet with **\--genconfig**. 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 \'\--run_mode\' option. + doubt, specify the run mode with the \'\--run\_mode\' option. **save** - API only: create or overwrite an object. @@ -175,7 +185,7 @@ options can also be generated by running puppet with **\--genconfig**. : **SYNOPSIS** puppet catalog select \[\--terminus \_TERMINUS\] *host* - *resource_type* + *resource\_type* **DESCRIPTION** @@ -197,7 +207,9 @@ options can also be generated by running puppet with **\--genconfig**. FORMATTING ISSUES: This action cannot currently render useful yaml; instead, it returns an entire catalog. Use json instead. -## EXAMPLES +EXAMPLES +======== + **apply** Apply the locally cached catalog: @@ -210,11 +222,17 @@ Retrieve a catalog from the master and apply it, in one step: API example: +- +```{=html} + +``` ## ... Puppet::Face[:catalog, '0.0.1'].download ## (Termini are singletons; catalog.download has a side effect of ## setting the catalog terminus to yaml) report = Puppet::Face[:catalog, '0.0.1'].apply ## ... +- + **compile** Compile catalog for node \'mynode\': @@ -229,19 +247,27 @@ Retrieve and store a catalog: API example: +- +```{=html} + +``` Puppet::Face[:plugin, '0.0.1'].download Puppet::Face[:facts, '0.0.1'].upload Puppet::Face[:catalog, '0.0.1'].download ## ... +- + **select** Ask the puppet master for a list of managed file resources for a node: \$ puppet catalog select \--terminus rest somenode.magpie.lan file -## NOTES +NOTES +===== + This subcommand is an indirector face, which exposes **find**, **search**, **save**, and **destroy** actions for an indirected subsystem of Puppet. Valid termini for this face include: @@ -254,9 +280,13 @@ subsystem of Puppet. Valid termini for this face include: - **rest** -- **store_configs** +- **store\_configs** - **yaml** -## COPYRIGHT AND LICENSE +- + +COPYRIGHT AND LICENSE +===================== + Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING diff --git a/references/man/config.md b/references/man/config.md index 94f01222be7..8f3648c1d7c 100644 --- a/references/man/config.md +++ b/references/man/config.md @@ -1,31 +1,39 @@ --- layout: default -built_from_commit: 70303b65ae864066c583e1436011ff135847f6ad +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Man Page: puppet config' canonical: "/puppet/latest/man/config.html" --- # Man Page: puppet config -> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 17:41:46 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:47 +0000 + +NAME +==== -## NAME **puppet-config** - Interact with Puppet\'s settings. -## SYNOPSIS -puppet config *action* \[\--section SECTION_NAME\] +SYNOPSIS +======== + +puppet config *action* \[\--section SECTION\_NAME\] + +DESCRIPTION +=========== -## DESCRIPTION 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. -## OPTIONS +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, **server** and **run_mode** are valid +present action. For example, **server** and **run\_mode** are valid settings, so you can specify **\--server \**, or -**\--run_mode \** as an argument. +**\--run\_mode \** as an argument. See the configuration file documentation at *https://puppet.com/docs/puppet/latest/configuration.html* for the full @@ -46,7 +54,7 @@ options can also be generated by running puppet with **\--genconfig**. : Whether to log debug information. -\--section SECTION_NAME +\--section SECTION\_NAME : The section of the puppet.conf configuration file to interact with. @@ -61,12 +69,14 @@ options can also be generated by running puppet with **\--genconfig**. environment (a deprecated feature), and can only include the \'manifest\' and \'modulepath\' settings. -## ACTIONS +ACTIONS +======= + **delete** - Delete a Puppet setting. : **SYNOPSIS** - puppet config delete \[\--section SECTION_NAME\] *setting* + puppet config delete \[\--section SECTION\_NAME\] *setting* **DESCRIPTION** @@ -83,7 +93,7 @@ options can also be generated by running puppet with **\--genconfig**. : **SYNOPSIS** - puppet config print \[\--section SECTION_NAME\] all \| *setting* + puppet config print \[\--section SECTION\_NAME\] all \| *setting* \[*setting* \...\] **DESCRIPTION** @@ -103,8 +113,8 @@ options can also be generated by running puppet with **\--genconfig**. : **SYNOPSIS** - puppet config set \[\--section SECTION_NAME\] \[setting_name\] - \[setting_value\] + puppet config set \[\--section SECTION\_NAME\] \[setting\_name\] + \[setting\_value\] **DESCRIPTION** @@ -116,18 +126,20 @@ options can also be generated by running puppet with **\--genconfig**. \'main\' section. Use the \'\--section\' flag to manipulate other configuration domains. -## EXAMPLES +EXAMPLES +======== + **delete** -Delete the setting \'setting_name\' from the \'main\' configuration +Delete the setting \'setting\_name\' from the \'main\' configuration domain: -\$ puppet config delete setting_name +\$ puppet config delete setting\_name -Delete the setting \'setting_name\' from the \'server\' configuration +Delete the setting \'setting\_name\' from the \'server\' configuration domain: -\$ puppet config delete setting_name \--section server +\$ puppet config delete setting\_name \--section server **print** @@ -150,5 +162,7 @@ Set the vardir for only the agent: \$ puppet config set vardir /opt/puppetlabs/puppet/cache \--section agent -## COPYRIGHT AND LICENSE +COPYRIGHT AND LICENSE +===================== + Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING diff --git a/references/man/describe.md b/references/man/describe.md index a857f8eeb89..b1238f1db2d 100644 --- a/references/man/describe.md +++ b/references/man/describe.md @@ -1,25 +1,33 @@ --- layout: default -built_from_commit: 70303b65ae864066c583e1436011ff135847f6ad +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Man Page: puppet describe' canonical: "/puppet/latest/man/describe.html" --- # Man Page: puppet describe -> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 17:41:46 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:47 +0000 + +NAME +==== -## NAME **puppet-describe** - Display help about resource types -## SYNOPSIS +SYNOPSIS +======== + Prints help about Puppet resource types, providers, and metaparameters. -## USAGE +USAGE +===== + puppet describe \[-h\|\--help\] \[-s\|\--short\] \[-p\|\--providers\] \[-l\|\--list\] \[-m\|\--meta\] -## OPTIONS +OPTIONS +======= + \--help : Print this help text @@ -40,15 +48,21 @@ puppet describe \[-h\|\--help\] \[-s\|\--short\] \[-p\|\--providers\] : List only parameters without detail -## EXAMPLE +EXAMPLE +======= + $ puppet describe --list $ puppet describe file --providers $ puppet describe user -s -m -## AUTHOR +AUTHOR +====== + David Lutterkort -## COPYRIGHT +COPYRIGHT +========= + Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License diff --git a/references/man/device.md b/references/man/device.md index 5ab644f3df1..2b6cf749531 100644 --- a/references/man/device.md +++ b/references/man/device.md @@ -1,25 +1,31 @@ --- layout: default -built_from_commit: 70303b65ae864066c583e1436011ff135847f6ad +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Man Page: puppet device' canonical: "/puppet/latest/man/device.html" --- # Man Page: puppet device -> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 17:41:46 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:47 +0000 + +NAME +==== -## NAME **puppet-device** - Manage remote network devices -## SYNOPSIS +SYNOPSIS +======== + Retrieves catalogs from the Puppet master and applies them to remote devices. This subcommand can be run manually; or periodically using cron, a scheduled task, or a similar tool. -## USAGE +USAGE +===== + puppet device \[-h\|\--help\] \[-v\|\--verbose\] \[-d\|\--debug\] \[-l\|\--logdest syslog\|*file*\|console\] \[\--detailed-exitcodes\] \[\--deviceconfig *file*\] \[-w\|\--waitforcert *seconds*\] \[\--libdir @@ -27,18 +33,22 @@ puppet device \[-h\|\--help\] \[-v\|\--verbose\] \[-d\|\--debug\] *type* \[name\]\] \[-t\|\--target *device*\] \[\--user=*user*\] \[-V\|\--version\] -## DESCRIPTION +DESCRIPTION +=========== + Devices require a proxy Puppet agent to request certificates, collect facts, retrieve and apply catalogs, and store reports. -## USAGE NOTES +USAGE NOTES +=========== + 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. The device.conf file is an INI-like file, with one section per device: -\[*DEVICE_CERTNAME*\] type *TYPE* url *URL* debug +\[*DEVICE\_CERTNAME*\] type *TYPE* url *URL* debug The section name specifies the certname of the device. @@ -48,10 +58,12 @@ device. The optional debug property specifies transport-level debugging, and is limited to telnet and ssh transports. -See https://puppet.com/docs/puppet/latest/config_file_device.html for +See https://puppet.com/docs/puppet/latest/config\_file\_device.html for details. -## OPTIONS +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 *servername*\' as an argument. @@ -133,22 +145,28 @@ parameter, so you can specify \'\--server *servername*\' as an argument. : Target a specific device/certificate in the device.conf. Doing so will perform a device run against only that device/certificate. -\--to_yaml +\--to\_yaml : Output found resources in yaml format, suitable to use with Hiera - and create_resources. + and create\_resources. \--user : The user to run as. -## EXAMPLE +EXAMPLE +======= + $ puppet device --target remotehost --verbose -## AUTHOR +AUTHOR +====== + Brice Figureau -## COPYRIGHT +COPYRIGHT +========= + Copyright (c) 2011-2018 Puppet Inc., LLC Licensed under the Apache 2.0 License diff --git a/references/man/doc.md b/references/man/doc.md index 83ff741c10a..c4191c17f31 100644 --- a/references/man/doc.md +++ b/references/man/doc.md @@ -1,26 +1,34 @@ --- layout: default -built_from_commit: 70303b65ae864066c583e1436011ff135847f6ad +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Man Page: puppet doc' canonical: "/puppet/latest/man/doc.html" --- # Man Page: puppet doc -> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 17:41:46 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:47 +0000 + +NAME +==== -## NAME **puppet-doc** - Generate Puppet references -## SYNOPSIS +SYNOPSIS +======== + Generates a reference for all Puppet types. Largely meant for internal Puppet Inc. use. (Deprecated) -## USAGE +USAGE +===== + puppet doc \[-h\|\--help\] \[-l\|\--list\] \[-r\|\--reference *reference-name*\] -## DESCRIPTION +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 @@ -33,7 +41,9 @@ https://github.com/puppetlabs/puppetlabs-strings for more information. This command (puppet-doc) will be removed once the puppetlabs internal documentation processing pipeline is completely based on puppet-strings. -## OPTIONS +OPTIONS +======= + \--help : Print this help message @@ -43,13 +53,19 @@ documentation processing pipeline is completely based on puppet-strings. : Build a particular reference. Get a list of references by running \'puppet doc \--list\'. -## EXAMPLE +EXAMPLE +======= + $ puppet doc -r type > /tmp/type_reference.markdown -## AUTHOR +AUTHOR +====== + Luke Kanies -## COPYRIGHT +COPYRIGHT +========= + Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License diff --git a/references/man/epp.md b/references/man/epp.md index d13fa48980b..b0a3bf2018d 100644 --- a/references/man/epp.md +++ b/references/man/epp.md @@ -1,27 +1,33 @@ --- layout: default -built_from_commit: 70303b65ae864066c583e1436011ff135847f6ad +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Man Page: puppet epp' canonical: "/puppet/latest/man/epp.html" --- # Man Page: puppet epp -> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 17:41:46 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:47 +0000 + +NAME +==== -## NAME **puppet-epp** - Interact directly with the EPP template parser/renderer. -## SYNOPSIS +SYNOPSIS +======== + puppet epp *action* -## OPTIONS +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, **server** and **run_mode** are valid +present action. For example, **server** and **run\_mode** are valid settings, so you can specify **\--server \**, or -**\--run_mode \** as an argument. +**\--run\_mode \** as an argument. See the configuration file documentation at *https://puppet.com/docs/puppet/latest/configuration.html* for the full @@ -42,7 +48,9 @@ options can also be generated by running puppet with **\--genconfig**. : Whether to log debug information. -## ACTIONS +ACTIONS +======= + - **dump** - Outputs a dump of the internal template parse tree for debugging: **SYNOPSIS** @@ -66,6 +74,8 @@ options can also be generated by running puppet with **\--genconfig**. - \'json\' outputs the same graph as \'pn\' but with JSON syntax. +- + 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. @@ -109,10 +119,10 @@ options can also be generated by running puppet with **\--genconfig**. - **render** - Renders an epp template as text: **SYNOPSIS** - puppet epp render \[\--node *node_name*\] \[\--e *source*\] - \[\--values *values_hash*\] \[\--values_file *pp_or_yaml_file*\] - \[\--facts *facts_file*\] \[\--\[no-\]header\] -e *source* \| - \[*templates* \...\] + puppet epp render \[\--node *node\_name*\] \[\--e *source*\] + \[\--values *values\_hash*\] \[\--values\_file + *pp\_or\_yaml\_file*\] \[\--facts *facts\_file*\] + \[\--\[no-\]header\] -e *source* \| \[*templates* \...\] **DESCRIPTION** @@ -125,33 +135,33 @@ options can also be generated by running puppet with **\--genconfig**. case the given path matches both a modulename/template and a file, the template from the module is used. - An inline_epp equivalent can also be performed by giving the + An inline\_epp equivalent can also be performed by giving the template after an -e, or by piping the EPP source text to the command. Values to the template can be defined using the Puppet Language on the command line with **\--values** or in a .pp or .yaml file - referenced with **\--values_file**. If specifying both the result is - merged with \--values having higher precedence. + referenced with **\--values\_file**. If specifying both the result + is merged with \--values having higher precedence. The \--values option allows a Puppet Language sequence of expressions to be defined on the command line the same way as it may - be given in a .pp file referenced with **\--values_file**. It may + be given in a .pp file referenced with **\--values\_file**. It may set variable values (that become available in the template), and must produce either **undef** or a **Hash** of values (the hash may be empty). Producing **undef** simulates that the template is called without an arguments hash and thus only references variables in its outer scope. When a hash is given, a template is limited to seeing only the global scope. It is thus possible to simulate the different - types of calls to the **epp** and **inline_epp** functions, with or + types of calls to the **epp** and **inline\_epp** functions, with or without a given hash. Note that if variables are given, they are always available in this simulation - to test that the template only references variables given as arguments, produce a hash in \--values - or the \--values_file, do not specify any variables that are not - global, and turn on \--strict_variables setting. + or the \--values\_file, do not specify any variables that are not + global, and turn on \--strict\_variables setting. If multiple templates are given, the same set of values are given to - each template. If both \--values and \--value_file are used, the + each template. If both \--values and \--value\_file are used, the \--values are merged on top of those given in the file. When multiple templates are rendered, a separating header is output @@ -180,27 +190,27 @@ options can also be generated by running puppet with **\--genconfig**. 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 **epp** or **inline_epp** and to use as few global + when calling **epp** or **inline\_epp** 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. **OPTIONS** *\--e \ - Render one inline epp template given on the command line. - *\--facts \ - A .yaml or .json file containing a hash + *\--facts \ - A .yaml or .json file containing a hash of facts made available in \$facts and \$trusted *\--\[no-\]header* - Whether or not to show a file name header between rendered results. - *\--node \ - The name of the node for which facts are + *\--node \ - The name of the node for which facts are obtained. Defaults to facts for the local node. - *\--values \ - A Hash in Puppet DSL form given as + *\--values \ - A Hash in Puppet DSL form given as arguments to the template being rendered. - *\--values_file \ - A .pp or .yaml file that is - processed to produce a hash of values for the template. + *\--values\_file \ - A .pp or .yaml file that + is processed to produce a hash of values for the template. **RETURNS** @@ -209,7 +219,7 @@ options can also be generated by running puppet with **\--genconfig**. - **validate** - Validate the syntax of one or more EPP templates.: **SYNOPSIS** - puppet epp validate \[\--\[no-\]continue_on_error\] \[*template*\] + puppet epp validate \[\--\[no-\]continue\_on\_error\] \[*template*\] \[*template* \...\] **DESCRIPTION** @@ -217,9 +227,9 @@ options can also be generated by running puppet with **\--genconfig**. This action validates EPP syntax without producing any output. When validating, multiple issues per file are reported up to the - settings of max_error, and max_warnings. The processing stops after - having reported issues for the first encountered file with errors - unless the option \--continue_on_error is given. + settings of max\_error, and max\_warnings. The processing stops + after having reported issues for the first encountered file with + errors unless the option \--continue\_on\_error is given. Files can be given using the **modulename/template.epp** style to lookup the template from a module, or be given as a reference to a @@ -230,103 +240,187 @@ options can also be generated by running puppet with **\--genconfig**. Exits with 0 if there were no validation errors. - **OPTIONS** *\--\[no-\]continue_on_error* - Whether or not to + **OPTIONS** *\--\[no-\]continue\_on\_error* - Whether or not to continue after errors are reported for a template. **RETURNS** Nothing, or encountered syntax errors. -## EXAMPLES +- + +EXAMPLES +======== + **render** Render the template in module \'mymodule\' called \'mytemplate.epp\', and give it two arguments **a** and **b**: +- +```{=html} + +``` $ puppet epp render mymodule/mytemplate.epp --values '{a => 10, b => 20}' +- + Render a template using an absolute path: +- +```{=html} + +``` $ puppet epp render /tmp/testing/mytemplate.epp --values '{a => 10, b => 20}' +- + Render a template with data from a .pp file: +- +```{=html} + +``` $ puppet epp render /tmp/testing/mytemplate.epp --values_file mydata.pp +- + Render a template with data from a .pp file and override one value on the command line: +- +```{=html} + +``` $ puppet epp render /tmp/testing/mytemplate.epp --values_file mydata.pp --values '{a=>10}' +- + Render from STDIN: +- +```{=html} + +``` $ cat template.epp | puppet epp render --values '{a => 10, b => 20}' +- + Set variables in a .pp file and render a template that uses variable references: +- +```{=html} + +``` ## data.pp file $greeted = 'a global var' undef $ puppet epp render -e 'hello <%= $greeted %>' --values_file data.pp +- + Render a template that outputs a fact: +- +```{=html} + +``` $ facter --yaml > data.yaml $ puppet epp render -e '<% $facts[osfamily] %>' --facts data.yaml +- + **validate** Validate the template \'template.epp\' in module \'mymodule\': +- +```{=html} + +``` $ puppet epp validate mymodule/template.epp +- + Validate two arbitrary template files: +- +```{=html} + +``` $ puppet epp validate mymodule/template1.epp yourmodule/something.epp +- + Validate a template somewhere in the file system: +- +```{=html} + +``` $ puppet epp validate /tmp/testing/template1.epp +- + Validate a template against a file relative to the current directory: +- +```{=html} + +``` $ puppet epp validate template1.epp $ puppet epp validate ./template1.epp +- + Validate from STDIN: +- +```{=html} + +``` $ cat template.epp | puppet epp validate +- + Continue on error to see errors for all templates: +- +```{=html} + +``` $ puppet epp validate mymodule/template1.epp mymodule/template2.epp --continue_on_error -## COPYRIGHT AND LICENSE +- + +COPYRIGHT AND LICENSE +===================== + Copyright 2014 by Puppet Inc. Apache 2 license; see COPYING diff --git a/references/man/facts.md b/references/man/facts.md index 4eee9a7221d..05558222787 100644 --- a/references/man/facts.md +++ b/references/man/facts.md @@ -1,31 +1,39 @@ --- layout: default -built_from_commit: 70303b65ae864066c583e1436011ff135847f6ad +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Man Page: puppet facts' canonical: "/puppet/latest/man/facts.html" --- # Man Page: puppet facts -> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 17:41:46 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:47 +0000 + +NAME +==== -## NAME **puppet-facts** - Retrieve and store facts. -## SYNOPSIS +SYNOPSIS +======== + puppet facts *action* \[\--terminus \_TERMINUS\] -## DESCRIPTION +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 **facter** terminus). -## OPTIONS +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, **server** and **run_mode** are valid +present action. For example, **server** and **run\_mode** are valid settings, so you can specify **\--server \**, or -**\--run_mode \** as an argument. +**\--run\_mode \** as an argument. See the configuration file documentation at *https://puppet.com/docs/puppet/latest/configuration.html* for the full @@ -64,12 +72,14 @@ options can also be generated by running puppet with **\--genconfig**. occasionally needs to be set explicitly. See the \"Notes\" section of this face\'s manpage for more details. -## ACTIONS +ACTIONS +======= + **find** - Retrieve a node\'s facts. : **SYNOPSIS** - puppet facts find \[\--terminus \_TERMINUS\] \[*node_certname*\] + puppet facts find \[\--terminus \_TERMINUS\] \[*node\_certname*\] **DESCRIPTION** @@ -98,7 +108,7 @@ options can also be generated by running puppet with **\--genconfig**. 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 \'\--run_mode\' option. + doubt, specify the run mode with the \'\--run\_mode\' option. **save** - API only: create or overwrite an object. @@ -175,9 +185,11 @@ options can also be generated by running puppet with **\--genconfig**. For details on configuring Puppet Server\'s **auth.conf**, see: - *https://puppet.com/docs/puppetserver/latest/config_file_auth.html* + *https://puppet.com/docs/puppetserver/latest/config\_file\_auth.html* + +EXAMPLES +======== -## EXAMPLES **find** Get facts from the local system: @@ -196,7 +208,9 @@ Upload facts: \$ puppet facts upload -## NOTES +NOTES +===== + This subcommand is an indirector face, which exposes **find**, **search**, **save**, and **destroy** actions for an indirected subsystem of Puppet. Valid termini for this face include: @@ -207,13 +221,17 @@ subsystem of Puppet. Valid termini for this face include: - **memory** -- **network_device** +- **network\_device** - **rest** -- **store_configs** +- **store\_configs** - **yaml** -## COPYRIGHT AND LICENSE +- + +COPYRIGHT AND LICENSE +===================== + Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING diff --git a/references/man/filebucket.md b/references/man/filebucket.md index c54ed7f5eaa..5cd268e57f5 100644 --- a/references/man/filebucket.md +++ b/references/man/filebucket.md @@ -1,21 +1,27 @@ --- layout: default -built_from_commit: 70303b65ae864066c583e1436011ff135847f6ad +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Man Page: puppet filebucket' canonical: "/puppet/latest/man/filebucket.html" --- # Man Page: puppet filebucket -> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 17:41:46 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:47 +0000 + +NAME +==== -## NAME **puppet-filebucket** - Store and retrieve files in a filebucket -## SYNOPSIS +SYNOPSIS +======== + A stand-alone Puppet filebucket client. -## USAGE +USAGE +===== + puppet filebucket *mode* \[-h\|\--help\] \[-V\|\--version\] \[-d\|\--debug\] \[-v\|\--verbose\] \[-l\|\--local\] \[-r\|\--remote\] \[-s\|\--server *server*\] \[-f\|\--fromdate *date*\] \[-t\|\--todate @@ -41,7 +47,9 @@ filebucket or between a checksum and its matching file. list: List all files in the current local filebucket. Listing remote filebuckets is not allowed. -## DESCRIPTION +DESCRIPTION +=========== + This is a stand-alone filebucket client for sending files to a local or central filebucket. @@ -59,14 +67,26 @@ disk space by using one of the following two options: - Use a **find** command and **crontab** entry to retain only the last X days of file backups. For example: +- + +- +```{=html} + +``` find /opt/puppetlabs/server/data/puppetserver/bucket -type f -mtime +45 -atime +45 -print0 | xargs -0 rm +- + - Restrict the directory to a maximum size after which the oldest items are removed. -## OPTIONS +- + +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 *directory*\' as an argument. @@ -106,7 +126,7 @@ options can also be generated by running puppet with \'\--genconfig\'. information and the bucket located at the \'\$bucketdir\' setting by default. -\--server_list +\--server\_list : A list of comma separated servers; only the first entry is used for file storage. This setting takes precidence over **server**. @@ -114,7 +134,7 @@ options can also be generated by running puppet with \'\--genconfig\'. \--server : The server to use for file storage. This setting is only used if - **server_list** is not set. + **server\_list** is not set. \--todate @@ -128,7 +148,9 @@ options can also be generated by running puppet with \'\--genconfig\'. : Print version information. -## EXAMPLES +EXAMPLES +======== + ### Backup a file to the filebucket, then restore it to a temporary directory $ puppet filebucket backup /etc/passwd /etc/passwd: 429b225650b912a2ee067b0a4cf1e949 @@ -176,9 +198,13 @@ options can also be generated by running puppet with \'\--genconfig\'. d43a6ecaa892a1962398ac9170ea9bf2 2015-05-11 09:27:56 /tmp/TestFile 7ae322f5791217e031dc60188f4521ef 2015-05-11 09:52:15 /tmp/TestFile -## AUTHOR +AUTHOR +====== + Luke Kanies -## COPYRIGHT +COPYRIGHT +========= + Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License diff --git a/references/man/generate.md b/references/man/generate.md index 69d0b2f04a7..25bf397321b 100644 --- a/references/man/generate.md +++ b/references/man/generate.md @@ -1,26 +1,32 @@ --- layout: default -built_from_commit: 70303b65ae864066c583e1436011ff135847f6ad +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Man Page: puppet generate' canonical: "/puppet/latest/man/generate.html" --- # Man Page: puppet generate -> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 17:41:46 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:47 +0000 + +NAME +==== -## NAME **puppet-generate** - Generates Puppet code from Ruby definitions. -## SYNOPSIS +SYNOPSIS +======== + puppet generate *action* -## OPTIONS +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, **server** and **run_mode** are valid +present action. For example, **server** and **run\_mode** are valid settings, so you can specify **\--server \**, or -**\--run_mode \** as an argument. +**\--run\_mode \** as an argument. See the configuration file documentation at *https://puppet.com/docs/puppet/latest/configuration.html* for the full @@ -41,7 +47,9 @@ options can also be generated by running puppet with **\--genconfig**. : Whether to log debug information. -## ACTIONS +ACTIONS +======= + **types** - Generates Puppet code for custom types : **SYNOPSIS** @@ -61,22 +69,38 @@ options can also be generated by running puppet with **\--genconfig**. *\--format \ - The generation output format to use. Supported formats: pcore. -## EXAMPLES +EXAMPLES +======== + **types** Generate Puppet type definitions for all custom resource types in the current environment: +- +```{=html} + +``` $ puppet generate types +- + Generate Puppet type definitions for all custom resource types in the specified environment: +- +```{=html} + +``` $ puppet generate types --environment development -## COPYRIGHT AND LICENSE +- + +COPYRIGHT AND LICENSE +===================== + Copyright 2016 by Puppet Inc. Apache 2 license; see COPYING diff --git a/references/man/help.md b/references/man/help.md index c07f555d907..a98959fd778 100644 --- a/references/man/help.md +++ b/references/man/help.md @@ -1,26 +1,32 @@ --- layout: default -built_from_commit: 70303b65ae864066c583e1436011ff135847f6ad +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Man Page: puppet help' canonical: "/puppet/latest/man/help.html" --- # Man Page: puppet help -> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 17:41:46 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:47 +0000 + +NAME +==== -## NAME **puppet-help** - Display Puppet help. -## SYNOPSIS +SYNOPSIS +======== + puppet help *action* -## OPTIONS +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, **server** and **run_mode** are valid +present action. For example, **server** and **run\_mode** are valid settings, so you can specify **\--server \**, or -**\--run_mode \** as an argument. +**\--run\_mode \** as an argument. See the configuration file documentation at *https://puppet.com/docs/puppet/latest/configuration.html* for the full @@ -41,7 +47,9 @@ options can also be generated by running puppet with **\--genconfig**. : Whether to log debug information. -## ACTIONS +ACTIONS +======= + **help** - Display help about Puppet subcommands and their actions. : **SYNOPSIS** @@ -63,12 +71,16 @@ options can also be generated by running puppet with **\--genconfig**. Short help text for the specified subcommand or action. -## EXAMPLES +EXAMPLES +======== + **help** Get help for an action: \$ puppet help -## COPYRIGHT AND LICENSE +COPYRIGHT AND LICENSE +===================== + Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING diff --git a/references/man/lookup.md b/references/man/lookup.md index 885224f51ad..07b33c6a182 100644 --- a/references/man/lookup.md +++ b/references/man/lookup.md @@ -1,18 +1,22 @@ --- layout: default -built_from_commit: 70303b65ae864066c583e1436011ff135847f6ad +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Man Page: puppet lookup' canonical: "/puppet/latest/man/lookup.html" --- # Man Page: puppet lookup -> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 17:41:46 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:47 +0000 + +NAME +==== -## NAME **puppet-lookup** - Interactive Hiera lookup -## SYNOPSIS +SYNOPSIS +======== + Does Hiera lookups from the command line. Since this command needs access to your Hiera data, make sure to run it @@ -23,7 +27,9 @@ The most common version of this command is: \'puppet lookup *KEY* \--node *NAME* \--environment *ENV* \--explain\' -## USAGE +USAGE +===== + puppet lookup \[\--help\] \[\--type *TYPESTRING*\] \[\--merge first\|unique\|hash\|deep\] \[\--knock-out-prefix *PREFIX-STRING*\] \[\--sort-merged-arrays\] \[\--merge-hash-arrays\] \[\--explain\] @@ -31,7 +37,9 @@ first\|unique\|hash\|deep\] \[\--knock-out-prefix *PREFIX-STRING*\] \[\--facts *FILE*\] \[\--compile\] \[\--render-as s\|json\|yaml\|binary\|msgpack\] *keys* -## DESCRIPTION +DESCRIPTION +=========== + The lookup command is a CLI for Puppet\'s \'lookup()\' function. It searches your Hiera data and returns a value for the requested lookup key, so you can test and explore your data. It is a modern replacement @@ -58,9 +66,11 @@ You can provide multiple lookup keys to this command, but it only returns a value for the first found key, omitting the rest. For more details about how Hiera works, see the Hiera documentation: -https://puppet.com/docs/puppet/latest/hiera_intro.html +https://puppet.com/docs/puppet/latest/hiera\_intro.html + +OPTIONS +======= -## OPTIONS - \--help: Print this help message. - \--explain Explain the details of how the lookup was performed and @@ -86,7 +96,7 @@ https://puppet.com/docs/puppet/latest/hiera_intro.html factors. - \--merge first\|unique\|hash\|deep: Specify the merge behavior, - overriding any merge behavior from the data\'s lookup_options. + overriding any merge behavior from the data\'s lookup\_options. \'first\' returns the first value found. \'unique\' appends everything to a merged, deduplicated array. \'hash\' performs a simple hash merge by overwriting keys of lower lookup priority. @@ -104,9 +114,9 @@ https://puppet.com/docs/puppet/latest/hiera_intro.html When this flag is used, hashes WITHIN arrays are deep-merged with their counterparts by position. -- \--explain-options Explain whether a lookup_options hash affects - this lookup, and how that hash was assembled. (lookup_options is how - Hiera configures merge behavior in data.) +- \--explain-options Explain whether a lookup\_options hash affects + this lookup, and how that hash was assembled. (lookup\_options is + how Hiera configures merge behavior in data.) - \--default *VALUE* A value to return if Hiera can\'t find a value in data. For emulating calls to the \'lookup()\' function that include @@ -118,7 +128,7 @@ https://puppet.com/docs/puppet/latest/hiera_intro.html - \--compile Perform a full catalog compilation prior to the lookup. If your hierarchy and data only use the \$facts, \$trusted, and - \$server_facts variables, you don\'t need this option; however, if + \$server\_facts variables, you don\'t need this option; however, if your Hiera configuration uses arbitrary variables set by a Puppet manifest, you might need this option to get accurate data. No catalog compilation takes place unless this flag is given. @@ -128,34 +138,41 @@ https://puppet.com/docs/puppet/latest/hiera_intro.html producing a value is yaml and the default when producing an explanation is s. -## EXAMPLE -To look up \'key_name\' using the Puppet Server node\'s facts: \$ puppet -lookup key_name +- + +EXAMPLE +======= -To look up \'key_name\' using the Puppet Server node\'s arbitrary +To look up \'key\_name\' using the Puppet Server node\'s facts: \$ +puppet lookup key\_name + +To look up \'key\_name\' using the Puppet Server node\'s arbitrary variables from a manifest, and classify the node if applicable: \$ -puppet lookup key_name \--compile +puppet lookup key\_name \--compile -To look up \'key_name\' using the Puppet Server node\'s facts, -overridden by facts given in a file: \$ puppet lookup key_name \--facts -fact_file.yaml +To look up \'key\_name\' using the Puppet Server node\'s facts, +overridden by facts given in a file: \$ puppet lookup key\_name \--facts +fact\_file.yaml -To look up \'key_name\' with agent.local\'s facts: \$ puppet lookup -\--node agent.local key_name +To look up \'key\_name\' with agent.local\'s facts: \$ puppet lookup +\--node agent.local key\_name -To get the first value found for \'key_name_one\' and \'key_name_two\' -with agent.local\'s facts while merging values and knocking out the -prefix \'foo\' while merging: \$ puppet lookup \--node agent.local -\--merge deep \--knock-out-prefix foo key_name_one key_name_two +To get the first value found for \'key\_name\_one\' and +\'key\_name\_two\' with agent.local\'s facts while merging values and +knocking out the prefix \'foo\' while merging: \$ puppet lookup \--node +agent.local \--merge deep \--knock-out-prefix foo key\_name\_one +key\_name\_two -To lookup \'key_name\' with agent.local\'s facts, and return a default +To lookup \'key\_name\' with agent.local\'s facts, and return a default value of \'bar\' if nothing was found: \$ puppet lookup \--node -agent.local \--default bar key_name +agent.local \--default bar key\_name -To see an explanation of how the value for \'key_name\' would be found, +To see an explanation of how the value for \'key\_name\' would be found, using agent.local\'s facts: \$ puppet lookup \--node agent.local -\--explain key_name +\--explain key\_name + +COPYRIGHT +========= -## COPYRIGHT Copyright (c) 2015 Puppet Inc., LLC Licensed under the Apache 2.0 License diff --git a/references/man/module.md b/references/man/module.md index 1ecd0bfbaa5..d90650a83e5 100644 --- a/references/man/module.md +++ b/references/man/module.md @@ -1,33 +1,41 @@ --- layout: default -built_from_commit: 70303b65ae864066c583e1436011ff135847f6ad +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Man Page: puppet module' canonical: "/puppet/latest/man/module.html" --- # Man Page: puppet module -> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 17:41:46 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:47 +0000 + +NAME +==== -## NAME **puppet-module** - Creates, installs and searches for modules on the Puppet Forge. -## SYNOPSIS +SYNOPSIS +======== + puppet module *action* \[\--environment production \] \[\--modulepath \] -## DESCRIPTION +DESCRIPTION +=========== + This subcommand can find, install, and manage modules from the Puppet Forge, a repository of user-contributed Puppet code. It can also generate empty modules, and prepare locally developed modules for release on the Forge. -## OPTIONS +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, **server** and **run_mode** are valid +present action. For example, **server** and **run\_mode** are valid settings, so you can specify **\--server \**, or -**\--run_mode \** as an argument. +**\--run\_mode \** as an argument. See the configuration file documentation at *https://puppet.com/docs/puppet/latest/configuration.html* for the full @@ -71,7 +79,7 @@ options can also be generated by running puppet with **\--genconfig**. Given that the context and effects vary depending on the config section - *https://puppet.com/docs/puppet/latest/config_file_main.html##config-sections* in which the **environment** setting is defined, do not set it + *https://puppet.com/docs/puppet/latest/config\_file\_main.html\##config-sections* in which the **environment** setting is defined, do not set it globally. \--modulepath @@ -86,9 +94,11 @@ options can also be generated by running puppet with **\--genconfig**. than the default modulepath of **\:\$basemodulepath**, you can set **modulepath** in environment.conf. For more info, see - *https://puppet.com/docs/puppet/latest/environments_about.html* + *https://puppet.com/docs/puppet/latest/environments\_about.html* + +ACTIONS +======= -## ACTIONS **changes** - Show modified files of an installed module. : **SYNOPSIS** @@ -224,7 +234,9 @@ options can also be generated by running puppet with **\--genconfig**. Hash -## EXAMPLES +EXAMPLES +======== + **changes** Show modified files of an installed module: @@ -294,7 +306,7 @@ Install a module from a release archive and ignore dependencies: List installed modules: \$ puppet module list /etc/puppetlabs/code/modules ├── -bodepd-create_resources (v0.0.1) ├── puppetlabs-bacula (v0.0.2) ├── +bodepd-create\_resources (v0.0.1) ├── puppetlabs-bacula (v0.0.2) ├── puppetlabs-mysql (v0.0.1) ├── puppetlabs-sqlite (v0.0.1) └── puppetlabs-stdlib (v2.2.1) /opt/puppetlabs/puppet/modules (no modules installed) @@ -303,14 +315,14 @@ List installed modules in a tree view: \$ puppet module list \--tree /etc/puppetlabs/code/modules └─┬ puppetlabs-bacula (v0.0.2) ├── puppetlabs-stdlib (v2.2.1) ├─┬ -puppetlabs-mysql (v0.0.1) │ └── bodepd-create_resources (v0.0.1) └── +puppetlabs-mysql (v0.0.1) │ └── bodepd-create\_resources (v0.0.1) └── puppetlabs-sqlite (v0.0.1) /opt/puppetlabs/puppet/modules (no modules installed) List installed modules from a specified environment: \$ puppet module list \--environment production -/etc/puppetlabs/code/modules ├── bodepd-create_resources (v0.0.1) ├── +/etc/puppetlabs/code/modules ├── bodepd-create\_resources (v0.0.1) ├── puppetlabs-bacula (v0.0.2) ├── puppetlabs-mysql (v0.0.1) ├── puppetlabs-sqlite (v0.0.1) └── puppetlabs-stdlib (v2.2.1) /opt/puppetlabs/puppet/modules (no modules installed) @@ -362,5 +374,7 @@ upgrade an installed module for a specific environment /etc/puppetlabs/code/environments/test/modules └── puppetlabs-apache (v1.0.0 -\> v2.4.0) -## COPYRIGHT AND LICENSE +COPYRIGHT AND LICENSE +===================== + Copyright 2012 by Puppet Inc. Apache 2 license; see COPYING diff --git a/references/man/node.md b/references/man/node.md index 3491c28bbcc..2cba06b32ec 100644 --- a/references/man/node.md +++ b/references/man/node.md @@ -1,32 +1,40 @@ --- layout: default -built_from_commit: 70303b65ae864066c583e1436011ff135847f6ad +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Man Page: puppet node' canonical: "/puppet/latest/man/node.html" --- # Man Page: puppet node -> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 17:41:46 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:47 +0000 + +NAME +==== -## NAME **puppet-node** - View and manage node definitions. -## SYNOPSIS +SYNOPSIS +======== + puppet node *action* \[\--terminus \_TERMINUS\] -## DESCRIPTION +DESCRIPTION +=========== + This subcommand interacts with node objects, which are used by Puppet to build a catalog. A node object consists of the node\'s facts, environment, node parameters (exposed in the parser as top-scope variables), and classes. -## OPTIONS +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, **server** and **run_mode** are valid +present action. For example, **server** and **run\_mode** are valid settings, so you can specify **\--server \**, or -**\--run_mode \** as an argument. +**\--run\_mode \** as an argument. See the configuration file documentation at *https://puppet.com/docs/puppet/latest/configuration.html* for the full @@ -65,7 +73,9 @@ options can also be generated by running puppet with **\--genconfig**. occasionally needs to be set explicitly. See the \"Notes\" section of this face\'s manpage for more details. -## ACTIONS +ACTIONS +======= + **clean** - Clean up signed certs, cached facts, node objects, and reports for a node stored by the puppetmaster : **SYNOPSIS** @@ -119,9 +129,11 @@ options can also be generated by running puppet with **\--genconfig**. 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 \'\--run_mode\' option. + doubt, specify the run mode with the \'\--run\_mode\' option. + +EXAMPLES +======== -## EXAMPLES **find** Retrieve an \"empty\" (no classes, no ENC-imposed parameters, and an @@ -132,15 +144,17 @@ environment of \"production\") node: Retrieve a node using the Puppet Server\'s configured ENC: -\$ puppet node find somenode.puppetlabs.lan \--terminus exec \--run_mode -server \--render-as yaml +\$ puppet node find somenode.puppetlabs.lan \--terminus exec +\--run\_mode server \--render-as yaml Retrieve the same node from the Puppet Server: \$ puppet node find somenode.puppetlabs.lan \--terminus rest \--render-as yaml -## NOTES +NOTES +===== + This subcommand is an indirector face, which exposes **find**, **search**, **save**, and **destroy** actions for an indirected subsystem of Puppet. Valid termini for this face include: @@ -157,9 +171,13 @@ subsystem of Puppet. Valid termini for this face include: - **rest** -- **store_configs** +- **store\_configs** - **yaml** -## COPYRIGHT AND LICENSE +- + +COPYRIGHT AND LICENSE +===================== + Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING diff --git a/references/man/overview.md b/references/man/overview.md index 2c30a35fad9..2970597cae1 100644 --- a/references/man/overview.md +++ b/references/man/overview.md @@ -1,13 +1,13 @@ --- layout: default -built_from_commit: 70303b65ae864066c583e1436011ff135847f6ad +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: Puppet Man Pages canonical: "/puppet/latest/man/overview.html" --- # Puppet Man Pages -> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 17:41:46 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:47 +0000 diff --git a/references/man/parser.md b/references/man/parser.md index cb2b9082a70..113ac64843f 100644 --- a/references/man/parser.md +++ b/references/man/parser.md @@ -1,26 +1,32 @@ --- layout: default -built_from_commit: 70303b65ae864066c583e1436011ff135847f6ad +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Man Page: puppet parser' canonical: "/puppet/latest/man/parser.html" --- # Man Page: puppet parser -> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 17:41:46 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:47 +0000 + +NAME +==== -## NAME **puppet-parser** - Interact directly with the parser. -## SYNOPSIS +SYNOPSIS +======== + puppet parser *action* -## OPTIONS +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, **server** and **run_mode** are valid +present action. For example, **server** and **run\_mode** are valid settings, so you can specify **\--server \**, or -**\--run_mode \** as an argument. +**\--run\_mode \** as an argument. See the configuration file documentation at *https://puppet.com/docs/puppet/latest/configuration.html* for the full @@ -41,7 +47,9 @@ options can also be generated by running puppet with **\--genconfig**. : Whether to log debug information. -## ACTIONS +ACTIONS +======= + - **dump** - Outputs a dump of the internal parse tree for debugging: **SYNOPSIS** @@ -64,6 +72,8 @@ options can also be generated by running puppet with **\--genconfig**. - \'json\' outputs the same graph as \'pn\' but with JSON syntax. +- + 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. @@ -104,14 +114,19 @@ options can also be generated by running puppet with **\--genconfig**. validate the default site manifest. When validating multiple issues per file are reported up to the - settings of max_error, and max_warnings. The processing stops after - having reported issues for the first encountered file with errors. + settings of max\_error, and max\_warnings. The processing stops + after having reported issues for the first encountered file with + errors. **RETURNS** Nothing, or the first syntax error encountered. -## EXAMPLES +- + +EXAMPLES +======== + **validate** Validate the default site manifest at @@ -127,5 +142,7 @@ Validate from STDIN: \$ cat init.pp \| puppet parser validate -## COPYRIGHT AND LICENSE +COPYRIGHT AND LICENSE +===================== + Copyright 2014 by Puppet Inc. Apache 2 license; see COPYING diff --git a/references/man/plugin.md b/references/man/plugin.md index 5e48eade1dc..95505e6299b 100644 --- a/references/man/plugin.md +++ b/references/man/plugin.md @@ -1,21 +1,27 @@ --- layout: default -built_from_commit: 70303b65ae864066c583e1436011ff135847f6ad +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Man Page: puppet plugin' canonical: "/puppet/latest/man/plugin.html" --- # Man Page: puppet plugin -> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 17:41:46 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:47 +0000 + +NAME +==== -## NAME **puppet-plugin** - Interact with the Puppet plugin system. -## SYNOPSIS +SYNOPSIS +======== + puppet plugin *action* -## DESCRIPTION +DESCRIPTION +=========== + This subcommand provides network access to the puppet master\'s store of plugins. @@ -24,12 +30,14 @@ directories of its modules. These plugins can be used on agent nodes to extend Facter and implement custom types and providers. Plugins are normally downloaded by puppet agent during the course of a run. -## OPTIONS +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, **server** and **run_mode** are valid +present action. For example, **server** and **run\_mode** are valid settings, so you can specify **\--server \**, or -**\--run_mode \** as an argument. +**\--run\_mode \** as an argument. See the configuration file documentation at *https://puppet.com/docs/puppet/latest/configuration.html* for the full @@ -50,7 +58,9 @@ options can also be generated by running puppet with **\--genconfig**. : Whether to log debug information. -## ACTIONS +ACTIONS +======= + **download** - Download plugins from the puppet master. : **SYNOPSIS** @@ -70,7 +80,9 @@ options can also be generated by running puppet with **\--genconfig**. array of the files downloaded, which will be empty if none were retrieved. -## EXAMPLES +EXAMPLES +======== + **download** Retrieve plugins from the puppet master: @@ -81,5 +93,7 @@ Retrieve plugins from the puppet master (API example): \$ Puppet::Face\[:plugin, \'0.0.1\'\].download -## COPYRIGHT AND LICENSE +COPYRIGHT AND LICENSE +===================== + Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING diff --git a/references/man/report.md b/references/man/report.md index c601281447c..3c4260fa18c 100644 --- a/references/man/report.md +++ b/references/man/report.md @@ -1,26 +1,32 @@ --- layout: default -built_from_commit: 70303b65ae864066c583e1436011ff135847f6ad +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Man Page: puppet report' canonical: "/puppet/latest/man/report.html" --- # Man Page: puppet report -> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 17:41:46 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:47 +0000 + +NAME +==== -## NAME **puppet-report** - Create, display, and submit reports. -## SYNOPSIS +SYNOPSIS +======== + puppet report *action* \[\--terminus \_TERMINUS\] -## OPTIONS +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, **server** and **run_mode** are valid +present action. For example, **server** and **run\_mode** are valid settings, so you can specify **\--server \**, or -**\--run_mode \** as an argument. +**\--run\_mode \** as an argument. See the configuration file documentation at *https://puppet.com/docs/puppet/latest/configuration.html* for the full @@ -59,7 +65,9 @@ options can also be generated by running puppet with **\--genconfig**. occasionally needs to be set explicitly. See the \"Notes\" section of this face\'s manpage for more details. -## ACTIONS +ACTIONS +======= + **info** - Print the default terminus class for this face. : **SYNOPSIS** @@ -70,7 +78,7 @@ options can also be generated by running puppet with **\--genconfig**. 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 \'\--run_mode\' option. + doubt, specify the run mode with the \'\--run\_mode\' option. **save** - API only: submit a report. @@ -101,20 +109,24 @@ options can also be generated by running puppet with **\--genconfig**. **rest** terminus, and provides additional details in the event of a failure. -## EXAMPLES +EXAMPLES +======== + **save** From the implementation of **puppet report submit** (API example): -begin Puppet::Transaction::Report.indirection.terminus_class = :rest +begin Puppet::Transaction::Report.indirection.terminus\_class = :rest Puppet::Face\[:report, \"0.0.1\"\].save(report) Puppet.notice \"Uploaded -report for ##{report.name}\" rescue =\> detailPuppet.log_exception(detail, \"Could not send report: ##{detail}\") end +report for \##{report.name}\" rescue =\> detailPuppet.log\_exception(detail, \"Could not send report: \##{detail}\") end **submit** API example:report = Puppet::Face\[:catalog, \'0.0.1\'\].apply Puppet::Face\[:report, \'0.0.1\'\].submit(report) return report -## NOTES +NOTES +===== + This subcommand is an indirector face, which exposes **find**, **search**, **save**, and **destroy** actions for an indirected subsystem of Puppet. Valid termini for this face include: @@ -129,5 +141,9 @@ subsystem of Puppet. Valid termini for this face include: - **yaml** -## COPYRIGHT AND LICENSE +- + +COPYRIGHT AND LICENSE +===================== + Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING diff --git a/references/man/resource.md b/references/man/resource.md index 63c6e1672b7..26d5bcbabfa 100644 --- a/references/man/resource.md +++ b/references/man/resource.md @@ -1,26 +1,34 @@ --- layout: default -built_from_commit: 70303b65ae864066c583e1436011ff135847f6ad +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Man Page: puppet resource' canonical: "/puppet/latest/man/resource.html" --- # Man Page: puppet resource -> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 17:41:46 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:47 +0000 + +NAME +==== -## NAME **puppet-resource** - The resource abstraction layer shell -## SYNOPSIS +SYNOPSIS +======== + Uses the Puppet RAL to directly interact with the system. -## USAGE +USAGE +===== + puppet resource \[-h\|\--help\] \[-d\|\--debug\] \[-v\|\--verbose\] \[-e\|\--edit\] \[-p\|\--param *parameter*\] \[-t\|\--types\] -\[-y\|\--to_yaml\] *type* \[*name*\] \[*attribute*=*value* \...\] +\[-y\|\--to\_yaml\] *type* \[*name*\] \[*attribute*=*value* \...\] + +DESCRIPTION +=========== -## DESCRIPTION This command provides simple facilities for converting current system state into Puppet code, along with some ability to modify the current state using Puppet\'s RAL. @@ -36,7 +44,9 @@ Alternately, if given a type, a name, and the \'\--edit\' flag, puppet resource will write its output to a file, open that file in an editor, and then apply the saved file as a Puppet transaction. -## OPTIONS +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 *directory*\' as an argument. @@ -71,21 +81,27 @@ options can also be generated by running puppet with \'\--genconfig\'. : Print extra information. -\--to_yaml +\--to\_yaml : Output found resources in yaml format, suitable to use with Hiera - and create_resources. + and create\_resources. \--fail : Fails and returns an exit code of 1 if the resource could not be modified. -## EXAMPLE +EXAMPLE +======= + This example uses **puppet resource** to return a Puppet configuration for the user **luke**: +- +```{=html} + +``` $ puppet resource user luke user { 'luke': @@ -98,9 +114,15 @@ for the user **luke**: groups => ['sysadmin','audio','video','puppet'] } -## AUTHOR +- + +AUTHOR +====== + Luke Kanies -## COPYRIGHT +COPYRIGHT +========= + Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License diff --git a/references/man/script.md b/references/man/script.md index 9adc8f03864..9ebaf3d5a01 100644 --- a/references/man/script.md +++ b/references/man/script.md @@ -1,34 +1,44 @@ --- layout: default -built_from_commit: 70303b65ae864066c583e1436011ff135847f6ad +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Man Page: puppet script' canonical: "/puppet/latest/man/script.html" --- # Man Page: puppet script -> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 17:41:46 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:47 +0000 + +NAME +==== -## NAME **puppet-script** - Run a puppet manifests as a script without compiling a catalog -## SYNOPSIS +SYNOPSIS +======== + Runs a puppet language script without compiling a catalog. -## USAGE +USAGE +===== + puppet script \[-h\|\--help\] \[-V\|\--version\] \[-d\|\--debug\] \[-v\|\--verbose\] \[-e\|\--execute\] \[-l\|\--logdest syslog\|eventlog\|*FILE*\|console\] \[\--noop\] *file* -## DESCRIPTION +DESCRIPTION +=========== + This is a standalone puppet script runner tool; use it to run puppet code without compiling a catalog. When provided with a modulepath, via command line or config file, puppet script can load functions, types, tasks and plans from modules. -## OPTIONS +OPTIONS +======= + Note that any setting that\'s valid in the configuration file is also a valid long argument. For example, \'environment\' is a valid setting, so you can specify \'\--environment mytest\' as an argument. @@ -76,14 +86,20 @@ options can also be generated by running puppet with \'\--genconfig\'. : Print extra information. -## EXAMPLE +EXAMPLE +======= + $ puppet script -l /tmp/manifest.log manifest.pp $ puppet script --modulepath=/root/dev/modules -e 'notice("hello world")' -## AUTHOR +AUTHOR +====== + Henrik Lindberg -## COPYRIGHT +COPYRIGHT +========= + Copyright (c) 2017 Puppet Inc., LLC Licensed under the Apache 2.0 License diff --git a/references/man/ssl.md b/references/man/ssl.md index f6a6a5fbf16..3d74981c908 100644 --- a/references/man/ssl.md +++ b/references/man/ssl.md @@ -1,26 +1,34 @@ --- layout: default -built_from_commit: 70303b65ae864066c583e1436011ff135847f6ad +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Man Page: puppet ssl' canonical: "/puppet/latest/man/ssl.html" --- # Man Page: puppet ssl -> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 17:41:46 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:47 +0000 + +NAME +==== -## NAME **puppet-ssl** - Manage SSL keys and certificates for puppet SSL clients -## SYNOPSIS +SYNOPSIS +======== + Manage SSL keys and certificates for SSL clients needing to communicate with a puppet infrastructure. -## USAGE +USAGE +===== + puppet ssl *action* \[-h\|\--help\] \[-v\|\--verbose\] \[-d\|\--debug\] \[\--localca\] \[\--target CERTNAME\] -## OPTIONS +OPTIONS +======= + - \--help: Print this help message. - \--verbose: Print extra information. @@ -32,7 +40,11 @@ puppet ssl *action* \[-h\|\--help\] \[-v\|\--verbose\] \[-d\|\--debug\] - \--target CERTNAME Clean the specified device certificate instead of this host\'s certificate. -## ACTIONS +- + +ACTIONS +======= + bootstrap : Perform all of the steps necessary to request and download a client @@ -42,7 +54,7 @@ bootstrap **waitforcert** is a Puppet setting, it can be specified as a time interval, such as 30s, 5m, 1h. -submit_request +submit\_request : Generate a certificate signing request (CSR) and submit it to the CA. If a private and public key pair already exist, they will be @@ -50,13 +62,13 @@ submit_request generated. If a CSR has already been submitted with the given **certname**, then the operation will fail. -generate_request +generate\_request : Generate a certificate signing request (CSR). If a private and public key pair exist, they will be used to generate the CSR. Otherwise a new key pair will be generated. -download_cert +download\_cert : Download a certificate for this host. If the current private key matches the downloaded certificate, then the certificate will be diff --git a/references/metaparameter.md b/references/metaparameter.md index a806fc9bd27..e2019bba4b6 100644 --- a/references/metaparameter.md +++ b/references/metaparameter.md @@ -1,6 +1,6 @@ --- layout: default -built_from_commit: c0f933882f92b7998fe94e2a57bbdf69f77ac61e +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: Metaparameter Reference toc: columns canonical: "/puppet/latest/metaparameter.html" @@ -8,7 +8,7 @@ canonical: "/puppet/latest/metaparameter.html" # Metaparameter Reference -> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 09:52:11 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:47 +0000 diff --git a/references/report.md b/references/report.md index dba027d1f75..f6627f2ab31 100644 --- a/references/report.md +++ b/references/report.md @@ -1,6 +1,6 @@ --- layout: default -built_from_commit: 41ffe0f49158b8f34714b7e18429afa0ce8ded09 +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: Report Reference toc: columns canonical: "/puppet/latest/report.html" @@ -8,7 +8,7 @@ canonical: "/puppet/latest/report.html" # Report Reference -> **NOTE:** This page was generated from the Puppet source code on 2024-08-29 09:52:52 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:45 +0000 diff --git a/references/type.md b/references/type.md index 245e31d5c8d..2e8de4ebca3 100644 --- a/references/type.md +++ b/references/type.md @@ -1,6 +1,6 @@ --- layout: default -built_from_commit: d0ec909330b5a98b868eae9a4aae37bbfca96e7a +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: Resource Type Reference (Single-Page) canonical: "/puppet/latest/type.html" toc_levels: 2 @@ -9,7 +9,7 @@ toc: columns # Resource Type Reference (Single-Page) -> **NOTE:** This page was generated from the Puppet source code on 2024-09-30 11:26:40 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:37:51 +0000 @@ -4029,7 +4029,9 @@ Values can match `/^[0-9]+$/`. #### recurse {#tidy-attribute-recurse} If target is a directory, recursively descend -into the directory looking for files to tidy. +into the directory looking for files to tidy. Numeric values +specify a limit for the recursion depth, `true` means +unrestricted recursion. Valid values are `true`, `false`, `inf`. Values can match `/^[0-9]+$/`. diff --git a/references/types/exec.md b/references/types/exec.md index 5f4dca26dc9..4d870824ed1 100644 --- a/references/types/exec.md +++ b/references/types/exec.md @@ -1,13 +1,13 @@ --- layout: default -built_from_commit: 942adce0b1b70f696b0f09d7109ded7559f0fa33 +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Resource Type: exec' canonical: "/puppet/latest/types/exec.html" --- # Resource Type: exec -> **NOTE:** This page was generated from the Puppet source code on 2024-08-28 16:45:59 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:37:51 +0000 diff --git a/references/types/file.md b/references/types/file.md index 2c85ce02de3..10bc2eb64bb 100644 --- a/references/types/file.md +++ b/references/types/file.md @@ -1,13 +1,13 @@ --- layout: default -built_from_commit: 942adce0b1b70f696b0f09d7109ded7559f0fa33 +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Resource Type: file' canonical: "/puppet/latest/types/file.html" --- # Resource Type: file -> **NOTE:** This page was generated from the Puppet source code on 2024-08-28 16:45:59 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:37:51 +0000 diff --git a/references/types/filebucket.md b/references/types/filebucket.md index 448d0d72bf2..626e0bbb7ed 100644 --- a/references/types/filebucket.md +++ b/references/types/filebucket.md @@ -1,13 +1,13 @@ --- layout: default -built_from_commit: 942adce0b1b70f696b0f09d7109ded7559f0fa33 +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Resource Type: filebucket' canonical: "/puppet/latest/types/filebucket.html" --- # Resource Type: filebucket -> **NOTE:** This page was generated from the Puppet source code on 2024-08-28 16:45:59 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:37:51 +0000 diff --git a/references/types/group.md b/references/types/group.md index f3488e2bad3..d0346b52ea5 100644 --- a/references/types/group.md +++ b/references/types/group.md @@ -1,13 +1,13 @@ --- layout: default -built_from_commit: 942adce0b1b70f696b0f09d7109ded7559f0fa33 +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Resource Type: group' canonical: "/puppet/latest/types/group.html" --- # Resource Type: group -> **NOTE:** This page was generated from the Puppet source code on 2024-08-28 16:45:59 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:37:51 +0000 diff --git a/references/types/notify.md b/references/types/notify.md index 2d6cca43aa7..acd21071215 100644 --- a/references/types/notify.md +++ b/references/types/notify.md @@ -1,13 +1,13 @@ --- layout: default -built_from_commit: 942adce0b1b70f696b0f09d7109ded7559f0fa33 +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Resource Type: notify' canonical: "/puppet/latest/types/notify.html" --- # Resource Type: notify -> **NOTE:** This page was generated from the Puppet source code on 2024-08-28 16:45:59 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:37:51 +0000 diff --git a/references/types/overview.md b/references/types/overview.md index 3fe80a70f86..a931b8f9546 100644 --- a/references/types/overview.md +++ b/references/types/overview.md @@ -1,13 +1,13 @@ --- layout: default -built_from_commit: 942adce0b1b70f696b0f09d7109ded7559f0fa33 +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: Resource types overview canonical: "/puppet/latest/types/overview.md" --- # Resource types overview -> **NOTE:** This page was generated from the Puppet source code on 2024-08-28 16:45:59 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:37:51 +0000 ## List of resource types diff --git a/references/types/package.md b/references/types/package.md index d57ca63eef4..4c5b8acf1c0 100644 --- a/references/types/package.md +++ b/references/types/package.md @@ -1,13 +1,13 @@ --- layout: default -built_from_commit: 942adce0b1b70f696b0f09d7109ded7559f0fa33 +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Resource Type: package' canonical: "/puppet/latest/types/package.html" --- # Resource Type: package -> **NOTE:** This page was generated from the Puppet source code on 2024-08-28 16:45:59 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:37:51 +0000 diff --git a/references/types/resources.md b/references/types/resources.md index 8029a212111..5748c4aa210 100644 --- a/references/types/resources.md +++ b/references/types/resources.md @@ -1,13 +1,13 @@ --- layout: default -built_from_commit: 942adce0b1b70f696b0f09d7109ded7559f0fa33 +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Resource Type: resources' canonical: "/puppet/latest/types/resources.html" --- # Resource Type: resources -> **NOTE:** This page was generated from the Puppet source code on 2024-08-28 16:45:59 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:37:51 +0000 diff --git a/references/types/schedule.md b/references/types/schedule.md index f96cef4cefb..0bee6b9cc53 100644 --- a/references/types/schedule.md +++ b/references/types/schedule.md @@ -1,13 +1,13 @@ --- layout: default -built_from_commit: 942adce0b1b70f696b0f09d7109ded7559f0fa33 +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Resource Type: schedule' canonical: "/puppet/latest/types/schedule.html" --- # Resource Type: schedule -> **NOTE:** This page was generated from the Puppet source code on 2024-08-28 16:45:59 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:37:51 +0000 diff --git a/references/types/service.md b/references/types/service.md index 4172fec9089..ac959e1b469 100644 --- a/references/types/service.md +++ b/references/types/service.md @@ -1,13 +1,13 @@ --- layout: default -built_from_commit: d0ec909330b5a98b868eae9a4aae37bbfca96e7a +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Resource Type: service' canonical: "/puppet/latest/types/service.html" --- # Resource Type: service -> **NOTE:** This page was generated from the Puppet source code on 2024-09-30 11:26:40 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:37:51 +0000 diff --git a/references/types/stage.md b/references/types/stage.md index cb9e45b7b2c..ef93d97abc4 100644 --- a/references/types/stage.md +++ b/references/types/stage.md @@ -1,13 +1,13 @@ --- layout: default -built_from_commit: 942adce0b1b70f696b0f09d7109ded7559f0fa33 +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Resource Type: stage' canonical: "/puppet/latest/types/stage.html" --- # Resource Type: stage -> **NOTE:** This page was generated from the Puppet source code on 2024-08-28 16:45:59 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:37:51 +0000 diff --git a/references/types/tidy.md b/references/types/tidy.md index a24e3969f70..bec1655d28d 100644 --- a/references/types/tidy.md +++ b/references/types/tidy.md @@ -1,13 +1,13 @@ --- layout: default -built_from_commit: 942adce0b1b70f696b0f09d7109ded7559f0fa33 +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Resource Type: tidy' canonical: "/puppet/latest/types/tidy.html" --- # Resource Type: tidy -> **NOTE:** This page was generated from the Puppet source code on 2024-08-28 16:45:59 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:37:51 +0000 @@ -132,7 +132,9 @@ Allowed values: #### recurse {#tidy-attribute-recurse} If target is a directory, recursively descend -into the directory looking for files to tidy. +into the directory looking for files to tidy. Numeric values +specify a limit for the recursion depth, `true` means +unrestricted recursion. Allowed values: diff --git a/references/types/user.md b/references/types/user.md index 13fe39840ed..7dc7c8e050b 100644 --- a/references/types/user.md +++ b/references/types/user.md @@ -1,13 +1,13 @@ --- layout: default -built_from_commit: 942adce0b1b70f696b0f09d7109ded7559f0fa33 +built_from_commit: 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2 title: 'Resource Type: user' canonical: "/puppet/latest/types/user.html" --- # Resource Type: user -> **NOTE:** This page was generated from the Puppet source code on 2024-08-28 16:45:59 -0700 +> **NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:37:51 +0000