Page History

Scroll Ignore

scroll-pdf	true
scroll-office	true
scroll-chm	true
scroll-docbook	true
scroll-eclipsehelp	true
scroll-epub	true
scroll-html	true

Vue d'ensemble

Ce document décrit comment vous pouvez importer des hôtes et des utilisateurs depuis Active Directory.

Après avoir pris soin de lire notre page sur la Définition et Utilisation des sources, certaines étapes sont nécessaires afin de pouvoir importer des hôtes et des utilisateurs depuis un annuaire Active Directory:

Personnaliser la source Active Directory (à partir de la source d'exemple)

Configurer les 3 fichiers pour :

la connection à Active Directory pour les extractions de données

le "mapping" pour la correspondance entre les champs de l'annuaire Active Directory et ceux de Shinken

les règles de configuration pour appliquer des filtres si besoin et réaliser des actions

Panel

title	Sommaire

Table of Contents

Personnaliser la source pré-installée

Le script d'installation et de mise à jour de Shinken permet de mettre en place une source Active Directory déjà listée ( active-dir-example ).

Vous pouvez la voir sur la page d'accueil de l'UI de Configuration, dans le tableau des sources.

Cette source utilise 2 sortes de fichiers de configuration :

Le fichier de définition de source Active DirectoryPour Active Directory, le fichier en place pour l'exemple est /etc/shinken/sources/active-dir-hosts.cfg

3 fichiers de configuration de la source afin de personnaliser les extractions de données

Disponible dans le répertoire /etc/shinken-user/source-data/source-data-active-directory-sample/_configuration :
- connection_configuration_file,
- mapping_configuration_file,
- rules_configuration_file.

style	none

Introduction

La source collecteur Active Directory permet d’interroger un serveur Active Directory 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 :

La source via le module "ldap-import" va se connecter à un serveur Active Directory avec l'adresse et les identifiants que vous aurez renseignés dans le fichier de configuration de la source ( voir ci-dessous ).
Une fois connectée, la source interroge le serveur Active Directory pour récupérer les informations des éléments à importer.
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 Active Directory sont mappés dans des propriétés ou des données de l'hôte ou utilisateurs.

Vous pourrez utiliser les mappings par défaut ou définir les vôtres.

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 Active Directory correspondent aux critères d'activation d'une règle.

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

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

Définition de la source

Vous trouverez la procédure de mise en place et de configuration dans la page Module de source de type ldap-import ( pour Active Directory ).

Utilisation de la source

Personnaliser la source pré-installée

Vous pouvez directement utiliser cette source "active-dir-example" en modifiant uniquement les fichiers de configuration pour extractions de vos données Active Directory (pour un test rapide par exemple). Cependant, nous vous conseillons de dupliquer la source "active-dir-example" en suivant l'explication ci-dessous.

Tip

Pour personnaliser votre source (et donc modifier le terme "example"), copiez votre répertoire de configuration de la source (source-data-active-directory-sample vers source-data-active-directory-monServeurAD par exemple) et modifiez votre définition de source (le nom de votre source et les chemins à vos 3 fichiers de configuration).

Bien entendu, votre Synchronizer devra appeler ce nouveau nom de source, modifiez donc également le fichier de configuration du Shinken Synchronizer.

Panel
Image Removed

Définition de la source

Le fichier préalablement créé pour la source Active Directory exemple est : /etc/shinken/sources/active-dir-hosts.cfg. (de la même manière qu'avec le répertoire de configuration, vous pouvez dupliquer ce fichier et effectuer les modifications afin de personnaliser votre source)

C'est ici que vous pouvez changer le nom de votre source via la propriété source_name

Une source Active Directory est caractérisée par son module_type qui doit être : ldap-import

Le module pouvant être utilisé aussi par les sources de type Open LDAP, il est nécessaire de préciser le mode : ad

Pour les autres valeurs, merci de vous référer à la Définition et Utilisation des sources.

Les fichiers suivants sont utilisés pour configurer votre serveur Active Directory (le chemin peut varier si vous avez personnalisé votre répertoire) :

PropertyValueDescriptionnot_stored_properties< liste de champs >Ce paramètre permet de définir un ou plusieurs champs que ne seront pas importés dans shinken. Cela peut être utile pour exclure une propriété ou bien utiliser des champs personnalisés utiles pour la gestion de vos fichiers .cfgconnection_configuration_file/etc/shinken-user/source-data/source-data-active-directory-sample/_configuration/active-directory-connection.json

Connexion LDAP

Information de connexion à l'annuaire LDAP.
Ce fichier est à modifier obligatoirement

mapping_configuration_file/etc/shinken-user/source-data/

Le script d'installation et de mise à jour de Shinken permet de mettre en place une source Active Directory déjà listée ( active-dir-example ).

Vous pouvez la voir sur la page d'accueil de l'interface de Configuration, dans le tableau des sources.

Cette source utilise 2 sortes de fichiers de configuration :

Le fichier de définition de source Active Directory
- Pour Active Directory, le fichier en place pour l'exemple est /etc/shinken/sources/active-dir-hosts.cfg
3 fichiers de configuration de la source afin de personnaliser les extractions de données
- Disponible dans le répertoire /etc/shinken-user/source-data/source-data-active-directory-sample/_configuration :
  - connection_configuration_file,
  - mapping_configuration_file,
  - rules_configuration_file.

Vous pouvez directement utiliser cette source "active-dir-example" en modifiant uniquement les fichiers de configuration pour extractions de vos données Active Directory (pour un test rapide par exemple). Cependant, nous vous conseillons de dupliquer la source "active-dir-example" en suivant l'explication ci-dessous.

Tip
Pour personnaliser votre source (et donc modifier le terme "example"), copiez votre répertoire de configuration de la source (

/_configuration/mapping.json

Règles de mapping
Vous pouvez spécifier dans ce fichier quel serait le nom d'attribut du numéro de téléphone des utilisateurs.
Ce fichier est facultatif et peut être utilisé tel quel

rules_configuration_file/etc/shinken-user/source-data/source-data-active-directory-sample/_configuration/active-directory-rules.json

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

Image Removed

Veuillez donc tout d'abord modifier le fichier active-directory-connection.json :

Paramètres du fichier

PropriétéDéfautObligatoireDescriptionurlOUIAdresse de votre serveur Active Directoryldap_protocol3OUIVersion du protocole LDAP (par défaut à 3 si pas spécifié)baseOUIOU (Organisation Unit) base pour la découverte de vos objetsusernameOUIUtilisateur utilisé pour la connexion au serveur Active DirectorypasswordOUIMot de passe utilisé pour la connexion au serveur Active Directoryhosts_baseOU (Organisation Unit) base pour la découverte de vos 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_groupPermes de ne filtrer que les hôtes présents dans des groupes définis.contacts_baseOU (Organisation Unit) base pour la découverte de vos 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_groupPermets de ne filtrer que les contacts présents dans des groupes définis.hostgroups_baseOU (Organisation Unit) base pour la découverte de vos 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)Filtre au format ldap utilisé pour découvrir uniquement certains groupes d'hôtes.contactgroups_baseOU (Organisation Unit) base pour la découverte de vos groupes de contacts. Si ce paramètre est absent ou vide, aucun groupe de contacts ne sera découvert.

monServeurAD par exemple ) et modifiez votre définition de source ( le nom de votre source et les chemins à vos 3 fichiers de configuration ).

Bien entendu, votre Synchronizer ( voir la page Le Synchronizer ) devra appeler ce nouveau nom de source, modifiez donc également le fichier de configuration du Shinken Synchronizer.

Panel
Image Added

Personnaliser la source que vous avez ajouter

Lorsque vous aurez mis en place votre propre source en suivant la procédure décrite dans la page Module de source de type ldap-import ( pour Active Directory ), vous devrez configurer les fichiers suivants ( le chemin variera en fonction du répertoire que vous avez choisi ) :

Property	Value	Description
not_stored_properties	< liste de champs >	Ce paramètre permet de définir un ou plusieurs champs qui ne seront pas importés dans shinken. Cela peut être utile pour exclure une propriété ou bien utiliser des champs personnalisés utiles pour la gestion de vos fichiers .cfg
connection_configuration_file	/etc/shinken-user/source-data/source-data-active-directory-sample/_configuration/active-directory-connection.json	*Connexion LDAP* Information de connexion à l'annuaire LDAP. Ce fichier est à modifier obligatoirement
mapping_configuration_file	/etc/shinken-user/source-data/source-data-active-directory-sample/_configuration/active-directory-mapping.json	Règles de mapping Vous pouvez spécifier dans ce fichier quel serait le nom d'attribut du numéro de téléphone des utilisateurs. Ce fichier est facultatif et peut être utilisé tel quel
rules_configuration_file	/etc/shinken-user/source-data/source-data-active-directory-sample/_configuration/active-directory-rules.json	*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

Image Added

Veuillez donc tout d'abord modifier le fichier active-directory-connection.json :

Paramètres du fichier

contactgroups_filter(|(objectclass=group)Filtre au format ldap utilisé pour découvrir uniquement certains groupes de contacts.

Tip

Si vous ne souhaitez pas importer d'objets Active Directory "computer" et donc de ne pas créer d'hôtes en "nouveau" dans Shinken, vous pouvez ne pas définir la propriété hosts_base ou bien la laisser vide.
Si vous ne souhaitez pas importer d'objets Active Directory "contact" et donc de ne pas créer d'utilisateurs en "nouveau" dans Shinken, vous pouvez ne pas définir la propriété contacts_base ou bien la laisser vide

Exemple

Code Block

language	js
title	/etc/shinken-user/source-data/source-data-active-directory-sample/_configuration/active-directory-connection.json

{ # Mandatory "url": "ldap://192.168.1.240", "ldap_protocol":3, "base": "dc=shinkendom,dc=local", "username": "shinkendom/administrateur", "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": "

Propriété

Défaut

Obligatoire

Description

url

OUI

Adresse de votre serveur Active Directory.

Warning
Le paramètre "url" doit obligatoirement commencer par "ldap://" ou "ldaps://". Si jamais ça n'est pas le cas, un message d’erreur expliquant le problème apparaitra lors de l'import de la source.

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 de vos objets.

username

OUI

Utilisateur utilisé pour la connexion au serveur Active Directory.

password

OUI

Mot de passe utilisé pour la connexion au serveur Active Directory.

hosts_base

OU ( Organisation Unit ) base pour la découverte de vos 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 de vos contacts. Si ce paramètre est absent ou vide, aucun contact ne sera découvert.

contacts_filter

(|(objectClass=InetOrgPerson)(objectClass=user))

", "contacts

		Filtre au format LDAP utilisé pour découvrir uniquement certains contacts.
contacts_filter_with_group

": "", "hostgroups_base": "OU=Serveurs,dc=shinkendom,dc=local", "hostgroups_filter": "(

		Permets de ne filtrer que les contacts présents dans des groupes définis.
hostgroups_base		OU ( Organisation Unit ) base pour la découverte de vos 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))", "contactgroups_base": "OU=Users,dc=shinkendom,dc=local", "contactgroups_filter": "(|(objectClass=groupOfUniqueNames)(objectClass=groupOfNames)(objectClass=posixGroup))" }

Tip

title	Tip

Le compte utilisé pour envoyer des requêtes LDAP au serveur n'a besoin que d'un accès en "lecture seule". Vous devriez créer un compte de service Active Directory dédié à cet accès Shinken.

Info
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é.

Configuration des règles de "mapping"

Il est possible de faire correspondre certaines propriétés Active Directory avec des propriétés ou données d'un élément Shinken. Il existe un "mapping" par défaut pour Active Directory, mais il est possible de personnaliser les correspondances.

Image Removed Si besoin (facultatif), modifiez le fichier active-directory-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:

No Format
"host.host_name": "name",

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.

Tip
Si ce format n'est pas respecté, l'import se déroulera sans cette ligne et un message d'avertissement vous indiquera qu'il y a une erreur de syntaxe

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.

Propriété ShinkenPropriété Active DirectoryDescriptionhost.host_namenameLa propriété ldap "name" sera utilisée pour le nom des hôteshost.display_namesAMAccountNameLa propriété ldap "sAMAccountName" sera utilisée pour la description des hôteshost.addressipHostNumberLa propriété ldap "ipHostNumber" sera utilisée pour l'adresse des hôteshostgroup.hostgroup_namecnLa propriété ldap "cn" (CommonName) sera utilisée pour le nom des groupes d'hôtescontact.contact_namenameLa propriété ldap "name" sera utilisée pour le nom des contactscontact.emailmailLa propriété ldap "mail" sera utilisée comme adresse mail du contactcontact.display_namedisplayNameLa propriété ldap "displayName" sera utilisée comme description du contactcontact._PHONEtelephoneNumberLa propriété ldap "telephoneNumber" sera conservée dans la donnée _PHONE du contactcontact._MOBILEmobileLa propriété ldap "mobile" sera conservée dans la donnée _MOBILE du contactcontact._COUNTRYcoLa propriété ldap "co" (Country) sera conservée dans la donnée _COUNTRY du contactcontact._CITYlLa propriété ldap "l" (localityName) sera conservée dans la donnée _CITY du contactcontact._COMPANYcompanyLa propriété ldap "company" sera conservée dans la donnée _COMPANY du contactcontactgroup.contactgroup_namecnLa propriété ldap "cn" (CommonName) sera utilisée pour le nom des groupes d'hôtes

Tip
Si vous ne souhaitez pas importer les propriétés par défaut, vous devez définir un fichier de "mapping" avec la clé souhaitée et sa valeur à vide

		Filtre au format LDAP utilisé pour découvrir uniquement certains groupes d'hôtes.
contactgroups_base			OU ( Organisation Unit ) base pour la découverte de vos groupes de contacts. Si ce paramètre est absent ou vide, aucun groupe de contacts ne sera découvert.
contactgroups_filter	(\|(objectclass=group)		Filtre au format LDAP utilisé pour découvrir uniquement certains groupes de contacts.

Tip

Si vous ne souhaitez pas importer d'objets Active Directory "computer" et donc de ne pas créer d'hôte en "nouveau" dans Shinken, vous pouvez ne pas définir la propriété hosts_base ou bien la laisser vide.
Si vous ne souhaitez pas importer d'objets Active Directory "contact" et donc de ne pas créer d'utilisateur en "nouveau" dans Shinken, vous pouvez ne pas définir la propriété contacts_base ou bien la laisser vide.

Exemple

Code Block

language	bash
theme	RDark
title	/etc/shinken-user/source-data/source-data-active-directory-sample/_configuration/active-directory-connection.json

{
  # Mandatory
  "url": "ldap://192.168.1.240",
  "ldap_protocol":3,
  "base": "dc=shinkendom,dc=local",
  "username": "shinkendom/administrateur",
  "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))"
 }

Tip

title	Tip

Le compte utilisé pour envoyer des requêtes LDAP au serveur n'a besoin que d'un accès en "lecture seule". Vous devriez créer un compte de service Active Directory dédié à cet accès Shinken.

Info
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é.

Configuration des règles de "mapping"

Il est possible de faire correspondre certaines propriétés Active Directory avec des propriétés ou données d'un élément Shinken. Il existe un "mapping" par défaut pour Active Directory, mais il est possible de personnaliser les correspondances.

Image Added Si besoin ( facultatif ), modifiez le fichier active-directory-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:

No Format
"host.host_name": "name",

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.

Tip
Si ce format n'est pas respecté, l'import se déroulera sans cette ligne et un message d'avertissement vous indiquera qu'il y a une erreur de syntaxe.

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.

Propriété Shinken	Propriété Active Directory	Description
host.host_name	name	La propriété LDAP "name" sera utilisée pour le nom des hôtes.
host.display_name	sAMAccountName	La propriété LDAP "sAMAccountName" sera utilisée pour la description des hôtes.
host.address	ipHostNumber	La propriété LDAP "ipHostNumber" sera utilisée pour l'adresse des hôtes.
hostgroup.hostgroup_name	cn	La propriété LDAP "cn" ( CommonName ) sera utilisée pour le nom des groupes d'hôtes.
contact.contact_name	name	La propriété LDAP "name" sera utilisée pour le nom des contacts.
contact.email	mail	La propriété LDAP "mail" sera utilisée comme adresse mail du contact.
contact.display_name	displayName	La propriété LDAP "displayName" sera utilisée comme description du contact.
contact._PHONE	telephoneNumber	La propriété LDAP "telephoneNumber" sera conservée dans la donnée _PHONE du contact.
contact._MOBILE	mobile	La propriété LDAP "mobile" sera conservée dans la donnée _MOBILE du contact.
contact._COUNTRY	co	La propriété LDAP "co" ( Country ) sera conservée dans la donnée _COUNTRY du contact.
contact._CITY	l	La propriété LDAP "l" ( localityName ) sera conservée dans la donnée _CITY du contact.
contact._COMPANY	company	La propriété LDAP "company" sera conservée dans la donnée _COMPANY du contact.
contactgroup.contactgroup_name	cn	La propriété LDAP "cn" ( CommonName ) sera utilisée pour le nom des groupes d'hôtes.

Tip
Si vous ne souhaitez pas importer les propriétés par défaut, vous devez définir un fichier de "mapping" avec la clé souhaitée et sa valeur à vide

Exemple

Code Block

language	bash
theme	RDark
title	/etc/shinken-user/source-data/source-data-active-directory-sample/_configuration/active-directory-mapping.json

Exemple

Code Block

title	/etc/shinken-user/source-data/source-data-active-directory-sample/_configuration/active-directory-mapping.json

{                                                                        
    # You can map any ldap attribut in a Data (start with a _ and in MAJ)
    # -- Hosts                                                           
    # mandatory                                                          
    "host.host_name": "name",                                            
    "host.display_name": "sAMAccountName",                               
    "host.address": "ipHostNumber",                                      
                                                                         
    # -- Hostgroups                                                      
    # mandatory                                                          
    "hostgroup.hostgroup_name": "cn",    
    # You can map any ldap attribut in a Data (start with a _ and in MAJ)
    # -- Hosts        
                                                   
    # mandatory                 
    # -- Contacts                                   
    "host.host_name": "name",                 
    # mandatory                      
    "host.display_name": "sAMAccountName",                               
    "contacthost.contact_nameaddress": "nameipHostNumber",                                      
                                                                         
    "contact.email": "mail",# -- Hostgroups                                               
    "contact.display_name":"displayName",   
    # mandatory                        
    "contact._MEMBER": "uniqueMember",                                   
    "contacthostgroup.hostgroup_PHONEname": "telephoneNumbercn",                                  
    "contact._MOBILE":"mobile",
                                           
    # Co: for country                       
    # -- Contacts                       
    "contact._COUNTRY":"co",                             
    # mandatory           
    # l: for city                                        
                
    ""contact.contact_CITYname": "lname",                                      
           
    "contact._COMPANY":"company",                                        
                  
          "contact.email": "mail",                                             
    # -- Contactgroups"contact.display_name":"displayName",                                
    "contact._MEMBER": "uniqueMember",                
    # mandatory              
        "contact._PHONE":"telephoneNumber",                                    
    "contactgroupcontact.contactgroup_nameMOBILE": "cnmobile",                               
}           
    # Co: for country                                                    
    "contact._COUNTRY":"co",                                    
                            
    # l: for city                                                        
    "contact._CITY":"l",                                                 
    "contact._COMPANY":"company",                                        
                                                                         
    # -- Contactgroups                                                   
    # mandatory                                                          
    "contactgroup.contactgroup_name": "cn"                               
}

Forcer la valeur des propriétés

On peut ajouter "[FORCE]" à la fin du nom de la propriété Shinken, on dit dans ce cas que la valeur est 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 :

Code Block

language	text
theme	Emacs

"contactgroup.members[FORCE]": "members"

Note : il n'y a pas d'espace entre la propriété et le [FORCE].

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 :

Ancienne propriété	Nouvelle propriété Shinken correspondante	Description
hosthost.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.
contactcontact.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.
contactcontact.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ée dans une donnée.
contact.company	contact._COMPANY	La société de société de l'utilisateur sera conservée dans une donnée.
hostgrouphostgroup.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.

Info

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

Si les paramètres du fichier de connexion sont définis, ils seront prioritaires.
Si les paramètres sont absents du fichier de connexion, ceux du fichier de mapping seront pris en compte.

Warning

Les paramètres "contact.classFilter" et "contact.categoryFilter" sont dépréciés et seront supprimés dans une version ultérieure. Veuillez utiliser le paramètre contacts_filter du fichier de connexion pour remplacer ce filtre.

Exemple : "contacts_filter" : "(objectClass=InetOrgPerson)"

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 Active Directory ciblé.

Image Removed

Image Added

Veuillez donc enfin modifier le fichier active-directory-rules.json
Attention, la modification de ce fichier est obligatoire, car certaines propriétés contenant des chemins Active Directory ne permettront pas un import valide si elles ne sont pas modifiées.

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 :

Code Block

language	text
theme	Emacs

"hosts_template": "ldap-host",
"contacts_template": "ldap-user"

Warning

Les paramètres "hosts_tag" et "contacts_tag" sont dépréciés et seront supprimés dans une version ultérieure. Veuillez utiliser le paramètre "hosts_template" et "contacts_template" remplacer ces règles.

Exemple : "contacts_template" : "generic-contact"

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 WindowsServer à tous les hôtes présent dans l'OU "ou=WindowsServer,ou=Datacenter,dc=shinkendom,dc=local", et le modèle "Bordeaux" à tous les contacts présents dans l'OU "ou=Users,ou=Bordeaux,ou=Datacenter,dc=shinkendom,dc=local", il faut configurer les lignes suivantes ::

code

Code Block

language	text
theme	Emacs

"hosts_template_WindowsServer": "ou=WindowsServer,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 :

Code Block

language	text
theme	Emacs

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_" : permet permets d'ajouter le modèle en première position du champs champ use,
- "AddLast_template_" : permet permets d'ajouter le modèle en dernière position du champs champ use,
- "Force_template_" : permet permets 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é utilisée pour les hôtes,
- "_to_contact_matching_" : la règle sera utilisé 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.

Info

title	Propriétés multiples et règles

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, on 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 :

Code Block

language	text
theme	Emacs
title	openldap-rules.json

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

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.

Exemple

Dans cet exemple nous allons ligne par ligne :

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écouvert découverts par la source,
ajouter le modèle "domain-admins" à tous les contact contacts qui font partie du groupe ldap LDAP "cn=Domain Admins,ou=Users,dc=shinken,dc=local".

Code Block

language	bash
theme	jsRDark
title	/etc/shinken-user/source-data/source-data-active-directory-sample/_configuration/active-directory-rules.json

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

Tip
Pour ne définir aucune règle, vous pouvez créer un fichier vide avec seulement les accolades ouvrantes et fermantes ou ne pas préciser de fichier dans la définition de la source.

Import des objets

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

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

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

Panel
Image Modified

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

HOW TO

Importer des ordinateurs avec des noms spécifiques

Image Removed

Image Added

Dans le fichier active-directory-connection.json

Modifiez le paramètre hosts_filter

Code Block

language	text
theme	Emacs

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

Changez SERVER_NAME par le nom de serveur vous voulez importer.

Importer des utilisateurs issus d'un ou plusieurs groupes

Avec la source Active Directory, il est donc possible d'importer des utilisateurs de la base contacts_base spécifiée dans le fichier active-directory-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.

Image Removed

Image Added

Dans le fichier active-directory-connection.json

Dans contacts_filter_with_group, ajouter le Distinguished Name ( DN ) des des différents groupes d'utilisateurs séparés par un pipe ( "|") )

code

Code Block

language	bash
theme	RDark


title	/etc/shinken-user/source-data/source-data-active-directory-sample/_configuration/active-directory-rules.json

  "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 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 le paramètre suivant:

Code Block

language	text
theme	Emacs

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

Précisions techniques

Clés de synchronisation

=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 permettent 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 Active Directory ) ).

