community.vmware.vmware_vmkernel module – Manages a VMware VMkernel Adapter of an ESXi host.
Note
This module is part of the community.vmware collection (version 4.7.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.vmware
.
To use it in a playbook, specify: community.vmware.vmware_vmkernel
.
Synopsis
This module can be used to manage the VMKernel adapters / VMKernel network interfaces of an ESXi host.
The module assumes that the host is already configured with the Port Group in case of a vSphere Standard Switch (vSS).
The module assumes that the host is already configured with the Distributed Port Group in case of a vSphere Distributed Switch (vDS).
The module automatically migrates the VMKernel adapter from vSS to vDS or vice versa if present.
Parameters
Parameter |
Comments |
---|---|
Search VMkernel adapter by device name. The parameter is required only in case of |
|
The name of the vSphere Distributed Switch (vDS) where to add the VMKernel interface. Required parameter only if Optional parameter from version 2.8 and onwards. |
|
Enable vSphere Backup NFC traffic on the VMKernel adapter. This option is only allowed if the default TCP/IP stack is used. Choices:
|
|
Enable Fault Tolerance traffic on the VMKernel adapter. This option is only allowed if the default TCP/IP stack is used. Choices:
|
|
Enable Management traffic on the VMKernel adapter. This option is only allowed if the default TCP/IP stack is used. Choices:
|
|
Enable Provisioning traffic on the VMKernel adapter. This option is only allowed if the default TCP/IP stack is used. Choices:
|
|
Enable vSphere Replication traffic on the VMKernel adapter. This option is only allowed if the default TCP/IP stack is used. Choices:
|
|
Enable vSphere Replication NFC traffic on the VMKernel adapter. This option is only allowed if the default TCP/IP stack is used. Choices:
|
|
Enable vMotion traffic on the VMKernel adapter. This option is only allowed if the default TCP/IP stack is used. You cannot enable vMotion on an additional adapter if you already have an adapter with the vMotion TCP/IP stack configured. Choices:
|
|
Enable VSAN traffic on the VMKernel adapter. This option is only allowed if the default TCP/IP stack is used. Choices:
|
|
Name of ESXi host to which VMKernel is to be managed. |
|
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 |
|
The MTU for the VMKernel interface. The default value of 1500 is valid from version 2.5 and onwards. Default: |
|
A dictionary of network details. Default: |
|
Default gateway (Override default gateway for this adapter). |
|
Static IP address. Required if |
|
Static netmask required. Required if |
|
The TCP/IP stack for the VMKernel interface. Choices:
|
|
Type of IP assignment. Choices:
|
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Default: |
|
The name of the port group for the VMKernel interface. |
|
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 |
|
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 |
|
If set to If set to If set to Choices:
|
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
|
The name of the vSwitch where to add the VMKernel interface. Required parameter only if Optional parameter from version 2.5 and onwards. |
Notes
Note
The option
device
need to be used with DHCP because otherwise it’s not possible to check if a VMkernel device is already presentYou can only change from DHCP to static, and vSS to vDS, or vice versa, in one step, without creating a new device, with
device
specified.You can only create the VMKernel adapter on a vDS if authenticated to vCenter and not if authenticated to ESXi.
All modules requires API write access and hence is not supported on a free ESXi license.
All variables and VMware object names are case sensitive.
Examples
- name: Add Management vmkernel port using static network type
community.vmware.vmware_vmkernel:
hostname: '{{ esxi_hostname }}'
username: '{{ esxi_username }}'
password: '{{ esxi_password }}'
esxi_hostname: '{{ esxi_hostname }}'
vswitch_name: vSwitch0
portgroup_name: PG_0001
network:
type: 'static'
ip_address: 192.168.127.10
subnet_mask: 255.255.255.0
state: present
enable_mgmt: true
delegate_to: localhost
- name: Add Management vmkernel port using DHCP network type
community.vmware.vmware_vmkernel:
hostname: '{{ esxi_hostname }}'
username: '{{ esxi_username }}'
password: '{{ esxi_password }}'
esxi_hostname: '{{ esxi_hostname }}'
vswitch_name: vSwitch0
portgroup_name: PG_0002
state: present
network:
type: 'dhcp'
enable_mgmt: true
delegate_to: localhost
- name: Change IP allocation from static to dhcp
community.vmware.vmware_vmkernel:
hostname: '{{ esxi_hostname }}'
username: '{{ esxi_username }}'
password: '{{ esxi_password }}'
esxi_hostname: '{{ esxi_hostname }}'
vswitch_name: vSwitch0
portgroup_name: PG_0002
state: present
device: vmk1
network:
type: 'dhcp'
enable_mgmt: true
delegate_to: localhost
- name: Delete VMkernel port
community.vmware.vmware_vmkernel:
hostname: '{{ esxi_hostname }}'
username: '{{ esxi_username }}'
password: '{{ esxi_password }}'
esxi_hostname: '{{ esxi_hostname }}'
vswitch_name: vSwitch0
portgroup_name: PG_0002
state: absent
delegate_to: localhost
- name: Add Management vmkernel port to Distributed Switch
community.vmware.vmware_vmkernel:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
dvswitch_name: dvSwitch1
portgroup_name: dvPG_0001
network:
type: 'static'
ip_address: 192.168.127.10
subnet_mask: 255.255.255.0
state: present
enable_mgmt: true
delegate_to: localhost
- name: Add vMotion vmkernel port with vMotion TCP/IP stack
community.vmware.vmware_vmkernel:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
dvswitch_name: dvSwitch1
portgroup_name: dvPG_0001
network:
type: 'static'
ip_address: 192.168.127.10
subnet_mask: 255.255.255.0
tcpip_stack: vmotion
state: present
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
metadata about VMKernel name Returned: always Sample: |