Docs4dev
Docs
ansible / 2.4 / vertica_facts_module.html

vertica_facts - Gathers Vertica database facts.

New in version 2.0.

Synopsis

  • Gathers Vertica database facts.

Requirements (on host that executes module)

  • unixODBC
  • pyodbc

Options

parameter required default choices comments
cluster
 no localhost
Name of the cluster running the schema.
db
 no
Name of the database running the schema.
login_password
 no
The password used to authenticate with.
login_user
 no dbadmin
The username used to authenticate with.
port
 no 5433
Database port to connect to.

Examples

- name: gathering vertica facts
  vertica_facts: db=db_name

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_facts_module.html