| Scroll Ignore |
|---|
| scroll-viewport | true |
|---|
| scroll-pdf | true |
|---|
| scroll-office | true |
|---|
| scroll-chm | true |
|---|
| scroll-docbook | true |
|---|
| scroll-eclipsehelp | true |
|---|
| scroll-epub | true |
|---|
| scroll-html | truefalse |
|---|
|
|
Le Ce 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.
de détecter automatiquement des équipements réseau et des serveurs physiques dans l'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 nmap:
- 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.
Cette page explique comment définir ce type de collecteur.
La page "Collecteur de type discovery-import ( Scan NMAP )" décrit comment l'utiliser ( voir la page Collecteur de type discovery-import ( Scan NMAP ) ).
Il est possible d'avoir uniquement une source de type discovery-import.
Par défaut, l’installation de Shinken Entreprise va mettre à disposition cette source sous le nom "discovery".
- Le fichier est disponible sous /etc/shinken/sources/discovery.cfg
- Pour avoir cette source disponible
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é
Exemple :
| Code Block |
|---|
| language | js |
|---|
| theme | Confluencebash |
|---|
|
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 |
La configuration du module se trouve par défaut dans le dossierfichier /etc/shinken/sources/active-dir-hostsdiscovery.cfg
Vous trouverez un exemple dans .
| Code Block |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
| title | /etc/shinken |
|---|
|
-user-exampleconfiguration/daemons/synchronizers/sources/active-dir-hosts/active-dir-hosts-example.cfgExemple de fichier de configuration
|
# CFG_FORMAT_VERSION 1 ( SHINKEN : DON'T TOUCH THIS LINE )
# |
| Code Block |
|---|
|
#===========================================================================================
# active-dir-examplediscovery
#================================================================================
# Daemons that can load this source:
# - synchronizer
# This source import hosts and contacts from an Active Directory server module allows you to automatically detect network devices and physical servers in your infrastructure and import them in the configuration.
# MANDATORY SOURCE
#================================================================================
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# │ ──────────────────────────────────────────────── SOURCE IDENTITY ──────────────────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Source name [ Must be unique ] core-source-ae7394945adc11e580e6080027f08538
_SE_UUID_HASH d1d512d1e37aae8486d6c2060cada8fd
# End of Shinken Enterprise part
#======== source identity =========
# Source name. Must be unique
source_name [ MANDATORY ] 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───
#source_name interface
import_interval 5
# enabled: is this source enabled or not
enabled discovery
# ─── Source module type [ Do not edit ] 0
# description: display a description on the interface for this source
description [ ThisMANDATORY 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───
module_type ==> 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
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.
| Nom | Type | Unités | Défaut | Commentaire |
|---|
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 "$".
| Texte | --- | ldap-import | Valeur obligatoire et non modifiable ( permet au Synchronizer de charger le code logiciel correspondant ). | Fonctionnement de la source
| Code Block |
|---|
|
define source {
...
orderdiscovery-import
# ─── Interval between each automatic import ───
# ─── Interval in minutes between each automatic import of the source ───
# ─── -> Setting it to 0 will deactivate the automatic import and can only be done manually ───
# Default : 5 3
import_interval 5
enabled 0
description This source is about loading hosts from active directories
...
} |
| Nom | Type | Unités | Défaut | Commentaire |
|---|
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 |
Entier | minutes | 5 | 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.
Booléen | --- | 0 | Permets d'activer ou désactiver la source ( 1 pour activer, 0 pour désactiver ). | Texte | --- | Description du module qui apparaît dans l'interface du Synchronizer. | ───
# ───
import_interval 5
# ─── Order of priority when merging data ───
# ─── The final element will take the value of the element from the source with the highest priority ───
# ─── -> Priority at source with the order closest to 1 ───
# Default : 10 ───
# ───
order 10
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ─────────────────────────────────────────────── DATABASE OPTIONS ──────────────────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ────────────────────── General ────────────────────────────────────────────────────────────────────────────────────────── #
# ─── Database backend ───
# ───
# Default : mongodb => Use Mongo as database backend ───
# ─── ───
data_backend mongodb
# ───────────────── MongoDB parameters ──────────────────────────────────────────────────────────────────────────────────── #
# ─── USE ONLY IF "data_backend" IS SET TO "mongodb" ───
# ─── MongoDB uri definition . You can find the mongodb uri syntax at ───
# ─── https://docs.mongodb.com/manual/reference/connection-string/ ───
# ───
# Default : mongodb://localhost/?w=1&fsync=false ───
# ─── ───
mongodb_uri mongodb://localhost/?w=1&fsync=false
# ─── Database to use ───
# ───
# Default : synchronizer ───
# ─── ───
mongodb_database synchronizer
# ─── username/password to authenticate to MongoDB. ───
# ─── Both parameters must be provided for authentication to function correctly. ───
# ─── ───
# synchronizer__source_discovery-import__database__username
# ─── ───
# synchronizer__source_discovery-import__database__password
# ─── SSH tunnel activation to secure your mongodb connection ───
# ─── That will allow all mongodb to be encrypted & authenticated with SSH ───
# ───
# Default : 0 => Disable ( disable ssh tunnel ) ───
# ... : 1 => Enable ( enable ssh tunnel ) ───
# ─── ───
mongodb_use_ssh_tunnel 0
# ─── If the SSH connection goes wrong, then retry use_ssh_retry_failure time before_shinken_inactive ───
# ───
# Default : 1 ( number of retry ) ───
# ─── ───
mongodb_use_ssh_retry_failure 1
# ─── SSH user to connect to the mongodb server. ───
# ───
# Default : shinken ───
# ─── ───
mongodb_ssh_user shinken
# ─── SSH keyfile to connect to the mongodb server. ───
# ───
# Default : ~shinken/.ssh/id_rsa ───
# ─── ───
mongodb_ssh_keyfile ~shinken/.ssh/id_rsa
# ─── SSH Timeout used to test if the SSH tunnel is viable or not, in seconds. ───
# ───
# Default : 10 ( seconds ) ───
# ─── ───
mongodb_retry_timeout 10
# ─── Number of connection tries to do before considering a request as an error. ───
# ───
# Default : 15 ( tries ) ───
# ─── ───
discovery-import__database__retry_connection_X_times_before_considering_an_error 15
# ─── Time interval between each attempt. ───
# ───
# Default : 5 ( seconds ) ───
# ─── ───
discovery-import__database__wait_X_seconds_before_reconnect 5
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ─────────────────────────────────────────────── INTERNAL OPTIONS ──────────────────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Path to your discovery rules file. ───
# ───
# Default : /etc/shinken-user/configuration/daemons/synchronizers/sources/discovery/discovery_rules.json ───
# ─── ───
rules_path /etc/shinken-user/configuration/daemons/synchronizers/sources/discovery/discovery_rules.json
# ─── Path to your nmap-mac-prefixes file. ───
# ───
# Default : /etc/shinken-user/configuration/daemons/synchronizers/sources/discovery/nmap/nmap-mac-prefixes ───
# ─── ───
nmap_mac_prefixes_path /etc/shinken-user/configuration/daemons/synchronizers/sources/discovery/nmap/nmap-mac-prefixes
} |
Détails des sections composant le fichier de configuration
| Scroll Title |
|---|
| anchor | parameter_cfg |
|---|
| title | |
|---|
|
| Nom | Type | Unité | Défaut | Description |
|---|
| Texte | --- | discovery | Valeur obligatoire et non modifiable. | | Texte | --- | discovery-import | Valeur obligatoire et non modifiable ( permet au Synchronizer de charger le code logiciel correspondant ). | |
Fonctionnement de la source
| Code Block |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
|
define source {
...
# ─── Interval between each automatic import ───
# ─── Interval in minutes between each automatic import of the source ───
# ─── -> Setting it to 0 will deactivate the automatic import and can only be done manually ───
# Default : 5 ───
# ───
import_interval 5
# ─── Order of priority when merging data ───
# ─── The final element will take the value of the element from the source with the highest priority ───
# ─── -> Priority at source with the order closest to 1 ───
# Default : 10 ───
# ───
order 10 ...
} |
| Scroll Title |
|---|
| anchor | parameter_cfg |
|---|
| title | |
|---|
|
| Nom | Type | Unité | Défaut | Description |
|---|
| Entier | --- | 10 | L'ordre de la source dans l'interface de configuration ( A un impact dans la fusion des données lors des imports de sources ). Remarque : Si l'ordre est changé depuis l'interface ( page d’accueil ), le fichier .cfg sera mis à jour. | | Entier | Minute | 5 | 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.
| |
Options d'accès à la base de données
| Code Block |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
| title | /etc/shinken/sources/discovery.cfg |
|---|
|
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ─────────────────────────────────────────────── DATABASE OPTIONS ──────────────────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ────────────────────── General ────────────────────────────────────────────────────────────────────────────────────────── #
# ─── Database backend ───
# ───
# Default : mongodb => Use Mongo as database backend ───
# ─── ───
data_backend mongodb
# ───────────────── MongoDB parameters ──────────────────────────────────────────────────────────────────────────────────── #
# ─── USE ONLY IF "data_backend" IS SET TO "mongodb" ───
# ─── MongoDB uri definition . You can find the mongodb uri syntax at ───
# ─── https://docs.mongodb.com/manual/reference/connection-string/ ───
# ───
# Default : mongodb://localhost/?w=1&fsync=false ───
# ─── ───
mongodb_uri mongodb://localhost/?w=1&fsync=false
# ─── Database to use ───
# ───
# Default : synchronizer ───
# ─── ───
mongodb_database synchronizer
# ─── username/password to authenticate to MongoDB. ───
# ─── Both parameters must be provided for authentication to function correctly. ───
# ─── ───
# synchronizer__source_discovery-import__database__username
# ─── ───
# synchronizer__source_discovery-import__database__password
# ─── SSH tunnel activation to secure your mongodb connection ───
# ─── That will allow all mongodb to be encrypted & authenticated with SSH ───
# ───
# Default : 0 => Disable ( disable ssh tunnel ) ───
# ... : 1 => Enable ( enable ssh tunnel ) ───
# ─── ───
mongodb_use_ssh_tunnel 0
# ─── If the SSH connection goes wrong, then retry use_ssh_retry_failure time before_shinken_inactive ───
# ───
# Default : 1 ( number of retry ) ───
# ─── ───
mongodb_use_ssh_retry_failure 1
# ─── SSH user to connect to the mongodb server. ───
# ───
# Default : shinken ───
# ─── ───
mongodb_ssh_user shinken
# ─── SSH keyfile to connect to the mongodb server. ───
# ───
# Default : ~shinken/.ssh/id_rsa ───
# ─── ───
mongodb_ssh_keyfile ~shinken/.ssh/id_rsa
# ─── SSH Timeout used to test if the SSH tunnel is viable or not, in seconds. ───
# ───
# Default : 10 ( seconds ) ───
# ─── ───
mongodb_retry_timeout 10
# ─── Number of connection tries to do before considering a request as an error. ───
# ───
# Default : 15 ( tries ) ───
# ─── ───
discovery-import__database__retry_connection_X_times_before_considering_an_error 15
# ─── Time interval between each attempt. ───
# ───
# Default : 5 ( seconds ) ───
# ─── ───
discovery-import__database__wait_X_seconds_before_reconnect 5 |
| Scroll Title |
|---|
| anchor | parameter_cfg |
|---|
| title | |
|---|
|
| Nom | Type | Unité | Défaut | Description |
|---|
| Texte | --- | mongodb | Base de données où les informations de la source vont être stockées. | | url | --- | mongodb://localhost/?safe=false | URL d'accès à MongoDB. | | No Format |
|---|
mongodb_database |
| Texte | --- | synchronizer | Base MongoDB où sont stockées les données de la source. | | No Format |
|---|
synchronizer__source_discovery-import__database__username |
| Texte | --- |
| Utilisateur pour l'authentification avec mot de passe à la base MongoDB. Utile uniquement si l'activation par mot de passe a été activé ( voir la page MongoDB - activation de l'authentification par mot de passe ) | | No Format |
|---|
synchronizer__source_discovery-import__database__password |
| Texte | --- |
| Mot de passe de l'utilisateur utilisé pour l'authentification avec mot de passe à la base MongoDB. Utile uniquement si l'activation par mot de passe a été activé ( voir la page MongoDB - activation de l'authentification par mot de passe ) | | No Format |
|---|
mongodb_use_ssh_tunnel |
| 0 ou 1 | --- | 0 | Défini si la connexion à la base de données est directe ou doit être encapsulée dans un tunnel SSH. | | No Format |
|---|
mongodb_use_ssh_retry_failure |
| Entier positif | --- | 1 | Défini le nombre d'essais à réaliser si la connexion à la base de données est perdue. | | No Format |
|---|
mongodb_ssh_user |
| Texte | --- | shinken | L'utilisateur qui sera utilisé si la connexion à la base de données est encapsulée dans un tunnel SSH. | | No Format |
|---|
mongodb_ssh_keyfile |
| Texte | --- | ~shinken/.ssh/id_rsa | La clé SSH qui sera utilisée si la connexion à la base de données est encapsulée dans un tunnel SSH. | | No Format |
|---|
mongodb_retry_timeout |
| Entier positif | Seconde | 10 | Temps de connexion maximum avant que la connexion ne soit considérée comme trop longue et cause un échec de connexion. | | No Format |
|---|
discovery-import__database__retry_connection_X_times_before_considering_an_error |
| Entier positif | --- | 15 | Nombre de tentatives à effectuer avant de considérer une requête mongo comme étant en erreur. | | No Format |
|---|
discovery-import__database__wait_X_seconds_before_reconnect |
| Entier positif | Seconde | 5 | Temps d'attente entre chaque tentative de requête mongo. |
|
| Code Block |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
| title | /etc/shinken/sources/discovery.cfg |
|---|
|
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ─────────────────────────────────────────────── INTERNAL OPTIONS ──────────────────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Path to your discovery rules file. ───
# ───
# Default : /etc/shinken-user/configuration/daemons/synchronizers/sources/discovery/discovery_rules.json ───
# ───
rules_path /etc/shinken-user/configuration/daemons/synchronizers/sources/discovery/discovery_rules.json
# ─── Path to your nmap-mac-prefixes file. ───
# ───
# Default : /etc/shinken-user/configuration/daemons/synchronizers/sources/discovery/nmap/nmap-mac-prefixes ───
# |
| Code Block |
|---|
|
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
...
} ───
nmap_mac_prefixes_path /etc/shinken-user/configuration/daemons/synchronizers/sources/discovery/nmap/nmap-mac-prefixes |
| Scroll Title |
|---|
| anchor | parameter_cfg |
|---|
| title | |
|---|
|
|
| Nom | Type | Unités | Défaut | Commentaire |
|---|
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