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 操作。

注意

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

参数 

参数	注释
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 主机应所在的组的工作组名称。

属性 

属性	支持	描述
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)