.\" 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"
.
.SH "NAME"
\fBpuppet\-plugin\fR \- Interact with the Puppet plugin system\.
.
.SH "SYNOPSIS"
puppet plugin \fIaction\fR
.
.SH "DESCRIPTION"
This subcommand provides network access to the puppet master\'s store of plugins\.
.
.P
The puppet master serves Ruby code collected from the \fBlib\fR 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\.
.
.SH "OPTIONS"
Note that any setting that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
.
.P
See the configuration file documentation at \fIhttps://puppet\.com/docs/puppet/latest/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
.
.TP
\-\-render\-as FORMAT
The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\.
.
.TP
\-\-verbose
Whether to log verbosely\.
.
.TP
\-\-debug
Whether to log debug information\.
.
.SH "ACTIONS"
.
.TP
\fBdownload\fR \- Download plugins from the puppet master\.
\fBSYNOPSIS\fR
.
.IP
puppet plugin download
.
.IP
\fBDESCRIPTION\fR
.
.IP
Downloads plugins from the configured puppet master\. Any plugins downloaded in this way will be used in all subsequent Puppet activity\. This action modifies files on disk\.
.
.IP
\fBRETURNS\fR
.
.IP
A list of the files downloaded, or a confirmation that no files were downloaded\. When used from the Ruby API, this action returns an array of the files downloaded, which will be empty if none were retrieved\.
.
.SH "EXAMPLES"
\fBdownload\fR
.
.P
Retrieve plugins from the puppet master:
.
.P
$ puppet plugin download
.
.P
Retrieve plugins from the puppet master (API example):
.
.P
$ Puppet::Face[:plugin, \'0\.0\.1\']\.download
.
.SH "COPYRIGHT AND LICENSE"
Copyright 2011 by Puppet Inc\. Apache 2 license; see COPYING