Documentation

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.

            Note

            This module uses pyodbc, a Python ODBC database adapter. You must ensure that unixODBC and pyodbc is installed on the host and properly configured.

            Note

            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.

            This is an Extras Module

            For more information on what this means please read Extras Modules

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