ansible.builtin.async_status – Obtain status of asynchronous task¶
Note
This module is part of ansible-base
and included in all Ansible
installations. In most cases, you can use the short module name
async_status even without specifying the collections:
keyword.
Despite that, we recommend you use the FQCN for easy linking to the module
documentation and to avoid conflicting with other collections that may have
the same module name.
New in version 0.5: of ansible.builtin
Synopsis¶
This module gets the status of an asynchronous task.
This module is also supported for Windows targets.
Note
This module has a corresponding action plugin.
Parameters¶
See Also¶
See also
- Asynchronous actions and polling
Detailed information on how to use asynchronous actions and polling.
Examples¶
---
- name: Asynchronous yum task
yum:
name: docker-io
state: present
async: 1000
poll: 0
register: yum_sleeper
- name: Wait for asynchronous job to end
async_status:
jid: '{{ yum_sleeper.ansible_job_id }}'
register: job_result
until: job_result.finished
retries: 100
delay: 10
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Ansible Core Team
Michael DeHaan