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
Destination folder, absolute path to find an existing guest.
This is required if name is supplied.
hostname
yes
The hostname or IP address of the vSphere vCenter.
name
yes
Name of the VM to work with
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 VM facts
  vmware_guest_facts:
    hostname: 192.168.1.209
    username: [email protected]
    password: vmware
    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.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

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