ansible.builtin.success test – check task success

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

Synopsis

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

Aliases: succeeded, successful

Input

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

Parameter

Comments

Input

dictionary / required

registered result from an Ansible task

Examples

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

Return Value

Key

Description

Return value

boolean

Returns True if the task was successfully completed, 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.

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ansible/builtin/success_test.html