Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Scroll Ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue


Panel
titleSommaire

Table of Contents
stylenone



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 des contacts, depuis certains endroits seulement

Ce module source vous permet de détecter automatiquement des équipements réseau et des serveurs physiques dans votre infrastructure pour faciliter et accélérer leur import dans la configuration.

Cette source utilise la commande nmap pour la découverte des équipements, pour cela la commande :

  • Scanne les machines présentes sur le réseau et détecte les ports ouverts
  • Essaye de déterminer le constructeur de l'équipement en fonction de son adresse MAC
  • Si possible, détermine son FQDN ( Fully Qualified Domain Name ).

La source Discovery permet de définir des règles qui, suivant les valeurs remontées par la commande nmap, apportent un complément d'information sur les équipements découverts. Ce complément d'information peut être :

  • Des modèles d'hôtes suivant le type d'équipement.
  • L'ajout d'un préfixe au nom de l'équipement.

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.
  • cette source sous le nom "discovery".

    Copier le fichier d'exemple :

    Le fichier est disponible sous

    /etc/shinken/sources/discovery.cfg

    Pour avoir cette source disponible

    • Le nom "discovery" doit être présent dans le paramètre
    • 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:

    Code Block
    languagebash
    define synchronizer { 
    	...
        sources                   Source 1, Source 2, Source 3, active_directory_bordeaux discovery
         ...
    }


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

    Code Block
    service shinken-synchronizer restart


    Configuration

    La configuration du module se trouve dans le dossier /etc/shinken/sources/active-dir-hosts.cfg

    Vous trouverez un exemple dans

    Fichier de configuration


    Code Block
    languagebash
    title/etc/shinken
    -user-example/configuration/daemons/synchronizers
    /sources/
    active-dir-hosts/active-dir-hosts-example.cfg

    Exemple de fichier de configuration

    Code Block
    languagebashdiscovery.cfg
    #===============================================================================
    # active-dir-examplediscovery
    #===============================================================================
    # Daemons that can load this source:
    # - synchronizer
    # ThisMandatory source, importdo hosts and contacts from an Active Directory servernot edit.
    #===============================================================================
    
    
    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_name        d1d512d1e37aae8486d6c2060cada8fd
    # End of Shinken Enterprise part
    
        #======== source identity ========= discovery
        #order Source name. Must be unique
        source_name                10000000
        import_interval    active-dir-example
    
        # Module type (to load module code). Do not edit.5
        module_type                        ldapdiscovery-import
    
        # order: source order for a source imply if a source is before an another source when
        # merging data
     data_backend    order                              3
    mongodb
        # import_interval:mongodb_uri  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 mongodb://localhost/?safe=false
        # interface
        import_intervalmongodb_database                    5
    
    
        # enabled: is this source enabled or not
        enabled                   synchronizer
        mongodb_use_ssh_tunnel         0
    
        # description: display a description on the interface for this sourcemongodb_use_ssh_retry_failure 1
        descriptionmongodb_ssh_user                This source is about loading hosts from active directories
    shinken
        # Connection mode:
        # - ad: active directory
    mongodb_ssh_keyfile         # - 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 ~shinken/.ssh/id_rsa
        mongodb_retry_timeout         10
        rules_path      ==> 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_fileuser/configuration/daemons/synchronizers/sources/discovery/discovery_rules.json
        nmap_mac_prefixes_path        /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
    
    
    }
    
    configuration/daemons/synchronizers/sources/discovery/nmap/nmap-mac-prefixes
    }
       


    Détails des sections composant le fichier de configuration

    Identification du

    moduleIl est possible de définir plusieurs instances de

    module

    de type ldap-import dans votre architecture Shinken.Chaque instance devra avoir un nom unique.


    NomTypeUnitésDéfautCommentaire


    Code Block
    source_name 


    Texte---active-dir-example

    Nous vous conseillons de choisir un nom en fonction de l'utilisation du module pour que votre configuration soit simple à maintenir.

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

    Valeur obligatoire et non modifiable


    Code Block
    module_type 


    Texte---ldapdiscovery-import

    Valeur obligatoire et non modifiable ( permet au Synchronizer de charger le code logiciel correspondant ).


    Fonctionnement de la source


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




    NomTypeUnitésDéfautCommentaire


    Code Block
    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.


    Code Block
    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.



    Code Block
    enabled


    Booléen---0

    Permets d'activer ou désactiver la source ( 1 pour activer, 0 pour désactiver ).


    Code Block
    description


    Texte---

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


    Options du module


    Code Block
    languagebash
    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






    Code Block
    mode


    Texte---ad

    Deux modes possibles :

    • ad : Ce mode permet de communiquer avec ad. 
      Lorsque ce mode est activé, cela modifie les chemins par défaut de ces paramètres :
      • connection_configuration_file
      • rules_configuration_file
      • mapping_configuration_file
    • openldap : Ce mode permet de communiquer avec un openldap. 
    • Lorsque ce mode est activé, cela modifie les chemins par défaut de ces paramètres :
      • connection_configuration_file
      • rules_configuration_file
      • mapping_configuration_file


    Code Block
    connection_configuration_file 


    Path---

    Fichier de configuration de connexion:

    • Pour le mode ad : /etc/shinken/_default/sources/active-directory-source/active-directory-connection.json
    • Pour le mode openldap : /etc/shinken/_default/sources/openldap-source/openldap-connection.json


    Code Block
    rules_configuration_file 


    Path---

    Fichier de configuration des règles d'import:

    • Pour le mode ad : /etc/shinken/_default/sources/active-directory-source/active-directory-rules.json
    • Pour le mode openldap : /etc/shinken/_default/sources/openldap-source/openldap-rules.json






    Code Block
    mapping_configuration_file 



    Path---

    Fichier de configuration du mapping des fields personnalisés:

    • Pour le mode ad : /etc/shinken/_default/sources/active-directory-source/active-directory-mapping.json
    • Pour le mode openldap : /etc/shinken/_default/sources/openldap-source/openldap-mapping.json


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