Add documentation on underlying tools in user module (#46455) (#46511)

(cherry picked from commit bcfdc37be0)
This commit is contained in:
Sam Doran 2018-10-08 15:13:52 -04:00 committed by Alicia Cozine
parent 8a4736d89d
commit 9f0f66137f
2 changed files with 11 additions and 0 deletions

View file

@ -0,0 +1,2 @@
bugfixes:
- user - add documentation on what underlying tools are used on each platform (https://github.com/ansible/ansible/issues/44266)

View file

@ -24,6 +24,13 @@ notes:
- For Windows targets, use the M(win_user) module instead.
- On SunOS platforms, the shadow file is backed up automatically since this module edits it directly.
On other platforms, the shadow file is backed up by the underlying tools used by this module.
- On macOS, this module uses C(dscl) to create, modify, and delete accounts. C(dseditgroup) is used to
modify group membership. Accounts are hidden from the login window by modifying
C(/Library/Preferences/com.apple.loginwindow.plist).
- On FreeBSD, this module uses C(pw useradd) and C(chpass) to create, C(pw usermod) and C(chpass) to modify,
C(pw userdel) remove, C(pw lock) to lock, and C(pw unlock) to unlock accounts.
- On all other platforms, this module uses C(useradd) to create, C(usermod) to modify, and
C(userdel) to remove accounts.
description:
- Manage user accounts and user attributes.
- For Windows targets, use the M(win_user) module instead.
@ -78,6 +85,8 @@ options:
- Optionally set the user's shell.
- On macOS, before version 2.5, the default shell for non-system users was /usr/bin/false.
Since 2.5, the default shell for non-system users on macOS is /bin/bash.
- On other operating systems, the default shell is determined by the underlying tool being
used. See Notes for details.
home:
description:
- Optionally set the user's home directory.