1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "PUPPET\-REPORT" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
.
.SH "NAME"
\fBpuppet\-report\fR \- Create, display, and submit reports\.
.
.SH "SYNOPSIS"
puppet report \fIaction\fR [\-\-terminus TERMINUS]
.
.SH "OPTIONS"
Note that any configuration parameter that\'s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR is a valid configuration parameter, so you can specify \fB\-\-server <servername>\fR as an argument\.
.
.P
See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
.
.TP
\-\-mode MODE
The run mode to use for the current action\. Valid modes are \fBuser\fR, \fBagent\fR, and \fBmaster\fR\.
.
.TP
\-\-render\-as FORMAT
The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\.
.
.TP
\-\-verbose
Whether to log verbosely\.
.
.TP
\-\-debug
Whether to log debug information\.
.
.TP
\-\-terminus TERMINUS
Indirector faces expose indirected subsystems of Puppet\. These subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR) from an arbitrary number of pluggable backends\. In Puppet parlance, these backends are called terminuses\.
.
.IP
Almost all indirected subsystems have a \fBrest\fR terminus that interacts with the puppet master\'s data\. Most of them have additional terminuses for various local data models, which are in turn used by the indirected subsystem on the puppet master whenever it receives a remote request\.
.
.IP
The terminus for an action is often determined by context, but occasionally needs to be set explicitly\. See the "Notes" section of this face\'s manpage for more details\.
.
.SH "ACTIONS"
.
.TP
\fBdestroy\fR \- Invalid for this face\.
\fBSYNOPSIS\fR
.
.IP
puppet report destroy [\-\-terminus TERMINUS] \fIkey\fR
.
.IP
\fBDESCRIPTION\fR
.
.IP
Invalid for this face\.
.
.TP
\fBfind\fR \- Invalid for this face\.
\fBSYNOPSIS\fR
.
.IP
puppet report find [\-\-terminus TERMINUS] \fIkey\fR
.
.IP
\fBDESCRIPTION\fR
.
.IP
Invalid for this face\.
.
.TP
\fBinfo\fR \- Print the default terminus class for this face\.
\fBSYNOPSIS\fR
.
.IP
puppet report info [\-\-terminus TERMINUS]
.
.IP
\fBDESCRIPTION\fR
.
.IP
Prints the default terminus class for this subcommand\. Note that different run modes may have different default termini; when in doubt, specify the run mode with the \'\-\-mode\' option\.
.
.TP
\fBsave\fR \- API only: submit a report\.
\fBSYNOPSIS\fR
.
.IP
puppet report save [\-\-terminus TERMINUS] \fIreport\fR
.
.IP
\fBDESCRIPTION\fR
.
.IP
API only: create or overwrite an object\. As the Faces framework does not currently accept data from STDIN, save actions cannot currently be invoked from the command line\.
.
.IP
\fBRETURNS\fR
.
.IP
Nothing\.
.
.TP
\fBsearch\fR \- Invalid for this face\.
\fBSYNOPSIS\fR
.
.IP
puppet report search [\-\-terminus TERMINUS] \fIquery\fR
.
.IP
\fBDESCRIPTION\fR
.
.IP
Invalid for this face\.
.
.TP
\fBsubmit\fR \- API only: submit a report with error handling\.
\fBSYNOPSIS\fR
.
.IP
puppet report submit [\-\-terminus TERMINUS] \fIreport\fR
.
.IP
\fBDESCRIPTION\fR
.
.IP
API only: Submits a report to the puppet master\. This action is essentially a shortcut and wrapper for the \fBsave\fR action with the \fBrest\fR terminus, and provides additional details in the event of a failure\.
.
.SH "EXAMPLES"
\fBsave\fR
.
.P
From the implementation of \fBpuppet report submit\fR (API example):
.
.IP "" 4
.
.nf
begin
Puppet::Transaction::Report\.indirection\.terminus_class = :rest
Puppet::Face[:report, "0\.0\.1"]\.save(report)
Puppet\.notice "Uploaded report for #{report\.name}"
rescue => detail
puts detail\.backtrace if Puppet[:trace]
Puppet\.err "Could not send report: #{detail}"
end
.
.fi
.
.IP "" 0
.
.P
\fBsubmit\fR
.
.P
From secret_agent\.rb (API example):
.
.IP "" 4
.
.nf
# \.\.\.
report = Puppet::Face[:catalog, \'0\.0\.1\']\.apply
Puppet::Face[:report, \'0\.0\.1\']\.submit(report)
return report
.
.fi
.
.IP "" 0
.
.SH "NOTES"
This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR actions for an indirected subsystem of Puppet\. Valid termini for this face include:
.
.IP "\(bu" 4
\fBprocessor\fR
.
.IP "\(bu" 4
\fBrest\fR
.
.IP "\(bu" 4
\fByaml\fR
.
.IP "" 0
.
.SH "COPYRIGHT AND LICENSE"
Copyright 2011 by Puppet Labs Apache 2 license; see COPYING
|
