Page History

Les versions supportées par la source sont : 7.0, 7.0U1, 7.0U2, 7.0U3 , 8.0, 8.0U1, 8.0U2, 8.0U3

# 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

}

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ──────────────────────────────────────    SOURCE IDENTITY    ────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── Source name [ Must be unique ]                                                      [ MANDATORY ] ───
    # ───       ⚠ Must be unique                                                                            ───
    # ───       ⚠ Forbidden characters ?&"'$/#\\;                                                           ───
    # ───       ⚠ Length of the name must not exceed 40 characters                                          ───
    #                                                                                                       ───
    source_name                                         synchronizer-collector-vmware

    # ─── Module type [ Do not edit ]                                                         [ MANDATORY ] ───
    # ───                                                                                                   ───
    module_type                                         synchronizer_collector_vmware

    # ─── Display a description on the interface for this source                                            ───
    # ───                                                                                                   ───
    description                                         This source is about loading hosts from a VMWare Server     

    # ─── Interval between each automatic import                                                            ───
    # ─── Interval in minutes between each automatic import of the source                                   ───
    # ───       -> Setting it to 0 will deactivate the automatic import and can only be done manually       ───
    #           Default : 0                                                                                 ───
    #                                                                                                       ───
    # import_interval                                     0

    # ─── Order of priority when merging data                                                               ───
    # ─── The final element will take the value of the element from the source with the highest priority    ───
    # ───       -> Priority at source with the order closest to 1                                           ───
    #           Default : 99                                                                                ───
    #                                                                                                       ───
    # order                                               99

    # ─── Make the source active                                                                            ───
    #                                                                                                       ───
    #           ...     : 0 => disabled                                                                     ───
    #           Default : 1 => enabled                                                                      ───
    #                                                                                                       ───
    # enabled                                             1

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ───────────────────────────────────────    MERGE OPTIONS    ─────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

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

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

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

    # ─── Specific treatment with elements that are no longer present in the source                         ───
    #                                                                                                       ───
    #           Default : disabled                                                                          ───
    #           ...     : delete_if_missing_in_all_sources                                                  ───
    #           ...     : delete_if_missing_in_this_source                                                  ───
    #                                                                                                       ───
    # compute_deleted_element_not_in_source               disabled     

    # ─── 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
    

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

    # ─── Detecting new elements                                                                            ───
    #   - authorized ( Default )                                                                            ───
    #   - never_new                                                                                         ───
    # compute_new_element                               authorized

    # ─── Calculate the differences                                                                         ───
    #   - authorized ( Default )                                                                            ───
    #   - never_difference                                                                                  ───
    # compute_element_difference                        authorized   

Cette option peut être activée que si cette source met directement dans l'espace "Staging" ou "Production" ses éléments importés.

    # ─── Detect elements that are no longer present in the source                                          ───
    #   - disabled ( Default )                                                                              ───
    #   - delete_if_missing_in_all_sources                                                                  ───
    #   - delete_if_missing_in_this_source                                                                  ───
    # compute_deleted_element_not_in_source             disabled   

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

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

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

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

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

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

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ─────────────────────────────    SYNCHRONIZATION KEYS ( SYNC_KEY )    ───────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── List of parameters whose values will be used as sync keys for hosts elements                      ───
    #                                                                                                       ───
    #           Default : _SE_UUID                                                                          ───
    #           ...     : host_name                                                                         ───
    # ───                                                                                                   ───
    # properties_used_as_synckey_for_hosts                _SE_UUID, host_name