Forge Home


Tasks that inspect the value of system facts


359 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 2.0.0 (deleted)
  • 1.3.0 (latest)
  • 1.2.0
  • 1.1.0
  • 1.0.0
  • 0.9.0
  • 0.8.0
  • 0.7.0
  • 0.6.0
  • 0.5.0
  • 0.4.1
  • 0.4.0
  • 0.3.1
  • 0.3.0
  • 0.2.1
  • 0.2.0
  • 0.1.5
  • 0.1.4
  • 0.1.3
released Oct 3rd 2022
This version is compatible with:
  • Puppet Enterprise 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x
  • Puppet >= 6.0.0 < 8.0.0
  • , , , , , , ,
  • facter_task

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'puppetlabs-facter_task', '1.3.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppetlabs-facter_task
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppetlabs-facter_task --version 1.3.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.



puppetlabs/facter_task — version 1.3.0 Oct 3rd 2022


Table of Contents


This module provides the facter_task task.

Module Description

This task allows you to discover facts about remote machines in your infrastructure.



This module is compatible with Puppet Enterprise and Puppet Bolt.

  • To run tasks with Puppet Enterprise, PE 2018.1 or later must be installed on the machine from which you are running task commands. Machines receiving task requests must be Puppet agents.

  • To run tasks with Puppet Bolt, Bolt 1.0 or later must be installed on the machine from which you are running task commands. Machines receiving task requests must have SSH or WinRM services enabled.


To view the available actions and parameters, on the command line, run puppet task show facter_task or see the facter_task module page on the Forge. For a complete list of facts that are supported, see the Puppet core facts documentation. To show help for the task CLI, run puppet task run --help or bolt task run --help

To run a facter_task task, use the task command, specifying the fact you want to retrieve.

  • With PE on the command line, run puppet task run facter_task fact=<FACT>.
  • With Bolt on the command line, run bolt task run facter_task fact=<FACT>.

For example, to check the operating system family on a machine, run:

  • With PE, run puppet task run facter_task fact=osfamily --nodes neptune
  • With Bolt, run bolt task run facter_task fact=osfamily --nodes neptune --modulepath ~/modules

You can also run tasks in the PE console. See PE task documentation for complete information.


For information on the classes and types, see the


To run acceptance tests against Windows machines locally, ensure that the BEAKER_password environment variable has been set to the password of the Administrator user of the target machine.

For an extensive list of supported operating systems, see metadata.json


Acceptance tests for this module leverage puppet_litmus. To run the acceptance tests follow the instructions here. You can also find a tutorial and walkthrough of using Litmus and the PDK on YouTube.

If you run into an issue with this module, or if you would like to request a feature, please file a ticket. Every Monday the Puppet IA Content Team has office hours in the Puppet Community Slack, alternating between an EMEA friendly time (1300 UTC) and an Americas friendly time (0900 Pacific, 1700 UTC).

If you have problems getting this module up and running, please contact Support.

If you submit a change to this module, be sure to regenerate the reference documentation as follows:

puppet strings generate --format markdown --out