community.postgresql.postgresql_subscription module – Add, update, or remove PostgreSQL subscription

Note

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

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_subscription.

New in community.postgresql 0.2.0

Synopsis

• Add, update, or remove PostgreSQL subscription.

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.
cascade boolean	Drop subscription dependencies. Has effect with state=absent only. Ignored when state is not absent. Choices: false ← (default) true
comment string added in community.postgresql 3.3.0	Sets a comment on the subscription. To reset the comment, pass an empty string.
connect_params dictionary added in community.postgresql 2.3.0	Any additional parameters to be passed to libpg. These parameters take precedence. Default: {}
connparams dictionary	The connection dict param-value to connect to the publisher. For more information see https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING. Ignored when state is not present. Ignored when an existing subscription’s connection parameters are not available from the server (such as in CloudSQL).
login_db aliases: db string / required	Name of the database to connect to and where the subscription state will be changed. The db alias is deprecated and will be removed in version 5.0.0.
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 string / required	Name of the subscription to add, update, or remove.
owner string	Subscription owner. If owner is not defined, the owner will be set as login_user or session_role. Ignored when state is not present.
port aliases: login_port integer	Database port to connect to. Default: 5432
publications list / elements=string	The publication names on the publisher to use for the subscription. Ignored when state is not present.
session_role string added in community.postgresql 0.2.0	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.
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 subscription state. present implies that if name subscription doesn’t exist, it will be created. absent implies that if name subscription exists, it will be removed. refresh implies that if name subscription exists, it will be refreshed. Fetch missing table information from publisher. Always returns ``changed`` is ``True``. This will start replication of tables that were added to the subscribed-to publications since the last invocation of REFRESH PUBLICATION or since CREATE SUBSCRIPTION. The existing data in the publications that are being subscribed to should be copied once the replication starts. For more information about refresh see https://www.postgresql.org/docs/current/sql-altersubscription.html. Choices: "absent" "present" ← (default) "refresh"
subsparams dictionary	Dictionary of optional parameters for a subscription, e.g. copy_data, enabled, create_slot, etc. For update the subscription allowed keys are enabled, slot_name, synchronous_commit, publication_name. See available parameters to create a new subscription on https://www.postgresql.org/docs/current/sql-createsubscription.html. Ignored when state is not present.
trust_input boolean added in community.postgresql 0.2.0	If false, check whether values of parameters name, publications, owner, session_role, connparams, subsparams are potentially dangerous. It makes sense to use true only when SQL injections via the parameters 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

• PostgreSQL version must be 10 or greater.

• 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

community.postgresql.postgresql_publication

Add, update, or remove PostgreSQL publication.

community.postgresql.postgresql_info

Gather information about PostgreSQL servers.

CREATE SUBSCRIPTION reference

Complete reference of the CREATE SUBSCRIPTION command documentation.

ALTER SUBSCRIPTION reference

Complete reference of the ALTER SUBSCRIPTION command documentation.

DROP SUBSCRIPTION reference

Complete reference of the DROP SUBSCRIPTION command documentation.

Examples

- name: >
    Create acme subscription in mydb database using acme_publication and
    the following connection parameters to connect to the publisher.
    Set the subscription owner as alice.
  community.postgresql.postgresql_subscription:
    login_db: mydb
    name: acme
    state: present
    publications: acme_publication
    owner: alice
    connparams:
      host: 127.0.0.1
      port: 5432
      user: repl
      password: replpass
      dbname: mydb
    comment: Made by Ansible

- name: Assuming that acme subscription exists, try to change conn parameters
  community.postgresql.postgresql_subscription:
    login_db: mydb
    name: acme
    connparams:
      host: 127.0.0.1
      port: 5432
      user: repl
      password: replpass
      connect_timeout: 100

- name: Refresh acme publication
  community.postgresql.postgresql_subscription:
    db: mydb
    name: acme
    state: refresh

- name: Drop acme subscription from mydb with dependencies (cascade=true)
  community.postgresql.postgresql_subscription:
    login_db: mydb
    name: acme
    state: absent
    cascade: true

- name: Assuming that acme subscription exists and enabled, disable the subscription
  community.postgresql.postgresql_subscription:
    login_db: mydb
    name: acme
    state: present
    subsparams:
      enabled: false

Return Values

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

Key	Description
exists boolean	Flag indicates the subscription exists or not at the end of runtime. Returned: success Sample: true
final_state dictionary	Subscription configuration at the end of runtime. Returned: success Sample: {"conninfo": {}, "enabled": true, "owner": "postgres", "slotname": "test", "synccommit": true}
initial_state dictionary	Subscription configuration at the beginning of runtime. Returned: success Sample: {"conninfo": {}, "enabled": true, "owner": "postgres", "slotname": "test", "synccommit": true}
name string	Name of the subscription. Returned: success Sample: "acme"
queries string	List of executed queries. Returned: success Sample: "['DROP SUBSCRIPTION \"mysubscription\"']"

Authors

• Andrew Klychkov (@Andersson007)

Collection links

• Issue Tracker
• Repository (Sources)
• Report an issue
• Communication