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

From Get docs
Ansible/docs/2.10/collections/gluster/gluster/gluster heal info module


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

Note

This plugin is part of the gluster.gluster collection (version 1.0.1).

To install it use: ansible-galaxy collection install gluster.gluster.

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 Choices/Defaults Comments

name

string / required

The volume name.


aliases: volume

status_filter

string

  • self-heal

  • rebalance

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.



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 Returned Description

heal_info

list / elements=string

On success

List of files that still need healing process


name

string

always

GlusterFS volume name


rebalance_status

list / elements=string

On success

Status of rebalance operation


status_filter

string

always

Whether self-heal or rebalance status is to be returned





Authors

  • Devyani Kota (@devyanikota)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/gluster/gluster/gluster_heal_info_module.html