vmware.vmware_rest.vcenter_vm_tools_info module – Gather information about the VMware Tools running in a virtual machine.

Note

This module is part of the vmware.vmware_rest collection (version 5.0.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 vmware.vmware_rest.

To use it in a playbook, specify: vmware.vmware_rest.vcenter_vm_tools_info.

New in vmware.vmware_rest 5.0.0

Synopsis

  • Retrieve the current state of VMware Tools installed in the guest operating system of a virtual machine.

  • Returned details include the installed Tools version, its run state and version status, the installation type, and the configured Tools upgrade policy.

  • Use this module to check whether Tools are running and up to date before performing guest operations that depend on VMware Tools.

Parameters

Parameter

Comments

session_timeout

float

Timeout in seconds for the whole operation including connection establishment, request sending, and response.

Default: 300.0

vcenter_hostname

string / required

The hostname or IP address of the vSphere vCenter.

If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.

vcenter_password

string / required

The vSphere vCenter password.

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

vcenter_port

integer

The port number of the vSphere vCenter.

If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.

vcenter_rest_log_file

string

Optional path to a log file for HTTP REST interaction.

If the value is not specified in the task, the value of environment variable VMWARE_REST_LOG_FILE will be used instead.

vcenter_username

string / required

The vSphere vCenter username.

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

vcenter_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.

Choices:

  • false

  • true ← (default)

vm

string / required

Identifier of the virtual machine whose VMware Tools information should be gathered.

Must be an identifier (MOID) for a Vm resource.

Notes

Note

  • Generated from vSphere API spec 9.1.0.

  • Compatible with vSphere API 7.0.3.

  • Compatible with vSphere API 8.0.2.

Examples

- name: Gather VMware Tools information for a virtual machine
  vmware.vmware_rest.vcenter_vm_tools_info:
    vm: vm-1013
  register: tools_info

- name: Fail if VMware Tools are not running
  ansible.builtin.assert:
    that:
      - tools_info.value.run_state == "RUNNING"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

info

list / elements=string

A list containing the detailed VMware Tools information for the queried virtual machine.

Returned: On success

Sample: [{"auto_update_supported": false, "install_attempt_count": 0, "install_type": "OPEN_VM_TOOLS", "run_state": "RUNNING", "upgrade_policy": "MANUAL", "version": "12325", "version_number": 12325, "version_status": "CURRENT"}]

value

dictionary

Detailed information about the VMware Tools installed in the virtual machine.

Returned: On success

Sample: {"auto_update_supported": false, "install_attempt_count": 0, "install_type": "OPEN_VM_TOOLS", "run_state": "RUNNING", "upgrade_policy": "MANUAL", "version": "12325", "version_number": 12325, "version_status": "CURRENT"}

Authors

  • Ansible Eco Content Team (@eco-ansible-content)