Utilisation des macros dans les commandes

Macros

Une des fonctionalités disponibles dans Nagios® est la possibilité d'utiliser des macros [NdT: macro-commandes] dans les définitions de commandes. Avant d'exécuter une commande, Nagios® remplacera toutes les macros dans celle-ci par les valeurs correspondantes. Cela vous permet de définir quelques commandes génériques que vous manipulerez à votre guise.

Substitution des macros

Avant qu'une commande (contrôles d'hôte et de service, notifications, gestionnaires d'événements, etc.) soit exécutée, Nagios® va remplacer toutes les macros qu'il trouvera dans la définition de la commande par les valeurs correspondantes.

Quand vous utilisez des macros d'hôte et de service dans les définitions de commandes, elles font référence aux valeurs de l'hôte ou du service pour lequel s'exécute la commande. Prenons un exemple. Supposons que nous ayons une définition d'hôte et une commande check_ping définies de la manière suivante :

define host{
        host_name       linuxbox
        address         192.168.1.2
        check_command   check_ping
        …
        }
        
define command{
        command_name    check_ping
        command_line    /usr/local/nagios/libexec/check_ping -H $HOSTADDRESS$ -w 100.0,90% -c 200.0,60%
        }

La ligne de commande finale, après substitution, qui sera exécutée pour le contrôle de l'hôte ressemblera à ceci :

/usr/local/nagios/libexec/check_ping -H 192.168.1.2 -w 100.0,90% -c 200.0,60%

Vous pouvez aussi passer des paramètres aux commandes, ce qui est pratique si vous voulez avoir des définitions de commandes plus génériques. Les paramètres sont spécifiés dans la définition de l'objet (c.-à-d. de l'hôte ou du service), en les séparant du nom de la commande par des points d'exclamation (!) comme ceci :

define service{
        host_name               linuxbox
        service_description     PING
        …
        check_command           check_ping!200.0,80%!400.0,40%
        …
        }

Dans l'exemple ci-dessus, la commande de contrôle du service a deux paramètres (auxquels on fait référence par les macros $ARGn$). La macro $ARG1$ vaudra "200.0,80%" et $ARG2$ vaudra "400.0,40%" (sans les guillemets). Supposons que nous utilisons la définition d'hôte ci-dessus et une commande check_ping définie comme ceci :

define command{
        command_name    check_ping
        command_line    /usr/local/nagios/libexec/check_ping -H $HOSTADDRESS$ -w $ARG1$ -c $ARG2$
        }

La ligne de commande finale à exécuter pour le contrôle du service sera :

/usr/local/nagios/libexec/check_ping -H 192.168.1.2 -w 200.0,80% -c 400.0,40%

Macros à la demande

Normalement, quand vous utilisez des macros d'hôte ou de service dans les définitions de commandes, elles font référence aux valeurs de l'hôte ou du service pour lequel s'exécute la commande. Par exemple, si la commande de contrôle d'un hôte s'exécute pour l'hôte appelé "linuxbox", toutes les macros d'hôte listées dans le tableau ci-après font référence aux valeurs de cet hôte ("linuxbox").

Si vous souhaitez faire référence aux valeurs d'un autre hôte ou service dans une commande (pour lequel ne s'exécute pas la commande), vous pouvez utiliser ce qu'on appellle des macros "à la demande". Les macros à la demande ressemblent aux macros normales, mis à part qu'elle contiennent l'identifiant de l'hôte ou du service où aller chercher leur valeur. Voici la syntaxe de base pour les macros à la demande :

• $HOSTMACRO:host_name$
• $SERVICEMACRO:host_name:service_description$

Notez que le nom de la macro est séparé de l'identifiant de l'hôte ou du service par deux points (:). Pour les macros de service à la demande, l'identifiant du service est composé d'un nom d'hôte et d'une description de service - qui sont séparés par deux point (:) également.

Voici des exemples de macros d'hôte et de service à la demande :

$HOSTDOWNTIME:myhost$
$SERVICESTATEID:novellserver:DS Database$

Nettoyage des macros

Les valeurs de certaines macros sont dépouillées des métacaractères du shell potentiellement dangereux, avant d'être remplacées dans la commande à exécuter. Les caractéres qui seront supprimés dans les macros sont définis par le paramètre illegal_macro_output_chars. Ce nettoyage s'applique aux macros suivantes :

1. $HOSTOUTPUT$
2. $HOSTPERFDATA$
3. $HOSTACKAUTHOR$
4. $HOSTACKCOMMENT$
5. $SERVICEOUTPUT$
6. $SERVICEPERFDATA$
7. $SERVICEACKAUTHOR$
8. $SERVICEACKCOMMENT$

Macros et variables d'environnement

A partir de la version 2.0 de Nagios®, la plupart des macros sont disponibles sous forme de variables d'environnement. Cela signifie que les scripts lancés par Nagios® (c.-à-d. les commandes de contrôle de service et d'hôte, les commandes de notification, etc.) peuvent faire référence à ces macros directement en tant que variables d'environnement standard. Pour des raisons de sécurité et de bon sens, $USERn$ et les macros d'hôte et de service à la demande ne sont pas disponibles comme variables d'environnement. Les variables d'environnement qui contiennent des macros sont nommées comme les macros correspondantes (listées ci-dessous), avec le préfixe "NAGIOS_". Par exemple, la macro $HOSTNAME$ est disponible à travers la variable d'environnement nommée "NAGIOS_HOSTNAME".

Validité des macros

Bien que toutes les macros puissent être utilisées dans toutes les commandes que vous définissez, elles ne sont pas toutes "valables" pour une commande en particulier. Par exemple, certaines macros ne sont valables que dans les commandes de notification de service, alors que d'autres ne sont valables que dans les commandes de contrôle d'hôte. Il y a dix types de commandes que Nagios® identifie et traite différemment. Ce sont les suivantes :

1. Les contrôles de service
2. Les notifications de service
3. Les contrôles d'hôte
4. Les notifications d'hôte
5. Les gestionnaires d'événements de service et/ou le gestionnaire global d'événements de service
6. Les gestionnaires d'événements d'hôte et/ou le gestionnaire global d'événements d'hôte
7. La commande OCSP
8. La commande OCHP
9. Les commandes de données de performance de service
10. Les commandes de données de performance d'hôte

La tableau ci-dessous liste toutes les macros actuellement disponibles dans Nagios®, accompagnées d'une brève description et des types de commandes pour lesquels elles sont valables. Si une macro est utilisée dans une commande où elle n'est pas valable, elle est remplacée par une chaîne vide. Notez que les macros sont entièrement en majuscules et sont comprises entre des caractères $.

Tableau de disponibilité des macros

Légende :

Description des macros

Notes

¹ Ces macros ne sont pas valables pour l'hôte auquel elles sont associées lorsque cet hôte est en cours de contrôle (c.-à-d. qu'elles n'ont pas de sens, car elles ne sont pas encore déterminées).

² Ces macros ne sont pas valables pour le service auquel elles sont associées lorsque ce service est en cours de contrôle (c.-à-d. qu'elles n'ont pas de sens, car elles ne sont pas encore déterminées).

³ Quand des macros d'hôte sont utilisées dans des commandes relatives à un service (c.-à-d. les notifications de service, les gestionnaires d'événements, etc.) elles font référence à l'hôte auquel est associé le service.

⁴ Quand les macros récapitulatives d'hôte et de service sont utilisées dans des commandes de notification, les totaux sont filtrés pour ne prendre en compte que les hôtes et les services autorisés à ce contact (c.-à-d. les hôtes et les services configurés pour lui envoyer des notifications).