vmware_host_vmnic_facts - Gathers facts about vmnics available on the given ESXi host
New in version 2.5.
Synopsis
- This module can be used to gather facts about vmnics available on the given ESXi host.
- If
cluster_nameis provided, then vmnic facts about all hosts from given cluster will be returned. - If
esxi_hostnameis provided, then vmnic facts about given host system will be returned.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- PyVmomi
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| cluster_name | Name of the cluster. Vmnic 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. Vmnic facts about this ESXi server will be returned. If cluster_name is not given, this parameter is required. | |
| 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. | |
| 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. |
| 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. |
Notes
Note
- Tested on vSphere 6.5
Examples
- name: Gather facts about vmnics of all ESXi Host in the given Cluster
vmware_host_vmnic_facts:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
cluster_name: cluster_name
register: cluster_host_vmnics
- name: Gather facts about vmnics of an ESXi Host
vmware_host_vmnic_facts:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
register: host_vmnics
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| hosts_vmnics_facts dict | hosts_vmnics_facts | dict with hostname as key and dict with vmnics facts as value Sample: {'hosts_vmnics_facts': {'localhost.localdomain': {'available': [], 'all': ['vmnic0'], 'used': ['vmnic0']}}} |
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author
- Abhijeet Kasurde (@akasurde)
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_host_vmnic_facts_module.html