vmware_host_active_directory – Joins an ESXi host system to an Active Directory domain or leaves it¶
New in version 2.8.
Synopsis¶
- This module can be used to join or leave an ESXi host to or from an Active Directory domain.
Requirements¶
The below requirements are needed on the host that executes this module.
- python >= 2.6
- PyVmomi
Parameters¶
Examples¶
- name: Join an AD domain
vmware_host_active_directory:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
ad_domain: example.local
ad_user: adjoin
ad_password: Password123$
ad_state: present
validate_certs: no
delegate_to: localhost
- name: Leave AD domain
vmware_host_active_directory:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
ad_state: absent
validate_certs: no
delegate_to: localhost
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Christian Kotte (@ckotte)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.