ansible.builtin.started test – Was async task started

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 started. However, we recommend you use the Fully Qualified Collection Name (FQCN) ansible.builtin.started 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 check if an async task has started, will also work with non async tasks but will issue a warning.

  • This test checks for the existence of a started 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.started or is not ansible.builtin.started.

Parameter

Comments

Input

dictionary / required

registered result from an Ansible task

Examples

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

Return Value

Key

Description

Return value

boolean

Returns True if the task has started, False otherwise.

Returned: success

Authors

  • Ansible Core