community.zabbix.zabbix_user_directory module – Create/update/delete Zabbix user directories
Note
This module is part of the community.zabbix collection (version 1.9.0).
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.zabbix
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.zabbix.zabbix_user_directory
.
Synopsis
This module allows you to create, modify and delete Zabbix user directories.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9
Parameters
Parameter |
Comments |
---|---|
LDAP base distinguished name string. |
|
LDAP bind distinguished name string. Can be empty for anonymous binding. Default: |
|
LDAP bind password. Can be empty for anonymous binding. Available only for present |
|
User directory description. Default: |
|
LDAP server host name, IP or URI. URI should contain schema, host and port (optional). |
|
Zabbix user password. If not set the environment variable This option is deprecated with the move to httpapi connection and will be removed in the next release |
|
Zabbix user name. If not set the environment variable This option is deprecated with the move to httpapi connection and will be removed in the next release |
|
Unique name of the user directory. |
|
LDAP server port. |
|
LDAP attribute name to identify user by username in Zabbix database. |
|
LDAP custom filter string when authenticating user in LDAP. Default: |
|
URL of Zabbix server, with protocol (http or https). If not set the environment variable This option is deprecated with the move to httpapi connection and will be removed in the next release |
|
LDAP startTLS option. It cannot be used with ldaps:// protocol hosts. Choices:
|
|
State of the user directory. On On Choices:
|
|
The timeout of API request (seconds). This option is deprecated with the move to httpapi connection and will be removed in the next release Default: |
|
If set to False, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If not set the environment variable This option is deprecated with the move to httpapi connection and will be removed in the next release Choices:
|
Notes
Note
If you use login_password=zabbix, the word “zabbix” is replaced by “********” in all module output, because login_password uses
no_log
. See this FAQ for more information.
Examples
---
# Set following variables for Zabbix Server host in play or inventory
- name: Set connection specific variables
set_fact:
ansible_network_os: community.zabbix.zabbix
ansible_connection: httpapi
ansible_httpapi_port: 80
ansible_httpapi_use_ssl: false
ansible_httpapi_validate_certs: false
ansible_zabbix_url_path: 'zabbixeu' # If Zabbix WebUI runs on non-default (zabbix) path ,e.g. http://<FQDN>/zabbixeu
# If you want to use Username and Password to be authenticated by Zabbix Server
- name: Set credentials to access Zabbix Server API
set_fact:
ansible_user: Admin
ansible_httpapi_pass: zabbix
# If you want to use API token to be authenticated by Zabbix Server
# https://www.zabbix.com/documentation/current/en/manual/web_interface/frontend_sections/administration/general#api-tokens
- name: Set API token
set_fact:
ansible_zabbix_auth_key: 8ec0d52432c15c91fcafe9888500cf9a607f44091ab554dbee860f6b44fac895
- name: Create new user directory or update existing info
community.zabbix.zabbix_user_directory:
server_url: http://monitor.example.com
login_user: username
login_password: password
state: present
name: TestUserDirectory
host: 'test.com'
port: 389
base_dn: 'ou=Users,dc=example,dc=org'
search_attribute: 'uid'
bind_dn: 'cn=ldap_search,dc=example,dc=org'
description: 'Test user directory'
search_filter: '(%{attr}=test_user)'
start_tls: 0