postgresql_membership – Add or remove PostgreSQL roles from groups

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values
• Status

Synopsis

• Adds or removes PostgreSQL roles from groups (other roles) https://www.postgresql.org/docs/current/role-membership.html.
• Users are roles with login privilege (see https://www.postgresql.org/docs/current/role-attributes.html for more information).
• Groups are PostgreSQL roles usually without LOGIN privelege.
• Common use case:
• 1. add a new group (groups) by postgresql_user module https://docs.ansible.com/ansible/latest/modules/postgresql_user_module.html with role_attr_flags=NOLOGIN
• 2. grant them desired privileges by postgresql_privs module https://docs.ansible.com/ansible/latest/modules/postgresql_privs_module.html
• 3. add desired PostgreSQL users to the new group (groups) by this module

Requirements

The below requirements are needed on the host that executes this module.

• psycopg2

Parameters

Notes

Examples

- name: Grant role read_only to alice and bob
  postgresql_membership:
    group: read_only
    target_roles:
    - alice
    - bob
    state: present

# you can also use target_roles: alice,bob,etc to pass the role list

- name: Revoke role read_only and exec_func from bob. Ignore if roles don't exist
  postgresql_membership:
    groups:
    - read_only
    - exec_func
    target_role: bob
    fail_on_role: no
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]
• This module is maintained by the Ansible Community. [community]

Authors

• Andrew Klychkov (@Andersson007)