vmware.vmware_rest.vcenter_vm_hardware module – Updates the virtual hardware settings of a virtual machine.

Note

This module is part of the vmware.vmware_rest collection (version 2.1.5).

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

New in version 0.1.0: of vmware.vmware_rest

Synopsis

  • Updates the virtual hardware settings of a virtual machine.

Requirements

The below requirements are needed on the host that executes this module.

  • vSphere 7.0.2 or greater

  • python >= 3.6

  • aiohttp

Parameters

Parameter

Comments

session_timeout

float

added in 2.1.0 of vmware.vmware_rest

Timeout settings for client session.

The maximal number of seconds for the whole operation including connection establishment, request sending and response.

The default value is 300s.

state

string

Choices:

  • present ← (default)

  • upgrade

upgrade_policy

string

The upgrade_policy defines the valid virtual hardware upgrade policies for a virtual machine.

Choices:

  • AFTER_CLEAN_SHUTDOWN

  • ALWAYS

  • NEVER

upgrade_version

string

The version defines the valid virtual hardware versions for a virtual machine. See https://kb.vmware.com/s/article/1003746 (Virtual machine hardware versions (1003746)).

Choices:

  • VMX_03

  • VMX_04

  • VMX_06

  • VMX_07

  • VMX_08

  • VMX_09

  • VMX_10

  • VMX_11

  • VMX_12

  • VMX_13

  • VMX_14

  • VMX_15

  • VMX_16

  • VMX_17

  • VMX_18

  • VMX_19

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_rest_log_file

string

You can use this optional parameter to set the location of a log file.

This file will be used to record the HTTP REST interaction.

The file will be stored on the host that run the module.

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:

  • no

  • yes ← (default)

version

string

The version defines the valid virtual hardware versions for a virtual machine. See https://kb.vmware.com/s/article/1003746 (Virtual machine hardware versions (1003746)).

Choices:

  • VMX_03

  • VMX_04

  • VMX_06

  • VMX_07

  • VMX_08

  • VMX_09

  • VMX_10

  • VMX_11

  • VMX_12

  • VMX_13

  • VMX_14

  • VMX_15

  • VMX_16

  • VMX_17

  • VMX_18

  • VMX_19

vm

string / required

Virtual machine identifier. This parameter is mandatory.

Notes

Note

  • Tested on vSphere 7.0.2

Examples

- name: Upgrade the VM hardware version
  vmware.vmware_rest.vcenter_vm_hardware:
    upgrade_policy: AFTER_CLEAN_SHUTDOWN
    upgrade_version: VMX_11
    vm: "{{ lookup('vmware.vmware_rest.vm_moid', '/my_dc/vm/test_vm1') }}"

Return Values

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

Key

Description

id

dictionary

moid of the resource

Returned: On success

value

dictionary

Upgrade the VM hardware version

Returned: On success

Sample: {}

Authors

  • Ansible Cloud Team (@ansible-collections)