microsoft.ad.domain_controller 模块 – 管理 Windows 主机的域控制器/成员服务器状态
注意
此模块是 microsoft.ad 集合（版本 1.7.1）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install microsoft.ad。
要在 playbook 中使用它，请指定：microsoft.ad.domain_controller。
概要
确保 Windows Server 2012+ 主机配置为域控制器或降级为成员服务器。
如果进行了更改，此模块可能需要在之后使用 ansible.windows.win_reboot 操作。
注意
此模块具有相应的 操作插件。
参数
参数 |
注释 |
|---|---|
Windows 主机上固定磁盘上的目录路径，将在其中创建域数据库。 如果未设置，则默认路径为 |
|
当 state=domain_controller 时，目标 Windows 主机应为其 DC 的域的 DNS 名称。 |
|
指定 domain_admin_user 的密码。 |
|
目标域的域管理员的用户名（提升或降级域控制器所必需）。 |
|
指定本地计算机固定磁盘上目录的完整、非 UNC 路径，该目录将包含域日志文件。 |
|
创建域控制器时是否安装 DNS 服务。 如果未指定，则不会向 选择
|
|
Windows 主机上固定磁盘上的目录路径，将使用从介质安装 有关详细信息，请参阅使用 IFM 安装指南。 |
|
要分配给本地 |
|
是否将域控制器安装为现有域的只读副本。 选择
|
|
如果为 如果为 不能与异步模式一起使用。 选择
|
|
重新启动后等待计算机重新出现并响应测试命令的最长时间（秒）。 此超时时间分别针对重新启动验证和测试命令成功进行评估，因此总超时时间可以是此值的两倍。 默认值： |
|
域控制器的安全模式密码（当 state=domain_controller 时必需）。 |
|
指定可以在其中放置新域控制器的现有站点的名称。 当 read_only=true 时，此选项是必需的。 |
|
目标主机应该是域控制器还是成员服务器。 选择
|
|
Windows 主机上固定磁盘上的目录路径，将在其中创建 Sysvol 文件夹。 如果未设置，则默认路径为 |
属性
属性 |
支持 |
描述 |
|---|---|---|
支持： 完全 |
表示它具有相应的操作插件，因此部分选项可以在控制器上执行 |
|
支持： 部分 支持除 reboot=True 外的所有场景。 |
支持与 |
|
支持： 无 |
强制执行一个不按主机执行的“全局”任务，这将绕过按主机模板化以及串行、节流和其他循环注意事项 条件语句将像使用 此操作在锁定步骤策略之外无法正常工作 |
|
支持： 完全 |
可以在 check_mode 下运行，并返回已更改状态的预测，而无需修改目标。如果不支持，则会跳过该操作。 |
|
支持： 无 |
在 diff 模式下，将返回已更改（或在 check_mode 下可能需要更改）的详细信息 |
|
平台： windows |
可以操作的目标操作系统/系列 |
备注
注意
强烈建议设置 reboot=true，以便让 Ansible 管理主机重启阶段，因为此模块执行的操作会使主机处于一种状态，如果没有重启，Ansible 可能无法在后续任务中重新连接。
此模块必须在 Windows 目标主机上运行。
如果使用 reboot=true，如果主机在域升级之前需要重启，则可能会发生多次重启。此外，请确保在任务中使用完全限定的模块名称，或者 collections 关键字包含此集合。
另请参阅
另请参阅
- microsoft.ad.computer
管理 Active Directory 计算机对象。
- microsoft.ad.domain
确保 Windows 域的存在。
- microsoft.ad.domain_child
在现有 Active Directory 林中管理域子项。
- microsoft.ad.group
管理 Active Directory 组对象。
- microsoft.ad.membership
管理 Windows 主机的域/工作组隶属关系。
- microsoft.ad.user
管理 Active Directory 用户。
- 迁移指南
此模块取代了
ansible.windows.win_domain_controller。请参阅迁移指南了解详细信息。- ansible.windows.win_domain_controller
管理 Windows 主机的域控制器/成员服务器状态。
示例
- name: Ensure a server is a domain controller
microsoft.ad.domain_controller:
dns_domain_name: ansible.vagrant
domain_admin_user: [email protected]
domain_admin_password: password123!
safe_mode_password: password123!
state: domain_controller
reboot: true
- name: Ensure a server is not a domain controller
microsoft.ad.domain_controller:
domain_admin_user: [email protected]
domain_admin_password: password123!
local_admin_password: password123!
state: member_server
reboot: true
- name: Promote server as a read only domain controller
microsoft.ad.domain_controller:
dns_domain_name: ansible.vagrant
domain_admin_user: [email protected]
domain_admin_password: password123!
safe_mode_password: password123!
state: domain_controller
read_only: true
site_name: London
reboot: true
# This scenario is not recommended, use reboot: true when possible
- name: Promote server with custom paths with manual reboot task
microsoft.ad.domain_controller:
dns_domain_name: ansible.vagrant
domain_admin_user: [email protected]
domain_admin_password: password123!
safe_mode_password: password123!
state: domain_controller
sysvol_path: D:\SYSVOL
database_path: D:\NTDS
domain_log_path: D:\NTDS
register: dc_promotion
- name: Reboot after promotion
ansible.windows.win_reboot:
when: dc_promotion.reboot_required
返回值
常见返回值记录在这里，以下是此模块独有的字段
键 |
描述 |
|---|---|
如果进行了需要重启的更改，则为 True。 返回：总是 示例： |