Ansible Core 文档

ansible.builtin.set_stats 模块 – 定义并显示当前 Ansible 运行的统计信息

注意

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

概要 

此模块允许在当前 Ansible 运行中设置/累积统计信息，可以按主机设置，也可以为运行中的所有主机设置。
此模块也支持 Windows 目标。

注意

此模块具有相应的action 插件。

参数 

参数	说明
aggregate 布尔值	提供的的值是聚合到现有统计信息 `true` 还是替换它 `false`。选择 `false` `true` ← (默认)
data 字典 / 必需	一个字典，其中每个键代表您要跟踪的统计信息（或变量）。
per_host 布尔值	统计信息是按主机还是为运行中的所有主机设置。选择 `false` ← (默认) `true`

属性 

属性	支持	描述
action	支持：部分虽然 action 插件确实完成了一些工作，但它依赖于核心引擎来实际创建变量，这部分无法被覆盖	表示它有一个对应的 action 插件，因此可以在控制器上执行部分选项
async	支持：无	支持与 `async` 关键字一起使用
become	支持：无	可以与 become 关键字一起使用
bypass_host_loop	支持：无	强制执行不按主机执行的“全局”任务，这会绕过按主机模板化、串行、节流和其他循环考虑条件语句的工作方式就像使用了 `run_once` 一样，使用的变量将来自第一个可用的主机此 action 通常在锁步策略之外不起作用
bypass_task_loop	支持：无	这些任务会忽略 `loop` 和 `with_` 关键字
check_mode	支持：完全	可以在 check_mode 中运行，并返回已更改的状态预测，而不会修改目标，如果不支持，则跳过该 action。
connection	支持：无	使用目标配置的连接信息在其上执行代码
core	支持：部分虽然此 action 的部分在核心中实现，但其他部分仍然作为普通插件可用，并且可以部分覆盖	这是一个“核心引擎”功能，不是像大多数任务 action 那样实现的，因此无法通过插件系统以任何方式覆盖。
delegation	支持：无	可以与 delegate_to 和相关关键字结合使用
diff_mode	支持：无	在 diff 模式下，将返回有关已更改（或可能需要在 check_mode 中更改）的详细信息
ignore_conditional	支持：无	该 action 不受条件执行的约束，因此它将忽略 `when:` 关键字
platform	平台：全部	可以对其进行操作的目标操作系统/系列
tags	支持：完全	允许使用“tags”关键字来控制此 action 的选择以进行执行
until	支持：完全	表示此 action 是否遵守 until/retry/poll 关键字

备注 

注意

为了显示自定义统计信息，您必须在 ansible.cfg 的 [defaults] 部分中设置 show_custom_stats 或通过将环境变量 ANSIBLE_SHOW_CUSTOM_STATS 定义为 true。有关详细信息，请参阅 ansible.builtin.default 回调插件。

示例 

- name: Aggregating packages_installed stat per host
  ansible.builtin.set_stats:
    data:
      packages_installed: 31
    per_host: yes

- name: Aggregating random stats for all hosts using complex arguments
  ansible.builtin.set_stats:
    data:
      one_stat: 11
      other_stat: "{{ local_var * 2 }}"
      another_stat: "{{ some_registered_var.results | map(attribute='ansible_facts.some_fact') | list }}"
    per_host: no

- name: Setting stats (not aggregating)
  ansible.builtin.set_stats:
    data:
      the_answer: 42
    aggregate: no

作者

Brian Coca (@bcoca)

集合链接