microsoft.ad.domain 模块 – 确保 Windows 域的存在

注意

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

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

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

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

概要 

确保名为 *dns_domain_name* 的域存在且可访问。
如果域不可访问，则会在目标 Windows Server 2012+ 主机上新的林中创建域。
如果进行了更改，此模块可能需要随后使用 ansible.windows.win_reboot 操作。

注意

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

参数 

参数	注释
create_dns_delegation 布尔值	是否创建引用与域控制器一起安装的新 DNS 服务器的 DNS 委派。仅适用于 Active Directory 集成的 DNS。默认值根据环境自动计算。选项 `false` `true`
database_path 路径	Windows 主机固定磁盘上将创建域数据库的目录的路径。如果未设置，则默认路径为 `%SYSTEMROOT%\NTDS`。
dns_domain_name 字符串 / 必需	应该存在且可访问或位于目标 Windows 主机的域的 DNS 名称。
domain_mode 字符串	指定创建新林时第一个域的域功能级别。域功能级别不能低于林功能级别，但可以高于它。默认值会自动计算和设置。当前已知的模式为 `Win2003`、`Win2008`、`Win2008R2`、`Win2012`、`Win2012R2` 或 `WinThreshold`。
domain_netbios_name 字符串	新林中根域的 NetBIOS 名称。要使 NetBIOS 名称对此参数有效，它们必须是 15 个字符或更少的单标签名称，否则将失败。如果未设置此参数，则默认值将根据 domain_name 参数的值自动计算。
forest_mode 字符串	指定新林的林功能级别。 Windows Server 中的默认林功能级别通常与您正在运行的版本相同。当前已知的模式为 `Win2003`、`Win2008`、`Win2008R2`、`Win2012`、`Win2012R2` 或 `WinThreshold`。
install_dns 布尔值	创建域控制器时是否安装 DNS 服务。选项 `false` `true` ← (默认)
log_path 路径	指定此操作日志文件写入到的本地计算机固定磁盘上目录的完全限定非 UNC 路径。如果未设置，则默认路径为 `%SYSTEMROOT%\NTDS`。
reboot 布尔值	如果为 `true`，则如果模块需要重新启动，则会重新启动主机。如果为 `false`，则如果需要重新启动，则不会重新启动主机，而是将 reboot_required 返回值设置为 `true`。这不能与异步模式一起使用。选项 `false` ← (默认) `true`
reboot_timeout 整数在 microsoft.ad 1.7.0 中添加	重新启动后等待机器重新出现并响应测试命令的最大秒数。此超时将分别针对重新启动验证和测试命令成功进行评估，因此总超时时间可能是此值的两倍。默认值： `600`
safe_mode_password 字符串 / 必需	域控制器的安全模式密码。
sysvol_path 路径	Windows 主机固定磁盘上将创建 Sysvol 文件的目录的路径。如果未设置，则默认路径为`%SYSTEMROOT%\SYSVOL`。

属性 

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

备注 

注意

此模块必须在 Windows 目标主机上运行。
如果使用reboot=true，如果主机在域提升之前需要重新启动，则可能会发生多次重新启动。还要确保在任务中使用完全限定的模块名称，或者collections关键字包含此集合。

另请参阅 

另请参阅

microsoft.ad.domain_child: 管理现有 Active Directory 林中的域子域。
microsoft.ad.domain_controller: 管理 Windows 主机的域控制器/成员服务器状态。
microsoft.ad.group: 管理 Active Directory 组对象。
microsoft.ad.membership: 管理 Windows 主机的域/工作组成员身份。
microsoft.ad.user: 管理 Active Directory 用户。
microsoft.ad.computer: 管理 Active Directory 计算机对象。
迁移指南: 此模块替换ansible.windows.win_domain。有关详细信息，请参阅迁移指南。
ansible.windows.win_domain: 确保 Windows 域的存在。

示例 

- name: Create new domain in a new forest on the target host and reboot
  microsoft.ad.domain:
    dns_domain_name: ansible.vagrant
    safe_mode_password: password123!
    reboot: true

- name: Create new Windows domain in a new forest with specific parameters and reboot in post task
  microsoft.ad.domain:
    create_dns_delegation: false
    database_path: C:\Windows\NTDS
    dns_domain_name: ansible.vagrant
    domain_mode: Win2012R2
    domain_netbios_name: ANSIBLE
    forest_mode: Win2012R2
    safe_mode_password: password123!
    sysvol_path: C:\Windows\SYSVOL
  register: domain_install

- name: Reboot host if install requires it
  ansible.windows.win_reboot:
  when: domain_install.reboot_required

返回值 

常见返回值在此处记录，以下是此模块独有的字段。

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

作者

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