Docs4dev
Docs
ansible / 2.4 / vmware_vm_facts_module.html

vmware_vm_facts - Return basic facts pertaining to a vSphere virtual machine guest

New in version 2.0.

Synopsis

  • Return basic facts pertaining to a vSphere virtual machine guest.

Requirements (on host that executes module)

  • python >= 2.6
  • PyVmomi

Options

parameter required default choices comments
hostname
 yes
The hostname or IP address of the vSphere vCenter.
password
 yes
The password of the vSphere vCenter.
aliases: pass, pwd
username
 yes
The username of the vSphere vCenter.
aliases: user, admin
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 all registered virtual machines
  vmware_vm_facts:
    hostname: esxi_or_vcenter_ip_or_hostname
    username: username
    password: password
  delegate_to: localhost
  register: vmfacts

- debug:
    var: vmfacts.virtual_machines

Return Values

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

name description returned type sample
virtual_machines
dictionary of virtual machines and their facts
success dict

Notes

Note

  • Tested on vSphere 5.5 and vSphere 6.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.

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