ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-26 14:41:23 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Use semantic markup (modules h-j) (#6677)

Browse source 
* Use semantic markup.

* Use 'ignore:' until a new version of antsibull-docs is released.

* 'ignore:' is no longer needed.

* E() now works better.
This commit is contained in:
Felix Fontein 2023-06-15 15:47:00 +02:00 • committed by GitHub
commit 3e0d84bdda
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
30 changed files with 202 additions and 202 deletions
Download patch file Download diff file Expand all files Collapse all files

18
plugins/modules/ipa_group.py
View file

@ -22,8 +22,8 @@ attributes:
options:
append:
description:
- If C(true), add the listed I(user) and I(group) to the group members.
- If C(false), only the listed I(user) and I(group) will be group members, removing any other members.
- If V(true), add the listed O(user) and O(group) to the group members.
- If V(false), only the listed O(user) and O(group) will be group members, removing any other members.
default: false
type: bool
version_added: 4.0.0
@ -50,9 +50,9 @@ options:
group:
description:
- List of group names assigned to this group.
- If I(append=false) and an empty list is passed all groups will be removed from this group.
- If O(append=false) and an empty list is passed all groups will be removed from this group.
- Groups that are already assigned but not passed will be removed.
- If I(append=true) the listed groups will be assigned without removing other groups.
- If O(append=true) the listed groups will be assigned without removing other groups.
- If option is omitted assigned groups will not be checked or changed.
type: list
elements: str
@ -63,20 +63,20 @@ options:
user:
description:
- List of user names assigned to this group.
- If I(append=false) and an empty list is passed all users will be removed from this group.
- If O(append=false) and an empty list is passed all users will be removed from this group.
- Users that are already assigned but not passed will be removed.
- If I(append=true) the listed users will be assigned without removing other users.
- If O(append=true) the listed users will be assigned without removing other users.
- If option is omitted assigned users will not be checked or changed.
type: list
elements: str
external_user:
description:
- List of external users assigned to this group.
- Behaves identically to I(user) with respect to I(append) attribute.
- List entries can be in C(DOMAIN\\username) or SID format.
- Behaves identically to O(user) with respect to O(append) attribute.
- List entries can be in V(DOMAIN\\\\username) or SID format.
- Unless SIDs are provided, the module will always attempt to make changes even if the group already has all the users.
This is because only SIDs are returned by IPA query.
- I(external=true) is needed for this option to work.
- O(external=true) is needed for this option to work.
type: list
elements: str
version_added: 6.3.0