Ansible 社区文档

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

注意

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

概要 

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

注意

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

参数 

参数	注释
aggregate 布尔值	指定提供的值是聚合到现有统计信息 `true` 还是替换它 `false`。选项 `false` `true` ←（默认）
data 字典 / 必需	一个字典，其中每个键都代表要跟踪的统计信息（或变量）。
per_host 布尔值	指定统计信息是按主机还是针对运行中的所有主机。选项 `false` ←（默认） `true`

属性 

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

集合链接