community.vmware.vmware_host_vmnic_info module – Gathers info about vmnics available on the given ESXi host
Note
This module is part of the community.vmware collection (version 3.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_host_vmnic_info.
Synopsis
This module can be used to gather information about vmnics available on the given ESXi host.
If
cluster_nameis provided, then vmnic information about all hosts from given cluster will be returned.If
esxi_hostnameis provided, then vmnic information about given host system will be returned.Additional details about vswitch and dvswitch with respective vmnic is also provided which is added in 2.7 version.
Additional details about lldp added in 1.11.0
Parameters
Parameter |
Comments |
|---|---|
Gather information about general capabilities (Auto negotiation, Wake On LAN, and Network I/O Control). Choices:
|
|
Name of the cluster from which all host systems will be used. Vmnic information about each ESXi server will be returned for the given cluster. This parameter is required if |
|
Gather information about DirectPath I/O capabilities and configuration. Choices:
|
|
Name of the host system to work with. Vmnic information about this ESXi server will be returned. This parameter is required if |
|
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 Environment variable support added in Ansible 2.6. |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. Default: |
|
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 This feature depends on a version of pyvmomi greater than v6.7.1.2018.12 |
|
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 |
|
Gather information about SR-IOV capabilities and configuration. Choices:
|
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. If set to Choices:
|
Notes
Note
All modules requires API write access and hence is not supported on a free ESXi license.
Examples
- name: Gather info about vmnics of all ESXi Host in the given Cluster
community.vmware.vmware_host_vmnic_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
cluster_name: '{{ cluster_name }}'
delegate_to: localhost
register: cluster_host_vmnics
- name: Gather info about vmnics of an ESXi Host
community.vmware.vmware_host_vmnic_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
delegate_to: localhost
register: host_vmnics
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
dict with hostname as key and dict with vmnics information as value. for details about vswitch and dvswitch was added in version 2.7. details about vmnics was added in version 2.8. details about lldp was added in version 1.11.0 Returned: hosts_vmnics_info Sample: |