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	truefalse

Panel

title	Sommaire

Table of Contents

style	none

Description

Les Taggers sont des outils qui lisent les hôtes détectés (automatiquement ou manuellement) et leur appliquent des règles. Si un hôte correspond à une règle, celle-ci sera appliquée et modifiera la définition de l'hôte.

Activation du module

Le module ip-tag-dmz est un module qui peut être activé seulement sur le démon Synchronizer.

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

Exemple: par défaut, nous livrons un module dont le nom est "ip-tag-dmz":

Code Block

language	bash

define synchronizer {
    [...]
    modules             Cfg_password, synchronizer-module-database-backup, ip-tag-dmz
    [...]
}

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

Code Block
service shinken-synchronizer restart

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/taggers/ip-tag-dmz.cfg

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 utilisant un module basé sur les plages IP ).

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

Définir le module de type sync_ip_tag.
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 modules taggers ).
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/sync_ip_tag/MY-MODULE-ip-tag.cfg

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

Scroll Title

title

Code Block

language	text
theme	Emacs

cp /etc/shinken-user-example/configuration/daemons/synchronizers/modules/sync_ip_tag/MY-MODULE-ip-tag.cfg /etc/shinken/modules/MY-MODULE-ip-tag.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 ).

Renommer le module ( paramètre module_name ).
Éditer les paramètres pour définir l'action du module :
- Les hôtes à impacter.
- La nature de l'action.

Exemple de fichier de configuration

Cet exemple ajoute

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

Code Block

language	js
theme	Confluence

Exemple de fichier de configuration

Code Block

language	js

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

    #======== Module identity =========
    # Module name. Must be unique
    module_name            MY-MODULE-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

Code Block

language	js
theme	Confluence

#======== 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 votre l'architecture Shinken .

Chaque instance devra avoir un nom unique.

Scroll Title

anchor	parameter_cfg
title

Nom	Type	Unité	Défaut

Commentaire

Description

code

No Format
module_name

Texte

---

ip

--

tag

-

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

Valeur obligatoire

Nom du module.

Doit être unique parmi tous les modules.

code

No Format
module_type

Texte

---

sync_ip_tag

Ne

peut être modifié.

Configuration du tagger

pas modifier.

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

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

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

Scroll Title

anchor	parameter_cfg
title

Nom

Type

Unité

Défaut

Description

No Format
ip_range

Texte

IP/masque

---

Valeur obligatoire

Plage d'IP à détecter.

No Format
ignore_hosts

Liste

---

---

Liste de nom d'hôtes ( et pas de leurs adresses ) qui seront ignorés par ce module de Tagger.

Édition des hôtes

Code Block

language	js
theme	Confluence

    # 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

Scroll Title

anchor	parameter_cfg
title

Nom

Type

Unité

Défaut

Description

No Format

property

Texte

---

useQuelle propriété modifier sur

---

Valeur obligatoire

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

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

code

No Format
method

Texte

---

append

Valeur obligatoire

Méthode d'édition :

replace :

mettre

ajoute la valeur si

aucun autre n’est en place

elle est absente.
append : ajoute la valeur à la

FIN

fin.
prepend : ajoute la valeur au

DÉBUT

début.
set :

juste

remplace la valeur

, effacer la valeur précédente définie par un autre tagger ou source

actuelle ou l'ajoute si absente.

No Format

code


value

Texte

---

DMZValeur à définir sur la propriété

Mise en place du tagger

---

Valeur obligatoire

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

Déclarer le Module dans le Tagger

Pour qu'un Tagger utilise les règles définies dans un module, il faut ajouter le nom du module au paramètre modules dans le fichier de configuration du Tagger (ex : Vous devez éditer la définition du tagger pour la lier au nouveau module dans le fichier /etc/shinken/taggers/ipMY-tagsTAGGER.cfg )

Exemple avec un Tagger appelé MY-TAGGER :

info

Code Block

language	js
theme	Confluence

define tagger {
    tagger_name       ip  MY-tagsTAGGER
    order               1

    modules              ip-tag-dmz,TAGGER-MODULE-01, TAGGER-MODULE-02, MY-MODULE-ip-tag-dc1
 
 description   description  This tagger will tag hosts based on their ip range
}

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

<
>
"
'

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 règles apportées par chaque module apparaissent à l'intérieur du Tagger, dans l'onglet Règles :

Panel
Image Added

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
Image Removed

Page tree

Versions Compared

Old Version 5

New Version Current

Key

Description

Activation du module

Configuration

Concept

Définition du module

Exemple de fichier de configuration

Exemple de fichier de configuration

Détails des sections composant le fichier de configuration

Identification du module

Configuration du tagger

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

Édition des hôtes

Mise en place du tagger

Déclarer le Module dans le Tagger

Affichage des Taggers sur l'interface de Configuration