Optionally sets the description (aka GECOS) of user account.
Unless set to
(added in 1.9)
An expiry time for the user in epoch, it will be ignored on platforms that do not support this. Currently supported on Linux and FreeBSD.
When used with
Whether to generate a SSH key for the user in question. This will not overwrite an existing SSH key.
Optionally sets the user's primary group (takes a group name).
Puts the user in list of groups. When set to the empty string ('groups='), the user is removed from all groups except the primary group.
Before version 2.3, the only input format allowed was a 'comma separated string', now it should be able to accept YAML lists also.
Optionally set the user's home directory.
Optionally sets the user's login class for FreeBSD, OpenBSD and NetBSD systems.
If set to
Name of the user to create, remove or modify.
Optionally when used with the -u option, this option allows to change the user ID to a non-unique value.
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. See http://docs.ansible.com/ansible/faq.html#how-do-i-generate-crypted-passwords-for-the-user-module for details on various ways to generate these password values. Note on Darwin system, this value has to be cleartext. Beware of security issues.
When used with
(added in 2.1)
Optionally sets the seuser type (user_u) on selinux enabled systems.
Optionally set the user's shell.
(added in 2.0)
Optionally set a home skeleton directory. Requires createhome option!
||no||default set by ssh-keygen|
Optionally specify number of bits in SSH key to create.
||no||ansible-generated on $HOSTNAME|
Optionally define the comment for the SSH key.
Optionally specify the SSH key filename. If this is a relative filename then it will be relative to the user's home directory.
Set a passphrase for the SSH key. If no passphrase is provided, the SSH key will default to having no passphrase.
Optionally specify the type of SSH key to generate. Available SSH key types will depend on implementation present on target host.
Whether the account should exist or not, taking action if the state is different from what is stated.
When creating an account, setting this to
Optionally sets the UID of the user.
(added in 1.3)
# Add the user 'johnd' with a specific uid and a primary group of 'admin' - user: name: johnd comment: "John Doe" uid: 1040 group: admin # Add the user 'james' with a bash shell, appending the group 'admins' and 'developers' to the user's groups - user: name: james shell: /bin/bash groups: admins,developers append: yes # Remove the user 'johnd' - user: name: johnd state: absent remove: yes # Create a 2048-bit SSH key for user jsmith in ~jsmith/.ssh/id_rsa - user: name: jsmith generate_ssh_key: yes ssh_key_bits: 2048 ssh_key_file: .ssh/id_rsa # added a consultant whose account you want to expire - user: name: james18 shell: /bin/zsh groups: developers expires: 1422403387
There are specific requirements per platform on user management utilities. However they generally come pre-installed with the system and Ansible will require they are present at runtime. If they are not, a descriptive error message will be shown.
This module is flagged as stableinterface which means that the maintainers for this module guarantee that the no backward incompatible interface changes will be made.