1PUPPET-FACTS(8)                  Puppet manual                 PUPPET-FACTS(8)
2
3
4

NAME

6       puppet-facts - Retrieve and store facts.
7

SYNOPSIS

9       puppet facts action [--terminus _TERMINUS] [--extra HASH]
10

DESCRIPTION

12       This subcommand manages facts, which are collections of normalized sys‐
13       tem information used by Puppet. It can read  facts  directly  from  the
14       local system (with the default facter terminus).
15

OPTIONS

17       Note  that any setting that´s valid in the configuration file is also a
18       valid long argument, although it may or may  not  be  relevant  to  the
19       present action. For example, server and run_mode are valid settings, so
20       you can specify --server <servername>, or --run_mode  <runmode>  as  an
21       argument.
22
23       See    the    configuration    file   documentation   at   https://pup‐
24       pet.com/docs/puppet/latest/configuration.html  for  the  full  list  of
25       acceptable  parameters.  A  commented list of all configuration options
26       can also be generated by running puppet with --genconfig.
27
28       --render-as FORMAT
29              The format in which to render output. The  most  common  formats
30              are  json, s (string), yaml, and console, but other options such
31              as dot are sometimes available.
32
33       --verbose
34              Whether to log verbosely.
35
36       --debug
37              Whether to log debug information.
38
39       --extra HASH
40              A terminus can take additional arguments to  refine  the  opera‐
41              tion,  which  are  passed  as an arbitrary hash to the back-end.
42              Anything passed as the extra value is just send  direct  to  the
43              back-end.
44
45       --terminus _TERMINUS
46              Indirector  faces  expose indirected subsystems of Puppet. These
47              subsystems are each able to retrieve and alter a  specific  type
48              of  data  (with  the familiar actions of find, search, save, and
49              destroy) from an arbitrary number of pluggable backends. In Pup‐
50              pet parlance, these backends are called terminuses.
51
52              Almost  all  indirected  subsystems  have  a  rest terminus that
53              interacts with the puppet master´s data. Most of them have addi‐
54              tional  terminuses  for  various local data models, which are in
55              turn used by the indirected subsystem on the puppet master when‐
56              ever it receives a remote request.
57
58              The  terminus  for an action is often determined by context, but
59              occasionally needs to be set explicitly. See the "Notes" section
60              of this face´s manpage for more details.
61

ACTIONS

63       find - Retrieve a node´s facts.
64              SYNOPSIS
65
66              puppet  facts  [--terminus _TERMINUS] [--extra HASH] [node_cert‐
67              name]
68
69              DESCRIPTION
70
71              Retrieve a node´s facts.
72
73              RETURNS
74
75              A hash containing some metadata and (under the "values" key) the
76              set  of  facts  for  the requested node. When used from the Ruby
77              API: A Puppet::Node::Facts object.
78
79              RENDERING ISSUES:  Facts  cannot  currently  be  rendered  as  a
80              string; use yaml or json.
81
82              NOTES
83
84              When using the facter terminus, the host argument is ignored.
85
86       info - Print the default terminus class for this face.
87              SYNOPSIS
88
89              puppet facts info [--terminus _TERMINUS] [--extra HASH]
90
91              DESCRIPTION
92
93              Prints the default terminus class for this subcommand. Note that
94              different run modes may have different default termini; when  in
95              doubt, specify the run mode with the ´--run_mode´ option.
96
97       save - API only: create or overwrite an object.
98              SYNOPSIS
99
100              puppet facts save [--terminus _TERMINUS] [--extra HASH] key
101
102              DESCRIPTION
103
104              API  only: create or overwrite an object. As the Faces framework
105              does not currently accept data from STDIN, save  actions  cannot
106              currently be invoked from the command line.
107
108       upload - Upload local facts to the puppet master.
109              SYNOPSIS
110
111              puppet facts upload [--terminus _TERMINUS] [--extra HASH]
112
113              DESCRIPTION
114
115              Reads  facts  from  the  local system using the facter terminus,
116              then saves the returned facts using the rest terminus.
117
118              RETURNS
119
120              Nothing.
121
122              NOTES
123
124              This action requires that the  puppet  master´s  auth.conf  file
125              allow PUT or save access to the /puppet/v3/facts API endpoint.
126
127              For details on configuring Puppet Server´s auth.conf, see:
128
129              https://puppet.com/docs/puppetserver/latest/con‐
130              fig_file_auth.html
131
132              For legacy Rack-based Puppet Masters, see:
133
134              https://puppet.com/docs/puppet/latest/config_file_auth.html
135

EXAMPLES

137       find
138
139       Get facts from the local system:
140
141       $ puppet facts find
142
143       upload
144
145       Upload facts:
146
147       $ puppet facts upload
148

NOTES

150       This subcommand is an indirector  face,  which  exposes  find,  search,
151       save,  and destroy actions for an indirected subsystem of Puppet. Valid
152       termini for this face include:
153
154       ·   facter
155
156       ·   memory
157
158       ·   network_device
159
160       ·   rest
161
162       ·   store_configs
163
164       ·   yaml
165
166
167

169       Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING
170
171
172
173Puppet, Inc.                      April 2020                   PUPPET-FACTS(8)
Impressum