community / community.general / 1.3.14 / module / postgresql_pg_hba Add, remove or modify a rule in a pg_hba file Authors: Sebastiaan Mannem (@sebasmannem)community.general.postgresql_pg_hba (1.3.14) — module
Install with ansible-galaxy collection install community.general:==1.3.14
collections: - name: community.general version: 1.3.14
The fundamental function of the module is to create, or delete lines in pg_hba files.
The lines in the file should be in a typical pg_hba form and lines should be unique per key (type, databases, users, source). If they are not unique and the SID is 'the one to change', only one for C(state=present) or none for C(state=absent) of the SID's will remain.
- name: Grant users joe and simon access to databases sales and logistics from ipv6 localhost ::1/128 using peer authentication. community.general.postgresql_pg_hba: dest: /var/lib/postgres/data/pg_hba.conf contype: host users: joe,simon source: ::1 databases: sales,logistics method: peer create: true
- name: Grant user replication from network 192.168.0.100/24 access for replication with client cert authentication. community.general.postgresql_pg_hba: dest: /var/lib/postgres/data/pg_hba.conf contype: host users: replication source: 192.168.0.100/24 databases: replication method: cert
- name: Revoke access from local user mary on database mydb. community.general.postgresql_pg_hba: dest: /var/lib/postgres/data/pg_hba.conf contype: local users: mary databases: mydb state: absent
dest: description: - Path to C(pg_hba) file to modify. required: true type: path mode: description: - The permissions the resulting filesystem object should have. - For those used to I(/usr/bin/chmod) remember that modes are actually octal numbers. You must give Ansible enough information to parse them correctly. For consistent results, quote octal numbers (for example, V('644') or V('1777')) so Ansible receives a string and can do its own conversion from string into number. Adding a leading zero (for example, V(0755)) works sometimes, but can fail in loops and some other circumstances. - Giving Ansible a number without following either 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, V(u+rwx) or V(u=rw,g=r,o=r)). - If O(mode) is not specified and the destination filesystem object B(does not) exist, the default C(umask) on the system will be used when setting the mode for the newly created filesystem object. - If O(mode) is not specified and the destination filesystem object B(does) exist, the mode of the existing filesystem object will be used. - Specifying O(mode) is the best way to ensure filesystem objects are created with the correct permissions. See CVE-2020-1736 for further details. type: raw group: description: - Name of the group that should own the filesystem object, as would be fed to I(chown). - When left unspecified, it uses the current group of the current user unless you are root, in which case it can preserve the previous ownership. type: str order: choices: - sdu - sud - dsu - dus - usd - uds default: sdu description: - The entries will be written out in a specific order. With this option you can control by which field they are ordered first, second and last. s=source, d=databases, u=users. This option is deprecated since 2.9 and will be removed in community.general 3.0.0. Sortorder is now hardcoded to sdu. type: str owner: description: - Name of the user that should own the filesystem object, as would be fed to I(chown). - When left unspecified, it uses the current user unless you are root, in which case it can preserve the previous ownership. - Specifying a numeric username will be assumed to be a user ID and not a username. Avoid numeric usernames to avoid this confusion. type: str state: choices: - absent - present default: present description: - The lines will be added/modified when C(state=present) and removed when C(state=absent). type: str users: default: all description: - Users this line applies to. type: str backup: default: false description: - If set, create a backup of the C(pg_hba) file before it is modified. The location of the backup is returned in the (backup) variable by this module. type: bool create: default: false description: - Create an C(pg_hba) file if none exists. - When set to false, an error is raised when the C(pg_hba) file doesn't exist. type: bool method: choices: - cert - gss - ident - krb5 - ldap - md5 - pam - password - peer - radius - reject - scram-sha-256 - sspi - trust default: md5 description: - Authentication method to be used. type: str serole: description: - The role part of the SELinux filesystem object context. - When set to V(_default), it will use the C(role) portion of the policy if available. type: str setype: description: - The type part of the SELinux filesystem object context. - When set to V(_default), it will use the C(type) portion of the policy if available. type: str seuser: description: - The user part of the SELinux filesystem object context. - By default it uses the V(system) policy, where applicable. - When set to V(_default), it will use the C(user) portion of the policy if available. type: str address: aliases: - source - src default: samehost description: - The source address/net where the connections could come from. - Will not be used for entries of I(type)=C(local). - You can also use keywords C(all), C(samehost), and C(samenet). type: str contype: choices: - local - host - hostnossl - hostssl description: - Type of the rule. If not set, C(postgresql_pg_hba) will only return contents. type: str netmask: description: - The netmask of the source address. type: str options: description: - Additional options for the authentication I(method). type: str selevel: description: - The level part of the SELinux filesystem object context. - This is the MLS/MCS attribute, sometimes known as the C(range). - When set to V(_default), it will use the C(level) portion of the policy if available. type: str databases: default: all description: - Databases this line applies to. type: str attributes: aliases: - attr description: - The attributes the resulting filesystem object should have. - To get supported flags look at the man page for I(chattr) on the target system. - This string should contain the attributes in the same order as the one displayed by I(lsattr). - The C(=) operator is assumed as default, otherwise C(+) or C(-) operators need to be included in the string. type: str version_added: '2.3' version_added_collection: ansible.builtin backup_file: description: - Write backup to a specific backupfile rather than a temp file. type: str unsafe_writes: default: false description: - Influence when to use atomic operation to prevent data corruption or inconsistent reads from the target filesystem object. - By default this module uses atomic operations to prevent data corruption or inconsistent reads from the target filesystem objects, but sometimes systems are configured or just broken in ways that prevent this. One example is docker mounted filesystem objects, 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 filesystem objects 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. type: bool version_added: '2.2' version_added_collection: ansible.builtin
backup_file: description: File that the original pg_hba file was backed up to returned: changed sample: /tmp/pg_hba_jxobj_p type: str msgs: description: List of textual messages what was done returned: always sample: msgs: - Removing - Changed - Writing type: list pg_hba: description: List of the pg_hba rules as they are configured in the specified hba file returned: always sample: pg_hba: - db: all method: md5 src: samehost type: host usr: all type: list