mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-02 14:40:19 -07:00
Windows: Add missing parameter types and doc fixes (#50232)
* Windows: Add missing parameter types and doc fixes This PR includes: - Adding missing parameter types - Various documentation fixes * Update lib/ansible/modules/windows/win_copy.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_credential.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_domain_computer.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_domain_user.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_environment.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_psexec.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_uri.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_wait_for.py Co-Authored-By: dagwieers <dag@wieers.com> * Ensure docstrings are raw strings
This commit is contained in:
parent
f80ce60cf9
commit
d863027159
92 changed files with 982 additions and 716 deletions
|
@ -24,13 +24,14 @@ options:
|
|||
description:
|
||||
- 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'.
|
||||
required: yes
|
||||
such as, C(HKLM:\Software).
|
||||
type: path
|
||||
required: yes
|
||||
aliases: [ dest, destination ]
|
||||
user:
|
||||
description:
|
||||
- The user or group to adjust rules for.
|
||||
type: str
|
||||
required: yes
|
||||
rights:
|
||||
description:
|
||||
|
@ -39,8 +40,8 @@ options:
|
|||
FileSystemRights U(https://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(https://msdn.microsoft.com/en-us/library/system.security.accesscontrol.registryrights.aspx).
|
||||
required: yes
|
||||
type: list
|
||||
required: yes
|
||||
inheritance_flags:
|
||||
description:
|
||||
- Defines what objects inside of a folder or registry key will inherit the settings.
|
||||
|
@ -48,28 +49,29 @@ options:
|
|||
- For more information on the choices see MSDN PropagationFlags enumeration
|
||||
at U(https://msdn.microsoft.com/en-us/library/system.security.accesscontrol.inheritanceflags.aspx).
|
||||
type: list
|
||||
default: "ContainerInherit,ObjectInherit"
|
||||
choices: [ ContainerInherit, ObjectInherit ]
|
||||
default: ContainerInherit,ObjectInherit
|
||||
propagation_flags:
|
||||
description:
|
||||
- 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(https://msdn.microsoft.com/en-us/library/system.security.accesscontrol.propagationflags.aspx).
|
||||
default: "None"
|
||||
choices: [ None, InherityOnly, NoPropagateInherit ]
|
||||
default: "None"
|
||||
audit_flags:
|
||||
description:
|
||||
- Defines whether to log on failure, success, or both.
|
||||
- To log both define as comma separated list "Success, Failure".
|
||||
required: yes
|
||||
type: list
|
||||
required: yes
|
||||
choices: [ Failure, Success ]
|
||||
state:
|
||||
description:
|
||||
- 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).
|
||||
type: str
|
||||
choices: [ absent, present ]
|
||||
default: present
|
||||
seealso:
|
||||
|
@ -79,7 +81,7 @@ author:
|
|||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
- name: add filesystem audit rule for a folder
|
||||
- name: Add filesystem audit rule for a folder
|
||||
win_audit_rule:
|
||||
path: C:\inetpub\wwwroot\website
|
||||
user: BUILTIN\Users
|
||||
|
@ -87,7 +89,7 @@ EXAMPLES = r'''
|
|||
audit_flags: success,failure
|
||||
inheritance_flags: ContainerInherit,ObjectInherit
|
||||
|
||||
- name: add filesystem audit rule for a file
|
||||
- name: Add filesystem audit rule for a file
|
||||
win_audit_rule:
|
||||
path: C:\inetpub\wwwroot\website\web.config
|
||||
user: BUILTIN\Users
|
||||
|
@ -95,20 +97,20 @@ EXAMPLES = r'''
|
|||
audit_flags: success,failure
|
||||
inheritance_flags: None
|
||||
|
||||
- name: add registry audit rule
|
||||
- name: Add registry audit rule
|
||||
win_audit_rule:
|
||||
path: HKLM:\software
|
||||
user: BUILTIN\Users
|
||||
rights: delete
|
||||
audit_flags: 'success'
|
||||
|
||||
- name: remove filesystem audit rule
|
||||
- name: Remove filesystem audit rule
|
||||
win_audit_rule:
|
||||
path: C:\inetpub\wwwroot\website
|
||||
user: BUILTIN\Users
|
||||
state: absent
|
||||
|
||||
- name: remove registry audit rule
|
||||
- name: Remove registry audit rule
|
||||
win_audit_rule:
|
||||
path: HKLM:\software
|
||||
user: BUILTIN\Users
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue