community / community.vmware / 4.2.0 / module / vmware_guest_tools_wait Wait for VMware tools to become available Authors: Philippe Dellaert (@pdellaert) <philippe@dellaert.org>community.vmware.vmware_guest_tools_wait (4.2.0) — module
Install with ansible-galaxy collection install community.vmware:==4.2.0
collections: - name: community.vmware version: 4.2.0
This module can be used to wait for VMware tools to become available on the given VM and return facts.
- name: Wait for VMware tools to become available by UUID vmware_guest_facts: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter }}" folder: "/{{datacenter}}/vm" name: "{{ vm_name }}" delegate_to: localhost register: vm_facts
- name: Get UUID from previous task and pass it to this task community.vmware.vmware_guest_tools_wait: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" uuid: "{{ vm_facts.instance.hw_product_uuid }}" delegate_to: localhost register: facts
- name: Wait for VMware tools to become available by MoID community.vmware.vmware_guest_tools_wait: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" moid: vm-42 delegate_to: localhost register: facts
- name: Wait for VMware tools to become available by name community.vmware.vmware_guest_tools_wait: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" name: test-vm folder: "/{{datacenter}}/vm" datacenter: "{{ datacenter }}" delegate_to: localhost register: facts
moid: description: - Managed Object ID of the instance to manage if known, this is a unique identifier only within a single vCenter instance. - This is required if O(name) or O(uuid) is not supplied. type: str name: description: - Name of the VM for which to wait until the tools become available. - This is required if O(uuid) or O(moid) is not supplied. type: str port: default: 443 description: - The port number of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PORT) will be used instead. type: int uuid: description: - 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 O(name) or O(moid) is not supplied. type: str folder: description: - Destination folder, absolute or relative path to find an existing guest. - This is required only, if multiple VMs with same O(name) is found. - The folder should include the datacenter. ESX's datacenter is C(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' type: str timeout: default: 500 description: - Max duration of the waiting period (seconds). type: int hostname: description: - 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 E(VMWARE_HOST) will be used instead. type: str password: aliases: - pass - pwd description: - The password of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PASSWORD) will be used instead. type: str username: aliases: - admin - user description: - The username of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_USER) will be used instead. type: str datacenter: description: - Name of the datacenter. - The datacenter to search for a virtual machine. type: str name_match: choices: - first - last default: first description: - If multiple VMs match the name, use the first or last found. type: str proxy_host: description: - Address of a proxy that will receive all HTTPS requests and relay them. - The format is a hostname or a IP. - If the value is not specified in the task, the value of environment variable E(VMWARE_PROXY_HOST) will be used instead. required: false type: str proxy_port: description: - Port of the HTTP proxy that will receive all HTTPS requests and relay them. - If the value is not specified in the task, the value of environment variable E(VMWARE_PROXY_PORT) will be used instead. required: false type: int validate_certs: default: true description: - Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted. - If the value is not specified in the task, the value of environment variable E(VMWARE_VALIDATE_CERTS) will be used instead. type: bool use_instance_uuid: default: false description: - Whether to use the VMware instance UUID rather than the BIOS UUID. type: bool
instance: description: metadata about the virtual machine returned: always sample: None type: dict