| Variable | Values allowed | Default value | Explanation |
|---|---|---|---|
|
|
Absolute or relative path to the test distribution. Specifying the variable is mandatory. Can also be a Git repository URL of a test distribution to checkout with an optional refspec or Git commit hash into the current directory. It tries to follow the definition of https://docs.npmjs.com/cli/v7/configuring-npm/package-json#git-urls-as-dependencies (e.g. |
|
|
|
Absolute or relative path to the optional "product directory" which includes the test schedule entry point |
|
|
|
Absolute or relative path to the needles subdirectory. Defaults to |
|
|
|
Absolute or relative path to the directory wheels are stored in if |
|
|
|
comma separated names or fullnames of test modules to be included while excluding all that do not match, e.g. "boot,mod1" |
|
|
|
comma separated names or fullnames of test modules to exclude. Can be combined with INCLUDE_MODULES and has precedence, e.g. to additionally exclude modules based on an include-list |
|
|
|
comma or space separated list of relative paths to test modules within CASEDIR to be scheduled instead of evaluating a schedule from the test distributions main.pm file, e.g. "boot,console/mod1". Test modules can be specified without the implicit file extension '.pm'. |
|
|
|
|
Exit test execution immediately after evaluation of the test schedule, e.g. to check only which test modules would be executed |
|
|
|
Skip the execution of post_fail_hook methods if set. This can be useful to save test execution time during test development when the post_fail_hook is not expected to provide any value as most likely the test developer already knows what needs to be done as a next step on a test fail. |
|
|
git refspec to checkout within |
|
|
|
git refspec to checkout within |
|
|
|
Specifies the command line for invoking a custom video encoder. It is supposed to accept a sequence of PPM images via stdin. The placeholder |
|
|
|
|
The extension of the output file when |
|
|
|
Whether |
|
|
|
Whether the creation of the video should be disabled and also any |
|
|
|
Disable the I/O debug output in case of needle comparison times longer than expected |
|
|
|
The interval in seconds between "attempts" in osutils, e.g. used for connections to qemu qmp backend |
|
|
|
The interval in seconds at which screenshots are taken internally |
|
|
|
Timeout for any SSH based command in SSH based consoles, disabled for a value of 0. Time in seconds. |
|
|
|
Maximum retries to connect to SSH based console targets |
|
|
|
Interval in seconds between retries to connect to SSH based console targets. Related to SSH_CONNECT_RETRY |
|
|
|
Time after which is VNC considered stalled |
|
|
|
Maximum number of keys per second |
|
|
|
Timeout for local VNC connections in seconds |
|
|
|
Timeout for remote VNC connections in seconds |
|
|
|
The amount of time isotovideo is going to wait for the VNC console to become responsive |
|
|
|
The amount of times, the select should return the same fileno during the _CHKSEL_RATE_WAIT_TIME seconds, to consider the VNC console unresponsive |
|
|
|
This scale parameter can be used based on performance of workers to prevent false positive timeouts based on differing worker performance. |
|
|
Test module (name or fullname) to pause test execution at. To be used together with the openQA developer mode which also allows to continue test execution again. Note that this does not start a developer mode session. So you still need to confirm taking control over the test to access the developer mode controls. |
|
|
|
|
Pause test execution on the next screen mismatch. Same notes as for |
|
|
|
Pause test execution on the next test API command. Same notes as for |
|
|
|
Pause test execution on a test failure (instead of invoking the post-fail hook and terminating). Same notes as for |
|
|
|
Add quiet flag to all the calls to script_run, script_output and validate_script_output. It will omit all the squares "wait_serial expected" on the Details view of the test case. This option might be useful for serial terminal tests. |
|
|
|
If this value is greater then 0, it is used by |
|
|
hostname or IP address of host running the autoinst webserver endpoint, defaults to the local IP address within the qemu network for the qemu backend or the |
|
|
|
|
Display curl progress meter in |
|
|
|
Specifies the max. upload size in GiB for the test API functions |
|
|
|
Specifies the inactivity timeout in seconds for the test API functions |
|
|
|
Only warn about deprecated backends instead of aborting |
|
|
|
Resolution of display on x axis. Sets the resolution of the video encoder, and in qemu, the initial console resolution when OFW is set (Power and SPARC), and the EDID resolution for devices that support EDID |
|
|
|
Resolution of display on y axis. Sets the resolution of the video encoder, and in qemu, the initial console resolution when OFW is set (Power and SPARC), and the EDID resolution for devices that support EDID |
|
|
|
Whether the pipe for writing data to the video encoder should be blocking or not. Making it blocking might allow following the live view in realtime despite large screenshot file sizes but it is not a well tested configuration |
|
|
|
Default single click time in seconds |
|
|
|
Default double/triple click time in seconds (both press time and interval between clicks) |
|
|
If set enables locally caching Git repositories in the specified directory when handling Git URLs in variables like |
| Variable | Values allowed | Default value | Explanation |
|---|---|---|---|
|
|
Sets the remote hostname. |
|
|
|
Sets the remote username. |
|
|
|
Sets the remote password. |
| Variable | Values allowed | Default value | Explanation |
|---|---|---|---|
|
|
|
Sets the number of server alive messages which may be sent without receiving any messages back from the server. If this threshold is reached while server alive messages are being sent, ssh will disconnect from the server, terminating the session. The server alive mechanism is valuable when the client or server depend on knowing when a connection has become inactive. |
|
|
|
Sets a timeout interval in seconds after which if no data has been received from the server, client will send a message through the encrypted channel to request a response from the server. |
| Variable | Values allowed | Default value | Explanation |
|---|---|---|---|
|
|
|
Enable direct log capture of sol console, disabled by default |
|
|
|
Hostname/IP for IPMI interface |
|
|
|
Password for the IPMI interface |
|
|
|
Username for the IPMI interface |
|
|
|
Don’t power off the machine after test |
|
|
|
Don’t restart the machine before test |
|
|
|
Reset ipmi main board before test for sol console stability |
|
|
|
Don’t perform BMC selftest |
|
|
|
Hardware used for IPMI interface |
|
|
|
Maximum number of overall retries for mc reset |
|
|
|
Time to sleep after sending mc reset command before trying to control IPMI |
|
|
|
Counts to try to reach IPMI interface after mc reset |
|
|
|
Ping counts that must be successful after mc reset |
|
|
|
Maximum number of IPMI command tries that are conducted after mc reset |
|
|
|
Make SOL console persistent and don’t reset it, enabled by default |
|
|
|
Maximum number of SOL reconnects on connection failure |
|
Internal iterator variable |
||
|
|
|
Worker hostname |
| Variable | Values allowed | Default value | Explanation |
|---|---|---|---|
|
|
|
Architecture of VM. |
|
|
Controller for ATA devices, needed for connecting disks as SATA. |
|
|
Set the filename for the BIOS |
||
|
|
enables boot from HDD_1 (BOOTFROM has higher priority) |
|
|
|
|
enables boot menu for selection of boot device |
|
|
|
boot menu timeout in ms. Needs BOOT_MENU |
|
|
|
Influences order of boot devices. Multi boot order is not supported. This variable can be overriden by |
|
|
|
Storage device for virtualized CD |
|
|
delay vm cpu start until resume_vm() is called |
|
|
|
|
Enable FIDO2 hardware token |
|
|
|
Storage device for virtualized HDD. |
|
|
|
Storage device for virtualized HDD. Overrides global HDDMODEL for HDD_$i |
|
|
|
Creates HDD with specified size in GiB |
|
|
Filename of HDD image to be used for VM. Up to 9 |
|
|
|
|
see qemu-system-x86_64 -device nvme,help - set the number of queues for HDD_$i |
|
|
|
specifies the physical and logical block size and boot sector size of the HDD image |
|
|
Filename of ISO file to be attached to VM |
|
|
|
Additional ISO to be attached to VM. Up to 9 |
|
|
|
Leave created HDD after test finishes. Useful for debugging tests |
|
|
|
|
If 1, loads HP EliteBook 820 G1 DMI. If filename, loads specified DMI |
|
|
|
Save snapshot for each test module in qcow image |
|
|
|
Add HDD drives as multipath devices. Override HDDMODEL to virtio-scsi-pci |
|
|
|
open source network boot firmware e.g. to attach iscsi target on boot http://ipxe.org/ |
|
|
|
MAC address to be assigned to virtual network card |
|
|
|
Network device virtual NIC. |
|
|
|
Instruct QEMU to either use user networking or to connect virtual NIC to existin system TAP device |
|
|
|
Arbitrary options for NICTYPE |
|
|
|
Comma-separated list of network (vlan) numbers to which the NIC should be connected, assigned by scheduler to jobs with NICTYPE != user |
|
|
|
Number of disks to be created and attached to VM, can be 0 to disable disks, if using RAIDLEVEL, will be set to 4 |
|
|
|
Disable network for a VM |
|
|
|
QEMU Open Firmware is in use |
|
|
|
Set debug mode if value is 1 |
|
|
|
If set, only execute the qemu process but return early before connecting to the process. This can be helpful for cutting testing time or to connect to the qemu process manually. |
|
|
|
Only used for internal testing, see comment in t/18-qemu-options.t for details. |
|
|
|
(Deprecated, set QEMU_VIDEO_DEVICE=VGA) If set, and QEMU_VIDEO_DEVICE is not set, for arm systems use VGA as video adapter instead of virtio-gpu-pci |
|
|
|
If set, disable snapshots in QEMU. This needs to be set when using vmdk disk images or in case the worker has slow disks to avoid save_vm calls failing due to timeouts (See bsc#1035453) |
|
|
|
The number of attempts to connect to qemu qmp. Usually used for internal testing |
|
|
|
Number of paths in MULTIPATH scenario |
|
|
|
Boot VM from network, on every boot or only once if set to 'once'. If value is 1 or 'once' it sets |
|
|
|
Filename of QEMU binary to use |
|
|
|
Number of CPU clusters used by VM |
|
|
|
Number of CPU cores used by VM |
|
|
|
CPU to emulate |
|
|
|
Number of CPUs to assign to VM |
|
|
|
Number of CPU dies used by VM |
|
|
|
Machine and chipset to emulate |
|
|
|
Port on which QEMU monitor should listen |
|
|
|
Size of RAM of VM in MiB |
|
|
|
Number of CPU sockets used by VM |
|
|
|
Number of CPU threads used by VM |
|
|
|
Configure VM to use a TPM emulator device, with appropriate args for the arch. If a TPM device is available at QEMUTPM_PATH_PREFIX + X, where X is the value of QEMUTPM or the worker instance number if QEMUTPM is set to 'instance', it will be used. Otherwise it will be created at test startup. See QEMUTPM_VER in the latter case. |
|
|
|
If no TPM device has been setup otherwise, swtpm will be used internally to create one with a socket at /tmp/mytpmX |
|
|
|
Path prefix to use or create TPM emulator device in |
|
|
|
(Deprecated, use QEMU_VIDEO_DEVICE instead) VGA device to use with VM (will be converted to a matching -device parameter) |
|
|
|
compress qcow2 images intended for upload |
|
|
|
Define number of tries for qemu-img commands |
|
|
|
Define a path to use huge pages (e.g. /dev/hugepages/) |
|
|
|
The VM host IP used in usermode networking. Set |
|
|
|
Maximum time in seconds a migration to file may take for example for snapshot creation before being forcefully aborted. |
|
|
|
Don’t disable the floppy drive. |
|
|
|
Don’t use KVM acceleration. |
|
|
|
Don’t use USB tablet. |
|
|
|
Enable virtio random number generator |
|
|
|
Enable NUMA simulation, requires QEMUCPUS to be greater than one |
|
|
|
pass this value to qemu -smbios |
|
|
|
pass this value to qemu -soundhw (for qemu < 4.2) |
|
|
|
Audio device to use with audiodev to qemu -device (for qemu >= 4.2) |
|
|
|
Audio backend to use with audiodev (for qemu >= 4.2) |
|
|
|
Sets the compression level used for memory dumps and snapshots. Zero turns compression off and 9 is the maximum level. Generally there is little improvement in compression ratio by increasing the level, but the CPU time can be high on some platforms. |
|
|
|
Number of threads used for compressing memory dumps and snapshots. |
|
|
|
Ignore failed dbus calls and ignore instead of fatal exits |
|
|
|
Limits the transfer rate during a snapshot. |
|
|
|
The compression to use during a memory dump. Can be set to xz, bzip2 or internal (QEMU’s internal compression, not compatible with crash or gdb). If xz is set, but not available, it will fallback to bzip2. Also see QEMU_COMPRESSION_LEVEL. |
|
|
Append parameters on qemu command line. The first item will have '-' prepended to it. |
|
|
|
|
Enable QEMU’s built-in samba service for user network. Exported worker’s pool will be accessible on |
|
|
|
Enable/disable virtio console. (@see |
|
|
|
Number of virtio consoles. |
|
|
|
The target guest RAM usage before a snapshot is taken. It is intended to speed up snapshots by forcing the guest to drop various caches. Setting this enables the virtio-balloon device which requires a kernel with a virtio-balloon driver. Setting this far below the RAM required by the guest will probably cause the guest to panic or deadlock. However it should be able to cope with it being set slightly below what is needed. |
|
|
|
Timeout for qemu balloon operations |
|
Set the raid level, affects NUMDISKS. |
||
|
|
Restore VM from snapshot and continue by running specified test module. Needs HDD image with snapshots present |
|
|
|
|
TAP device name to which virtual NIC should be connected. Usually undef so automatic matching is used |
|
|
|
Script used during the backend network shutdown |
|
Script used during the backend network creation |
||
|
|
|
Enable test debugging: override 'milestone' and 'fatal' test flags to 1. Snapshot are created after each successful test module and each fail aborts test run |
|
|
|
Enable UEFI |
|
|
Specify the file name of the UEFI firmware code which will be loaded onto a read-only PFLASH drive |
|
|
|
Specify the file name which contains the UEFI firmware variables which will be loaded onto a mutable PFLASH drive |
|
|
|
Specify the file name to publish the UEFI vars file as |
|
|
|
|
(Deprecated, use UEFI_PFLASH_VARS) Enable the pflash mode to write the UEFI variables directly into the firmware file instead of NVvars in the EFI system partition |
|
Deprecated, use UEFI_PFLASH_CODE |
||
|
|
|
Mount ISO as USB disk and boot VM from it |
|
|
|
Size of USB disk for USBBOOT |
|
|
|
number of vde switch port to connect |
|
|
|
directory where vde_switch control socket is to be found |
|
|
|
whether to start slirpvde |
|
|
|
Display on which VNC server is running. Actual port is 5900 + VNC |
|
|
Additional variables passed to the qemu VNC parameter ( |
|
|
Set the keyboard layout if you are not using en-us |
||
|
|
|
qemu system types |
|
|
|
Worker hostname |
|
|
|
Video device to use with VM (using -device, not -vga). Can have options appended e.g. "virtio-gpu-gl,edid=on", but it is better to set QEMU_VIDEO_DEVICE_OPTIONS. See qemu docs and https://www.kraxel.org/blog/2019/09/display-devices-in-qemu/ for valid choices |
|
|
|
Additional options for QEMU_VIDEO_DEVICE (comma-separated). Will be appended after automatically-generated resolution setting options on devices that support EDID |
|
|
|
Timeout for saving one storage volume in |
| Variable | Values allowed | Default value | Explanation |
|---|---|---|---|
|
|
|
Disk size in GB |
|
|
|
Number of CPUs to assign to VM |
|
|
|
Size of RAM of VM in MiB |
|
|
SSH Host with virsh |
|
|
|
Username on above host, defaults to root |
|
|
|
Password for user account on above host |
|
|
|
Host’s hypervisor ('kvm', 'xen') |
|
|
|
Host’s hypervisor type ('hvm' for full virtualization on 'kvm' and 'xen' families, 'linux' for paravirtualization on 'xen' family) |
|
|
|
Where to look for VNC server (SUT or VM) |
|
|
|
VNC password of the guest |
|
|
|
VM’s instance number on VIRSH_HOSTNAME |
|
|
|
Administrator’s username ('@' is '%40') |
|
|
|
Administrator’s password |
|
|
|
VCS server for authentication |
|
|
|
|
VMware datastore |
|
|
VMware datastore with openQA NFS directories |
|
|
|
TCP port where is VM’s serial port stream to be expected on the ESX server |
|
|
|
VMware’s bridge name (usual default is 'VM Network') |
|
|
|
Set the vmware Virtual Machine Manager |
|
|
|
|
Whether to use VNC over WebSockets (instead of raw VNC connection) |
|
|
|
Do not require a valid TLS certificate for VNC over WebSockets |
|
|
Set the location of combustion’s bash script file among the data folder |
|
|
|
Set the location of ignition’s config file formated in json, among the data folder |
|
|
|
Set the location of user-data and meta-data files, separated by a comma in data folder |
|
|
|
Administrator account name |
|
|
|
Password for above account |
|
|
|
Windows Server (2008 R2, 2012 R2, or 2016) instance IP address |
|
|
|
TCP port where is VM’s serial port stream to be expected on the Hyper-V server |
|
|
|
Name of Hyper-V’s External Virtual Switch |
|
|
|
|
Number of disks to be created and attached to VM, can be 0 to disable disks, if using RAIDLEVEL, will be set to 4 |
|
|
|
Sets the raid level, affects NUMDISKS. |
|
|
|
Keep VM running after execution, disabled by default |
|
|
|
Use the openQA worker cache if possible to copy images to the svirt host - this means the path specified when invoking |
|
|
|
Worker hostname |
| Variable | Values allowed | Default value | Explanation |
|---|---|---|---|
|
|
|
The unique identifier/name of the vagrant box that should be used for the test. This is the same value as used when running |
|
|
|
URL to the json file that contains the links to the published versions of the vagrant boxes. This is only required for boxes that are hosted in the Open Build Service and not for those hosted on Vagrant Cloud. |
|
|
|
The provider (= VM backend) that will be used by vagrant. |
|
|
|
The maximum time in seconds that |
|
|
|
Directory on the worker in which it expects to find local vagrant boxes. This variable must be set when testing local boxes and can be left undefined otherwise. It is recommended to set this variable on the worker. |
| Variable | Values allowed | Default value | Explanation |
|---|---|---|---|
|
|
|
Number of CPUs |
|
|
|
Quantity of RAM |
| Variable | Values allowed | Default value | Explanation |
|---|---|---|---|
|
|
|
Architecture of the pvm backend |
|
|
|
amount of RAM |
|
|
|
LPAR name to be created |
|
|
|
LPAR id |
|
|
|
Number of disks |
|
|
|
Name of the virtual disk to be attached |
|
|
|
Additional disk to be attached |
|
|
|
Disk size in GB |
|
|
|
Type of NIC |
|
|
|
VLAN to attach to |
|
|
|
A virtula switch to connect to |
|
|
|
Number of CPUS for LPAR |
|
|
|
isos from nfs mount on VIO side to VMLibrary |
|
|
|
Virtual Optical Media ISO |
|
|
|
VNC port |
|
|
|
osauto id |
| Variable | Values allowed | Default value | Explanation |
|---|---|---|---|
|
|
|
Enable direct log capture of mkvterm console, disabled by default |
|
|
Sets the public name of the host |
|
|
|
Sets the remote host to connect tp |
|
|
|
Username for the remote host, defaults to hscroot |
|
|
|
Password for the remote host |
|
|
|
|
LPAR id |
| Variable | Values allowed | Default value | Explanation |
|---|---|---|---|
|
|
Hostname of the gadget’s network. If not set, SSH consoles will be used |
|
|
|
Password for VNC server |
|
|
|
|
VNC Port number |
|
|
|
Color depth for VNC server |
|
|
|
Advertise support for Tight JPEG encoding |
|
|
Don’t use serial |
|
|
|
Video stream URL (in ffmpeg’s syntax) to receive, for example 'udp://@:5004' or '/dev/video0'. Using 'ustreamer:///dev/videoN' will use ustreamer from PiKVM instead of ffmpeg to read '/dev/videoN'. The URL can have '?fps=..' appended to specify desired FPS to capture with. Ustreamer support requires pack("D") working, which rules out openSUSE 15.5’s perl. |
|
|
|
Prefix to prepend to 'ffmpeg' and 'v4l2-ctl' commands, can be used to run them on a different host via SSH. Example: 'ssh root@pikvm'. Note: the value is tokenized on spaces, so avoid their use in command name or any of the parameters. |
|
|
|
|
Buffer containing at least a single PPM frame for video capturing |
|
|
URL to keyboard emulation device. eg. 'http://1.2.3.4/cmd' - see rpi_pico_w_keyboard |
|
|
|
Directory with allowed CMD scripts. Note: This variable should be set in the workers.ini file, otherwise it will be ignored by openQA. |
|
|
|
Shell Script to output serial output (in CMD_DIR) |
|
|
|
Arguments to pass GENERAL_HW_SOL_CMD Shell script |
|
|
|
Shell Command to power on the SUT (in CMD_DIR) |
|
|
|
Arguments to pass GENERAL_HW_POWERON_CMD Shell script |
|
|
|
Shell Command to power off the SUT (in CMD_DIR) |
|
|
|
Arguments to pass GENERAL_HW_POWEROFF_CMD Shell script |
|
|
|
Shell Command to eject CD from SUT (in CMD_DIR). If 'id' is passed to eject_cd, it’s converted to '--id=…' argument. If 'force' is passed to eject_cd, it’s converted to '--force' argument. |
|
|
|
Arguments to pass GENERAL_HW_EJECT_CMD Shell script |
|
|
|
Shell Command to flash a disk image on SUT (in CMD_DIR), optional |
|
|
|
Arguments to pass GENERAL_HW_FLASH_CMD Shell script |
|
|
|
Shell Command to extract disk image from SUT (in CMD_DIR), optional |
|
|
|
Arguments to pass GENERAL_HW_IMAGE_CMD Shell script. The script will get also extra arguments: disk number and file path to save it into. |
|
|
|
Shell Command to control keyboard/mouse of the SUT, should wait for keyboard events on its stdin (in syntax used in 'send_key'), or mouse events as 'mouse_move <x> <y>' or 'mouse_button <buttons-pressed-mask>'. The command should print an "ok" line for each input (or an error message in case of an error). This is used only if GENERAL_HW_VIDEO_STREAM_URL is set. |
|
|
|
Arguments to pass GENERAL_HW_INPUT_CMD Shell script |
|
|
|
EDID to be set on relevant /dev/video device (see 'GENERAL_HW_VIDEO_STREAM_URL'), used directly as an argument for 'v4l2-ctl --set-edit'. Example values: 'type=hdmi', 'file=/some/path'. |
|
|
|
|
Creates HDD with specified size in GiB |
|
|
Filename of HDD image to be used for machine. |
|
|
|
Creates HDD with specified size in GiB for corresponding HDD |
|
|
|
|
Number of disks attached to machine |
|
|
|
Worker hostname |
| Variable | Values allowed | Default value | Explanation |
|---|---|---|---|
|
|
Hostname or IP of the target host |
|
|
|
Password for admin AMT user on target host |
| Variable | Values allowed | Default value | Explanation |
|---|---|---|---|
|
|
|
Worker hostname |
| Variable | Values allowed | Default value | Explanation |
|---|---|---|---|
|
|
|
Enable direct log capture of mkvterm console, disabled by default |
|
|
|
Worker hostname |
|
|
|
Novalink target host to connect to |
|
|
|
Username to authenticate on Novalink host |
|
|
|
Password to authenticate on Novalink host |
|
|
|
LPAR ID on the Novalink target to control |