Parameters and configuration
Parameters
| -v --verbose |
Optional. Shows information about the progress of the plugin execution by STDERR. |
| -c <task_configuration_file_path> --conf <task_configuration_file_path> |
Path to the configuration file of the task to be executed. |
| -s <side_file_path> --side <side_file_path> |
Path to the SIDE file to execute. |
| -t <task_name> --task <task_name> |
Unique name of the task. It is used to generate temporary elements that do not overwrite those of other tasks that may be running on the same computer. |
| -i <agents_interval> --interval <agents_interval> |
Optional. Monitoring interval of the agents generated by the plugin. Default: 300. |
| -g <group_id> --group <group_id> |
Optional. ID of the group where you want to create the agents generated by the plugin. Default: 0. |
| -x --xml_mode |
Optional. If indicated, the plugin will generate XML files for the agents instead of outputting them via STDOUT. |
| -S <server:port> --server <server:port> |
Optional. For the generation of agents by XML. IP and port of the Tentacle server to which to send the XML files. |
| -T <temp_folder> --temp <temp_folder> |
Optional. For the generation of agents by XML. Temporary directory for the XML files that are generated before being sent to the indicated Tentacle server. |
Configuration file (--conf)
The content of the file will be the following:
{
"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>"
}Each configuration element being:
| worker_mode | Indicates whether the transaction will be launched locally or remotely. |
| run_mode | Indicates whether the plugin will run with drivers or in Docker. |
| browser | Indicates the browser that will be used for the transaction. |
| driver_url | Provide the URL to the Selenium 4 server to execute the transaction. Only in "remote/driver" mode. |
| ssh_address | Indicates the IP of the server to which you will connect via SSH to launch the plugin. Only in "remote/docker" mode. |
| ssh_port | Optional. Indicates the port for the SSH connection. By default "22". Only in "remote/docker" mode. |
| ssh_user | Indicates the user for the SSH connection. Only in "remote/docker" mode. |
| ssh_password | Indicates the password of the previous user. Only in "remote/docker" mode. |
| ssh_password_encrypt | Optional. Indicates whether the previous password is sent encrypted (1) or not (0). Only in "remote/docker" mode. Passwords can be encrypted by launching the plugin from the Pandora FMS Discovery server. Only in "remote/docker" mode. |
| ssh_temp_folder | Optional. Indicates the path to the temporary directory for the files needed during execution on the SSH server. By default "/tmp". Only in "remote/docker" mode. |
| docker_image | Optional. Indicates the name of the Docker image to launch the transaction. By default "pandorafms/pandora_selenium_headless". Only in "docker" mode. |
| chromedriver_path | Optional. Indicates the path to the "chromedriver" binary. By default "/usr/share/pandora_server/util/selenium_headless_drivers/chromedriver". Only in "local/driver" mode |
| chrome_binary_path | Optional. Indicates the path to the Google Chrome binary. By default "/usr/share/pandora_server/util/selenium_headless_drivers/chrome/google-chrome". Only in "local/driver" mode |
| chrome_user_data_dir | Optional. Indicates the path to the Google Chrome data directory ("data dir") that you want to use. |
| chrome_profile | Optional. Indicates the name of the Google Chrome profile you want to use. It must be found within the "data_dir". If not indicated, the browser's default profile will be used. |
| geckodriver_path | Indicates the path to the "geckodriver" binary. By default "/usr/share/pandora_server/util/selenium_headless_drivers/geckodriver". Only in "local/driver" mode |
| firefox_binary_path | Indicates the path to the Mozilla Firefox binary. By default "/usr/share/pandora_server/util/selenium_headless_drivers/firefox/firefox". Only in "local/driver" mode |
| firefox_profile | Optional. Indicates the path to the Mozilla Firefox profile directory that you want to use. If not indicated, the browser's default profile will be used. |
| accept_insecure_certs | Optional. If indicated with a value of "1", insecure SSL certificates from URLs accessed during the transaction will automatically be accepted as valid. |
| monitor_stats | Optional. If it is indicated with a value of "1", connection statistics modules will be generated to the main URL of the indicated SIDE file. |
| browser_width | Optional. Indicates the width of the browser in pixels for the transaction. By default "1920". |
| browser_height | Optional. Indicates the height of the browser in pixels for the transaction. By default "1080". |
| global_timeout | Optional. Indicates the global timeout in seconds for the tasks performed by the plugin, such as connecting to the Selenium server, starting the browser drivers, etc. It is also the default timeout used for Selenium commands to be executed. Default "5". |
| wait_between_commands | Optional. Indicates the time in seconds that the plugin will wait between each SIDE command it executes. This value can be adjusted with SIDE itself using the "setSpeed" command. By default "0". |
For example:
{
"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"
}