community.vmware.vmware_host_hyperthreading 模块 – 启用/禁用 ESXi 主机系统的超线程优化

注意

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

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

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

要在剧本中使用它,请指定:community.vmware.vmware_host_hyperthreading

概要

  • 此模块可用于在给定的 vCenter 基础架构中启用或禁用 ESXi 主机系统的超线程优化。

  • 它还会检查超线程是否已激活/停用以及主机是否需要重新启动。

  • 如果超线程已启用但由于处理器容易受到 L1 终端故障 (L1TF) 的影响而处于非活动状态,则模块会通知用户。

参数

参数

注释

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

state

字符串

启用或禁用超线程。

如果更改配置,则需要重新启动 ESXi 主机。

确保在 BIOS 中启用了超线程。否则,它将被启用,但永远不会被激活。

选项

  • "enabled" ← (默认)

  • "disabled"

username

别名:admin、user

字符串

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

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

validate_certs

布尔值

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

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

选项

  • false

  • true ← (默认)

备注

注意

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

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

示例

- name: Enable Hyperthreading for an host system
  community.vmware.vmware_host_hyperthreading:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
    state: enabled
  delegate_to: localhost

- name: Disable Hyperthreading for an host system
  community.vmware.vmware_host_hyperthreading:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
    state: disabled
  delegate_to: localhost

- name: Disable Hyperthreading for all host systems from cluster
  community.vmware.vmware_host_hyperthreading:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: '{{ cluster_name }}'
    state: disabled
  delegate_to: localhost

返回值

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

描述

结果

字典

关于主机系统超线程配置的元数据

返回值:始终

示例: {"esxi01": {"msg": "已为主机'esxi01'启用并激活超线程", "state": "enabled", "state_current": "active"}}

作者

  • Christian Kotte (@ckotte)