ansible.builtin.rabbitmq_exchange (v2.4.6.0-1) — module

This module manages rabbitMQ exchanges

| "added in version" 2.0 of ansible.builtin"

Authors: Manuel Sousa (@manuel-sousa)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.4.6.0.post1

Description

This module uses rabbitMQ Rest API to create/delete exchanges


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Create direct exchange
- rabbitmq_exchange:
    name: directExchange
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Create topic exchange on vhost
- rabbitmq_exchange:
    name: topicExchange
    type: topic
    vhost: myVhost

Inputs

    
name:
    description:
    - Name of the exchange to create
    required: true

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the exchange should be present or absent
    - Only present implemented atm
    required: false

vhost:
    default: /
    description:
    - rabbitMQ virtual host
    required: false

durable:
    choices:
    - 'yes'
    - 'no'
    default: true
    description:
    - whether exchange is durable or not
    required: false

internal:
    choices:
    - 'yes'
    - 'no'
    default: false
    description:
    - exchange is available only for other exchanges
    required: false

arguments:
    default: {}
    description:
    - extra arguments for exchange. If defined this argument is a key/value dictionary
    required: false

login_host:
    default: localhost
    description:
    - rabbitMQ host for connection
    required: false

login_port:
    default: 15672
    description:
    - rabbitMQ management api port
    required: false

login_user:
    default: guest
    description:
    - rabbitMQ user for connection
    required: false

auto_delete:
    choices:
    - 'yes'
    - 'no'
    default: false
    description:
    - if the exchange should delete itself after all queues/exchanges unbound from it
    required: false

exchange_type:
    aliases:
    - type
    choices:
    - fanout
    - direct
    - headers
    - topic
    default: direct
    description:
    - type for the exchange
    required: false

login_password:
    default: false
    description:
    - rabbitMQ password for connection
    required: false