microsoft.ad.membership 模块 – 管理 Windows 主机的域/工作组成员身份

注意

此模块是 microsoft.ad 集合 (版本 1.7.1) 的一部分。

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

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

要在剧本中使用它，请指定：microsoft.ad.membership。

概要 

管理 Windows 主机的域成员身份或工作组成员身份。也支持主机名更改。
如果进行了更改，此模块可能需要随后使用 ansible.windows.win_reboot 操作。

注意

此模块具有相应的 action 插件。

参数 

参数	注释
dns_domain_name 字符串	当 state=domain 时，这是目标 Windows 主机应加入的域的 DNS 名称。当指定 offline_join_blob 时，不能设置此参数。
domain_admin_password 字符串	指定 `domain_admin_user` 的密码。除非指定 offline_join_blob，否则必须设置此参数。
domain_admin_user 字符串	目标域的域管理员用户名（加入或离开域所需）。除非指定 offline_join_blob，否则必须设置此参数。
domain_ou_path 字符串	添加计算机对象的所需 OU 路径。仅在将目标主机添加到域时使用，如果它已经是成员，则忽略它。当指定 offline_join_blob 时，不能设置此参数。
domain_server 字符串在 microsoft.ad 1.7.0 中添加	指定加入域时要使用的域控制器。
hostname 字符串	Windows 主机的所需主机名。当指定 offline_join_blob 时，不能设置此参数。
offline_join_blob 字符串	将主机加入域时要使用的域脱机加入 blob 的 base64 字符串。此 blob 可以由 microsoft.ad.offline_join 模块生成。此参数与 domain_admin_user、dns_domain_name 和 domain_ou_path 互斥。它也不能与 hostname 一起使用。
reboot 布尔值	如果为 `true`，则如果模块需要重新启动，则将重新启动主机。如果为 `false`，则如果需要重新启动，则不会重新启动主机，而是将 reboot_required 返回值设置为 `true`。此参数不能与异步模式一起使用。选项 `false` ← (默认) `true`
reboot_timeout 整数在 microsoft.ad 1.7.0 中添加	重新启动后等待机器再次出现并响应测试命令的最大秒数。此超时分别针对重新启动验证和测试命令成功进行评估，因此总超时可能是此值的两倍。默认值： `600`
state 字符串 / 必需	目标主机应该是域成员还是工作组成员。当 state=domain 时，必须设置 dns_domain_name、domain_admin_user 和 domain_admin_password 或 offline_join_blob。当 state=workgroup 时，必须设置 workgroup_name。选项 `"domain"` `"workgroup"`
workgroup_name 字符串	当 state=workgroup 时，这是 Windows 主机所在的 workgroup 名称。

属性 

属性	支持	描述
action	支持：完全支持	指示它具有相应的 action 插件，因此某些选项部分可以在控制器上执行
async	支持：部分支持除 reboot=True 外，所有场景均支持。	支持与 `async` 关键字一起使用
bypass_host_loop	支持：不支持	强制执行不按主机执行的“全局”任务，这将绕过按主机模板化以及串行、节流和其他循环考虑因素条件将按使用 `run_once` 的方式工作，使用的变量将来自第一个可用的主机此操作通常无法在步调一致的策略之外正常工作
check_mode	支持：完全支持	可以在 check_mode 下运行并返回更改状态预测，而无需修改目标，如果不支持，则将跳过操作。
diff_mode	支持：完全支持	在 diff 模式下，将返回有关已更改内容（或可能需要在 check_mode 下更改的内容）的详细信息
platform	平台： windows	可以对其进行操作的目标操作系统/系列

备注 

注意

此模块必须在 Windows 目标主机上运行。
如果使用reboot=true并将域更改为工作组，则连接帐户必须是本地用户，该用户在主机取消加入域后可以连接到主机。还要确保在任务中使用完全限定的模块名称，或者collections关键字包含此集合。

另请参见 

另请参见

microsoft.ad.domain: 确保 Windows 域的存在。
microsoft.ad.domain_controller: 管理 Windows 主机的域控制器/成员服务器状态。
microsoft.ad.group: 管理 Active Directory 组对象。
microsoft.ad.offline_join: 获取脱机域加入 BLOB。
microsoft.ad.user: 管理 Active Directory 用户。
microsoft.ad.computer: 管理 Active Directory 计算机对象。
ansible.windows.win_group: 添加和删除本地组。
ansible.windows.win_group_membership: 管理 Windows 本地组成员资格。
ansible.windows.win_user: 管理本地 Windows 用户帐户。
迁移指南: 此模块替换ansible.windows.win_domain_membership。有关详细信息，请参见迁移指南。
ansible.windows.win_domain_membership: 管理 Windows 主机的域/工作组成员资格。

示例 

- name: join host to ansible.vagrant with automatic reboot
  microsoft.ad.membership:
    dns_domain_name: ansible.vagrant
    hostname: mydomainclient
    domain_admin_user: [email protected]
    domain_admin_password: password123!
    domain_ou_path: "OU=Windows,OU=Servers,DC=ansible,DC=vagrant"
    state: domain
    reboot: true

- name: join host to workgroup with manual reboot in later task
  microsoft.ad.membership:
    workgroup_name: mywg
    domain_admin_user: '{{ win_domain_admin_user }}'
    domain_admin_password: '{{ win_domain_admin_password }}'
    state: workgroup
  register: workgroup_res

- name: reboot host after joining workgroup
  ansible.windows.win_reboot:
  when: workgroup_res.reboot_required

返回值 

常用返回值已在此处记录，以下是此模块特有的字段

键	描述
reboot_required 布尔值	如果进行了需要重新启动的更改，则为 True。返回：始终示例：`true`

作者

Matt Davis (@nitzmahone)
Jordan Borean (@jborean93)