community.rabbitmq.rabbitmq_parameter (1.3.0) — module

Manage RabbitMQ parameters

Authors: Chris Hoffman (@chrishoffman)

Install collection

Install with ansible-galaxy collection install community.rabbitmq:==1.3.0


Add to requirements.yml

  collections:
    - name: community.rabbitmq
      version: 1.3.0

Description

Manage dynamic, cluster-wide parameters for RabbitMQ

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set the federation parameter 'local_username' to a value of 'guest' (in quotes)
  community.rabbitmq.rabbitmq_parameter:
    component: federation
    name: local-username
    value: '"guest"'
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create or update a shovel
  vars:
    payload:
      src-protocol: "amqp091"
      src-uri: "amqp://"
      src-queue: "src-queue"
      dest-protocol: "amqp091"
      dest-uri: "amqp://guest:guest@example.com"
      dest-queue: "dest-queue"
  community.rabbitmq.rabbitmq_parameter:
    component: shovel
    name: "shovel-name"
    value: "{{ payload | to_json }}"
    state: present

Inputs

    
name:
    description:
    - Name of the parameter being set
    required: true
    type: str

node:
    default: rabbit
    description:
    - erlang node name of the rabbit we wish to configure
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Specify if parameter is to be added or removed
    type: str

value:
    description:
    - Value of the parameter, as a JSON term
    type: str

vhost:
    default: /
    description:
    - vhost to apply access privileges.
    type: str

component:
    description:
    - Name of the component of which the parameter is being set
    required: true
    type: str