Introduction
La configuration du collecteur définie dans le fichier de configuration de la source ( pour la source par défaut : /etc/shinken/sources/synchronizer-collector-vmware.cfg ) peut être consultée dans l'onglet ci-dessous.
( voir la page Collecteur de type synchronizer-collector-vmware ( Pour vSphere - ESXi/vCenter ) ).
Elle est divisée en 5 chapitres :
- Configuration générale
- Options de mélange des sources
- Choix de l'espace sur lequel seront placés les éléments importés
- Clés spécifiques à la source
- Clé de synchronisation ( sync_key )
Remarque : Cet onglet ne permet pas encore d'éditer la configuration ( => Sera implémenté dans une prochaine version )
Configuration générale
|
Ce chapitre contient tous les paramètres pour le chargement et fonctionnement des sources en général.
| Nom dans l'interface | Noms dans le fichier | Description | ||
|---|---|---|---|---|
| Nom |
| Nom de la source affichée dans la page d'accueil de l'interface de configuration.
| ||
| Type de Module |
| Type de module chargé par le Synchroniser. Pour cette source, le module_type est "synchronizer_collector_vmware". | ||
| Intervalle d'import |
| Délai écoulé entre les imports automatiques de la source.
| ||
| Ordre |
| L'ordre de la source dans l'interface de configuration ( A un impact dans la fusion des données lors des imports de sources ).
Remarque : Si vous changez l'ordre depuis l'interface ( page d’accueil ), le fichier cfg sera mis à jour. | ||
| Éléments Shinken importés |
| Liste des types d'éléments à importer au format Shinken lors de l'import de la source.
|
Options de mélange des sources
|
Mode de mélange des sources
Grace au paramètre "Mode de mélange des sources" ( merge_mode dans le fichier de configuration de la source ), il est possible de modifier comment est gérée une source lors de l'étape du mélange des sources.
( Voir la page Le mélange des sources & les clés de synchronisation (sync-key) )
La valeur par défaut est : all
Les valeurs possibles sont :
| Nom du paramètre dans l'interface | Nom du paramètre dans le fichier | Description | |||
|---|---|---|---|---|---|
| merge_mode |
| Ce paramètre peut avoir les valeurs suivantes : | |||
| Label dans l'interface | Valeurs dans le fichier | Description | |||
| Ne fusionne pas avec les autres | dont_merge_with_other | Les éléments récoltés par cette source seront importés, mais pas fusionnés avec les autres sources. Ce qui implique que si un élément de cette source possède une clé de synchronisation commune avec une autre source, alors ces éléments ne pourront être importés et provoquera un conflit. À utiliser si votre source vous donne un élément complet et qui ne doit pas être modifié ni par l'interface de configuration ni d'autres sources. | |||
| Seulement avec syncui | only_with_syncui | Si un élément importé par cette source est aussi récolté par "Syncui", ils seront fusionnés pour ne donner qu'un élément. À utiliser si votre source vous donne un élément complet et que vous vous voulez le modifier via l'interface de configuration. | |||
| Tout sauf syncui | all_without_syncui | Si un même élément est importé par plusieurs sources ( à part "Syncui" ), alors les éléments seront fusionnés pour n'en donner qu'un. À utiliser si votre source vous donne un élément à compléter avec d'autres sources, mais qui ne doit pas être modifié par l'interface de configuration. | |||
| Toutes | all (valeur par défaut) | Si un même élément est importé par plusieurs sources, alors les éléments seront fusionnés pour n'en donner qu'un. Cas par défaut : les éléments de cette source seront complétés avec les autres sources et l'interface de configuration. | |||
Syncui est une source qui importe tous les éléments de l'interface de configuration. Chaque fois qu'une source est importée, elle l'est aussi. Si une source ne se mélange pas avec Syncui, les modifications sur l'interface de configuration ne seront pas prises en compte . |
Les sources désactivées ne sont pas prises en compte lors du mélange des sources. |
Détecter les nouveaux éléments
Les éléments proposés par la source sont soumis au calcul des nouveautés ( voir la page Modules de Sources ( imports ) et de Taggers ( qualification ) ).
| Nom des paramètres dans l'interface | Noms des paramètres dans le fichier | Défaut | Description | |||
|---|---|---|---|---|---|---|
| Détecter les nouveaux éléments |
| authorized | Ce paramètre peut avoir les valeurs suivantes : | |||
| Label dans l'interface | Valeurs dans le fichier | Description | ||||
| Option cochée | authorized | L'option est 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. | ||||
| Option non cochée | never_new | L'option est 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. | ||||
À noter : Après modification de la valeur de ce paramètre, une demande de confirmation vous sera demandée. ( Voir la page "BesoinDeConfirmation" ) |
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 ) ).
| Nom des paramètres dans l'interface | Noms des paramètres dans le fichier | Défaut | Description | |||
|---|---|---|---|---|---|---|
| Calculer les différences |
| authorized | Ce paramètre peut avoir les valeurs suivantes : | |||
| Label dans l'interface | Valeurs dans le fichier | Description | ||||
| cochée | authorized | Activée => le mécanisme de calcul des différences analysera les éléments de la source pour identifier toute différence par rapport à l'espace de données Staging. | ||||
| non cochée | never_difference | Désactivée => les éléments de la source n’apparaîtront pas en tant que différence, même s'ils possèdent des différences par rapport à l'espace de données Staging. | ||||
À noter : Après modification de la valeur de ce paramètre, une demande de confirmation vous sera demandée. ( Voir section "Besoin de confirmation" ) |
Suppression des éléments absents
Détecter les éléments qui ne sont plus présents dans la source
Permets de proposer en suppression, les éléments qui ne sont plus présents dans la ou les sources.
| Nom des paramètres dans l'interface | Noms des paramètres dans le fichier | Défaut | Description | |||
|---|---|---|---|---|---|---|
| Calculer les différences |
| disabled | Ce paramètre peut avoir les valeurs suivantes : | |||
| Label dans l'interface | Valeurs dans le fichier | Description | ||||
| Désactivé | disabled | Les éléments qui ne sont plus présents dans la ou les sources ne seront pas proposées à la suppression. | ||||
| Supprimer s'ils ne sont pas dans TOUTES les sources | delete_if_missing_in _all_sources | Les éléments, qui ne sont plus présents dans cette source et qui n'existent pas dans les autres sources ( sauf Syncui ), seront proposés à la suppression. | ||||
| Supprimer s'ils ne sont pas dans cette source | delete_if_missing_in _this_source | Les éléments qui ne sont plus présents dans cette source seront proposés à la suppression. | ||||
À noter: Après modification de la valeur de ce paramètre, une demande de confirmation vous sera demandée. ( Voir section "Besoin de confirmation" ) |
Définir une Période de maintenance sur les éléments supprimés
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 à disparition de l'équipement. Pour que les Périodes de maintenance puissent être effectives, il faut que le Script d'interprétation des traps avec le module receiver-module-webservice soit activé sur le Receiver.
| Nom des paramètres dans l'interface | Noms des paramètres dans le fichier | Valeurs dans le fichier | Description | |
|---|---|---|---|---|
| Option cochée ou non cochée |
| 1 or 0 | Permets d'activer ou de désactiver la période de maintenance sur tous les éléments supprimés de cette source. | |
| Durée |
| 1440 | Durée des périodes de maintenance en minutes. Limite est de 2630880 minutes ( soit cinq ans ). | |
| Commentaire |
| Set automaticaly by the source synchronizer-collector-vmware | Commentaire pour la période de maintenance ( Par défaut : remove from source ). | |
| Auteur |
| Source synchronizer-collector-vmware | Auteur des périodes de maintenance. | |
| Url de l'api pour définir la période de maintenance |
| 127.0.0.1 | URL du Module receiver-module-webservice. | |
| Port de l'api |
| 7760 | Port du Module receiver-module-webservice. | |
| Connexion sécurisée (https) |
| 0 | Protocole du Module receiver-module-webservice ( 1 pour https, 0 pour http ). | |
| Utilisateur de l'api |
| admin | Nom d'utilisateur de l'API ( si la protection par utilisateur / mot de passe a été activée ). | |
| Mot de passe de l'api |
| admin | Mot de passe de l'API ( si la protection par utilisateur / mot de passe a été activée ). |
Choix de l'espace où seront placé les éléments importés
|
Mettre dans l'espace
Permets d'appliquer les différences et d'importer les nouveaux éléments de cette source directement en Staging ou en Production ou bien de les laisser dans l'espace de calcul des sources comme par défaut.
| Nom des paramètres dans l'interface | Noms des paramètres dans le fichier | Défaut | Description | |||
|---|---|---|---|---|---|---|
| Mettre dans l'espace |
| source_space | Ce paramètre peut avoir les valeurs suivantes : | |||
| Label dans l'interface | Valeurs dans le fichier | Description | ||||
| Espace de calcul des Sources | source_space | 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 | staging | Les éléments sont sauvegardés dans les espaces de données "Espace de calcul des Sources" et "Staging". | ||||
| Production | production | Les éléments sont sauvegardés dans les espaces de données "Espace de calcul des Sources", "Staging" et "Production". | ||||
| Production et rechargement de l'Arbiter | production_and_reload_arbiter | Les éléments sont sauvegardés dans les espaces de données "Espace de calcul des Sources", "Staging" et "Production". | ||||
À noter : Après modification de la valeur de ce paramètre, une demande de confirmation vous sera demandée. ( Voir section "Besoin de confirmation" ) |
Une source avec le paramètre "put in" à la valeur "production" ou "production_and_reload_arbiter" n'appliquera en production que les changements qui proviennent de la source, donc tous les changements visibles dans la page de production ne seront pas appliqués. 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 deux é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 des paramètres dans l'interface | Noms des paramètres dans le fichier | Valeurs dans le fichier | Description | |
|---|---|---|---|---|
| Utilisateur utilisé pour la sauvegarde des changements |
| shinken-core | Les nouveaux éléments et les différences importés par cette source auront la valeur de cette clé comme utilisateur ayant apporté la dernière modification. |
Clés spécifiques à la source
|
Ce chapitre liste tous les paramètres qui sont spécifiques au fonctionnement de cette source.
Dans cette source, il s'agit des informations de connexion au serveur VMWare :
| Nom des paramètres dans l'interface | Noms des paramètres dans le fichier | Valeurs dans le fichier | Description | |
|---|---|---|---|---|
| Adresse IPv4 du serveur VMWare ESXi distant |
| vcenter.fqdn.com | Corresponds à l'adresse réseau ( IP ou DNS ) du serveur ESXi | |
| Numéro de port du serveur VMWare ESXi distant afin d'établir la connexion |
| 443 | Corresponds au port du serveur ESXi ( par défaut 443 ) | |
| Connexion sécurisée (http, https) |
| 1 | Corresponds à 1 si l'on veut utiliser https ou 0 si l'on veut utiliser http ( par défaut 1 ) | |
| Nom d'utilisateur du serveur VMWare ESXi distant |
| DOMAIN\user | Corresponds à l'identifiant permettant de se connecter au serveur ESXi | |
| Mot de passe du serveur VMWare ESXi distant |
| PASSWORD | Corresponds au mot de passe permettant de se connecter au serveur ESXi | |
| Délai d'attente lors de la perte de la connexion |
| 60 | Corresponds au Timeout de la connexion au serveur ESXi ( en secondes ) | |
| 0 | Corresponds à 1 si on veut activer la collecte des balises ( tags ) ou 0 si on la collecte est désactivé.
|
À noter : Après modification de la valeur de ce paramètre "Adresse IPv4 du serveur VMWare ESXi distant" ( vmware_server_ip ) , une demande de confirmation vous sera demandée. ( Voir section "Besoin de confirmation" ) |
L'option vmware_collect_tags qui permet la collecte des balises ( tags ) utilise une API spécifique disponible uniquement sur les vSphere. Elle permet la collecte des champs suivants : |
Précisions techniques
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) ).
Le paramètre properties_used_as_synckey_for_hosts de la source permet d'ajouter les propriétés qui serviront à créer les clés de synchronisation ( voir la page Collecteur de type synchronizer-collector-vmware ( Pour vSphere - ESXi/vCenter ) ).
Propriétés par défaut utilisé pour la construction des clés de synchronisation
Propriétés par défaut utilisé pour la construction des clés de synchronisation :
| Propriété | Type d'élément | Info | |
|---|---|---|---|
| Tous les éléments | Cette propriété ne peut pas être retirée des propriétés utilisées pour faire les clés de synchronisation | |
| Tous les éléments | Cette propriété ne peut pas être retirée des propriétés utilisées pour faire les clés de synchronisation |
Besoin de confirmation
Lorsqu'une modification de la configuration de la source est faite, elle peut impacter les éléments importés avec l'ancienne configuration. Par exemple, ils seront automatiquement supprimés, si vous avez activé la suppression automatique ou si vous l'activez dans le futur.
Pour pallier ce problème, une demande de confirmation apparaîtra si votre nouvelle configuration de source impacte ou pourra impacter les éléments précédemment importés.
Cette demande de confirmation s'active lorsque la valeur du paramètre "Mettre dans l'espace" ( put_in ) est différente de "Espace de calcul des sources".
Liste des paramètres pouvant déclencher la demande de confirmation :
| Nom des paramètres dans l'interface | Noms des paramètres dans le fichier | |
|---|---|---|
| Détecter les nouveaux éléments |
| |
| Calculer les différences |
| |
| Détecter les éléments qui ne sont plus présents dans la source |
| |
| Mettre dans l'espace |
| |
| Adresse du serveur VMWare ESXi distant |
|
|
Erreurs de configuration
Dans le cas où, vous renseignez une clé non reconnue par Shinken dans la configuration de la source, une erreur apparaîtra. Cette erreur rendra l'import de la source impossible.
|
