Versions Compared

Old Version 11

changes.mady.by.user camille dubourgeois

Saved on

compared with

New Version Current

changes.mady.by.user Soubrié Grégoire

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Make by tools (01.00.01) - action=clean_macro_parameter
Scroll Ignore
scroll-viewporttrue
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-htmlfalse
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtruescroll-htmlfalse
Panel
titleSommaire

Table of Contents
stylenone

Présentation

Concept

Cet onglet permet de consulter la configuration de la source définie dans son La configuration du collecteur défini dans le fichier de configuration de la source ( voir la page  pour plus de détails ) peut être consultée dans cet onglet :

Elle est divisée en 5 chapitres :

  • Configuration générale
  • Options de mélange des sources
  • Choix de l'espace où seront placé les éléments importés
  • Paramètres spécifiques à la source
    • Clé de synchronisation ( sync_key )

    page Collecteur de type discovery-import ( Scan NMAP ) ).

    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.

    Nom du paramètre dans l'interfaceNom du paramètre dans le fichierDescription


    Section
    anchorparameter_cfg
    title​
    NomTypeUnitéDéfautCommentaire
    No Format
    Modules Code BlocklanguagetextthemeEmacs
    source_name

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

  • Dois être unique, 
  • d'une  longueur inférieure à 40 caractères,
    • et ne dois pas contenir le caractère "$".Type de Module
    Code Block
    languagetext
    themeEmacs
     module_type

    Type de module chargé par le Synchroniser. Pour cette source le module_type est "discovery-import".

    Intervalle d'import
    Code Block
    languagetext
    themeEmacs
    import_interval

    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.
    Ordre
    Code Block
    languagetext
    themeEmacs
    order
    		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

    , qui a

    (  A un impact dans la fusion des données lors des imports de sources

    .
  • Un nombre
    • Voir

    , voir la page

    du  Le Synchronizer  pour plus d'information au sujet des fusions. 

    Le mélange des sources & les clés de synchronisation (sync-key) ).

    Remarque :  Si

    vous changez

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


    Options de mélange des sources

    Panel

    Image Removed

    Mode de mélange des sources

    Grace au paramètre "Mode de mélange des sources" ( merge_mode dans le fichier de configuration de la source ) il est possible de modifier comment est gérée une source lors de l'étape du mélange des sources.

    Voir la page : Module de source discovery ( de type discovery-import )

    La valeur par défaut est : all

    Les valeurs possibles sont : 

    Nom du paramètre dans l'interfaceNom du paramètre dans le fichierDescriptionmerge_mode
    Code Block
    languagetext
    themeEmacs
    merge_mode

    Ce paramètre peut avoir les valeurs suivantes :

    Label dans l'interfaceValeurs dans le fichierDescriptionNe fusionne pas avec les autresdont_merge_with_other

    Les éléments récoltés par cette source seront importés, mais pas fusionnés avec les autres sources.

    Ce qui implique que si un élément de cette source possède une clé de synchronisation commune avec une autre source alors ces éléments ne pourront être importés et provoquerons un conflit.

    A utiliser si votre source vous donne un élément complet et qui ne doit pas être modifier ni par l'interface de configuration ni d'autre source.

    Seulement avec syncuionly_with_syncui

    Si un élément importé par cette source est aussi récolté par "Syncui", ils seront fusionnés pour ne donner qu'un élément.

    A utiliser si votre source vous donne un élément complet et que vous vous voulez le modifier via l'interface de configuration.

    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

    Image Added

    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

    Section
    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
    Tout sauf syncuiall_without_syncui

    Si un même élément est importé par plusieurs sources (à part "Syncui"), alors les éléments seront fusionnés pour n'en donner qu'un.

    A utiliser si votre source vous donne un élément à compléter avec d'autres sources mais qui ne doit pas être modifié par l'interface de configuration.

    Toutesall  (valeur par défaut)

    Si un même élément est importé par plusieurs sources, alors les éléments seront fusionnés pour n'en donner qu'un.

    Cas par défaut : les éléments de cette source seront complétés avec les autres sources et l'interface de configuration.

    Info

    Syncui est une source qui importe tous les éléments de l'interface de configuration.

    Chaque fois qu'une source est importée, elle l'est aussi. Si une source ne se mélange pas avec Syncui, les modifications sur l'interface de configuration ne seront pas prises en compte .

    Info

    Les sources désactivés ne sont pas prises en compte lors du mélange des sources.

    Détecter les nouveaux éléments

    Les éléments proposés par la source sont soumis au calcul des nouveautés ( cf.  Modules de Sources ( imports ) et de Taggers ( qualification ) ).

    Nom du paramètre dans l'interfaceNom du paramètre dans le fichierDescriptioncompute_new_element
    Code Block
    languagetext
    themeEmacs
    compute_new_element

    Ce paramètre peut avoir les valeurs suivantes :

    Label dans l'interfaceValeurs dans le fichierDescriptioncoché

    authorized 

    (valeur par défaut)

    Activée => le mécanisme de calcul des nouveautés analysera les éléments de la source pour identifier les nouveaux éléments par rapport à l'espace de données Staging. non cochénever_newDésactivée => les éléments de la source n’apparaîtront pas en tant que nouveau, même s'ils n'ont jamais été importés par rapport à l'espace de données Staging.

    Calculer les différences

    Les éléments proposés par la source sont soumis au calcul des différences ( cf. Modules de Sources ( imports ) et de Taggers ( qualification )).

    Nom du paramètre dans l'interfaceNom du paramètre dans le fichierDescriptioncompute_element_difference
    Code Block
    languagetext
    themeEmacs
    compute_element_difference

    Ce paramètre peut avoir les valeurs suivantes :

    Label dans l'interfaceValeurs dans le fichierDescriptioncochée

    authorized 

    (valeur par défaut)

    Activée => le mécanisme de calcul des différences analysera les éléments de la source pour identifier toute différence par rapport à l'espace de données Staging.

    non cochéenever_difference

    Désactivée => les éléments de la source n’apparaîtront pas en tant que différence, même s'ils possèdent des différences par rapport a l'espace de données Staging.

    Suppression des éléments absents

    Détecter les éléments qui ne sont plus présent dans la source

    Permets de proposer en suppression, les éléments qui ne sont plus présents dans la ou les source/s.

    Nom du paramètre dans l'interfaceNom du paramètre dans le fichierDescription

    compute_deleted_element_not

    _in_source

    Code Block
    languagetext
    themeEmacs
    compute_deleted_element_not
