Forge Home


Task that lets you run pql queries in the PE Console


5,108 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

  • 1.0.2 (latest)
  • 1.0.1
  • 1.0.0
  • 0.2.1
  • 0.2.0
  • 0.1.0
released Mar 8th 2019
This version is compatible with:
  • Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.7.0 < 6.0.0
  • , , , , ,
  • run

Start using this module

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

Add this module to your Puppetfile:

mod 'beersy-pql_query', '1.0.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add beersy-pql_query
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install beersy-pql_query --version 1.0.2

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.



beersy/pql_query — version 1.0.2 Mar 8th 2019

Build Status


Table of Contents

  1. Description
  2. Requirements
  3. Usage - Configuration options and additional functionality
  4. Reference - An under-the-hood peek at what the module is doing and how
  5. Getting help - Some Helpful commands


This module provides the pql_query task. This task lets you run pql queries and display the results in the PE Console"


This module is compatible with Puppet Enterprise and Puppet Bolt.

  • To run tasks with Puppet Enterprise, PE 2017.3 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 0.5 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. If using Bolt, the puppet agent must already installed.



You can also run the Puppet Task from the command line using:

puppet task run pql_query::run query=<value> <[--nodes, -n <node-names>] | [--query, -q <'query'>]>

Or using bolt:

bolt task run --nodes, -n <node-name> pql_query::run query=<value>

NOTE The task can take a few minutes to run.

There is 1 parameter:

  • query : pql query you want to execute
  • store_results : Store results on disk. Defaults to 'yes'.

If something goes wrong, try changing single quotes to double quotes or vice versa.

The results will be shown in YAML in the console.
If store_results is set to 'yes' or not set, the results are saved in /tmp in json and yaml formats.


To view the available actions and parameters, on the command line, run puppet task show pql_query or see the pql_query module page on the Forge.

Getting Help

To display help for the pql_query task, run puppet task show pql_query::run

To show help for the task CLI, run puppet task run --help or bolt task run --help


This task can only be targeted to the master node

Release Notes/Contributors/Etc.

0.2.0 - Added new store_results option
0.1.0 - Initial Release