community.rabbitmq.rabbitmq_vhost module – Manage the state of a virtual host in RabbitMQ

Note

This module is part of the community.rabbitmq collection (version 1.3.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_vhost.

Synopsis

  • Manage the state of a virtual host in RabbitMQ

Parameters

Parameter

Comments

name

aliases: vhost

string / required

The name of the vhost to manage

node

string

erlang node name of the rabbit we wish to configure

Default: "rabbit"

state

string

The state of vhost

Choices:

  • "present" ← (default)

  • "absent"

tracing

aliases: trace

boolean

Enable/disable tracing for a vhost

Choices:

  • false ← (default)

  • true

Examples

- name: Ensure that the vhost /test exists.
  community.rabbitmq.rabbitmq_vhost:
    name: /test
    state: present

Authors

  • Chris Hoffman (@chrishoffman)