W3cubDocs

/Ansible 2.11

community.general.gluster_peer – Attach/Detach peers to/from the cluster

Note

This plugin is part of the community.general collection (version 2.0.1).

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.gluster_peer.

DEPRECATED

Removed in

version 3.0.0

Why

The gluster modules have migrated to the gluster.gluster collection.

Alternative

Use gluster.gluster.gluster_peer instead.

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 Choices/Defaults Comments
force
boolean
    Choices:
  • no ←
  • yes
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.
nodes
list / elements=string / required
List of nodes that have to be probed into the pool.
state
string
    Choices:
  • present ←
  • absent
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.

Notes

Note

  • This module does not support check mode.

Examples

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

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

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

Status

  • This module will be removed in version 3.0.0. [deprecated]
  • For more information see DEPRECATED.

Authors

  • Sachidananda Urs (@sac)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/gluster_peer_module.html