Composants de l'assistant

Dans le cadre des capacités de wizard SNMP et wizard WMI, il existe des types de composants distants appelés Wizard components.

Ces composants permettent d'établir une configuration de base pour les modules qui seront générés dans les agents lors de l'exécution de l'un des wizard (SNMP ou WMI). Ils offrent également la possibilité de générer dynamiquement plusieurs modules à l'aide d'un seul composant.

Pour créer ces composants, utilisez le menu Management → Configuration → Templates → Remote components. Sélectionnez l'option Create a new wizard component et cliquez sur le bouton Create.

La boîte de dialogue de création contient une option importante : le protocole de module (Module protocol) à utiliser. Deux protocoles sont disponibles, SNMP (par défaut) et WMI, et bien qu'ils partagent des champs communs, ils diffèrent également dans d'autres champs.

• Enabled: L'activation de ce token indique que le composant tentera d'effectuer un balayage lors du lancement de l'assistant.
• Add by default: Il permet de choisir si les modules générés par le composant seront marqués pour être ajoutés par défaut lors du lancement de l'assistant.
• Module name: Le nom que le composant aura, et nom par défaut pour les modules générés par lui. Certaines macros peuvent être utilisées.
• Module type: Le type de données à obtenir par les modules générés par le composant.
• Component group: Le groupe auquel appartiendra le composant. Il permet d'organiser la présentation des modules.
• Module unit: Unité des données obtenues par les modules générés par le composant.
• Warning: Dans cette section, vous pouvez définir un seuil par défaut pour l'état d'alerte des modules générés par le wizard.
• Critical status: Dans cette section, vous pouvez définir un seuil par défaut pour l'état critique des modules générés par l'assistant.
• Description : La description du composant et des modules qu'il génère. Certaines macros peuvent être utilisées.

Scan type: Il permet de choisir entre deux modes d'exploration que les assistants pourront effectuer avec ce composant:

• Fixed: Le composant ne doit générer qu'un seul module.
• Dynamic: Le composant peut générer un ou plusieurs modules.

Execution type: Ce champ indique le type d'exécution des modules générés par le composant. Il est utilisé pour déterminer le serveur Pandora FMS auquel les modules appartiendront au moment de leur création, en fonction de l'endroit à partir duquel le wizard est exécuté:

• Network: Les modules générés par le composant obtiendront leurs données grâce aux mécanismes propres au Pandora FMS pour les modules SNMP et WMI. Il s'agit des éléments suivants: le serveurs de réseau, serveur WMI et serveur satellite.
• Plugin : Les modules générés par le composant obtiendront leurs données à partir de l'exécution de commandes personnalisées, plugins ou scripts. De cette manière, ils seront exécutés par le composant serveur de plugins soit par le serveur Satellite via des modules de type exec.

Management → Configuration → Templates → Remote components → Create a new wizard component → Create → Module protocol → SNMP menu.

Champs spécifiques:

• Name OID: Il permet d'indiquer un OID à partir duquel on obtiendra une valeur qui pourra être ajoutée au nom du module au moyen d'une macro. La valeur de cet OID est stockée dans la macro _nameOID_, qui peut être utilisée dans le champ Module name. Si All est indiqué comme fabricant, le composant sera analysé à la recherche de tout PEN enregistré dans Pandora FMS.
• Manufacturer ID: Il permet d'indiquer l'ID d'un fabricant spécifique pour lequel le composant SNMP wizard prendra effet.
• Lorsque Execution type est énoncé dans Network : Value OID.
• ​​​Lorsque Execution type est énoncé dans Plugin : Macros OID, Value operation, Satellite execution, Server plugin.

Management → Configuration → Templates → Remote components → Create a new wizard component → Create → Module protocol → SNMP menu (Execution type → Network).

Lorsque le type d'exécution est Network, la Value OID permet d'indiquer l'OID à partir duquel les données des modules générés par le composant doivent être obtenues.

• S'il est utilisé dans des composants dynamiques, l'OID indiqué dans ce champ doit être une branche SNMP et non un OID final.
• S'il est utilisé dans des composants fixes, l'OID indiqué dans ce champ doit être un OID final.

Management → Configuration → Templates → Remote components → Create a new wizard component → Create → Module protocol → SNMP menu (Execution type → Plugin).

