On this page
vertica_info – Gathers Vertica database facts
Synopsis
- Gathers Vertica database information.
- This module was called
vertica_factsbefore Ansible 2.9, returningansible_facts. Note that the vertica_info module no longer returnsansible_facts!
Aliases: vertica_facts
Requirements
The below requirements are needed on the host that executes this module.
- unixODBC
- pyodbc
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| cluster
-
|
Default:
"localhost"
|
Name of the cluster running the schema.
|
| db
-
|
Name of the database running the schema.
|
|
| login_password
-
|
The password used to authenticate with.
|
|
| login_user
-
|
Default:
"dbadmin"
|
The username used to authenticate with.
|
| port
-
|
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
dbadminaccount on the host. - This module uses
pyodbc, a Python ODBC database adapter. You must ensure thatunixODBCandpyodbcis installed on the host and properly configured. - Configuring
unixODBCfor Vertica requiresDriver = /opt/vertica/lib64/libverticaodbc.soto be added to theVerticasection of either/etc/odbcinst.inior$HOME/.odbcinst.iniand bothErrorMessagesPath = /opt/vertica/lib64andDriverManagerEncoding = UTF-16to be added to theDriversection of either/etc/vertica.inior$HOME/.vertica.ini.
Examples
- name: gathering vertica facts
vertica_info: db=db_name
register: result
- name: Print schemas
debug:
msg: "{{ result.vertica_schemas }}"
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Dariusz Owczarek (@dareko)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/vertica_info_module.html