Page History

Introduction

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.

Fonctionnement

La source fonctionne de la manière suivante : 

1. La source via le module "ldap-import" va se connecter à un serveur de Type Open LDAP avec l'adresse et les et les identifiants que vous aurez renseignés dans le fichier de configuration de la source ( voir ci-dessous ).
2. Une fois connectée, la source interroge le serveur LDAP pour récupérer les informations des éléments à importer.
3. La source va créer les hôtes ou contacts Shinken avec ces informations en effectuant les modifications suivantes :

• • Certains champs collectés du serveur LDAP sont mappés dans des propriétés ou des données de l'hôte ou utilisateurs.
  Vous pourrez
  • • • il est possible d'utiliser les mappings par défaut ou
  définir les vôtres
  • • • d'en créer des spécifiques.

  Info
  title Définition
  Un mapping est une correspondance entre un attribut LDAP et une propriété ou une donnée.

  • • Des modèles d'hôte pourront être ajoutés à l'hôte en fonction des règles d'applications de modèles définies.
  Vous pouvez définir vos propres règles
  • • .
  • • Les modèles sont ajoutés si les champs collectés sur le serveur LDAP correspondent aux critères d'activation d'une règle.
      • Il est possible de définir ses propres règles

  
  

  Une fois les informations du serveur LDAP récupérées, la source va proposer au Synchronizer : 

  • Les hôtes importés.,
  • les groupes d'hôtes importés.,
  • Les les contacts importés.,
  • les groupes de contacts importés.

Définition de la source

Vous trouverez la 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 ) ).

Personnaliser la source pré-installée

Définition de la source

Le fichier préalablement créé pour de la source OpenLDAP  exemple est : openldap-example installée comme exemple est  /etc/shinken/sources/openldap.cfg. Si vous souhaitez Pour créer une autre source openldap, vous pouvez soit il faut au choix : 

• Dupliquer le fichier openldap.cfg créer à l'installation de Shinken puis et éditer le fichier afin de  personnaliser votre de personnaliser la source.
• Copier le fichier de configuration d'exemple /etc/shinken-user-example/configuration/daemons/synchronizers/sources/openldap/openldap-example.cfg cfg dans le dossier /etc/shinken/sources/ puis éditer le fichier afin de personnaliser votre la source :
  

  • 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 faire , éxécuter la commande :

    Code Block
    language text theme Emacs
    chown -R shinken:shinken openldap.cfg

C'est ici que vous pouvez changer le Le changement du nom de votre la source se via la propriété 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.
Pour les autres valeurs, merci de vous référer à Créer et organiser ses sources. 

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 votre le serveur OpenLdap ( le chemin peut varier si vous avez personnalisé votre répertoire ) :

les chemins des fichiers peuvent varier en fonction de la configuration ) :

Connexion LDAP

Règles de configuration
Vous pouvez choisir quelles sortes d'hôtes et d'utilisateurs seront récupérés et permet également la définition de critères afin d'appliquer automatiquement des modèles.
Ce fichier est facultatif mais indispensable si vous souhaitez personnaliser les éléments remontés.

Configuration de la connexion

Configuration de la connexion

La configuration de la connection se fait dans le fichier /etc/shinken/_default/sources/openldap-source/openldap-connection.json.

Paramètres du fichier

Paramètres du fichier

Exemple

Configuration des règles de "mapping"

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.

Image Removed Si besoin ( facultatif ), modifiez le fichier La configuration du mapping se fait dans le fichier /etc/shinken-user/source-data/source-data-openldap-sample/_configuration/openldap-mapping.json.

Paramètres du fichier

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 :

• la propriété shinken entre guillemets découpée en deux parties :
  • le type de l'élément au singulier. Les types disponibles sont : "host", "contact", "hostgroup" et "contactgroup",
  • le point permet de joindre les deux parties,
  • la propriété de l'élément. Cette propriété est la "clé d'import" que l'on peut retrouver sur l'interface dans la fenêtre d'aide.
• le séparateur "deux points".
• la propriété ldap entre guillemets.

Il vous est donc possible de faire correspondre les propriétés ldap avec les propriétés shinken de votre choix. Si vous ne définissez pas ce fichier, un mapping par défaut sera utilisé. Voici ses valeurs.aucun fichier n'est trouvé Shinken utilise le mapping par défaut suivant : 

