community.general.vertica_info – Gathers Vertica database facts.

Note

This plugin is part of the community.general collection (version 2.2.0).

To install it use: ansible-galaxy collection install community.general.

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

Synopsis

  • Gathers Vertica database information.

  • This module was called vertica_facts before Ansible 2.9, returning ansible_facts. Note that the community.general.vertica_info module no longer returns ansible_facts!

Requirements

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

  • unixODBC

  • pyodbc

Parameters

Parameter Choices/Defaults Comments
cluster
string
Default:
"localhost"
Name of the cluster running the schema.
db
string
Name of the database running the schema.
login_password
string
The password used to authenticate with.
login_user
string
Default:
"dbadmin"
The username used to authenticate with.
port
string
Default:
5433
Database port to connect to.

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 are 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: Gathering vertica facts
  community.general.vertica_info: db=db_name
  register: result

- name: Print schemas
  ansible.builtin.debug:
    msg: "{{ result.vertica_schemas }}"

Authors

  • Dariusz Owczarek (@dareko)