Documentation

vmware_guest_tools_wait - Wait for VMware tools to become available

New in version 2.4.

Synopsis

  • Wait for VMware tools to become available on the VM and return facts.

Options

parameter required default choices comments
folder
no /vm
Destination folder, absolute or relative path to find an existing guest.
This is required if name is supplied.
The folder should include the datacenter. ESX's datacenter is ha-datacenter.
Examples:
folder: /ha-datacenter/vm
folder: ha-datacenter/vm
folder: /datacenter1/vm
folder: datacenter1/vm
folder: /datacenter1/vm/folder1
folder: datacenter1/vm/folder1
folder: /folder1/datacenter1/vm
folder: folder1/datacenter1/vm
folder: /folder1/datacenter1/vm/folder2
hostname
yes
The hostname or IP address of the vSphere vCenter.
name
no
Name of the VM for which to wait until the tools become available.
This is required if uuid is not supplied.
name_match
no first
  • first
  • last
If multiple VMs match 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 VM for which to wait until the tools become available, 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: Wait for VMware tools to become available by UUID
  vmware_guest_tools_wait:
    hostname: 192.168.1.209
    username: [email protected]
    password: vmware
    validate_certs: no
    uuid: 421e4592-c069-924d-ce20-7e7533fab926
  delegate_to: localhost
  register: facts

- name: Wait for VMware tools to become available by name
  vmware_guest_tools_wait:
    hostname: 192.168.1.209
    username: [email protected]
    password: vmware
    validate_certs: no
    name: test-vm
    folder: /datacenter1/vm
  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 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.