ansible.builtin.meta 模块 – 执行 Ansible ‘动作’

注意

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

概要 

Meta 任务是一种特殊的任务，可以影响 Ansible 内部执行或状态。
Meta 任务可以在 playbook 中的任何位置使用。
此模块也支持 Windows 目标。

参数 

参数

注释

free_form

字符串 / 必需

此模块接受一个自由格式的命令，作为字符串。没有名为“free form”的实际选项。请参阅示例！

flush_handlers 使 Ansible 运行到目前为止已通知的任何处理程序任务。Ansible 在某些点内部插入这些任务，以隐式触发处理程序运行（在 pre/post 任务、最终角色执行和 play 的主要任务部分之后）。

refresh_inventory（在 Ansible 2.0 中添加）强制重新加载清单，这意味着在动态清单脚本的情况下，它们将被重新执行。如果动态清单脚本正在使用缓存，Ansible 无法知道这一点，并且无法刷新它（您可以禁用缓存，或者，如果适用于您的特定清单数据源（例如 aws），则可以使用清单插件而不是清单脚本）。当创建额外的 host 并且用户希望使用它们而不是使用 ansible.builtin.add_host 模块时，这主要很有用。

noop（在 Ansible 2.0 中添加）实际上“不执行任何操作”。它主要在内部使用，不建议一般使用。

clear_facts（在 Ansible 2.1 中添加）导致清除 play 的 host 列表中指定的 host 的收集的事实，包括事实缓存。

clear_host_errors（在 Ansible 2.1 中添加）清除 play 的 host 列表中指定的 host 的失败状态（如果有）。

end_play（在 Ansible 2.2 中添加）导致 play 结束，而不会使 host 失败。请注意，这会影响所有 host。

reset_connection（在 Ansible 2.3 中添加）中断持久连接（即 ssh + 控制保持）

end_host（在 Ansible 2.8 中添加）是 end_play 的每个 host 变体。导致当前 host 的 play 结束，而不会使其失败。

end_batch（在 Ansible 2.12 中添加）导致当前批处理（请参阅 serial）结束，而不会使 host 失败。请注意，使用 serial=0 或未定义，其行为与 end_play 相同。

选项

"clear_facts"
"clear_host_errors"
"end_host"
"end_play"
"flush_handlers"
"noop"
"refresh_inventory"
"reset_connection"
"end_batch"

属性 

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

注释 

注意

clear_facts 将使用 cacheable=True 从 ansible.builtin.set_fact 中删除持久化事实，但不会删除当前运行所创建的当前主机变量。
在 Ansible 2.11 之前的版本中，不支持跳过带有标签的 ansible.builtin.meta 任务。

另请参阅 

另请参阅

ansible.builtin.assert: 断言给定表达式为真。
ansible.builtin.fail: 使用自定义消息失败。

示例 

# Example showing flushing handlers on demand, not at end of play
- ansible.builtin.template:
    src: new.j2
    dest: /etc/config.txt
  notify: myhandler

- name: Force all notified handlers to run at this point, not waiting for normal sync points
  ansible.builtin.meta: flush_handlers

# Example showing how to refresh inventory during play
- name: Reload inventory, useful with dynamic inventories when play makes changes to the existing hosts
  cloud_guest:            # this is fake module
    name: newhost
    state: present

- name: Refresh inventory to ensure new instances exist in inventory
  ansible.builtin.meta: refresh_inventory

# Example showing how to clear all existing facts of targeted hosts
- name: Clear gathered facts from all currently targeted hosts
  ansible.builtin.meta: clear_facts

# Example showing how to continue using a failed target
- name: Bring host back to play after failure
  ansible.builtin.copy:
    src: file
    dest: /etc/file
  remote_user: imightnothavepermission

- ansible.builtin.meta: clear_host_errors

# Example showing how to reset an existing connection
- ansible.builtin.user:
    name: '{{ ansible_user }}'
    groups: input

- name: Reset ssh connection to allow user changes to affect 'current login user'
  ansible.builtin.meta: reset_connection

# Example showing how to end the play for specific targets
- name: End the play for hosts that run CentOS 6
  ansible.builtin.meta: end_host
  when:
  - ansible_distribution == 'CentOS'
  - ansible_distribution_major_version == '6'

作者

Ansible 核心团队