community.rabbitmq.rabbitmq_vhost – Manage the state of a virtual host in RabbitMQ
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_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
|
|
The state of vhost
|
| tracing
boolean
|
|
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/rabbitmq/rabbitmq_vhost_module.html