vmware.vmware_rest.vcenter_vm_hardware_info module – Gather information about the virtual hardware settings 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_hardware_info.

New in vmware.vmware_rest 5.0.0

Synopsis

  • Retrieve the top-level virtual hardware settings of a virtual machine.

  • The returned details describe the virtual hardware version (for example VMX_21) and the scheduled hardware upgrade policy and status.

  • Use this module to inspect a virtual machine’s hardware compatibility level, for example to confirm it meets the minimum version required by a feature or to check the state of a pending hardware upgrade.

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 virtual hardware settings 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 the virtual hardware settings for a virtual machine
  vmware.vmware_rest.vcenter_vm_hardware_info:
    vm: vm-1013
  register: hardware_info

- name: Fail if the virtual machine is below hardware version VMX_19
  ansible.builtin.assert:
    that:
      - hardware_info.value.version >= "VMX_19"

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 virtual hardware settings for the queried virtual machine.

Returned: On success

Sample: [{"upgrade_policy": "NEVER", "upgrade_status": "NONE", "version": "VMX_21"}]

value

dictionary

Detailed information about the virtual hardware settings of the virtual machine.

Returned: On success

Sample: {"upgrade_policy": "NEVER", "upgrade_status": "NONE", "version": "VMX_21"}

Authors

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