11---
22layout : default
3- built_from_commit : 70303b65ae864066c583e1436011ff135847f6ad
3+ built_from_commit : 6893bdd69ab1291e6e6fcd6b152dda2b48e3cdb2
44title : ' Man Page: puppet agent'
55canonical : " /puppet/latest/man/agent.html"
66---
77
88# Man Page: puppet agent
99
10- > ** NOTE:** This page was generated from the Puppet source code on 2024-08-29 17:41:46 -0700
10+ > ** NOTE:** This page was generated from the Puppet source code on 2024-10-17 02:36:47 +0000
11+
12+ NAME
13+ ====
1114
12- ## NAME
1315** puppet-agent** - The puppet agent daemon
1416
15- ## SYNOPSIS
17+ SYNOPSIS
18+ ========
19+
1620Retrieves the client configuration from the Puppet master and applies it
1721to the local host.
1822
1923This service may be run as a daemon, run periodically using cron (or
2024something similar), or run interactively for testing purposes.
2125
22- ## USAGE
26+ USAGE
27+ =====
28+
2329puppet agent \[\- -certname * NAME* \]
2430\[ -D\|\- -daemonize\|\- -no-daemonize\] \[ -d\|\- -debug\]
2531\[\- -detailed-exitcodes\] \[\- -digest * DIGEST* \] \[\- -disable
2632\[ MESSAGE\]\] \[\- -enable\] \[\- -fingerprint\] \[ -h\|\- -help\]
2733\[ -l\|\- -logdest syslog\| eventlog\| * ABS FILEPATH* \| console\]
2834\[\- -serverport * PORT* \] \[\- -noop\] \[ -o\|\- -onetime\]
29- \[\- -sourceaddress * IP_ADDRESS * \] \[ -t\|\- -test\] \[ -v\|\- -verbose\]
35+ \[\- -sourceaddress * IP \_ ADDRESS * \] \[ -t\|\- -test\] \[ -v\|\- -verbose\]
3036\[ -V\|\- -version\] \[ -w\|\- -waitforcert * SECONDS* \]
3137
32- ## DESCRIPTION
38+ DESCRIPTION
39+ ===========
40+
3341This is the main puppet client. Its job is to retrieve the local
3442machine\' s configuration from a remote server and apply it. In order to
3543successfully communicate with the remote server, the client must have a
@@ -42,7 +50,9 @@ connecting until it receives one.
4250Once the client has a signed certificate, it will retrieve its
4351configuration and apply it.
4452
45- ## USAGE NOTES
53+ USAGE NOTES
54+ ===========
55+
4656\' puppet agent\' does its best to find a compromise between interactive
4757use and daemon use. If you run it with no arguments and no
4858configuration, it goes into the background, attempts to get a signed
@@ -69,6 +79,8 @@ one of the following exit codes:
6979
7080- 6: The run succeeded, and included both changes and failures.
7181
82+ -
83+
7284\'\- -tags\' allows you to specify what portions of a configuration you
7385want to apply. Puppet elements are tagged with all of the class or
7486definition 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
89101received is the same as the one the client sent (to prevent against
90102man-in-the-middle attacks when signing certificates).
91103
92- \'\- -skip_tags \' is a flag used to filter resources. If this is set,
104+ \'\- -skip \_ tags \' is a flag used to filter resources. If this is set,
93105then only resources not tagged with the specified tags will be applied.
94106Values must be comma-separated.
95107
96- ## OPTIONS
108+ OPTIONS
109+ =======
110+
97111Note that any Puppet setting that\' s valid in the configuration file is
98112also a valid long argument. For example, \' server\' is a valid setting,
99113so you can specify \'\- -server * servername* \' as an argument. Boolean
@@ -226,7 +240,7 @@ be generated by running puppet agent with \'\--genconfig\'.
226240- \- -test: Enable the most common options used for testing. These are
227241 \' onetime\' , \' verbose\' , \' no-daemonize\' ,
228242 \' no-usecacheonfailure\' , \' detailed-exitcodes\' , \' no-splay\' , and
229- \' show_diff \' .
243+ \' show \_ diff \' .
230244
231245- \- -trace Prints stack traces on some errors. (This is a Puppet
232246 setting, and can go in puppet.conf. Note the special \' no-\' prefix
@@ -244,16 +258,22 @@ be generated by running puppet agent with \'\--genconfig\'.
244258 waiting for certificates by specifying a time of 0. (This is a
245259 Puppet setting, and can go in puppet.conf.)
246260
247- - \- -write_catalog_summary After compiling the catalog saves the
261+ - \- -write \_ catalog \_ summary After compiling the catalog saves the
248262 resource list and classes list to the node in the state directory
249263 named classes.txt and resources.txt (This is a Puppet setting, and
250264 can go in puppet.conf.)
251265
252- ## EXAMPLE
266+ -
267+
268+ EXAMPLE
269+ =======
270+
253271
254272 $ puppet agent --server puppet.domain.com
255273
256- ## DIAGNOSTICS
274+ DIAGNOSTICS
275+ ===========
276+
257277Puppet agent accepts the following signals:
258278
259279SIGHUP
@@ -274,9 +294,13 @@ SIGUSR2
274294: Close file descriptors for log files and reopen them. Used with
275295 logrotate.
276296
277- ## AUTHOR
297+ AUTHOR
298+ ======
299+
278300Luke Kanies
279301
280- ## COPYRIGHT
302+ COPYRIGHT
303+ =========
304+
281305Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0
282306License
0 commit comments