Parámetros específicos del plugin
En esta sección describiremos todos los parámetros opcionales del plug-in, si los tiene, todas las combinaciones y tipo de ejecuciones posibles que sean relevantes.
Ejemplo: Continuamos con el conector de Discord en este ejemplo
Parámetros opcionales
Como podemos ver, aparte de los datos serializados y la url tenemos varios parámetros opcionales, algunos son muy simples y autoexplicativos como el nombre del autor, el título, la descripción de la alerta o footer.
Otros son un poco menos intuitivos, como la configuración de la gráfica, así que haremos un pequeño ejemplo de una ejecución con los parámetros más relevantes.
Descripción de los parámetros opcionales:
| Parámetro |
Descripción |
| -h, --help |
Muestra la ayuda. |
| -d DATA, --data | Los datos a enviar en pares clave=valor Ej: test=5,house=2 |
| -u URL, --url | URL Discord webhook URL |
| -t ALERT_TITTLE, --alert_tittle ALERT_TITTLE | Título de la alerta |
| -D ALERT_DESC, --alert_desc ALERT_DESC | Descripción de la alerta |
| -m MESSAGE, --message | Cuerpo del mensaje |
| -T TITTLE_COLOR, --tittle_color TITTLE_COLOR | Color del título de la alerta en hexadecimal EX: 53e514 |
| -A AUTHOR, --author AUTHOR | Nombre del autor (por defecto PandoraFMS) |
| -F FOOTER, --footer FOOTER | Footer personalizado |
| --api_conf API_CONF |
Parametros configuracion de la api en formato clave valor. Ej:"user=admin,pass=pandora,api_pass=1234,api_url=http://test.artica.es/pandora_console/include/api.php" |
| --module_graph MODULE_GRAPH | Generar una gráfica para enviar usando conexión a la api deben pasarse los parametros module_id y intervalo en formato clave valor. EX "module_id=55,interval=3600" |
| --tmp_dir TMP_DIR | Directorio temporal donde se almacenaran las gráficas para su envio. |
Al descomprimir el paquete hay un fichero test-exec.txt en el que tendremos una ejecución de ejemplo utilizando todos los parámetros:
python3 pandora_discord_cli.py -d "Agent=Server22,Module=test_module,Group=Servers,State=Critical,Data=22,Timestamp=2020-11-04 11:14:00" \
-u https://discord.com/api/webhooks/702868786843353179/YI1LOUzC64EcYcpPVB_ \
--tittle_color ed2512 \
--footer "PandoraFMS Alert" \
-A "Sauron Systems" \
--author_icon_url "https://pandorafms.com/wp-content/uploads/2019/04/software-de-monitorizacion-pandorafms-logo.png" \
-m "We have bad news for you. Something is on CRITICAL status 2" \
--author_url https://pandorafms.com/ \
-D "Module test is going to critical" \
--thumb https://pandorafms.com/images/alerta_roja.png \
--avatar_url https://pandorafms.com/images/alerta_roja.png \
--api_conf "user=admin,pass=pandora,api_pass=pandora,api_url=http://192.168.80.222/pandora_console/include/api.php" \
--module_graph "module_id=6266, interval=3600" \
--tmp_dir /tmp
El resultado de esta ejecución será ligeramente diferente, contendrá más información, indicándonos que tenemos la API configurada y que la gráfica se ha generado con éxito.
Si vemos el mensaje recibido en Discord:
Veremos que es similar al anterior pero con una imagen de usuario personalizada, el logo de alerta crítica, un color de borde personalizado, título y footer y la gráfica del módulo seleccionado obtenido de la API de Pandora, simplemente pasando los parámetros correspondientes en la ejecución.