community.postgresql.postgresql_slot module – Add or remove replication slots from a PostgreSQL database

Note

This module is part of the community.postgresql collection (version 3.8.0).

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.postgresql. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.postgresql.postgresql_slot.

Synopsis

  • Add or remove physical or logical replication slots from a PostgreSQL database.

Requirements

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

  • psycopg2 >= 2.5.1

Parameters

Parameter

Comments

ca_cert

aliases: ssl_rootcert

string

Specifies the name of a file containing SSL certificate authority (CA) certificate(s).

If the file exists, the server’s certificate will be verified to be signed by one of these authorities.

connect_params

dictionary

added in community.postgresql 2.3.0

Any additional parameters to be passed to libpg.

These parameters take precedence.

Default: {}

db

aliases: login_db

string

Name of database to connect to.

immediately_reserve

boolean

Optional parameter that when true specifies that the LSN for this replication slot be reserved immediately, otherwise the default, false, specifies that the LSN is reserved on the first connection from a streaming replication client.

Is available from PostgreSQL version 9.6.

Uses only with slot_type=physical.

Mutually exclusive with slot_type=logical.

Choices:

  • false ← (default)

  • true

login_host

aliases: host

string

Host running the database.

If you have connection issues when using localhost, try to use 127.0.0.1 instead.

Default: ""

login_password

string

The password this module should use to establish its PostgreSQL session.

Default: ""

login_unix_socket

aliases: unix_socket

string

Path to a Unix domain socket for local connections.

Default: ""

login_user

aliases: login

string

The username this module should use to establish its PostgreSQL session.

Default: "postgres"

name

aliases: slot_name

string / required

Name of the replication slot to add or remove.

output_plugin

string

All logical slots must indicate which output plugin decoder they’re using.

This parameter does not apply to physical slots.

It will be ignored with slot_type=physical.

Default: "test_decoding"

port

aliases: login_port

integer

Database port to connect to.

Default: 5432

session_role

string

Switch to session_role after connecting. The specified session_role must be a role that the current login_user is a member of.

Permissions checking for SQL commands is carried out as though the session_role were the one that had logged in originally.

slot_type

string

Slot type.

Choices:

  • "logical"

  • "physical" ← (default)

ssl_cert

path

added in community.postgresql 2.4.0

Specifies the file name of the client SSL certificate.

ssl_key

path

added in community.postgresql 2.4.0

Specifies the location for the secret key used for the client certificate.

ssl_mode

string

Determines whether or with what priority a secure SSL TCP/IP connection will be negotiated with the server.

See https://www.postgresql.org/docs/current/static/libpq-ssl.html for more information on the modes.

Default of prefer matches libpq default.

Choices:

  • "allow"

  • "disable"

  • "prefer" ← (default)

  • "require"

  • "verify-ca"

  • "verify-full"

state

string

The slot state.

state=present implies the slot must be present in the system.

state=absent implies the groups must be revoked from target_roles.

Choices:

  • "absent"

  • "present" ← (default)

trust_input

boolean

added in community.postgresql 0.2.0

If false, check the value of session_role is potentially dangerous.

It makes sense to use false only when SQL injections via session_role are possible.

Choices:

  • false

  • true ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

Notes

Note

  • Physical replication slots were introduced to PostgreSQL with version 9.4, while logical replication slots were added beginning with version 10.0.

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

  • To avoid “Peer authentication failed for user postgres” error, use postgres user as a become_user.

  • This module uses psycopg, a Python PostgreSQL database adapter. You must ensure that psycopg2 >= 2.5.1 or psycopg3 >= 3.1.8 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 python3-psycopg2 packages on the remote host before using this module.

See Also

See also

PostgreSQL pg_replication_slots view reference

Complete reference of the PostgreSQL pg_replication_slots view.

PostgreSQL streaming replication protocol reference

Complete reference of the PostgreSQL streaming replication protocol documentation.

PostgreSQL logical replication protocol reference

Complete reference of the PostgreSQL logical replication protocol documentation.

Examples

- name: Create physical_one physical slot if doesn't exist
  become_user: postgres
  community.postgresql.postgresql_slot:
    slot_name: physical_one
    db: ansible

- name: Remove physical_one slot if exists
  become_user: postgres
  community.postgresql.postgresql_slot:
    slot_name: physical_one
    db: ansible
    state: absent

- name: Create logical_one logical slot to the database acme if doesn't exist
  community.postgresql.postgresql_slot:
    name: logical_slot_one
    slot_type: logical
    state: present
    output_plugin: custom_decoder_one
    db: "acme"

- name: Remove logical_one slot if exists from the cluster running on another host and non-standard port
  community.postgresql.postgresql_slot:
    name: logical_one
    login_host: mydatabase.example.org
    port: 5433
    login_user: ourSuperuser
    login_password: thePassword
    state: absent

Return Values

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

Key

Description

name

string

Name of the slot.

Returned: success

Sample: "physical_one"

queries

string

List of executed queries.

Returned: success

Sample: "[\"SELECT pg_create_physical_replication_slot('physical_one', False, False)\"]"

Authors

  • John Scalia (@jscalia)

  • Andrew Klychkov (@Andersson007)

  • Thomas O’Donnell (@andytom)