Concept

Il est possible de définir sur un Tagger une action qui va utiliser une plage d’adresses IP afin d'éditer automatiquement une propriété des hôtes issus de l'import des sources en fonction de la valeur de leur IP ou nom DNS ( propriété "address" ).

  • Cette action est portée par un module de type sync_ip_tag, que vous aurez besoin d'ajouter sur votre Tagger.
  • L'intérêt est, par exemple, d'ajouter le modèle d'hôte DMZ sur les hôtes avec des adresses comprises dans la plage IP 172.20.0.0/26 ( voir la page Tagger basé sur les plages IP ).


L'activation de ce module se fait en 3 étapes :

  1. Définir le module de type sync_ip_tag.
  2. L'ajouter au Tagger qui exécutera cette règle.
    1. Si vous n'avez pas déjà de tagger défini, il faut le mettre en place ( voir la page Definition des taggers ).
  3. Redémarrer le Synchroniser pour que cette modification soit prise en compte.

Définition du module

La configuration des modules doit être placée dans le dossier /etc/shinken/modules/

  • Un exemple de fichier de configuration est disponible ici :  /etc/shinken-user-example/configuration/daemons/synchronizers/modules/ip-tag-dmz/ip-tag-dmz-exemple.cfg.

  • Copier cet exemple et adapter le à votre besoin ( voir plus bas, la description des différents paramètres ).

    cp /etc/shinken-user-example/configuration/daemons/synchronizers/modules/ip-tag-dmz/ip-tag-dmz-exemple.cfg /etc/shinken/taggers/MY_MODULE.cfg

    Nous vous recommandons d'intégrer, dans le nom du module, un rappel du type du module. C'est plus simple en gestion ( ex :  MY_MODULE_ip_tag.cfg ).

Exemple de fichier de configuration

Cette exemple ajoute 

  • le modèle d'hôte DMZ sur les hôtes à la fin des modèles d'hôtes utilisé par chaque hôte,
  • avec des adresses comprises dans la plage IP 172.20.0.0/30.


#===============================================================================
# ip-tag-*
#===============================================================================
# Daemons that can load this module:
# - synchronizer (into a tagger object)
# This module add new templates into hosts objects based on their IP range. For example to set a DMZ template is an host is in a DMZ ip range.
#===============================================================================


define module{
# Shinken Enterprise. Lines added by import core. Do not remove it, it's used by Shinken Enterprise to update your objects if you re-import them.
    _SE_UUID             core-module-07a50e365adc11e5a550080027f08538
    _SE_UUID_HASH        5d15556b0225fcc39cecf7d86d636120
# End of Shinken Enterprise part

    #======== Module identity =========
    # Module name. Must be unique
    module_name            ip-tag-dmz

    # Module type (to load module code). Do not edit.
    module_type            sync_ip_tag




    #======== Ip range definiton, and objects edition =========
    # IP range to detect. Should looks like:   XXX.XXX.XXX.XXX/YY
    ip_range               172.20.0.0/30

    # host_name listed will be skipped by tagger
    # ignore_hosts

    # property: which property to edit on the hosts. Default: use   (templates definitions)
    property               use

    # method: how to edit the host "property". Several methods are available:
    # - replace = put the value if not another one is in place
    # - append  = add the value at the END
    # - prepend = add the value at the BEGINING
    # - set     = just the value, erase the previous value set by other tagger or source.
    method                 append

    # value:  which value to set on the property
    value                  DMZ

}

Détails des sections composant le fichier de configuration

Identification du module

#======== Module identity =========
# Module name. Must be unique
module_name            MY_MODULE_ip_tag

  # Module type (to load module code). Do not edit.
module_type            sync_ip_tag

Il est possible de définir plusieurs instances de module de type sync_ip_tag dans l'architecture Shinken .

  • Chaque instance devra avoir un nom unique.


NomTypeUnitéDéfautCommentaire
module_name
Texte--- ---

Valeur obligatoire

Nom du module.

Doit être unique parmi tous les modules.

module_type 
Texte--- sync_ip_tag Ne pas modifier.

Définition des hôtes ou l'action de modification sera appliqué ( plage d'adresses IP et exclusion )

NomTypeUnitéDéfautCommentaire
ip_range
TexteIP/masque ---

Valeur obligatoire

Plage d'IP à détecter.

ignore_hosts





Édition des hôtes

NomTypeUnitéDéfautCommentaire
property
Texte--- ---

Valeur obligatoire

Nom de la propriété à modifier sur l'hôte.

Ex : use pour les modèles de l'hôte.

method
Texte---replace

Valeur obligatoire

Méthode d'édition : 

  • replace : ajoute la valeur si elle est absente.
  • append  : ajoute la valeur à la fin.
  • prepend : ajoute la valeur au début.
  • set : remplace la valeur actuelle ou l'ajoute si absente.
value
Texte--- ---

Valeur obligatoire

Valeur utilisée lors de l'application de la règle.

Déclarer le Tagger dans le Synchronizer

Pour prendre en compte le changement de configuration, il faut redémarrer le Synchronizer :

service shinken-synchronizer restart

L'activation des taggers se fait dans le fichier de configuration du Synchronizer :

  • Il faut ajouter le nom du Tagger au paramètre taggers dans le fichier de configuration du démon Synchronizer ( /etc/shinken/synchronizers/synchronizer-master.cfg ) .


Exemple : Le Tagger livré par défaut dont le nom est "ip-tags":

define synchronizer {
    [...]     
    #======== Taggers =========
    taggers	          TAGGER_MODULE_01, TAGGER_MODULE_02, MY_MODULE_ip_tag
    [...]
}


Pour prendre en compte le changement de configuration, il faut redémarrer le Synchronizer :

service shinken-synchronizer restart

Affichage des Taggers sur l'interface de Configuration

Changer le screen pour montrer à l'intérieur du tagger


Les Taggers apparaissent sur la page Principale de l'Interface de Configuration ( voir la page Page Principale ).