W3cubDocs

/Ansible 2.10

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

Note

This plugin is part of the community.rabbitmq collection.

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 Choices/Defaults Comments
name
string / required
The name of the vhost to manage

aliases: vhost
node
string
Default:
"rabbit"
erlang node name of the rabbit we wish to configure
state
string
    Choices:
  • present ←
  • absent
The state of vhost
tracing
boolean
    Choices:
  • no ←
  • yes
Enable/disable tracing for a vhost

aliases: trace

Examples

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

Authors

  • Chris Hoffman (@chrishoffman)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/rabbitmq/rabbitmq_vhost_module.html