Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Scroll Ignore
scroll-viewporttrue
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmlfalse
Panel
titleSommaire

Table of Contents
stylenone

Présentation

L'onglet de configuration affiché les paramètres de configuration définie dans le fichier de configuration de votre module peut être consultés dans cet onglet ( voir la page Collecteur de type ldap-import ( pour Active Directory ) ) :

Elle est divisée en 5 chapitres :

  • Configuration générale.
  • Options de mélange des sources.
  • Choix de l'espace où seront placé les é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

Image Modified

Ce chapitre contient tous les paramètres pour le chargement et le fonctionnement des sources en général.

Nom du paramètre dans l'interfaceNom du paramètre dans le fichierDescription
Modules
Code Block
source_name

Nom de la source affichée dans l'interface de configuration en page d'accueil.

  • Dois être unique, 
  • d'une  longueur inférieure à 40 caractères,
  • et ne dois pas contenir le caractère "$".
Type de Module
Code Block
 module_type

Type de module chargé par le Synchroniser. Pour cette source le module_type est "ldap-import".

Intervalle d'import
Code Block
import_interval

Délai écoulé entre les imports automatiques de la source. 

  • Un nombre ( en minutes )
  • Si 0, la source ne sera jamais exécutée automatiquement.
Ordre
Code Block
order

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.

  • Un nombre
  • Pour plus d'information au sujet des fusions, voir la page Le Synchronizer.

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

Image Modified

Mode de mélange des sources

Grace 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 Concept général et utilisation des sources.

La valeur par défaut est : all

Les valeurs possibles sont : 

Nom du paramètre dans l'interfaceNom du paramètre dans le fichier

merge_mode
Code Block
merge_mode

Ce paramètre peut avoir les valeurs suivantes :




Valeurs dans le fichierDescription


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.



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.

À utiliser si votre source vous donne un élément complet et que vous voulez le modifier via l'interface de configuration.



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.



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 ( voir la page Les Modules de détection Sources ( imports ) et de Taggers ( qualification ) ).


Nom du paramètre dans l'interfaceNom du paramètre dans le fichierDescription

compute_new_element
Code Block
compute_new_element

Ce paramètre peut avoir les valeurs suivantes :

Valeurs dans le fichierDescription

authorized
( valeur par défau t)

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.
never_newDé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 ( voir la page Les Modules de détection Sources ( imports ) et de Taggers ( qualification ) ).


Nom du paramètre dans l'interfaceNom du paramètre dans le fichierDescription

compute_element_difference
Code Block
compute_element_difference

Ce paramètre peut avoir les valeurs suivantes :

Valeurs dans le fichierDescription

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.
never_differenceDé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'interfaceNom du paramètre dans le fichierDescription

compute_deleted_element_not

_in_source

Code Block
compute_deleted_element_not
_in_source

Ce paramètre peut avoir les valeurs suivantes :

Valeurs dans le fichierDescription

disabled
( valeur par défaut )

Les éléments qui ne sont plus présents dans les sources ne seront pas proposés à la suppression.

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.

delete_if_missing_in_this_source

Les éléments qui ne sont plus présents dans cette source seront proposés à la suppression.

Choix de l'espace où seront placé les éléments importés

Panel

Image Modified

Mettre dans l'espace

Permets 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'interfaceNom du paramètre dans le fichierDescription

put_in
Code Block
put_in

Ce paramètre peut avoir les valeurs suivantes :

Valeurs dans le fichierDescription

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 Les éléments sont sauvegardés dans les espaces de données "Espace de calcul des Sources" et "Staging".
productionLes éléments sont sauvegardés dans les espaces de données "Espace de calcul des Sources", "Staging" et "Production".
production_and_reload_arbiterLes éléments sont sauvegardés dans les espaces de données "Espace de calcul des Sources", "Staging" et "Production".
L'Arbiter est redémarré afin de soumettre les changements à la supervision.
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.
Une source avec l'option put_in à production_and_reload_arbiter ne redémarrera l'Arbiter que si elle a des modifications à pousser en production.

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'interfaceNom du paramètre dans le fichierValeurs dans le fichierDescription
put_in_user
Code Block
put_in_user
shinken-coreLes 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

Image Modified

Ce chapitre liste tous les paramètres qui sont spécifiques au fonctionnement de cette source.

Anchor
FormatFichiersJson
FormatFichiersJson

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 est nécessaire de lui préciser que notre source va fonctionner avec l'implémentation de Microsoft : Active Directory. Le paramètre mode doit donc être configuré sur ad pour notre source Collecteur Active Directory.


Info

Pour se connecter à un serveur Open LDAP, il faut utiliser le Collecteur OpenLDAP ( voir la page Collecteur de type ( ldap-import ) depuis un serveur OpenLDAP ).

Nom du paramètre dans l'interfaceNom du paramètre dans le fichierDescription
modemodeIndique l'implémentation du protocole LDAP. Doit être à la valeur ad pour ce collecteur

Définition de l'accès au serveur

L'accès au serveur Active Directory se configure dans le fichier indiqué par le paramètre connection_configuration_file.

Nom du paramètre dans l'interfaceNom du paramètre dans le fichierDescription
connection_configuration_fileconnection_configuration_fileChemin vers le fichier de configuration de la connexion au serveur Active Directory
Info

Ce fichier est lu à chaque import du collecteur, il est donc inutile de redémarrer le Synchronizer si vous modifiez ce fichier


Le fichier indiqué dans ce paramètre ( par défaut /etc/shinken-user/source-data/source-data-active-directory-sample/_configuration/active-directory-connection.json ) doit respecter le format des fichiers Json ( voir la page JavaScript Object Notation ). Voici les paramètres obligatoires à renseigner dans le fichier, qui permettent de définir la connexion au serveur Active Directory :


Nom du paramètreDescription
urlAdresse de votre serveur Active Directory
ldap_protocolVersion du protocole LDAP ( par défaut à 3 si pas spécifié )
baseOU ( Organisation Unit ) de base pour la découverte de vos objets. Permet de définir la racine de recherche des éléments à importer.
usernameUtilisateur utilisé pour la connexion au serveur Active Directory. Il peut s'agir d'un compte en lecteur seule.
passwordMot de passe utilisé pour la connexion au 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. 

Tip
titleTip

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

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

ParamètreValeur par défautDescription
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 Active Directory 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ètreValeur par défautDescription
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 Active Directory 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
languagejs
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))"
 }

Le mapping des informations collectées

Le mapping des informations collectées par la source se configure dans le fichier indiqué par le paramètre mapping_configuration_file
Voir ( voir la page Le mapping des informations collectées des champs du serveur Active Directory vers les propriétés et les données Shinken.

Nom du paramètre dans l'interfaceNom du paramètre dans le fichierDescription
mapping_configuration_file
Code Block
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
Voir la page Les règles d'application des modèles par rapport aux champs collectés du serveur Active Directory.

Nom du paramètre dans l'interfaceNom du paramètre dans le fichierDescription
rules_configuration_file
Code Block
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

Image Modified

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_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 la page Collecteur 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émentInfo
Code Block
Nom de l'élément
Tous les élémentsCette propriété ne peut pas être retirée des propriétés utilisées pour faire les clés de synchronisation
Code Block
_SE_UUID
Tous les élémentsCette propriété ne peut pas être retirée des propriétés utilisées pour faire les clés de synchronisation
Code Block
address
hôte
Code Block
email
contact