DragonFly On-Line Manual Pages

PUPPET-INSTRUMENTATION_DATA(8)   Puppet manual  PUPPET-INSTRUMENTATION_DATA(8)

NAME
       puppet-instrumentation_data - Manage instrumentation listener
       accumulated data.

SYNOPSIS
       puppet instrumentation_data action [--terminus TERMINUS] [--extra HASH]

DESCRIPTION
       This subcommand allows to retrieve the various listener data.

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 and run_mode are
       valid configuration parameters, so you can specify --server
       <servername>, or --run_mode <runmode> 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.

       --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 parlance, 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 subcommand.
              SYNOPSIS

              puppet instrumentation_data destroy [--terminus TERMINUS]
              [--extra HASH] key

              DESCRIPTION

              Invalid for this subcommand.

       find - Retrieve listener data.
              SYNOPSIS

              puppet instrumentation_data find [--terminus TERMINUS] [--extra
              HASH] key

              DESCRIPTION

              Retrieve listener data.

              RETURNS

              The data of an instrumentation listener

       info - Print the default terminus class for this face.
              SYNOPSIS

              puppet instrumentation_data 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 '--run_mode' option.

       save - Invalid for this subcommand.
              SYNOPSIS

              puppet instrumentation_data save [--terminus TERMINUS] [--extra
              HASH] key

              DESCRIPTION

              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.

       search - Invalid for this subcommand.
              SYNOPSIS

              puppet instrumentation_data search [--terminus TERMINUS]
              [--extra HASH] query

              DESCRIPTION

              Invalid for this subcommand.

EXAMPLES
       find

       Retrieve listener data:

       $ puppet instrumentation_data find performance --terminus rest

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   local

       o   rest

COPYRIGHT AND LICENSE
       Copyright 2011 by Puppet Labs Apache 2 license; see COPYING

Puppet Labs, LLC                 January 2013   PUPPET-INSTRUMENTATION_DATA(8)