Versions Compared

Key

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

Table of Contents
stylenone

Concept

Les sources de type synchronizer_collector_excel permettent d'importer des éléments ( hôte, modèle d'hôte, check, utilisateurs ... ) à partir d'un fichier Excel.

Les formats de fichier supportés sont : 

  • Spreadsheet ( *.xls ) : Format des anciennes versions d'Excel.
  • Excel Workbook ( *.xlsx ) : Format des nouvelles versions d'Excel, à partir d'Excel 2007.


Cette page explique comment définir ce type de collecteur ( pour l'utilisation du collecteur, voir la page Collecteur de type ( synchronizer-collector-excel ) - Import depuis des fichiers Excel ( xls ou xlsx ) ) .

Importer des données

Panel

Shinken impose l'agencement des informations dans le fichier Excel :

  • Il doit y avoir un onglet par type d'élément à importer ( hôtes, clusters, etc ).
    • Chaque ligne de ces onglets décrit un objet à importer.
    • Chaque colonne une information, par exemple le nom d'un hôte, son adresse IP ou le datacenter dans lequel il est hébergé.
  • Il doit y avoir un onglet "Configuration", qui :
    • Décrit pour chaque onglet quel type d'objet Shinken sera importé ( par exemple, l'onglet "Équipements à importer" peut contenir des hôtes ).
    • Décrit dans quelle propriété de Shinken seront récupérées les informations des différentes colonnes des autres onglets ( par exemple la colonne "Adresse de l'hôte" peut contenir l'adresse IP de l'hôte ).


Panel

Shinken fournit un fichier d'exemple ( disponible ici : Excel-import-file.xlsx ) contenant déjà des éléments prêts à être importés. Il est possible de le modifier pour correspondre aux besoins :

  • Dans les différents onglets, on peut modifier les colonnes pour ajouter des données, renommer des colonnes ou supprimer celles inutiles.
  • On peut ajouter des onglets pour importer de nouveaux types d'éléments.
  • On peut supprimer les onglets inutiles, ou les laisser vides.

Une fois les onglets et colonnes mis en place, il faudra adapter l'onglet "Configuration" pour importer correctement les éléments dans Shinken.


Warning

Il est conseillé d'utiliser le fichier fourni dans l'installation de Shinken.

  • Ainsi, le fichier Excel aura toujours un format compatible avec la source installée sur le système.


Il est disponible à l'emplacement suivant :

Code Block
languagetext
themeEmacs
/etc/shinken-user-example/configuration/daemons/synchronizers/sources/synchronizer-collector-excel/source-data-synchronizer-collector-excel/Excel-import-file.xlsx

Description de la configuration de l'import des données

Panel

Entête de la feuille

Panel

Le fichier doit contenir un onglet "Configuration" qui contiendra le format d'import des éléments.

  • La case E2 doit contenir la version de la description du format. La seule valeur possible pour le moment est "V1".
  • La case E3 doit contenir la langue utilisée par ce fichier. Les valeurs possibles sont "EN" ( pour anglais ) ou "FR" ( pour français ).
  • La ligne 5 doit lister les types d'éléments à charger.
    • La première valeur est dans la colonne B et les valeurs suivants sont toutes les cinq colonnes ( "5B", "5G", "5L" ... ).
    • Les valeurs possibles sont : 

      Francais
      FrançaisAnglais 
      Hôte
      ( en anglais : "" )
      Host
      Modèle d'hôte   Host template
      Groupe d'hôtes   Host group
      Cluster  Cluster
      Modèle de cluster   Cluster template
      Utilisateur User
      Modèle d'utilisateur   User template
      Groupe d'utilisateur   User group
      Check appliqué à l'hôte   Check applied on Host
      Check appliqué au cluster   Check applied on Cluster
      Check appliqué au modèle d'hôte   Check applied on Host template
      Check appliqué au modèle de cluster   Check applied on Cluster template
      Modèle de check   Check template
      Méthode de notification   Notification Way
      Modulation de données   Data modulation
      Modulation de résultats   Result modulation
      Modulation d'impact métier   Business impact modulation
      Escalade   Escalation
      Commande  Command
      Période de temps   Timeperiod

Déclarations par type d'élément

  • Les lignes suivantes décrivent le format des éléments : 
    • La ligne 7 contient pour chaque type d'élément le nom des colonnes suivantes : 
      • Type,

      • Propriétés dans Excel,

      • Propriétés dans Shinken.

Panel

Image Added

  • Chaque ligne devra être d'un des types suivants :

:
  •  

Francais
  • FrançaisAnglaisDescription 

    Onglet 

    Tab
    • Nom de l'onglet qui contient les éléments de ce type
( précisé en ligne 5  
    • d'élément ( pour rappel, le type d'élément est défini dans la ligne 5 => nom au-dessus des 3 colonnes ).
    • Le nom doit être dans la colonne Propriétés dans Excel.

    Première ligne

    First line
    • Ligne où commence la liste des éléments dans l'onglet ciblé.
      • Utile s'il y a un en-tête de plusieurs lignes sur les onglets avec les éléments à importer.
    • Le numéro de la ligne doit être dans la colonne Propriétés dans Excel.

    Colonne

    Column

    Il faut dans ce cas remplir les 2 colonnes supplémentaires :

    • Dans la colonne Propriétés dans Excel doit contenir soit :
      • soit le nom d'une colonne,
      • soit des opérateurs ( comme par exemple CONCAT, MANY_FIELDS_BY_REGEX, ... ) en utilisant des noms de colonnes pour faire des opérations de transformation avant d'importer les valeurs dans Shinken
.soit avec le mot-clé DATA, avec entre crochets le nom de colonne choisi
      • .

    • Dans la colonne Propriétés dans Shinken, Il faut saisir :
      • Pour une propriété, le nom de la clé d'import de Shinken
