vmware.vmware_rest.appliance_health_storage_info module – Get the storage health of 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_storage_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

  • Returns the health status of the storage on the vCenter Server Appliance.

  • The status is reported as a color code that summarizes whether the appliance storage is operating normally or requires attention.

  • Use this module to monitor for storage capacity or performance problems on the appliance.

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 storage health status
  vmware.vmware_rest.appliance_health_storage_info:
  register: storage_health

- name: Display the appliance storage health status
  ansible.builtin.debug:
    var: storage_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 the appliance storage.

Reported as a color code where green indicates normal operation and other values indicate degraded states.

Possible values include green, yellow, orange, red, and gray.

Returned: On success

Sample: "green"

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)