L'objectif principal de l'utilisation de composants de type plugin est de pouvoir effectuer des opérations avec les valeurs d'un ou de plusieurs OID dans le même dispositif. C'est pourquoi, dans ces composants, vous pouvez indiquer autant d'OID que nécessaire pour les utiliser dans d'autres champs.

Macros OID → _oid_N_

En outre, ces OID, ou leurs valeurs, peuvent être utilisés à partir des macros _oid_N_. Selon le champ dans lequel la macro est utilisée, c'est la valeur de l'OID ou l'OID lui-même qui sera utilisé.

En cas d'utilisation sur des composants dynamiques, les OID indiqués dans ces champs doivent être une branche SNMP et non un OID de fin. En cas d'utilisation sur des composants fixes, les OID indiqués dans ces champs doivent être des OID de fin.

Value operation

Il permet d'indiquer une opération arithmétique avec laquelle la valeur courante de chaque module généré par le composant sera obtenue dans l'aperçu du module wizard. Cette opération n'affecte en aucun cas l'exécution finale des modules générés.

Il accepte les caractères + - * / ( ) ., les nombres et les macros _oid_N_ à partir desquels les valeurs de l'opération seront obtenues.

Satellite execution

Il permet d'indiquer l'exécution à effectuer par un serveur Satellite pour les modules générés lorsque le wizard est exécuté à partir d'un serveur Satellite en utilisant l'option Exec server. Il s'agit de la commande, plugin ou script à utiliser dans un serveur Satellite module_exec. Il accepte l'utilisation de macros pour l'assistant SNMP et de macros _oid_N_ pour obtenir les OID utilisés dans chaque module.

Le serveur Satellite distribue un certain nombre de plugins recommandés pour ces composants:

/etc/pandora/satellite_plugins/wizard_snmp_module
/etc/pandora/satellite_plugins/wizard_snmp_process

Server plugin

Cette liste permet d'indiquer un plugin préalablement enregistré dans la Console Pandora FMS, qui sera utilisé par le serveur de plugins avec chaque module généré par le composant. Le choix d'un plugin montre à son tour dans le formulaire les champs spécifiques pour l'utiliser.

Les champs propres au plugin acceptent l'utilisation de macros pour l'assistant SNMP et de macros _oid_N_ pour obtenir les OID utilisés dans chaque module.

La Console Pandora FMS a déjà enregistré les plugins recommandés pour ces composants : Wizard SNMP module et Wizard SNMP process. Selon que l'un ou l'autre est utilisé, le reste des champs respectifs doit être complété afin d'effectuer la supervision SNMP.

Management → Configuration → Templates → Remote components → Create a new wizard component → Create → Module protocol → WMI menu.

Management → Configuration → Templates → Remote components → Create a new wizard component → Create → Module protocol → WMI menu (Execution type → Network).

Lorsque le type d'exécution est Network:

• WMI class: Il permet de spécifier la classe WMI à interroger. Les classes WMI sont des classes prédéfinies incluses dans chaque espace de noms du noyau Windows Management Instrumentation® (WMI).
• Query filters → Execution: Cet espace permet d'indiquer les conditions de la requête WMI lancée par chaque module généré par le composant. Il accepte l'utilisation de macros avec les noms des champs de la requête (_FIELDNAME_) pour obtenir la valeur de chaque enregistrement dans ce champ.
• Field value: Il indique le numéro du champ de requête WMI à partir duquel la valeur du module doit être obtenue, le champ 0 étant le champ clé de la classe et les champs 1 et suivants étant des champs supplémentaires de la classe.
• Key string: Il permet de convertir la valeur du module en booléen (1 ou 0) selon que la valeur du champ indiquée dans Field value correspond à la chaîne indiquée dans ce champ.

Management → Configuration → Templates → Remote components → Create a new wizard component → Create → Module protocol → WMI menu (Execution type → Plugin).

Lorsque le type d'exécution est Plugin:

