/AuditPolicyDsc

Primary LanguagePowerShellMIT LicenseMIT

AuditPolicyDsc

The AuditPolicyDsc module allows you to configure and manage the advanced audit policy on all currently supported versions of Windows.

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.

Branches

master

Build status codecov

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

dev

Build status codecov

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 check out common DSC Resources contributing guidelines.

Resources

  • AuditPolicySubcategory: Provides a mechanism to manage advanced auditpolicy subcategory audit flags.

  • AuditPolicyOption: Provides a mechanism to manage audit policy options.

  • AuditPolicyCsv: Provides a mechanism to restore an audit policy backup from a CSV file.

  • AuditPolicyGUID: Provides a version of AuditPolicySubcategory that works around localization issues with auditpol.

AuditPolicySubcategory

Provides a mechanism to manage advanced audit policy subcategory audit flags. This resource works on Nano Server.

Requirements

None

Parameters

  • [String] Name (Key): The name of the subcategory in the advanced audit policy to manage.

  • [String] AuditFlag (Key): The name of the audit flag to apply to the subcategory. { Success | Failure }.

  • [String] Ensure (Write): Indicates whether the service is present or absent. Defaults to Present. { Present | Absent }.

Read-Only Properties from Get-TargetResource

None

Examples

AuditPolicyOption

Provides a mechanism to manage audit policy options. This resource works on Nano Server.

Requirements

None

Parameters

  • [String] Name (Key): The name of the option to configure.

  • [String] Value (Key): The value to apply to the option. { Enabled | Disabled }.

Read-Only Properties from Get-TargetResource

None

Examples

AuditPolicyCsv

Provides a mechanism to restore an audit policy backup. This resource works on Nano Server.

Requirements

None

Parameters

  • [String] CsvPath (Required): The path to the CSV file to apply to the node.

  • [String] IsSingleInstance (Key): Specifies if the resource is a single instance, the value must be 'Yes'.

Read-Only Properties from Get-TargetResource

None

Examples

AuditPolicyGuid

Provides a version of AuditPolicySubcategory that works around localization issues with auditpol.

Requirements

None

Parameters

  • [String] Name (Key): The name of the subcategory in the advanced audit policy to manage.

  • [String] AuditFlag (Key): The name of the audit flag to apply to the subcategory. { Success | Failure }.

  • [String] Ensure (Write): Indicates whether the service is present or absent. Defaults to Present. { Present | Absent }.

Read-Only Properties from Get-TargetResource

None

Examples

Versions

Unreleased

1.4.0.0

  • Explicitly removed extra hidden files from release package

1.3.0.0

  • Update LICENSE file to match the Microsoft Open Source Team standard.
  • Added the AuditPolicyGuid resource.

1.2.0.0

  • Moved auditpol call in the helper module to an external process to better control output
  • auditpol output is now converted to CSV to remove the need to parse the text output
  • All resources have been updated to use the new helper module functionality
  • Added the Ensure parameter default value of Present to the AuditPolicySubcategory resource Test-TargetResource function

1.1.0.0

  • Added the AuditPolicyCsv resource.

1.0.0.0

  • Initial release with the following resources:

    • AuditPolicySubcategory
    • AuditPolicyOption