community.rabbitmq.rabbitmq_exchange 模块 – 管理 rabbitMQ 交换器

注意

此模块是 community.rabbitmq 集合(版本 1.3.0)的一部分。

如果您正在使用 ansible 包,则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install community.rabbitmq。您需要进一步的要求才能使用此模块,请参阅 要求 了解详细信息。

要在剧本中使用它,请指定:community.rabbitmq.rabbitmq_exchange

概要

  • 此模块使用 rabbitMQ Rest API 来创建/删除交换器

要求

执行此模块的主机需要以下要求。

  • requests >= 1.0.0

参数

参数

注释

arguments

字典

交换器的额外参数。如果定义,此参数是一个键/值字典。

默认值: {}

auto_delete

布尔值

如果所有队列/交换器都从交换器解除绑定后,交换器是否应该自行删除。

选择

  • false ← (默认)

  • true

ca_cert

别名:cacert

路径

用于验证与管理 API 的 SSL 连接的 CA 证书。

client_cert

别名:cert

路径

用于在与管理 API 的 SSL 连接上发送的客户端证书。

client_key

别名:key

路径

与客户端证书匹配的私钥。

durable

布尔值

交换器是否持久化。

选择

  • false

  • true ← (默认)

exchange_type

别名:type

字符串

交换器的类型。

如果使用 x-delayed-messagex-randomx-consistent-hashx-recent-history,则必须启用 RabbitMQ 服务器上的相应插件。

RabbitMQ 服务器必须启用。

选择

  • "fanout"

  • "direct" ← (默认)

  • "headers"

  • "topic"

  • "x-delayed-message"

  • "x-random"

  • "x-consistent-hash"

  • "x-recent-history"

internal

布尔值

交换器仅适用于其他交换器。

选择

  • false ← (默认)

  • true

login_host

字符串

用于连接的 RabbitMQ 主机。

默认值: "localhost"

login_password

字符串

用于连接的 RabbitMQ 密码。

默认值: "guest"

login_port

字符串

RabbitMQ 管理 API 端口。

默认值: "15672"

login_protocol

字符串

RabbitMQ 管理 API 协议。

选择

  • "http" ← (默认)

  • "https"

login_user

字符串

用于连接的 RabbitMQ 用户。

默认值: "guest"

name

字符串 / 必需

要创建的交换器的名称。

state

字符串

交换器是否应该存在或不存在。

选择

  • "present" ← (默认)

  • "absent"

vhost

字符串

RabbitMQ 虚拟主机。

默认值: "/"

示例

- name: Create direct exchange
  community.rabbitmq.rabbitmq_exchange:
    name: directExchange

- name: Create topic exchange on vhost
  community.rabbitmq.rabbitmq_exchange:
    name: topicExchange
    type: topic
    vhost: myVhost

作者

  • Manuel Sousa (@manuel-sousa)