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] [--extra HASH]
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
20       acceptable  parameters.  A  commented list of all configuration options
21       can 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       --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
40       --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
47              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
53              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

ACTIONS

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

EXAMPLES

98       save
99
100       From the implementation of puppet report submit (API example):
101
102       begin  Puppet::Transaction::Report.indirection.terminus_class  =  :rest
103       Puppet::Face[:report,  "0.0.1"].save(report)  Puppet.notice   "Uploaded
104       report   for   #{report.name}"   rescue   =>  detail  Puppet.log_excep‐
105       tion(detail, "Could not send report: #{detail}") end
106
107       submit
108
109       API  example:report  =   Puppet::Face[:catalog,   ´0.0.1´].apply   Pup‐
110       pet::Face[:report, ´0.0.1´].submit(report) return report
111

NOTES

113       This  subcommand  is  an  indirector  face, which exposes find, search,
114       save, and destroy actions for an indirected subsystem of Puppet.  Valid
115       termini for this face include:
116
117       ·   msgpack
118
119       ·   processor
120
121       ·   rest
122
123       ·   yaml
124
125
126

128       Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING
129
130
131
132Puppet, Inc.                     January 2019                 PUPPET-REPORT(8)
Impressum