ansible.builtin.rabbitmq_binding (v2.7.10) — module

This module manages rabbitMQ bindings

| "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.7.10

Description

This module uses rabbitMQ REST APIs to create / delete bindings.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Bind myQueue to directExchange with routing key info
- rabbitmq_binding:
    name: directExchange
    destination: myQueue
    type: queue
    routing_key: info
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Bind directExchange to topicExchange with routing key *.info
- rabbitmq_binding:
    name: topicExchange
    destination: topicExchange
    type: exchange
    routing_key: '*.info'

Inputs

    
name:
    aliases:
    - src
    - source
    description:
    - source exchange to create binding on.
    required: true

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the bindings should be present or absent.
    - Only present implemented at the momemt.

vhost:
    default: /
    description:
    - rabbitMQ virtual host.

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

login_host:
    default: localhost
    description:
    - rabbitMQ host for the connection.

login_port:
    default: 15672
    description:
    - rabbitMQ management API port.

login_user:
    default: guest
    description:
    - rabbitMQ user for the connection.

destination:
    aliases:
    - dst
    - dest
    description:
    - destination exchange or queue for the binding.
    required: true

routing_key:
    default: '#'
    description:
    - routing key for the binding.

login_password:
    default: false
    description:
    - rabbitMQ password for the connection.

destination_type:
    aliases:
    - type
    - dest_type
    choices:
    - queue
    - exchange
    description:
    - Either queue or exchange.
    required: true