ansible.windows.async_status module – Obtain status of asynchronous task
Note
This module is part of the ansible.windows collection (version 2.5.0).
You might already have this collection installed if you are using the ansible
package. It is not included in ansible-core
. To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install ansible.windows
.
To use it in a playbook, specify: ansible.windows.async_status
.
Synopsis
- This module gets the status of an asynchronous task.
Parameters
Parameter | Comments |
---|---|
jid string / required | Job or task identifier |
mode string | If If Choices:
|
Attributes
Attribute | Support | Description |
---|---|---|
action | Support: full | Indicates this has a corresponding action plugin so some parts of the options can be executed on the controller |
async | Support: none | Supports being used with the |
bypass_host_loop | Support: none | Forces a ‘global’ task that does not execute per host, this bypasses per host templating and serial, throttle and other loop considerations Conditionals will work as if This action will not work normally outside of lockstep strategies |
check_mode | Support: full added in ansible.windows 2.4.0 | Can run in check_mode and return changed status prediction without modifying target, if not supported the action will be skipped. |
diff_mode | Support: none | Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode |
platform | Platform: windows | Target OS/families that can be operated against |
See Also
See also
- ansible.builtin.async_status
-
Obtain status of asynchronous task.
Examples
- name: Asynchronous yum task ansible.windows.win_command: my.exe async: 1000 poll: 0 register: long_cmd - name: Wait for asynchronous job to end ansible.builtin.async_status: jid: '{{ long_cmd.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:
Key | Description |
---|---|
ansible_job_id string | The asynchronous job id Returned: success Sample: |
erased string | Path to erased job file Returned: when file is erased |
finished integer | Whether the asynchronous job has finished ( Returned: always Sample: |
started integer | Whether the asynchronous job has started ( Returned: always Sample: |
stderr string | Any errors returned by async_wrapper Returned: always |
stdout string | Any output returned by async_wrapper Returned: always |
Collection links
© 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/windows/async_status_module.html