community.vmware.vmware_host_kernel_manager – Manage kernel module options on ESXi hosts

Note

This plugin is part of the community.vmware collection.

To install it use: ansible-galaxy collection install community.vmware.

To use it in a playbook, specify: community.vmware.vmware_host_kernel_manager.

Synopsis

  • This module can be used to manage kernel module options on ESXi hosts.

  • All connected ESXi hosts in scope will be configured when specified.

  • If a host is not connected at time of configuration, it will be marked as such in the output.

  • Kernel module options may require a reboot to take effect which is not covered here.

  • You can use community.vmware.reboot or community.vmware.vmware_host_powerstate module to reboot all ESXi host systems.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7

  • PyVmomi

Parameters

Parameter Choices/Defaults Comments
cluster_name
string
Name of the VMware cluster to work on.
All ESXi hosts in this cluster will be configured.
This parameter is required if esxi_hostname is not specified.
esxi_hostname
string
Name of the ESXi host to work on.
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.
kernel_module_name
string / required
Name of the kernel module to be configured.
kernel_module_option
string / required
Specified configurations will be applied to the given module.
These values are specified in key=value pairs and separated by a space when there are multiple options.
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
    Choices:
  • no
  • yes ←
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 yes, please make sure Python >= 2.7.9 is installed on the given machine.

Notes

Note

  • Tested on vSphere 6.0

Examples

- 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"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
host_kernel_status
dictionary
success
dict with information on what was changed, by ESXi host in scope.

Sample:
{'results': {'myhost01.example.com': {'changed': True, 'configured_options': 'ipv6=0', 'msg': 'Options have been changed on the kernel module', 'original_options': 'ipv6=1'}}}


Authors

  • Aaron Longchamps (@alongchamps)