Forge Home


OSQuery Puppet module


8,917 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

  • 0.2.3 (latest)
  • 0.2.2
  • 0.2.1 (deleted)
  • 0.1.4
  • 0.1.3
  • 0.1.2
  • 0.1.1
  • 0.1.0
released Sep 26th 2018
This version is compatible with:
  • Puppet Enterprise 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 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, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 3.3.0
  • , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'bryana-osquery', '0.2.3'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add bryana-osquery
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install bryana-osquery --version 0.2.3

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.



bryana/osquery — version 0.2.3 Sep 26th 2018

Build Status


Table of Contents

  1. Overview
  2. Setup - The basics of getting started with osquery
  3. Usage - Configuration options and additional functionality
  4. Reference - An under-the-hood peek at what the module is doing and how
  5. Limitations - OS compatibility, etc.


OSQuery installation and configuration Puppet module.


What OSQuery affects

  • osquery repo installed by default, can be disabled.
  • osquery package installed.
  • osquery JSON config file setup.
  • osquery service ran.

Setup Requirements

Uses apt module for Ubuntu to setup the repository or yum if Redhat family to install the repo RPM.


Basic usage example with defaults.

include osquery

Usage example including some custom settings.

class { 'osquery':
  settings => {
    'options' => {
      'event_pubsub_expiry' => '86000',
      'debug' => false,
      'worker_threads' => $::processorcount,
    'schedule' => {
      'info' => {
        'query' => 'SELECT * FROM osquery_info',
        'interval' => '3600',


  • osquery::settings - hash converted into a JSON string for the OSQuery config file. Default is based on upstream package example config.
  • osquery::package_name - Package name to install. Default is auto detect based on OSFamily.
  • osquery::service_name - Service name to run. Default is auto detect based on OSFamily.
  • osquery::package_ver - latest or present. Defaults to latest.
  • osquery::params::config - Full path to config file. Defaults to /etc/osquery/osquery.conf.
  • osquery::params::repo_install - Boolan, manage the repo or not. Default is true.
  • osquery::params::repo_url - Repo URL.
  • osquery::params::repo_name - Redhat repo RPM name.
  • osquery::params::repo_key_id - Apt repo signature key ID.
  • osquery::params::repo_key_server - Apt repo key server.


OSQuery is developed for CentOS6/7 as well as Ubuntu Trusty 14.04 LTS and Precise 12.04 LTS only.