Un complemento (plugin) de servidor es un programa o guión con comandos (script) ubicado en el servidor (por defecto en /usr/share/pandora_server/util/plugin ) y ejecutado por éste, al que podemos pasarle una serie de parámetros. Devuelve un único valor simple, ya sea numérico, booleano o de tipo texto.
Para usar los plugins, debemos activar el servidor específico pluginserver en la configuración del servidor:
/etc/pandora/pandora_server.conf.
Pandora FMS trae por defecto unos cuantos plugins, como iface_bandwith.pl y udp_nmap_plugin.sh, pero también se pueden desarrollar manualmente. La manera más fácil de comprobar su funcionamiento es ejecutándolos directamente desde la terminal, como más adelante hará Pandora FMS. En general, los plugins suelen incluir una ayuda al ejecutarlos con -help, -h o sin parámetros, lo cual facilita su uso.
Para utilizar un plugin en Pandora FMS hay que registrarlo, y esto se puede hacer de dos maneras:
Registro manual
Se realiza en Servers/Plugins. En el menú de crear plugin debemos indicar el nombre (junto con otros parámetros como el tipo de plugin, el timeout y una descripción) así como el comando que ejecuta y los parámetros a utilizar con él. Éstos se especifican en Plug-in command (donde hay que indicar la ruta completa al plugin) y en Plug-in parameters (el cual acepta el uso de macros), respectivamente.
Por ejemplo, si quisiéramos crear un plugin que ejecutara un chequeo remoto UDP utilizando NMAP a la dirección IP y el puerto que deseemos, tendríamos que completar el registro de esta manera:
- Escogeríamos como nombre de plugin “Chequeo de puerto UDP”, por ejemplo.
- En Plug-in command, escribiríamos la ruta /usr/share/pandora_server/util/plugin/udp_nmap_plugin.sh, la cual lleva a un plugin instalado por defecto con Pandora FMS.
- En Plug-in parameters, escribiríamos
-t _field1_ -p _field2_para que el plugin pueda reutilizarse para todos los puertos y direcciones IP que necesitemos. Más abajo podemos añadir una descripción a estos macros para saber qué información exigen. - En el espacio Command preview veremos cómo ejecutará Pandora FMS el comando:
/usr/share/pandora_server/util/plugin/udp_nmap_plugin.sh -t _field1_ -p _field2_
Ya tenemos registrado el plugin. Para usarlo, cree un módulo de tipo plugin en el agente que desee monitorizar. Al escogerlo, se le dará la opción de escoger la información que sustituirá a los macros _field1_ y _field2_, en este caso, la dirección IP y el puerto, respectivamente.
Tenga en cuenta que algunos plugins pueden tardar bastante tiempo en terminar su ejecución, por lo que el timeout de ejecución del servidor (pandora_server.conf) siempre debe ser más alto que cualquiera de los valores definidos en un plugin. En caso contrario, el servidor detendrá la ejecución del plugin.
Registro mediante un fichero .pspz
El formato PSPZ se creó para abstraer la instalación de plugins por parte de usuarios con poco conocimiento. Consiste en un fichero .zip con extensión .pspz que contiene el script y otros ficheros que necesite el plugin para funcionar, junto con un fichero denominado plugin_definition.ini. Este fichero contiene la especificación del plugin y de los módulos que se pueden emplear con él, para incorporarlos a la librería. Contiene la definición de la interfaz completa, y al instalarlo a través de la consola, copia el plugin a un directorio del disco.
El registro con ficheros .pspz se realiza desde la consola, en Servers/Register plug-in, donde habrá que subir el archivo para que Pandora FMS lo utilice. Por defecto, el plugin se copiará sobre el servidor donde está la consola. Si el servidor de plugins se encuentra en otra máquina, habrá que copiar o sincronizar el directorio /attachment/plugin de la Consola web.
- Véase también: