Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/puppetlabs/puppetlabs-windows_eventlog
https://github.com/puppetlabs/puppetlabs-windows_eventlog
hacktoberfest module puppet supported windows-puppet-module
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/puppetlabs/puppetlabs-windows_eventlog
- Owner: puppetlabs
- License: mit
- Created: 2013-07-10T16:26:08.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2024-09-03T13:14:43.000Z (4 months ago)
- Last Synced: 2024-09-27T21:43:35.357Z (3 months ago)
- Topics: hacktoberfest, module, puppet, supported, windows-puppet-module
- Language: Ruby
- Homepage: https://forge.puppet.com/puppet/windows_eventlog
- Size: 212 KB
- Stars: 5
- Watchers: 28
- Forks: 16
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# windows_eventlog
[](#transfer-notice)
#### Table of Contents
1. [Overview](#overview)
1. [Module Description - What is the windows_eventlog module?](#module-description)
1. [Setup - The basics of getting started with windows_eventlog](#setup)
* [What windows_eventloge affects](#what-windows_eventlog-affects)
* [Beginning with windows_eventlog](#beginning-with-windows_eventlog)
1. [Usage - Configuration options and additional functionality](#usage)
1. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
1. [Limitations - OS compatibility, etc.](#limitations)
1. [License](#license)
1. [Development - Guide for contributing to the module](#development)
## 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:
```puppet
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:
```puppet
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`](#define-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.
## License
This codebase is licensed under the Apache2.0 licensing, however due to the nature of the codebase the open source dependencies may also use a combination of [AGPL](https://opensource.org/license/agpl-v3/), [BSD-2](https://opensource.org/license/bsd-2-clause/), [BSD-3](https://opensource.org/license/bsd-3-clause/), [GPL2.0](https://opensource.org/license/gpl-2-0/), [LGPL](https://opensource.org/license/lgpl-3-0/), [MIT](https://opensource.org/license/mit/) and [MPL](https://opensource.org/license/mpl-2-0/) Licensing.
## Development
### Contributing
Please read CONTRIBUTING.md for full details on contributing to this project.
## Transfer notice
This module was previously maintained by Vox Pupuli. It was migrated to Puppet/Perforce in 2023.