Skip to main content

Parameters

Script execution parameters

--script Path to the Oculix script to execute. This parameter is mandatory. Supports commas for multiple phases: --script a.py,b.py,c.py
--jar Path to the Oculix JAR file. This parameter is mandatory.
--conf Path to the .conf configuration file with Pandora and connection parameters. This parameter is mandatory.
--workspace Working directory for Oculix script execution. Optional.
--debug Debug verbosity (0 silent → 3 very verbose)
--console Enables Oculix console mode. Activated with the flag.
--native-access Enables --enable-native-access=ALL-UNNAMED in Java execution. Activated with the flag.
--checkpoint Enables baseline logic: if no reference image exists, creates one from the current screenshot. Activated with the flag.
--artifacts Directory where screenshots, baselines, and diffs are stored. Default "artifacts".
--phase-names Phase 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.
--transaction Global 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.
--retries Number of retries for the full transaction (default: 1). If any phase fails, all phases are retried from the start. Also configurable in .conf as phase_retries. CLI overrides .conf.
--post-command Command to execute after all phases complete. CLI-only argument, not available in .conf.

Pandora configuration parameters (.conf file)

agent_name Name of the agent that will contain the modules. Default: "{script} Oculix".
agents_group_name Agent group in PandoraFMS. Default "Oculix".
module_prefix Prefix for all modules created by the plugin.
interval Agent monitoring interval in seconds. Default 300.
agent_plugin Output mode: 1 prints XML to console, 0 writes to file and transfers. Default 0.
temporal Temporary directory for XML files. Default "/tmp".
transfer_mode Transfer mode: "tentacle" or "local". Default "tentacle".
tentacle_client Path to the tentacle_client binary. Default "tentacle_client".
tentacle_ip IP address of the tentacle server. Default "127.0.0.1".
tentacle_port Tentacle connection port. Default "41121".
tentacle_opts Extra options for tentacle connection.
data_dir PandoraFMS data directory for local transfer. Default "/var/spool/pandora/data_in/".