ansible.postgresql_user(3) - Linux man page

Name

postgresql_user - Adds or removes a users (roles) from a PostgreSQL database.

Description

Add or remove PostgreSQL users (roles) from a remote host and, optionally, grant the users access to an existing database or tables.

The fundamental function of the module is to create, or delete, roles from a PostgreSQL cluster. Privilege assignment, or removal, is an optional step, which works on one database at a time. This allows for the module to be called several times in the same module to modify the permissions on different databases, or to grant permissions to already existing users.

A user cannot be removed until all the privileges have been stripped from the user. In such situation, if the module tries to remove the user it will fail. To avoid this from happening the fail_on_user option signals the module to try to remove the user, but if not possible keep going; the module will report if changes happened and separately if the user was removed or not.

Options

db

name of database where permissions will be granted

fail_on_user

if yes, fail when user can't be removed. Otherwise just log and continue Choices: yes,no. (default: yes

login_host

Host running PostgreSQL. (default: localhost)

login_password

Password used to authenticate with PostgreSQL

login_user

User (role) used to authenticate with PostgreSQL (default: postgres)

name

name of the user (role) to add or remove(required)

password

set the user's password(required)

priv

PostgreSQL privileges string in the format: table:priv1,priv2

role_attr_flags

PostgreSQL role attributes string in the format: CREATEDB,CREATEROLE,SUPERUSER Choices: [NO]SUPERUSER,[NO]CREATEROLE,[NO]CREATEUSER,[NO]CREATEDB,[NO]INHERIT,[NO]LOGIN,[NO]REPLICATION.

state

The database state Choices: present,absent. (default: present)."

Notes

The default authentication assumes that you are either logging in as or sudo'ing to the postgres account on the host.

This module uses psycopg2, a Python PostgreSQL database adapter. You must ensure that psycopg2 is installed on the host before using this module. If the remote host is the PostgreSQL server (which is the default case), then PostgreSQL must also be installed on the remote host. For Ubuntu-based systems, install the postgresql, libpq-dev, and python-psycopg2 packages on the remote host before using this module.

Examples

Create django user and grant access to database and products table

postgresql_user: db=acme user=django password=ceec4eif7ya priv=CONNECT/products:ALL

postgresql_user: user=rails password=secret role_attr_flags=CREATEDB,NOSUPERUSER

postgresql_user: db=acme user=test priv=ALL/products:ALL state=absent fail_on_user=no

postgresql_user: db=test user=test priv=ALL state=absent

INSERT,UPDATE/table:SELECT/anothertable:ALL

Author

Lorin Hochstein

See Also

ansible(1), http://ansible.github.com/modules.html#postgresql-user