community.general.pacemaker_cluster module – Manage pacemaker clusters

Note

This module is part of the community.general collection (version 9.4.0).

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 community.general.

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

Synopsis

  • This module can manage a pacemaker cluster and nodes from Ansible using the pacemaker cli.

Parameters

Parameter

Comments

force

boolean

Force the change of the cluster state

Choices:

  • false

  • true ← (default)

node

string

Specify which node of the cluster you want to manage. None == the cluster status itself, ‘all’ == check the status of all nodes.

state

string

Indicate desired state of the cluster

Choices:

  • "cleanup"

  • "offline"

  • "online"

  • "restart"

timeout

integer

Timeout when the module should considered that the action has failed

Default: 300

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Examples

---
- name: Set cluster Online
  hosts: localhost
  gather_facts: false
  tasks:
  - name: Get cluster state
    community.general.pacemaker_cluster:
      state: online

Return Values

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

Key

Description

changed

boolean

true if the cluster state has changed

Returned: always

out

string

The output of the current state of the cluster. It return a list of the nodes state.

Returned: always

Sample: "out: [[\"  overcloud-controller-0\", \" Online\"]]}"

rc

boolean

exit code of the module

Returned: always

Authors

  • Mathieu Bultel (@matbu)