Class: Ansible::Ruby::Modules::Win_audit_rule

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/windows/win_audit_rule.rb

Overview

Used to apply audit rules to files, folders or registry keys. Once applied, it will begin recording the user who performed the operation defined into the Security Log in the Event viewer. The behavior is designed to ignore inherited rules since those cannot be adjusted without first disabling the inheritance behavior. It will still print inherited rules in the output though for debugging purposes.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#audit_flags ⇒ :Failure, :Success

Returns Defines whether to log on failure, success, or both.,To log both define as comma separated list “Success, Failure”.

Returns:

  • (:Failure, :Success) —

    Defines whether to log on failure, success, or both.,To log both define as comma separated list “Success, Failure”.



34
 
# File 'lib/ansible/ruby/modules/generated/windows/win_audit_rule.rb', line 34

attribute :audit_flags

#inheritance_flags ⇒ Array<String>, ...

Returns Defines what objects inside of a folder or registry key will inherit the settings.,If you are setting a rule on a file, this value has to be changed to C(none).,For more information on the choices see MSDN PropagationFlags enumeration at U(msdn.microsoft.com/en-us/library/system.security.accesscontrol.inheritanceflags.aspx).

Returns:



26
 
# File 'lib/ansible/ruby/modules/generated/windows/win_audit_rule.rb', line 26

attribute :inheritance_flags

#path ⇒ String

Returns Path to the file, folder, or registry key.,Registry paths should be in Powershell format, beginning with an abbreviation for the root such as, ‘hklm:software’.

Returns:

  • (String) —

    Path to the file, folder, or registry key.,Registry paths should be in Powershell format, beginning with an abbreviation for the root such as, ‘hklm:software’.



14
 
# File 'lib/ansible/ruby/modules/generated/windows/win_audit_rule.rb', line 14

attribute :path

#propagation_flags ⇒ :None, ...

Returns Propagation flag on the audit rules.,This value is ignored when the path type is a file.,For more information on the choices see MSDN PropagationFlags enumeration at U(msdn.microsoft.com/en-us/library/system.security.accesscontrol.propagationflags.aspx).

Returns:



30
 
# File 'lib/ansible/ruby/modules/generated/windows/win_audit_rule.rb', line 30

attribute :propagation_flags

#rights ⇒ Array<String>, String

Returns Comma separated list of the rights desired. Only required for adding a rule.,If I(path) is a file or directory, rights can be any right under MSDN FileSystemRights U(msdn.microsoft.com/en-us/library/system.security.accesscontrol.filesystemrights.aspx).,If I(path) is a registry key, rights can be any right under MSDN RegistryRights U(msdn.microsoft.com/en-us/library/system.security.accesscontrol.registryrights.aspx).

Returns:



22
 
# File 'lib/ansible/ruby/modules/generated/windows/win_audit_rule.rb', line 22

attribute :rights

#state ⇒ :absent, ...

Returns Whether the rule should be C(present) or C(absent).,For absent, only I(path), I(user), and I(state) are required.,Specifying C(absent) will remove all rules matching the defined I(user).

Returns:

  • (:absent, :present, nil) —

    Whether the rule should be C(present) or C(absent).,For absent, only I(path), I(user), and I(state) are required.,Specifying C(absent) will remove all rules matching the defined I(user).



38
 
# File 'lib/ansible/ruby/modules/generated/windows/win_audit_rule.rb', line 38

attribute :state

#user ⇒ String

Returns The user or group to adjust rules for.

Returns:

  • (String) —

    The user or group to adjust rules for.



18
 
# File 'lib/ansible/ruby/modules/generated/windows/win_audit_rule.rb', line 18

attribute :user