New in version 2.5.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| cluster_name |
Name of the cluster.
VMKernel facts about each ESXi server will be returned for the given cluster.
If
esxi_hostname is not given, this parameter is required. |
|
| esxi_hostname |
ESXi hostname.
VMKernel facts about this ESXi server will be returned.
If
cluster_name is not given, this parameter is required. |
|
|
hostname
str |
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 version 2.6.
|
|
|
password
str |
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 version 2.6.
aliases: pass, pwd |
|
|
port
int (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 support added in version 2.6.
|
|
username
str |
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 version 2.6.
aliases: admin, user |
|
|
validate_certs
bool |
|
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 version 2.6.
If set to
yes, please make sure Python >= 2.7.9 is installed on the given machine. |
- name: Gather VMKernel facts about all ESXi Host in given Cluster
vmware_vmkernel_facts:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
cluster_name: cluster_name
register: cluster_host_vmks
- name: Gather VMKernel facts about ESXi Host
vmware_vmkernel_facts:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
register: host_vmks
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
host_vmk_facts
dict
|
success |
metadata about VMKernel present on given host system
Sample:
{'10.76.33.208': [{'enable_vsan': False, 'enable_vmotion': False, 'enable_management': True, 'ipv4_subnet_mask': '255.255.255.0', 'mtu': 1500, 'ipv4_address': '10.76.33.28', 'mac': '52:54:00:12:50:ce', 'key': 'key-vim.host.VirtualNic-vmk0', 'device': 'vmk0', 'dhcp': True, 'portgroup': 'Management Network', 'stack': 'defaultTcpipStack', 'enable_ft': False}]}
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.