community.rabbitmq.rabbitmq_upgrade module – Execute rabbitmq-upgrade commands

Note

This module is part of the community.rabbitmq collection (version 1.2.3).

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

To use it in a playbook, specify: community.rabbitmq.rabbitmq_upgrade.

New in community.rabbitmq 1.1.0

Synopsis

  • Allows to execute rabbitmq-upgrade commands

Parameters

Parameter

Comments

action

string / required

Specify action to be executed.

Choices:

  • "await_online_quorum_plus_one"

  • "await_online_synchronized_mirror"

  • "post_upgrade"

  • "drain"

  • "revive"

node

string

Erlang node name of the target rabbit node.

Default: "rabbit"

Examples

- name: Drain 'rabbit@node-1' node (in other words, put it into maintenance mode)
  community.rabbitmq.rabbitmq_upgrade:
    action: drain
    node: rabbit@node-1

Authors

  • Damian Dabrowski (@damiandabrowski5)