Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Scroll Ignore
scroll-viewporttrue
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmlfalse
Panel
titleSommaire

Table of Contents
stylenone

Concept

La source synchronizer-collector-vmware permet d’interroger l'API d'un serveur ESXi ou d'un vCenter afin de récupérer toutes les informations disponibles des ESXi et des machines virtuelles présentes.
Puis la source va définir les hôtes Shinken qui permettront de superviser les ESXi et VM détectées.

Info
titleVersions de vCenter supportées

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 définir ce type de collecteur ( pour l'utilisation du collecteur, voir la page Collecteur de type ( synchronizer-collector-vmware ) - Import depuis des serveurs VMWare ).

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 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
      languagejs
      themeConfluence
      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 :

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

Ajouter un autre collecteur de type synchronizer-collector-vmware

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.

  • 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
    languagetext
    themeEmacs
    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
      languagejs
      themeConfluence
      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
    languagejs
    themeConfluence
    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.

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


Configuration

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
languagejs
themeConfluence
# 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 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 : 1 => HTTPS                                                                        ───
    #           ...     : 0 => 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

    # ─── SSL settings for the vCenter/ESXi                                                                 ───
    #                                                                                                       ───
    #           Default : 0 => disabled                                                                     ───
    #           ...     : 1 => enabled                                                                      ───
    # ───                                                                                                   ───
    # vmware_server_use_ssl                               0

    # ─── Enable tags collect, this option only works on vCenter server                                     ───
    #                                                                                                       ───
    #           Default : 0 => disabled                                                                     ───
    #           ...     : 1 => enabled                                                                      ───
    # ───                                                                                                   ───
    # vmware_collect_tags                                 0

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ─────────────────────────────    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

}



Détails des sections composant le fichier de configuration

Identification du module de source

Code Block
languagejs
themeConfluence
    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ──────────────────────────────────────    SOURCE IDENTITY    ────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── Source name [ Must be unique ]                                                      [ MANDATORY ] ───
    # ───       ⚠ Must be unique                                                                            ───
    # ───       ⚠ Forbidden characters ?&"'$/#\\;                                                           ───
    # ───       ⚠ Length of the name must not exceed 40 characters                                          ───
    #                                                                                                       ───
    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.

  • Chaque instance devra avoir un nom unique.
NomTypeUnitéDéfautCommentaire
No Format
source_name
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 -  :

  • Doit être unique,
  • Doit commencer par une lettre,
  • D'une longueur maximum à 40 caractères,
  • Ne doit pas contenir le caractère "$".
No Format
module_type
Texte

---

synchronizer_collector_vmware

Ne peut être modifié.

No Format
description	
Texte

---


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

No Format
import_interval

Entier positif

minute

0

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

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

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

 

Info
iconfalse
titleRemarque

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

No Format
enabled	
Booléen

---

1

Permet d'activer/désactiver la source.

Info
iconfalse
titleRemarque

Si vous activez/desactivez la source depuis l'interface ( page d’accueil ), le fichier .cfg sera mis à jour.

Options de mélange des sources

Code Block
languagejs
themeConfluence
    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ───────────────────────────────────────    MERGE OPTIONS    ─────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── Behaviour of mixing of sources                                                                    ───
    #                                                                                                       ───
    #           Default : all                     => Merge with all source                                  ───
    #           ...     : dont_merge_with_other   => Don't merge with other source                          ───
    #           ...     : only_with_syncui        => Merge only with syncui                                 ───
    #           ...     : all_without_syncui      => Merge with all source without syncui                   ───
    #                                                                                                       ───
    # merge_mode                                          all

    # ─── New element calculation                                                                           ───
    #                                                                                                       ───
    #           Default : authorized ( Authorized the calculation of new items )                            ───
    #           ...     : never_new  ( Do not compute new items )                                           ───
    #                                                                                                       ───
    # compute_new_element                                 authorized

    # ─── Element difference calculation                                                                    ───
    #                                                                                                       ───
    #           Default : authorized       ( Authorized the calculation of differences )                    ───
    #           ...     : never_difference ( Do not compute differences )                                   ───
    #                                                                                                       ───
    # compute_element_difference                          authorized

    # ─── Specific treatment with elements that are no longer present in the source                         ───
    #                                                                                                       ───
    #           Default : disabled                                                                          ───
    #           ...     : delete_if_missing_in_all_sources                                                  ───
    #           ...     : delete_if_missing_in_this_source                                                  ───
    #                                                                                                       ───
    # compute_deleted_element_not_in_source               disabled     
