4
.\" Man page generated from reStructeredText.
7
Retrieve the client configuration from the puppet master and apply it to
10
Currently must be run out periodically, using cron or something similar.
16
.B puppet agent [\-D|\-\-daemonize|\-\-no\-daemonize] [\-d|\-\-debug]
18
[\-\-detailed\-exitcodes] [\-\-disable] [\-\-enable]
19
[\-h|\-\-help] [\-\-fqdn <host name>] [\-l|\-\-logdest syslog|<file>|console]
20
[\-o|\-\-onetime] [\-\-serve <handler>] [\-t|\-\-test] [\-\-noop]
21
[\-\-digest <digest>] [\-\-fingerprint] [\-V|\-\-version]
22
[\-v|\-\-verbose] [\-w|\-\-waitforcert <seconds>]
28
This is the main puppet client. Its job is to retrieve the local
29
machine\(aqs configuration from a remote server and apply it. In order to
30
successfully communicate with the remote server, the client must have a
31
certificate signed by a certificate authority that the server trusts;
32
the recommended method for this, at the moment, is to run a certificate
33
authority as part of the puppet server (which is the default). The
34
client will connect and request a signed certificate, and will continue
35
connecting until it receives one.
37
Once the client has a signed certificate, it will retrieve its
38
configuration and apply it.
41
+puppet agent+ does its best to find a compromise between interactive
42
use and daemon use. Run with no arguments and no configuration, it will
43
go into the backgroun, attempt to get a signed certificate, and retrieve
44
and apply its configuration every 30 minutes.
46
Some flags are meant specifically for interactive use \-\- in particular,
47
+test+, +tags+ or +fingerprint+ are useful. +test+ enables verbose
48
logging, causes the daemon to stay in the foreground, exits if the
49
server\(aqs configuration is invalid (this happens if, for instance, you\(aqve
50
left a syntax error on the server), and exits after running the
51
configuration once (rather than hanging around as a long\-running
54
+tags+ allows you to specify what portions of a configuration you want
55
to apply. Puppet elements are tagged with all of the class or definition
56
names that contain them, and you can use the +tags+ flag to specify one
57
of these names, causing only configuration elements contained within
58
that class or definition to be applied. This is very useful when you are
59
testing new configurations \-\- for instance, if you are just starting to
60
manage +ntpd+, you would put all of the new elements into an +ntpd+
61
class, and call puppet with +\-\-tags ntpd+, which would only apply that
62
small portion of the configuration during your testing, rather than
63
applying the whole thing.
65
+fingerprint+ is a one\-time flag. In this mode +puppet agent+ will run
66
once and display on the console (and in the log) the current certificate
67
(or certificate request) fingerprint. Providing the +\-\-digest+ option
68
allows to use a different digest algorithm to generate the fingerprint.
69
The main use is to verify that before signing a certificate request on
70
the master, the certificate request the master received is the same as
71
the one the client sent (to prevent against man\-in\-the\-middle attacks
72
when signing certificates).
75
Note that any configuration parameter that\(aqs valid in the configuration
76
file is also a valid long argument. For example, \(aqserver\(aq is a valid
77
configuration parameter, so you can specify \(aq\-\-server <servername>\(aq as
80
See the configuration file documentation at
81
\fI\%http://docs.puppetlabs.com/references/stable/configuration.html\fP for the
82
full list of acceptable parameters. A commented list of all
83
configuration options can also be generated by running puppet agent with
84
\(aq\-\-genconfig\(aq.
87
.B daemonize: Send the process into the background. This is the
92
no\-daemonize: Do not send the process into the background.
94
debug: Enable full debugging.
97
.B digest: Change the certificate fingerprinting digest
99
algorithm. The default is MD5. Valid values depends
100
on the version of OpenSSL installed, but should
101
always at least contain MD5, MD2, SHA1 and SHA256.
103
.B detailed\-exitcodes: Provide transaction information via exit codes. If
105
this is enabled, an exit code of \(aq2\(aq means there
106
were changes, and an exit code of \(aq4\(aq means that
107
there were failures during the transaction. This
108
option only makes sense in conjunction with
111
.B disable: Disable working on the local system. This puts a
113
lock file in place, causing +puppet agent+ not to
114
work on the system until the lock file is removed.
115
This is useful if you are testing a configuration
116
and do not want the central configuration to
117
override the local state until everything is tested
121
+puppet agent+ uses the same lock file while it is running, so no more
122
than one +puppet agent+ process is working at a time.
124
+puppet agent+ exits after executing this.
127
.B enable: Enable working on the local system. This removes any
129
lock file, causing +puppet agent+ to start managing
130
the local system again (although it will continue to
131
use its normal scheduling, so it might not start for
135
+puppet agent+ exits after executing this.
138
.B fqdn: Set the fully\-qualified domain name of the client.
140
This is only used for certificate purposes, but can
141
be used to override the discovered hostname. If you
142
need to use this flag, it is generally an indication
146
help: Print this help message
149
.B logdest: Where to send messages. Choose between syslog, the
151
console, and a log file. Defaults to sending
152
messages to syslog, or the console if debugging or
153
verbosity is enabled.
155
.B no\-client: Do not create a config client. This will cause the
157
daemon to run without ever checking for its
158
configuration automatically, and only makes sense
159
when used in conjunction with \-\-listen.
161
.B onetime: Run the configuration once. Runs a single (normally
163
daemonized) Puppet run. Useful for interactively
164
running puppet agent when used in conjunction with
165
the \-\-no\-daemonize option.
167
.B fingerprint: Display the current certificate or certificate
169
signing request fingerprint and then exit. Use the
170
+\-\-digest+ option to change the digest algorithm
173
.B serve: Start another type of server. By default, +puppet
175
agent+ will start a service handler that allows
176
authenticated and authorized remote nodes to trigger
177
the configuration to be pulled down and applied. You
178
can specify any handler here that does not require
179
configuration, e.g., filebucket, ca, or resource.
180
The handlers are in +lib/puppet/network/handler+,
181
and the names must match exactly, both in the call
182
to +serve+ and in +namespaceauth.conf+.
184
.B test: Enable the most common options used for testing.
186
These are +onetime+, +verbose+, +ignorecache,
187
+no\-daemonize+, and +no\-usecacheonfailure+.
189
.B noop: Use +noop+ mode where the daemon runs in a no\-op or
191
dry\-run mode. This is useful for seeing what changes
192
Puppet will make without actually executing the
196
verbose: Turn on verbose reporting.
198
version: Print the puppet version number and exit.
201
.B waitforcert: This option only matters for daemons that do not yet
203
have certificates and it is enabled by default, with
204
a value of 120 (seconds). This causes +puppet agent+
205
to connect to the server every 2 minutes and ask it
206
to sign a certificate request. This is useful for
207
the initial setup of a puppet client. You can turn
208
off waiting for certificates by specifying a time of
215
puppet agent \-\-server puppet.domain.com
223
Copyright (c) 2005, 2006 Reductive Labs, LLC Licensed under the GNU
225
.\" Generated by docutils manpage writer.
added
removed
.pc/debian-changes-2.6.1~rc3-1/man/man8/puppetd.8
