timedout

Collection Note

This module is part of the ansible.builtin collection. To install the collection, use:

ansible-galaxy collection install ansible.builtin

Added in version 2.18.

Synopsis

• Tests if task finished ended due to a time out

Parameters

Parameter	Defaults / Choices	Comments
_input dictionary required		registered result from an Ansible task

Examples

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

Return Values

Key	Data Type	Description	Returned
_value	dict	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.

Authors

• Ansible Core