vertica_role – Adds or removes Vertica database roles and assigns roles to them¶
New in version 2.0.
Synopsis¶
Adds or removes Vertica database role and, optionally, assign other roles.
Requirements¶
The below requirements are needed on the host that executes this module.
unixODBC
pyodbc
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
assigned_roles
-
|
Comma separated list of roles to assign to the role.
aliases: assigned_role |
|
cluster
-
|
Default: "localhost"
|
Name of the Vertica cluster.
|
db
-
|
Name of the Vertica database.
|
|
login_password
-
|
The password used to authenticate with.
|
|
login_user
-
|
Default: "dbadmin"
|
The username used to authenticate with.
|
name
-
/ required
|
Name of the role to add or remove.
|
|
port
-
|
Default: 5433
|
Vertica cluster port to connect to.
|
state
-
|
|
Whether to create
present , drop absent or lock locked a role. |
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
is 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: creating a new vertica role
vertica_role: name=role_name db=db_name state=present
- name: creating a new vertica role with other role assigned
vertica_role: name=role_name assigned_role=other_role_name state=present
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]