community.general.vertica_role module – Adds or removes Vertica database roles and assigns roles to them

Note

This module is part of the community.general collection (version 6.3.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.general. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: community.general.vertica_role.

Synopsis

  • Adds or removes Vertica database role and, optionally, assign other roles.

Requirements

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

  • unixODBC

  • pyodbc

Parameters

Parameter

Comments

assigned_roles

aliases: assigned_role

string

Comma separated list of roles to assign to the role.

cluster

string

Name of the Vertica cluster.

Default: "localhost"

db

string

Name of the Vertica database.

login_password

string

The password used to authenticate with.

login_user

string

The username used to authenticate with.

Default: "dbadmin"

port

string

Vertica cluster port to connect to.

Default: "5433"

role

aliases: name

string / required

Name of the role to add or remove.

state

string

Whether to create present, drop absent or lock locked a role.

Choices:

  • "present" ← (default)

  • "absent"

Notes

Note

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

  • This module uses pyodbc, a Python ODBC database adapter. You must ensure that unixODBC and pyodbc is installed on the host and properly configured.

  • Configuring unixODBC for Vertica requires Driver = /opt/vertica/lib64/libverticaodbc.so to be added to the Vertica section of either /etc/odbcinst.ini or $HOME/.odbcinst.ini and both ErrorMessagesPath = /opt/vertica/lib64 and DriverManagerEncoding = UTF-16 to be added to the Driver section of either /etc/vertica.ini or $HOME/.vertica.ini.

Examples

- name: Creating a new vertica role
  community.general.vertica_role: name=role_name db=db_name state=present

- name: Creating a new vertica role with other role assigned
  community.general.vertica_role: name=role_name assigned_role=other_role_name state=present

Authors

  • Dariusz Owczarek (@dareko)