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

Description

Concept

Il est possible Ce module permet de définir un tagger qui va Tagger qui utilise une plage d’adresses IP afin d'éditer automatiquement une propriété des hôtes issus de l'import des sources 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.

la valeur de leur IP ou nom DNS ( propriété "address" ).

Par exemple ajouter le template

L'intêret est d'ajouter le modèle d'hôte

DMZ sur les hôtes avec des adresses

compris dans l'espace :

comprises dans la plage IP 172.20.0.0/

30.

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

Activation du tagger

26 ( voir la page Tagger basé sur les plages IP ).

L'activation d'un Tagger se fait en trois étapes : :

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

Définir un Tagger qui utilise un module de type sync_ip_tag ( ex :

/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

language	bash

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

taggers/ip-tags.cfg ).
Configurer les règles du module ( ex : /etc/shinken/modules/ip-tag-dmz.cfg ).
Déclarer le Tagger dans le Synchronizer ( /etc/shinken/synchronizers/synchronizer-master.cfg ).

Pour prendre en compte le changement de configuration, redémarrer le Synchronizer:
Code Blockservice shinken-synchronizer restart

Définition du tagger

La configuration du module se trouve par défaut dans le fichier des Taggers doit être placée dans le dossier /etc/shinken/taggers/.

Le Tagger basé sur les plages IP livré par Shinken : /etc/shinken/modulestaggers/ip-tag-dmztags.cfg.

Vous trouverez aussi systématiquement un exemple dans

Un exemple de fichier de configuration est disponible : /etc/shinken-user-example/configuration/daemons/synchronizers/taggers/ip-tag/ip-tags-example.cfg

Exemple de fichier de configuration

Code Block

language	js
theme	Confluence

#===============================================================================
# ip-tags
#===============================================================================

define tagger {
# Shinken Enterprise. Lines added by import core. Do not remove it, it's used tagger_nameby Shinken Enterprise to update your objects if you ip-tagsre-import them.
    order_SE_UUID             core-tagger-ed4200e85adc11e58e4d080027f08538
  1
  _SE_UUID_HASH  modules      0d3fd680dc3d526ffc3750cfa7ef49d1
# End of Shinken Enterprise part


    tagger_name		ip-tag-dmz
 tags
    order		    1

   description modules    		ip-tag-dmz

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

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

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

Chaque instance devra avoir un nom unique.

Scroll Title

anchor	parameter_cfg
title

Nom	Type	Unité	Défaut	Commentaire

code

No Format
tagger_name

Texte

---

regexp

---

Configuration du module

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

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

Vous trouverez aussi systématiquement un exemple dans

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

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

de la source

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

Chaque instance devra avoir un nom unique.

Scroll Title

anchor	parameter_cfg
title

Nom	Type	Unité	Défaut	Commentaire

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é

pas modifier.

Définition de la plage d'adresses IP

définition

et de l'édition

d'

des objets

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

# 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

code

No Format
ip_range

Texte

IP/

MASK172.20.0.0/30

masque

---

Valeur obligatoire

Plage

Rang

d'IP à détecter.

code

No Format
property

Texte

---

---

useQuelle propriété

Valeur obligatoire

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

code

No Format
method

Texte

---

append

replace

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

---

---

DMZ

Valeur obligatoire

Valeur

à définir sur la propriété

Mise en place du tagger

utilisée par la méthode.

Déclarer le Tagger dans le Synchronizer

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

Vous devez éditer la définition du tagger pour la lier au nouveau module dans le fichier

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 "taggers/ip-tags.cfg":

Code Block

language	js
theme	Confluence

define taggersynchronizer {
    tagger_name[...]     ip-tags
  order  #======== Taggers =========
    taggers	  1
  modules      TAGGER_01,  ip-tag-dmztags
  description    This tagger will tag hosts based on their ip range
}
  [...]
}

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

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

Image Removed

Page tree

Versions Compared

Old Version 13

New Version 14

Key

Description

Concept

Activation du tagger

Définition du tagger

Exemple de fichier de configuration

Détails des sections composant le fichier de configuration

Configuration du module

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

Mise en place du tagger

Déclarer le Tagger dans le Synchronizer

Affichage des Taggers sur l'interface de Configuration