ansible.builtin.unreachable test – Did task end due to the host was unreachable

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 unreachable. However, we recommend you use the Fully Qualified Collection Name (FQCN) ansible.builtin.unreachable 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 was not able to reach the host for execution
  • This test checks for the existence of a unreachable key in the input dictionary and that it’s value is True

Input

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

Parameter

Comments

Input

dictionary / required

registered result from an Ansible task

Examples

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

Return Value

Key

Description

Return value

boolean

Returns True if the task flagged the host as unreachable, 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/unreachable_test.html