community.vmware.vmware_host_iscsi_info – Gather iSCSI configuration information of ESXi host
community.vmware.vmware_host_iscsi_info – Gather iSCSI configuration information of 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_host_iscsi_info
.
Synopsis
- This module can be used to gather information about the iSCSI configuration of the ESXi host.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- PyVmomi
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
esxi_hostname string / required |
The ESXi hostname on which to gather iSCSI settings. | |
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 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 Environment variable support added in Ansible 2.6.
| |
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 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 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 | |
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 Environment variable support added in Ansible 2.6.
| |
validate_certs boolean |
|
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 |
Examples
- name: Gather iSCSI configuration information of ESXi host
community.vmware.vmware_host_iscsi_info:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
esxi_hostname: "{{ esxi_hostname }}"
register: iscsi_info
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
iscsi_properties dictionary |
always |
dictionary of current iSCSI information
Sample: { "iscsi_alias": "", "iscsi_authentication_properties": { "_vimtype": "vim.host.InternetScsiHba.AuthenticationProperties", "chapAuthEnabled": false, "chapAuthenticationType": "chapProhibited", "chapInherited": null, "chapName": "", "chapSecret": "XXXXXXXXX", "mutualChapAuthenticationType": "chapProhibited", "mutualChapInherited": null, "mutualChapName": "", "mutualChapSecret": "XXXXXXXXX" }, "iscsi_enabled": true, "iscsi_name": "iqn.1998-01.com.vmware:esxi-033f58ee", "iscsi_send_targets": [ { "address": "192.168.0.1", "authenticationProperties": { "_vimtype": "vim.host.InternetScsiHba.AuthenticationProperties", "chapAuthEnabled": false, "chapAuthenticationType": "chapProhibited", "chapInherited": true, "chapName": "", "chapSecret": "XXXXXXXXX", "mutualChapAuthenticationType": "chapProhibited", "mutualChapInherited": true, "mutualChapName": "", "mutualChapSecret": "XXXXXXXXX" }, "port": 3260 } ], "iscsi_static_targets": [ { "address": "192.168.0.1", "authenticationProperties": { "_vimtype": "vim.host.InternetScsiHba.AuthenticationProperties", "chapAuthEnabled": false, "chapAuthenticationType": "chapProhibited", "chapInherited": true, "chapName": "", "chapSecret": "XXXXXXXXX", "mutualChapAuthenticationType": "chapProhibited", "mutualChapInherited": true, "mutualChapName": "", "mutualChapSecret": "XXXXXXXXX" }, "iscsi_name": "iqn.2004-04.com.qnap:tvs-673:iscsi.vm3.2c580e", "port": 3260 } ], "port_bind": [], "vmhba_name": "vmhba65" } |
Authors
- sky-joker (@sky-joker)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/vmware/vmware_host_iscsi_info_module.html