Note
This plugin is part of the community.general collection (version 3.8.1).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.general.
To use it in a playbook, specify: community.general.htpasswd.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| attributes string added in 2.3 of ansible.builtin | The attributes the resulting file or directory should have. To get supported flags look at the man page for chattr on the target system. This string should contain the attributes in the same order as the one displayed by lsattr. The = operator is assumed as default, otherwise + or - operators need to be included in the string.aliases: attr | |
| create boolean |
| Used with state=present. If specified, the file will be created if it does not already exist. If set to "no", will fail if the file does not exist |
| crypt_scheme string | Default: "apr_md5_crypt" | Encryption scheme to be used. As well as the four choices listed here, you can also use any other hash supported by passlib, such as md5_crypt and sha256_crypt, which are linux passwd hashes. If you do so the password file will not be compatible with Apache or Nginx Some of the available choices might be: apr_md5_crypt, des_crypt, ldap_sha1, plaintext
|
| group string | Name of the group that should own the file/directory, as would be fed to chown. | |
| mode raw | The permissions the resulting file or directory should have. For those used to /usr/bin/chmod remember that modes are actually octal numbers. You must either add a leading zero so that Ansible's YAML parser knows it is an octal number (like 0644 or 01777) or quote it (like '644' or '1777') so Ansible receives a string and can do its own conversion from string into number.Giving Ansible a number without following one of these rules will end up with a decimal number which will have unexpected results. As of Ansible 1.8, the mode may be specified as a symbolic mode (for example, u+rwx or u=rw,g=r,o=r).If mode is not specified and the destination file does not exist, the default umask on the system will be used when setting the mode for the newly created file.If mode is not specified and the destination file does exist, the mode of the existing file will be used.Specifying mode is the best way to ensure files are created with the correct permissions. See CVE-2020-1736 for further details. | |
| name string / required | User name to add or remove aliases: username | |
| owner string | Name of the user that should own the file/directory, as would be fed to chown. | |
| password string | Password associated with user. Must be specified if user does not exist yet. | |
| path path / required | Path to the file that contains the usernames and passwords aliases: dest, destfile | |
| selevel string | The level part of the SELinux file context. This is the MLS/MCS attribute, sometimes known as the range.When set to _default, it will use the level portion of the policy if available. | |
| serole string | The role part of the SELinux file context. When set to _default, it will use the role portion of the policy if available. | |
| setype string | The type part of the SELinux file context. When set to _default, it will use the type portion of the policy if available. | |
| seuser string | The user part of the SELinux file context. By default it uses the system policy, where applicable.When set to _default, it will use the user portion of the policy if available. | |
| state string |
| Whether the user entry should be present or not |
| unsafe_writes boolean added in 2.2 of ansible.builtin |
| Influence when to use atomic operation to prevent data corruption or inconsistent reads from the target file. By default this module uses atomic operations to prevent data corruption or inconsistent reads from the target files, but sometimes systems are configured or just broken in ways that prevent this. One example is docker mounted files, which cannot be updated atomically from inside the container and can only be written in an unsafe manner. This option allows Ansible to fall back to unsafe methods of updating files when atomic operations fail (however, it doesn't force Ansible to perform unsafe writes). IMPORTANT! Unsafe writes are subject to race conditions and can lead to data corruption. |
Note
- name: Add a user to a password file and ensure permissions are set
community.general.htpasswd:
path: /etc/nginx/passwdfile
name: janedoe
password: '9s36?;fyNp'
owner: root
group: www-data
mode: 0640
- name: Remove a user from a password file
community.general.htpasswd:
path: /etc/apache2/passwdfile
name: foobar
state: absent
- name: Add a user to a password file suitable for use by libpam-pwdfile
community.general.htpasswd:
path: /etc/mail/passwords
name: alex
password: oedu2eGh
crypt_scheme: md5_crypt
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/htpasswd_module.html