gluster.gluster.gluster_heal_info module – Gather information on self-heal or rebalance status

Note

This module is part of the gluster.gluster collection (version 1.0.2).

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 gluster.gluster. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: gluster.gluster.gluster_heal_info.

Synopsis

  • Gather facts about either self-heal or rebalance status.

  • This module was called gluster_heal_facts before Ansible 2.9, returning ansible_facts. Note that the gluster.gluster.gluster_heal_info module no longer returns ansible_facts!

Requirements

The below requirements are needed on the host that executes this module.

  • GlusterFS > 3.2

Parameters

Parameter

Comments

name

aliases: volume

string / required

The volume name.

status_filter

string

Determines which facts are to be returned.

If the status_filter is self-heal, status of self-heal, along with the number of files still in process are returned.

If the status_filter is rebalance, rebalance status is returned.

Choices:

  • "self-heal" ← (default)

  • "rebalance"

Examples

- name: Gather self-heal facts about all gluster hosts in the cluster
  gluster.gluster.gluster_heal_info:
    name: test_volume
    status_filter: self-heal
  register: self_heal_status
- debug:
    var: self_heal_status

- name: Gather rebalance facts about all gluster hosts in the cluster
  gluster.gluster.gluster_heal_info:
    name: test_volume
    status_filter: rebalance
  register: rebalance_status
- debug:
    var: rebalance_status

Return Values

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

Key

Description

heal_info

list / elements=string

List of files that still need healing process

Returned: On success

name

string

GlusterFS volume name

Returned: always

rebalance_status

list / elements=string

Status of rebalance operation

Returned: On success

status_filter

string

Whether self-heal or rebalance status is to be returned

Returned: always

Authors

  • Devyani Kota (@devyanikota)