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

New in version 2.0.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
- Author

Synopsis ¶

Return basic facts pertaining to a vSphere virtual machine guest.

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 2.6
PyVmomi

Parameters ¶

Parameter	Choices/Defaults	Comments
hostname required		The hostname or IP address of the vSphere vCenter.
password required		The password of the vSphere vCenter. aliases: pass, pwd
port (added in 2.5)	Default: 443	The port number of the vSphere vCenter or ESXi server.
username required		The username of the vSphere vCenter. aliases: user, admin
validate_certs	Choices: no yes Default: True	Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
vm_type (added in 2.5)	Choices: all ← vm template	If set to `vm`, then facts are gathered for virtual machines only. If set to `template`, then facts are gathered for virtual machine templates only. If set to `all`, then facts are gathered for all virtual machines and virtual machine templates.

Notes ¶

Note

Tested on vSphere 5.5 and vSphere 6.5

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

- name: Gather only registered virtual machine templates
  vmware_vm_facts:
    hostname: esxi_or_vcenter_ip_or_hostname
    username: username
    password: password
    vm_type: template
  delegate_to: localhost
  register: template_facts

- debug:
    var: template_facts.virtual_machines

- name: Gather only registered virtual machines
  vmware_vm_facts:
    hostname: esxi_or_vcenter_ip_or_hostname
    username: username
    password: password
    vm_type: vm
  delegate_to: localhost
  register: vm_facts

- debug:
    var: vm_facts.virtual_machines

Return Values ¶

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

Key	Returned	Description
virtual_machines dict	success	dictionary of virtual machines and their facts

Status ¶

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

Author ¶

Joseph Callen (@jcpowermac)
Abhijeet Kasurde (@akasurde)

Hint

If you notice any issues in this documentation you can edit this document to improve it.