vmware.vmware_rest.vcenter_vm_tools module – Manage the VMware Tools configuration of 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.

New in vmware.vmware_rest 5.0.0

Synopsis

  • Configure the VMware Tools settings of a virtual machine, such as the automatic upgrade policy.

  • Trigger an upgrade of the VMware Tools installed in the guest operating system.

  • This module does not install VMware Tools; the guest must already have a supported Tools package present for an upgrade to succeed.

Parameters

Parameter

Comments

command_line_options

string

Command line options passed to the Tools installer to customize the upgrade procedure.

Only used when state=upgrade. Leave unset to run the upgrade with default options.

session_timeout

float

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

Default: 300.0

state

string

The desired state of the resource.

Use present to create or update the resource.

Use upgrade to perform the upgrade action.

Only options present support idempotence.

Choices:

  • "present" ← (default)

  • "upgrade"

upgrade_policy

string

Controls when VMware Tools are automatically upgraded on the virtual machine.

MANUAL - No automatic upgrades are performed. Tools must be upgraded on demand by running this module with state=upgrade.

UPGRADE_AT_POWER_CYCLE - When the virtual machine is power-cycled, the system checks for a newer version of Tools on power on. If one is available, Tools are upgraded automatically and the guest is rebooted if necessary.

Applied when state=present.

This property was added in vSphere API 7.0.0.0.

If not set, the upgrade policy is left unchanged.

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 configuration should be managed.

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: Set the VMware Tools upgrade policy to upgrade at power cycle
  vmware.vmware_rest.vcenter_vm_tools:
    vm: vm-1013
    upgrade_policy: UPGRADE_AT_POWER_CYCLE
    state: present

- name: Revert the VMware Tools upgrade policy to manual
  vmware.vmware_rest.vcenter_vm_tools:
    vm: vm-1013
    upgrade_policy: MANUAL
    state: present

- name: Upgrade VMware Tools now
  vmware.vmware_rest.vcenter_vm_tools:
    vm: vm-1013
    state: upgrade

- name: Upgrade VMware Tools with custom installer options
  vmware.vmware_rest.vcenter_vm_tools:
    vm: vm-1013
    command_line_options: /S /v"/qn REBOOT=R"
    state: upgrade

Return Values

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

Key

Description

id

string

MOID of the managed virtual machine.

Returned: When state is present, or when state is set to a supported action.

Sample: "vm-1013"

value

any

The raw API response body from the vCenter operation.

Returned: On success

Sample: {"upgrade_policy": "UPGRADE_AT_POWER_CYCLE"}

Authors

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