ansible.builtin.finished test – Did async task finish

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 finished. However, we recommend you use the Fully Qualified Collection Name (FQCN) ansible.builtin.finished for easy linking to the plugin documentation and to avoid conflicting with other collections that may have the same test plugin name.

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 finished key in the input dictionary and that it is 1 if present

Input

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

Parameter

Comments

Input

dictionary / required

registered result from an Ansible task

Examples

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

Return Value

Key

Description

Return value

boolean

Returns True if the async task has finished, False otherwise.

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.