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)

集合链接