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
even without specifying the collections:
keyword.
However, we recommend you use the FQCN 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 1.9
Synopsis
Used to test if an async task has finished, it will aslo work with normal tasks but will issue a warning.
This test checks for the existance of a
finished
key in the input dictionary and that it is1
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 |
---|---|
registered result from an Ansible task |
Examples
# test 'status' to know how to respond
{{ (asynctaskpoll is finished}}
Return Value
Key |
Description |
---|---|
Returns Returned: success |