f5networks.f5_modules.bigip_message_routing_router 模块 – 管理消息路由协议的路由器配置文件

注意

此模块是 f5networks.f5_modules 集合 (版本 1.32.1) 的一部分。

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

要安装它，请使用： ansible-galaxy collection install f5networks.f5_modules。

要在 playbook 中使用它，请指定： f5networks.f5_modules.bigip_message_routing_router。

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 管理消息路由协议的路由器配置文件。

参数

参数	注释
description 字符串	路由器配置文件的用户定义描述。
ignore_client_port 布尔值	当设置为 true 时，在搜索现有连接时，将忽略客户端连接（对等体连接到 BIG-IP 的连接）上的远程端口。 选项 false true
inherited_traffic_group 布尔值	设置为 true 时，traffic_group 将继承自包含文件夹。如果未指定，则系统在创建新的路由器配置文件时将其设置为 false。 选项 false true
max_pending_bytes 整数	等待创建与对等体的连接时将保留的待处理消息的最大字节数。达到此限制后，任何其他发送给对等体的消息都将被标记为无法投递并返回给发送者。 可接受的范围是 0 到 4294967295（包含）。
max_pending_messages 整数	等待创建与对等体的连接时将保留的待处理消息的最大数量。达到此限制后，任何其他发送给对等体的消息都将被标记为无法投递并返回给发送者。 可接受的范围是 0 到 65535（包含）。
max_retries 整数	设置 MR::retry iRule 命令最多可以重新提交消息以进行重新路由的次数。 可接受的范围是 0 到 4294967295（包含）。
mirror 布尔值	启用或禁用状态镜像。状态镜像可用于在备用单元中维护与活动单元中相同的状态信息。 选项 false true
mirrored_msg_sweeper_interval 整数	指定消息在备用设备上等待活动设备路由消息时将保存的最大毫秒数。 在备用设备上保存的时间超过可配置的清理间隔的消息将被丢弃。 可接受的范围是 0 到 4294967295（包含）。
name 字符串 / 必需	指定路由器配置文件的名称。
parent 字符串	此路由器配置文件的父模板。设置此值后，将无法更改。 如果未指定，则系统将设置默认值，这些默认值与创建的路由器类型相对应，例如，对于 generic type，默认值为 /Common/messagerouter，依此类推。
partition 字符串	在其中创建路由器配置文件的设备分区。 默认值： "Common"
provider 字典 f5networks.f5_modules 1.0.0 中新增	包含连接详细信息的字典对象。
auth_provider 字符串	配置身份验证提供程序以从远程设备获取身份验证令牌。 此选项在使用 BIG-IQ 设备时非常有用。
no_f5_teem 布尔值	如果为 yes，则不会将 TEEM 遥测数据发送到 F5。 您可以通过设置环境变量 F5_TELEMETRY_OFF 来省略此选项。 以前使用的变量 F5_TEEM 已弃用，因为其名称令人困惑。 选项 false ← (默认) true
password 别名：pass、pwd 字符串 / 必需	用于连接到 BIG-IP 或 BIG-IQ 的用户帐户的密码。 您可以通过设置环境变量 F5_PASSWORD 来省略此选项。
server 字符串 / 必需	BIG-IP 主机或 BIG-IQ 主机。 您可以通过设置环境变量 F5_SERVER 来省略此选项。
server_port 整数	BIG-IP 服务器端口。 您可以通过设置环境变量 F5_SERVER_PORT 来省略此选项。 默认值： 443
timeout 整数	指定与网络设备通信的超时时间（以秒为单位），用于连接或发送命令。如果在操作完成之前超时，则模块将出错。
transport 字符串	配置连接到远程设备时要使用的传输连接。 选项 "rest" ← (默认)
user 字符串 / 必需	连接到 BIG-IP 或 BIG-IQ 的用户名。此用户必须具有设备上的管理权限。 您可以通过设置环境变量 F5_USER 来省略此选项。
validate_certs 布尔值	如果为 no，则不验证 SSL 证书。仅在使用自签名证书的个人控制站点上使用此选项。 您可以通过设置环境变量 F5_VALIDATE_CERTS 来省略此选项。 选项 false true ← (默认)
routes 列表 / 元素=字符串	指定路由器实例要使用的静态路由列表。 路由必须与路由器配置文件位于同一分区。
state 字符串	当为 present 时，确保路由器配置文件存在。 当absent时，确保路由器配置文件被移除。 选项 "present" ← (默认) "absent"
traffic_group 字符串	指定路由器配置文件的流量组。 将traffic_group设置为空字符串""将导致设备继承自包含文件夹，这意味着设备上的inherited_traffic_group值为true。
type 字符串	用于指定要管理的路由器配置文件类型的参数。 默认设置为generic，更多选项即将推出。 选项 "generic" ← (默认)
use_local_connection 布尔值	如果true，路由器将把消息路由到与接收消息相同的TMM上的现有连接。 选项 false true

注释

注意

• 需要BIG-IP >= 14.0.0

• 有关使用Ansible管理F5网络设备的更多信息，请参见 https://ansible.org.cn/integrations/networks/f5。

• 需要BIG-IP软件版本 >= 12。

• F5模块仅操作F5产品的运行配置。为了确保BIG-IP特定配置持久保存到磁盘，请务必包含至少一项使用f5networks.f5_modules.bigip_config模块保存运行配置的任务。请参考模块的文档，了解保存运行配置的正确使用方法。

示例

- name: Create a generic router profile
  bigip_message_routing_router:
    name: foo
    max_retries: 10
    ignore_client_port: true
    routes:
      - /Common/route1
      - /Common/route2
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Modify a generic router profile
  bigip_message_routing_router:
    name: foo
    ignore_client_port: false
    mirror: true
    mirrored_msg_sweeper_interval: 4000
    traffic_group: /Common/traffic-group-2
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove a generic router profile
  bigip_message_routing_router:
    name: foo
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

常见的返回值已在此处记录此处，以下是此模块特有的字段

键	描述
description 字符串	路由器配置文件的用户定义描述。 返回：changed 示例："My description"
ignore_client_port 布尔值	在搜索现有连接时，允许忽略客户端连接上的远程端口。 返回：changed 示例：false
inherited_traffic_group 布尔值	指定是否应从包含文件夹继承流量组。 返回：changed 示例：true
max_pending_bytes 整数	将保存的待处理消息的最大字节数。 返回：changed 示例：10000
max_pending_messages 整数	将保存的待处理消息的最大数量。 返回：changed 示例：64
max_retries 整数	消息可以重新提交进行重新路由的最大次数。 返回：changed 示例：10
mirror 布尔值	启用或禁用状态镜像。 返回：changed 示例：true
mirrored_msg_sweeper_interval 整数	消息在备用设备上保存的最大时间（毫秒）。 返回：changed 示例：2000
parent 字符串	此路由器配置文件的父模板。 返回：changed 示例："/Common/messagerouter"
routes 列表 / 元素=字符串	路由器实例要使用的静态路由列表。 返回：changed 示例：["/Common/route1", "/Common/route2"]
traffic_group 字符串	路由器配置文件的流量组。 返回：changed 示例："/Common/traffic-group-1"
use_local_connection 布尔值	启用将消息路由到与接收消息相同的TMM上的现有连接。 返回：changed 示例：true

作者

• Wojciech Wypior (@wojtek0806)

集合链接

• 问题跟踪器
• 主页
• 代码库 (源代码)