Mode de mélange des sources

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

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

Enumération

---

all

Ce paramètre peut avoir les valeurs suivantes :

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

Code Block
languagejs
themeConfluence
    # ─── Detecting new elements                                                                            ───
    #   - authorized ( Default )                                                                            ───
    #   - never_new                                                                                         ───
    # compute_new_element                               authorized
NomTypeUnitéDéfautCommentaire
Panel
borderColor#c1c7d0

compute_new_element



Énumération---authorized 

Ce paramètre peut avoir les valeurs suivantes :

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

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



NomTypeUnitéDéfautCommentaire
No Format
compute_element_difference
Enumération--- authorized 

Ce paramètre peut avoir les valeurs suivantes :

NomDescription
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_differenceL'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.
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
languagejs
themeConfluence
    # ─── Detect elements that are no longer present in the source                                          ───
    #   - disabled ( Default )                                                                              ───
    #   - delete_if_missing_in_all_sources                                                                  ───
    #   - delete_if_missing_in_this_source                                                                  ───
    # compute_deleted_element_not_in_source             disabled   
NomTypeUnitéDéfautCommentaire
No Format
compute_deleted_element_not_in_source
Enumération--- disabled

Ce paramètre peut avoir les valeurs suivantes :

NomDescription
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_sourcesL'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_sourceLes é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'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
languagejs
themeConfluence
    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ──────────────────────    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
 
NomTypeUnitéDéfautCommentaire
No Format
downtime_on_delete_element_activated
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 )
No Format
downtime_on_delete_element_duration
Nombreminute 1440 ( un jour )

Durée des périodes de maintenance en minutes. La limite est de 2630880 minutes ( soit cinq ans ).

No Format
downtime_on_delete_element_comment
Texte--- Géré automatiquement par synchronizer-collector-vmware Commentaire pour la période de maintenance.
No Format
downtime_on_delete_element_author
Texte--- shinken-core Auteur des périodes de maintenance.
No Format
downtime_on_delete_element_api_url
Texte--- 127.0.0.1 URL du Module receiver-module-webservice.
No Format
downtime_on_delete_element_api_port
Nombre--- 7760 Port du Module receiver-module-webservice.
No Format
downtime_on_delete_element_api_use_ssl
Booléen--- 0 Protocole du Module receiver-module-webservice  ( 1 pour https, 0 pour http ).
No Format
downtime_on_delete_element_api_user
Texte--- admin Nom d'utilisateur de l'API ( si la protection par utilisateur / mot de passe a été activée ).
No Format
downtime_on_delete_element_api_password
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
languagejs
themeConfluence
    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ──────────────────────────────────────    PUT IN OPTIONS    ─────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── Targeted spaces to put elements                                                                   ───
    #   - source_space                  : Available for staging ( Default )                                 ───
    #   - staging                       : Saved in staging                                                  ───
    #   - production                    : Saved in staging                                                  ───
    #                                     Saved in production                                               ───
    #   - production_and_reload_arbiter : Saved in staging                                                  ───
    #                                     Saved in production                                               ───
    #                                     Available to monitoring                                           ───
    # put_in                                            source_space

    # ─── User responsible of import                                                                        ───
    # ───          accepted name : Only admin shinken name                                                  ───
    # >>> admin  ( Default )                                                                                ───
    # put_in_user                                       admin
 
Mettre dans l'espace

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

NomTypeUnitéDéfautCommentaire
No Format
put_in
Enumération--- source_space

Ce paramètre peut avoir les valeurs suivantes :

NomDescription
source_spaceLes éléments sont sauvegardés dans l'espace de données "Sources". Cet espace sera comparé avec l'espace de données "Staging" afin de calculer les nouveautés et les différences.
staging Les éléments sont sauvegardés dans les espaces de données "Espace de calcul des Sources" et "Staging".
productionLes éléments sont sauvegardés dans les espaces de données "Espace de calcul des Sources", "Staging" et "Production".
production_and_reload_arbiterLes éléments sont sauvegardés dans les espaces de données "Espace de calcul des Sources", "Staging" et "Production".
L'Arbiter est redémarré après l'import afin de soumettre les changements à la supervision.
Info

