:param str cmd: command to run
:param bool ignore_errors: whether not to raise error on command failure
:param vm: vm to run on if running on a guest instead of the host
- :type vm: VM object or None
+ :type vm: :py:class:`virttest.qemu_vm.VM` or None
:param int timeout: amount of seconds to wait for the program to run
:returns: command result output
:rtype: str
:param str process: process to verify if running
:param int timeout: run verification timeout
:param vm: vm to run on if running on a guest instead of the host
- :type vm: VM object or None
+ :type vm: :py:class:`virttest.qemu_vm.VM` or None
:raises: :py:class:`RuntimeError` if process is not running
"""
platform_str = ""
Accept the Intra2net license.
:param vm: vm to run on if running on a guest instead of the host
- :type vm: VM object or None
+ :type vm: :py:class:`virttest.qemu_vm.VM` or None
This is mostly useful for simplified webpage access.
"""
:param wait_online: whether to wait until online
:type wait_online: bool
:param vm: vm to run on if running on a guest instead of the host
- :type vm: VM object or None
+ :type vm: :py:class:`virttest.qemu_vm.VM` or None
.. seealso:: :py:func:`go_offline`, :py:func:`wait_for_online`
"""
:param wait_offline: whether to wait until offline
:type wait_offline: bool
:param vm: vm to run on if running on a guest instead of the host
- :type vm: VM object or None
+ :type vm: :py:class:`virttest.qemu_vm.VM` or None
.. seealso:: :py:func:`go_online`, :py:func:`wait_for_offline`
"""
:param int timeout: maximum timeout for waiting
:param vm: vm to run on if running on a guest instead of the host
- :type vm: VM object or None
+ :type vm: :py:class:`virttest.qemu_vm.VM` or None
"""
_wait_for_online_status('offline', None, timeout, vm)
:type provider_id: int
:param int timeout: maximum timeout for waiting
:param vm: vm to run on if running on a guest instead of the host
- :type vm: VM object or None
+ :type vm: :py:class:`virttest.qemu_vm.VM` or None
"""
_wait_for_online_status('online', provider_id, timeout, vm)
Disable virscan that could block GENERATE and thus all configurations.
:param vm: vm to run on if running on a guest instead of the host
- :type vm: VM object or None
+ :type vm: :py:class:`virttest.qemu_vm.VM` or None
"""
log.info("Disabling virus database update")
unset_cnf("VIRSCAN_UPDATE_CRON", vm=vm)
Transfer all the emails using the guest tool arnied_helper.
:param vm: vm to run on if running on a guest instead of the host
- :type vm: VM object or None
+ :type vm: :py:class:`virttest.qemu_vm.VM` or None
"""
cmd = f"{BIN_ARNIED_HELPER} --transfer-mail"
result = run_cmd(cmd=cmd, vm=vm)
:param int timeout: email transfer timeout
:param vm: vm to run on if running on a guest instead of the host
- :type vm: VM object or None
+ :type vm: :py:class:`virttest.qemu_vm.VM` or None
"""
for i in range(timeout):
if i % 10 == 0:
:param int exec_time: scheduled time of program's execution
:param str optional_args: optional command line arguments
:param vm: vm to run on if running on a guest instead of the host
- :type vm: VM object or None
+ :type vm: :py:class:`virttest.qemu_vm.VM` or None
"""
log.info("Scheduling %s to be executed at %i", program, exec_time)
schedule_dir = "/var/intranator/schedule"
:param int timeout: program run timeout
:param int retries: number of tries to verify that the program is scheduled or running
:param vm: vm to run on if running on a guest instead of the host
- :type vm: VM object or None
+ :type vm: :py:class:`virttest.qemu_vm.VM` or None
"""
log.info("Waiting for program %s to finish with timeout %i",
program, timeout)
:param int timeout: maximum number of seconds to wait
:param vm: vm to run on if running on a guest instead of the host
- :type vm: VM object or None
+ :type vm: :py:class:`virttest.qemu_vm.VM` or None
"""
cmd = f"{BIN_ARNIED_HELPER} --wait-for-arnied-socket " \
f"--wait-for-arnied-socket-timeout {timeout}"
:param bool compact: whether to retrieve compact version of the matched cnf keys
:param int timeout: arnied run verification timeout
:param vm: vm to run on if running on a guest instead of the host
- :type vm: VM object or None
+ :type vm: :py:class:`virttest.qemu_vm.VM` or None
:returns: extracted information via the regex
:rtype: Match object
:param str value: cnf value of the cnf key
:param int timeout: arnied run verification timeout
:param vm: vm to run on if running on a guest instead of the host
- :type vm: VM object or None
+ :type vm: :py:class:`virttest.qemu_vm.VM` or None
:returns: the cnf id or -1 if no such cnf variable
:rtype: int
"""
:param str data: "data" field by which the resulting CNF_VAR list should be filtered
:param int timeout: arnied run verification timeout
:param vm: vm to run on if running on a guest instead of the host
- :type vm: VM object or None
+ :type vm: :py:class:`virttest.qemu_vm.VM` or None
:returns: the resulting "cnfvar" structure or None if the lookup fails or the result could not be parsed
:rtype: cnfvar option
"""
:param str data: "data" field by which the resulting CNF_VAR list should be filtered
:param int timeout: arnied run verification timeout
:param vm: vm to run on if running on a guest instead of the host
- :type vm: VM object or None
+ :type vm: :py:class:`virttest.qemu_vm.VM` or None
:returns: the cnf id or -1 if no such cnf variable
:rtype: int
"""
:param int instance: "instance" of that variable to unset
:param int timeout: arnied run verification timeout
:param vm: vm to run on if running on a guest instead of the host
- :type vm: VM object or None
+ :type vm: :py:class:`virttest.qemu_vm.VM` or None
"""
wait_for_arnied(timeout=timeout, vm=vm)
:param str kind: "json" or "cnf"
:param int timeout: arnied run verification timeout
:param vm: vm to run on if running on a guest instead of the host
- :type vm: VM object or None
+ :type vm: :py:class:`virttest.qemu_vm.VM` or None
:raises: :py:class:`ConfigError` if cannot apply file
The config files must be provided and are always expected to be found on
:param str kind: "json" or "cnf"
:param int timeout: arnied run verification timeout
:param vm: vm to run on if running on a guest instead of the host
- :type vm: VM object or None
+ :type vm: :py:class:`virttest.qemu_vm.VM` or None
The config files must be provided and are always expected to be found on
the host. If these are absolute paths, they will be kept as is or
:param str kind: "json", "cnf", or "raw"
:param int timeout: arnied run verification timeout
:param vm: vm to run on if running on a guest instead of the host
- :type vm: VM object or None
+ :type vm: :py:class:`virttest.qemu_vm.VM` or None
:raises: :py:class:`ValueError` if `kind` is not an acceptable value
:raises: :py:class:`ConfigError` if cannot apply file