gluster.gluster.gluster_peer module – Attach/Detach peers to/from the cluster

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

Note

The gluster.gluster collection is considered unmaintained and will be removed from Ansible 10. See the discussion thread for more information.

Synopsis

  • Create or diminish a GlusterFS trusted storage pool. A set of nodes can be added into an existing trusted storage pool or a new storage pool can be formed. Or, nodes can be removed from an existing trusted storage pool.

Requirements

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

  • GlusterFS > 3.2

Parameters

Parameter

Comments

force

boolean

Applicable only while removing the nodes from the pool. gluster will refuse to detach a node from the pool if any one of the node is down, in such cases force can be used.

Choices:

  • false ← (default)

  • true

nodes

list / elements=string / required

List of nodes that have to be probed into the pool.

state

string / required

Determines whether the nodes should be attached to the pool or removed from the pool. If the state is present, nodes will be attached to the pool. If state is absent, nodes will be detached from the pool.

Choices:

  • "present" ← (default)

  • "absent"

Notes

Note

  • This module does not support check mode.

Examples

- name: Create a trusted storage pool
  gluster.gluster.gluster_peer:
        state: present
        nodes:
             - 10.0.1.5
             - 10.0.1.10

- name: Delete a node from the trusted storage pool
  gluster.gluster.gluster_peer:
         state: absent
         nodes:
              - 10.0.1.10

- name: Delete a node from the trusted storage pool by force
  gluster.gluster.gluster_peer:
         state: absent
         nodes:
              - 10.0.0.1
         force: true

Authors

  • Sachidananda Urs (@sac)