Page History

Scroll Ignore

scroll-viewport	true
scroll-pdf	true
scroll-office	true
scroll-chm	true
scroll-htmldocbook	falsetrue
scroll-docbookeclipsehelp	true
scroll-eclipsehelpepub	true
scroll-epubhtml	truefalse

Panel

title	Sommaire

Table of Contents

style	none

Qu'est-ce qu'une règle de mapping Open LDAP OpenLDAP ?

Une règle de mapping permet de mettre en relation, lors de l'import, un attribut LDAP avec une propriété ou une donnée Shinken en fonction du type de l'élément ( hôte, groupe d'hôtehôtes, utilisateur, etc ... ).

Une règle peut s'appliquer pour tous les types d’éléments présents dans l'interface de Shinken.

Définition d'une règle de mapping utilisateur

Chaque ligne de ce fichier définit une correspondance entre une propriété ou donnée Shinken avec et un attribut 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 son attribut dans LDAP :

noformat

Code Block

language	bash
theme	RDark

"host.host_name": "name",

Elle est définie par :

la La propriété shinken Shinken entre guillemets découpée en deux parties :
- le Le type de l'élément au singulier. Les types disponibles sont : "host", "contact", "hostgroup" et "contactgroup".
- le Le point permet de joindre les deux parties.
- la La propriété ou la donnée de l'élément. Cette propriété ou donnée est la "clé d'import" que l'on peut retrouver sur l'interface dans la fenêtre d'aide.
le Le séparateur "deux points".
lL'attribut LDAP entre guillemets.
une Une virgule, s'il ne s'agit pas de la dernière ligne non commentée.

Tip
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 choisir avec quelles propriétés Shinken on peut faire correspondre les attributs LDAP. Si ce fichier n'est pas définisdéfini, un mapping par défaut sera utilisé. Voici ses valeurs .:

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

Tip
Pour ne pas importer les propriétés par défaut, un fichier de "mapping" doit être définis défini avec la clé souhaitée et sa valeur à vide.

Forcer la valeur des propriétés

On peut ajouter "Il est possible d’ajouter le suffixe [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 ( sans rajouter d'espace ) à la clé d’import d'un élément Shinken afin de forcer la valeur associée ( voir la page Forcer la valeur des noms des éléments et des propriétés de type liste (comme la propriété des modèles hérités) ).

Exemple :

Code Block

language	bash
theme	RDark

"host.address[FORCE]": "ipHostNumber",

Lorsqu’une propriété est marquée avec [FORCE], elle est traitée de la manière suivante par le mélange des sources :

La valeur est considérée comme prioritaire par rapport aux autres sources.
Si une autre source

essaye d'importer

importe le même objet avec une valeur différente, cette dernière est ignorée.
En cas de conflit entre plusieurs valeurs forcées, la priorité de la source détermine la valeur conservée.

Ajouter [FORCE] à une clé d'import contenant , 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 des autres sources par celle fournie avec l'option [FORCE].

Liste des clés d'import pouvant être forcées

Excerpt Include

	Syntaxe des fichiers d'imports
	Syntaxe des fichiers d'imports
nopanel	true

Ex :

Code Block

language	bash
theme	RDark

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

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

Chemin du fichier de définition des règles de mapping

Pour ajouter une règle utilisateur d'application des modèles, il faut éditer le chemin suivant :

Code Block

language	text
theme	Emacs

/etc/shinken-user/source-data/source-data-[nom de la source]/_configuration/openldap-mapping.json

Info

icon	false
title	Exemple de chemin pour la source livrée par défaut :

/etc/shinken-user/source-data/source-data-openldap-sample/_configuration/openldap-mapping.json

Exemple

Code Block

language	js
theme	Confluence
title	/etc/shinken-user/source-data/source-data-openldap-sample/_configuration/openldap-mapping.json

# IMPORTANT: Do not edit this file.
# To have your own mapping, copy it under the /etc/shinken-users/source-data/YOUR_SOURCE_FOLDER/_configuration/ directory and edit your copy instead.
# Note: comments should be with a # starting the line, NOT after a value
{
    # 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",
    "host._OS": "operatingSystem",


    # -- 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"
}

Compatibilité avec les anciennes versions

Pour des raisons de compatibilité avec les versions inférieures anté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 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 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 e-mail 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 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 contacts n'étaient pas importés. Désormais ils le sont et 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. Le paramètre contacts_filter du fichier de connexion doit être utilité utilisé pour remplacer ce filtreces filtres.

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

Page tree

Versions Compared

Old Version 5

New Version Current

Key

Qu'est-ce qu'une règle de mapping Open LDAP OpenLDAP ?

Définition d'une règle de mapping utilisateur

Forcer la valeur des propriétés

Liste des clés d'import pouvant être forcées

Chemin du fichier de définition des règles de mapping

Exemple

Compatibilité avec les anciennes versions