Forge Home


Install and configure the Sumo Logic collector on Linux and Windows using local software distribution. Providing more control over lifecycle.


1,985 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
released Dec 2nd 2019
This version is compatible with:
  • Puppet Enterprise 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, 2016.4.x
  • Puppet >= 4.10.0 < 7.0.0
  • , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'qtechnologies-sumo', '1.0.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add qtechnologies-sumo
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install qtechnologies-sumo --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.



qtechnologies/sumo — version 1.0.2 Dec 2nd 2019


Install and configure the Sumo Logic collector on Linux and Windows using local software distribution. Providing more control over lifecycle.

Table of Contents


There are currently a few SumoLogic modules already. Most notably and The problem with the former is that it does not support Windows or many of the options for the file. The problem with the latter is that it assumes every node can directly connect to the internet for curl (some firewalls only allow Sumo profile traffic) and it doesn't allow you to upgrade or control the package versions. So this module takes the approach of the former, but the detail from the second.

This module assumes an existing package management solution is in place (YUM for RHEL/SLES and Chocolatey for Windows). It takes the following platform approach:

  • Windows - install pkg via chocolatey with the site customisation being driven during pkg install. Upgradeable via Chocolatey.
  • Linux - install RPM, configure, then start sumo. Upgradeable via RPM.


Setup Requirements


Assumes a functional Chocolatey environment and that the Sumo Logic Collector installer for Windows has been correctly imported into Chocolatey.

Setup the Chocolatey package so that it installs the exe with the following command line options:

-console -q -varfile 'C:\windows\temp\sumoVarFile.txt'


Download the Sumo Logic Collector package for your respective flavours and import into your repos.

Beginning with sumo

Put the relevant configuration information into Hiera:

sumo::accessid: lkskj98983hjhj
sumo::accesskey: jlkdlkaldkalkda984nb197jdnkjsomjsdkjiocjJAOSALDJWBDahsikldjkja78
sumo::sumo_package_ver: 19.253-26
sumo::sources_path: "/tmp/sumo-%{osfamily}.json"

Call in the sumo class in your required scope:

  class { 'sumo': }


Expanding on the previous section, all the user properties can be specified in hiera. Here are the defaults that can be overridden by site requirements:

sumo::accessid:                null
sumo::accesskey:               null
sumo::category:                null
sumo::clobber:                 true
sumo::collector_name:          "%{::hostname}"
sumo::collector_secure_files:  true
sumo::description:             null
sumo::enable_action_source:    false
sumo::enable_script_source:    false
sumo::disable_upgrade:         true
sumo::ephemeral:               false
sumo::hostname:                "%{::hostname}"
sumo::proxy_host:              null
sumo::proxy_ntlmdomain:        null
sumo::proxy_password:          null
sumo::proxy_port:              null
sumo::proxy_user:              null
sumo::skip_access_key_removal: false
sumo::skip_registration:       false
sumo::local_config_mgmt:       false
sumo::sources_path:            null
sumo::sync_sources_path:       null
sumo::target_cpu:              null
sumo::time_zone:               null
sumo::token:                   null
sumo::runas_username:          null
sumo::win_run_as_password:     null
sumo::install_properties_path: null
sumo::user_properties_path:    /opt/SumoCollector/config/
  name:    SumoCollector
  version: latest
  name:    collector
  running: true
  enabled: true

Here are the Windows overrides:

  name: sumo-collector
sumo::install_properties_path: 'C:\windows\temp\sumoVarFile.txt'
sumo::user_properties_path:    'C:\Program Files\Sumo Logic Collector\config\'

If you want to install globally except on a few test systems, then you can specify the following Hiera in the scope of the test systems so that it will not be installed or configured on them:

sumo::install: false

Please refer to Sumo documentation for an explanation of each setting: (Bear in mind, some of the properties have been slightly modified, but it should be reasonably clear how they align).

See the file for more detailed information.


  • Nothing implemented for UNIX in this version.
  • Assumes chocolatey is the Windows package manager.
  • Debian/Ubuntu probably works, but is untested.


If you would like to contribute to this module, please submit a PR on github. Thanks.