Skip to content
THIS MODULE HAS BEEN DEPRECATED Please use ComputerManagementDsc instead: https://github.com/PowerShell/ComputerManagementDsc
PowerShell
Branch: dev
Clone or download

README.md

THIS MODULE HAS BEEN DEPRECATED

It will no longer be released. Please use the 'WinEventLog' resource in ComputerManagementDsc instead.

xWinEventLog

Build status

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. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Contributing

Please check out common DSC Resources contributing guidelines.

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

$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
You can’t perform that action at this time.