community.vmware.vmware_host_active_directory 模块 – 将 ESXi 主机系统加入到 Active Directory 域或从中退出

注意

此模块是 community.vmware 集合（版本 5.2.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.vmware。

要在 playbook 中使用它，请指定：community.vmware.vmware_host_active_directory。

概要 

此模块可用于将 ESXi 主机加入或退出 Active Directory 域。

参数 

参数	注释
ad_domain 别名：domain, domain_name 字符串	要加入的 AD 域。默认： `""`
ad_password 字符串	用于加入 AD 域的密码。默认： `""`
ad_state 别名：state 字符串	ESXi 主机是否已加入 AD 域。选项 `"present"` `"absent"` ← (默认)
ad_user 字符串	用于加入 AD 域的用户名。默认： `""`
cluster_name 字符串	将从中使用所有主机系统的集群的名称。如果未指定 `esxi_hostname`，则此参数是必需的。
esxi_hostname 字符串	要使用的主机系统的名称。如果未指定 `cluster_name`，则此参数是必需的。
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。如果未在任务中指定该值，则将使用环境变量 `VMWARE_HOST` 的值。
password 别名：pass, pwd 字符串	vSphere vCenter 或 ESXi 服务器的密码。如果未在任务中指定该值，则将使用环境变量 `VMWARE_PASSWORD` 的值。
port 整数	vSphere vCenter 或 ESXi 服务器的端口号。如果未在任务中指定该值，则将使用环境变量 `VMWARE_PORT` 的值。默认： `443`
proxy_host 字符串	将接收所有 HTTPS 请求并转发它们的代理的地址。格式为主机名或 IP。如果未在任务中指定该值，则将使用环境变量 `VMWARE_PROXY_HOST` 的值。
proxy_port 整数	将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。如果未在任务中指定该值，则将使用环境变量 `VMWARE_PROXY_PORT` 的值。
username 别名：admin, user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。如果未在任务中指定该值，则将使用环境变量 `VMWARE_USER` 的值。
validate_certs 布尔值	当 SSL 证书无效时允许连接。当证书不受信任时，设置为 `false`。如果未在任务中指定该值，则将使用环境变量 `VMWARE_VALIDATE_CERTS` 的值。选项 `false` `true` ← (默认)

说明 

注意

所有模块都需要 API 写入访问权限，因此在免费 ESXi 许可证上不受支持。
所有变量和 VMware 对象名称都区分大小写。

示例 

- 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

返回值 

常见的返回值记录在这里，以下是此模块独有的字段

键	描述
结果字典	有关主机系统 AD 域加入状态的元数据返回：始终示例: `{"esxi01": {"ad_state": "present", "ad_state_current": "present", "ad_state_previous": "absent", "changed": true, "domain": "example.local", "membership_state": "ok", "msg": "主机已加入 AD 域"}}`

作者

Christian Kotte (@ckotte)