community.vmware.vmware_guest_tools_upgrade – Module to upgrade VMTools
Note
This plugin is part of the community.vmware collection (version 1.15.0).
You might already have this collection installed if you are using the ansible
package. It is not included in ansible-core
. To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.vmware
.
To use it in a playbook, specify: community.vmware.vmware_guest_tools_upgrade
.
Synopsis
- This module upgrades the VMware Tools on Windows and Linux guests and reboots them.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- PyVmomi
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
datacenter string / required | Destination datacenter where the virtual machine exists. | |
folder string | 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 | |
force_upgrade boolean |
| This flag overrides the guest operating system detection and forcibly upgrade VMware tools or open-vm-tools. This is useful when VMware tools is too old and unable to detect the 'guestFamily' value. Using this flag may sometime give unexpected results since module will override the default behaviour of 'guestFamily' detection. |
hostname string | 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 support added in Ansible 2.6. | |
moid string | 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 name or uuid is not supplied. | |
name string | Name of the virtual machine to work with. This is required if uuid or moid is not supplied. | |
name_match string |
| If multiple virtual machines matching the name, use the first or last found. |
password string | 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 support added in Ansible 2.6. aliases: pass, pwd | |
port integer | 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 support added in Ansible 2.6. |
proxy_host string | 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 VMWARE_PROXY_HOST will be used instead.This feature depends on a version of pyvmomi greater than v6.7.1.2018.12 | |
proxy_port integer | 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 VMWARE_PROXY_PORT will be used instead. | |
username string | 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 support added in Ansible 2.6. aliases: admin, user | |
uuid string | UUID of the instance to manage if known, this is VMware's unique identifier. This is required if name or moid is not supplied. | |
validate_certs boolean |
| 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 support added in Ansible 2.6. If set to true , please make sure Python >= 2.7.9 is installed on the given machine. |
Notes
Note
- In order to upgrade VMTools, please power on virtual machine before hand - either ‘manually’ or using module community.vmware.vmware_guest_powerstate.
- All modules requires API write access and hence is not supported on a free ESXi license.
Examples
- name: Get VM 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: Upgrade VMware Tools using uuid community.vmware.vmware_guest_tools_upgrade: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" uuid: "{{ vm_facts.instance.hw_product_uuid }}" delegate_to: localhost - name: Upgrade VMware Tools using MoID community.vmware.vmware_guest_tools_upgrade: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" datacenter: "{{ datacenter_name }}" moid: vm-42 delegate_to: localhost
Authors
- Mike Klebolt (@MikeKlebolt) <michael.klebolt@centurylink.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_guest_tools_upgrade_module.html