Skip to content

finished

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 1.9.

Synopsis

  • Used to test if an async task has finished, it will also work with normal tasks but will issue a warning.
  • This test checks for the existence of a C(finished) key in the input dictionary and that it is V(1) if present

Parameters

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

Examples

# test 'status' to know how to respond
{{ (asynctaskpoll is finished}}

Return Values

Key Data Type Description Returned
_value boolean Returns V(True) if the async task has finished, V(False) otherwise.

Authors

  • Ansible Core