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

Contexte

Concept

Cet onglet permet de consulter la configuration de la source définie dans son La configuration du collecteur, définie dans le fichier de configuration de la source ( voir la page Collecteur de type discovery-import ( Scan NMAP ) ), est divisée en 3 chapitres :

  • Configuration générale
  • Clés spécifiques de la source
  • Précisions techniques

    .

    Remarque : Cet onglet ne permet pas encore d'éditer la configuration ( → Sera implémenté dans une prochaine version )

    Configuration générale

    Panel

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


    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfautCommentaire
    No Format
    source_name 
    Texte--- discovery

    Shinken conseille de choisir un nom en fonction de l'utilisation du module pour que la configuration soit simple à maintenir.

    Doit être unique.

    No Format
    module_type 
    Texte--- discovery-import

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

    No Format
    order
    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, voir la page Le mélange des sources & les clés de synchronisation (sync-key) ).

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

    No Format
    import_interval
    EntierMinute 5

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

    • Si 0, la source ne sera jamais exécutée automatiquement.




    Clés spécifiques à la source

    Panel

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

    Paramètres de connexion à Mongo

    La discovery conserve sa configuration ( ses plages réseau, ses règles  de découvertes, ... ) dans une base MongoDB. Ces paramètres permettent de s'y connecter.

    Info

    Il est préférable d'utiliser la même base que le Synchronizer

    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfautCommentaire
    No Format
    data_backend
    Texte---mongodb

    Base de données où les informations de la source vont être stockées.

    No Format
    mongodb_uri
    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.

    • 1 : Connexion par tunnel SSH
    • 0 : Connexion directe
    No Format
    mongodb_use_ssh_retry_failure
    Entier positif---1Défini le nombre d'essais à réaliser si la connexion à la base de données est perdue.
    No Format
    mongodb_ssh_user
    Texte---shinkenL'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_rsaLa 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 positifSeconde10Temps 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 positifSeconde5Temps d'attente entre chaque tentative de requête mongo.

    Règles de découvertes

    Permet de définir le fichier de règle de découverte de la discovery.

    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfautCommentaire
    No Format
    rules_path
    Path---

    /etc/shinken-user/configuration/daemons/ synchronizers/sources/discovery/discovery_rules.json

    Fichier .json comportant les règles de découvertes ( voir la page  Les règles de découvertes du scan réseau ( discovery-import )  ).

    Anchor
    discoveryMacVendor
    discoveryMacVendor

    Correspondance entre l'adresse MAC et le constructeur

    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfautCommentaire
    No Format
    nmap_mac_prefixes_path
    Path---/etc/shinken-user/configuration/daemons/synchronizers/sources/discovery/nmap/nmap-mac-prefixesFichier comportant les propres nmap-mac-prefixes (  Correspondance entre l'adresse MAC et le constructeur  ).

    Lors du scan d'une plage réseau, le collecteur discovery peut remonter le constructeur du matériel à l'aide de nmap.

    Cette détection du constructeur se fait par identification de l'adresse MAC de l'équipement détecté sur le réseau. Pour la correspondance entre adresse MAC et constructeur, nmap utilise un fichier nommé nmap-mac-prefixes qui comporte des adresses MAC associées à des constructeurs (macvendor).

    Par exemple, si la machine récupérée par la discovery a pour adresse MAC "0050BAXXXXX", le constructeur détecté (macvendor) est "D-Link".
    Shinken fournit par défaut un fichier nmap-mac-prefixes qui sert de référence à nmap. Ce fichier est mis à jour à chaque mise à jour de Shinken.

    Panel

    Pour créer des associations entre adresses MAC et constructeur personnalisées, il est possible créer un fichier nmap-mac-prefixes dans /etc/shinken-user/configuration/daemons/synchronizers/sources/discovery/nmap/qui surchargera celui que Shinken met à  disposition lors de l'installation. Un fichier d'exemple est disponible dans /etc/shinken-user-example/configuration/daemons/synchronizers/sources/discovery

    Ce fichier doit être au format de l'exemple donné et peut contenir des commentaires en commençant la ligne par un #.


    Le fichier surcharge la liste présente par défaut dans l'installation de Shinken Entreprise.

    Le fichier par défaut à utiliser comme modèle est le suivant: nmap-mac-prefixes.


    Pour plus d'informations sur la syntaxe à respecter pour ce fichier, la documentation de nmap décrit la syntaxe requise pour ce fichier de préfixes: https://nmap.org/book/nmap-mac-prefixes.html

    L'exemple suivant fournit une illustration sur la découverte d'un NAS Synology et la détection automatique du constructeur.

    Panel

    Précisions techniques

    Anchor
    discoveryNmapDefaultOptions
    discoveryNmapDefaultOptions

    Sécurité : paramètres de la commande nmap

    La commande nmap lancée par la source discovery utilise les paramètres suivants:

    • -PE : Ping Scan ( Echo Request )
    • -sU : Scan UDP
    • -sT : Scan TCP
    • --min-rate 1000 : Envoie un minimum de 1000 paquets par seconde
    • --max-retries 3 : Effectue au maximum 3 retransmissions en cas d'erreur sur les scan de ports
    • -T4 : Optimisation de performances
    • -O : Détection des systèmes d'exploitation
    • -oX : Export XML ( utilisé pour l’interprétation des données par Shinken )

    Anchor
    discoverySyncKeys
    discoverySyncKeys

    Clés de synchronisation

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

    Propriétés par défaut utilisé pour la construction des clés de synchronisation

    Propriétés par défaut utilisé pour la construction des clés de synchronisation :


    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfautCommentaire
    No Format
    languagetext
    themeEmacs
    Nom de l'élément



    Texte------Cette propriété ne peut pas être retirée des propriétés utilisées pour faire les clés de synchronisation
    No Format
    languagetext
    themeEmacs
    _SE_UUID
    Texte------Cette propriété ne peut pas être retirée des propriétés utilisées pour faire les clés de synchronisation
    No Format
    languagetext
    themeEmacs
    address
    Texte------Présente que pour les hôtes