vmware_vmkernel_ip_config - Configure the VMkernel IP Address
New in version 2.0.
Synopsis
- Configure the VMkernel IP Address
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- PyVmomi
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| hostname |
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 supported added in version 2.6.
|
|
| ip_address
required
|
IP address to assign to VMkernel interface
|
|
| password |
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 supported added in version 2.6.
aliases: pass, pwd |
|
| port
(added in 2.5)
|
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 supported added in version 2.6.
|
| subnet_mask
required
|
Subnet Mask to assign to VMkernel interface
|
|
| username |
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 supported added in version 2.6.
aliases: user, admin |
|
| validate_certs |
True
|
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 supported added in version 2.6.
|
| vmk_name
required
|
VMkernel interface name
|
Notes
Note
- Tested on vSphere 5.5
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
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author
- Joseph Callen (@jcpowermac), Russell Teague (@mtnbikenc)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/vmware_vmkernel_ip_config_module.html