ansible.builtin.add_host 模块 – 将主机（以及可选的组）添加到 ansible-playbook 内存中的清单

注意

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

摘要 

使用变量在清单中创建新的主机和组，以便在同一 playbook 的后续任务中使用。
接受变量，以便您可以更完整地定义新主机。
此模块也支持 Windows 目标。

注意

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

参数 

参数	注释
groups 别名：group，groupname 列表 / 元素=字符串	要将主机名添加到其中的组。
name 别名：host，hostname 字符串 / 必需	要添加到清单中的主机的主机名/IP，可以包含冒号和端口号。

属性 

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

备注 

注意

参数 host 的别名 name 仅在 Ansible 2.4 及更高版本中可用。
从 Ansible 2.4 开始，inventory_dir 变量现在设置为 None 而不是“全局清单源”，因为您现在可以有多个源。添加了一个示例，说明如何部分恢复以前的行为。
尽管此模块不会更改远程主机，但我们确实提供了 changed 状态，因为它对于尝试跟踪清单更改的人员很有用。
添加的主机不会绕过命令行中的 --limit，因此两者都需要一致才能使它们可用作任务目标。它们仍然可以通过 hostvars 和作为清单的正常部分进行委托。

另请参阅 

另请参阅

ansible.builtin.group_by: 根据事实创建 Ansible 组。

示例 

- name: Add host to group 'just_created' with variable foo=42
  ansible.builtin.add_host:
    name: '{{ ip_from_ec2 }}'
    groups: just_created
    foo: 42

- name: Add host to multiple groups
  ansible.builtin.add_host:
    hostname: '{{ new_ip }}'
    groups:
    - group1
    - group2

- name: Add a host with a non-standard port local to your machines
  ansible.builtin.add_host:
    name: '{{ new_ip }}:{{ new_port }}'

- name: Add a host alias that we reach through a tunnel (Ansible 1.9 and older)
  ansible.builtin.add_host:
    hostname: '{{ new_ip }}'
    ansible_ssh_host: '{{ inventory_hostname }}'
    ansible_ssh_port: '{{ new_port }}'

- name: Add a host alias that we reach through a tunnel (Ansible 2.0 and newer)
  ansible.builtin.add_host:
    hostname: '{{ new_ip }}'
    ansible_host: '{{ inventory_hostname }}'
    ansible_port: '{{ new_port }}'

- name: Ensure inventory vars are set to the same value as the inventory_hostname has (close to pre Ansible 2.4 behaviour)
  ansible.builtin.add_host:
    hostname: charlie
    inventory_dir: '{{ inventory_dir }}'

- name: Add all hosts running this playbook to the done group
  ansible.builtin.add_host:
    name: '{{ item }}'
    groups: done
  loop: "{{ ansible_play_hosts }}"

作者

Ansible Core 团队
Seth Vidal (@skvidal)