Skip to main content

Parameters

ScriptDiscovery executiontask wizard parameters

**Field****Macro****Notes****Default**
Worker mode`_workerMode_``local` or `remote`. `remote` runs Docker on an SSH host.`local`
Browser`_browser_``chromium`, `firefox`, `webkit``chromium`
SSH address`_sshAddress_`Host that runs Docker (remote only)
SSH port`_sshPort_``22`
SSH user`_sshUser_`Must be able to run Docker`root`
SSH password`_sshPassword_`Encryptable via `password_encrypter.py`
Encrypt password`_sshPasswordEncrypt_`Obfuscates the password in the task configon
Temporal folder`_sshTemp_`Where the test file is copied on the remote host`/tmp`
Docker image`_dockerImage_``pandorafms/pandora_playwright:noble`
Browser width`_browserWidth_``1920`
Browser height`_browserHeight_``1080`
Test timeout`_globalTimeout_`Per-test timeout, in **seconds**`30`
Send full report`_fullReport_`Adds a verbose text report moduleoff
Report agent name`_reportAgent_`Agent that holds the full report; empty = first test's agent
Generate error history module`_errorHistoryModule_`Adds a synchronous string module per status/phase (`OK` or the error text), so Pandora keeps a historic value series of errorsoff
Playwright test (.ts)`_playwrightTest_`The full test file content

Task configuration (JSON the runner receives)

{
  "worker_mode": "local",
  "browser": "chromium",
  "ssh_address": "", "ssh_port": "22", "ssh_user": "root",
  "ssh_password": "", "ssh_password_encrypt": "0", "ssh_temp_folder": "/tmp",
  "docker_image": "pandorafms/pandora_playwright:noble",
  "browser_width": "1920", "browser_height": "1080",
  "global_timeout": "30",
  "full_report": "0",
  "report_agent": "",
  "error_history_module": "0"
}

CLI parameters (manual / standalone execution)

Ifall
**Short****Long****Required****Default****Description**
`-c``--scriptconf`yesPath to the Oculixtask scriptconfiguration to execute. This parameter is mandatory. Supports commas for multiple phases: --script a.py,b.py,c.pyJSON
`-s``--jartest`yesPath to the OculixPlaywright JAR`.ts` file.test This parameter is mandatory.file
`-t``--conftask`yesTask Pathname (used to derive the .confcontainer configuration file with Pandora and connection parameters. This parameter is mandatory.name)
`-i``--workspaceinterval`no`300`Agent Workinginterval directory for Oculix script execution. Optional.(seconds)
`-g``--debuggroup`no`0`Group Debug verbosity (0 silent → 3 very verbose)
--consoleEnables Oculix console mode. Activated with the flag.
--native-accessEnables --enable-native-access=ALL-UNNAMED in Java execution. Activated with the flag.
--checkpointEnables baseline logic: if no reference image exists, creates one from the current screenshot. Activated with the flag.
--artifactsDirectory where screenshots, baselines, and diffs are stored. Default "artifacts".
--phase-namesPhase names separated by commas (e.g. Login,Search,Logout). If omitted, the script stem is used. Also configurable in .conf as phase_names. CLI overrides .conf.
--transactionGlobal transaction name. If set, Global_Status_{name}, Global_Time_{name} and Global_Last_Image_{name} modules are generated. Also configurable in .conf as transaction_name. CLI overrides .conf.
--retriesNumber of retriesid for the fullcreated transactionagents
`-x``--xml_mode`nooffBuild agent XML and send it via Tentacle (default:standalone 1).mode)
`-S``--server`no`127.0.0.1:41121`Tentacle any`server:port` phase(with fails,`-x`)
`-T``--temp`no`/tmp`Temp phasesfolder are retried fromfor the start.XML Also(with configurable in .conf as phase_retries. CLI overrides .conf.`-x`)
`-v``--post-commandverbose`nooffStep-by-step Commandtrace to execute after all phases complete. CLI-only argument, not available in .conf.STDERR

Pandorapassword_encrypter configuration-e parameters-p <password> encrypts a password; -d decrypts it (.conf file)

agent_nameName of the agent that will contain the modules. Default: "{script} Oculix".
agents_group_nameAgent group in PandoraFMS. Default "Oculix".
module_prefixPrefix for all modules createdused by the plugin.
intervalAgent monitoring interval in seconds. Default 300.
agent_pluginOutput mode: 1 prints XML to console, 0 writes to file and transfers. Default 0.
temporalTemporary directoryconsole for XML files. Default "/tmp".
transfer_modeTransfer mode: "tentacle" or "local". Default "tentacle".
tentacle_clientPath to the tentacle_clientSSH binary.password Defaultfield).

"tentacle_client".
tentacle_ipIP address of the tentacle server. Default "127.0.0.1".
tentacle_portTentacle connection port. Default "41121".
tentacle_optsExtra options for tentacle connection.
data_dirPandoraFMS data directory for local transfer. Default "/var/spool/pandora/data_in/".