community.vmware.vmware_guest_disk_info – Gather info about disks of given virtual machine

Note

This plugin is part of the community.vmware collection (version 1.6.0).

To install it use: ansible-galaxy collection install community.vmware.

To use it in a playbook, specify: community.vmware.vmware_guest_disk_info.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

This module can be used to gather information about disks belonging to given virtual machine.
All parameters and VMware object names are case sensitive.

Requirements

The below requirements are needed on the host that executes this module.

python >= 2.6
PyVmomi

Parameters

Parameter	Choices/Defaults	Comments
datacenter string / required		The datacenter name to which virtual machine belongs to.
folder string		Destination folder, absolute or relative path to find an existing guest. This is required parameter, only if multiple VMs are found with same name. The folder should include the datacenter. ESX's datacenter is ha-datacenter Examples: folder: /ha-datacenter/vm folder: ha-datacenter/vm folder: /datacenter1/vm folder: datacenter1/vm folder: /datacenter1/vm/folder1 folder: datacenter1/vm/folder1 folder: /folder1/datacenter1/vm folder: folder1/datacenter1/vm folder: /folder1/datacenter1/vm/folder2
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.
moid string		Managed Object ID of the instance to manage if known, this is a unique identifier only within a single vCenter instance. This is required if `name` or `uuid` is not supplied.
name string		Name of the virtual machine. This is required parameter, if parameter `uuid` or `moid` is not supplied.
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.
use_instance_uuid boolean	no ← yes	Whether to use the VMware instance UUID rather than the BIOS UUID.
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
uuid string		UUID of the instance to gather information if known, this is VMware's unique identifier. This is required parameter, if parameter `name` or `moid` is not supplied.
validate_certs boolean	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.0 and 6.5.
Disk UUID information is added in version 2.8.
Additional information about guest disk backings added in version 2.8.

Examples

- name: Gather disk info from virtual machine using UUID
  community.vmware.vmware_guest_disk_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: ha-datacenter
    uuid: 421e4592-c069-924d-ce20-7e7533fab926
  delegate_to: localhost
  register: disk_info

- name: Gather disk info from virtual machine using name
  community.vmware.vmware_guest_disk_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: ha-datacenter
    name: VM_225
  delegate_to: localhost
  register: disk_info

- name: Gather disk info from virtual machine using moid
  community.vmware.vmware_guest_disk_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: ha-datacenter
    moid: vm-42
  delegate_to: localhost
  register: disk_info

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
guest_disk_info dictionary	always	metadata about the virtual machine's disks Sample: {'0': {'backing_datastore': 'datastore2', 'backing_disk_mode': 'persistent', 'backing_diskmode': 'persistent', 'backing_eagerlyscrub': False, 'backing_filename': '[datastore2] VM_225/VM_225.vmdk', 'backing_thinprovisioned': False, 'backing_type': 'FlatVer2', 'backing_uuid': '200C3A00-f82a-97af-02ff-62a595f0020a', 'backing_writethrough': False, 'capacity_in_bytes': 10485760, 'capacity_in_kb': 10240, 'controller_bus_number': 0, 'controller_key': 1000, 'controller_type': 'paravirtual', 'key': 2000, 'label': 'Hard disk 1', 'summary': '10,240 KB', 'unit_number': 0}, '1': {'backing_datastore': 'datastore3', 'backing_devicename': 'vml.012345678901234567890123456789012345678901234567890123', 'backing_disk_mode': 'independent_persistent', 'backing_diskmode': 'independent_persistent', 'backing_filename': '[datastore3] VM_226/VM_226.vmdk', 'backing_lunuuid': '012345678901234567890123456789012345678901234567890123', 'backing_type': 'RawDiskMappingVer1', 'backing_uuid': None, 'capacity_in_bytes': 15728640, 'capacity_in_kb': 15360, 'controller_bus_number': 0, 'controller_key': 1000, 'controller_type': 'paravirtual', 'key': 2001, 'label': 'Hard disk 3', 'summary': '15,360 KB', 'unit_number': 1}}

Authors

Abhijeet Kasurde (@Akasurde) <[email protected]>

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/vmware/vmware_guest_disk_info_module.html