New in version 2.6.
The below requirements are needed on the host that executes this module.
| 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 |
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 supported added in version 2.6.
|
|
| name |
Name of the virtual machine.
This is required parameter, if parameter
uuid is not supplied. |
|
| password |
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 supported added in version 2.6.
aliases: pass, pwd |
|
|
port
(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 supported added in version 2.6.
|
| username |
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 supported added in version 2.6.
aliases: user, admin |
|
| 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 |
True
|
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 supported added in version 2.6.
|
- name: Gather disk facts from virtual machine using UUID
vmware_guest_disk_facts:
hostname: 192.168.1.209
username: administrator@vsphere.local
password: vmware
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: 192.168.1.209
username: administrator@vsphere.local
password: vmware
datacenter: ha-datacenter
validate_certs: no
name: VM_225
delegate_to: localhost
register: disk_facts
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
guest_disk_facts
dict
|
always |
metadata about the virtual machine's disks
Sample:
{'0': {'backing_filename': '[datastore2] VM_225/VM_225.vmdk', 'capacity_in_kb': 10240, 'backing_disk_mode': 'persistent', 'backing_eagerlyscrub': False, 'backing_writethrough': False, 'label': 'Hard disk 1', 'backing_datastore': 'datastore2', 'key': 2000, 'capacity_in_bytes': 10485760, 'backing_thinprovisioned': False, 'controller_key': 1000, 'summary': '10,240 KB', 'unit_number': 0}}
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.