puppet-facts
- Retrieve and store facts.
puppet facts action [--terminus _TERMINUS] [--extra HASH]
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).
Note that any setting 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
settings, so you can specify --server <servername>
, or
--run_mode <runmode>
as an argument.
See the configuration file documentation at
https://puppet.com/docs/puppet/latest/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
.
json
,
s
(string), yaml
, and console
, but other options such as dot
are
sometimes available.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.
find
- Retrieve a node's facts.SYNOPSIS
puppet facts [--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 '--run_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 currently be invoked from the command line.
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 PUT
or save
access to the /puppet/v3/facts
API endpoint.
For details on configuring Puppet Server's auth.conf
, see:
https://puppet.com/docs/puppetserver/latest/config_file_auth.html
For legacy Rack-based Puppet Masters, see:
find
Get facts from the local system:
$ puppet facts find
upload
Upload facts:
$ puppet facts upload
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:
facter
memory
network_device
rest
store_configs
yaml
Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING