AuditSystemDsc

This resource module contains resources used to audit system settings/verify compliance.

This project has adopted this code of conduct.

Branches

master

This is the branch containing the latest release - no contributions should be made directly to this branch.

dev

This is the development branch to which contributions should be proposed by contributors as pull requests. This development branch will periodically be merged to the master branch, and be released to PowerShell Gallery.

Contributing

Please see our contributing guidelines.

Installation

GitHub

To manually install the module, download the source code and unzip the contents to the directory '$env:ProgramFiles\WindowsPowerShell\Modules' folder.

PowerShell Gallery

To install from the PowerShell gallery using PowerShellGet (in PowerShell 5.0) run the following command:

Find-Module -Name AuditSystemDsc -Repository PSGallery | Install-Module

To confirm installation, run the below command and ensure you see the DSC resources available:

Get-DscResource -Module AuditSystemDsc

Requirements

The minimum Windows Management Framework (PowerShell) version required is 4.0 or higher.

Examples

You can review the Examples directory for some general use scenarios for all of the resources that are in the module.

Change log

A full list of changes in each version can be found in the change log.

Resources

• AuditSetting A resource the leverages CIM classes to verify system settings.

AuditSetting

A resource the leverages CIM classes to verify system settings.

Requirements

• Target machine must have the CIM cmdlets installed.

Parameters

• [String] NameSpace: Specifies the namespace of CIM class.
• [String] Query (Key): A WQL query used to retrieve the setting to be audited.
• [String] Property (Key): The property name to be audited.
• [String] DesiredValue (Key): Specifies the desired value of the property being audited.
• [String] Operator (Required): The comparison operator to be used to craft the condition that defines compliance.

Read-Only Properties from Get-TargetResource

• [String[]] ResultString (Read): An array of strings listing all the properties and values of the WMI class being queried.

Examples

• Audit disk volumnes are NTFS
• Audit local users that don't require a password
• Verify netowrk prefix length
• Verify service pack level

Known issues

All issues are not listed here, see here for all open issues.