vmware.vmware_rest.appliance_health_database_info module – Get the health status of the vCenter Server Appliance database.

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

New in vmware.vmware_rest 5.0.0

Synopsis

  • Returns the health status of the database used by the vCenter Server Appliance.

  • The response reports an overall status along with any messages describing database issues and their severity.

  • Use this module to detect database corruption or degradation that could impact vCenter Server functionality.

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.

  • This endpoint is deprecated as of vSphere 9.1.0.

Examples

- name: Get the appliance database health status
  vmware.vmware_rest.appliance_health_database_info:
  register: database_health

- name: Display the appliance database health status
  ansible.builtin.debug:
    var: database_health.value

Return Values

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

Key

Description

info

list / elements=dictionary

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: [{"messages": [], "status": "HEALTHY"}]

value

dictionary

The health status of the appliance database.

Returned: On success

Sample: {"messages": [], "status": "HEALTHY"}

messages

list / elements=dictionary

Messages describing any issues with the database, along with their severity.

Returned: On success

message

dictionary

A localizable message describing the issue with the database.

Returned: On success

severity

string

The severity of the message, either ERROR or WARNING.

Returned: On success

Sample: "WARNING"

status

string

The overall health status of the database.

HEALTHY means the database is healthy, DEGRADED means it has issues with low impact on vCenter Server, and UNHEALTHY means the database is corrupted and vCenter Server functionality will be impacted.

Returned: On success

Sample: "HEALTHY"

Authors

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