PUPPET-FACTS(8) Puppet manual PUPPET-FACTS(8)
NAME
puppet-facts - Retrieve and store facts.
SYNOPSIS
puppet facts action [--terminus TERMINUS] [--extra HASH]
DESCRIPTION
This subcommand manages facts, which are collections of normalized system information used by Puppet. It can read facts directly from the
local system (with the default facter terminus), look up facts reported by other systems, and submit facts to the puppet master.
When used with the rest terminus, this subcommand is essentially a front-end to the inventory service REST API. See the inventory service
documentation at http://docs.puppetlabs.com/guides/inventory_service.html for more detail.
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 subcommand.
SYNOPSIS
puppet facts destroy [--terminus TERMINUS] [--extra HASH] key
DESCRIPTION
Invalid for this subcommand.
find - Retrieve a node's facts.
SYNOPSIS
puppet facts find [--terminus TERMINUS] [--extra HASH] node_certname
DESCRIPTION
Retrieve a node's facts.
RETURNS
A hash containing some metadata and (under the "values" key) the set of facts for the requested node. When used from the Ruby API: A
Puppet::Node::Facts object.
RENDERING ISSUES: Facts cannot currently be rendered as a string; use yaml or json.
NOTES
When using the facter terminus, the host argument is ignored.
info - Print the default terminus class for this face.
SYNOPSIS
puppet facts 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: create or overwrite an object.
SYNOPSIS
puppet facts 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 cur-
rently be invoked from the command line.
search - Invalid for this subcommand.
SYNOPSIS
puppet facts search [--terminus TERMINUS] [--extra HASH] query
DESCRIPTION
Invalid for this subcommand.
upload - Upload local facts to the puppet master.
SYNOPSIS
puppet facts upload [--terminus TERMINUS] [--extra HASH]
DESCRIPTION
Reads facts from the local system using the facter terminus, then saves the returned facts using the rest terminus.
RETURNS
Nothing.
NOTES
This action requires that the puppet master's auth.conf file allow save access to the facts REST terminus. Puppet agent does not use
this facility, and it is turned off by default. See http://docs.puppetlabs.com/guides/rest_auth_conf.html for more details.
EXAMPLES
find
Get facts from the local system:
$ puppet facts find x
Ask the puppet master for facts for an arbitrary node:
$ puppet facts find somenode.puppetlabs.lan --terminus rest
Query a DB-backed inventory directly (bypassing the REST API):
$ puppet facts find somenode.puppetlabs.lan --terminus inventory_active_record --mode master
upload
Upload facts:
$ puppet facts upload
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 active_record
o couch
o facter
o inventory_active_record
o inventory_service
o memory
o network_device
o rest
o store_configs
o yaml
COPYRIGHT AND LICENSE
Copyright 2011 by Puppet Labs Apache 2 license; see COPYING
Puppet Labs, LLC June 2012 PUPPET-FACTS(8)