You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

vmware_vmkernel_ip_config - Configure the VMkernel IP Address¶

New in version 2.0.

Synopsis
Requirements (on host that executes module)
Options
Examples
Notes
- Status

Synopsis ¶

Configure the VMkernel IP Address

Requirements (on host that executes module)¶

python >= 2.6

PyVmomi

Options ¶

parameter	required	default	choices	comments
hostname	yes			The hostname or IP address of the vSphere vCenter.
ip_address	yes			IP address to assign to VMkernel interface
password	yes			The password of the vSphere vCenter. aliases: pass, pwd
subnet_mask	yes			Subnet Mask to assign to VMkernel interface
username	yes			The username of the vSphere vCenter. aliases: user, admin
validate_certs	no	True	True False	Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
vmk_name	yes			VMkernel interface name

Examples ¶

# Example command from Ansible Playbook

- name: Configure IP address on ESX host
  local_action:
    module: vmware_vmkernel_ip_config
    hostname: esxi_hostname
    username: esxi_username
    password: esxi_password
    vmk_name: vmk0
    ip_address: 10.0.0.10
    subnet_mask: 255.255.255.0

Notes ¶

Note

Tested on vSphere 5.5

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.