ansible.windows.win_domain module – Ensures the existence of a Windows domain
Note
This module is part of the ansible.windows collection (version 2.5.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.win_domain.
DEPRECATED
- Removed in:
version 3.0.0
- Why:
This module has been moved into the
microsoft.adcollection.- Alternative:
Use the microsoft.ad.domain module instead.
Synopsis
Ensure that the domain named by
dns_domain_nameexists and is reachable.If the domain is not reachable, the domain is created in a new forest on the target Windows Server 2012R2+ host.
This module may require subsequent use of the ansible.windows.win_reboot action if changes are made.
Parameters
Parameter |
Comments |
|---|---|
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. Choices:
|
|
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 |
|
The DNS name of the domain which should exist and be reachable or reside on the target Windows host. |
|
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. Choices:
|
|
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. |
|
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. Choices:
|
|
Whether to install the DNS service when creating the domain controller. Choices:
|
|
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 |
|
Safe mode password for the domain controller. |
|
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 |
See Also
See also
- ansible.windows.win_domain_controller
Manage domain controller/member server state for a Windows host.
- community.windows.win_domain_computer
Manage computers in Active Directory.
- community.windows.win_domain_group
Creates, modifies or removes domain groups.
- ansible.windows.win_domain_membership
Manage domain/workgroup membership for a Windows host.
- community.windows.win_domain_user
Manages Windows Active Directory user accounts.
Examples
- 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: 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
True if changes were made that require a reboot. Returned: always Sample: |
Status
This module will be removed in version 3.0.0. [deprecated]
For more information see DEPRECATED.