Go to main content

man pages section 8: System Administration Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

puppet-facts (8)

Name

puppet-facts - Retrieve and store facts.

Synopsis

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

Description

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 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://docs.puppet-
       labs.com/puppet/latest/reference/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
       find - Retrieve a node's facts.
              SYNOPSIS

              puppet  facts  [--terminus _TERMINUS] [--extra HASH] [node_cert-
              name]

              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/con-
              fig_file_auth.html

              For legacy Rack-based Puppet Masters, see:

              https://puppet.com/docs/puppet/latest/config_file_auth.html

EXAMPLES
       find

       Get facts from the local system:

       $ puppet facts find

       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   memory

       o   network_device

       o   rest

       o   store_configs

       o   yaml



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


       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/ar-
       chive/5.5.0.tar.gz

       Further information about this software can be found on the open source
       community website at http://puppetlabs.com/.



Puppet, Inc.                      March 2018                   PUPPET-FACTS(8)