community.rabbitmq.rabbitmq_upgrade – Execute rabbitmq-upgrade commands

Note

This plugin is part of the community.rabbitmq collection (version 1.1.0).

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 version 1.1.0: of community.rabbitmq

Synopsis

  • Allows to execute rabbitmq-upgrade commands

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • await_online_quorum_plus_one
  • await_online_synchronized_mirror
  • post_upgrade
  • drain
  • revive
Specify action to be executed.
node
string
Default:
"rabbit"
Erlang node name of the target rabbit node.

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)

© 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/rabbitmq/rabbitmq_upgrade_module.html