1PUPPETRUN(8) PUPPETRUN(8)
2Trigger a puppet agent run on a set of hosts.puppet kick [-a|--all]
6[-c|--class class] [-d|--debug] [-f|--foreground]
7 [-h|--help] [--host <host>] [--no-fqdn] [--ignoreschedules]
11 [-t|--tag <tag>] [--test] [-p|--ping] <host> [<host> [...]]
12 This script can be used to connect to a set of machines running +puppet
15 agent+ and trigger them to run their configurations. The most common
16 usage would be to specify a class of hosts and a set of tags, and +pup‐
17 pet kick+ would look up in LDAP all of the hosts matching that class,
18 then connect to each host and trigger a run of all of the objects with
19 the specified tags.
20 If you are not storing your host configurations in LDAP, you can spec‐
22 ify hosts manually.
23 You will most likely have to run +puppet kick+ as root to get access to
25 the SSL certificates.
26 +puppet kick+ reads +puppet master+´s configuration file, so that it
28 can copy things like LDAP settings.+puppet kick+ is useless unless
29 +puppet agent+ is listening. See its documentation for more informa‐
30 tion, but the gist is that you must enable +listen+ on the +puppet
31 agent+ daemon, either using +--listen+ on the command line or adding
32 ´listen: true´ in its config file. In addition, you need to set the
33 daemons up to specifically allow connections by creating the +names‐
34 paceauth+ file, normally at ´/etc/puppet/namespaceauth.conf´. This file
35 specifies who has access to each namespace; if you create the file you
36 must add every namespace you want any Puppet daemon to allow -- it is
37 currently global to all Puppet daemons.
38 An example file looks like this::
40 [fileserver]
44 allow *.madstop.com
45 [puppetmaster]
47 allow *.madstop.com
48 [puppetrunner]
50 allow culain.madstop.com
51 This is what you would install on your Puppet master; non-master hosts
55 could leave off the ´fileserver´ and ´puppetmaster´ namespaces.Note
56 that any configuration parameter that´s valid in the configuration file
57 is also a valid long argument. For example, ´ssldir´ is a valid config‐
58 uration parameter, so you can specify ´--ssldir directory´ as an argu‐
59 ment.
60 See the configuration file documentation at http://reductive‐
62 labs.com/projects/puppet/reference/configref.html for the full list of
63 acceptable parameters. A commented list of all configuration options
64 can also be generated by running puppet master with ´--genconfig´.
65 all: Connect to all available hosts. Requires LDAP support
67 at this point.
71 class: Specify a class of machines to which to connect. This
75 only works if you have LDAP configured, at the moment.
79 debug: Enable full debugging.
83 foreground: Run each configuration in the foreground; that is, when
85 connecting to a host, do not return until the host has
89 finished its run. The default is false.
90 help: Print this help message
94 host: A specific host to which to connect. This flag can be
96 specified more than once.
100 ignoreschedules: Whether the client should ignore schedules when run‐
104 ning
105 its configuration. This can be used to force the client
109 to perform work it would not normally perform so soon.
110 The default is false.
111 parallel: How parallel to make the connections. Parallelization
115 is provided by forking for each client to which to
119 connect. The default is 1, meaning serial execution.
120 tag: Specify a tag for selecting the objects to apply. Does
124 not work with the --test option.
128 test: Print the hosts you would connect to but do not
132 actually connect. This option requires LDAP support at
136 this point.
137 ping::
141 Do a ICMP echo against the target host. Skip hosts that don´t respond
143 to ping.sudo puppet kick -p 10 -t remotefile -t webserver host1
144 host2Luke KaniesCopyright (c) 2005 Puppet Labs, LLC Licensed under the
145 GNU Public License
146 August 2010 PUPPETRUN(8)