community.vmware.vmware_host_dns 模块 – 管理 ESXi 主机系统的 DNS 配置

注意

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

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

要安装它,请使用: ansible-galaxy collection install community.vmware

要在 Playbook 中使用它,请指定: community.vmware.vmware_host_dns

概要

  • 此模块可用于配置 ESXi 主机系统上默认 TCP/IP 堆栈的 DNS。

参数

参数

注释

cluster_name

字符串

将从中获取所有主机系统的集群的名称。

如果未指定 esxi_hostname 且您连接到 vCenter,则此参数是必需的。

当您直接连接到 ESXi 主机时,不能使用此参数。

device

字符串

要从中获取 DNS 设置的 VMkernel 网络适配器。

需要通过 DHCP 获取其 IP,静态网络配置与动态 DNS 配置相结合不起作用。

仅在 type=dhcp 的情况下,此参数才是必需的。

dns_servers

列表 / 元素=字符串

要使用的 DNS 服务器列表。

DNS 服务器的顺序很重要,因为它们按顺序依次使用。

domain

字符串

要用于 ESXi 主机的域名。

esxi_hostname

字符串

要使用的主机系统的名称。

如果未指定 cluster_name 且您连接到 vCenter,则此参数是必需的。

当您直接连接到 ESXi 主机时,不能使用此参数。

host_name

字符串

要用于 ESXi 主机的主机名。

配置完整集群时不能使用此参数。

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 的值。

search_domains

列表 / 元素=字符串

解析器要搜索的域列表。

type

字符串 / 必需

DNS 分配的类型。可以是 dhcpstatic

如果设置为 dhcp,则需要将 VMkernel 适配器设置为 DHCP。

选项

  • "dhcp"

  • "static"

username

别名:admin, user

字符串

vSphere vCenter 或 ESXi 服务器的用户名。

如果未在任务中指定该值,则将改为使用环境变量 VMWARE_USER 的值。

validate_certs

布尔值

当 SSL 证书无效时允许连接。当证书不受信任时,设置为 false

如果未在任务中指定该值,则将改为使用环境变量 VMWARE_VALIDATE_CERTS 的值。

选项

  • false

  • true ← (默认)

verbose

布尔值

DNS 服务器配置更改的详细输出。

说明是否添加、删除 DNS 服务器,或者是否更改了 DNS 服务器的顺序。

选项

  • false ← (默认)

  • true

注意

注意

  • 所有模块都需要 API 写入权限,因此不支持免费的 ESXi 许可证。

  • 所有变量和 VMware 对象名称都区分大小写。

示例

- name: Configure DNS for an ESXi host
  community.vmware.vmware_host_dns:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
    type: static
    host_name: esx01
    domain: example.local
    dns_servers:
      - 192.168.1.10
      - 192.168.1.11
    search_domains:
      - subdomain.example.local
      - example.local
  delegate_to: localhost

- name: Configure DNS for all ESXi hosts of a cluster
  community.vmware.vmware_host_dns:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: '{{ cluster_name }}'
    type: static
    domain: example.local
    dns_servers:
      - 192.168.1.10
      - 192.168.1.11
    search_domains:
      - subdomain.example.local
      - example.local
  delegate_to: localhost

- name: Configure DNS via DHCP for an ESXi host
  community.vmware.vmware_host_dns:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
    type: dhcp
    device: vmk0
  delegate_to: localhost

返回值

常见返回值已在此处记录,以下是此模块特有的字段

描述

dns_config_result

字典

关于主机系统 DNS 配置的元数据

返回: 总是

示例: {"esx01.example.local": {"changed": true, "dns_servers": ["192.168.1.10", "192.168.1.11"], "dns_servers_changed": ["192.168.1.12", "192.168.1.13"], "dns_servers_previous": ["192.168.1.10", "192.168.1.11", "192.168.1.12", "192.168.1.13"], "domain": "example.local", "host_name": "esx01", "msg": "DNS 服务器和 搜索域已更改", "search_domains": ["subdomain.example.local", "example.local"], "search_domains_changed": ["subdomain.example.local"], "search_domains_previous": ["example.local"]}}

作者

  • Christian Kotte (@ckotte)

  • Mario Lenz (@mariolenz)