pql_query

pdk
tasks
Task that lets you run pql queries in the PE Console

Abir Majumdar

beersy

13,547 downloads

3,477 latest version

5.0 quality score

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
  • CentOS
    ,
    OracleLinux
    ,
    RedHat
    ,
    Scientific
    ,
    Debian
    ,
    Ubuntu
Tasks:
  • run

Start using this module

Documentation

beersy/pql_query — version 1.0.2 Mar 8th 2019

Build Status

pql_query

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

Description

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

Requirements

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.

Usage

Usage

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.

Reference

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

Limitations

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