1PUPPET-PLUGIN(8)                 Puppet manual                PUPPET-PLUGIN(8)
2
3
4

NAME

6       puppet-plugin - Interact with the Puppet plugin system.
7

SYNOPSIS

9       puppet plugin action
10

DESCRIPTION

12       This subcommand provides network access to the puppet master´s store of
13       plugins.
14
15       The puppet master serves Ruby code collected from the  lib  directories
16       of its modules. These plugins can be used on agent nodes to extend Fac‐
17       ter and implement custom types  and  providers.  Plugins  are  normally
18       downloaded by puppet agent during the course of a run.
19

OPTIONS

21       Note  that any setting that´s valid in the configuration file is also a
22       valid long argument, although it may or may  not  be  relevant  to  the
23       present action. For example, server and run_mode are valid settings, so
24       you can specify --server <servername>, or --run_mode  <runmode>  as  an
25       argument.
26
27       See    the    configuration    file   documentation   at   https://pup‐
28       pet.com/docs/puppet/latest/configuration.html  for  the  full  list  of
29       acceptable  parameters.  A  commented list of all configuration options
30       can also be generated by running puppet with --genconfig.
31
32       --render-as FORMAT
33              The format in which to render output. The  most  common  formats
34              are  json, s (string), yaml, and console, but other options such
35              as dot are sometimes available.
36
37       --verbose
38              Whether to log verbosely.
39
40       --debug
41              Whether to log debug information.
42

ACTIONS

44       download - Download plugins from the puppet master.
45              SYNOPSIS
46
47              puppet plugin download
48
49              DESCRIPTION
50
51              Downloads plugins from the configured puppet master. Any plugins
52              downloaded  in  this  way  will be used in all subsequent Puppet
53              activity. This action modifies files on disk.
54
55              RETURNS
56
57              A list of the files downloaded, or a confirmation that no  files
58              were  downloaded.  When  used  from  the  Ruby  API, this action
59              returns an array of the files downloaded, which will be empty if
60              none were retrieved.
61

EXAMPLES

63       download
64
65       Retrieve plugins from the puppet master:
66
67       $ puppet plugin download
68
69       Retrieve plugins from the puppet master (API example):
70
71       $ Puppet::Face[:plugin, ´0.0.1´].download
72

74       Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING
75
76
77
78Puppet, Inc.                     January 2020                 PUPPET-PLUGIN(8)
Impressum