Documentation

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

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
  local_action:
    module: vmware_vm_facts
    hostname: esxi_or_vcenter_ip_or_hostname
    username: username
    password: password

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.