Documentation
  • Docs »
  • win_audit_policy_system - Used to make changes to the system wide Audit Policy

win_audit_policy_system - Used to make changes to the system wide Audit Policy

New in version 2.5.

Synopsis

Parameters

Parameter Choices/Defaults Comments
audit_type
required
    Choices:
  • failure
  • none
  • success
The type of event you would like to audit for.
Accepts a list. See examples.
category
Single string value for the category you would like to adjust the policy on.
Cannot be used with subcategory. You must define one or the other.
Changing this setting causes all subcategories to be adjusted to the defined audit_type.
subcategory
Single string value for the subcategory you would like to adjust the policy on.
Cannot be used with category. You must define one or the other.

Examples

- name: enable failure auditing for the subcategory "File System"
  win_audit_policy_system:
    subcategory: File System
    audit_type: failure

- name: enable all auditing types for the category "Account logon events"
  win_audit_policy_system:
    category: Account logon events
    audit_type: success, failure

- name: disable auditing for the subcategory "File System"
  win_audit_policy_system:
    subcategory: File System
    audit_type: none

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
current_audit_policy
dictionary
 always
details on the policy being targetted

Sample:
{ "File Share":"failure" }


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Noah Sparks (@nwsparks)

Hint

If you notice any issues in this documentation you can edit this document to improve it.