Propriétés par défaut utilisé pour la construction des clés de synchronisation

Propriété

Type d'élément

Info

No Format
Nom de l'élément

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

No Format
_SE_UUID

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

No Format
address

hôte

No Format
email

contact

Les clés de synchronisation sont des propriétés des objets utilisées pour les identifier dans les sources. Le fonctionnement et l'utilité des clés de synchronisation sont décrits de manière plus détaillée dans la page de documentation dédiée: Précision techniques sur le fonctionnement de l'import des sources.

Dans notre cas le nom de l'élément est automatiquement ajouté dans les clés de synchronization. Les clés supplémentaires suivantes sont ajoutées :

Pour les hôtes : address,

pour les contacts : email, le préfixe de l'email (la partie avant le @)

Page tree

Page History

Versions Compared

Old Version 5

New Version Current

Key

Vue d'ensemble

Personnaliser la source pré-installée

Introduction

Fonctionnement

Définition de la source

Utilisation de la source

Personnaliser la source pré-installée

Définition de la source

Configuration de la connexion

Paramètres du fichier

Personnaliser la source que vous avez ajouter

Configuration de la connexion

Paramètres du fichier

Exemple

Configuration des règles de "mapping"

Paramètres du fichier

Exemple

Configuration des règles de "mapping"

Paramètres du fichier

Exemple

Exemple

Forcer la valeur des propriétés

Compatibilité avec les anciennes versions

Règles de configuration

Paramètres du fichier

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

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

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

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

Exemple

Import des objets

HOW TO

Importer des ordinateurs avec des noms spécifiques

Importer des utilisateurs issus d'un ou plusieurs groupes

Filtrer et appliquer des modèles

Précisions techniques

Clés de synchronisation

Précisions techniques

Clés de synchronisation

Propriétés par défaut utilisé pour la construction des clés de synchronisation