Un plugin remoto es un script o ejecutable que admite parámetros y devuelve un valor.
Para registrar un plugin en Pandora FMS iremos a la sección de administración de la consola, y en ella pulsaremos sobre Servers; después pulsar Plugins, después haga click en el botón Add.
Se abrirá una nueva página con un formulario, donde tendremos que rellenar los campos para la ejecución de nuestro plugin:
- Name: Nombre del plugin.
- Plugin type: Hay dos tipos de plugins, estándar (standard) y los de tipo Nagios. Los complementos estándar son scripts que ejecutan acciones y admiten parámetros. Los complementos de Nagios son, como su nombre indica, complementos de Nagios que se pueden usar en Pandora FMS. La diferencia estriba principalmente en que los plugins de Nagios devuelven un error level para indicar si la prueba ha tenido éxito o no y una cadena descriptiva adicional. Esa descripción no es un valor numérico que se pueda usar como valor de un módulo, así que en este caso la utilizaremos para actualizar la descripción del módulo.
- Max. timeout: Es el tiempo de expiración del complemento. Si no se recibe una respuesta en ese tiempo, se detendrá su ejecución. Este es un elemento muy relevante a la hora de implementar monitorización con plugins, ya que si el tiempo que tarda en ejecutar el plugin es mayor que este número, nunca podremos obtener valores con él (no se inicializará siquiera). Este valor siempre debe ser mayor que el tiempo que tarde normalmente en devolver un valor el script/ejecutable usado como plugin.
- Description: Descripción del complemento.
- Plug-in command: Path (ruta) al ejecutable del plugin. De forma predeterminada, si la instalación ha sido estándar, estarán en el directorio
/usr/share/pandora_server/util/plugin/. Aunque puede ser cualquier ruta del sistema. Para este caso, escribir:
/usr/share/pandora_server/util/plugin/udp_nmap_plugin.sh
- Plug-in parameters: Una cadena con los parámetros del plugin, que irán tras el comando y un espacio en blanco. Este campo acepta macros tales como
_field1_,_field2_, …_fieldN_. Aquí es donde está la parte más compleja del funcionamiento de un plugin. - Parameters macros: Es posible agregar macros ilimitadas para usarlas en el campo de los parámetros del plugin. Estas macros aparecerán como campos de texto en la configuración del módulo para que el usuario abstraiga la complejidad de uso de un módulo de tipo plugin. Se trata de que el usuario utilice un plugin como si fuera un módulo “de librería” en el que rellena campos, sin tener que saber cómo funciona por debajo. La definición de macros permite que el usuario rellene los parámetros de llamada al script sin saber cómo funciona, ni el script ni la forma de llamarlo.
- Descripción: Una cadena corta descriptiva de la macro. Será la etiqueta que aparecerá junto al campo en el formulario.
- Valor por defecto: Valor asignado al campo por defecto.
- Ayuda: Un texto explicativo de la macro, para mostrar algún ejemplo de uso o explicar mejor para qué sirve ese campo.
Para más información aquí tiene el enlace a nuestra Wiki:
