Description

Le module de source active-dir-example permet d’interroger un serveur Active Directory afin de récupérer toutes les informations disponibles des hôtes, groupes d'hôtes, utilisateurs et groupes d'utilisateurs présents.

Il est possible d'importer uniquement des hôtes ou uniquement des contacts, depuis certains endroits seulement.

Activation du module

Vous pouvez avoir plusieurs sources de type ldap-import pour, par exemple se connecter à plusieurs serveurs Active Directory.

Par défaut, l’installation de Shinken Entreprise va mettre à disposition un exemple de définition du collecteur Active Directory

Pour ajouter une autre source, vous devez : 

  • Créer un nouveau dossier pour accueillir les fichiers de configuration de votre source dans /etc/shinken-user/source-data/
    ( Exemple : /etc/shinken-user/source-data/source-data-active_directory_bordeaux ).
  • Copier les trois fichiers présents dans /etc/shinken-user-example/sources/active-directory/ dans le dossier de votre source.
  • Copier le fichier d'exemple : /etc/shinken/sources/active-dir-hosts.cfg dans le répertoire de définition des sources /etc/shinken/sources/ avec un nouveau nom
    ( Exemple : /etc/shinken/sources/active_directory_bordeaux.cfg ).
  • Éditer le fichier nouvellement créé :
    • Changer le nom de la source ( clé source_name ).
    • Changer le chemin des trois fichiers vers ceux précédemment copiés dans le dossier de votre source.
  • Ajouter le nom de la nouvelle source au Synchronizer en modifiant la propriété sources du fichier /etc/shinken/synchronizers/synchronizer-master.cfg.


Exemple:

define synchronizer { 
	[...]
    sources                   Source 1, Source 2, Source 3, my-module-livestatus
    [...]
}


Pour prendre en compte le changement de configuration, redémarrer le Synchronizer:

service shinken-synchronizer restart


Configuration

La configuration du module se trouve dans le dossier /etc/shinken/sources/

  • Vous trouverez un exemple dans /etc/shinken/sources/active-dir-hosts.cfg

Exemple de fichier de configuration


#===============================================================================
# active-dir-example
#===============================================================================
# Daemons that can load this source:
# - synchronizer
# This source import hosts and contacts from an Active Directory server
#===============================================================================


define source {
# Shinken Enterprise. Lines added by import core. Do not remove it, it's used by Shinken Enterprise to update your objects if you re-import them.
    _SE_UUID             core-source-ae7394945adc11e580e6080027f08538
    _SE_UUID_HASH        d1d512d1e37aae8486d6c2060cada8fd
# End of Shinken Enterprise part

    #======== source identity =========
    # Source name. Must be unique
    source_name                        active-dir-example

    # Module type (to load module code). Do not edit.
    module_type                        ldap-import

    # order: source order for a source imply if a source is before an another source when
    # merging data
    order                              3

    # import_interval:  in minutes, what is the schedule import interval for this source.
    # note: 0 = don't schedule this source, will run only if an administrator launch it from the
    # interface
    import_interval                    5


    # enabled: is this source enabled or not
    enabled                            0

    # description: display a description on the interface for this source
    description                This source is about loading hosts from active directories

    # Connection mode:
    # - ad: active directory
    # - openldap: openldap.
    mode                              ad


    #======== Active directory access and data mapping =========
    # In order to configure this source, you must copy or edit the sample active-directory source-data available in the directory
    # /etc/shinken-user/source-data/source-data-active-directory-sample/ with theses files:
    #  * _configuration/active-directory-connection.json   ==> how to connect to your active directory server
    #  * _configuration/active-directory-rules.json        ==> what are the import rule to setup (like OU=>template rules)
    #  * _configuration/active-directory-mapping.json      ==> if you have custom Ldap fields, you can defined them in this file (ex: for openldap users)
    #
    # Note: If a file is commented, the configuration will be load from the default directory /etc/shinken/_default/sources/active-directory-source

    # Configuration file for your Active Directory connection (server, user, password, ...)
    connection_configuration_file   /etc/shinken-user/source-data/source-data-active-directory-sample/_configuration/active-directory-connection.json

    # Configuration file for your import rules (like OU=>template rules)
    rules_configuration_file       /etc/shinken-user/source-data/source-data-active-directory-sample/_configuration/active-directory-rules.json

    # Configuration file for your ldap fields mapping (like for openldap users)
    mapping_configuration_file     /etc/shinken-user/source-data/source-data-active-directory-sample/_configuration/active-directory-mapping.json


}


Détails des sections composant le fichier de configuration

Identification du module

Il est possible de définir plusieurs instances de module de type ldap-import. Chaque instance devra avoir un nom unique.

nomtypeUnitésdéfautcommentaire


source_name


Texte---active-dir-example

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

Chaîne de caractères composée de lettres, de chiffres et des caractères _  et -

  • Doit être unique 
  • Doit commencer par une lettre.
  • D'une longueur maximum à 40 caractères
  • Ne doit pas contenir le caractère "$"


module_type 


Texte---ldap-importValeur obligatoire et non modifiable ( permet au Synchronizer de charger le code logiciel correspondant ).


Fonctionnement de la source


define source { 
	[...]
    order              3
    import_interval    5
    enabled            0
    description        This source is about loading hosts from active directories
    [...]
}




nomtypeUnitésdéfautcommentaire


order


Entier---3

L'ordre de la source dans l'interface de configuration ( A un impact dans la fusion des données lors des imports de sources ).

  • Un nombre
  • Voir la page du Synchronizer pour plus d'information au sujet des fusions. 

Remarque : Si vous changez l'ordre depuis l'interface ( page d’accueil ), le fichier .cfg sera mis à jour.


import_interval


Entierminutes5

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.



enabled


Entier---0
  • 1 : Active le module.
  • 0 : Désactive le module.


description


Texte---
Description du module qui apparaît dans l'interface du Synchronizer.


Option du module


define source { 
	[...]
    mode                              ad
    connection_configuration_file     /etc/shinken-user/source-data/source-data-active-directory-sample/_configuration/active-directory-connection.json
    rules_configuration_file          /etc/shinken-user/source-data/source-data-active-directory-sample/_configuration/active-directory-rules.json
    mapping_configuration_file        /etc/shinken-user/source-data/source-data-active-directory-sample/_configuration/active-directory-mapping.json
    [...]
}



nomtypeUnitésdéfautcommentaire






mode


Texte---ad
  • ad : Modifie le chemin de configuration par défaut des propriétés connection_configuration_file, rules_configuration_file et mapping_configuration_file pour correspondre au fichier de configuration par défaut de ad
  • openldap : Modifie le chemin de configuration par défaut des propriété connection_configuration_file, rules_configuration_file et mapping_configuration_file pour correspondre au fichier de configuration par défaut de openldap


connection_configuration_file


Path---

Fichier de configuration de connexion:

  • Défaut ad : /etc/shinken/_default/sources/active-directory-source/active-directory-connection.json
  • Défaut openldap : /etc/shinken/_default/sources/openldap-source/openldap-connection.json


rules_configuration_file


Path---

Fichier de configuration des règles d'import:

  • Défaut ad : /etc/shinken/_default/sources/active-directory-source/active-directory-rules.json
  • Défaut openldap : /etc/shinken/_default/sources/openldap-source/openldap-rules.json






mapping_configuration_file



Path---

Fichier de configuration du mapping des fields personnalisés:

  • Défaut ad : /etc/shinken/_default/sources/active-directory-source/active-directory-mapping.json
  • Défaut openldap : /etc/shinken/_default/sources/openldap-source/openldap-mapping.json


Pour connaitre le contenut des fichier .json voir: HIDDEN - V02.08.02 - Voir la configuration du module ( ldap-import : mode ad ) ou HIDDEN - Collecteur OpenLDAP 02.08.02