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

• 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

Notes

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:

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)