Documentation

rabbitmq_vhost - Manage the state of a virtual host in RabbitMQ

Synopsis

  • Manage the state of a virtual host in RabbitMQ

Parameters

Parameter Choices/Defaults Comments
name
required
The name of the vhost to manage

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

aliases: trace

Examples

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

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • “Chris Hoffman (@choffman)”

Hint

If you notice any issues in this documentation you can edit this document to improve it.