PUPPET-REPORT(8) Puppet manual PUPPET-REPORT(8)
NAME
puppet-report - Create, display, and submit reports.
SYNOPSIS
puppet report action [--terminus TERMINUS] [--extra HASH]
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, server is a valid configuration parameter, so you can specify --server <servername> as an
argument.
See the configuration file documentation at http://docs.puppetlabs.com/references/stable/configuration.html for the full list of acceptable
parameters. A commented list of all configuration options can also be generated by running puppet with --genconfig.
--mode MODE
The run mode to use for the current action. Valid modes are user, agent, and master.
--render-as FORMAT
The format in which to render output. The most common formats are json, s (string), yaml, and console, but other options such as dot
are sometimes available.
--verbose
Whether to log verbosely.
--debug
Whether to log debug information.
--extra HASH
A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back-end. Anything
passed as the extra value is just send direct to the back-end.
--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 find, search, save, and destroy) from an arbitrary number of pluggable backends. In Puppet par-
lance, these backends are called terminuses.
Almost all indirected subsystems have a rest 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.
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.
ACTIONS
destroy - Invalid for this face.
SYNOPSIS
puppet report destroy [--terminus TERMINUS] [--extra HASH] key
DESCRIPTION
Invalid for this face.
find - Invalid for this face.
SYNOPSIS
puppet report find [--terminus TERMINUS] [--extra HASH] key
DESCRIPTION
Invalid for this face.
info - Print the default terminus class for this face.
SYNOPSIS
puppet report info [--terminus TERMINUS] [--extra HASH]
DESCRIPTION
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.
save - API only: submit a report.
SYNOPSIS
puppet report save [--terminus TERMINUS] [--extra HASH] report
DESCRIPTION
API only: create or overwrite an object. As the Faces framework does not currently accept data from STDIN, save actions cannot cur-
rently be invoked from the command line.
RETURNS
Nothing.
search - Invalid for this face.
SYNOPSIS
puppet report search [--terminus TERMINUS] [--extra HASH] query
DESCRIPTION
Invalid for this face.
submit - API only: submit a report with error handling.
SYNOPSIS
puppet report submit [--terminus TERMINUS] [--extra HASH] report
DESCRIPTION
API only: Submits a report to the puppet master. This action is essentially a shortcut and wrapper for the save action with the rest
terminus, and provides additional details in the event of a failure.
EXAMPLES
save
From the implementation of puppet report submit (API example):
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
submit
From secret_agent.rb (API example):
# ...
report = Puppet::Face[:catalog, '0.0.1'].apply
Puppet::Face[:report, '0.0.1'].submit(report)
return report
NOTES
This subcommand is an indirector face, which exposes find, search, save, and destroy actions for an indirected subsystem of Puppet. Valid
termini for this face include:
o processor
o rest
o yaml
COPYRIGHT AND LICENSE
Copyright 2011 by Puppet Labs Apache 2 license; see COPYING
Puppet Labs, LLC June 2012 PUPPET-REPORT(8)