The zabbix-ldap-sync script is used for keeping your Zabbix users in sync with an LDAP directory server.
It can automatically import existing LDAP groups and users into Zabbix, thus making it easy for you to keep your Zabbix users in sync with LDAP.
Maintained by Marc Schöchlin ms@256bit.org
This project moved to https://github.com/zabbix-tooling/zabbix-ldap-sync to ease collaboration of developers. You can switchover your current git clone byexecuting the follwing command:
git remote set-url origin git@github.com:zabbix-tooling/zabbix-ldap-sync.git # or
git remote set-url origin https://github.com/zabbix-tooling/zabbix-ldap-sync.git
You also need to have your Zabbix Frontend configured to authenticate against an AD/LDAP directory server. (using http or ldap-auth)
Check the official documentation of Zabbix on how to configure Zabbix to authenticate against an AD/LDAP directory server.
apt-get install python-dev virtualenv libpython3.*-dev libldap2-dev libsasl2-dev
virtualenv -p python3 venv
source venv/bin/activate
pip install -r requirements.txt
In order to use the zabbix-ldap-sync script we need to create a configuration file describing the various LDAP and Zabbix related config entries.
type
- Select type of ldap server, can beactivedirectory
oropenldap
uri
- URI of the LDAP server, including portbase
- BaseDistinguished Name
binduser
- LDAP user which has permissions to perform LDAP searchbindpass
- Password for LDAP usergroups
- LDAP groups to sync with Zabbix (support wildcard - TESTED ONLY with Active Directory, see Command-line arguments)media
- Name of the LDAP attribute of user object, that will be used to setSend to
property of Zabbix user media. This entry is optional, default value ismail
.
filtergroup
= The ldap filter to get group in ActiveDirectory mode, by default(&(objectClass=group)(name=%s))
filteruser
= The ldap filter to get the users in ActiveDirectory mode, by default(objectClass=user)(objectCategory=Person)
filterdisabled
= The filter to get the disabled user in ActiveDirectory mode, by default(!(userAccountControl:1.2.840.113556.1.4.803:=2))
filtermemberof
= The filter to get memberof in ActiveDirectory mode, by default(memberOf:1.2.840.113556.1.4.1941:=%s)
groupattribute
= The attribute used for membership in a group in ActiveDirectory mode, by defaultmember
userattribute
= The attribute for users in ActiveDirectory modesAMAccountName
type
= The storage mode for group and users can beposix
orgroupofnames
filtergroup
= The ldap filter to get group in OpenLDAP mode, by default(&(objectClass=posixGroup)(cn=%s))
filteruser
= The ldap filter to get the users in OpenLDAP mode, by default(&(objectClass=posixAccount)(uid=%s))
groupattribute
= The attribute used for membership in a group in OpenLDAP mode, by defaultmemberUid
userattribute
= The attribute for users in openldap mode, by defaultuid
server
- Zabbix URLusername
- Zabbix username. This user must have permissions to add/remove users and groups. Typically, this would beZabbix Admin
account.password
- Password for Zabbix userauth
- can behttp
(for basic auth) orwebform
(for regular form based login)
Allows to override various properties for Zabbix users created by script. See User object in Zabbix API documentation for available properties. If section/property doesn't exist, defaults are:
type = 1
- User type. Possible values:1
- (default) Zabbix user;2
- Zabbix admin;3
- Zabbix super admin.
Allows to override media type and various properties for Zabbix media for users created by script.
decription
- Description of Zabbix media (Email
,Jabber
,SMS
, etc...). This entry is optional, default value isEmail
.
You can configure additional properties in this section. See Media object in Zabbix API documentation for available properties. If this section/property doesn't exist, defaults fro additional properties are:
active = 0
- Whether the media is enabled. Possible values:0
- enabled;1
- disabled.period = 1-7,00:00-24:00
- Time when the notifications can be sent as a time period.onlycreate = true
- Process media only on newly created users if this is set totrue
.severity = 63
- Decimal value of trigger severities to send notifications about. Each severity value occupies a position of a 6-bit value. Use this table to calculate decimal representation or enumerate the severities separated by a comma:
╔═════════════╦════════╦════╦═══════╦═══════╦═══════════╦══════════════╗
║ Severity ║Disaster║High║Average║Warning║Information║Not Classified║
╠═════════════╬════════╬════╬═══════╬═══════╬═══════════╬══════════════╣
║ Enabled ? ║ 1 ║ 1 ║ 1 ║ 1 ║ 1 ║ 1 ║
╠═════════════╬════════╩════╩═══════╩═══════╩═══════════╩══════════════╣
║Decimal value║ 111111 = 63 ║
║ ║ Linux: printf '%i\n' "$((2#111111))" ║
║ ║Disaster,High,Average,Warning,Information,Not Classified║
╚═════════════╩════════════════════════════════════════════════════════╝
[ldap]
type = activedirectory
uri = ldaps://ldap.example.org:389/
base = dc=example,dc=org
binduser = DOMAIN\ldapuser
bindpass = ldappass
groups = sysadmins
media = mail
[ad]
filtergroup = (&(objectClass=group)(name=%s))
filteruser = (objectClass=user)(objectCategory=Person)
filterdisabled = (!(userAccountControl:1.2.840.113556.1.4.803:=2))
filtermemberof = (memberOf:1.2.840.113556.1.4.1941:=%s)
groupattribute = member
userattribute = sAMAccountName
[openldap]
type = posix
filtergroup = (&(objectClass=posixGroup)(cn=%s))
filteruser = (&(objectClass=posixAccount)(uid=%s))
groupattribute = memberUid
userattribute = uid
[zabbix]
server = http://zabbix.example.org/zabbix/
username = admin
password = adminp4ssw0rd
[user]
type = 3
url = http://zabbix.example.org/zabbix/hostinventories.php
autologin = 1
[media]
description = Email
active = 0
period = 1-5,07:00-22:00
severity = Disaster, High, Average, Warning, Information, Not Classified
onlycreate = true
Usage: zabbix-ldap-sync [-lsrwdn] [--verbose] -f <config>
zabbix-ldap-sync -v
zabbix-ldap-sync -h
Options:
-h, --help Display this usage info
-v, --version Display version and exit
-l, --lowercase Create AD user names as lowercase
-s, --skip-disabled Skip disabled AD users
-r, --recursive Resolves AD group members recursively (i.e. nested groups)
-w, --wildcard-search Search AD group with wildcard (e.g. R.*.Zabbix.*) - TESTED ONLY with Active Directory
-d, --delete-orphans Delete Zabbix users that don't exist in a LDAP group
-n, --no-check-certificate Don't check Zabbix server certificate
--verbose Print debug message from ZabbixAPI
-f <config>, --file <config> Configuration file to use
Now that we have the above mentioned configuration file created, let's import our groups and users from LDAP to Zabbix.
$ zabbix-ldap-sync -f /path/to/zabbix-ldap.conf
Once the script completes, check your Zabbix Frontend to verify that users are successfully imported.
To sync different LDAP groups with different options, create separate config file for each group and run zabbix-ldap-sync
:
$ zabbix-ldap-sync -f /path/to/zabbix-ldap-admins.conf
$ zabbix-ldap-sync -f /path/to/zabbix-ldap-users.conf
You would generally be running the above scripts on regular basis, say each day from cron(8)
in order to make sure your Zabbix system is in sync with LDAP.