vmware_guest_disk_facts – Gather facts about disks of given virtual machine

New in version 2.6.

Synopsis

  • This module can be used to gather facts 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
- / required
The datacenter name to which virtual machine belongs to.
folder
-
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
folder: vm/folder2
folder: 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.
name
-
Name of the virtual machine.
This is required parameter, if parameter uuid 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
added in 2.5
 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.
use_instance_uuid
boolean
added in 2.8
    Choices:
  • 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
-
UUID of the instance to gather facts if known, this is VMware's unique identifier.
This is required parameter, if parameter name is not supplied.
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 yes, 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 facts from virtual machine using UUID
  vmware_guest_disk_facts:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: ha-datacenter
    validate_certs: no
    uuid: 421e4592-c069-924d-ce20-7e7533fab926
  delegate_to: localhost
  register: disk_facts

- name: Gather disk facts from virtual machine using name
  vmware_guest_disk_facts:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: ha-datacenter
    validate_certs: no
    name: VM_225
  delegate_to: localhost
  register: disk_facts

Return Values

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

Key Returned Description
guest_disk_facts
dictionary
 always
metadata about the virtual machine's disks

Sample:
{'0': {'backing_datastore': 'datastore2', 'backing_disk_mode': 'persistent', 'backing_eagerlyscrub': False, 'backing_filename': '[datastore2] VM_225/VM_225.vmdk', 'backing_thinprovisioned': False, 'backing_type': 'FlatVer2', 'backing_writethrough': False, 'backing_uuid': '200C3A00-f82a-97af-02ff-62a595f0020a', 'capacity_in_bytes': 10485760, 'capacity_in_kb': 10240, 'controller_key': 1000, '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_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_key': 1000, 'key': 2001, 'label': 'Hard disk 3', 'summary': '15,360 KB', 'unit_number': 1}}


Status

Authors

Hint

If you notice any issues in this documentation you can edit this document to improve it.