Page History

Scroll Ignore

scroll-viewport	true
scroll-pdf	true
scroll-office	true
scroll-chm	true
scroll-docbook	true
scroll-eclipsehelp	true
scroll-epub	true
scroll-html	false

Panel

title	Sommaire

Table of Contents

style	none

Concept

Il est possible de définir sur un Tagger une action qui utilise 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 d'un Tagger de ce module se fait en trois 3 étapes :

Définir un Tagger qui utilise un le module de type sync_ip_tag ( ex : /etc/shinken/taggers/ip-tags.cfg ).
Définir les règles que vous avez besoin
- Pour chadu module ( ex : /etc/shinken/modules/ip-tag-dmz.cfg ).

Déclarer le Tagger dans le Synchronizer (

/etc/shinken/synchronizers/synchronizer-master.cfg

).

Définition du tagger

.
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 Les taggers ).
Redémarrer le Synchroniser pour que cette modification soit prise en compte.

Définition du module

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

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

Le Tagger basé sur les plages IP livré par Shinken : /etc/shinken/taggers/ip-tags.cfg.
Un exemple de fichier de configuration est disponible ici : /etc/shinken-user-example/configuration/daemons/synchronizers/taggersmodules/ip-tag-dmz/ip-tag-tagsdmz-example.cfg

Exemple de fichier de configuration

Code Block

language	js
theme	Confluence

define tagger {
# 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-tagger-ed4200e85adc11e58e4d080027f08538
    _SE_UUID_HASH        0d3fd680dc3d526ffc3750cfa7ef49d1
# End of Shinken Enterprise part


    tagger_name		ip-tags
    order		    1

    modules    		ip-tag-dmz

    description		This tagger will tag hosts based on their ip range
}

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

No Format
modules

Texte--- ---

Valeur obligatoire

Nom du module utilisé par le Tagger.

No Format
description

Texte--- --- Une description du Tagger affichée dans l'Interface de Configuration

Configuration du module ou des modules

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

La configuration du module livré par Shinken se trouve dans le fichier /etc/shinken/modules/ip-tag-dmz.cfgUn exemple de fichier de configuration est disponible ici : /etc/shinken

Code Block
language text
theme Emacs

service shinken-synchronizer restart

Détails des sections composant le fichier de configuration

Il est possible de définir plusieurs instances de Tagger s dans l'architecture Shinken .

Chaque instance devra avoir un nom unique.

Scroll Title

anchor	parameter_cfg
title

NomTypeUnitéDéfautCommentaire

No Format
tagger_name

Texte--- ---

Valeur obligatoire

Nom du Tagger.

Le nom doit être unique parmi tous les taggers existants.

Caractères interdits :
les signes inférieur ou supérieur ( < ou > ), les guillemets ( ' ou " ).

No Format
order

Entier--- ---

Valeur obligatoire

L'ordre d'application des Taggers. Les Taggers sont exécutés les uns à la suite des autres dans l'ordre croissant de la propriété.

Warning

Si plusieurs Taggers qui s'enchaînent modifient la même propriété, il est possible qu'un Tagger annule les modifications de précédents Taggers.

Attention donc à l'ordre d'exécution des Taggers

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

Code Block

language	js
theme	Confluence

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

}

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

Code Block

language	text
theme	Emacs

service shinken-synchronizer restart

Détails des sections composant le fichier de configuration

Identification du module

Code Block

language	js
theme	Confluence

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

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.

Scroll Title

anchor	parameter_cfg
title

Nom

Type

Unité

Défaut

Commentaire

No Format
module_name

Texte

---

---

Valeur obligatoire

Nom du module.

Doit être unique parmi tous les modules.

No Format
module_type

Texte

---

sync_ip_tag

Ne pas modifier.

Définition de la plage d'adresses IP et de l'édition des objets

Code Block

language	js
theme	Confluence

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

Scroll Title

anchor	parameter_cfg
title

Nom

Type

Unité

Défaut

Commentaire

No Format
ip_range

Texte

IP/masque

---

Valeur obligatoire

Plage d'IP à détecter.

No Format
property

Texte

---

---

Valeur obligatoire

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

No Format
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.

No Format
value

Texte

---

---

Valeur obligatoire

Valeur utilisée par la méthode.

Déclarer le Tagger dans le Synchronizer

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

Code Block

language	text
theme	Emacs

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

Code Block

language	js
theme	Confluence

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

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

Code Block

language	text
theme	Emacs

service shinken-synchronizer restart

Affichage des Taggers sur l'interface de Configuration

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

Excerpt Include

	Page Principale
	Page Principale
nopanel	true

Page tree

Versions Compared

Old Version 9

New Version 10

Key

Concept

Définition du tagger

Définition du module

Exemple de fichier de configuration

Configuration du module ou des modules

Détails des sections composant le fichier de configuration

Exemple de fichier de configuration

Détails des sections composant le fichier de configuration

Identification du module

Définition de la plage d'adresses IP et de l'édition des objets

Déclarer le Tagger dans le Synchronizer

Affichage des Taggers sur l'interface de Configuration