À noter : Une source avec le paramètre "put in" à la valeur "production" ou "production_and_reload_arbiter" ne poussera en production que les changements qui proviennent de la source et non tous les changements à appliquer en production ( tous les changements visibles dans la page de production ).

Ce qui implique que si un utilisateur supprime un élément importé par une source avec le paramètre "put_in" à la valeur "production" ou "production_and_reload_arbiter", alors que l'élément est réimporté par la source. Il y aura en production 2 éléments avec le même nom, car la suppression manuelle de l'élément ne sera pas prise en compte, ce qui provoquera une erreur.
Une source avec l'option "put_in" à "production_and_reload_arbiter" ne redémarrera l'Arbiter que si elle a des modifications à pousser en production.

Utilisateur utilisé pour la sauvegarde des changements

Option qui permet de choisir l'utilisateur qui apparaîtra comme étant le dernier à avoir mis à jour les éléments.

Info

À Noter :  l'utilisateur doit être obligatoirement un administrateur Shinken.

NomTypeUnitéDéfautCommentaire
No Format
put_in_user
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
languagejs
themeConfluence
    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ─────────────────────────────    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  
NomTypeUnitéDéfautCommentaire
No Format
vmware_server_ip
Texte------Correspond à l'adresse réseau ( IP ou DNS ) du serveur vCenter ou ESXi.
No Format
vmware_server_port
Nombre--- 443 Port du serveur vCenter ou ESXi.
No Format
vmware_server_use_ssl
Booléen--- 1
  • 0 : Le module se connectera au serveur vCenter ou ESXi en utilisant le protocole HTTP.
  • 1 : Le module se connectera au serveur vCenter ou ESXi en utilisant le protocole HTTPS.
No Format
vmware_server_username
Texte------Identifiant permettant de se connecter au serveur vCenter ou ESXi.
No Format
vmware_server_password
Texte------Mot de passe permettant de se connecter au serveur vCenter ou ESXi.
No Format
vmware_connection_timeout
Nombreseconde 60

Temps maximum accordé à une tentative de connexion au serveur vCenter ou ESXi
en secondes  ).

No Format
vmware_collect_tags
Booléen---0
  • 0 : Desactive la collecte des balises ( tags en anglais ).
  • 1 : Active la collecte des balises ( tags en anglais ).


Warning

Pour pouvoir collecter des balises ( tags en anglais ), le serveur VMware indiqué dans l'option vmware_server_ip doit être un vCenter.

Les balises sont gérés à partir de la version 6.5 de vSphere.


La collecte des balises permet l'utilisation des champs suivants : 

shinken.tags, shinken.tag_categories, shinken.tags_by_category.

Anchor
sync_keys
sync_keys

Clés de synchronisation ( sync_key )

Défini la liste des propriétés qui seront utilisées pour générer les clés de synchronisation.

Les clés de synchronisation sont des valeurs utilisées lors de l'étape du mélange des sources ( voir la page Modules de Sources ( imports ) et de Taggers ( qualification ) ) qui permet de choisir quel élément de cette source se mélange avec quel élément d'une autre source ( voir la page Le mélange des sources & les clés de synchronisation (sync-key)  ).

Info

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

Code Block
languagejs
themeConfluence
    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ─────────────────────────────    SYNCHRONIZATION KEYS ( SYNC_KEY )    ───────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── List of parameters whose values will be used as sync keys for hosts elements                      ───
    #                                                                                                       ───
    #           Default : _SE_UUID                                                                          ───
    #           ...     : host_name                                                                         ───
    # ───                                                                                                   ───
    # properties_used_as_synckey_for_hosts                _SE_UUID, host_name
NomTypeUnitéDéfautCommentaire
No Format
properties_used_as_synckey_for_hosts
Texte--- _SE_UUID, host_name Permets de compléter la clé de synchronisation déjà existante.
Propriété dépréciée
No Format
Info
NomTypeUnitéDéfautCommentaire
titlenot_stored_properties

 Le paramètre "

not_stored_properties

Texte------

Empêche la récupération de certaines propriétés des éléments récoltés.

À ne pas utiliser car :

Source de confusionun champ de la source présent dans la liste des champs collectés peut également se trouver dans cette propriété, rendant complexe l’identification de la raison pour laquelle Shinken ne le récupère pas

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