Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Make by tools (01.00.01) - action=same_as_next_version
Scroll Ignore
scroll-viewporttrue
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltruefalse
Panel
titleSommaire

Table of Contents
stylenone

Description

Ce module permet de définir un tagger qui va en fonction de l'adresse de l'hôte, modifier une propriété choisi.

  • Typiquement, le cas d'usage classique est de rajouter/modifier des templates d'hôtes/clusters sur les éléments s'ils respectent une règle de nommage sur le nom.
  • Par exemple ajouter le template DMZ sur les hôtes avec des adresses compris dans l'espace : 172.20.0.0/30.

Voir : Tagger sur le nom de l'hôte

Activation du tagger

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

  • L'activation du tagger s'effectue en ajoutant le nom de ce tagger dans le fichier de configuration du démon Synchronizer.
  • Pour ce faire, ouvrez le fichier de configuration du Synchronizer à l'emplacement /etc/shinken/etc/shinken/synchronizers/synchronizer-master.cfg, et ajouter le nom de votre tagger "ip-tags".


Exemple: par défaut, nous livrons un tagger dont le nom est "ip-tags":

Code Block
languagebash
define synchronizer {
    [...]     
    #======== Taggers =========
    taggers	          TAGGER_01, ip-tags
    [...]
}


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

Code Block
service shinken-synchronizer restart

Définition du tagger

La configuration du module se trouve par défaut dans le fichier  /etc/shinken/modules/ip-tag-dmz.cfg

  • Vous trouverez aussi systématiquement un exemple dans /etc/shinken-user-example/configuration/daemons/synchronizers/taggers/ip-tag/ip-tags-example.cfg

Exemple de fichier de configuration

Code Block
languagejs
#===============================================================================
# ip-tags
#===============================================================================

define tagger {
    tagger_name         ip-tags
    order               1
    modules             ip-tag-dmz
    description         This tagger will tag hosts based on their ip range
}

Détails des sections composant le fichier de configuration

Il est possible de définir plusieurs instances de tagger dans votre architecture Shinken.

  • Chaque instance devra avoir un nom unique.


NomTypeUnitéDéfautCommentaire
Code Block
tagger_name



Texte---regexp-tags

Valeur obligatoire

Nous vous conseillons de choisir un nom en fonction de l'utilisation du tagger pour que votre configuration soit simple à maintenir.

Doit être unique.

Ne doit pas contenir les caractères suivants: < > " '

Code Block
order
Entier------

Valeur obligatoire

L'ordre du tagger dans l'interface de configuration ( Les taggers seront executé dans l'ordre lors de l'import ).

Code Block
modules 
Listenom de modules---

Valeur obligatoire

Liste de nom de modules utilisé par le tagger. Voir ci-dessous pour la configuration des modules.

Le séparateur est le caractère : ,

Code Block
description
Texte------Une description du tagger affiché dans l'interface de configuration

Configuration

La configuration du module se trouve par défaut dans le fichier  /etc/shinken/modules/ip-tag-dmz.cfg

  • Vous trouverez aussi systématiquement un exemple dans /etc/shinken-user-example/configuration/daemons/synchronizers/modules/ip-tag-dmz/ip-tag-dmz-exemple.cfg


Code Block
languagejs
#===============================================================================
# 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.
#===============================================================================

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

    # 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 de la source

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

  • Chaque instance devra avoir un nom unique.


NomTypeUnitéDéfautCommentaire
Code Block
module_name 
Texte---ip-tag-dmz

Nous vous conseillons de choisir un nom en fonction de l'utilisation du module pour que votre configuration soit simple à maintenir.

Doit être unique.

Code Block
module_type 
Texte---sync_ip_tagNe peut être modifié.

IP définition et édition d'objets

Ces paramètres vous permettront de définir un tagger basé sur les plages IP


Code Block
languagejs
	...
    #======== 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

    # 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
	...  
NomTypeUnitéDéfautCommentaire
Code Block
ip_range
TexteIP/MASK172.20.0.0/30Rang d'IP à détecter
Code Block
property
Texte---useQuelle propriété modifier sur l'hôte
Code Block
method 
Texte---append
  • replace : mettre la valeur si aucun autre n’est en place
  • append  : ajoute la valeur à la FIN
  • prepend : ajoute la valeur au DÉBUT
  • set : juste la valeur, effacer la valeur précédente définie par un autre tagger ou source
Code Block
value
Texte---DMZValeur à définir sur la propriété

Mise en place du tagger

Vous devez éditer la définition du tagger pour la lier au nouveau module dans le fichier /etc/shinken/taggers/ip-tags.cfg:


Code Block
define tagger {
  tagger_name    ip-tags
  order          1
  modules        ip-tag-dmz
  description    This tagger will tag hosts based on their ip range
}
Info

La propriété tagger_name ne doit pas contenir les caractères suivants:

  • <
  • >
  • "
  • '

Pour que les modifications soient prises en compte, vous devez redémarrer le Synchronizer.


Si votre configuration est correcte, vous devriez retrouver votre tagger en bas de page de l'interface de configuration :

Panel