community.general.pacemaker_cluster – Manage pacemaker clusters
Note
This plugin is part of the community.general collection (version 3.8.1).
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 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 | Choices/Defaults | Comments |
|---|---|---|
| force boolean |
| Force the change of the cluster state |
| 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 |
| timeout integer | Default: 300 | Timeout when the module should considered that the action has failed |
Examples
---
- name: Set cluster Online
hosts: localhost
gather_facts: no
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 | Returned | Description |
|---|---|---|
| changed boolean | always | True if the cluster state has changed |
| out string | always | The output of the current state of the cluster. It return a list of the nodes state. Sample: out: [[" overcloud-controller-0", " Online"]]} |
| rc boolean | always | exit code of the module |
Authors
- Mathieu Bultel (@matbu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/pacemaker_cluster_module.html