ansible.builtin.async_status 模块 – 获取异步任务的状态

注意

此模块是 ansible-core 的一部分，并包含在所有 Ansible 安装中。在大多数情况下，即使不指定 collections 关键字，您也可以使用短模块名称 async_status。但是，我们建议您使用完全限定的集合名称 (FQCN) ansible.builtin.async_status，以便轻松链接到模块文档并避免与其他可能具有相同模块名称的集合冲突。

概要 

此模块获取异步任务的状态。
此模块也支持 Windows 目标。

注意

此模块具有相应的操作插件。

参数 

参数	注释
jid 字符串 / 必需	作业或任务标识符
mode 字符串	如果为 `status`，则获取状态。如果为 `cleanup`，则清理指定作业 `jid` 的异步作业缓存（默认在 `~/.ansible_async/` 中），而无需等待其完成。选项 `"cleanup"` `"status"` ← （默认）

属性 

属性	支持	描述
action	支持：完全	指示此项具有对应的操作插件，因此可以在控制器上执行部分选项
async	支持：无	支持与 `async` 关键字一起使用
bypass_host_loop	支持：无	强制执行不按主机执行的“全局”任务，这会绕过每个主机的模板和串行、限制和其他循环考虑因素条件表达式的工作方式与使用 `run_once` 时相同，使用的变量将来自第一个可用的主机此操作在锁步策略之外无法正常工作
check_mode	支持：完全在 ansible-core 2.17 中添加	可以在 check_mode 中运行，并返回更改状态预测，而无需修改目标，如果不被支持，则将跳过该操作。
diff_mode	支持：无	在 diff 模式下，将返回有关已更改（或在 check_mode 中可能需要更改）的详细信息
platform	平台： posix，windows	可以对其进行操作的目标操作系统/系列

另请参阅 

另请参阅

异步操作和轮询: 有关如何使用异步操作和轮询的详细信息。

示例 

---
- name: Asynchronous dnf task
  ansible.builtin.dnf:
    name: docker-io
    state: present
  async: 1000
  poll: 0
  register: dnf_sleeper

- name: Wait for asynchronous job to end
  ansible.builtin.async_status:
    jid: '{{ dnf_sleeper.ansible_job_id }}'
  register: job_result
  until: job_result.finished
  retries: 100
  delay: 10

- name: Clean up async file
  ansible.builtin.async_status:
    jid: '{{ dnf_sleeper.ansible_job_id }}'
    mode: cleanup

返回值 

常用返回值在此处记录，以下是此模块特有的字段

键	描述
ansible_job_id 字符串	异步作业 ID 返回：成功示例： `"360874038559.4169"`
erased 字符串	已擦除的作业文件的路径返回：在擦除文件时
finished 整数	异步作业是否已完成 (`1`) 或未完成 (`0`) 返回：始终示例： `1`
started 整数	异步作业是否已启动 (`1`) 或未启动 (`0`) 返回：始终示例： `1`
stderr 字符串	async_wrapper 返回的任何错误返回：始终
stdout 字符串	async_wrapper 返回的任何输出返回：始终

作者

Ansible Core 团队
Michael DeHaan