Exemple

Forcer la valeur des propriétés

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"

Compatibilité avec les anciennes versions

Pour des raisons de compatibilité avec les versions inférieures à la 02.06.03, les propriétés suivantes sont toujours fonctionnelles :

Règles de configuration

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.

Paramètres du fichier

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.

Ajouter un modèle sur tous les éléments

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"

Ajouter un modèle sur tous les éléments présent dans une OU spécifique

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"

Ajouter un modèle sur tous les éléments correspondant à une propriété

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 |

• Tout d'abord le préfixe peut prendre 3 valeurs :
  • "AddFirst_template_" : permets d'ajouter le modèle en première position du champ use,
  • "AddLast_template_" : permets d'ajouter le modèle en dernière position du champ use,
  • "Force_template_" : permet d'utiliser uniquement ce modèle. Cette méthode sera prioritaire et effacera les valeurs obtenues par les précédentes règles.
• Le nom du modèle doit être mis entre parenthèses : France dans l'exemple.
• Le type d'élément ne peut prendre que deux valeurs :
  
  • "_to_host_matching_" : la règle sera utilisée pour les hôtes,
  • "_to_contact_matching_" : la règle sera utilisée pour les contacts.
• le nom de la propriété doit être entre crochets : _COUNTRY dans l'exemple :
  
  • Cette propriété peut être une propriété ou donnée de l'élément shinken ( présente dans le fichier de mapping ),
  • Cette propriété peut être un attribut ldap.
• la valeur de la propriété pour que la règle s'applique : France dans l'exemple.
  

Ajouter un modèle sur tous les élément présent dans un groupe

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.

"AddLast_template_(bordeaux)_to_host_matching_[l]": "Bordeaux"

Exemple

Dans cet exemple nous allons ligne par ligne L'exemple suivant permet :

• ajouter le modèle "linux" à tous les hôtes découverts par la source,
• ajouter le modèle "centos" à tous les hôtes découverts dans l'OU "OU=centos,OU=serveurs,dc=shinken,dc=local",
• ajouter le modèle "Datacenter_01_Bordeaux" à la fin du champ use aux hôtes ou la propriété "location" vaut "FRBXDC01",
• ajouter le modèle "generic-contact" à tous les contacts découverts par la source,
• ajouter le modèle "domain-admins" à tous les contacts qui font partie du groupe ldap "cn=Domain Admins,ou=Users,dc=shinken,dc=local".

{
  "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",
}

Import des objets

Pour importer des objets, allez sur la page d'accueil de l'interface de configuration, si votre la configuration est bonne, vous devriez avoir un message correcte, le message suivant apparaitra : "OK: la source LDAP a été correctement chargée."

Maintenant, faîtes un Pour "Forcer l'import" en cliquant cliquer sur  

Dans le panneau "Elements >" vous verrez   les nouveaux éléments apparaître apparaitront ( Hôtes et Contacts ).

La prochaine étape sera alors d'importer ces nouveaux éléments dans Shinken.

HOW TO

Importer des ordinateurs avec des noms spécifiques

Modifiez le paramètre hosts_filterfilter

   "hosts_filter": "(&(objectClass=computer)(sAMAccountName=*SERVER_NAME*))",

Changez Changer SERVER_NAME  par le nom de serveur vous voulez à importer.

Importer des utilisateurs issus d'un ou plusieurs groupes

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 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",

Filtrer et appliquer des modèles

Cette source inclut également d'autres paramètres qui permettent d'appliquer des modèles automatiquement suivant le type d'objets :

• hosts_template : chaque hôte chargé aura au moins le modèle défini en valeur,
• contacts_template : chaque contact chargé aura au moins le modèle défini en valeur.

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_*

Par exemple, si vous voulez 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, utilisez tiliser le paramètre suivant :

"hosts_template_exchange":  "OU=Email Collaboration Servers,OU=DataCenter Servers,DC=YOUR,dc=DOMAIN,dc=com"

Précisions techniques

Clés de synchronisation

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_hosthosts, properties_used_as_synckey_for_hostgrouphostgroups, properties_used_as_synckey_for_contact contacts et properties_used_as_synckey_for_contactgroup 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és par défaut utilisé pour la construction des clés de synchronisation