Page History

Description

Le module de source activeldap-dir-example import permet d’interroger un serveur Active Directory ou OpenLDAP 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

collecteur

Vous pouvez

essayer ce type de source soit en activant le collecteur active-dir-example présent par défaut ou en activant  vos propres collecteurs de type ldap-import

.

Activer le collecteur Active Directory livré par défaut

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

Pour ajouter une autre source, vous devez : 

.

• La configuration de ce collecteur se trouve par défaut dans le fichier 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-datasources/sourceactive-data-active_directory_bordeaux ).
• Copier les trois fichiers présents dans /etc/shinken-user-example/sources/active-directory/ dans le dossier de votre source.
• dir-hosts.cfg
• Copier le fichier d'exemple : Vérifier que le nom "active-dir-example" est présent dans le paramètre sources du fichier  /etc/shinken/sourcessynchronizers/activesynchronizer-dir-hostsmaster.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.
• ( ou le .cfg que vous utilisez pour définir les options du Synchronizer ).

• • Ce collecteur est normalement présent dans la liste des sources livrées par défaut.

  • S'il n'y est pas ( car modifié ), vous pouvez le rajouter pour qu'il soit de nouveau actif.
    
    Exemple :
    
    

    Code Block
    language

• • js theme Confluence

    define synchronizer {

• • [...] sources Source 1, Source 2, Source 3,

• • active-

• • dir-

• • example   [...] }

• Si vous avez rajouté la source, redémarrez le Synchronizer pour qu'il puisse prendre en compte

• cette nouvelle source.

  Code Block
  language text theme Emacs

• 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

Ajouter un autre collecteur Active Directory

Vous pouvez avoir plusieurs sources du type ldap-import, pour par exemple se connecter à plusieurs serveurs Open LDAP.

Choisissez un nom pour ce nouveau collecteur.

• Pour l'exemple, nous allons l'appeler "Mon-Collecteur-Active-Directory".
• Remplacer dans l'exemple le mot "Mon-Collecteur-Active-Directory" par le nom que vous aurez choisi.

Pour ajouter une autre source, vous devez : 

• Créer un répertoire pour contenir les fichiers de configuration de la source :

  Code Block
  language text theme Emacs
  mkdir -p /etc/shinken-user/source-data/source-data__Mon-Collecteur-Active-Directory/_configuration

• Copier les fichiers d'exemple dans le répertoire de configuration de la source :

  Code Block
  language text theme Emacs
  cp /etc/shinken-user-example/sources/active-directory/active-directory-* /etc/shinken-user/source-data/source-data__Mon-Collecteur-Active-Directory/_configuration/

• Copier le fichier de définition de la source d'exemple : /etc/shinken/sources/active-dir-hosts.cfg dans le répertoire de définition des sources /etc/shinken/sources/ et modifier son nom pour qu'il soit différent de l'autre source de type ldap-import.
  ( Exemple : /etc/shinken/sources/Mon-Collecteur-Active-Directory.cfg )
  

  Code Block
  language text theme Emacs
  cp /etc/shinken/sources/active-dir-hosts.cfg /etc/shinken/sources/collector__ldap-import__Mon-Collecteur-Active-Directory.cfg

  
  

• Dans ce nouveau fichier, changer le nom de la source et faire correspondre les chemins vers les fichiers de configurations précédemment copiés :

  Code Block
  language js theme Confluence
  ...

• #======== source identity =========

• # Source name. Must be unique source_name serveur_AD_France ... # Configuration file for your Active Directory connection (server, user, password, ...)a connection_configuration_file /etc/shinken-user/source-data/source-data__Mon-Collecteur-Active-Directory/_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__Mon-Collecteur-Active-Directory/_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__Mon-Collecteur-Active-Directory/_configuration/active-directory-mapping.json ...

  Vous trouverez plus de détail sur ces fichiers dans la page Collecteur de type ldap-import ( pour Active Directory ).
  
  

• Une fois que le fichier a été édité, vérifiez que le fichier possède comme droits utilisateurs shinken. Si ce n'est pas le cas, effectuez la commande suivante :
  

  Code Block
  language text theme Emacs
  chown -R shinken:shinken /etc/shinken/sources/collector__ldap-import__Mon-Collecteur-Active-Directory.cfg

• Faire pareil avec les fichiers de configurations de la source et leur ajouter les droits d'écriture :

  Code Block
  language text theme Emacs
  chown -R shinken:shinken /etc/shinken-user/source-data/source-data__Mon-Collecteur-Active-Directory/_configuration chmod -R 664 /etc/shinken-user/source-data/source-data__Mon-Collecteur-Active-Directory/_configuration/

• Ajouter le nom de la nouvelle source au Synchronizer en modifiant le paramètre sources du fichier  /etc/shinken/synchronizers/synchronizer-master.cfg .
  

  Code Block
  language js theme Confluence
  sources syncui,cfg-file-shinken,active-dir-example,cfg-file-nagios,discovery,openldap-example,synchronizer-collector-vmware,Mon-Collecteur-Active-Directory

• Redémarrez le Synchronizer pour qu'il puisse prendre en compte cette nouvelle source

  Code Block
  language text theme Emacs
  service shinken-synchronizer restart

Configuration

Voici le détail de fichier de configuration de la source se trouve :

• Soit le fichier /etc/shinken/sources/active-dir-hosts.cfg
• Soit dans le fichier que vous venez de créer en ajoutant le module ( par exemple /etc/shinken/sources/serveur_AD_France.cfg )

Exemple de fichier de configuration

Vous trouverez un exemple dans /etc/shinken-user-example/configuration/daemons/synchronizers/sources/active-dir-hosts/active-dir-hosts-example.cfg

#===============================================================================
# active-dir-example
#===============================================================================
# Daemons that can load this source:
# - synchronizer
# This source import hosts and contacts from an Active Directory server
#======================================================================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 =========


define source   {
# 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)
    #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

    # Noteorder: Ifsource aorder filefor a issource commented,imply theif configurationa willsource beis loadbefore fromanother thesource defaultwhen directory /etc/shinken/_default/sources/active-directory-source

merging data
    #order		 Configuration file for your Active Directory connection (server, user, password, ...)
 2

    connection_configuration_file# import_interval:   /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

Fonctionnement de la source

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 dans votre architecture Shinken.

• Chaque instance devra avoir un nom unique.

source_name 

module_type 

Fonctionnement de la source

Options du module

Clés de synchronisation ( sync_key )

Défini la liste des propriétés qui seront utilisées pour générer les clés de synchronisation pour chaque type d'éléments importés.

Propriétés non récupérées

Il est possible de définir des propriétés que la source ne devra pas récupérer.

• Dans le cas de cette source, si possible nous conseillons de ne pas utiliser cette option, car il est possible de choisir les champs collecter par cette source.
  • En choisissant les champs collectés, vous gagnerez en performances, car ces informations ne seront pas importées puis supprimées.
• C'est pour ça que cette option n'est pas par défaut dans le fichier de configuration de la source.

Options 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
    [...]
}

mode

• 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 

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 

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 

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