New in version 2.3.
Parameter | Choices/Defaults | Comments |
---|---|---|
dns_domain_name
-
|
When
state is domain , the DNS name of the domain to which the targeted Windows host should be joined. |
|
domain_admin_password
-
|
Password for the specified
domain_admin_user . |
|
domain_admin_user
-
/ required
|
Username of a domain admin for the target domain (required to join or leave the domain).
|
|
domain_ou_path
-
added in 2.4 |
The desired OU path for adding the computer object.
This is only used when adding the target host to a domain, if it is already a member then it is ignored.
|
|
hostname
-
|
The desired hostname for the Windows host.
|
|
state
-
|
|
Whether the target host should be a member of a domain or workgroup.
|
workgroup_name
-
|
When
state is workgroup , the name of the workgroup that the Windows host should be in. |
# host should be a member of domain ansible.vagrant; module will ensure the hostname is mydomainclient
# and will use the passed credentials to join domain if necessary.
# Ansible connection should use local credentials if possible.
# If a reboot is required, the second task will trigger one and wait until the host is available.
- hosts: winclient
gather_facts: no
tasks:
- win_domain_membership:
dns_domain_name: ansible.vagrant
hostname: mydomainclient
domain_admin_user: testguy@ansible.vagrant
domain_admin_password: password123!
domain_ou_path: "OU=Windows,OU=Servers,DC=ansible,DC=vagrant"
state: domain
register: domain_state
- win_reboot:
when: domain_state.reboot_required
# Host should be in workgroup mywg- module will use the passed credentials to clean-unjoin domain if possible.
# Ansible connection should use local credentials if possible.
# The domain admin credentials can be sourced from a vault-encrypted variable
- hosts: winclient
gather_facts: no
tasks:
- win_domain_membership:
workgroup_name: mywg
domain_admin_user: '{{ win_domain_admin_user }}'
domain_admin_password: '{{ win_domain_admin_password }}'
state: workgroup
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
|
More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.
Hint
If you notice any issues in this documentation you can edit this document to improve it.