Forge Home

windows_eventlog

Module for managing the windows event log

Vox Pupuli

puppet

20,898 downloads

2,009 latest version

5.0 quality score

Version information

  • 3.0.0 (latest)
  • 2.0.2
  • 2.0.1
  • 2.0.0
  • 1.2.0
  • 1.1.1
  • 1.0.0
released Jan 16th 2020
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
  • Puppet >= 5.5.8 < 7.0.0
  • windows

Start using this module

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

Add this declaration to your Puppetfile:

mod 'puppet-windows_eventlog', '3.0.0'
Learn more about managing modules with a Puppetfile

Add this module to a Bolt project:

bolt module add puppet-windows_eventlog
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppet-windows_eventlog --version 3.0.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

puppet/windows_eventlog — version 3.0.0 Jan 16th 2020

Windows Event Logs module for Puppet

Build Status Code Coverage Puppet Forge Puppet Forge - downloads Puppet Forge - endorsement Puppet Forge - scores

Table of Contents

  1. Overview
  2. Module Description - What is the windows_eventlog module?
  3. Setup - The basics of getting started with windows_eventlog
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module

Overview

Puppet module for managing windows event logs

Build Status

Module Description

The purpose of this module is to manage each of the Windows event logs, including the size, rotation and retention

Setup

What windows_eventlog affects

  • Sets registry keys to manage the event log configuration

Beginning with windows_eventlog

Manage the size of the Application log:

    windows_eventlog { 'Application':
      log_path => '%SystemRoot%\system32\winevt\Logs\Application.evtx',
      log_size => '2048',
      max_log_policy => 'overwrite'
    }

Manage several custom logs under C:\Logs:

   windows_eventlog { ['Custom1', 'Custom2', 'Custom3']:
     log_path_template => 'C:\Logs\%%NAME%%.evtx'
   }

Usage

Classes and Defined Types

Defined Type: windows_eventlog

The primary definition of this module. Manages the size and rotation policy of Windows event logs

Parameters within windows_eventlog:

log_path

(Optional) The path to the log file that you want to manage.

log_size

The max size of the log file in bytes. Defaults to '1028'.

max_log_policy

The retention policy for the log. Defaults to 'overwrite'.

log_path_template

(Optional) A template for log_path, where "%%NAME%%" will be replaced with the log name. Defaults to '%SystemRoot%\\system32\\winevt\\Logs\\%%NAME%%.evtx'.

Reference

Defined Types

Public Defined Types

Limitations

This module is tested on the following platforms:

  • Windows 2008 R2

It is tested with the OSS version of Puppet only.

Development

Contributing

Please read CONTRIBUTING.md for full details on contributing to this project.