ansible.builtin.timedout test – did the task time out

Note

This test plugin is part of ansible-core and included in all Ansible installations. In most cases, you can use the short plugin name timedout. However, we recommend you use the Fully Qualified Collection Name (FQCN) ansible.builtin.timedout for easy linking to the plugin documentation and to avoid conflicting with other collections that may have the same test plugin name.

New in ansible-core 2.18

Synopsis

  • Tests if task finished ended due to a time out

Input

This describes the input of the test, the value before is ansible.builtin.timedout or is not ansible.builtin.timedout.

Parameter

Comments

Input

dictionary / required

registered result from an Ansible task

Examples

# test 'status' to know how to respond
{{ taskresults is timedout }}

Return Value

Key

Description

Return value

dictionary

A dictionary with 2 keys ‘frame’ showing the ‘frame of code’ in which the timeout occurred and ‘period’ with the time limit that was enforced.

Returned: success

Authors

  • Ansible Core

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.