New in version 2.4.
The below requirements are needed on the host that executes this module.
Parameter |
Choices/Defaults |
Comments |
---|---|---|
folder
|
Default:
/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
|
|
The hostname or IP address of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable
VMWARE_HOST will be used instead.Environment variable supported added in version 2.6.
|
name
|
|
Name of the VM for which to wait until the tools become available.
This is required if uuid is not supplied.
|
name_match
|
|
If multiple VMs match the name, use the first or last found.
|
password
|
|
The password of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable
VMWARE_PASSWORD will be used instead.Environment variable supported added in version 2.6.
aliases: pass, pwd |
port
(added in 2.5) |
Default:
443
|
The port number of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable
VMWARE_PORT will be used instead.Environment variable supported added in version 2.6.
|
username
|
|
The username of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable
VMWARE_USER will be used instead.Environment variable supported added in version 2.6.
aliases: user, admin |
uuid
|
|
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
|
True
|
Allows connection when SSL certificates are not valid. Set to
false when certificates are not trusted.If the value is not specified in the task, the value of environment variable
VMWARE_VALIDATE_CERTS will be used instead.Environment variable supported added in version 2.6.
|
Note
- 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
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
---|---|---|
instance
dict
|
always |
metadata about the virtual machine
Sample:
None
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.