:soit d'une propriété
      • ( visible dans l'aide des pages d'édition des élements  ),
  • soit le nom d'une donnée. 
        • Pour une donnée : le mot clé DATA avec en parentheses le nom de la donnée voulu
          • Exemple: DATA(MY_DATA)) .
    PanelImage Removed
    Panel
    titleClé d'import dans Shinken ( visible dans l'aide )

    Activation de la source

    Ajouter un collecteur de type synchronizer_collector_excel

    Il est possible d'avoir plusieurs sources du type synchronizer_collector_excel, pour importer plusieurs fichiers.

    Choisissez un nom pour ce nouveau collecteur.

    • Pour l'exemple, il s'appellera "Mon-Collecteur-Synchronizer-Excel".
    • Remplacer dans l'exemple le mot "Mon-Collecteur-Synchronizer-Excel" par le nom choisi.


    Pour ajouter une autre source, il faut :

    • Copier le fichier de définition de la source d'exemple : /etc/shinken-user-example/configuration/daemons/synchronizers/sources/synchronizer-collector-excel/synchronizer-collector-excel-example.cfg  dans le répertoire de définition des sources : /etc/shinken/sources/
      ( Exemple : /etc/shinken/sources/collector__synchronizer-collector-excel__Mon-Collecteur-Synchronizer-Excel.cfg ).

      Code Block
      languagetext
      themeEmacs
      cp /etc/shinken-user-example/configuration/daemons/synchronizers/sources/synchronizer-collector-excel/synchronizer-collector-excel-example.cfg /etc/shinken/sources/collector__synchronizer-collector-excel__Mon-Collecteur-Synchronizer-Excel.cfg
    • Ouvrir ce fichier ( collector__synchronizer-collector-excel__Mon-Collecteur-Synchronizer-Excel.cfg  ) :
        • Modifier la ligne source_name en remplaçant le nom par défaut "synchronizer-collector-excel-example" par le nom choisi "Mon-Collecteur-Synchronizer-Excel".

        • Modifier la ligne excel_file_path pour indiquer le chemin absolu du fichier excel qui sera lu par la source.

          Code Block
          languagejs
          themeConfluence
          define synchronizer {
              [...]
              source_name         Mon-Collecteur-Synchronizer-Excel
               [...]
              excel_file_path     /etc/shinken-user/source-data/source-data-synchronizer-collector-excel____Mon-Collecteur-Synchronizer-Excel/Excel-import-file.xlsx 
          }

          Créer le dossier s'il n'existe pas et y téléverser le fichier excel.

          Code Block
          languagetext
          themeEmacs
          mkdir /etc/shinken-user/source-data/source-data-synchronizer-collector-excel____Mon-Collecteur-Synchronizer-Excel/

          Il est possible d'y copier le fichier d'exemple pour vérifier l'import de la source :

      Code Block
      languagetext
      themeEmacs
      cp /etc/shinken-user-example/configuration/daemons/synchronizers/sources/synchronizer-collector-excel/source-data-synchronizer-collector-excel/Excel-import-file.xlsx /etc/shinken-user/source-data/source-data-synchronizer-collector-excel____Mon-Collecteur-Synchronizer-Excel/Excel-import-file.xlsx
    • 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
      languagejs
      themeConfluence
      define synchronizer {
          [...]
          sources                   Source 1, Source 2, Source 3, Mon-Collecteur-Synchronizer-Excel
          [...]
      }
    • Redémarrez le Synchronizer pour qu'il puisse prendre en compte cette nouvelle source.

      Excerpt Include
      Configuration ( Synchronizer )
      Configuration ( Synchronizer )
      pageDefaultLink[destination=Optional[PageResourceIdentifier[spaceKey=<null>,title=Configuration ( Synchronizer )]],body=Optional.empty,tooltip=Optional.empty,anchor=Optional.empty,target=Optional.empty]
      nopaneltrue


    Configuration

    Un exemple est disponible dans le fichier : /etc/shinken-user-example/configuration/daemons/synchronizers/sources/synchronizer-collector-excel/synchronizer-collector-excel-example.cfg

    Exemple de fichier de configuration

         
    Code Block
    languagejs
    themeConfluence
    # CFG_FORMAT_VERSION 1 ( SHINKEN : DON'T TOUCH THIS LINE )
    
    #================================================================================
    # synchronizer-collector-excel
    #================================================================================
    # Daemons that can load this source:
    # - synchronizer
    # This collector import elements from an Excel file
    #================================================================================
    
    define source {
    
        # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
        # │ ──────────────────────────────────────    SOURCE IDENTITY    ────────────────────────────────────── │ #
        # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
    
        # ─── Source name [ Must be unique ]                                                      [ MANDATORY ] ───
        # ───       /!\ Must be unique                                                                          ───
        # ───       /!\ Forbidden characters ?&"'$/#\\;                                                         ───
        # ───       /!\ Length of the name must not exceed 40 characters                                        ───
        #                                                                                                       ───
        source_name                                         synchronizer-collector-excel-example
    
        # ─── Module type [ Do not edit ]                                                         [ MANDATORY ] ───
        # ───                                                                                                   ───
        module_type                                         synchronizer_collector_excel
    
        # ─── Display a description on the interface for this source                                            ───
        # ───                                                                                                   ───
        description                                         This source is about loading element from a Excel file.
    
        # ─── 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 : 0                                                                                 ───
        #                                                                                                       ───
        # import_interval                                     0
    
        # ─── OrderFilter ofthe priorityitem whentypes mergingimported datain Shinken by the source                                           ───
        # ─── If left empty or as a comment, no filter will ───
    be applied   # ─── 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# ─── so the source can import into Shinken any item type                                ───
        #           Default───
     : 99  # ───                                                                             ───
        #                  ───
        # ─── Values must be separated by a comma. Possible values are :                                        ───
        # ───       clusters, clustertpls, hosts, hosttpls, hostgroups, serviceshosts,            ───
        # order         ───
        # ───       serviceshosttpls, servicesclusters, servicesclustertpls, servicetpls                        99───
    
        # ─── Make the source active   contacts, contacttpls, contactgroups, escalations, notificationways                         ───
        # ───       commands, businessimpactmodulations,        macromodulations, resultmodulations,                       ───
        # ───       timeperiods                                                                                 ───
        # ───         ───
        #           ...     : 0 => disabled                                                                     ───
        # type_to_import          Default : 1 => enabled                        
    
        # ─── 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                             ───
        # enabled         ───
        #           Default : 99                   1
    
        # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
        #  ───────────────────────────────────────    MERGE OPTIONS    ───────────────────────────────────────  #
        # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
    
        # ─── Behaviour of mixing of sources                      ───
        #                                          ───
        #                                                         ───
        # order                                         ───
        #  99
    
        # ─── Make the source active Default : all                     => Merge with all source                                  ───
        #          ───
     ...   #  : dont_merge_with_other   => Don't merge with other source                          ───
        #           ...     : only_with_syncui        => Merge only with syncui                                 ───
        #           ...     : all_without_syncui  0 => disabled    => Merge with all source without syncui                   ───
        # ───                                   ───
        #           Default : 1 => enabled                                             ───
        # merge_mode                    ───
        # ───                 all
    
        # ─── New element calculation                                                                           ───
        # enabled                                             1
    
        # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
        #  ───────────────────────────────────────    MERGE OPTIONS    ───────────────────────────────────────  #
        # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
    
        # ─── Behaviour of mixing of sources                  ───
        #           Default : authorized ( Authorized the calculation of new items )                            ───
        #           ...     : never_new  ( Do not compute new items )                                           ───
        # ───                              ───
        #           Default : all                     => Merge with all source                           ───
        # compute_new_element  ───
        #           ...     : dont_merge_with_other   => Don't merge with other source  authorized
    
        # ─── Element difference calculation                ───
        #           ...     : only_with_syncui        => Merge only with syncui                   ───
        #          ───
        #           ...     : all_without_syncui      => Merge with all source without syncui                   ───
        # ───                                    ───
        #           Default : authorized       ( Authorized the calculation of differences )                    ───
        #         ───
      ...  # merge_mode  : never_difference ( Do not compute differences )                                   ───all
    
        # ─── New element calculation                                                                           ───
        #                 ───
        # compute_element_difference                          authorized
    
        # ─── Specific treatment with elements that are no longer present in the source                         ───
        #         ───
        #           Default : authorized ( Authorized the calculation of new items )                            ───
        #           ...     : never_new  ( Do not compute new items )             ───
        #           Default : disabled             ───
        # ───                                                        ───
        #           ...     : delete_if_missing_in_all_sources                      ───
        # compute_new_element                       ───
        #      authorized
    
        # ...─── Element difference calculation  : delete_if_missing_in_this_source                                                  ───
        # ───          ───
        #                                                                                     ───
           # compute_deleted_element_not_in_source          ───
        # disabled
    
        # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
        #Default : ──────────────────────────────────────authorized    PUT IN OPTIONS ( Authorized the ───────────────────────────────────────calculation of #
    differences )   # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
    
        # ─── Targeted spaces to put elements     ───
        #           ...     : never_difference ( Do not compute differences )                                   ───
        # ───                                                                                                   ───
         ───
    # compute_element_difference      #           Default : source_space       authorized
    
        # ─── Specific treatment with elements that =>are Availableno forlonger stagingpresent in the source                         ───
        #           ...     : staging                       => Saved in staging                                 ───
        #           ...     : production      ───
        #          => SavedDefault in: stagingdisabled                                 ───
        #                                     ───
        #           ...  Saved in production : delete_if_missing_in_all_sources                            ───
        #           ...     : production_and_reload_arbiter => Saved in staging  ───
        #           ...     : delete_if_missing_in_this_source                      ───
        #                        ───
        # ───                         Saved in production                              ───
        #                                      ───
        # compute_deleted_element_not_in_source           Available to monitoring  disabled
    
        # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
        #  ──────────────────────────────────────    PUT IN OPTIONS    ───────────────────────────────────────  ───#
        # ───└─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
    
        # ─── Targeted spaces to put elements                                                                   ───
        #                 ───
        # put_in                                              source_space
    
        # ─── User responsible of import                           ───
        #           Default : source_space                  => Available for staging       ───
        # ───       accepted name : Only admin shinken name   ───
        #           ...     : staging                       => Saved in staging   ───
        #                          ───
        #           ...     : production                    => Saved in staging                                 ───
        #           Default : admin                                         Saved in production                                  ───
        # ───          ...     : production_and_reload_arbiter => Saved in staging                                 ───
        #                                          ───
        # put_in_user       Saved in production                                admin───
    
        # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
        #  ──────────────────────────────────    EXCEL SPECIFIC OPTIONS    ───────────────────────────────────  #
        # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
    
        # ─── Path of the excel file to load                Available to monitoring                          ───
        # ───     [ MANDATORY ] ───
        # ───                                                                                      ───
        # put_in        ───
        excel_file_path                                     /etc/shinken-user/source-data/source-data-synchronizer-collector-excel/Excel-import-file.xlsx
    
    }

    Détails des sections composant le fichier de configuration

    Identification du module de source

    Code Block
    languagejs
    themeConfluence
    source_space
    
        # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐─── #
    User responsible of import #  ──────────────────────────────────────    SOURCE IDENTITY    ──────────────────────────────────────  #
        # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
    
        # ─── Source name [ Must be unique ]                                        ───
        # ───       accepted name [: MANDATORYOnly ]admin ───
    shinken name   # ───       /!\ Must be unique                                       ───
        #                               ───
        # ───       /!\ Forbidden characters ?&"'$/#\\;                                                         ───
        # ───       /!\ Length of theDefault name: mustadmin not exceed 40 characters                                        ───
        #                             ───
        # ───                                                                     ───
        source_name                          ───
        # put_in_user          synchronizer-collector-excel-example
    
        # ─── Module type [ Do not edit ]                   admin
    
        # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
        #  ──────────────────────────────────    EXCEL SPECIFIC OPTIONS    ───────────────────────────────────  #
        # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
    
        # ─── Path of [the MANDATORYexcel ]file ───
    to load   # ───                                                  [ MANDATORY ] ───
        # ───                                         ───
        module_type                                         synchronizer_collector_excel
    
        # ─── Display a description on the interface for this───
     source   excel_file_path                                         ───/etc/shinken-user/source-data/source-data-synchronizer-collector-excel/Excel-import-file.xlsx
    
        # ───┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
        #  ─────────────────────────────    SYNCHRONIZATION KEYS ( SYNC_KEY )    ─────────────────────────────  #
        # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
    
        # ─── List of parameters whose values will be used as sync keys for Hosts elements                      ───
        #                           ───
        description                                         This source is about loading element from a Excel file.
    
        # ─── Interval between each automatic import            ───
        #           Default    : _SE_UUID                             ───
        # ─── 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 ...     : host_name            ───
        #           Default : 0                                            ───
        # ───                                ───
        #                                                               ───
        # properties_used_as_synckey_for_hosts                _SE_UUID, host_name
    
        # ─── List of parameters whose values will be used as sync keys for ───
    Host templates elements  # import_interval          ───
        #                       0
    
        # ─── Filter the item types imported in Shinken by the source                                           ───
        # ─── If left empty or as a comment, no filter will be applied     ───
        #           Default : _SE_UUID                    ───
        # ─── so the source can import into Shinken any item type                                               ───
        # ───          ...     : name                                                                              ───
        # ───
        # ─── Values must be separated by a comma. Possible values are :                                        ───
        # ───       clusters, clustertpls, hosts, hosttpls, hostgroups, serviceshosts,                          ───
        # ───properties_used_as_synckey_for_hosttpls       serviceshosttpls, servicesclusters, servicesclustertpls, servicetpls   _SE_UUID, name
    
        # ─── List of parameters whose values will be used as sync keys for Host groups ───
    elements    # ───       contacts, contacttpls, contactgroups, escalations, notificationways───
        #                     ───
        # ───       commands, businessimpactmodulations, macromodulations, resultmodulations,                   ───
        # ───       timeperiods                                    ───
        #           Default : _SE_UUID                            ───
        # ───                                         ───
        #           ...     : hostgroup_name                                     ───
        # type_to_import                          ───
        # ───       
    
        # ─── Order of priority when merging data                                                               ───
        # ─── The final element will take the value of the element from the source───
     with the highest priority # properties_used_as_synckey_for_hostgroups   ───
        # ───   _SE_UUID, hostgroup_name
    
       -> Priority# at─── sourceList withof theparameters orderwhose closestvalues towill 1be used as sync keys for Clusters elements                   ───
        #             ───
        #           Default : 99                                                                           ───
        #           Default : _SE_UUID  ───
               #                                                             ───
        #           ...     : host_name                     ───
        # order                                               99───
    
        # ─── Make the source active                                                                                                   ───
        # properties_used_as_synckey_for_clusters             _SE_UUID, host_name
    
        # ─── List of parameters whose values will be used as sync keys for Cluster templates elements          ───
        #                                                             ───
        #           ...     : 0 => disabled                   ───
        #           Default : _SE_UUID                                 ───
        #           Default : 1 => enabled                      ───
        #           ...     : name                           ───
        # ───                                              ───
        # ───                                                ───
        # enabled                                             1

    Il est possible de définir plusieurs instances de module de type synchronizer_collector_excel dans l'architecture Shinken.

    • Chaque instance devra avoir un nom unique.
    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfautDescription
    No Format
    source_name
    Texte

    ---

    synchronizer-collector-excel-example

    Il est conseillé de choisir un nom en fonction de l'utilisation du module pour que la 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 "$".
    No Format
    module_type
    Texte

    ---

    synchronizer_collector_excel

    Ne peut être modifié.

    No Format
    description	
    Texte

    ---

    Contient une description de la source qui permet de retrouver l'objectif de cette source.

    No Format
    import_interval

    Entier positif

    minute

    0

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

    Si 0, l'import de la source ne sera jamais exécuté automatiquement( L'import ne pourra être effectué que manuellement ).
    No Format
    order
    Entier positif--- 4

    L'ordre de la source dans l'interface de configuration (  A  un impact dans la fusion des données lors des imports de sources  ).

     

    Info
    iconfalse
    titleRemarque

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

    No Format
    type_to_import
    Liste

    Liste des types d'éléments à importer lors de l'import de la source.

    Pour ajouter plusieurs types, ils doivent être séparés par une virgule.

    • Exemple : hosts, clusters

    Valeurs possibles :

    • clusters ( pour les Clusters )
    • clustertpls ( pour les Modèles de cluster )
    • hosts ( pour les Hôtes )
    • hosttpls ( pour les Modèles d'hôtes)
    • hostgroups ( pour les Groupes d'hôtes )
    • serviceshosts ( pour les Check appliqué aux hôtes )
    • serviceshosttpls ( pour les Check appliqués aux modèles d'hôtes )
    • servicesclusters ( pour les Check appliqués aux clusters )
    • servicesclustertpls ( pour les Check appliqués aux modèles de cluster )
    • servicetpls ( pour les Modèles de check )
    • contacts ( pour les Utilisateurs )
    • contacttpls ( pour les Modèles d'utilisateur )
    • contactgroups ( pour les Groupes d'utilisateurs )
    • escalations ( pour les Escalades )
    • notificationways ( pour les Méthodes de notification )
    • commands ( pour les Commandes )
    • businessimpactmodulations ( pour les Modulations d'impact métier )
    • macromodulations ( pour les Modulations de données )
    • resultmodulations ( pour les Modulations de résultats )
    • timeperiods ( pour les Périodes de temps )
    No Format
    enabled	
    Booléen

    ---

    1

    Permet d'activer/désactiver la source.

    Info
    iconfalse
    titleRemarque

    Si la source est activée/désactivée depuis l'interface ( page d’accueil ), le fichier .cfg sera mis à jour.

    Options de mélange des sources

    Code Block
    languagejs
    themeConfluence
        # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
        # │ ───────────────────────────────────────    MERGE OPTIONS    ─────────────────────────────────────── │ #
        # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
    
        # ─── Behaviour of mixing of sources ───
        # properties_used_as_synckey_for_clustertpls          _SE_UUID, name
    
        # ─── List of parameters whose values will be used as sync keys for Users elements                      ───
        #                                                                                                       ───
        #           Default : _SE_UUID                                                                          ───
        #           ...     : contact_name                                                                      ───
        # ───                                                                                                   ───
        # properties_used_as_synckey_for_contacts             _SE_UUID, contact_name
    
        # ─── List of parameters whose values will be used as sync keys for User templates elements             ───
        #                                                                                       ───
        #            ───
        #           Default : _SE_UUID                                                                          ───
        #           Default...     : allname                       => Merge with all source                                  ───
        #           ...  ───
       : dont_merge_with_other  # ───  => Don't merge with other source                          ───
        #           ...     : only_with_syncui        => Merge only with syncui                                 ───
        # properties_used_as_synckey_for_contacttpls          ... _SE_UUID, name
    
        : all_without_syncui      => Merge with all source without syncui   # ─── List of parameters whose values will be used as sync keys for User groups elements                ───
        #                                                                                                       ───
        # merge_mode          Default : _SE_UUID                              all
    
        # ─── New element calculation                                    ───
        #           ...     : contactgroup_name                    ───
        #                                         ───
        # ───                                                         ───
        #           Default : authorized ( Authorized the calculation of new items )                 ───
        # properties_used_as_synckey_for_contactgroups      ───  _SE_UUID, contactgroup_name
    
        # ─── List of parameters whose values will be used as ...sync keys for Check applied :on never_newHosts elements ( Do not compute new───
     items )  #                                         ───
        #                                                          ───
        #           Default : _SE_UUID                            ───
        # compute_new_element                                 authorized
    
        # ─── Element difference calculation───
        # ───                                                               ───
        #                                ───
        # properties_used_as_synckey_for_serviceshosts        _SE_UUID
    
        # ─── List of parameters whose values will be used as sync keys for Check applied on Host templates elements ───
        #                              ───
        #           Default : authorized       ( Authorized the calculation of differences )                    ───
        #           ...     : never_difference ( Do───
     not compute differences )#           Default : _SE_UUID                      ───
        #                                                ───
        # ───                                                  ───
        # compute_element_difference                          authorized
    
        # ─── Specific treatment with elements that are no longer present in the source ───
        # properties_used_as_synckey_for_serviceshosttpls     _SE_UUID
    
        # ─── List of parameters whose values will be used as sync keys for Check applied on Clusters elements  ───
        #                                                                                                       ───
        #           Default : disabled_SE_UUID                                                                          ───
        # ───          ...     : delete_if_missing_in_all_sources                                                  ───
        #           ...     : delete_if_missing_in_this_source            ───
        # properties_used_as_synckey_for_servicesclusters     _SE_UUID
    
        # ─── List of parameters whose values will be used as sync keys for Check applied on Cluster templates  elements    ───
        #                                                                                                       ───
        # compute_deleted_element_not_in_source              Default : _SE_UUID           disabled     
    Mode de mélange des sources

    Option qui définit le mode de mélange entre les hôtes récupérés de cette source et les hôtes des autres sources ( voir la page Voir la configuration du module ( synchronizer-collector-excel ) ).

    Ce paramètre peut prendre les valeurs suivantes :

    • dont_merge_with_other : 

      Les éléments récoltés par cette source seront importés sans être fusionnés avec les autres sources.

      Si un élément de cette source possède une clé de synchronisation commune avec une autre source, la source provoquera un conflit et ces éléments ne pourront pas être importés.

      À utiliser si la source donne un élément complet qui ne doit pas être modifié, ni par l'interface de configuration ni par d'autres sources.   

    • only_with_syncui : 

      Les éléments récoltés par cette source seront importés et fusionnés  seulement avec ceux de la "syncui". 

      À utiliser si la source importe un élément complet qui ne doit être modifié que via l'interface de configuration.

    • all_without_syncui : 

      Les éléments récoltés par cette source seront importés et fusionnés  avec ceux des autres sources sauf la "syncui".

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

    • all ( valeur par défaut ) :  

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

      Les éléments de cette source seront complétés avec les autres sources et les modifications de l'interface de configuration.

    Code Block
    languagejs
    themeConfluence
        # ─── Source merge mode                                                    ───
        # ───                        ───
        #   - all                   : Merge with all source ( Default )                                         ───
        # properties_used_as_synckey_for_servicesclustertpls  - dont_merge_with_other : Don't merge with other source             SE_UUID
    
        # ─── List of parameters whose values will be used as sync keys for Check templates elements            ───
        #                                                                                                       ───
        #   - only_with_syncui        Default : _SE_UUID                  : Merge only with syncui                                                    ───
        #        - all_without_syncui   ...     : Mergename     with all source without syncui                                      ───
        # merge_mode                          ───
        # ───         all
        
    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfautDescription
    No Format
    merge_mode

    Enumération

    ---

    all

    Info

    À noter:  Syncui est une source ( interne à shinken ) qui importe tous les éléments de l'interface de configuration. Chaque fois qu'une source est importée, elle l'est aussi.

    Détecter les nouveaux éléments

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

    Code Block
    languagejs
    themeConfluence
        # ─── Detecting new elements                                                                                        ───
        # properties_used_as_synckey_for_servicetpls          _SE_UUID, name
    
        # ─── List of parameters whose values will be used as sync keys for Commands elements                   ───
        #                                                                                                       ───
        #           Default : _SE_UUID                                                                          ───
        #           ...     : command_name                                                                      ───
        # ───            ───
        #   - authorized ( Default )                                                                            ───
        # properties_used_as_synckey_for_commands           - never_new      _SE_UUID, command_name
    
        # ─── List of parameters whose values will be used as sync keys for Timeperiods elements                ───
        #                                                                 ───
          # compute_new_element                               authorized
    
    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfautDescription
    No Format
    compute_new_element
    Énumération---authorized 

    Ce paramètre peut prendre les valeurs suivantes :

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

    • never_new :  

      Dé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 ( Voir la page Modules de Sources ( imports ) et de Taggers ( qualification ) ).

    Ce paramètre peut prendre les valeurs suivantes :

    • authorized ( valeur par défaut ) :  

      Activé → le mécanisme de calcul des différences analysera les éléments de la source pour calculer les différences par rapport à l'espace de données Staging.

    •   never_difference :  

      Désactivé → 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 à l'espace de données Staging.

    Code Block
    languagejs
    themeConfluence
        # ─── Calculate the differences───
        #           Default : _SE_UUID                                                                          ───
        #   -  authorized ( Default )   ...     : timeperiod_name                                                                   ───
        # ───       - never_difference                                                                                            ───
        # compute_element_difference properties_used_as_synckey_for_timeperiods          _SE_UUID, timeperiod_name
    
        # ─── List of parameters whose values will be used as sync keys for Business impact modulations elements ───
        #                        authorized   
    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfautDescription
    No Format
    compute_element_difference
    Enumération--- authorized 
    Détecter les éléments qui ne sont plus présent dans la source

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

    Warning

    Cette option ne peut être activée que si cette source met directement dans l'espace "Staging" ou "Production" ses éléments importés.

    Code Block
    languagejs
    themeConfluence
        # ─── Detect elements that are no longer present in the source                                          ───
        #   - disabled ( Default )        ───
        #           Default : _SE_UUID                                                                          ───
        #           - delete_if_missing_in_all_sources...     : business_impact_modulation_name                                                   ───
        # ───                         ───
        #   - delete_if_missing_in_this_source                                                                  ───
        # compute_deleted_element_not_in_source       properties_used_as_synckey_for_businessimpactmodulations _SE_UUID, business_impact_modulation_name
    
        # ─── List of parameters whose values will be used as sync keys for Data modulations elements       disabled   
    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfautDescription
    No Format
    compute_deleted_element_not_in_source
    Enumération--- disabled

    Ce paramètre peut prendre les valeurs suivantes :

    • disabled ( valeur par défaut ) :  

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

    • 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 à l'exception de la "syncui", seront proposés à la suppression.

      Warning

      La prise en compte de ce paramètre dépend de la valeur de put_in. Si cette valeur correspond à source_space ( sa valeur par défaut ), alors le paramètre compute_deleted_element_not_in_source sera ignoré.

    • delete_if_missing_in _this_source :  

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

      Warning

      La prise en compte de ce paramètre dépend de la valeur de put_in. Si cette valeur correspond à source_space ( sa valeur par défaut ), alors le paramètre compute_deleted_element_not_in_source sera ignoré.

    Choix de l'espace d'import des éléments

    Code Block
    languagejs
    themeConfluence
        # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
        # │ ──────────────────────────────────────    PUT IN OPTIONS    ─────────────────────────────────────── │ #
        # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
    
        # ─── Targeted spaces to put elements          ───
        #                                                                                                       ───
        #           Default : _SE_UUID                                                                          ───
        #           ...     : macromodulation_name                                                              ───
        # ───                                                            ───
        #   - source_space                  : Available for staging ( Default )       ───
        # properties_used_as_synckey_for_macromodulations     _SE_UUID, macromodulation_name
    
        # ─── List of parameters whose values will be used as ───
    sync keys for Result #modulations elements  - staging      ───
        #             : Saved in staging                                                  ───
        #   - production                    : Saved in staging      ───
        #           Default : _SE_UUID                           ───
        #                                     Saved in production    ───
        #           ...           : resultmodulation_name                 ───
        #   - production_and_reload_arbiter : Saved in staging                                  ───
        # ───           ───
        #                                     Saved in production                                               ───
        # properties_used_as_synckey_for_resultmodulations      _SE_UUID, resultmodulation_name
    
        # ─── List of parameters whose values will be used as sync keys for Notification Ways elements          ───
        #       Available   to monitoring                                           ───
        # put_in                                            source_space───
    
        # ─── User responsible of import           Default : _SE_UUID                                                                          ───
        #    ───       ...    accepted : notificationway_name : Only admin shinken name                                                             ───
        # >>> admin  ( Default ) ───                                                                                                   ───
        # put_in_userproperties_used_as_synckey_for_notificationways     _SE_UUID, notificationway_name
    
        # ─── List of parameters whose values will be used as sync keys for Escalations elements                admin
     
    Mettre dans l'espace

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

    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfautDescription
    No Format
    put_in
    Enumération--- source_space

    Ce paramètre peut prendre les valeurs suivantes :

    • source_space ( valeur par défaut ) :  

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

    • staging  :  

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

    • production :  

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

    • 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

      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.

    ───
        #                                                                                                       ───
        #           Default : _SE_UUID                                                                          ───
        #           ...     : escalation_name                                                                   ───
        # ───                                                                                                   ───
        # properties_used_as_synckey_for_escalations          _SE_UUID, escalation_name
    
    }

    Détails des sections composant le fichier de configuration

    Identification du module de source

    Code Block
    languagejs
    themeConfluence
        # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
        # │ ──────────────────────────────────────    SOURCE IDENTITY    ────────────────────────────────────── │ #
        # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
    
        # ─── Source name [ Must be unique ]                                                      [ MANDATORY ] ───
        # ───       /!\ Must be unique                                                                          ───
        # ───       /!\ Forbidden characters ?&"'$/#\\;                                                         ───
        # ───       /!\ Length of the name must not exceed 40 characters     
    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 importé 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.

    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfautDescription
    No Format
    put_in_user
    Texte--- shinken-core Les nouveaux éléments et les éléments différents importés par cette source auront la valeur de cette clé comme utilisateur ayant fait la dernière modification.

    Chemin du fichier Excel

    Ce chapitre liste tous les paramètres qui sont spécifiques aux sources de type synchronizer_collector_excel  :

    Code Block
    languagejs
    themeConfluence
        # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
        # │ ──────────────────────────────────    EXCEL SPECIFIC OPTIONS    ─────────────────────────────────── │ #
        # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
    
        # ─── Path of the excel file to load                                   ───
        #               [ MANDATORY ] ───
        # ───                                                                                                   ───
        excel_file_path                                     /etc/shinken-user/source-data/source-data-synchronizer-collector-excel/Excel-import-file.xlsx
    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfautDescription
    No Format
    excel_file_path
    Texte------

    Correspond au chemin du fichier Excel à charger.

    La source peut charger des fichiers *.xls ou *.xlsx

    ...

                 ───
        source_name                                         synchronizer-collector-excel-example
    
        # ─── Module type [ Do not edit ]                                                         [ MANDATORY ] ───
        # ───                                                                                                   ───
        module_type                                         synchronizer_collector_excel
    
        # ─── Display a description on the interface for this source                                            ───
        # ───                                                                                                   ───
        description                                         This source is about loading element from a Excel file.
    
        # ─── 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 : 0                                                                                 ───
        #                                                                                                       ───
        # import_interval                                     0
    
        # ─── Filter the item types imported in Shinken by the source                                           ───
        # ─── If left empty or as a comment, no filter will be applied                                          ───
        # ─── so the source can import into Shinken any item type                                               ───
        # ───                                                                                                   ───
        # ─── Values must be separated by a comma. Possible values are :                                        ───
        # ───       clusters, clustertpls, hosts, hosttpls, hostgroups, serviceshosts,                          ───
        # ───       serviceshosttpls, servicesclusters, servicesclustertpls, servicetpls                        ───
        # ───       contacts, contacttpls, contactgroups, escalations, notificationways                         ───
        # ───       commands, businessimpactmodulations, macromodulations, resultmodulations,                   ───
        # ───       timeperiods                                                                                 ───
        # ───                                                                                                   ───
        # type_to_import                                      
    
        # ─── 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 : 99                                                                                ───
        #                                                                                                       ───
        # order                                               99
    
        # ─── Make the source active                                                                            ───
        #                                                                                                       ───
        #           ...     : 0 => disabled                                                                     ───
        #           Default : 1 => enabled                                                                      ───
        # ───                                                                                                   ───
        # enabled                                             1

    Il est possible de définir plusieurs instances de module de type synchronizer_collector_excel dans l'architecture Shinken.

    • Chaque instance devra avoir un nom unique.
    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfautDescription
    No Format
    source_name
    Texte

    ---

    synchronizer-collector-excel-example

    Il est conseillé de choisir un nom en fonction de l'utilisation du module pour que la 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 "$".
    No Format
    module_type
    Texte

    ---

    synchronizer_collector_excel

    Ne peut être modifié.

    No Format
    description	
    Texte

    ---


    Contient une description de la source qui permet de retrouver l'objectif de cette source.

    No Format
    import_interval

    Entier positif

    minute

    0

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

    • Si 0, l'import de la source ne sera jamais exécuté automatiquement ( L'import ne pourra être effectué que manuellement ).
    No Format
    order
    Entier positif--- 4

    L'ordre de la source dans l'interface de configuration (  A  un impact dans la fusion des données lors des imports de sources  ).

     

    Info
    iconfalse
    titleRemarque

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

    No Format
    type_to_import
    Liste Le champ est vide par défaut, ce qui correspond à tous types d'éléments.

    Liste des types d'éléments à importer lors de l'import de la source.

    Pour ajouter plusieurs types, ils doivent être séparés par une virgule.

    • Exemple : hosts, clusters


    Valeurs possibles :

    • clusters ( pour les Clusters )
    • clustertpls ( pour les Modèles de cluster )
    • hosts ( pour les Hôtes )
    • hosttpls ( pour les Modèles d'hôtes )
    • hostgroups ( pour les Groupes d'hôtes )
    • serviceshosts ( pour les Check appliqué aux hôtes )
    • serviceshosttpls ( pour les Check appliqués aux modèles d'hôtes )
    • servicesclusters ( pour les Check appliqués aux clusters )
    • servicesclustertpls ( pour les Check appliqués aux modèles de cluster )
    • servicetpls ( pour les Modèles de check )
    • contacts ( pour les Utilisateurs )
    • contacttpls ( pour les Modèles d'utilisateur )
    • contactgroups ( pour les Groupes d'utilisateurs )
    • escalations ( pour les Escalades )
    • notificationways ( pour les Méthodes de notification )
    • commands ( pour les Commandes )
    • businessimpactmodulations ( pour les Modulations d'impact métier )
    • macromodulations ( pour les Modulations de données )
    • resultmodulations ( pour les Modulations de résultats )
    • timeperiods ( pour les Périodes de temps )
    No Format
    enabled	
    Booléen

    ---

    1

    Permet d'activer/désactiver la source.

    Info
    iconfalse
    titleRemarque

    Si la source est activée/désactivée depuis l'interface ( page d’accueil ), le fichier .cfg sera mis à jour.

    Options de mélange des sources

    Code Block
    languagejs
    themeConfluence
        # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
        # │ ───────────────────────────────────────    MERGE OPTIONS    ─────────────────────────────────────── │ #
        # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
    
        # ─── Behaviour of mixing of sources                                                                    ───
        #                                                                                                       ───
        #           Default : all                     => Merge with all source                                  ───
        #           ...     : dont_merge_with_other   => Don't merge with other source                          ───
        #           ...     : only_with_syncui        => Merge only with syncui                                 ───
        #           ...     : all_without_syncui      => Merge with all source without syncui                   ───
        #                                                                                                       ───
        # merge_mode                                          all
    
        # ─── New element calculation                                                                           ───
        #                                                                                                       ───
        #           Default : authorized ( Authorized the calculation of new items )                            ───
        #           ...     : never_new  ( Do not compute new items )                                           ───
        #                                                                                                       ───
        # compute_new_element                                 authorized
    
        # ─── Element difference calculation                                                                    ───
        #                                                                                                       ───
        #           Default : authorized       ( Authorized the calculation of differences )                    ───
        #           ...     : never_difference ( Do not compute differences )                                   ───
        #                                                                                                       ───
        # compute_element_difference                          authorized
    
        # ─── Specific treatment with elements that are no longer present in the source                         ───
        #                                                                                                       ───
        #           Default : disabled                                                                          ───
        #           ...     : delete_if_missing_in_all_sources                                                  ───
        #           ...     : delete_if_missing_in_this_source                                                  ───
        #                                                                                                       ───
        # compute_deleted_element_not_in_source               disabled     
    Mode de mélange des sources

    Option qui définit le mode de mélange entre les hôtes récupérés de cette source et les hôtes des autres sources ( voir la page Voir la configuration du module ( synchronizer-collector-excel )  ).

    Code Block
    languagejs
    themeConfluence
        # ─── Source merge mode                                                                                 ───
        #   - all                   : Merge with all source ( Default )                                         ───
        #   - dont_merge_with_other : Don't merge with other source                                             ───
        #   - only_with_syncui      : Merge only with syncui                                                    ───
        #   - all_without_syncui    : Merge with all source without syncui                                      ───
        # merge_mode                                        all
        
    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfautDescription
    No Format
    merge_mode

    Enumération

    ---

    all


    Ce paramètre peut prendre les valeurs suivantes :

    • dont_merge_with_other : 

      Les éléments récoltés par cette source seront importés sans être fusionnés avec les autres sources.

      Si un élément de cette source possède une clé de synchronisation commune avec une autre source, la source provoquera un conflit et ces éléments ne pourront pas être importés.

      À utiliser si la source donne un élément complet qui ne doit pas être modifié, ni par l'interface de configuration ni par d'autres sources.   

    • only_with_syncui : 

      Les éléments récoltés par cette source seront importés et fusionnés  seulement avec ceux de la "syncui". 

      À utiliser si la source importe un élément complet qui ne doit être modifié que via l'interface de configuration.

    • all_without_syncui : 

      Les éléments récoltés par cette source seront importés et fusionnés  avec ceux des autres sources sauf la "syncui".

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

    • all ( valeur par défaut ) :  

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

      Les éléments de cette source seront complétés avec les autres sources et les modifications de l'interface de configuration.

    Info

    À noter:  Syncui est une source ( interne à shinken ) qui importe tous les éléments de l'interface de configuration. Chaque fois qu'une source est importée, elle l'est aussi.

    Détecter les nouveaux éléments

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

    Code Block
    languagejs
    themeConfluence
        # ─── Detecting new elements                                                                            ───
        #   - authorized ( Default )                                                                            ───
        #   - never_new                                                                                         ───
        # compute_new_element                               authorized
    
    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfautDescription
    No Format
    compute_new_element



    Énumération---authorized 


    Ce paramètre peut prendre les valeurs suivantes :

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

    • never_new :  

      Dé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 ( Voir la page Modules de Sources ( imports ) et de Taggers ( qualification ) ).

    Code Block
    languagejs
    themeConfluence
        # ─── Calculate the differences                                                                         ───
        #   - authorized ( Default )                                                                            ───
        #   - never_difference                                                                                  ───
        # compute_element_difference                        authorized   



    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfautDescription
    No Format
    compute_element_difference
    Enumération--- authorized 


    Ce paramètre peut prendre les valeurs suivantes :

    • authorized ( valeur par défaut ) :  

      Activé → le mécanisme de calcul des différences analysera les éléments de la source pour calculer les différences par rapport à l'espace de données Staging.

    •   never_difference :  

      Désactivé → 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 à l'espace de données Staging.

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

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

    Warning

    Cette option ne peut être activée que si cette source met directement dans l'espace "Staging" ou "Production" ses éléments importés.

    Code Block
    languagejs
    themeConfluence
        # ─── Detect elements that are no longer present in the source                                          ───
        #   - disabled ( Default )                                                                              ───
        #   - delete_if_missing_in_all_sources                                                                  ───
        #   - delete_if_missing_in_this_source                                                                  ───
        # compute_deleted_element_not_in_source             disabled   
    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfautDescription
    No Format
    compute_deleted_element_not_in_source
    Enumération--- disabled

    Ce paramètre peut prendre les valeurs suivantes :

    • disabled ( valeur par défaut ) :  

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

    • 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 à l'exception de la "syncui", seront proposés à la suppression.

      Warning

      La prise en compte de ce paramètre dépend de la valeur de put_in. Si cette valeur correspond à source_space ( sa valeur par défaut ), alors le paramètre compute_deleted_element_not_in_source sera ignoré.

    • delete_if_missing_in _this_source :  

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

      Warning

      La prise en compte de ce paramètre dépend de la valeur de put_in. Si cette valeur correspond à source_space ( sa valeur par défaut ), alors le paramètre compute_deleted_element_not_in_source sera ignoré.

    Choix de l'espace d'import des éléments

    Code Block
    languagejs
    themeConfluence
        # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
        # │ ──────────────────────────────────────    PUT IN OPTIONS    ─────────────────────────────────────── │ #
        # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
    
        # ─── Targeted spaces to put elements                                                                   ───
        #   - source_space                  : Available for staging ( Default )                                 ───
        #   - staging                       : Saved in staging                                                  ───
        #   - production                    : Saved in staging                                                  ───
        #                                     Saved in production                                               ───
        #   - production_and_reload_arbiter : Saved in staging                                                  ───
        #                                     Saved in production                                               ───
        #                                     Available to monitoring                                           ───
        # put_in                                            source_space
    
        # ─── User responsible of import                                                                        ───
        # ───          accepted name : Only admin shinken name                                                  ───
        # >>> admin  ( Default )                                                                                ───
        # put_in_user                                       admin
     
    Mettre dans l'espace

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

    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfautDescription
    No Format
    put_in
    Enumération--- source_space

    Ce paramètre peut prendre les valeurs suivantes :

    • source_space ( valeur par défaut ) :  

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

    • staging  :  

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

    • production :  

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

    • production_and_reload_arbiter :  

      L es é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

      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.

    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 importé 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.

    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfautDescription
    No Format
    put_in_user
    Texte--- shinken-core Les nouveaux éléments et les éléments différents importés par cette source auront la valeur de cette clé comme utilisateur ayant fait la dernière modification.

    Chemin du fichier Excel

    Ce chapitre liste tous les paramètres qui sont spécifiques aux sources de type synchronizer_collector_excel  :

    Code Block
    languagejs
    themeConfluence
        # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
        # │ ──────────────────────────────────    EXCEL SPECIFIC OPTIONS    ─────────────────────────────────── │ #
        # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
    
        # ─── Path of the excel file to load                                                      [ MANDATORY ] ───
        # ───                                                                                                   ───
        excel_file_path                                     /etc/shinken-user/source-data/source-data-synchronizer-collector-excel/Excel-import-file.xlsx
    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfautDescription
    No Format
    excel_file_path
    Texte------

    Correspond au chemin du fichier Excel à charger.

    La source peut charger des fichiers *.xls ou *.xlsx

    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.

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

    Info

    À Noter :  On ne peut pas supprimer les valeurs par défaut, mais on peut les compléter.

    Code Block
    languagejs
    themeConfluence
        # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
        # │ ─────────────────────────────    SYNCHRONIZATION KEYS ( SYNC_KEY )    ───────────────────────────── │ #
        # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
    
        # ─── List of parameters whose values will be used as sync keys for Hosts elements                      ───
        #                                                                                                       ───
        #           Default : _SE_UUID                                                                          ───
        #           ...     : host_name                                                                         ───
        # ───                                                                                                   ───
        # properties_used_as_synckey_for_hosts                _SE_UUID, host_name
    
        # ─── List of parameters whose values will be used as sync keys for Host templates elements             ───
        #                                                                                                       ───
        #           Default : _SE_UUID                                                                          ───
        #           ...     : name                                                                              ───
        # ───                                                                                                   ───
        # properties_used_as_synckey_for_hosttpls             _SE_UUID, name
    
        # ─── List of parameters whose values will be used as sync keys for Host groups elements                ───
        #                                                                                                       ───
        #           Default : _SE_UUID                                                                          ───
        #           ...     : hostgroup_name                                                                    ───
        # ───                                                                                                   ───
        # properties_used_as_synckey_for_hostgroups           _SE_UUID, hostgroup_name
    
        # ─── List of parameters whose values will be used as sync keys for Clusters elements                   ───
        #                                                                                                       ───
        #           Default : _SE_UUID                                                                          ───
        #           ...     : host_name                                                                         ───
        # ───                                                                                                   ───
        # properties_used_as_synckey_for_clusters             _SE_UUID, host_name
    
        # ─── List of parameters whose values will be used as sync keys for Cluster templates elements          ───
        #                                                                                                       ───
        #           Default : _SE_UUID                                                                          ───
        #           ...     : name                                                                              ───
        # ───                                                                                                   ───
        # properties_used_as_synckey_for_clustertpls          _SE_UUID, name
    
        # ─── List of parameters whose values will be used as sync keys for Users elements                      ───
        #                                                                                                       ───
        #           Default : _SE_UUID                                                                          ───
        #           ...     : contact_name                                                                      ───
        # ───                                                                                                   ───
        # properties_used_as_synckey_for_contacts             _SE_UUID, contact_name
    
        # ─── List of parameters whose values will be used as sync keys for User templates elements             ───
        #                                                                                                       ───
        #           Default : _SE_UUID                                                                          ───
        #           ...     : name                                                                              ───
        # ───                                                                                                   ───
        # properties_used_as_synckey_for_contacttpls          _SE_UUID, name
    
        # ─── List of parameters whose values will be used as sync keys for User groups elements                ───
        #                                                                                                       ───
        #           Default : _SE_UUID                                                                          ───
        #           ...     : contactgroup_name                                                                 ───
        # ───                                                                                                   ───
        # properties_used_as_synckey_for_contactgroups        _SE_UUID, contactgroup_name
    
        # ─── List of parameters whose values will be used as sync keys for Check applied on Hosts elements     ───
        #                                                                                                       ───
        #           Default : _SE_UUID                                                                          ───
        # ───                                                                                                   ───
        # properties_used_as_synckey_for_serviceshosts        _SE_UUID
    
        # ─── List of parameters whose values will be used as sync keys for Check applied on Host templates elements ───
        #                                                                                                       ───
        #           Default : _SE_UUID                                                                          ───
        # ───                                                                                                   ───
        # properties_used_as_synckey_for_serviceshosttpls     _SE_UUID
    
        # ─── List of parameters whose values will be used as sync keys for Check applied on Clusters elements  ───
        #                                                                                                       ───
        #           Default : _SE_UUID                                                                          ───
        # ───                                                                                                   ───
        # properties_used_as_synckey_for_servicesclusters     _SE_UUID
    
        # ─── List of parameters whose values will be used as sync keys for Check applied on Cluster templates elements ───
        #                                                                                                       ───
        #           Default : _SE_UUID                                                                          ───
        # ───                                                                                                   ───
        # properties_used_as_synckey_for_servicesclustertpls  _SE_UUID
    
        # ─── List of parameters whose values will be used as sync keys for Check templates elements            ───
        #                                                                                                       ───
        #           Default : _SE_UUID                                                                          ───
        #           ...     : name                                                                              ───
        # ───                                                                                                   ───
        # properties_used_as_synckey_for_servicetpls          _SE_UUID, name
    
        # ─── List of parameters whose values will be used as sync keys for Commands elements                   ───
        #                                                                                                       ───
        #           Default : _SE_UUID                                                                          ───
        #           ...     : command_name                                                                      ───
        # ───                                                                                                   ───
        # properties_used_as_synckey_for_commands             _SE_UUID, command_name
    
        # ─── List of parameters whose values will be used as sync keys for Timeperiods elements                ───
        #                                                                                                       ───
        #           Default : _SE_UUID                                                                          ───
        #           ...     : timeperiod_name                                                                   ───
        # ───                                                                                                   ───
        # properties_used_as_synckey_for_timeperiods          _SE_UUID, timeperiod_name
    
        # ─── List of parameters whose values will be used as sync keys for Business impact modulations elements ───
        #                                                                                                       ───
        #           Default : _SE_UUID                                                                          ───
        #           ...     : business_impact_modulation_name                                                   ───
        # ───                                                                                                   ───
        # properties_used_as_synckey_for_businessimpactmodulations _SE_UUID, business_impact_modulation_name
    
        # ─── List of parameters whose values will be used as sync keys for Data modulations elements           ───
        #                                                                                                       ───
        #           Default : _SE_UUID                                                                          ───
        #           ...     : macromodulation_name                                                              ───
        # ───                                                                                                   ───
        # properties_used_as_synckey_for_macromodulations     _SE_UUID, macromodulation_name
    
        # ─── List of parameters whose values will be used as sync keys for Result modulations elements         ───
        #                                                                                                       ───
        #           Default : _SE_UUID                                                                          ───
        #           ...     : resultmodulation_name                                                             ───
        # ───                                                                                                   ───
        # properties_used_as_synckey_for_resultmodulations    _SE_UUID, resultmodulation_name
    
        # ─── List of parameters whose values will be used as sync keys for Notification Ways elements          ───
        #                                                                                                       ───
        #           Default : _SE_UUID                                                                          ───
        #           ...     : notificationway_name                                                              ───
        # ───                                                                                                   ───
        # properties_used_as_synckey_for_notificationways     _SE_UUID, notificationway_name
    
        # ─── List of parameters whose values will be used as sync keys for Escalations elements                ───
        #                                                                                                       ───
        #           Default : _SE_UUID                                                                          ───
        #           ...     : escalation_name                                                                   ───
        # ───                                                                                                   ───
        # properties_used_as_synckey_for_escalations          _SE_UUID, escalation_name
    NomTypeUnitéDéfautCommentaire
    No Format
    properties_used_as_synckey_for_hosts
    Texte--- _SE_UUID, host_name Permets de compléter la liste par défaut des propriétés qui seront utilisées pour générer les clés de synchronisation pour les Hôtes.
    No Format
    properties_used_as_synckey_for_hosttpls
    Texte---_SE_UUID, namePermets de compléter la liste par défaut des propriétés qui seront utilisées pour générer les clés de synchronisation pour les Modèles d'hôte.
    No Format
    properties_used_as_synckey_for_hostgroups
    Texte--- _SE_UUID, hostgroup_name Permets de compléter la liste par défaut des propriétés qui seront utilisées pour générer les clés de synchronisation pour les Groupes d'hôte.
    No Format
    properties_used_as_synckey_for_clusters
    Texte--- _SE_UUID, host_name Permets de compléter la liste par défaut des propriétés qui seront utilisées pour générer les clés de synchronisation pour les Clusters.
    No Format
    properties_used_as_synckey_for_clustertpls
    Texte---_SE_UUID, namePermets de compléter la liste par défaut des propriétés qui seront utilisées pour générer les clés de synchronisation pour les Modèles de cluster.
    No Format
    properties_used_as_synckey_for_contacts
    Texte---_SE_UUID, contact_namePermets de compléter la liste par défaut des propriétés qui seront utilisées pour générer les clés de synchronisation pour les Utilisateurs.
    No Format
    properties_used_as_synckey_for_contacttpls
    Texte---_SE_UUID, namePermets de compléter la liste par défaut des propriétés qui seront utilisées pour générer les clés de synchronisation pour les Modèles d'utilisateur.
    No Format
    properties_used_as_synckey_for_contactgroups
    Texte---_SE_UUID, contactgroup_namePermets de compléter la liste par défaut des propriétés qui seront utilisées pour générer les clés de synchronisation pour les Groupes d'utilisateurs.
    No Format
    properties_used_as_synckey_for_serviceshosts
    Texte---_SE_UUIDPermets de compléter la liste par défaut des propriétés qui seront utilisées pour générer les clés de synchronisation pour les Check appliqué aux hôtes.
    No Format
    properties_used_as_synckey_for_serviceshosttpls
    Texte---_SE_UUIDPermets de compléter la liste par défaut des propriétés qui seront utilisées pour générer les clés de synchronisation pour les Check appliqué aux modèles d'hôte.
    No Format
    properties_used_as_synckey_for_servicesclusters
    Texte---_SE_UUIDPermets de compléter la liste par défaut des propriétés qui seront utilisées pour générer les clés de synchronisation pour les Check appliqué aux Clusters.
    No Format
    properties_used_as_synckey_for_servicesclustertpls
    Texte---_SE_UUIDPermets de compléter la liste par défaut des propriétés qui seront utilisées pour générer les clés de synchronisation pour les Check appliqué aux modèles de cluster.
    No Format
    properties_used_as_synckey_for_servicetpls
    Texte---_SE_UUID, namePermets de compléter la liste par défaut des propriétés qui seront utilisées pour générer les clés de synchronisation pour les Modèles de check.
    No Format
    properties_used_as_synckey_for_commands
    Texte---_SE_UUID, command_namePermets de compléter la liste par défaut des propriétés qui seront utilisées pour générer les clés de synchronisation pour les Commandes.
    No Format
    properties_used_as_synckey_for_timeperiods
    Texte---_SE_UUID, timeperiod_namePermets de compléter la liste par défaut des propriétés qui seront utilisées pour générer les clés de synchronisation pour les Périodes de temps.
    No Format
    properties_used_as_synckey_for_businessimpactmodulations
    Texte---_SE_UUID, business_impact_modulation_namePermets de compléter la liste par défaut des propriétés qui seront utilisées pour générer les clés de synchronisation pour les Modulations d'impact métier.
    No Format
    properties_used_as_synckey_for_macromodulations
    Texte---_SE_UUID, macromodulation_namePermets de compléter la liste par défaut des propriétés qui seront utilisées pour générer les clés de synchronisation pour les Modulations de données.
    No Format
    properties_used_as_synckey_for_resultmodulations
    Texte---_SE_UUID, resultmodulation_namePermets de compléter la liste par défaut des propriétés qui seront utilisées pour générer les clés de synchronisation pour les Modulations de résultats.
    No Format
    properties_used_as_synckey_for_notificationways
    Texte---_SE_UUID, notificationway_namePermets de compléter la liste par défaut des propriétés qui seront utilisées pour générer les clés de synchronisation pour les Méthodes de notification.
    No Format
    properties_used_as_synckey_for_escalations
    Texte---_SE_UUID, escalation_namePermets de compléter la liste par défaut des propriétés qui seront utilisées pour générer les clés de synchronisation pour les Escalades.
    Info
    titlenot_stored_properties

     Le paramètre "not_stored_properties" qui permet de filtrer des propriétés et données Shinken des éléments de la source ne doit pas être utilisé avec cette source. 

    • La règle de mapping "disable" permet d'aboutir au même résultat.
    • Ce paramètre n'est pas visible dans l'Interface de Configuration, dans l'onglet Configuration de la source.
    • Elle est source de confusion car il ne sera pas aisé de comprendre qu'une propriété définie dans le mapping a été filtrée par "not_stored_properties".