vmware.vmware_rest.appliance_health_softwarepackages_info module – Get the health status of available software updates for 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_health_softwarepackages_info.

New in vmware.vmware_rest 5.0.0

Synopsis

  • Returns information about software updates available in the remote vSphere Update Manager repository.

  • The status is reported as a color code where red means security updates are available, orange means non-security updates are available, green means no updates are available, and gray means the update information could not be retrieved.

  • Use this module to detect whether the appliance has pending software or security 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: Get the appliance software packages health status
  vmware.vmware_rest.appliance_health_softwarepackages_info:
  register: softwarepackages_health

- name: Display the appliance software packages health status
  ansible.builtin.debug:
    var: softwarepackages_health.value

Return Values

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

Key

Description

info

list / elements=string

The same information as value, returned as a list for consistency with other info modules.

This endpoint returns a single item, so the list always contains one element.

Returned: On success

Sample: ["green"]

value

string

The health status of available software updates for the appliance.

red indicates security updates are available, orange indicates non-security updates are available, green indicates no updates are available, and gray indicates the update information could not be retrieved.

Returned: On success

Sample: "green"

Authors

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