https://github.com/dsccommunity/xwineventlog

THIS MODULE HAS BEEN DEPRECATED Please use ComputerManagementDsc instead: https://github.com/PowerShell/ComputerManagementDsc
https://github.com/dsccommunity/xwineventlog

Last synced: 8 months ago
JSON representation

THIS MODULE HAS BEEN DEPRECATED Please use ComputerManagementDsc instead: https://github.com/PowerShell/ComputerManagementDsc

• Host: GitHub
• URL: https://github.com/dsccommunity/xwineventlog
• Owner: dsccommunity
• License: mit
• Created: 2015-04-15T22:43:11.000Z (over 11 years ago)
• Default Branch: dev
• Last Pushed: 2019-04-03T22:04:52.000Z (over 7 years ago)
• Last Synced: 2024-03-14T20:20:21.397Z (over 2 years ago)
• Language: PowerShell
• Homepage:
• Size: 55.7 KB
• Stars: 11
• Watchers: 21
• Forks: 8
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# **THIS MODULE HAS BEEN DEPRECATED**

It will no longer be released.

Please use the 'WinEventLog' resource in [ComputerManagementDsc](https://github.com/PowerShell/ComputerManagementDsc)

instead.

## xWinEventLog

[![Build status](https://ci.appveyor.com/api/projects/status/m6mpb7krr5ps31x3/branch/master?svg=true)](https://ci.appveyor.com/project/PowerShell/xwineventlog/branch/master)

The **xWinEventLog** module contains the **xWinEventLog** DSC resource which configures the Windows Event Logs.

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).

For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

### Contributing

Please check out common DSC Resources [contributing guidelines](https://github.com/PowerShell/DscResource.Kit/blob/master/CONTRIBUTING.md).

### Resources

#### xWinEventLog

* **LogName**: Name of the event log.

* **MaximumSizeInBytes**: Size that the event log file is allowed to be. When the file reaches this maximum size it is considered full.

* **IsEnabled**: Specifies whether or not logging for the specified log is enabled.

* **LogMode**: The log mode: { AutoBackup | Circular | Retained }

* **SecurityDescriptor**: This is an SDDL string which configures access rights to the event log.

### Versions

#### Unreleased

### 1.3.0.0

* THIS MODULE HAS BEEN DEPRECATED. It will no longer be released.

  Please use the "WinEventLog" resource in ComputerManagementDsc instead. 

* Update appveyor.yml to use the default template.

* Added default template files .codecov.yml, .gitattributes, and .gitignore, and

  .vscode folder.

### 1.2.0.0

* Converted appveyor.yml to install Pester from PSGallery instead of from Chocolatey.

* Fix PSSA errors.

#### 1.1.0.0

* MSFT_xWinEventLog: Added LogFilePath parameter to

* Fixed tests

* Fixed encoding

#### 1.0.0.0

* Fixed Set-TargetResource function in xWinEventLog resource not to reapply if resource is in desired state already.

#### 0.0.1

* Initial release with the following resource:

  * xWinEventLog

### Examples

#### Configuring the MSPaint event log

```powershell

$before = Get-WinEvent -ListLog "Microsoft-Windows-MSPaint/Admin"

Configuration Demo1

{

    Import-DscResource -module xWinEventLog

    xWinEventLog Demo1

    {

        LogName            = "Microsoft-Windows-MSPaint/Admin"

        IsEnabled          = $true

        LogMode            = "AutoBackup"

        MaximumSizeInBytes = 20mb

        LogFilePath        = "c:\logfolder\MSPaint.evtx"

    }

}

Demo1 -OutputPath $env:temp

Start-DscConfiguration -Path $env:temp -ComputerName localhost -Verbose -wait -debug

$after = Get-WinEvent -ListLog "Microsoft-Windows-MSPaint/Admin"

$before,$after | format-table -AutoSize LogName,IsEnabled,MaximumSizeInBytes,ProviderLatency,LogMode

Get-DscConfiguration

```