Parámetros y configuración
Parámetros
| -v --verbose |
Opcional. Muestra información acerca del progreso en la ejecución del plugin por STDERR. |
| -c <task_configuration_file_path> --conf <task_configuration_file_path> |
Ruta al fichero de configuración de la tarea a ejecutar. |
| -s <side_file_path> --side <side_file_path> |
Ruta al fichero SIDE a ejecutar. |
| -t <task_name> --task <task_name> |
Nombre único de la tarea. Es usaro para generar elementos temporales que no sobrescriban los de otras tareas que puedan estar corriendo en el mismo equipo. |
| -i <agents_interval> --interval <agents_interval> |
Opcional. Intervalo de monitorización de los agentes generados por el plugin. Por defecto: 300. |
| -g <group_id> --group <group_id> |
Opcional. ID del grupo donde se quieran crear los agentes generados por el plugin. Por defecto: 0. |
| -x --xml_mode |
Opcional. Si se indica, el plugin generará ficheros XML para los agentes en lugar de hacerlo mediante su salida por STDOUT. |
| -S <server:port> --server <server:port> |
Opcional. Para la generación de agentes por XML. IP y puerto del servidor de Tentacle al que enviar los ficheros XML. |
| -T <temp_folder> --temp <temp_folder> |
Opcional. Para la generación de agentes por XML. Directorio temporal para los fichero XML que se generen antes de enviarse al servidor de Tentacle indicado. |
Archivo de configuración (--conf)
El contenido del fichero será el siguiente:
{
"worker_mode" : "<local | remote>",
"run_mode" : "<driver | docker>",
"browser" : "<chrome | firefox>",
"driver_url" : "http://<selenium_ip>:<selenium_port>/wd/hub",
"ssh_address" : "<ssh_ip>",
"ssh_port" : "<ssh_port>",
"ssh_user" : "<ssh_user>",
"ssh_password" : "<ssh_password>",
"ssh_password_encrypt" : "<1 | 0>",
"ssh_temp_folder" : "<ssh_temp_folder_path>",
"docker_image": "<docker_image>",
"chromedriver_path": "<chromedriver_path>",
"chrome_binary_path": "<chrome_binary_path>",
"chrome_user_data_dir" : "<chrome_user_data_dir>",
"chrome_profile" : "<chrome_profile>",
"geckodriver_path": "<geckodriver_path>",
"firefox_binary_path": "<firefox_binary_path>",
"firefox_profile" : "<firefox_profile>",
"accept_insecure_certs" : "<1 | 0>",
"monitor_stats" : "<1 | 0>",
"browser_width" : "<width>",
"browser_height" : "<height>",
"global_timeout" : "<seconds>",
"wait_between_commands" : "<seconds>"
}Siendo cada elemento de la configuración:
| worker_mode | Indica si la transacción se lanzará en local o remoto. |
| run_mode | Indica si el plugin se ejecutará con drivers o en Docker. |
| browser | Indica el navegador que se usará para la transacción. |
| driver_url | Indica la URL al servidor de Selenium 4 para ejecutar la transacción. Solo en modo "remote/driver". |
| ssh_address | Indica la IP del servidor al que conectará por SSH para lanzar el plugin. Solo en modo "remote/docker". |
| ssh_port | Opcional. Indica el puerto para la conexión SSH. Por defecto "22". Solo en modo "remote/docker". |
| ssh_user | Indica el usuario para la conexión SSH. Solo en modo "remote/docker". |
| ssh_password | Indica la contraseña del usuario anterior. Solo en modo "remote/docker". |
| ssh_password_encrypt | Opcional. Indica si la contraseña anterior se envia encriptada (1) o no (0). Solo en modo "remote/docker". Las contraseñas se podrán encriptar lanzando el plugin desde el Discovery server de Pandora FMS. Solo en modo "remote/docker". |
| ssh_temp_folder | Opcional. Indica la ruta al directorio temporal para los ficheros necesarios durante la ejecución en el servidor SSH. Por defecto "/tmp". Solo en modo "remote/docker". |
| docker_image | Opcional. Indica el nombre de la imagen de Docker para lanzar la transacción. Por defecto "pandorafms/pandora_selenium_headless". Solo en modo "docker". |
| chromedriver_path | Opcional. Indica la ruta al binario "chromedriver". Por defecto "/usr/share/pandora_server/util/selenium_headless_drivers/chromedriver". Solo en modo "local/driver" |
| chrome_binary_path | Opcional. Indica la ruta al binario de Google Chrome. Por defecto "/usr/share/pandora_server/util/selenium_headless_drivers/chrome/google-chrome". Solo en modo "local/driver" |
| chrome_user_data_dir | Opcional. Indica la ruta al directorio de datos ("data dir") de Google Chrome que se quiera utilizar. |
| chrome_profile | Opcional. Indica el nombre del perfil de Google Chrome que se quiera utilizar. Debe encontrarse dentro del "data_dir". Si no se indica se usará el perfil por defecto del navegador. |
| geckodriver_path | Indica la ruta al binario "geckodriver". Por defecto "/usr/share/pandora_server/util/selenium_headless_drivers/geckodriver". Solo en modo "local/driver" |
| firefox_binary_path | Indica la ruta al binario de Mozilla Firefox. Por defecto "/usr/share/pandora_server/util/selenium_headless_drivers/firefox/firefox". Solo en modo "local/driver" |
| firefox_profile | Opcional. Indica la ruta al directorio del perfil de Mozilla Firefox que se quiera utilizar. Si no se indica se usará el perfil por defecto del navegador. |
| accept_insecure_certs | Opcional. Si se indica con valor "1" se aceptarán automáticamente como válidos los certificados SSL inseguros de las URL a las que se acceda durante la transacción. |
| monitor_stats | Opcional. Si se indica con valor "1" se generarán módulos de estadísticas de conexión a la URL principal del fichero SIDE indicado. |
| browser_width | Opcional. Indica el ancho del navegador en pixels para la transacción. Por defecto "1920". |
| browser_height | Opcional. Indica el alto del navegador en pixels para la transacción. Por defecto "1080". |
| global_timeout | Opcional. Indica el timeout global en segundos para las tareas que realiza el plugin, tales como conectar al servidor de Selenium, iniciar los drivers del navegador, etc. También es el timeout usado por defecto para los comando de Selenium que se ejecuten. Por defecto "5". |
| wait_between_commands | Opcional. Indica el tiempo en segundos que el plugin esperará entre cada comando del SIDE que ejecute. Este valor se podrá ajustar con el propio SIDE mediante el comando "setSpeed". Por defecto "0". |
Por ejemplo:
{
"worker_mode" : "local",
"run_mode" : "driver",
"browser" : "chrome",
"driver_url" : "",
"ssh_address" : "",
"ssh_port" : "",
"ssh_user" : "",
"ssh_password" : "",
"ssh_password_encrypt" : "",
"ssh_temp_folder" : "",
"docker_image": "",
"chromedriver_path": "",
"chrome_binary_path": "",
"chrome_user_data_dir" : "",
"chrome_profile" : "",
"geckodriver_path": "",
"firefox_binary_path": "",
"firefox_profile" : "",
"accept_insecure_certs" : "0",
"monitor_stats" : "1",
"browser_width" : "1920",
"browser_height" : "1080",
"global_timeout" : "10",
"wait_between_commands" : "0.2"
}