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
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 ).
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.
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 :
/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
Entête de la feuille
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 :
Français Anglais Hôte 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.
- La ligne 7 contient pour chaque type d'élément le nom des colonnes suivantes :
Chaque ligne devra être d'un des types suivants :
Français Anglais Description Onglet
Tab - Nom de l'onglet qui contient les éléments de ce type 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.
- Dans la colonne Propriétés dans Shinken, Il faut saisir :
- Pour une propriété, le nom de la clé d'import de Shinken ( visible dans l'aide des pages d'édition des élements ),
- Pour une donnée : le mot clé
DATAavec en parentheses le nom de la donnée voulu- Exemple:
DATA(MY_DATA)).
- Exemple:
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 ).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.
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.
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 :
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 .
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.
service-shinken-synchronizer restart
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
# 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
# ─── 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
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ─────────────────────────────────────── 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
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ────────────────────────────────────── PUT IN OPTIONS ─────────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Targeted spaces to put elements ───
# ───
# Default : source_space => Available for staging ───
# ... : 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 ───
# ───
# Default : admin ───
# ─── ───
# put_in_user admin
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ────────────────────────────────── 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
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ───────────────────────────── 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
}
Détails des sections composant le fichier de configuration
Identification du module de 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
# ─── 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.
| Nom | Type | Unité | Défaut | Description |
|---|---|---|---|---|
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 - :
|
module_type | Texte | --- | synchronizer_collector_excel | Ne peut être modifié. |
description | Texte | --- | | Contient une description de la source qui permet de retrouver l'objectif de cette source. |
import_interval | Entier positif | minute | 0 | Délai écoulé entre les imports automatiques de la source.
|
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 ).
|
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.
Valeurs possibles :
|
enabled | Booléen | --- | 1 | Permet d'activer/désactiver la source. |
Options de mélange des sources
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ─────────────────────────────────────── 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 ) ).
# ─── 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
| Nom | Type | Unité | Défaut | Description |
|---|---|---|---|---|
merge_mode | Enumération | --- | all | Ce paramètre peut prendre les valeurs suivantes :
|
À 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 ) ).
# ─── Detecting new elements ───
# - authorized ( Default ) ───
# - never_new ───
# compute_new_element authorized
| Nom | Type | Unité | Défaut | Description |
|---|---|---|---|---|
compute_new_element | Énumération | --- | authorized | Ce paramètre peut prendre les valeurs suivantes :
|
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 ) ).
# ─── Calculate the differences ───
# - authorized ( Default ) ───
# - never_difference ───
# compute_element_difference authorized
| Nom | Type | Unité | Défaut | Description |
|---|---|---|---|---|
compute_element_difference | Enumération | --- | authorized | Ce paramètre peut prendre les valeurs suivantes :
|
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).
Cette option ne peut être activée que si cette source met directement dans l'espace "Staging" ou "Production" ses éléments importés.
# ─── 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
| Nom | Type | Unité | Défaut | Description |
|---|---|---|---|---|
compute_deleted_element_not_in_source | Enumération | --- | disabled | Ce paramètre peut prendre les valeurs suivantes :
|
Choix de l'espace d'import des éléments
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ────────────────────────────────────── 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.
| Nom | Type | Unité | Défaut | Description |
|---|---|---|---|---|
put_in | Enumération | --- | source_space | Ce paramètre peut prendre les valeurs suivantes :
|
À 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.
À Noter : l'utilisateur doit être obligatoirement un administrateur Shinken.
| Nom | Type | Unité | Défaut | Description |
|---|---|---|---|---|
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 :
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ────────────────────────────────── 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
| Nom | Type | Unité | Défaut | Description |
|---|---|---|---|---|
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) ).
À Noter : On ne peut pas supprimer les valeurs par défaut, mais on peut les compléter.
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ───────────────────────────── 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
| Nom | Type | Unité | Défaut | Commentaire |
|---|---|---|---|---|
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. |
properties_used_as_synckey_for_hosttpls | Texte | --- | _SE_UUID, 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 Modèles d'hôte. |
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. |
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. |
properties_used_as_synckey_for_clustertpls | Texte | --- | _SE_UUID, 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 Modèles de cluster. |
properties_used_as_synckey_for_contacts | Texte | --- | _SE_UUID, contact_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 Utilisateurs. |
properties_used_as_synckey_for_contacttpls | Texte | --- | _SE_UUID, 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 Modèles d'utilisateur. |
properties_used_as_synckey_for_contactgroups | Texte | --- | _SE_UUID, contactgroup_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'utilisateurs. |
properties_used_as_synckey_for_serviceshosts | Texte | --- | _SE_UUID | 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 Check appliqué aux hôtes. |
properties_used_as_synckey_for_serviceshosttpls | Texte | --- | _SE_UUID | 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 Check appliqué aux modèles d'hôte. |
properties_used_as_synckey_for_servicesclusters | Texte | --- | _SE_UUID | 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 Check appliqué aux Clusters. |
properties_used_as_synckey_for_servicesclustertpls | Texte | --- | _SE_UUID | 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 Check appliqué aux modèles de cluster. |
properties_used_as_synckey_for_servicetpls | Texte | --- | _SE_UUID, 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 Modèles de check. |
properties_used_as_synckey_for_commands | Texte | --- | _SE_UUID, command_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 Commandes. |
properties_used_as_synckey_for_timeperiods | Texte | --- | _SE_UUID, timeperiod_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 Périodes de temps. |
properties_used_as_synckey_for_businessimpactmodulations | Texte | --- | _SE_UUID, business_impact_modulation_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 Modulations d'impact métier. |
properties_used_as_synckey_for_macromodulations | Texte | --- | _SE_UUID, macromodulation_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 Modulations de données. |
properties_used_as_synckey_for_resultmodulations | Texte | --- | _SE_UUID, resultmodulation_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 Modulations de résultats. |
properties_used_as_synckey_for_notificationways | Texte | --- | _SE_UUID, notificationway_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 Méthodes de notification. |
properties_used_as_synckey_for_escalations | Texte | --- | _SE_UUID, escalation_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 Escalades. |
not_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".