异步操作和轮询

默认情况下，Ansible 同步运行任务，保持与远程节点的连接打开，直到操作完成。这意味着，在 playbook 中，默认情况下每个任务都会阻塞下一个任务，后续任务将不会运行，直到当前任务完成。此行为可能会带来挑战。例如，一个任务可能需要比 SSH 会话允许的时间更长才能完成，从而导致超时。或者您可能希望一个长时间运行的进程在后台执行，同时您并发地执行其他任务。异步模式允许您控制长时间运行的任务如何执行。

异步 Ad Hoc 任务

您可以使用 ad hoc 任务在后台执行长时间运行的操作。例如，要在后台异步执行 long_running_operation，超时时间为 (-B) 3600 秒，并且不进行轮询 (-P)

$ ansible all -B 3600 -P 0 -a "/usr/bin/long_running_operation --do-stuff"

要稍后检查作业状态，请使用 async_status 模块，传递在后台运行原始作业时返回的作业 ID

$ ansible web1.example.com -m async_status -a "jid=488359678239.2844"

Ansible 还可以通过轮询自动检查长时间运行的作业的状态。在大多数情况下，Ansible 将在轮询之间保持与远程节点的连接打开。要运行 30 分钟并每 60 秒轮询一次状态

$ ansible all -B 1800 -P 60 -a "/usr/bin/long_running_operation --do-stuff"

轮询模式很智能，因此所有作业将在任何机器上开始轮询之前启动。如果要非常快速地启动所有作业，请务必使用足够高的 --forks 值。在时间限制（以秒为单位）用完 (-B) 后，远程节点上的进程将终止。

异步模式最适合长时间运行的 shell 命令或软件升级。例如，异步运行 copy 模块不会执行后台文件传输。

异步 Playbook 任务

Playbook 也支持异步模式和轮询，并且语法简化。您可以在 playbook 中使用异步模式来避免连接超时或避免阻塞后续任务。playbook 中异步模式的行为取决于 poll 的值。

避免连接超时：poll > 0

如果要在 playbook 中为某个任务设置更长的超时限制，请使用 async 并将 poll 设置为正值。Ansible 仍将阻塞 playbook 中的下一个任务，直到异步任务完成、失败或超时。但是，仅当任务超出您使用 async 参数设置的超时限制时，该任务才会超时。

为了避免任务超时，请指定其最大运行时以及您希望轮询状态的频率

---

- hosts: all
  remote_user: root

  tasks:

  - name: Simulate long running op (15 sec), wait for up to 45 sec, poll every 5 sec
    ansible.builtin.command: /bin/sleep 15
    async: 45
    poll: 5

注意

默认轮询值由 DEFAULT_POLL_INTERVAL 设置设置。异步时间限制没有默认值。如果您省略 “async” 关键字，则任务将同步运行，这是 Ansible 的默认设置。

注意

从 Ansible 2.3 开始，async 不支持检查模式，并且在检查模式下运行时将导致任务失败。请参阅 验证任务：检查模式和差异模式，了解如何在检查模式下跳过任务。

注意

当启用轮询的异步任务完成时，临时异步作业缓存文件（默认情况下在 ~/.ansible_async/ 中）会自动删除。

并发运行任务：poll = 0

如果要在 playbook 中并发运行多个任务，请使用 async 并将 poll 设置为 0。当您设置 poll: 0 时，Ansible 会启动该任务并立即转到下一个任务，而无需等待结果。每个异步任务都会运行，直到它完成、失败或超时（运行时间超过其 async 值）。Playbook 运行结束，而无需检查异步任务。

要异步运行 playbook 任务

---

- hosts: all
  remote_user: root

  tasks:

  - name: Simulate long running op, allow to run for 45 sec, fire and forget
    ansible.builtin.command: /bin/sleep 15
    async: 45
    poll: 0

注意

如果您希望在 playbook 中稍后针对这些相同资源运行其他命令，请不要对需要独占锁的操作（例如 yum 事务）指定 poll 值为 0。

注意

使用更高的 --forks 值将导致更快地启动异步任务。这也会提高轮询的效率。

注意

当使用 poll: 0 运行时，Ansible 不会自动清理异步作业缓存文件。您需要使用 async_status 模块和 mode: cleanup 手动清理此文件。

如果您需要与异步任务同步，可以注册它以获取其作业 ID，并使用 async_status 模块在后面的任务中观察它。例如

- name: Run an async task
  ansible.builtin.yum:
    name: docker-io
    state: present
  async: 1000
  poll: 0
  register: yum_sleeper

- name: Check on an async task
  async_status:
    jid: "{{ yum_sleeper.ansible_job_id }}"
  register: job_result
  until: job_result.finished
  retries: 100
  delay: 10

注意

如果 async: 的值不够高，这将导致“稍后检查”任务失败，因为 async_status: 正在查找的临时状态文件将不会被写入或不再存在

注意

异步 playbook 任务始终返回已更改。如果任务正在使用需要用户使用 changed_when、creates 等注释更改的模块，则应将其添加到以下 async_status 任务中。

要在限制并发运行的任务数的同时运行多个异步任务

#####################
# main.yml
#####################
- name: Run items asynchronously in batch of two items
  vars:
    sleep_durations:
      - 1
      - 2
      - 3
      - 4
      - 5
    durations: "{{ item }}"
  include_tasks: execute_batch.yml
  loop: "{{ sleep_durations | batch(2) | list }}"

#####################
# execute_batch.yml
#####################
- name: Async sleeping for batched_items
  ansible.builtin.command: sleep {{ async_item }}
  async: 45
  poll: 0
  loop: "{{ durations }}"
  loop_control:
    loop_var: "async_item"
  register: async_results

- name: Check sync status
  async_status:
    jid: "{{ async_result_item.ansible_job_id }}"
  loop: "{{ async_results.results }}"
  loop_control:
    loop_var: "async_result_item"
  register: async_poll_results
  until: async_poll_results.finished
  retries: 30

另请参阅

控制 Playbook 执行：策略等

控制 playbook 执行的选项

Ansible Playbook

playbook 简介

交流

有问题吗？需要帮助吗？想分享您的想法？请访问 Ansible 交流指南