Fichier de configuration Client

Le fichier de configuration Client est lu par l'indicateur pour déterminer quand et comment il doit se comporter lui-même ainsi que ses modules. Lorsque la fonctionnalité de mise à jour automatique est désactivée (option -m au lancement), l'administrateur peut définir le comportement de l'indicateur en modifiant directement ce fichier de configuration. Lorsque la fonctionnalité de mise à jour automatique est activée (par défaut), l'administrateur doit utiliser l'interface du serveur pour paramétrer l'indicateur. L'indicateur modifiera lui-même le fichier de configuration (avec un léger délai), afin d'être en phase avec le paramétrage du gabarit.

Le fichier de configuration se présente sous forme suivante :

• des sections, définies par la syntaxe suivante :

  [exemple_de_section]

• des paramètres, définis par la syntaxe suivante :

  clé=valeur

Un seul paramètre est autorisé dans cette section :

• server0=<server hostname>, où <server hostname> est le nom d'hôte du serveur de supervision vers lequel l'indicateur va remonter les informations.

<note warning>Il est important que ce nom d'hôte concorde précisément avec celui indiqué dans le fichier de configuration du serveur (risque de perte de synchro)</note> <note>Il est possible d'indiquer plusieurs serveurs en indentant la clé.</note>

• idcard=<chaine de 30 chiffres> : il s'agit d'un identifiant unique permettant au serveur d'identifier de manière unique l'indicateur. Ce paramètre est systématiquement remonté par l'indicateur lorsqu'il communique une information au serveur.
• idcode=<XXXX> : Il s'agit d'un paramètre de contrôle.
• pluginExtension=so : Ce paramètre n'est pas utilisé actuellement.
• replication=<0|1> : détermine le comportement de l'indicateur dans le cas où plusieurs serveurs sont paramétrés :
  • 1 : L'information est envoyé à tous les serveurs
  • 0 : L'information n'est remontée qu'au premier serveur accessible
• serial=<timestamp> : Définit la version du fichier (cette valeur est définie au temps actuel à chaque modification). Ce paramètre est nécessaire pour l'utilisation de la fonctionnalité de mise à jour automatique.
• serverWebPage=reportStatus.php : Ce paramètre n'est pas utilisé actuellement.

Cette section n'est pas utilisée actuellement.

Cette section est définie par l'indicateur lors de son initialisation. <note>Les paramètres de proxy sont définis au lancement de l'indicateur par les options -p et -u. Se reporter à la page “options de démarrage” pour plus d'explications</note> <note warning>Modifier ces paramètres directement dans le fichier peut avoir des effets inattendus</note>

Cette section est définie par l'indicateur lors de son initialisation. <note>Les paramètres SSL sont définis au lancement de l'indicateur par les options -k, -K, -r, -R, -v et -w. Se reporter à la page “options de démarrage” pour plus d'explications</note> <note warning>Il est impératif d'utiliser les options de démarrage pour que ces paramètres soient persistants.</note>

Ces sections sont identifiées par la syntaxe suivante :

[plugin:<nom_du_module>]

• @interval=<temps_en_secondes> : il s'agit de l'intervalle de temps entre chaque exécution du module.

<note>Cela ne signifie pas qu'il y aura une remontée d'information vers le serveur. Certains modules ne remontent de l'information que lors d'un changement d'état.</note>

• @plugin=<nom_du_module>
• @service=<nom_du_module> : Utilisé pour l'historisation

• device=<nom_de_l_interface_réseau> : Définit sur quelle interface réseau écouter. Exemple : eth0
• filterIncoming=<filtre> : Filtre à appliquer aux flux entrants (syntaxe pcap). Exemple : ether dst 00:0d:b9:19:ef:a8
• filterOutgoing=<filtre> : Filtre à appliquer aux flux sortants (syntaxe pcap). Exemple : ether src 00:0d:b9:19:ef:a8
• forgetOtherPackets=<0|1> :
  • 0 : Tous les paquets qui ne transitent pas sur un port identifié par la directive port_n= sont remontés en tant que “Autres” ou “Others”.
  • 1 : Les paquets “Autres” ne sont pas remontés.
• incoming=<0|1> : Remonter ou non les flux entrants
• outgoing=<0|1> : Remonter ou non les flux sortants
• port_<n>=<numero_de_port> où n est indenté de 1 pour chaque nouveau port : permet de définir les ports qui doivent être distingués des autres pour le tracé de graphes.
• stats=<0|n> :
  • 0 : Désactive la remontée des flux détaillés
  • n : Indique la périodicité des remontées d'information pour les détails de flux. Par défaut, vaut 30 fois l'intervalle de temps défini par @interval.