successful¶

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¶

Tests if task finished successfully, opposite of C(failed).
This test checks for the existence of a C(failed) key in the input dictionary and that it is V(False) if present

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

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

Key	Data Type	Description	Returned
_value	boolean	Returns V(True) if the task was successfully completed, V(False) otherwise.