1PUPPET-STATUS(8) Puppet manual PUPPET-STATUS(8)
2
6 puppet-status - View puppet server status.
7
9 puppet status action [--terminus _TERMINUS] [--extra HASH]
10
12 Note that any setting that´s valid in the configuration file is also a
13 valid long argument, although it may or may not be relevant to the
14 present action. For example, server and run_mode are valid settings, so
15 you can specify --server <servername>, or --run_mode <runmode> as an
16 argument.
17 See the configuration file documentation at https://pup‐
19 pet.com/docs/puppet/latest/configuration.html for the full list of
20 acceptable parameters. A commented list of all configuration options
21 can also be generated by running puppet with --genconfig.
22 --render-as FORMAT
24 The format in which to render output. The most common formats
25 are json, s (string), yaml, and console, but other options such
26 as dot are sometimes available.
27 --verbose
29 Whether to log verbosely.
30 --debug
32 Whether to log debug information.
33 --extra HASH
35 A terminus can take additional arguments to refine the opera‐
36 tion, which are passed as an arbitrary hash to the back-end.
37 Anything passed as the extra value is just send direct to the
38 back-end.
39 --terminus _TERMINUS
41 Indirector faces expose indirected subsystems of Puppet. These
42 subsystems are each able to retrieve and alter a specific type
43 of data (with the familiar actions of find, search, save, and
44 destroy) from an arbitrary number of pluggable backends. In Pup‐
45 pet parlance, these backends are called terminuses.
46 Almost all indirected subsystems have a rest terminus that
48 interacts with the puppet master´s data. Most of them have addi‐
49 tional terminuses for various local data models, which are in
50 turn used by the indirected subsystem on the puppet master when‐
51 ever it receives a remote request.
52 The terminus for an action is often determined by context, but
54 occasionally needs to be set explicitly. See the "Notes" section
55 of this face´s manpage for more details.
56
58 find - Check status of puppet master server.
59 SYNOPSIS
60 puppet status [--terminus _TERMINUS] [--extra HASH] [key]
62 DESCRIPTION
64 Checks whether a Puppet server is properly receiving and pro‐
66 cessing HTTP requests. This action is only useful when used with
67 ´--terminus rest´; when invoked with the local terminus, find
68 will always return true.
69 Over REST, this action will query the configured puppet master
71 by default. To query other servers, including puppet agent nodes
72 started with the --listen option, you can set the global
73 --server and --masterport options on the command line; note that
74 agent nodes listen on port 8139.
75 RETURNS
77 A "true" response or a low-level connection error. When used
79 from the Ruby API: returns a Puppet::Status object.
80 NOTES
82 This action requires that the server´s auth.conf file allow find
84 access to the status REST terminus. Puppet agent does not use
85 this facility, and it is turned off by default. See https://pup‐
86 pet.com/docs/puppet/latest/config_file_auth.html for more
87 details.
88 info - Print the default terminus class for this face.
90 SYNOPSIS
91 puppet status info [--terminus _TERMINUS] [--extra HASH]
93 DESCRIPTION
95 Prints the default terminus class for this subcommand. Note that
97 different run modes may have different default termini; when in
98 doubt, specify the run mode with the ´--run_mode´ option.
99
101 find
102 Check the status of the configured puppet master:
104 $ puppet status find --terminus rest
106
108 This subcommand is an indirector face, which exposes find, search,
109 save, and destroy actions for an indirected subsystem of Puppet. Valid
110 termini for this face include:
111 · local
113 · rest
115
119 Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING
120Puppet, Inc. January 2019 PUPPET-STATUS(8)