community.vmware.vmware_vmkernel_facts – Gathers VMKernel facts about an ESXi host¶

Note

This plugin is part of the community.vmware collection (version 1.7.0).

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

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

DEPRECATED
Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

DEPRECATED ¶

Removed in: major release after 2021-12-01
Why: Deprecated in favour of community.vmware.vmware_vmkernel_info module.
Alternative: Use community.vmware.vmware_vmkernel_info instead.

Synopsis ¶

This module can be used to gather VMKernel facts about an ESXi host from given ESXi hostname or cluster name.

Requirements ¶

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

python >= 2.6
PyVmomi

Parameters ¶

Parameter	Choices/Defaults	Comments
cluster_name string		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 string		ESXi hostname. VMKernel facts about this ESXi server will be returned. If `cluster_name` is not given, this parameter is required.
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.
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 `true`, please make sure Python >= 2.7.9 is installed on the given machine.

Notes ¶

Note

Tested on vSphere 6.5

Examples ¶

- name: Gather VMKernel facts about all ESXi Host in given Cluster
  community.vmware.vmware_vmkernel_facts:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: cluster_name
  delegate_to: localhost
  register: cluster_host_vmks

- name: Gather VMKernel facts about ESXi Host
  community.vmware.vmware_vmkernel_facts:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_hostname }}'
  delegate_to: localhost
  register: host_vmks

Return Values ¶

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

Key	Returned	Description
host_vmk_facts dictionary	success	metadata about VMKernel present on given host system Sample: {'10.76.33.208': [{'device': 'vmk0', 'dhcp': True, 'enable_ft': False, 'enable_management': True, 'enable_vmotion': False, 'enable_vsan': False, 'ipv4_address': '10.76.33.28', 'ipv4_subnet_mask': '255.255.255.0', 'key': 'key-vim.host.VirtualNic-vmk0', 'mac': '52:54:00:12:50:ce', 'mtu': 1500, 'portgroup': 'Management Network', 'stack': 'defaultTcpipStack'}]}

Status ¶

This module will be removed in a major release after 2021-12-01. [deprecated]
For more information see DEPRECATED.

Authors¶

Abhijeet Kasurde (@Akasurde)