REFERENCE.md

Reference

Table of Contents

Classes

Public Classes

• osquery: osquery

Private Classes

• osquery::config: osquery configuration
• osquery::package: osquery package management
• osquery::service: osquery service management

Classes

osquery

osquery

Parameters

The following parameters are available in the osquery class:

• config_path
• config_owner
• config_group
• package_name
• package_ensure
• package_provider
• package_install_options
• service_name
• service_enable
• service_ensure
• manage_repo
• repo_url
• repo_key_id
• repo_key_server
• repo_key_name
• repo_key_source
• settings
• validate_cmd

config_path

Data type: Stdlib::AbsolutePath

The absolute path to the osquery configuration file

Default value: '/etc/osquery/osquery.conf'

config_owner

Data type: Variant[Integer[0], String[1]]

The owner to set on the osquery configuration file

Default value: 0

config_group

Data type: Variant[Integer[0], String[1]]

The group to set on the osquery configuration file

Default value: 0

package_name

Data type: String[1]

The osquery package name

Default value: 'osquery'

package_ensure

Data type: String

The osquery package ensure state

Default value: 'installed'

package_provider

Data type: Optional[String]

The package provider to use (Windows)

Default value: undef

package_install_options

Data type: Optional[Array]

The install_options to provide when using Chocolatey (Windows)

Default value: undef

service_name

Data type: String[1]

The osquery service name

Default value: 'osqueryd'

service_enable

Data type: Boolean

The osquery service enable state

Default value: true

service_ensure

Data type: Stdlib::Ensure::Service

The osquery service ensure state

Default value: 'running'

manage_repo

Data type: Boolean

Set to true to manage the osquery repository

Default value: true

repo_url

Data type: Optional[String]

The osquery repository URL to use

Default value: undef

repo_key_id

Data type: Optional[String]

The osquery repository GPG key id (apt)

Default value: undef

repo_key_server

Data type: Optional[String]

The osquery GPG key server (apt) or GPG URL (yum)

Default value: undef

repo_key_name

Data type: Optional[String]

The osquery APT keyring name

Default value: undef

repo_key_source

Data type: Optional[String]

The osquery APT keyring file source

Default value: undef

settings

Data type: Hash

A hash of settings to set in the osquery configuration file

Default value: {}

validate_cmd

Data type: String

The command to validate osquery.conf format changes

Default value: '/usr/bin/osqueryi --config_path % --config_check'