community.vmware.vmware_host_kernel_manager 模块 – 管理 ESXi 主机上的内核模块选项

注意

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

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

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

要在 playbook 中使用它,请指定:community.vmware.vmware_host_kernel_manager

概要

  • 此模块可用于管理 ESXi 主机上的内核模块选项。

  • 指定时,将配置范围内所有连接的 ESXi 主机。

  • 如果主机在配置时未连接,则会在输出中标记为未连接。

  • 内核模块选项可能需要重新启动才能生效,此处不涉及此问题。

  • 您可以使用 ansible.builtin.rebootcommunity.vmware.vmware_host_powerstate 模块重新启动所有 ESXi 主机系统。

参数

参数

注释

cluster_name

字符串

要操作的 VMware 集群的名称。

将配置此集群中的所有 ESXi 主机。

如果未指定 esxi_hostname,则此参数为必需项。

esxi_hostname

字符串

要操作的 ESXi 主机的名称。

如果未指定 cluster_name,则此参数为必需项。

hostname

字符串

vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。

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

kernel_module_name

字符串 / 必需

要配置的内核模块的名称。

kernel_module_option

字符串 / 必需

指定的配置将应用于给定的模块。

这些值以键=值对的形式指定,当存在多个选项时,使用空格分隔。

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: Configure IPv6 to be off via tcpip4 kernel module
  community.vmware.vmware_host_kernel_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
    kernel_module_name: "tcpip4"
    kernel_module_option: "ipv6=0"

- name: Using cluster_name, configure vmw_psp_rr options
  community.vmware.vmware_host_kernel_manager:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: '{{ virtual_cluster_name }}'
    kernel_module_name: "vmw_psp_rr"
    kernel_module_option: "maxPathsPerDevice=2"

返回值

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

描述

host_kernel_status

字典

包含有关在范围内通过 ESXi 主机更改了哪些信息的信息字典。

已返回: 成功

示例: {"results": {"myhost01.example.com": {"changed": true, "configured_options": "ipv6=0", "msg": "已更改内核模块上的选项", "original_options": "ipv6=1"}}}

作者

  • Aaron Longchamps (@alongchamps)