| Scroll Ignore | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
|
Concept
La source synchronizer-collector-vmware permet d’interroger l'API d'un serveur ESX ESXi ou d'un vCenter afin de récupérer toutes les informations disponibles des ESXs ESXi et des machines virtuelles présentes.
Puis la source va définir les hôtes Shinken qui permettront de superviser les ESXs ESXi et VM détectées.
| Info | ||
|---|---|---|
| ||
Les versions supportées par la source sont : 7.0, 7.0U1, 7.0U2, 7.0U3 , 8.0, 8.0U1, 8.0U2, 8.0U3 |
Cette page vous explique comment de définir ce type de collecteur et la page Collecteur collecteur ( pour l'utilisation du collecteur, voir la page Collecteur de type ( synchronizer-collector-vmware ) - Import depuis des serveurs VMWare vous décrit comment l'utiliser.
Activation de la source
Activer le collecteur synchronizer-collector-vmware livré par défaut
).
Définition : ESXi, vCenter, vSphere
- ESXi : Hyperviseur de type 1 ( voir la page Qu'est-ce qu'un hyperviseur ? ), Système d'exploitation et permettant de gérer les machines virtuelles sur une machine physique.
- vCenter : Serveur permettant de gérer plusieurs ESXi, créer des machines virtuelles et leur allouer des ressources réseau ou matérielles ( RAM, CPU… ).
- vSphere : Nom donné par VMware à l'infrastructure comportant un ou plusieurs ESXi ainsi qu'un VCenter.
| Panel |
|---|
( Pour plus d'informations, voir la pageQu'est-ce que VMware ? )
Activation de la source
Activer le collecteur synchronizer-collector-vmware livré par défaut
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".
- La configuration de
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".
- La configuration de ce collecteur se trouve par défaut dans le fichier : /etc/shinken/sources/synchronizer-collector-vmware.cfg.
- Le collecteur synchronizer-collector-vmware s'active comme les autres sources, c'est-à-dire en modifiant le fichier /etc/shinken/synchronizers/synchronizer-master.cfg ( ou le .cfg que vous utilisez pour définir les options du Synchronizer ).
- Ce collecteur est déjà présent dans la liste des sources livrées par défaut, il n'y a donc rien à modifier.,
- S'il n'y est pas, vous pouvez le rajouter pour qu'il soit de nouveau actif.
Exemple :
Code Block language js theme Confluencebash 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 :
Code Block service shinken-synchronizer restartlanguage bash theme Confluence Excerpt Include Configuration ( Synchronizer ) Configuration ( Synchronizer ) page DefaultLink[destination=Optional[PageResourceIdentifier[spaceKey=<null>,title=Configuration ( Synchronizer )]],body=Optional.empty,tooltip=Optional.empty,anchor=Optional.empty,target=Optional.empty] nopanel true
Ajouter un autre collecteur de type synchronizer-collector-vmware
Vous pouvez avoir plusieurs sources du type synchronizer-collector-vmware, pour donc par exemple se connecter à plusieurs serveurs VMware.
Choisissez un nom pour ce nouveau collecteur.
- Pour l'exemple, nous allons l'appeler "
Mon-Collecteur-Synchronizer-VMWare". - Remplacer dans l'exemple le mot "
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 )Code Block language bashtext theme ConfluenceEmacs 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
- Ouvrer ce fichier ( 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".Code Block language js theme Confluencebash 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.
Code Block language js theme Confluencebash 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.
Code Block service shinken-synchronizer restartlanguage bash theme Confluence Excerpt Include Configuration ( Synchronizer ) Configuration ( Synchronizer ) page DefaultLink[destination=Optional[PageResourceIdentifier[spaceKey=<null>,title=Configuration ( Synchronizer )]],body=Optional.empty,tooltip=Optional.empty,anchor=Optional.empty,target=Optional.empty] nopanel true
Configuration
La configuration du module se trouve dans le dossier /etc/shinken/sources/synchronizer-collector-vmware.cfg
- Vous trouverez un exemple dans /etc/shinken-user-example/configuration/daemons/synchronizers/sources/synchronizer-collector-vmware/synchronizer-collector-vmware-example.cfg
Exemple de fichier de configuration
| Code Block | ||||
|---|---|---|---|---|
| ||||
# CFG_FORMAT_VERSION 1 ( SHINKEN : DON'T TOUCH THIS LINE ) #================================================================================ # 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-example # ─── 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 VcentervCenter/ES ESXi [ MANDATORY ] ─── # ─── ─── vmware_server_ip vcenter.fqdn.com # ─── Port of the VcentervCenter/ESXESXi ─── # ─── # Default : 443 ─── # ─── ─── # vmware_server_port 443 # ─── SSL settings for the VcentervCenter/ESXESXi ─── # ─── # Default : 01 => HTTPS ─── # ... : 10 => HTTP ─── # ─── ─── # vmware_server_use_ssl 1 # ─── Login user name for the VcentervCenter/ESXESXi [ MANDATORY ] ─── # ─── ─── vmware_server_username DOMAIN\user # ─── Login password for the VcentervCenter/ESXESXi [ MANDATORY ] ─── # ─── ─── vmware_server_password PASSWORD # ─── Timeout : Maximum time allowed to connect the VcentervCenter/ESXESXi ─── # ─── unit: second ─── # ─── # Default : 60 ─── # ─── ─── # vmware_connection_timeout 60 } |
Détails des sections composant le fichier de configuration
Identification du module de source
Il est possible de définir plusieurs instances de module de type synchronizer-collector-vmware dans votre architecture Shinken.
- Chaque instance devra avoir un nom unique.
| Code Block |
|---|
source_name |
---
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 - .
- Doit être unique.
- Doit commencer par une lettre.
- D'une longueur maximum à 40 caractères.
- Ne doit pas contenir le caractère "$".
| Code Block |
|---|
module_type |
---
Ne peut être modifié
Interval d'import et ordre de la source
| Code Block | ||
|---|---|---|
| ||
# ─── Interval between each automatic import # ─── SSL settings for the vCenter/ESXi ─── # ─── # ─── Interval in minutes between each automatic import of the source ─── # Default : 0 => disabled ─── # ─── -> Setting it to 0 will deactivate the automatic import and can only be done manually ─── # Default : 0 ─── # ... : 1 => enabled ─── # ─── # ─── ─── # import_interval ─── # vmware_server_use_ssl 0 # ─── Enable Ordertags ofcollect, prioritythis whenoption mergingonly dataworks on vCenter server ─── # ─── # ─── 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 0 => disabled ─── # ... : 1 => enabled ─── # ─── # ─── ─── # order 99 |
| Code Block |
|---|
import_interval |
Entier positif
minute
0 Si 0, l'import de la source ne sera jamais exécuté automatiquement.( L'import ne pourra être effectué uniquement manuellement )
| Code Block |
|---|
order |
L'ordre de la source dans l'interface de configuration ( A un impact dans la fusion des données lors des imports de sources ).
- Voir la page Le mélange des sources & les clés de synchronisation (sync-key) pour plus d'information au sujet des fusions.
| Info | ||||
|---|---|---|---|---|
| ||||
Si vous changez l'ordre depuis l'interface ( page d’accueil ), le fichier .cfg sera mis à jour. |
Options de mélange des sources
| Code Block | ||
|---|---|---|
| ||
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ # # │ ─────────────────────────────────────── MERGE OPTIONS ─── ─────────────────────────────────────── │ # vmware_collect_tags # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ # # ─── Source merge mode 0 # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ # # │ ───────────────────────────── SYNCHRONIZATION KEYS ( SYNC_KEY ) ───────────────────────────── │ # # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ # # ─── List of parameters whose values will be used as sync keys for hosts elements ─── # >>> all ─── # : Merge with all source ( Default ) ─── # ─── dont_merge_with_other : Don't merge with other source ─── # ─── #Default ───: only_with_syncuiSE_UUID : Merge only with syncui ─── # ─── all_without_syncui # : Merge with all source without syncui ... : host_name ─── # merge_mode all─── # ─── Detecting new elements ─── # >>> authorized ( Default ) ─── # properties_used_as_synckey_for_hosts _SE_UUID, host_name } |
Détails des sections composant le fichier de configuration
Identification du module de source
| Code Block | ||||
|---|---|---|---|---|
| ||||
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ # # │ ────────────────────────────────────── SOURCE IDENTITY ────────────────────────────────────── │ # # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ # # ─── Source name [ Must be unique ] ─── # ─── never_new [ MANDATORY ] ─── # ─── ⚠ Must be unique ─── # compute_new_element authorized # ─── Calculate the differences ─── # ─── ⚠ Forbidden characters ?&"'$/#\\; ─── # >>> authorized (─── Default ) # ─── ⚠ Length of the name must not exceed 40 characters ─── # ─── # ─── never_difference ─── # compute_element_difference ─── source_name authorized # ─── Detect elements that are no longer present in the source synchronizer-collector-vmware # ─── Module type [ Do not edit ] ─── # >>> disabled ( Default ) [ MANDATORY ] ─── # ─── ─── # ─── delete_if_missing_in_all_sources ─── module_type ─── # ─── delete_if_missing_in_this_source synchronizer_collector_vmware # ─── Display a description on the interface for this source ─── # compute_deleted_element_not_in_source ─── # ─── disabled # ─── Setting a Maintenance Period on Deleted Items ─── # downtime_on_delete_element_activated 0 # downtime_on_delete_element_duration ─── description 1440 # downtime_on_delete_element_comment This source is about loading hosts from a VMWare Server # downtime_on_delete_element_author # downtime_on_delete_element_api_url─── Interval between each automatic import 127.0.0.1 # downtime_on_delete_element_api_port 7760 # downtime_on_delete_element_api_use_ssl 0 # downtime_on_delete_element_api_user ─── # downtime_on_delete_element_api_password |
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.
Pour en savoir plus sur le fonctionnement du mélange des sources, veuillez vous référer à la partie Comportement des clés de synchronisation de la page de configuration du module ( synchronizer-collector-vmware )
| Code Block | ||
|---|---|---|
| ||
# ─── Source merge mode ─── 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 ─── # - all : Merge with all source ( Default ) ─── # - dont_merge_with_other : Don't merge with other source ─── # - only_with_syncui : Merge only with syncui ─── # import_interval ─── # - all_without_syncui 0 # ─── Order of priority when merging data : Merge with all source without syncui ─── # ─── The final element will take the value of the element from the source with the highest priority ─── # merge_mode─── -> Priority at source with the order closest to 1 all |
| Code Block |
|---|
merge_mode |
Enumération
all
Ce paramètre peut avoir les valeurs suivantes :
| Nom | Description |
|---|---|
| dont_merge_with_other | Les éléments récoltés par cette source seront importés, mais pas fusionnés avec les autres sources. S'il existe le même élément importé par une autre source, l'élément ne sera pas importé. |
| only_with_syncui | Si un même élément existe déjà dans "Syncui", ils seront tous les deux fusionnés pour n'en donner qu'un. |
| 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. |
| all | Si un même élément est importé par plusieurs sources, alors les éléments seront fusionnés pour en donner qu'un. |
| 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 ( cf. Les Modules de détection et de qualification ).
| Code Block | ||
|---|---|---|
| ||
# ─── Detecting new elements ─── # Default : 99 ─── # ─── # - authorized ( Default ) ─── # order 99 # ─── Make the source active ─── # - never_new ─── # compute_new_element ... : 0 => disabled authorized |
| Panel | ||
|---|---|---|
| ||
|
Ce paramètre peut avoir les valeurs suivantes :
| Nom | Description |
|---|---|
| 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. |
| 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. |
Calculer les différences
Les éléments proposés par la source sont soumis au calcul des différences ( cf. Les Modules de détection et de qualification ).
| Code Block | ||
|---|---|---|
| ||
# ─── Calculate the differences ─── # Default : 1 => enabled ─── # - authorized ( Default ) ─── # ─── # - never_difference ─── # enabled ─── # compute_element_difference authorized 1 |
Il est possible de définir plusieurs instances de module de type synchronizer-collector-vmware dans votre architecture Shinken.
- Chaque instance devra avoir un nom unique.
| Nom | Type | Unité | Défaut | Commentaire |
|---|
|
|
|
| Texte | --- |
Ce paramètre peut avoir les valeurs suivantes :
| Nom | Description |
|---|---|
| authorized | L'option est 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. |
| never_difference | L'option est 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. |
Suppression des éléments absents
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).
| 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.
|
Options de mélange des sources
| Code Block | ||||
|---|---|---|---|---|
| ||||
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ─────────────────────────────────────── MERGE OPTIONS ─────────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Behaviour of mixing of sources | ||||
| Code Block | ||||
| ||||
# ─── Detect elements that are no longer present in the source ─── # - disabled ( Default ) ─── # - delete_if_missing_in_all_sources ─── # ─── # - delete_if_missing_in_this_source ─── # ─── Default : # compute_deleted_element_not_in_sourceall disabled |
| Code Block |
|---|
compute_deleted_element_not_in_source |
Ce paramètre peut avoir les valeurs suivantes :
| Nom | Description |
|---|---|
| disabled | L'option est 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. |
| delete_if_missing_in_all_sources | L'option est 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. |
| delete_if_missing_in_this_source | Les éléments qui ne sont plus présents dans cette source seront proposés à la suppression. |
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'ESX 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.
| Code Block | ||
|---|---|---|
| ||
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ # # │ ────────────────────── SETTING FOR DOWNTIME PERIOD ON DELETED ELEMENTS ────────────────────── │ # # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ # => 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 # ─── AddNew downtimeelement periodcalculation on deleted elements ─── # - disabled : 0 ( Default )─── # ─── # - enabled : 1 ─── # Default : authorized ( Authorized the calculation of new items ) ─── # ─── # downtime_on_delete_element_activated... : never_new ( Do not compute new items ) 0 # ─── Duration of downtime period ─── # ─── # >>> 1440 ( Default ) ─── # compute_new_element ─── # ─── unit: minuteauthorized # ─── Element difference calculation ─── # ─── accepted range: 1 to 2630880 ( 5 years ) ─── # downtime_on_delete_element_duration 1440 # ─── Commentary added in downtime period ─── # Default : authorized ( Authorized the calculation of differences ) ─── # ─── # >>> Set automatically... by the source (: Defaultnever_difference )( Do not compute differences ) ─── # ─── # downtime_on_delete_element_comment Set automatically by the source # ─── Author of downtime period ─── # compute_element_difference ─── # >>> shinken-core ( Default ) authorized # ─── Specific treatment with elements that are no longer present in the source ─── # ─── # downtime_on_delete_element_author shinken-core # ─── Url used by receiver-module-webservice module ─── # >>> 127.0.0.1 ( Default ) Default : disabled ─── # downtime_on_delete_element_api_url ─── # 127.0.0.1 # ─── Port used by receiver-module-webservice module: delete_if_missing_in_all_sources ─── # ─── # >>> 7760 ( Default... ) : delete_if_missing_in_this_source ─── # ─── # downtime_on_delete_element_api_port 7760 # ─── SSL settings for receiver-module-webservice module ─── # compute_deleted_element_not_in_source - HTTP : 0 ( Default ) 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-vmware ) ).
| Code Block | ||||
|---|---|---|---|---|
| ||||
# ─── Source merge mode ─── # - HTTPS : 1 ─── # - all : Merge with all source ( Default ) ─── # downtime_on_delete_element_api_use_ssl 0 # ─── User name for receiver-module-webservice module dont_merge_with_other : Don't merge with other source ─── # ─── - only_with_syncui : Merge Onlyonly ifwith user/passwordsyncui protection has been activated ─── # >>> admin ( Default ) ─── # - all_without_syncui : Merge with all source without syncui ─── # downtime_on_delete_element_api_usermerge_mode admin # ─── Password for receiver-module-webservice module all ─── # ─── Only if user/password protection has been activated ─── # >>> admin ( Default ) ─── # downtime_on_delete_element_api_password admin |
| Code Block |
|---|
downtime_on_delete_element_activated |
( 1 pour activer, 0 pour désactiver )
| Code Block |
|---|
downtime_on_delete_element_duration |
Durée des périodes de maintenance en minutes. La limite est de 2630880 minutes ( soit cinq ans ).
| Code Block |
|---|
downtime_on_delete_element_comment |
| Code Block |
|---|
downtime_on_delete_element_author |
| Code Block |
|---|
downtime_on_delete_element_api_url |
| Code Block |
|---|
downtime_on_delete_element_api_port |
| Code Block |
|---|
downtime_on_delete_element_api_use_ssl |
| Code Block |
|---|
downtime_on_delete_element_api_user |
| Code Block |
|---|
downtime_on_delete_element_api_password |
Dépôt des éléments après l'import
|
| Nom | Type | Unité | Défaut | Commentaire | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Enumération | --- | all | Ce paramètre peut avoir les valeurs suivantes :
|
| 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 | ||||
|---|---|---|---|---|
| ||||
# ─── Detecting new elements ───
# - authorized ( Default ) | ||||
| Code Block | ||||
| ||||
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ # # │ ────────────────────────────────────── PUT IN OPTIONS ─────────────────────────────────────── │ # # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ # # ─── Targeted spaces to put elements ─── # - never_new ─── # - source_space : Available for staging ( Default ) ─── # compute_new_element - staging : Saved in staging authorized |
| Nom | Type | Unité | Défaut | Commentaire | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Énumération | --- | authorized | Ce paramètre peut avoir 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 ) ).
| Code Block | ||||
|---|---|---|---|---|
| ||||
# ─── Calculate the differences ─── # - production : Saved in staging ─── # - authorized ( Default ) Saved in production ─── # - production_and_reload_arbiter : Saved in staging never_difference ─── # Saved in production ─── # compute_element_difference Available to monitoring ─── # put_in source_space authorized |
| Nom | Type | Unité | Défaut | Commentaire | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Enumération | --- | authorized | Ce paramètre peut avoir 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).
| Warning |
|---|
Cette option peut être activée que si cette source met directement dans l'espace "Staging" ou "Production" ses éléments importés. |
| Code Block | ||||
|---|---|---|---|---|
| ||||
# ─── UserDetect responsibleelements ofthat importare no longer present in the source ─── # - disabled ( Default ) ─── # ─── accepted name : Only admin shinken name ─── # >>> admin ( Default )- delete_if_missing_in_all_sources ─── # - delete_if_missing_in_this_source ─── # put_in_user admin |
Mettre dans l'espace
───
# compute_deleted_element_not_in_source disabled |
| Nom | Type | Unité | Défaut | Commentaire | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Enumération | --- | source_space disabled | Ce paramètre peut avoir les valeurs suivantes :
|
| 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. |
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.
|
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 à 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 )
| Code Block | ||||
|---|---|---|---|---|
| ||||
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ────────────────────── 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 ). |
Choix de l'espace d'import des éléments
| Code Block | ||||
|---|---|---|---|---|
| ||||
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ────────────────────────────────────── 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 | Commentaire | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Enumération | --- | source_space | Ce paramètre peut avoir les valeurs suivantes :
|
| 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. |
Utilisateur utilisé pour la sauvegarde des changements
Option qui permet de choisir l'utilisateur qui apparaîtra comme étant le dernier à avoir mis à jour les éléments.
| Info |
|---|
À Noter : l'utilisateur doit être obligatoirement un administrateur Shinken. |
| Nom | 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". |
Connexion au serveur VMWare
Ce chapitre liste tous les paramètres qui sont spécifiques aux informations de connexion au serveur VMware :
| Code Block | ||||
|---|---|---|---|---|
| ||||
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ───────────────────────────── 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 collect, this option only works on vCenter server ───
# ───
# Default : 0 => disabled ───
# ... : 1 => enabled ───
# ───
# vmware_collect_tags 0 | ||||
| Info | ||||
| À Noter : l'utilisateur doit être obligatoirement un administrateur Shinken. |
| Nom | Type | Unité | Défaut | Commentaire |
|---|
|
|
|
| Texte | --- |
| --- |
Connexion au serveur VMWare
Ce chapitre liste tous les paramètres qui sont spécifiques aux informations de connexion au serveur VMware :
| Correspond à l'adresse réseau ( IP ou DNS ) du serveur vCenter ou ESXi. | ||||||||
| Nombre | --- | 443 | Port du serveur vCenter ou ESXi. | ||||
| Booléen | --- | 1 |
| ||||
| Texte | --- | --- | Identifiant permettant de se connecter au serveur vCenter ou ESXi. | ||||
| Texte | --- | --- | Mot de passe permettant de se connecter au serveur vCenter ou ESXi. | ||||
| Nombre | seconde | 60 | Temps maximum accordé à une tentative de connexion au serveur vCenter ou ESXi | ||||
| Booléen | --- | 0 |
La collecte des balises permet l'utilisation des champs suivants :
|
| Anchor | ||||
|---|---|---|---|---|
|
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 | ||||
|---|---|---|---|---|
| ||||
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ───────────────────────────── SYNCHRONIZATION KEYS ( SYNC_KEY ) ───────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ # | ||||
| Code Block | ||||
| ||||
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ # # │ ───────────────────────────── VMWARE SPECIFIC OPTIONS (ACCESS) ────────────────────────────── │ # # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ # # ─── Ip/fqdn of the Vcenter/ESX [ MANDATORY ] ─── vmware_server_ip vcenter.fqdn.com # ─── Port of the Vcenter/ESX ─── # >>> 443 ( Default ) ─── # vmware_server_port 443 # ─── SSL settings for the Vcenter/ESX ─── # - HTTPS : 1 ( Default ) ─── # - HTTP : 0 ─── # vmware_server_use_ssl 1 # ─── LoginList userof nameparameters forwhose thevalues Vcenter/ESXwill be used as sync keys for hosts elements ─── # [ MANDATORY ] ─── vmware_server_username DOMAIN\user # ─── Login password for the Vcenter/ESX [ MANDATORY ] ─── vmware_server_password# Default PASSWORD : _SE_UUID # ─── Timeout : Maximum time allowed to connect the Vcenter/ESX ─── # ─── unit: second ─── # ... : host_name ─── # >>> 60 ( Default ) ─── # ─── ─── # vmware_connection_timeout 60 |
| Code Block |
|---|
vmware_server_ip |
| Code Block |
|---|
vmware_server_port |
| Code Block |
|---|
vmware_server_use_ssl |
- 0 : Le module se connectera au serveur ESX en utilisant le protocole HTTP
- 1 : Le module se connectera au serveur ESX en utilisant le protocole HTTPS
| Code Block |
|---|
vmware_server_username |
| Code Block |
|---|
vmware_server_password |
| Code Block |
|---|
vmware_connection_timeout |
Temps maximum accordé à une tentative de connexion au serveur ESX
( en secondes )
Défini la liste des propriétés qui seront utilisées pour générer les clés de synchronisation.
| Info |
|---|
À Noter : On ne peut pas supprimer les valeurs par défaut, mais on peut les compléter.───
# properties_used_as_synckey_for_hosts _SE_UUID, host_name |
| Nom | Type | Unité | Défaut | Commentaire | ||
|---|---|---|---|---|---|---|
| Texte | --- | _SE_UUID, host_name | Permets de compléter la clé de synchronisation déjà existante. |
Propriétés non récupérées
Il est possible de définir des propriétés que la source ne devra pas récupérer.
- Dans le cas de cette source, si possible nous ne conseillons de ne pas utiliser cette option vue.
- En effet, vous pourrez directement choisir les propriétés remontées dans l'interface de la source => Cela ferait double emploi et serait source de confusion.
- C'est pour ça que cette option n'est pas par défaut dans le fichier de configuration de la source.
| Info | ||
|---|---|---|
| ||
Le paramètre "
|
| Code Block |
|---|
not_stored_properties |
