osquery

Install, configure and manage osquery

975 downloads

46 latest version

Version information

  • 1.2.0 (latest)
  • 1.1.0
  • 1.0.0
  • 0.1.0
released Apr 26th 2025
This version is compatible with:
  • Puppet Enterprise 2025.3.x, 2025.2.x, 2025.1.x, 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x
  • Puppet >= 8.0.0 < 9.0.0
  • , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'genv-osquery', '1.2.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install genv-osquery --version 1.2.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.

Download

Documentation

genv/osquery — version 1.2.0 Apr 26th 2025

osquery

Build Status Release Puppet Forge Apache-2 License

Install, configure and manage osquery.

Usage

Include the osquery class to install the package and run osqueryd with minimal configuration.

include osquery

Configuration

The settings parameter accepts any hash that is saved as JSON to /etc/osquery/osquery.conf.

class { 'osquery':
  settings => {
    options   => {
      config_plugin   => 'filesystem',
      disable_logging => 'false',
      logger_plugin   => 'syslog',
    },
    discovery => [
      'SELECT pid FROM processes WHERE name = \'foobar\';',
      'SELECT 1 FROM users WHERE username like \'www%\';',
    ],
  }
}
osquery::settings:
  options:
    config_plugin: filesystem
    logger_plugin: syslog
    host_identifier: uuid
  schedule:
    foobar:
      query: SELECT foo, bar, pid FROM foobar_table;
      interval: 600
  packs:
    shard: 10
    external_pack: /path/to/external_pack.conf
    queries:
      suid_bins:
        query: SELECT * FROM suid_bins;
        interval: 3600

Dependencies

The following modules are soft dependencies that are required depending on the OS family used.

Debian Family

  • puppetlabs/apt >= 9.1.0

RedHat Family

  • puppetlabs/yumrepo_core >= 1.2.0

Windows Family

  • puppetlabs/chocolatey >= 8.0.0