Windows Event Logs module for Puppet

Table of Contents

1. Overview
2. Module Description - What is the windows_eventlog module?
3. Setup - The basics of getting started with windows_eventlog
   • What windows_eventloge affects
   • Beginning 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

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

• windows_eventlog: Manages the size and rotation policy of a Windows event log

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.