puppet-facts - Retrieve and store facts.
puppet facts action [--terminus _TERMINUS]
PUPPET-FACTS(8) Puppet manual PUPPET-FACTS(8)
NAME
puppet-facts - Retrieve and store facts.
SYNOPSIS
puppet facts action [--terminus _TERMINUS]
DESCRIPTION
This subcommand manages facts, which are collections of normalized sys-
tem information used by Puppet. It can read facts directly from the
local system (with the default facter terminus).
OPTIONS
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://pup-
pet.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.
--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 opera-
tion, 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 Pup-
pet 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 addi-
tional terminuses for various local data models, which are in
turn used by the indirected subsystem on the puppet master when-
ever 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
diff - Compare Facter 3 output with Facter 4 output
SYNOPSIS
puppet facts diff [--terminus _TERMINUS] [--structured]
[--exclude regex]
DESCRIPTION
Compares output from facter 3 with Facter 4 and prints the dif-
ferences
OPTIONS --exclude <regex> - Regex used to exclude specific facts
from diff.
--structured - Render the different facts as structured.
RETURNS
Differences between Facter 3 and Facter 4 output as an array.
NOTES
find - Retrieve a node's facts.
SYNOPSIS
puppet facts [--terminus _TERMINUS] [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]
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] 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.
show - Retrieve current node's facts.
SYNOPSIS
puppet facts show [--terminus _TERMINUS] [--config-file path]
[--custom-dir path] [--external-dir path] [--no-block]
[--no-cache] [--show-legacy] [--value-only] [facts]
DESCRIPTION
Reads facts from the local system using facter terminus. A query
can be provided to retrieve just a specific fact or a set of
facts.
OPTIONS --config-file <path> - The location of the config file
for Facter.
--custom-dir <path> - The path to a directory that contains cus-
tom facts.
--external-dir <path> - The path to a directory that contains
external facts.
--no-block - Disable fact blocking mechanism.
--no-cache - Disable fact caching mechanism.
--show-legacy - Show legacy facts when querying all facts.
--value-only - Show only the value when the action is called
with a single query
RETURNS
The output of facter with added puppet specific facts.
NOTES
upload - Upload local facts to the puppet master.
SYNOPSIS
puppet facts upload [--terminus _TERMINUS]
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/con-
fig_file_auth.html
For legacy Rack-based Puppet Masters, see:
https://puppet.com/docs/puppet/latest/config_file_auth.html
EXAMPLES
diff
get differences between facter versions: $ puppet facts diff
find
Get facts from the local system:
$ puppet facts find
show
retrieve facts:
$ puppet facts show os
upload
Upload facts:
$ puppet facts upload
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+--------------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+--------------------------+
|Availability | system/management/puppet |
+---------------+--------------------------+
|Stability | Volatile |
+---------------+--------------------------+
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 facter
o json
o memory
o network_device
o rest
o store_configs
o yaml
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from https://github.com/puppetlabs/puppet.
Further information about this software can be found on the open source
community website at http://puppetlabs.com/.
COPYRIGHT AND LICENSE
Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING
Puppet, Inc. January 2022 PUPPET-FACTS(8)