{ "description": [ "Manage user accounts and user attributes." ], "module": "user", "docuri": "user", "requirements": [ "useradd", "userdel", "usermod" ], "author": "Stephen Fromm", "filename": "library/user", "version_added": 0.2, "short_description": "Manage user accounts", "now_date": "2012-10-09", "options": { "comment": { "required": false, "description": [ "Optionally sets the description (aka I(GECOS)) of user account." ] }, "shell": { "required": false, "description": [ "Optionally set the user's shell." ] }, "force": { "default": "no", "required": false, "description": [ "When used with I(state=absent), behavior is as with I(userdel --force)." ], "choices": [ true, false ] }, "name": { "required": true, "description": [ "Name of the user to create, remove or modify." ] }, "createhome": { "default": "yes", "required": false, "description": [ "Unless set to I(no), a home directory will be made for the user when the account is created." ], "choices": [ true, false ] }, "system": { "default": "no", "required": false, "description": [ "When creating an account, setting this to I(yes) makes the user a system account. This setting cannot be changed on existing users." ], "choices": [ true, false ] }, "remove": { "default": "no", "required": false, "description": [ "When used with I(state=absent), behavior is as with I(userdel --remove)." ], "choices": [ true, false ] }, "state": { "default": "present", "required": false, "description": [ "Whether the account should exist. When I(absent), removes the user account." ], "choices": [ "present", "absent" ] }, "groups": { "required": false, "description": [ "Puts the user in this comma-delimited list of groups." ] }, "home": { "required": false, "description": [ "Optionally set the user's home directory." ] }, "group": { "required": false, "description": [ "Optionally sets the user's primary group (takes a group name)." ] }, "password": { "required": false, "description": [ "Optionally set the user's password to this crypted value. See the user example in the github examples directory for what this looks like in a playbook." ] }, "append": { "required": false, "description": [ "If I(yes), will only add groups, not set them to just the list in I(groups)." ] }, "uid": { "required": false, "description": [ "Optionally sets the I(UID) of the user." ] } }, "ansible_version": "0.8" }