rabbitmq_exchange – This module manages rabbitMQ exchanges

From Get docs
Ansible/docs/2.7/modules/rabbitmq exchange module


rabbitmq_exchange – This module manages rabbitMQ exchanges

New in version 2.0.


Synopsis

  • This module uses rabbitMQ Rest API to create/delete exchanges

Requirements

The below requirements are needed on the host that executes this module.

  • requests >= 1.0.0

Parameters

Parameter Choices/Defaults Comments

arguments

-

Default:

{}

extra arguments for exchange. If defined this argument is a key/value dictionary

auto_delete

boolean

  • no

  • yes

if the exchange should delete itself after all queues/exchanges unbound from it

durable

boolean

  • no
  • yes

whether exchange is durable or not

exchange_type

-

  • fanout
  • direct

  • headers
  • topic

type for the exchange


aliases: type

internal

boolean

  • no

  • yes

exchange is available only for other exchanges

login_host

-

Default:

"localhost"

rabbitMQ host for connection

login_password

-

Default:

"no"

rabbitMQ password for connection

login_port

-

Default:

15672

rabbitMQ management api port

login_user

-

Default:

"guest"

rabbitMQ user for connection

name

- / required

Name of the exchange to create

state

-

  • present

  • absent

Whether the exchange should be present or absent

vhost

-

Default:

"/"

rabbitMQ virtual host



Examples

# Create direct exchange
- rabbitmq_exchange:
    name: directExchange

# Create topic exchange on vhost
- rabbitmq_exchange:
    name: topicExchange
    type: topic
    vhost: myVhost

Status

Authors

  • Manuel Sousa (@manuel-sousa)

Hint

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


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/rabbitmq_exchange_module.html