ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-22 21:00:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Update module docs to include new user/group control features, fix formatting on playbooks page.

Browse source
This commit is contained in:
Michael DeHaan 2012-03-31 12:08:28 -04:00
commit a879278713
8 changed files with 97 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

47
rst/modules.rst
View file

@ -177,6 +177,29 @@ Example action from Ansible :doc:`playbooks`::
git repo=git://foosball.example.org/path/to/repo.git dest=/srv/checkout version=release-0.22
group
`````
Adds or removes groups.
*name*:
* name of the group
*gid*:
* optional gid to set for the group
*state*:
* either 'absent', or 'present'. 'present' is the default.
To control members of the group, see the users resource.
Example action from Ansible :doc:`playbooks`::
group name=somegroup state=present
ohai
````
@ -327,6 +350,14 @@ Creates user accounts, manipulates existing user accounts, and removes user acco
* Optionally sets the user's primary group, takes a group name.
*groups*:
* Put the user in the specified groups, takes comma delimited group names.
*append*:
* If true, will only add additional groups to the user listed in 'groups', rather than making the user only be in those specified groups.
*shell*:
* Optionally sets the user's shell.
@ -337,17 +368,25 @@ Creates user accounts, manipulates existing user accounts, and removes user acco
*password*:
* Sets the user's password to this crypted value. Pass in a result from crypt. See the users
example in the github examples directory for what this looks like in a playbook.
* Sets the user's password to this crypted value. Pass in a result from crypt. See the users example in the github examples directory for what this looks like in a playbook.
*state*:
* Defaults to 'present'. When 'absent', the user account will be removed if present.
* Defaults to 'present'. When 'absent', the user account will be removed if present. Optionally additional removal behaviors can be set with the 'force' or 'remove' parameter values (see below).
*force*:
* When used with a state of 'absent', the behavior denoted in the 'userdel' manpage for --force is also used when removing the user. Value is 'yes' or 'no', default is 'no'.
*remove*:
* When used with a state of 'absent', the behavior denoted in the 'userdel' manpage for --remove is also used when removing the user. Value is 'yes' or 'no', default is 'no'.
Example action from Ansible :doc:`playbooks`::
user name=mdehaan comment=awesome passwd=awWxVV.JvmdHw createhome=yes
user name=mdehaan state=absent
user name=mdehaan groups=wheel,skynet
user name=mdehaan state=absent force=yes
.. _yum: