vmware.vmware_rest.vcenter_vm_tools_installer module – Connect or disconnect the VMware Tools installer CD-ROM 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_installer.

New in vmware.vmware_rest 5.0.0

Synopsis

  • Connect or disconnect the VMware Tools installer CD image on a virtual machine.

  • Connecting mounts the VMware Tools installer as a CD-ROM for the guest operating system so that the Tools installation can be started from inside the guest.

  • On Windows guests with autorun enabled, connecting typically starts the installer automatically, though it still requires user input in the guest to complete. On other guest operating systems the installer is made available but must be launched with guest-specific steps.

  • This module only mounts or unmounts the installer media; it does not perform the installation itself. To track installation progress, query the Tools status with vmware.vmware_rest.vcenter_vm_tools_info.

Parameters

Parameter

Comments

session_timeout

float

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

Default: 300.0

state

string / required

The action to perform on the VMware Tools installer media.

Use connect to mount the VMware Tools installer as a CD-ROM in the guest.

Use disconnect to unmount the VMware Tools installer CD image.

Both actions are always applied and do not support idempotence.

Choices:

  • "connect"

  • "disconnect"

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 installer media 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: Connect the VMware Tools installer CD-ROM
  vmware.vmware_rest.vcenter_vm_tools_installer:
    vm: vm-1013
    state: connect

- name: Disconnect the VMware Tools installer CD image
  vmware.vmware_rest.vcenter_vm_tools_installer:
    vm: vm-1013
    state: disconnect

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 set to a supported action.

Sample: "vm-1013"

value

any

The raw API response body from the vCenter operation.

The connect and disconnect actions return an empty body on success.

Returned: On success

Sample: {}

Authors

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