W3cubDocs

/Ansible

community.postgresql.postgresql_alter_system module – Change a PostgreSQL server configuration parameter

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

New in community.postgresql 3.13.0

Synopsis

  • Supports PostgreSQL 14 or later.
  • Allows to change a PostgreSQL server configuration parameter.
  • The module uses ALTER SYSTEM command and applies changes by reload server configuration.
  • Some parameters require PostgreSQL to restart. See the restart_required return value.

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: {}

login_db

string

Name of database to connect.

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"

param

string / required

Name of PostgreSQL server parameter.

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.

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"

trust_input

boolean

If false, check whether values of parameters are potentially dangerous.

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

Choices:

  • false
  • true ← (default)

value

string / required

Parameter value to set.

Specify the value in appropriate units!

For memory-related parameters of type integer, it is kB, MB, GB, and TB.

Use _RESET to run the ALTER SYSTEM RESET param which will remove a corresponding entry from postgresql.auto.conf. Always returns changed=True.

For boolean parameters, pass the "on" or "off" string.

Attributes

Attribute

Support

Description

check_mode

Support: full

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

Notes

Note

  • For some parameters restart of PostgreSQL server is required. See official documentation https://www.postgresql.org/docs/current/view-pg-settings.html.
  • 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_info

Gather information about PostgreSQL servers.

PostgreSQL server configuration

General information about PostgreSQL server configuration.

PostgreSQL view pg_catalog.pg_settings reference

Complete reference of the pg_catalog.pg_settings view documentation.

PostgreSQL ALTER SYSTEM command reference

Complete reference of the ALTER SYSTEM command documentation.

Examples

- name: Set work_mem
  community.postgresql.postgresql_alter_system:
    param: work_mem
    value: 1024

- name: Reset work_mem
  community.postgresql.postgresql_alter_system:
    param: work_mem
    value: _RESET

- name: Set TimeZone parameter (careful, case sensitive)
  community.postgresql.postgresql_alter_system:
    param: TimeZone
    value: 'Europe/Paris'

Return Values

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

Key

Description

attrs

dictionary

Parameter attributes from pg_catalog.pg_settings that do not change.

Returned: success

Sample: {"boot_val": 4096, "context": "user", "max_val": 2147483647, "min_val": 64, "unit": "kB", "vartype": "integer"}

diff

dictionary

A dictionary the before and after keys.

Each key contains a dictionary of key-value pairs representing changeable columns and values for the parameter obtained from the pg_catalog.pg_settings relation.

Returned: success

Sample: {"after": {"pending_restart": false, "setting": 8192}, "before": {"pending_restart": false, "setting": 4096}}

executed_queries

list / elements=string

List of executed queries except SELECTs.

In the check mode, returns a query that would be supposed to get executed in the real mode.

Returned: success

Sample: ["ALTER SYSTEM SET shared_preload_libraries = ''"]

restart_required

boolean

Indicates if restart of PostgreSQL is required or not.

Added here for convenience. Can be also determined from the diff[“after”][“pending_restart”] return value.

Returned: success

Sample: true

Authors

  • Andrew Klychkov (@Andersson007)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/postgresql/postgresql_alter_system_module.html