community.vmware.vmware_host_vmhba_facts – Gathers facts about vmhbas available on the given ESXi host
Note
This plugin is part of the community.vmware collection (version 1.17.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_vmhba_facts
.
DEPRECATED
- Removed in
major release after 2021-12-01
- Why
Deprecated in favour of community.vmware.vmware_host_vmhba_info module.
- Alternative
Use community.vmware.vmware_host_vmhba_info instead.
Synopsis
This module can be used to gather facts about vmhbas available on the given ESXi host.
If
cluster_name
is provided, then vmhba facts about all hosts from given cluster will be returned.If
esxi_hostname
is provided, then vmhba 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 |
Comments |
---|---|
Name of the cluster from which all host systems will be used. Vmhba facts about each ESXi server will be returned for the given cluster. This parameter is required if |
|
Name of the host system to work with. Vmhba facts 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: 443 |
|
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 |
|
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
Tested on vSphere 6.5
All modules requires API write access and hence is not supported on a free ESXi license.
Examples
- name: Gather facts about vmhbas of all ESXi Host in the given Cluster
community.vmware.vmware_host_vmhba_facts:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
cluster_name: '{{ cluster_name }}'
delegate_to: localhost
register: cluster_host_vmhbas
- name: Gather facts about vmhbas of an ESXi Host
community.vmware.vmware_host_vmhba_facts:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
delegate_to: localhost
register: host_vmhbas
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 vmhbas facts as value. Returned: hosts_vmhbas_facts Sample: {“10.76.33.204”: {“vmhba_details”: [{“adapter”: “HPE Smart Array P440ar”, “bus”: 3, “device”: “vmhba0”, “driver”: “nhpsa”, “location”: “0000:03:00.0”, “model”: “Smart Array P440ar”, “node_wwn”: “50:01:43:80:37:18:9e:a0”, “status”: “unknown”, “type”: “SAS”}, {“adapter”: “QLogic Corp ISP2532-based 8Gb Fibre Channel to PCI Express HBA”, “bus”: 5, “device”: “vmhba1”, “driver”: “qlnativefc”, “location”: “0000:05:00.0”, “model”: “ISP2532-based 8Gb Fibre Channel to PCI Express HBA”, “node_wwn”: “57:64:96:32:15:90:23:95:82”, “port_type”: “unknown”, “port_wwn”: “57:64:96:32:15:90:23:95:82”, “speed”: 8, “status”: “online”, “type”: “Fibre Channel”}, {“adapter”: “QLogic Corp ISP2532-based 8Gb Fibre Channel to PCI Express HBA”, “bus”: 8, “device”: “vmhba2”, “driver”: “qlnativefc”, “location”: “0000:08:00.0”, “model”: “ISP2532-based 8Gb Fibre Channel to PCI Express HBA”, “node_wwn”: “57:64:96:32:15:90:23:95:21”, “port_type”: “unknown”, “port_wwn”: “57:64:96:32:15:90:23:95:21”, “speed”: 8, “status”: “online”, “type”: “Fibre Channel”}]}} |
Status
This module will be removed in a major release after 2021-12-01. [deprecated]
For more information see DEPRECATED.
Authors
Christian Kotte (@ckotte)