community.vmware.vmware_host_active_directory – Joins an ESXi host system to an Active Directory domain or leaves it
Note
This plugin is part of the community.vmware collection (version 1.7.0).
To install it use: ansible-galaxy collection install community.vmware.
To use it in a playbook, specify: community.vmware.vmware_host_active_directory.
The below requirements are needed on the host that executes this module.
| Parameter |
Choices/Defaults |
Comments |
|
ad_domain
string
|
|
AD Domain to join.
aliases: domain, domain_name
|
|
ad_password
string
|
|
Password for AD domain join.
|
|
ad_state
string
|
Choices:
- present
absent ←
|
Whether the ESXi host is joined to an AD domain or not.
aliases: state
|
|
ad_user
string
|
|
Username for AD domain join.
|
|
cluster_name
string
|
|
Name of the cluster from which all host systems will be used.
This parameter is required if esxi_hostname is not specified.
|
|
esxi_hostname
string
|
|
Name of the host system to work with.
This parameter is required if cluster_name is not specified.
|
|
hostname
string
|
|
The hostname or IP address of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
Environment variable support added in Ansible 2.6.
|
|
password
string
|
|
The password of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
Environment variable support added in Ansible 2.6.
aliases: pass, pwd
|
|
port
integer
|
Default:
443
|
The port number of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
Environment variable support added in Ansible 2.6.
|
|
proxy_host
string
|
|
Address of a proxy that will receive all HTTPS requests and relay them.
The format is a hostname or a IP.
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
|
|
proxy_port
integer
|
|
Port of the HTTP proxy that will receive all HTTPS requests and relay them.
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_PORT will be used instead.
|
|
username
string
|
|
The username of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
Environment variable support added in Ansible 2.6.
aliases: admin, user
|
|
validate_certs
boolean
|
|
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
Environment variable support added in Ansible 2.6.
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.
|
- name: Join an AD domain
community.vmware.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
delegate_to: localhost
- name: Leave AD domain
community.vmware.vmware_host_active_directory:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
ad_state: absent
delegate_to: localhost
Common return values are documented here, the following are the fields unique to this module:
| Key |
Returned |
Description |
|
results
dictionary
|
always |
metadata about host system's AD domain join state
Sample:
{'esxi01': {'ad_state': 'present', 'ad_state_current': 'present', 'ad_state_previous': 'absent', 'changed': True, 'domain': 'example.local', 'membership_state': 'ok', 'msg': 'Host joined to AD domain'}}
|
