Documentation

vertica_user - Adds or removes Vertica database users and assigns roles.

New in version 2.0.

Synopsis

  • Adds or removes Vertica database user and, optionally, assigns roles.
  • A user will not be removed until all the dependencies have been dropped.
  • In such a situation, if the module tries to remove the user it will fail and only remove roles granted to the user.

Options

parameter required default choices comments
cluster
 no localhost
Name of the Vertica cluster.
db
 no
Name of the Vertica database.
expired
 no
Sets the user's password expiration.
ldap
 no
Set to true if users are authenticated via LDAP.
The user will be created with password expired and set to $ldap$.
login_password
 no
The password used to authenticate with.
login_user
 no dbadmin
The username used to authenticate with.
name
 yes
Name of the user to add or remove.
password
 no
The user's password encrypted by the MD5 algorithm.
The password must be generated with the format "md5" + md5[password + username], resulting in a total of 35 characters. An easy way to do this is by querying the Vertica database with select 'md5'||md5('<user_password><user_name>').
port
 no 5433
Vertica cluster port to connect to.
profile
 no
Sets the user's profile.
resource_pool
 no
Sets the user's resource pool.
roles
 no
Comma separated list of roles to assign to the user.

aliases: role
state
 no present
  • present
  • absent
  • locked
Whether to create present, drop absent or lock locked a user.

Examples

- name: creating a new vertica user with password
  vertica_user: name=user_name password=md5<encrypted_password> db=db_name state=present

- name: creating a new vertica user authenticated via ldap with roles assigned
  vertica_user:
    name=user_name
    ldap=true
    db=db_name
    roles=schema_name_ro
    state=present

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.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

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