_in_source

    Ce paramètre peut avoir les valeurs suivantes :

    Label dans l'interfaceValeurs dans le fichierDescriptionDésactivé

    disabled

    (valeur par défaut)

    Les éléments qui ne sont plus présents dans la(les) source(s) ne seront pas proposés à la suppression.

    Supprimer s'ils ne sont pas dans TOUTES les sources

    delete_if_missing_in

    _all_sources

    Les éléments, qui ne sont plus présents dans cette source et qui n'existent pas dans les autres sources (sauf Syncui), seront proposés à la suppression.

    Supprimer s'ils ne sont pas dans cette source

    delete_if_missing_in

    _this_source

    Les éléments qui ne sont plus présents dans cette source seront proposés à la suppression.

    Choix de l'espace où seront placé les éléments importés

    Panel

    Image Removed

    Mettre dans l'espace

    Permets d'appliquer les différences et d'importer les nouveaux éléments de cette source directement en Staging ou Production ou bien de les laisser dans l'espace de calcul des sources comme par défaut.

    Nom du paramètre dans l'interfaceNom du paramètre dans le fichierDescriptionput_in
    Code Block
    languagetext
    themeEmacs
    put_in

    Ce paramètre peut avoir les valeurs suivantes :

    Label dans l'interfaceValeurs dans le fichierDescriptionEspace de calcul des Sources

    source_space

    (valeur par défaut)

    Les éléments sont sauvegardés dans l'espace de donnée "Sources". Cette espace sera comparée avec l'espace de données "Staging" afin de calculer les nouveautés et les différences.

    Staging

    staging

    Les éléments sont sauvegardés dans les espaces de données "Espace de calcul des Sources" et "Staging".

    Production

    production

    Les éléments sont sauvegardés dans les espaces de données "Espace de calcul des Sources", "Staging" et "Production".

    Production et rechargement de l'Arbiter

    production_and_reload_arbiter

    Les éléments sont sauvegardés dans les espaces de données "Espace de calcul des Sources", "Staging" et "Production".
    L'Arbiter est redémarré afin de soumettre les changements à la supervision.

    Info

    À noter:  Une source avec le paramètre "put in" à la valeur "production" ou "production_and_reload_arbiter" ne poussera en production que les changements qui proviennent de la source et non tous les changements à appliquer en production (tous les changements visibles dans la page de production).

    Ce qui implique que si un utilisateur supprime un élément importer par une source avec le paramètre "put_in" à la valeur "production" ou "production_and_reload_arbiter" alors que l'élément est réimporté par la source : il y aura en production 2 éléments avec le même nom, car la suppression manuelle de l'élément ne sera pas prise en compte ce qui provoquera une erreur.
    Une source avec l'option put_in à production_and_reload_arbiter ne redémarrera l'Arbiter que si elle a des modifications à pousser en production.

    Utilisateur utilisé pour la sauvegarde des changements

    Option qui permet de choisir l'utilisateur qui apparaîtra comme étant le dernier à avoir mis à jour les éléments.

    Info

    À Noter:  l'utilisateur doit être obligatoirement un administrateur Shinken.

    Nom du paramètre dans l'interfaceNom du paramètre dans le fichierValeur dans le fichierDescriptionput_in_user
    Code Block
    languagetext
    themeEmacs
    put_in_user
    shinken-coreLes nouveaux éléments et les éléments différents importés par cette source auront la valeur de cette clé comme utilisateur faisant la dernière modification.

    Clés spécifiques à la source

    Panel

    Image Removed

    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

    Nom du paramètre dans l'interfaceNom du paramètre dans le fichierValeur dans le fichierDescriptiondiscovery-import__database__retry_connection_X_times_before_considering_an_error Code BlocklanguagetextthemeEmacs
    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
    Code Block
    languagetext
    themeEmacs
    discovery-import__database__wait_X_seconds_before_reconnect
    Entier positifSeconde5Temps d'attente entre chaque tentative de requête
    mongomongodb_database
    Code Block
    languagetext
    themeEmacs
    mongodb_database
    synchronizerle nom de la base de donnéesmongodb_retry_timeout
    Code Block
    languagetext
    themeEmacs
    mongodb_retry_timeout
    10Le temps d'attente avant la reconnexion à la base
    mongo
    en cas d'erreurmongodb_ssh_keyfile
    Code Block
    languagetext
    themeEmacs
    mongodb_ssh_keyfile
    ~shinken/.ssh/id_rsaLe chemin ver le fichier de clé privée SSH
    .

    N'est utile que si la connexion apr SSH est utilisée.

    mongodb_ssh_user
    Code Block
    languagetext
    themeEmacs
    mongodb_ssh_user
    shinken

    Nom de l'utilisateur SSH.

    N'est utile que si la connexion apr SSH est utilisée.

    mongodb_uri
    Code Block
    languagetext
    themeEmacs
    mongodb_uri
    mongodb://localhost/?safe=falseAdresse du mongo à utilisermongodb_use_ssh_retry_failure
    Code Block
    languagetext
    themeEmacs
    mongodb_use_ssh_retry_failure
    1

    Nombre de tentative d'essaie en cas d'erreur SSH.

    N'est utile que si la connexion apr SSH est utilisée.

    mongodb_use_ssh_tunnel
    Code Block
    languagetext
    themeEmacs
    mongodb_use_ssh_tunnel
    0Permet d'activer la connexion à MongoDB en passant par un tunnel SSH.

    Règles de découvertes

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

    Nom du paramètre dans l'interfaceNom du paramètre dans le fichierValeur dans le fichierDescriptionrules_path Code Block
    languagetext
    themeEmacs

    Section
    anchorparameter_cfg
    title​
    NomTypeUnitéDéfautCommentaire
    No Format
    rules_path
    		Path---
    rules_path

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

    Le chemin vers le fichier de règle de découverte qui sera utilisé lors de l'import.
    L'utilisation de ce fichier est décrit dans la page
    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

    Section
    anchorparameter_cfg
    title​
    NomTypeUnitéDéfautCommentaire
    No Format
    Nom du paramètre dans l'interfaceNom du paramètre dans le fichierValeur dans le fichierDescriptionnmap_mac_prefixes_path Code BlocklanguagetextthemeEmacs
    nmap_mac_prefixes_path
    		Path---/etc/shinken-user/configuration/daemons/synchronizers/sources/discovery/nmap/nmap-mac-prefixes
    Le chemin vers le fichier des préfixes nmap utilisés dans les imports
    Fichier 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 votre 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 #.


    Votre 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 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 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 :
    Propriété Type d'élémentInfocode


    Section
    anchorparameter_cfg
    title​
    NomTypeUnitéDéfautCommentaire
    No Format
    languagetext
    themeEmacs
    Nom de l'élément
    Tous les éléments


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