W3cubDocs

/Ansible 2.11

community.vmware.vmware_host_disk_info – Gathers information about disks attached to given ESXi host/s.

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_disk_info.

Synopsis

  • This module returns information about disks attached to given ESXi host/s
  • If cluster_name is provided, then disk information about all hosts from the given cluster will be returned.
  • If esxi_hostname is provided, then disk information about the 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
string
Name of the cluster from which the ESXi host belong to.
If esxi_hostname is not given, this parameter is required.
esxi_hostname
string
ESXi hostname to gather information from.
If cluster_name is not given, this parameter is required.
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 VMWARE_HOST will be used instead.
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 VMWARE_PASSWORD will be used instead.
Environment variable support added in Ansible 2.6.

aliases: pass, pwd
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 VMWARE_PORT will be used instead.
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 VMWARE_PROXY_HOST will be used instead.
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 VMWARE_PROXY_PORT will be used instead.
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 VMWARE_USER will be used instead.
Environment variable support added in Ansible 2.6.

aliases: admin, user
validate_certs
boolean
    Choices:
  • no
  • yes ←
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 support added in Ansible 2.6.
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.

Notes

Note

  • Tested on vSphere 6.7 and 7.0

Examples

- name: Gather info about vmhbas of all ESXi Host in the given Cluster
  community.vmware.vmware_host_disk_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_disk_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 Returned Description
hosts_disk_info
list / elements=string
always
list of information for all disks attached to each ESXi host

Sample:
"192.168.0.182": [ { "canonical_name": "naa.6000c296ed6217bd61df35622eb21a3a", "capacity_mb": 4096, "device_path": "/vmfs/devices/disks/naa.6000c296ed6217bd61df35622eb21a3a", "device_type": "disk", "device_ctd_list": [ "vmhba0:C0:T1:L0" ], "disk_uid": "key-vim.host.ScsiDisk-02000000006000c296ed6217bd61df35622eb21a3a566972747561", "display_name": "Local VMware Disk (naa.6000c296ed6217bd61df35622eb21a3a)" }, { "canonical_name": "naa.6000c2968ad7142d93faae527fe8822b", "capacity_mb": 204800, "device_path": "/vmfs/devices/disks/naa.6000c2968ad7142d93faae527fe8822b", "device_type": "disk", "device_ctd_list": [ "vmhba0:C0:T3:L0" ], "disk_uid": "key-vim.host.ScsiDisk-02000000006000c2968ad7142d93faae527fe8822b566972747561", "display_name": "Local VMware Disk (naa.6000c2968ad7142d93faae527fe8822b)" },]


Authors

  • Matt Proud (@laidbackware)

© 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_disk_info_module.html