community.general.vertica_info module – Gathers Vertica database facts
Note
This module is part of the community.general collection (version 8.6.4).
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_info
.
Synopsis
Gathers Vertica database information.
Aliases: database.vertica.vertica_info
Requirements
The below requirements are needed on the host that executes this module.
unixODBC
pyodbc
Parameters
Parameter |
Comments |
---|---|
Name of the cluster running the schema. Default: |
|
Name of the database running the schema. |
|
The password used to authenticate with. |
|
The username used to authenticate with. Default: |
|
Database port to connect to. Default: |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
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 thatunixODBC
andpyodbc
are installed on the host and properly configured.Configuring
unixODBC
for Vertica requiresDriver = /opt/vertica/lib64/libverticaodbc.so
to be added to theVertica
section of either/etc/odbcinst.ini
or$HOME/.odbcinst.ini
and bothErrorMessagesPath = /opt/vertica/lib64
andDriverManagerEncoding = UTF-16
to be added to theDriver
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 }}"