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

NAME

6       puppet-report - Create, display, and submit reports.
7

SYNOPSIS

9       puppet report action [--terminus _TERMINUS]
10

OPTIONS

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
18       See    the    configuration    file   documentation   at   https://pup‐
19       pet.com/docs/puppet/latest/configuration.html for the full list of  ac‐
20       ceptable  parameters. A commented list of all configuration options can
21       also be generated by running puppet with --genconfig.
22
23       --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
28       --verbose
29              Whether to log verbosely.
30
31       --debug
32              Whether to log debug information.
33
34       --terminus _TERMINUS
35              Indirector faces expose indirected subsystems of  Puppet.  These
36              subsystems  are  each able to retrieve and alter a specific type
37              of data (with the familiar actions of find,  search,  save,  and
38              destroy) from an arbitrary number of pluggable backends. In Pup‐
39              pet parlance, these backends are called terminuses.
40
41              Almost all indirected subsystems have a rest terminus  that  in‐
42              teracts  with  the puppet master´s data. Most of them have addi‐
43              tional terminuses for various local data models,  which  are  in
44              turn used by the indirected subsystem on the puppet master when‐
45              ever it receives a remote request.
46
47              The terminus for an action is often determined by  context,  but
48              occasionally needs to be set explicitly. See the "Notes" section
49              of this face´s manpage for more details.
50

ACTIONS

52       info - Print the default terminus class for this face.
53              SYNOPSIS
54
55              puppet report info [--terminus _TERMINUS]
56
57              DESCRIPTION
58
59              Prints the default terminus class for this subcommand. Note that
60              different  run modes may have different default termini; when in
61              doubt, specify the run mode with the ´--run_mode´ option.
62
63       save - API only: submit a report.
64              SYNOPSIS
65
66              puppet report save [--terminus _TERMINUS] report
67
68              DESCRIPTION
69
70              API only: create or overwrite an object. As the Faces  framework
71              does  not  currently accept data from STDIN, save actions cannot
72              currently be invoked from the command line.
73
74              RETURNS
75
76              Nothing.
77
78       submit - API only: submit a report with error handling.
79              SYNOPSIS
80
81              puppet report submit [--terminus _TERMINUS] report
82
83              DESCRIPTION
84
85              API only: Submits a report to the puppet master. This action  is
86              essentially  a shortcut and wrapper for the save action with the
87              rest terminus, and provides additional details in the event of a
88              failure.
89

EXAMPLES

91       save
92
93       From the implementation of puppet report submit (API example):
94
95       begin  Puppet::Transaction::Report.indirection.terminus_class  =  :rest
96       Puppet::Face[:report, "0.0.1"].save(report) Puppet.notice "Uploaded re‐
97       port  for #{report.name}" rescue => detail Puppet.log_exception(detail,
98       "Could not send report: #{detail}") end
99
100       submit
101
102       API  example:report  =   Puppet::Face[:catalog,   ´0.0.1´].apply   Pup‐
103       pet::Face[:report, ´0.0.1´].submit(report) return report
104

NOTES

106       This  subcommand  is  an  indirector  face, which exposes find, search,
107       save, and destroy actions for an indirected subsystem of Puppet.  Valid
108       termini for this face include:
109
110       •   json
111
112       •   msgpack
113
114       •   processor
115
116       •   rest
117
118       •   yaml
119
120
121

123       Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING
124
125
126
127Puppet, Inc.                     October 2023                 PUPPET-REPORT(8)
Impressum