La source synchronizer_collector_excel permet d'importer des éléments ( hôte, modele d'hôte, check, utilisateurs ... ) à partir d'un fichier Excel.
Les formats supportés sont :
Cette page vous explique comment définir ce type de collecteur ( pour l'utilisation du collecteur, voir la page TODO ).
Le fichier doit contenir un onglet "Configuration" qui doit décrire le format de comment sont décrits les éléments.
"Type" - "In excel" - "Propriétés"
Par défaut, l’installation ou la mise à jour de Shinken Entreprise va mettre à disposition une définition de collecteur synchronizer_collector_vmware appelé "synchronizer-collector-vmware-example".
Exemple :
define synchronizer {
[...]
sources Source 1, Source 2, Source 3, synchronizer-collector-vmware
[...]
} |
Redémarrez le Synchronizer pour qu'il puisse prendre en compte cette nouvelle source :
Vous pouvez avoir plusieurs sources du type synchronizer-collector-vmware, donc par exemple se connecter à plusieurs serveurs VMware.
Choisissez un nom pour ce nouveau collecteur.
Mon-Collecteur-Synchronizer-VMWare".Mon-Collecteur-Synchronizer-VMWare" par le nom que vous aurez choisi.Pour ajouter une autre source, vous devez :
Copier le fichier de définition de la source d'exemple : /etc/shinken-user-example/configuration/daemons/synchronizers/sources/synchronizer-collector-vmware/synchronizer-collector-vmware-example.cfg dans le répertoire de définition des sources /etc/shinken/sources/.
( Exemple : /etc/shinken/sources/collector__synchronizer-collector-vmware__Mon-Collecteur-Synchronizer-VMWare.cfg )
cp /etc/shinken-user-example/configuration/daemons/synchronizers/sources/synchronizer-collector-vmware/synchronizer-collector-vmware-example.cfg /etc/shinken/sources/collector__synchronizer-collector-vmware__Mon-Collecteur-Synchronizer-VMWare.cfg |
Modifier la ligne source_name en remplaçant le nom par défaut "synchronizer-collector-vmware" par le nom que vous avez choisi "Mon-Collecteur-Synchronizer-VMWare".
define synchronizer {
[...]
source_name Mon-Collecteur-Synchronizer-VMWare
[...]
} |
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-VMWare
[...]
} |
Redémarrez le Synchronizer pour qu'il puisse prendre en compte cette nouvelle source.
La configuration du module se trouve dans le dossier /etc/shinken/sources/synchronizer-collector-vmware.cfg
#================================================================================
# synchronizer-collector-vmware
#================================================================================
# Daemons that can load this source:
# - synchronizer
# This collector import hosts from a VMWare Server
#================================================================================
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-vmware
# ─── Module type [ Do not edit ] [ MANDATORY ] ───
# ─── ───
module_type synchronizer_collector_vmware
# ─── Display a description on the interface for this source ───
# ─── ───
description This source is about loading hosts from a VMWare Server
# ─── 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
# ─── 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
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ────────────────────── SETTING FOR DOWNTIME PERIOD ON DELETED ELEMENTS ────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Add downtime period on deleted elements ───
# ───
# Default : 0 => disabled ───
# ... : 1 => enabled ───
# ───
# downtime_on_delete_element_activated 0
# ─── Duration of downtime period ───
# ───
# Default : 1440 ( minute ) ───
# ─── Accepted range: 1 to 2630880 ( 5 years ) ───
# ─── ───
# downtime_on_delete_element_duration 1440
# ─── Commentary added in downtime period ───
# ───
# Default : Set automatically by the source ───
# ───
# downtime_on_delete_element_comment Set automatically by the source
# ─── Author of downtime period ───
# ───
# Default : shinken-core ───
# ───
# downtime_on_delete_element_author shinken-core
# ─── Url used by receiver-module-webservice module ───
# ───
# Default : 127.0.0.1 ───
# ───
# downtime_on_delete_element_api_url 127.0.0.1
# ─── Port used by receiver-module-webservice module ───
# ───
# Default : 7760 ───
# ───
# downtime_on_delete_element_api_port 7760
# ─── SSL settings for receiver-module-webservice module ───
# ───
# Default : 0 => HTTP ───
# ... : 1 => HTTPS ───
# ───
# downtime_on_delete_element_api_use_ssl 0
# ─── User name for receiver-module-webservice module ───
# ─── Only if user/password protection has been activated ───
# ───
# Default : admin ───
# ───
# downtime_on_delete_element_api_user admin
# ─── Password for receiver-module-webservice module ───
# ─── Only if user/password protection has been activated ───
# ───
# Default : admin ───
# ───
# downtime_on_delete_element_api_password admin
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ────────────────────────────────────── 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
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ───────────────────────────── VMWARE SPECIFIC OPTIONS (ACCESS) ────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Ip/fqdn of the vCenter/ESXi [ MANDATORY ] ───
# ─── ───
vmware_server_ip vcenter.fqdn.com
# ─── Port of the vCenter/ESXi ───
# ───
# Default : 443 ───
# ───
# vmware_server_port 443
# ─── SSL settings for the vCenter/ESXi ───
# ───
# Default : 0 => HTTPS ───
# ... : 1 => HTTP ───
# ───
# vmware_server_use_ssl 1
# ─── Login user name for the vCenter/ESXi [ MANDATORY ] ───
# ─── ───
vmware_server_username DOMAIN\user
# ─── Login password for the vCenter/ESXi [ MANDATORY ] ───
# ─── ───
vmware_server_password PASSWORD
# ─── Timeout : Maximum time allowed to connect the vCenter/ESXi ───
# ─── unit: second ───
# ───
# Default : 60 ───
# ───
# vmware_connection_timeout 60
# ─── Enable tags/balises collect, this option only works on vCenter server ───
# ───
# Default : 0 => disabled ───
# ... : 1 => enabled ───
# ───
# vmware_collect_tags 0
}
|
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ────────────────────────────────────── 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-vmware
# ─── Module type [ Do not edit ] [ MANDATORY ] ───
# ─── ───
module_type synchronizer_collector_vmware
# ─── Display a description on the interface for this source ───
# ─── ───
description This source is about loading hosts from a VMWare Server
# ─── 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
# ─── 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-vmware dans votre architecture Shinken.
| Nom | Type | Unité | Défaut | Commentaire | ||
|---|---|---|---|---|---|---|
| Texte | --- | synchronizer-collector-vmware | Nous vous conseillons de choisir un nom en fonction de l'utilisation du module pour que votre configuration soit simple à maintenir. Chaîne de caractères composée de lettres, de chiffres et des caractères _ et - :
| ||
| Texte | --- | synchronizer_collector_vmware | Ne peut être modifié. | ||
| Texte | --- | Contient une description de la source qui vous permet de retrouver l'objectif de cette source. | |||
| Entier positif | minute | 0 | Délai écoulé entre les imports automatiques de la source.
| ||
| 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 ).
| ||
| Booléen | --- | 1 | Permet d'activer/désactiver la source.
|
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ─────────────────────────────────────── 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 |
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-vmware ) ).
# ─── 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 | Commentaire | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Enumération | --- | all | Ce paramètre peut avoir 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. |
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 | Commentaire | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Énumération | --- | authorized | Ce paramètre peut avoir les valeurs suivantes :
|
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 | Commentaire | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Enumération | --- | authorized | Ce paramètre peut avoir les valeurs suivantes :
|
Permet de proposer en suppression, les éléments qui ne sont plus présents dans la ou les source(s).
Cette option 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 | Commentaire | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Enumération | --- | disabled | Ce paramètre peut avoir les valeurs suivantes :
|
Permets de rajouter une période de maintenance sur les éléments qui seront supprimés par la configuration de la source.
C'est pratique lorsqu'un hôte est supprimé dans le référentiel de la source ( dans l'ESXi par exemple ), mais que cette suppression n'a pas encore été appliquée dans les Interfaces de Visualisation ( mise en production ).
Ceci évitera les notifications liées à la disparition de l'équipement.
Pour que les Périodes de maintenance puissent être effectives, il faut que le Module receiver-module-webservice soit activé sur le Receiver. ( Voir la page Script d'interprétation des traps avec le module receiver-module-webservice )
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ────────────────────── SETTING FOR DOWNTIME PERIOD ON DELETED ELEMENTS ────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Add downtime period on deleted elements ───
# - disabled : 0 ( Default ) ───
# - enabled : 1 ───
# downtime_on_delete_element_activated 0
# ─── Duration of downtime period ───
# >>> 1440 ( Default ) ───
# ─── unit: minute ───
# ─── accepted range: 1 to 2630880 ( 5 years ) ───
# downtime_on_delete_element_duration 1440
# ─── Commentary added in downtime period ───
# >>> Set automatically by the source ( Default ) ───
# downtime_on_delete_element_comment Set automatically by the source
# ─── Author of downtime period ───
# >>> shinken-core ( Default ) ───
# downtime_on_delete_element_author shinken-core
# ─── Url used by receiver-module-webservice module ───
# >>> 127.0.0.1 ( Default ) ───
# downtime_on_delete_element_api_url 127.0.0.1
# ─── Port used by receiver-module-webservice module ───
# >>> 7760 ( Default ) ───
# downtime_on_delete_element_api_port 7760
# ─── SSL settings for receiver-module-webservice module ───
# - HTTP : 0 ( Default ) ───
# - HTTPS : 1 ───
# downtime_on_delete_element_api_use_ssl 0
# ─── User name for receiver-module-webservice module ───
# ─── Only if user/password protection has been activated ───
# >>> admin ( Default ) ───
# downtime_on_delete_element_api_user admin
# ─── Password for receiver-module-webservice module ───
# ─── Only if user/password protection has been activated ───
# >>> admin ( Default ) ───
# downtime_on_delete_element_api_password admin
|
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Booléen | --- | 0 | Permets d'activer ou de désactiver la période de maintenance sur tous les éléments supprimés de cette source. ( 1 pour activer, 0 pour désactiver ) | |
| Nombre | minute | 1440 ( un jour ) | Durée des périodes de maintenance en minutes. La limite est de 2630880 minutes ( soit cinq ans ). | |
| Texte | --- | Géré automatiquement par synchronizer-collector-vmware | Commentaire pour la période de maintenance. | |
| Texte | --- | shinken-core | Auteur des périodes de maintenance. | |
| Texte | --- | 127.0.0.1 | URL du Module receiver-module-webservice. | |
| Nombre | --- | 7760 | Port du Module receiver-module-webservice. | |
| Booléen | --- | 0 | Protocole du Module receiver-module-webservice ( 1 pour https, 0 pour http ). | |
| Texte | --- | admin | Nom d'utilisateur de l'API ( si la protection par utilisateur / mot de passe a été activée ). | |
| Texte | --- | admin | Mot de passe de l'API ( si la protection par utilisateur / mot de passe a été activée ). |
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ────────────────────────────────────── 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
|
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 | Commentaire | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Enumération | --- | source_space | Ce paramètre peut avoir 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. |
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 | Commentaire | |
|---|---|---|---|---|---|
| Texte | --- | shinken-core | La valeur de ce paramètre est mise à jour avec l'utilisateur ayant fait la dernière modification sur les éléments en "Nouveau" et les éléments en "Différence". |
Ce chapitre liste tous les paramètres qui sont spécifiques aux informations de connexion au serveur VMware :
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ───────────────────────────── VMWARE SPECIFIC OPTIONS (ACCESS) ────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Ip/fqdn of the vCenter/ESXi [ MANDATORY ] ───
vmware_server_ip vcenter.fqdn.com
# ─── Port of the vCenter/ESXi ───
# >>> 443 ( Default ) ───
# vmware_server_port 443
# ─── SSL settings for the vCenter/ESXi ───
# - HTTPS : 1 ( Default ) ───
# - HTTP : 0 ───
# vmware_server_use_ssl 1
# ─── Login user name for the vCenter/ESXi [ MANDATORY ] ───
vmware_server_username DOMAIN\user
# ─── Login password for the vCenter/ESXi [ MANDATORY ] ───
vmware_server_password PASSWORD
# ─── Timeout : Maximum time allowed to connect the vCenter/ESXi ───
# ─── unit: second ───
# >>> 60 ( Default ) ───
# vmware_connection_timeout 60
# ─── Enable tags/balises collect, this option only works on vCenter server ───
# ───
# Default : 0 => disabled ───
# ... : 1 => enabled ───
# ───
# vmware_collect_tags 0 |
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Texte | --- | --- | Correspond à l'adresse réseau ( IP ou DNS ) du serveur ESXi | |
| Nombre | --- | 443 | Port du serveur ESXi | |
| Booléen | --- | 1 |
| |
| Texte | --- | --- | Identifiant permettant de se connecter au serveur ESXi | |
| Texte | --- | --- | Mot de passe permettant de se connecter au serveur ESXi | |
| Nombre | seconde | 60 | Temps maximum accordé à une tentative de connexion au serveur ESXi | |
| Booléen | --- | 0 |
Pour pouvoir collecter des tags, le serveur VMware indiqué doit être un VCenter. Les tags sont gérés à partir de la version 6.5 de vSphere La collecte des tags/balises permet l'utilisation des champs suivants :
|
Défini la liste des propriétés qui seront utilisées pour générer les clés de synchronisation.
À Noter : On ne peut pas supprimer les valeurs par défaut, mais on peut les compléter. |
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Texte | --- | _SE_UUID, host_name | Permets de compléter la clé de synchronisation déjà existante. |
Il est possible de définir des propriétés que la source ne devra pas récupérer.
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| Texte | --- | --- | Empêche la récupération de certaines propriétés des éléments récoltés |