Note
This plugin is part of the ansible.windows collection.
To install it use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_domain.
dns_domain_name exists and is reachable.| Parameter | Choices/Defaults | Comments |
|---|---|---|
| create_dns_delegation boolean |
| Whether to create a DNS delegation that references the new DNS server that you install along with the domain controller. Valid for Active Directory-integrated DNS only. The default is computed automatically based on the environment. |
| database_path path | The path to a directory on a fixed disk of the Windows host where the domain database will be created. If not set then the default path is %SYSTEMROOT%\NTDS. | |
| dns_domain_name string / required | The DNS name of the domain which should exist and be reachable or reside on the target Windows host. | |
| domain_mode string |
| Specifies the domain functional level of the first domain in the creation of a new forest. The domain functional level cannot be lower than the forest functional level, but it can be higher. The default is automatically computed and set. |
| domain_netbios_name string | The NetBIOS name for the root domain in the new forest. For NetBIOS names to be valid for use with this parameter they must be single label names of 15 characters or less, if not it will fail. If this parameter is not set, then the default is automatically computed from the value of the domain_name parameter. | |
| forest_mode string |
| Specifies the forest functional level for the new forest. The default forest functional level in Windows Server is typically the same as the version you are running. |
| install_dns boolean |
| Whether to install the DNS service when creating the domain controller. |
| log_path path | Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer where the log file for this operation is written. If not set then the default path is %SYSTEMROOT%\NTDS. | |
| safe_mode_password string / required | Safe mode password for the domain controller. | |
| sysvol_path path | The path to a directory on a fixed disk of the Windows host where the Sysvol file will be created. If not set then the default path is %SYSTEMROOT%\SYSVOL. |
See also
The official documentation on the ansible.windows.win_domain_controller module.
The official documentation on the community.windows.win_domain_computer module.
The official documentation on the community.windows.win_domain_group module.
The official documentation on the ansible.windows.win_domain_membership module.
The official documentation on the community.windows.win_domain_user module.
- name: Create new domain in a new forest on the target host
ansible.windows.win_domain:
dns_domain_name: ansible.vagrant
safe_mode_password: password123!
- name: Create new Windows domain in a new forest with specific parameters
ansible.windows.win_domain:
create_dns_delegation: no
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
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| reboot_required boolean | always | True if changes were made that require a reboot. Sample: True |
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ansible/windows/win_domain_module.html