community.vmware.vmware_host_vmhba_info module – Gathers info about vmhbas available on the given ESXi host
Note
This module is part of the community.vmware collection (version 5.0.1).
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_info
.
Synopsis
This module can be used to gather information about vmhbas available on the given ESXi host.
If
cluster_name
is provided, then vmhba information about all hosts from given cluster will be returned.If
esxi_hostname
is provided, then vmhba information about given host system will be returned.
Parameters
Parameter |
Comments |
---|---|
Name of the cluster from which all host systems will be used. Vmhba information 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 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 |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable 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 |
|
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 |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
Notes
Note
All modules requires API write access and hence is not supported on a free ESXi license.
All variables and VMware object names are case sensitive.
Examples
- name: Gather info about vmhbas of all ESXi Host in the given Cluster
community.vmware.vmware_host_vmhba_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
cluster_name: '{{ cluster_name }}'
delegate_to: localhost
register: cluster_host_vmhbas
- name: Gather info about vmhbas of an ESXi Host
community.vmware.vmware_host_vmhba_info:
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 information as value. Returned: hosts_vmhbas_info Sample: |