• Il partage des champs communs avec le Network jusqu'au champ Query filters (Scan).
• Value operation : Ce champ permet d'indiquer une opération arithmétique pour obtenir la valeur courante de chaque module généré par le composant dans l'aperçu du module wizard. Il n'affecte en aucun cas l'exécution finale des modules générés. Accepte les caractères +, -, *, /, (, ), ., et les macros avec les noms des champs de la classe _FIELDNAME_, à partir desquels les valeurs de l'opération seront obtenues.
• Satellite execution : Il permet d'indiquer l'exécution à effectuer par un serveur Satellite pour les modules générés lorsque le wizard est lancé à partir d'un Satellite server à l'aide de l'option Exec server. Il s'agit de la commande, plugin ou script à utiliser dans un module_exec du Satellite server. Il accepte l'utilisation des macros pour l'assistant WMI et les macros _class_wmi_ pour obtenir le nom de la classe WMI et _field_wmi_N_ pour obtenir les noms des champs de la classe utilisés dans chaque module. Le Satellite server distribue un plugin recommandé pour ces composants : /etc/pandora/satellite_plugins/wizard_wmi_module.
• Server plugin : Il permet d'indiquer un plugin enregistré dans la console Pandora FMS qui sera utilisé par le serveur plugins à chaque module généré par le composant. Le choix d'un plugin fait apparaître en même temps dans le formulaire les champs spécifiques pour l'utiliser.

La console Pandora FMS dispose d'un plugin déjà enregistré recommended pour ces composants: Wizard WMI module.

Les champs propres au plugin acceptent l'utilisation des macros pour l'assistant WMI et les macros _class_wmi_ pour obtenir le nom de la classe WMI et _field_wmi_N_ pour obtenir les noms des champs de la classe utilisés dans chaque module.

Les macros spécifiques pour les composants de l'assistant WMI qui peuvent être utilisées dans les champs des exécutions de type plugin sont les suivantes:

• _address_ : L'adresse IP utilisée dans le WMI wizard. Cette macro ne sera pas remplacée lorsque wizard sera lancé dans une stratégie.
• _namespace_wmi_ : Le namespace utilisé dans l'assistant WMI.
• _user_wmi_ : L'utilisateur utilisé dans l'assistant WMI.
• _pass_wmi_ : Le mot de passe utilisé dans l'assistant WMI.

Les champs spécifiques aux composants de l'assistant WMI sont les suivants:

• WMI class: Il fait référence à la classe WMI à utiliser dans les requêtes des modules générés par le composant. Par exemple, Win32_LogicalDisk.
• Ils peuvent être utilisés dans d'autres champs du même formulaire en utilisant la macro _class_wmi_.

Query key field ( _field_wmi_0_ )

Il s'agit du nom du champ clé qui sera renvoyé dans la requête WMI utilisée dans les modules générés. En général, les classes WMI ont un champ clé qu'elles renvoient toujours dans toute requête, qu'il soit spécifié ou non. C'est ce champ qui doit être spécifié ici. Par exemple, le champ clé de la classe Win32_Processor serait DeviceID.

Le nom de ce champ peut être obtenu dans d'autres champs du formulaire en utilisant la macro _field_wmi_0_, et la valeur de ce champ pour chaque enregistrement de la requête WMI peut être obtenue au moyen d'une macro portant le même nom que le champ _FIELDNAME_. Ces macros _FIELDNAME_ peuvent être utilisées, entre autres, dans les champs Module name et Description du composant, afin de générer des noms et des descriptions de manière dynamique. Par exemple, pour le composant DeviceID la macro avec la valeur serait _DeviceID_.

Query extra fields → _field_wmi_N_ :

Ces champs contiennent les noms des champs supplémentaires à utiliser dans la requête WMI utilisée dans les modules générés.

Les noms de ces champs peuvent être obtenus dans d'autres champs du formulaire grâce aux macros _field_wmi_N_, et les valeurs que les champs ont pour chaque enregistrement dans la requête WMI peuvent être obtenues grâce à des macros portant les mêmes noms que les champs _FIELDNAME_. Ces macros _FIELDNAME_ peuvent être utilisées, entre autres, dans les champs Module name et Description du composant, pour générer des noms et des descriptions de manière dynamique. Par exemple, pour le champ FreeSpace, la macro avec la valeur serait _FreeSpace_.

Query filters → Scan

Cet espace indique les conditions de la requête WMI lancée dans l'analyse, qui récupérera un ou plusieurs enregistrements. Par exemple : DriveType = 3.

Dans les composants de l'assistant WMI, un module distinct est généré pour chaque enregistrement renvoyé par la requête WMI scan.

Retour à l'index de la documentation du Pandora FMS