vmware.vmware_rest.appliance_update_info module – Gather information about the current appliance update status.

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

New in vmware.vmware_rest 5.0.0

Synopsis

  • Retrieve the current status of the vCenter Server Appliance update.

  • Reports whether the appliance is up to date, has updates pending, or is currently staging or installing an update.

  • Returns the relevant version string and, when available, details about the running or completed update task and the time of the last query to the update repository.

  • Use this module to check for available appliance updates or to monitor the progress of an ongoing update.

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 the current appliance update status
  vmware.vmware_rest.appliance_update_info:
  register: appliance_update

- name: Show the appliance update state and version
  ansible.builtin.debug:
    msg: "Update state is {{ appliance_update.value.state }} for version {{ appliance_update.value.version }}"

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 current appliance update status.

Returned: On success

Sample: [{"latest_query_time": "2024-07-31T18:18:32.000Z", "state": "UP_TO_DATE", "version": "9.1.0.10000"}]

value

dictionary

Detailed information about the current appliance update status.

Returned: On success

Sample: {"latest_query_time": "2024-07-31T18:18:32.000Z", "state": "UP_TO_DATE", "version": "9.1.0.10000"}

Authors

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