Documentation

vmware_guest_facts - Gather facts about a single VM

New in version 2.3.

Synopsis

  • Gather facts about a single VM on a VMware ESX cluster

Options

parameter required default choices comments
datacenter
yes
Destination datacenter for the deploy operation
folder
no /vm
Destination folder, absolute or relative path to find an existing guest.
This is required if name is supplied.
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
yes
The hostname or IP address of the vSphere vCenter.
name
no
Name of the VM to work with
This is required if UUID is not supplied.
name_match
no first
  • first
  • last
If multiple VMs matching the name, use the first or last found
password
yes
The password of the vSphere vCenter.

aliases: pass, pwd
username
yes
The username of the vSphere vCenter.

aliases: user, admin
uuid
no
UUID of the instance to manage if known, this is VMware's unique identifier.
This is required if name is not supplied.
validate_certs
no True
  • True
  • False
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.

Examples

- name: Gather facts from standalone ESXi server having datacenter as 'ha-datacenter'
  vmware_guest_facts:
    hostname: 192.168.1.209
    username: [email protected]
    password: vmware
    datacenter: ha-datacenter
    validate_certs: no
    uuid: 421e4592-c069-924d-ce20-7e7533fab926
  delegate_to: localhost
  register: facts

Return Values

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

name description returned type sample
instance
metadata about the virtual machine
always dict None


Notes

Note

  • Tested on vSphere 5.5

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.