theforeman.foreman.wait_for_task 模块 – 等待任务完成

注意

此模块是 theforeman.foreman 集合（版本 4.2.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install theforeman.foreman。您需要其他要求才能使用此模块，请参阅要求了解详细信息。

要在 playbook 中使用它，请指定：theforeman.foreman.wait_for_task。

theforeman.foreman 3.13.0 中的新功能

概要 

等待任务完成

要求 

执行此模块的主机需要满足以下要求。

requests

参数 

参数	注释
password 字符串 / 必需	访问 Foreman 服务器的用户的密码。如果未在任务中指定该值，则将使用环境变量 `FOREMAN_PASSWORD` 的值。
server_url 字符串 / 必需	Foreman 服务器的 URL。如果未在任务中指定该值，则将使用环境变量 `FOREMAN_SERVER_URL` 的值。
task 字符串 / 必需	要等待的任务 ID。
timeout 整数	任务应在多少时间内完成默认值： `60`
username 字符串 / 必需	访问 Foreman 服务器的用户名。如果未在任务中指定该值，则将使用环境变量 `FOREMAN_USERNAME` 的值。
validate_certs 布尔值	是否验证 Foreman 服务器的 TLS 证书。如果未在任务中指定该值，则将使用环境变量 `FOREMAN_VALIDATE_CERTS` 的值。选项 `false` `true` ← (默认)

属性 

属性	支持	描述
check_mode	支持：完全	可以在 check_mode 中运行，并返回更改状态预测，而无需修改实体
diff_mode	支持：完全	在 diff 模式下，将返回有关已更改内容（或可能需要在 check_mode 中更改的内容）的详细信息

示例 

- name: Wait for a task to finish
  theforeman.foreman.wait_for_task:
    server_url: "https://foreman.example.com"
    password: changeme
    username: admin
    task: a03ba49f-4dc2-4ad6-a48b-b271b46f3347
    timeout: 60

- name: Sarch for previously created tasks
  resource_info:
    server_url: "https://foreman.example.com"
    password: changeme
    username: admin
    resource: foreman_tasks
    search: "(label = Actions::Katello::Product::Destroy and action ~ 'Test Product' and state = running)"
  register: tasks

- name: Wait for all found tasks to finish
  wait_for_task:
    server_url: "https://foreman.example.com"
    password: changeme
    username: admin
    task: "{{ item }}"
    timeout: 900
  loop: "{{ tasks.resources | map(attribute='id') | list }}"

返回值 

常见的返回值已记录在此处，以下是此模块独有的字段

键	描述
task 字典	已完成的任务返回：成功

作者

Julien Godin (@JGodin-C2C)