Docs4dev
Docs
ansible / 2.4 / vertica_role_module.html

vertica_role - Adds or removes Vertica database roles and assigns roles to them.

New in version 2.0.

Synopsis

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

Requirements (on host that executes module)

  • unixODBC
  • pyodbc

Options

parameter required default choices comments
assigned_roles
 no
Comma separated list of roles to assign to the role.
aliases: assigned_role
cluster
 no localhost
Name of the Vertica cluster.
db
 no
Name of the Vertica database.
login_password
 no
The password used to authenticate with.
login_user
 no dbadmin
The username used to authenticate with.
name
 yes
Name of the role to add or remove.
port
 no 5433
Vertica cluster port to connect to.
state
 no present
  • present
  • absent
Whether to create present, drop absent or lock locked a role.

Examples

- name: creating a new vertica role
  vertica_role: name=role_name db=db_name state=present

- name: creating a new vertica role with other role assigned
  vertica_role: name=role_name assigned_role=other_role_name state=present

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.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/vertica_role_module.html