| Scroll Ignore | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|
Présentation
L'onglet de configuration afficher les paramètres de configuration définie dans le fichier de configuration de votre module peut être consultée dans cet onglet ( voir la page Module de source de type ldap-import ( pour Open LDAP ) ) :
La configuration du collecteur définie dans le fichier de configuration de la source ( pour la source par défaut : /etc/shinken/sources/openldap.cfg ) peut être consultée dans cet onglet :
Elle est divisée en 5 chapitres :
- Configuration générale
- Options de mélange des sources
- Dépôts des éléments importés
- Paramètres spécifiques à la source
- Clé de synchronisation ( sync_key )
Remarque : Cet onglet ne permet pas encore d'éditer la configuration ( => Sera implémenté dans une prochaine version )
Configuration générale
| Panel |
|---|
Ce chapitre contient tous les paramètres pour le chargement et fonctionnement des sources en général.
| Nom du paramètre dans l'interface | Nom du paramètre dans le fichier | Description | ||
|---|---|---|---|---|
| Modules |
| Nom de la source affichée dans l'interface de configuration en page d'accueil.
| ||
| Type de Module |
| Type de module chargé par le Synchroniser. Pour cette source le module_type est "ldap-import". | ||
| Intervalle d'import |
| Délai écoulé entre les imports automatiques de la source.
| ||
| Ordre |
| L'ordre de la source dans l'interface de configuration, qui a un impact dans la fusion des données lors des imports de sources.
Remarque : Si vous changez l'ordre depuis l'interface ( page d’accueil ), le fichier cfg sera mis à jour. |
Options de mélange des sources
| Panel |
|---|
Mode de mélange des sources
Grâce au paramètre "Mode de mélange des sources" ( merge_mode dans le fichier de configuration de la source ), il est possible de modifier la gestion d'une source lors de l'étape du mélange des sources.
Voir la page : Le mélange des sources & les clés de synchronisation (sync-key)
La valeur par défaut est : all
Les valeurs possibles sont :
| Nom du paramètre dans l'interface | Nom du paramètre dans le fichier | Description | ||||
|---|---|---|---|---|---|---|
| merge_mode |
| Ce paramètre peut avoir les valeurs suivantes : | ||||
| Label dans l'interface | Valeurs dans le fichier | Description | ||||
| Ne fusionne pas avec les autres | dont_merge_with_other | Les éléments récoltés par cette source seront importés, mais pas fusionnés avec les autres sources. Ce qui implique que si un élément de cette source possède une clé de synchronisation commune avec une autre source alors ces éléments ne pourront être importés et provoquera un conflit. À utiliser si votre source vous donne un élément complet et qui ne doit pas être modifié ni par l'interface de configuration ni d'autres sources. | ||||
| Seulement avec syncui | only_with_syncui | Si un élément importé par cette source est aussi récolté par "Syncui", ils seront fusionnés pour ne donner qu'un élément. A utiliser si votre source vous donne un élément complet et que vous voulez le modifier via l'interface de configuration. | ||||
| Tout sauf syncui | all_without_syncui | Si un même élément est importé par plusieurs sources (à part "Syncui"), alors les éléments seront fusionnés pour n'en donner qu'un. À utiliser si votre source vous donne un élément à compléter avec d'autres sources, mais qui ne doit pas être modifié par l'interface de configuration. | ||||
| Toutes | all (valeur par défaut) | Si un même élément est importé par plusieurs sources, alors les éléments seront fusionnés pour n'en donner qu'un. Cas par défaut : les éléments de cette source seront complétés avec les autres sources et l'interface de configuration. | ||||
| Info |
|---|
Syncui est une source qui importe tous les éléments de l'interface de configuration. Chaque fois qu'une source est importée, elle l'est aussi. Si une source ne se mélange pas avec Syncui, les modifications sur l'interface de configuration ne seront pas prises en compte . |
| Info |
|---|
Les sources désactivées ne sont pas prises en compte lors du mélange des sources. |
Détecter les nouveaux éléments
Les éléments proposés par la source sont soumis au calcul des nouveautés ( cf. Les Modules de détection et de qualification ).
| Nom du paramètre dans l'interface | Nom du paramètre dans le fichier | Description | ||||
|---|---|---|---|---|---|---|
| compute_new_element |
| Ce paramètre peut avoir les valeurs suivantes : | ||||
| Label dans l'interface | Valeurs dans le fichier | Description | ||||
| coché | authorized (valeur par défaut) | Activée => le mécanisme de calcul des nouveautés analysera les éléments de la source pour identifier les nouveaux éléments par rapport à l'espace de données Staging. | ||||
| non coché | never_new | Désactivée => les éléments de la source n’apparaîtront pas en tant que nouveau, même s'ils n'ont jamais été importés par rapport à l'espace de données Staging. | ||||
Calculer les différences
Les éléments proposés par la source sont soumis au calcul des différences ( cf. Les Modules de détection et de qualification).
| Nom du paramètre dans l'interface | Nom du paramètre dans le fichier | Description | ||||
|---|---|---|---|---|---|---|
| compute_element_difference |
| Ce paramètre peut avoir les valeurs suivantes : | ||||
| Label dans l'interface | Valeurs dans le fichier | Description | ||||
| cochée | authorized (valeur par défaut) | Activée => le mécanisme de calcul des différences analysera les éléments de la source pour identifier toute différence par rapport à l'espace de données Staging. | ||||
| non cochée | never_difference | Désactivée => les éléments de la source n’apparaîtront pas en tant que différence, même s'ils possèdent des différences par rapport a l'espace de données Staging. | ||||
Suppression des éléments absents
Détecter les éléments qui ne sont plus présent dans la source
Permets de proposer en suppression, les éléments qui ne sont plus présents dans la ou les source/s.
| Nom du paramètre dans l'interface | Nom du paramètre dans le fichier | Description | ||||
|---|---|---|---|---|---|---|
compute_deleted_element_not _in_source |
| Ce paramètre peut avoir les valeurs suivantes : | ||||
| Label dans l'interface | Valeurs dans le fichier | Description | ||||
| Désactivé | disabled (valeur par défaut) | Les éléments qui ne sont plus présents dans la(les) source(s) ne seront pas proposés à la suppression. | ||||
| Supprimer s'ils ne sont pas dans TOUTES les sources | delete_if_missing_in _all_sources | Les éléments, qui ne sont plus présents dans cette source et qui n'existent pas dans les autres sources (sauf Syncui), seront proposés à la suppression. | ||||
| Supprimer s'ils ne sont pas dans cette source | delete_if_missing_in _this_source | Les éléments qui ne sont plus présents dans cette source seront proposés à la suppression. | ||||
Dépôt des éléments après l'import
| Panel |
|---|
Mettre dans l'espace
Permet d'appliquer les différences et d'importer les nouveaux éléments de cette source directement en Staging ou Production ou bien de les laisser dans l'espace de calcul des sources comme par défaut.
| Nom du paramètre dans l'interface | Nom du paramètre dans le fichier | Description | ||||
|---|---|---|---|---|---|---|
| put_in |
| Ce paramètre peut avoir les valeurs suivantes : | ||||
| Label dans l'interface | Valeurs dans le fichier | Description | ||||
| Espace de calcul des Sources | source_space (valeur par défaut) | Les éléments sont sauvegardés dans l'espace de donnée "Sources". Cette espace sera comparée avec l'espace de données "Staging" afin de calculer les nouveautés et les différences. | ||||
| Staging | staging | Les éléments sont sauvegardés dans les espaces de données "Espace de calcul des Sources" et "Staging". | ||||
| Production | production | Les éléments sont sauvegardés dans les espaces de données "Espace de calcul des Sources", "Staging" et "Production". | ||||
| Production et rechargement de l'Arbiter | production_and_reload_arbiter | Les éléments sont sauvegardés dans les espaces de données "Espace de calcul des Sources", "Staging" et "Production". | ||||
| Info |
|---|
À noter: Une source avec le paramètre "put in" à la valeur "production" ou "production_and_reload_arbiter" ne poussera en production que les changements qui proviennent de la source et non tous les changements à appliquer en production (tous les changements visibles dans la page de production). Ce qui implique que si un utilisateur supprime un élément importé par une source avec le paramètre "put_in" à la valeur "production" ou "production_and_reload_arbiter" alors que l'élément est réimporté par la source : il y aura en production 2 éléments avec le même nom, car la suppression manuelle de l'élément ne sera pas prise en compte ce qui provoquera une erreur. |
Utilisateur utilisé pour la sauvegarde des changements
Option qui permet de choisir l'utilisateur qui apparaîtra comme étant le dernier à avoir mis à jour les éléments.
| Info |
|---|
À Noter: l'utilisateur doit être obligatoirement un administrateur Shinken. |
| Nom du paramètre dans l'interface | Nom du paramètre dans le fichier | Valeurs dans le fichier | Description | ||
|---|---|---|---|---|---|
| put_in_user |
| shinken-core | Les nouveaux éléments et les éléments différents importés par cette source auront la valeur de cette clé comme utilisateur faisant la dernière modification. |
Clés spécifiques à la source
| Panel |
|---|
Ce chapitre liste tous les paramètres qui sont spécifiques au fonctionnement de cette source.
| Anchor | ||||
|---|---|---|---|---|
|
Format des fichiers JSON chargés par le module
Dans cette source, plusieurs fichiers JSON seront à configurer. Ils respectent tous le même format que voici :
- Le fichier débute par une ligne avec seulement une accolade ouvrante : {
- Toute ligne commençant par un dièse ( # ) sera considérée comme un commentaire et ne sera pas interprétée par la source
- Chaque ligne valide ( lue par la source ) est constituée de :
- le nom du paramètre entre guillemets : "nom_du_paramètre"
- le symbole deux-points ( : ) séparant le nom du paramètre de sa valeur
- la valeur du paramètre entre guillemets : "valeur du paramètre"
- le symbole virgule ( , ) s'il ne s'agit pas de la dernière ligne de définition d'un paramètre.
- Le fichier se termine par une ligne avec seulement une accolade fermante : }
Accès au serveur et arborescence des données
Implémentation du protocole LDAP
Le module implémentant le protocole LDAP, il peut être nécessaire de lui préciser l'implémentation à utiliser. Le paramètre mode doit donc être configuré sur openldap pour notre source Collecteur Open LDAP. Ce mode gère également d'autres implémentations telles qu’Oracle Directory Server Enterprise Edition.
| Info |
|---|
Pour se connecter à un serveur Active Directory, il faut utiliser le Collecteur Active Directory |
| Nom du paramètre dans l'interface | Nom du paramètre dans le fichier | Description |
|---|---|---|
| mode | mode | Indique l'implémentation du protocole LDAP. Doit être à la valeur openldap pour ce collecteur |
Définition de l'accès au serveur
L'accès au serveur Open LDAP se configure dans le fichier indiqué par le paramètre connection_configuration_file.
| Nom du paramètre dans l'interface | Nom du paramètre dans le fichier | Description |
|---|---|---|
| connection_configuration_file | connection_configuration_file | Chemin vers le fichier de configuration de la connexion au serveur Open LDAP |
| Info |
|---|
| Ce fichier est lu à chaque import du collecteur, il est donc inutile de redémarrer le Synchronizer si vous modifier ce fichier |
Le fichier indiqué dans ce paramètre ( par défaut /etc/shinken-user/source-data/source-data-openldap-sample/_configuration/openldap-connection.json ) doit respecter le format des fichiers Json. Voici les paramètres obligatoires à renseigner dans le fichier, qui permettent de définir la connexion au serveur Open LDAP :
| Nom du paramètre | Description |
|---|---|
| url | Adresse de votre serveur Open LDAP |
| ldap_protocol | Version du protocole LDAP (par défaut à 3 si pas spécifié) |
| base | OU (Organisation Unit) de base pour la découverte de vos objets. Permet de définir la racine de recherche des éléments à importer. |
| username | Utilisateur utilisé pour la connexion au serveur Open LDAP. Il peut s'agir d'un compte en lecteur seule. |
| password | Mot de passe utilisé pour la connexion au serveur Open LDAP |
| 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 Open LDAP 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é. |
Arborescence et filtrage des données
Import des hôtes et groupes d'hôtes
Afin d'importer des hôtes et des groupes d'hôtes, il faut spécifier au module ou rechercher ces éléments dans le serveur Open LDAP.
| Paramètre | Valeur par défaut | Description |
|---|---|---|
| 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 | Filtre au format LDAP permettant de ne filtrer que les hôtes 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) | Filtre au format LDAP utilisé pour découvrir uniquement certains groupes d'hôtes. |
| Tip |
|---|
Si vous ne souhaitez pas importer d'objets Open LDAP 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. |
Import des contacts et groupes de contacts
| Paramètre | Valeur par défaut | Description |
|---|---|---|
| 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)) | Filtre au format LDAP utilisé pour découvrir uniquement certains contacts. |
| contacts_filter_with_group | Filtre au format LDAP permettant de ne filtrer que les contacts présents dans des groupes définis. | |
| 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 Open LDAP 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 |
Exemples
Voici un exemple de ce fichier
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
# Mandatory
"url": "ldap://192.168.1.240",
"ldap_protocol":3,
"base": "dc=shinkendom,dc=local",
"username": "cn=administrateur,dc=shinkendom,dc=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 mapping des informations collectées
Le mapping des informations collectées par la source se configurent dans le fichier indiqué par le paramètre mapping_configuration_file. Une page est dédiée à ce mapping : Le mapping des informations collectées des champs du serveur Open LDAP vers les propriétés et les données Shinken
| Nom du paramètre dans l'interface | Nom du paramètre dans le fichier | Description | ||
|---|---|---|---|---|
| mapping_configuration_file |
| Chemin vers le fichier de correspondance des attributs LDAP vers les propriétés et données Shinken |
Les règles d'application des modèles
Les règles d'application des modèles par la source se configurent dans le fichier indiqué par le paramètre rules_configuration_file. Une page est dédiée à ces règles : Les règles d'application des modèles par rapport aux champs collectés du serveur Open LDAP
| Nom du paramètre dans l'interface | Nom du paramètre dans le fichier | Description | ||
|---|---|---|---|---|
| rules_configuration_file |
| Chemin vers le fichier de configuration des règles d'ajout de modèles sur les éléments importés |
Précisions techniques
Clés de synchronisation
| Panel |
|---|
Les clés de synchronisation sont des valeurs utilisées lors de l'étape du mélange des sources ( Voir 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 HIDDEN - V02.08.02 - Le mélange des sources & les clés de synchronisation (sync-key)).
Les paramètres properties_used_as_synckey_for_host, properties_used_as_synckey_for_hostgroup, properties_used_as_synckey_for_contact et properties_used_as_synckey_for_contactgroup de la source permettent d'ajouter les propriétés qui serviront à créer les clés de synchronisation ( Voir 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
| 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 |




