vmware.vmware_rest.appliance_system_version_info module – Gather version information about the vCenter Server Appliance.

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

New in vmware.vmware_rest 5.0.0

DEPRECATED

Removed in:

version 6.0.0

Why:

This functionality has been moved to vmware.vmware.appliance_info.

Alternative:

Use vmware.vmware.appliance_info instead.

Synopsis

  • Retrieve version information about the vCenter Server Appliance.

  • Returns details such as the product name, version, build number, deployment type, release name, and the date and time when the appliance was first installed.

  • When the appliance has been patched, the summary and release date of the applied patch are also reported.

  • Use this module to confirm the running version and build of the appliance before or after applying updates.

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)

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 version information about the appliance
  vmware.vmware_rest.appliance_system_version_info:
  register: appliance_version

- name: Show the appliance product name, version, and build
  ansible.builtin.debug:
    msg: "{{ appliance_version.value.product }} {{ appliance_version.value.version }} build {{ appliance_version.value.build }}"

Return Values

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

Key

Description

info

list / elements=dictionary

A list containing the version information about the appliance.

Returned: On success

Sample: [{"build": "12345678", "install_time": "2024-07-31T18:18:32.000Z", "name": "VMware vCenter Server 9.1.0", "product": "VMware vCenter Server", "releasedate": "", "summary": "", "type": "vCenter Server with an embedded Platform Services Controller", "version": "9.1.0.10000"}]

value

dictionary

Detailed version information about the appliance.

Returned: On success

Sample: {"build": "12345678", "install_time": "2024-07-31T18:18:32.000Z", "name": "VMware vCenter Server 9.1.0", "product": "VMware vCenter Server", "releasedate": "", "summary": "", "type": "vCenter Server with an embedded Platform Services Controller", "version": "9.1.0.10000"}

Status

  • This module will be removed in version 6.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

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