La source collecteur Open LDAP permet d’interroger un serveur de type Open LDAP afin de récupérer toutes les informations disponibles.
Une fois ces informations récupérées, la source va définir les hôtes ou groupes d'hôte, utilisateurs ou groupes d'utilisateurs Shinken qui seront proposés au Synchronizer.
La source fonctionne de la manière suivante :
Un mapping est une correspondance entre un attribut LDAP et une propriété ou une donnée. |
Une fois les informations du serveur LDAP récupérées, la source va proposer au Synchronizer :
La procédure de mise en place et de configuration est décrite dans une autre page ( voir la page Module de source de type ldap-import ( pour Open LDAP ) ).
Le fichier de la source OpenLDAP openldap-example installée comme exemple est /etc/shinken/sources/openldap.cfg. Pour créer une autre source openldap, il faut au choix :
Vérifier que les droits utilisateurs du fichier sont attribués à l'utilisateur shinken et le groupe shinken. Si ce n'est pas le cas, éxécuter la commande :
chown -R shinken:shinken openldap.cfg |
Le changement du nom de la source se via la propriété source_name.
Une source OpenLDAP est caractérisée par son module_type qui doit être : ldap-import.
Le module pouvant être utilisé aussi par les sources de type active-directory, il est nécessaire de préciser le mode : openldap.
D'autres propriétés peuvent être paramétrées ( voir la page Module de source de type ldap-import ( pour Open LDAP ) )
Les fichiers suivants sont utilisés pour configurer le serveur OpenLdap ( les chemins des fichiers peuvent varier en fonction de la configuration ) :
|
La configuration de la connection se fait dans le fichier /etc/shinken/_default/sources/openldap-source/openldap-connection.json.
| Propriété | Défaut | Obligatoire | Description | |
|---|---|---|---|---|
| url | OUI | Adresse du serveur OpenLDAP.
| ||
| ldap_protocol | 3 | OUI | Version du protocole LDAP ( par défaut à 3 si pas spécifié ). | |
| base | OUI | OU ( Organisation Unit ) base pour la découverte des objets. | ||
| username | OUI | Utilisateur utilisé pour la connexion au serveur OpenLDAP. | ||
| password | OUI | Mot de passe utilisé pour la connexion au serveur OpenLDAP. | ||
| hosts_base | OU ( Organisation Unit ) base pour la découverte des hôtes. Si ce paramètre est absent ou vide, aucun hôte ne sera découvert. | |||
| hosts_filter | (|(objectClass=device)(objectClass=computer)) | Filtre au format ldap utilisé pour découvrir uniquement certains hôtes. | ||
| hosts_filter_with_group | Permets de ne filtrer que les hôtes présents dans des groupes définis. | |||
| contacts_base | OU ( Organisation Unit ) base pour la découverte des contacts. Si ce paramètre est absent ou vide, aucun contact ne sera découvert. | |||
| contacts_filter | (|(objectClass=InetOrgPerson)(objectClass=user)) | Filtre au format ldap utilisé pour découvrir uniquement certains contacts. | ||
| contacts_filter_with_group | Permets de ne filtrer que les contacts présents dans des groupes définis. | |||
| hostgroups_base | OU ( Organisation Unit ) base pour la découverte des groupes d'hôtes. Si ce paramètre est absent ou vide, aucun groupe d'hôte ne sera découvert. | |||
| hostgroups_filter | (|(objectclass=group)(objectclass=groupofnames)(objectclass=groupofuniquenames)) | Filtre au format ldap utilisé pour découvrir uniquement certains groupes d'hôtes. | ||
| contactgroups_base | OU ( Organisation Unit ) base pour la découverte des groupes de contacts. Si ce paramètre est absent ou vide, aucun groupe de contacts ne sera découvert. | |||
| contactgroups_filter | (|(objectClass=groupOfUniqueNames)(objectClass=groupOfNames)(objectClass=posixGroup)) | Filtre au format ldap utilisé pour découvrir uniquement certains groupes de contacts. |
Pour ne pas importer d'objets OpenLDAP "computer" et donc de ne pas créer d'hôtes en "nouveau" dans Shinken, ne pas définir la propriété hosts_base ou la laisser vide. |
{
# Mandatory
"url": "ldap://vm-w2k8r2.shinkendom.local/",
"ldap_protocol":3,
"base": "dc=shinkendom,dc=local",
"username": "administrateur@shinkendom.local",
"password": "P@ssword1",
# Optionnal
"hosts_base": "OU=Serveurs,dc=shinkendom,dc=local",
"hosts_filter": "(|(objectClass=device)(objectClass=computer))",
"hosts_filter_with_group":"",
"contacts_base": "OU=Users,dc=shinkendom,dc=local",
"contacts_filter": "(|(objectClass=InetOrgPerson)(objectClass=user))",
"contacts_filter_with_group": "",
"hostgroups_base": "OU=Serveurs,dc=shinkendom,dc=local",
"hostgroups_filter": "(|(objectclass=group)(objectclass=groupofnames)(objectclass=groupofuniquenames))",
"contactgroups_base": "OU=Users,dc=shinkendom,dc=local",
"contactgroups_filter": "(|(objectClass=groupOfUniqueNames)(objectClass=groupOfNames)(objectClass=posixGroup))"
} |
Le compte utilisé pour envoyer des requêtes LDAP au serveur n'a besoin que d'un accès en "lecture seule". |
Il est possible que l'utilisateur ldap utilisé soit soumis à certaines limites ( nombre d'entrées, délai, taille, ... ). Si cette limite est rencontrée, aucun objet ne sera importé. |
Il est possible de faire correspondre certaines propriétés OpenLDAP avec des propriétés ou données d'un élément Shinken. Il existe un "mapping" par défaut pour OpenLDAP, mais il est possible de personnaliser les correspondances.
La configuration du mapping se fait dans le fichier /etc/shinken-user/source-data/source-data-openldap-sample/_configuration/openldap-mapping.json.
Chaque ligne de ce fichier définit une correspondance entre une propriété ou donnée Shinken avec une propriété ldap. Les paramètres peuvent donc être nombreux.
Par exemple la ligne suivante définit une correspondance entre le nom de l'hôte dans shinken et sa propriété dans ldap :
"host.host_name": "cn", |
Elle est définie par :
Si ce format n'est pas respecté, l'import se déroulera sans cette ligne et un message d'avertissement indiquera qu'il y a une erreur de syntaxe. |
Il est donc possible de faire correspondre les propriétés ldap avec les propriétés shinken. Si aucun fichier n'est trouvé Shinken utilise le mapping par défaut suivant :
| Propriété Shinken | Propriété OpenLdap | Description |
|---|---|---|
| host.host_name | cn | La propriété ldap "cn" ( CommonName ) sera utilisé pour le nom des hôtes. |
| host.display_name | description | La propriété ldap "description" sera utilisé pour la description des hôtes. |
| host.address | ipHostNumber | La propriété ldap "ipHostNumber" sera utilisé pour l'adresse des hôtes. |
| hostgroup.hostgroup_name | cn | La propriété ldap "cn" ( CommonName ) sera utilisé pour le nom des groupes d'hôtes. |
| contact.contact_name | uid | La propriété ldap "uid" ( UserId ) sera utilisé pour le nom des contacts. |
| contact.email | La propriété ldap "mail" sera utilisé comme adresse mail du contact. | |
| contact.display_name | displayName | La propriété ldap "displayName" sera utilisé comme description du contact. |
| contact._PHONE | telephoneNumber | La propriété ldap "telephoneNumber" sera conservé dans la donnée _PHONE du contact. |
| contact._MOBILE | mobile | La propriété ldap "mobile" sera conservé dans la donnée _MOBILE du contact. |
| contact._COUNTRY | co | La propriété ldap "co" ( Country ) sera conservé dans la donnée _COUNTRY du contact. |
| contact._CITY" | l | La propriété ldap "l" ( localityName ) sera conservé dans la donnée _CITY du contact. |
| contact._COMPANY | company | La propriété ldap "company" sera conservé dans la donnée _COMPANY du contact. |
| contactgroup.contactgroup_name | cn | La propriété ldap "cn" ( CommonName ) sera utilisé pour le nom des groupes d'hôtes. |
Pour ne pas importer les propriétés par défaut, il faut créer un fichier de "mapping" avec la clé souhaitée et sa valeur à vide. |
{
# You can map any ldap attribut in a Data (start with a _ and in MAJ)
# -- Hosts
# mandatory
"host.host_name": "cn",
"host.display_name": "description",
"host.address": "ipHostNumber",
# -- Hostgroups
# mandatory
"hostgroup.hostgroup_name": "cn",
# -- Contacts
# mandatory
"contact.contact_name": "uid",
"contact.email": "mail",
"contact.display_name":"displayName",
"contact._MEMBER": "uniqueMember",
"contact._PHONE":"telephoneNumber",
"contact._MOBILE":"mobile",
# Co: for country
"contact._COUNTRY":"co",
# l: for city
"contact._CITY":"l",
"contact._COMPANY":"company",
# -- Contactgroups
# mandatory
"contactgroup.contactgroup_name": "cn"
}
|
On peut ajouter "[FORCE]" à la fin du nom de la propriété Shinke pour que la valeur soit forcée.
Cela aura pour effet de donner aux valeurs de ce champ une importance supérieure par rapport aux autres sources. Si une autre source essaye d'importer le même objet, mais avec des valeurs différentes pour le champ forcé, ses valeurs seront ignorées. Si la seconde source force également le même champ, on gardera les valeurs de celui dont la source à la priorité la plus élevée.
Il se peut aussi que l'utilisateur veuille remplacer les éléments d'une liste ( comme la propriété "members" servant à définir les membres d'un groupe d'utilisateurs ) au lieu d'en ajouter. Dans ce cas, il peut ajouter [FORCE] à la propriété, ce qui aura pour effet de remplacer complètement la liste par celle fournie avec l'option [FORCE].
Ex :
"contactgroup.members[FORCE]": "members" |
Il n'y a pas d'espace entre la propriété et le [FORCE]. |
Pour des raisons de compatibilité avec les versions inférieures à la 02.06.03, les propriétés suivantes sont toujours fonctionnelles :
| Ancienne propriété | Nouvelle propriété Shinken correspondante | Description |
|---|---|---|
| host.name | host.host_name | Contient le nom de l'élément. |
| host.dNSHostName | host.address | L'adresse de l'élément. |
| host.operatingSystem | host._OS | Le système d'exploitation sera conservé dans une donnée de l'hôte. |
| host.operatingSystemServicePack | host._OS_SP | Le service pack de du système d'exploitation sera conservé dans une donnée. |
| host.distinguishedName | host.display_name | Le nom distingué de l'hôte correspondra à la description de l'hôte. |
| contact.name | contact.contact_name | Contient le nom de l'utilisateur. |
| contact.mail | contact.email | Contient l'adresse email de l'utilisateur. |
| contact.displayName | contact.display_name | Contient la description de l'utilisateur. |
| contact.telephoneNumber | contact._PHONE | Le numéro de téléphone de l'utilisateur sera conservé dans une donnée. |
| contact.mobile | contact._MOBILE | Le numéro de mobile de l'utilisateur sera conservé dans une donnée. |
| contact.co | contact._COUNTRY | Le pays de l'utilisateur sera conservé dans une donnée. |
| contact.l | contact._CITY | La ville de l'utilisateur sera conservé dans une donnée. |
| contact.company | contact._COMPANY | La société de l'utilisateur sera conservé dans une donnée. |
| hostgroup.name | hostgroup.hostgroup_name | Contient le nom du groupe. |
| contactgroup.name | contactgroup.contactgroup_name | Contient le nom du groupe. |
| contact.member | contactgroup.members | Dans les précédentes versions, les groupes de contact n'étaient pas importés. Désormais ils le sont les et liens avec les utilisateurs sont conservés. |
Les filtres sur les types d'éléments étaient présents dans le fichier de mapping : "host.filter", "contact.filter", "hostgroup.filter" et "contactgroup.filter"). Ceux-ci doivent désormais se trouver dans le fichier de connexion sous les noms : "hosts_filter", "contacts_filter", "hostgroups_filter" et "contactsgroups_filter".
|
Les paramètres "contact.classFilter" et "contact.categoryFilter" sont dépréciés et seront supprimés dans une version ultérieure. Itiliser le paramètre contacts_filter du fichier de connexion pour remplacer ce filtre. Exemple : "contacts_filter" : "(objectClass=InetOrgPerson)" |
Ce fichier est utilisé pour appliquer des modèles d'hôtes et des modèles d'utilisateurs sur les hôtes et utilisateurs durant l'import, provenant d'OU ciblées.
Ce fichier permet également de filtrer les utilisateurs à importer dans Shinken en se basant sur les membres d'un ou de plusieurs groupes d'utilisateurs de l'annuaire OpenLDAP ciblé.
La configuration des règles se fait dans le fichier /etc/shinken-user/source-data/source-data-openldap-sample/_configuration/openldap-rules.json.
Les règles doivent être définies dans le fichier "rules", encadré par des accolades "{ ... }". Il est possible de définir plusieurs types de règles.
Il est possible d'ajouter un même modèle sur tous les hôtes ou contacts importés par la source. Par exemple pour ajouter le modèle "ldap-host" à tous les hôtes et le modèle "ldap-user" à tous les contacts, il faut configurer les lignes suivantes :
"hosts_template": "ldap-host", "contacts_template": "ldap-user" |
Les paramètres "hosts_tag" et "contacts_tag" sont dépréciés et seront supprimés dans une version ultérieure. Utiliser le paramètre "hosts_template" et "contacts_template" remplacer ces règles. Exemple : "contacts_template" : "generic-contact" |
Il est possible d'ajouter un modèle pour tous les hôtes ou contacts qui sont dans une OU spécifique. Par exemple pour ajouter le modèle d'hôte linux à tous les hôtes présent dans l'OU "ou=Linux,ou=Datacenter,dc=shinkendom,dc=local", et le modèle "Bordeaux" à tous les contacts présent dans l'OU "ou=Users,ou=Bordeaux,ou=Datacenter,dc=shinkendom,dc=local", il faut configurer les lignes suivantes :
"hosts_template_linux": "ou=Linux,ou=Datacenter,dc=shinkendom,dc=local", "contacts_template_ldapAdmins": "ou=Users,ou=Bordeaux,ou=Datacenter,dc=shinkendom,dc=local" |
Il est possible d'ajouter des modèles sur des éléments dont une propriété correspond à une valeur définie.
Cette règle est divisée en 5 parties : un préfixe, un modèle, type d'élément, le nom de la propriété, la valeur de la propriété.
Voici un exemple et son explication :
exemple : "AddLast_template_(France)_to_contact_matching_[_COUNTRY]": "France" explication : | Préfixe |modèle| type d'élément |propriété| valeur | |
Pour ajouter un modèle sur un élément présent dans un groupe, il faut utiliser la règle précédente avec la propriété memberOf.
Sur certaines installations openLDAP, l'overlay memberOf n'est pas installé et n'est pas utilisable nativement. Le module import-ldap n'utilise pas cet overlay et le simule. Il est donc possible d'utiliser la propriété memberOf dans ce module même s'il n'est pas présent sur l'installation. |
Dans LDAP, il est possible qu'un objet possède plusieurs fois la même propriété. Dans ce cas, il est possible de mettre en place des règles sur ces propriétés. Par exemple, un considère un objet qui a plusieurs propriétés "l" ( location ) ( un utilisateur qui travaille à plusieurs endroits par exemple ). On peut alors mettre en place la règle suivante :
Cette règle est activée lorsque l'utilisateur possède une de ses propriétés "l" qui est égale à "Bordeaux". Dans ce cas, le modèle d'utilisateur "bordeaux" est utilisé pour cet utilisateur. |
L'exemple suivant permet :
{
"hosts_template": "linux",
"hosts_template_centos": "OU=centos,OU=serveurs,dc=shinken,dc=local",
"AddLast_template_(Datacenter_01_Bordeaux)_to_host_matching_[location]": "FRBXDC01",
"contacts_template": "generic-contact",
"AddFirst_template_(domain-admins)_to_contact_matching_[memberOf]": "cn=Domain Admins,ou=Users,dc=shinken,dc=local",
}
|
Pour ne définir aucune règle, il faut créer un fichier vide avec seulement les accolades ouvrantes et fermantes ou ne pas préciser le fichier dans la définition de la source. |
Pour importer des objets, allez sur la page d'accueil de l'interface de configuration, si la configuration est correcte, le message suivant apparaitra : "OK: la source LDAP a été correctement chargée."
Pour "Forcer l'import" cliquer sur 
Dans le panneau "Elements >" les nouveaux éléments apparaitront ( Hôtes et Contacts ).
|
La prochaine étape sera alors d'importer ces nouveaux éléments dans Shinken.
| Dans le fichier openldap-connection.json |
Modifiez le paramètre hosts_filter
"hosts_filter": "(&(objectClass=computer)(sAMAccountName=*SERVER_NAME*))", |
Changer SERVER_NAME par le nom de serveur à importer.
Avec la source OpenLDAP, il est donc possible d'importer des utilisateurs de la base contacts_base spécifiée dans le fichier openldap-connection.json mais on peut aussi les filtrer afin de n'importer que ceux qui sont dans un ou plusieurs groupes différents de l'annuaire LDAP.
| Dans le fichier openldap-connection.json |
Dans contacts_filter_with_group, ajouter le Distinguished Name ( DN ) des différents groupes d'utilisateurs séparés par un pipe ( "|" )
"contacts_filter_with_group": "CN=shinken_admins,OU=utilisateurs,DC=shinkendom,DC=local | CN=shinken_users,OU=utilisateurs,DC=shinkendom,DC=local", |
Cette source inclut également d'autres paramètres qui permettent d'appliquer des modèles automatiquement suivant le type d'objets :
Il est également possible d'ajouter un modèle sur les hôtes sur leur OU ( Organization Unit ) en utilisant le paramètre hosts_template_*
Pour ajouter le modèle exchange à tous les serveurs qui sont dans l'OU: OU=Email Collaboration Servers,OU=DataCenter Servers,DC=YOUR,dc=DOMAIN,dc=com, utiliser le paramètre suivant :
"hosts_template_exchange": "OU=Email Collaboration Servers,OU=DataCenter Servers,DC=YOUR,dc=DOMAIN,dc=com" |
Les clés de synchronisation sont des valeurs utilisées lors de l'étape du mélange des sources ( voir la page Modules de Sources ( imports ) et de Taggers ( qualification ) ) qui permet de choisir quel élément de cette source se mélange avec quel élément d'une autre source ( voir la page Le mélange des sources & les clés de synchronisation (sync-key) ).
Les paramètres properties_used_as_synckey_for_hosts, properties_used_as_synckey_for_hostgroups, properties_used_as_synckey_for_contacts et properties_used_as_synckey_for_contactgroups de la source permettent d'ajouter les propriétés qui serviront à créer les clés de synchronisation ( voir la page Module de source de type ldap-import ( pour Open LDAP ) ).
| Propriété | Type d'élément | Info | |
|---|---|---|---|
| Tous les éléments | Cette propriété ne peut pas être retirée des propriétés utilisées pour faire les clés de synchronisation | |
| Tous les éléments | Cette propriété ne peut pas être retirée des propriétés utilisées pour faire les clés de synchronisation | |
| hôte | ||
| contact |