ansible.windows.setup 模块 – 收集远程主机的 facts

注意

此模块是 ansible.windows 集合 (版本 2.5.0) 的一部分。

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

要安装它，请使用：ansible-galaxy collection install ansible.windows。

要在 playbook 中使用它，请指定：ansible.windows.setup。

概要

  • 此模块由 playbook 自动调用，以收集有关远程主机的有用变量，这些变量可在 playbook 中使用。它也可以由 /usr/bin/ansible 直接执行，以检查主机可用的变量。Ansible 自动提供许多关于系统的 *facts*。

参数

参数

注释

_measure_subset

布尔值

内部使用

选项

  • false ← (默认)

  • true

fact_path

路径

用于本地 Ansible facts 的路径 (*.ps1 或 *.json) - 此目录中的文件将运行 (如果为 ps1) 或读取 (如果为 json)，并将结果添加到返回的 facts 中。

返回的 fact 将以本地文件名 (不包括扩展名后缀) 命名，例如 ansible_my_fact。

gather_subset

列表 / 元素=字符串

如果提供，则将收集的附加 facts 限制为给定的子集。

可以指定一个值列表以指定更大的子集。

值也可以与初始 ! 一起使用，以指定不应收集该特定子集。

要避免收集最小子集，请指定 !all,!min。

要仅收集特定 facts，请使用 !all,!min，并指定特定的 fact 子集。

默认值： ["all"]

gather_timeout

整数

设置单个 fact 收集的默认超时时间（秒）。

默认值： 10

备注

注意

  • 随着版本的更新，将添加更多 Ansible facts。如果安装了 *facter*，则来自这些程序的变量也将被快照到 JSON 文件中，以便在模板中使用。这些变量以 facter_ 为前缀，因此很容易知道它们的来源。所有变量都将传递给调用者。

  • 如果在有限帐户下运行，某些 facts 可能不可用。

  • 有关委托 facts 的更多信息，请查看 https://docs.ansible.org.cn/ansible/latest/user_guide/playbooks_delegation.html#delegating-facts。

另请参阅

另请参阅

ansible.windows.setup

收集远程主机的 facts。

示例

- name: run the setup facts
  ansible.windows.setup:

作者

  • Ansible 核心团队