Document group module return values (#65294)
* Document group module return values, based on iterating over the combinations of `state` and `system` with existent and non-existent groups.
This commit is contained in:
parent
f89db2af99
commit
d906fdeba2
1 changed files with 23 additions and 0 deletions
|
@ -74,6 +74,29 @@ EXAMPLES = '''
|
|||
state: present
|
||||
'''
|
||||
|
||||
RETURN = r'''
|
||||
gid:
|
||||
description: Group ID of the group.
|
||||
returned: When C(state) is 'present'
|
||||
type: int
|
||||
sample: 1001
|
||||
name:
|
||||
description: Group name
|
||||
returned: always
|
||||
type: str
|
||||
sample: users
|
||||
state:
|
||||
description: Whether the group is present or not
|
||||
returned: always
|
||||
type: str
|
||||
sample: 'absent'
|
||||
system:
|
||||
description: Whether the group is a system group or not
|
||||
returned: When C(state) is 'present'
|
||||
type: bool
|
||||
sample: False
|
||||
'''
|
||||
|
||||
import grp
|
||||
|
||||
from ansible.module_utils._text import to_bytes
|
||||
|
|
Loading…
Add table
Reference in a new issue