f5networks.f5_modules.bigip_message_routing_peer 模块 – 管理用于路由通用消息协议消息的对等方

注意

此模块是 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_peer。

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 管理用于路由通用消息协议消息的对等方。

参数

参数	注释
auto_init 布尔值	如果 true，则 BIG-IP 会使用指定的 transport_config 配置自动创建到指定 pool 中活动池成员的出站连接。 为了使自动初始化尝试创建连接，对等方必须包含在附加到路由器实例的路由中。对于对等方包含的每个路由器实例，都会启动一个连接。 auto_init 逻辑会在 auto_init_interval 验证 BIG-IP 和池成员之间是否存在连接。如果连接不存在，它会尝试重新建立连接。 选择 false true
auto_init_interval 整数	指定启动连接尝试的间隔。 对等方对象创建时，系统提供的默认值为 5000 毫秒。 接受的范围是 0 到 4294967295（含）。
connection_mode 字符串	指定如何限制每个主机的连接数。 选择 "per-blade" "per-client" "per-peer" "per-tmm"
description 字符串	对等方的用户定义描述。
name 字符串 / 必需	指定要管理的对等方的名称。
number_of_connections 整数	指定 BIG-IP 和远程主机之间的连接分布。 接受的范围是 0 到 65535（含）。
partition 字符串	在其上创建对等方对象的设备分区。 默认值： "Common"
pool 字符串	指定消息路由到的池的名称。 指定的池必须与对等方位于同一分区上。
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 ← (默认)
ratio 整数	指定用于在 LTM 路由中的对等方列表中选择对等方的比率。 接受的范围是 0 到 4294967295（含）。
state 字符串	当为 present 时，确保对等方存在。 当为 absent 时，确保删除对等方。 选择 "present" ← (默认) "absent"
transport_config 字符串	用于创建出站连接的 LTM 虚拟或 LTM 传输配置的名称。 资源必须与对等方对象位于同一分区上。
type 字符串	用于指定要管理的对等端类型的参数。 默认设置为 generic，后续将提供更多选项。 选择 "generic" ← (默认)

注释

注意

• 需要 BIG-IP >= 14.0.0

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

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

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

示例

- name: Create a simple peer
  bigip_message_routing_peer:
    name: foobar
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create message routing peer with additional settings
  bigip_message_routing_peer:
    name: foobar
    connection_mode: per-blade
    pool: /baz/bar
    partition: baz
    transport_config: foovirtual
    ratio: 10
    auto_init: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Modify message routing peer settings
  bigip_message_routing_peer:
    name: foobar
    partition: baz
    ratio: 20
    auto_init_interval: 2000
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove message routing peer
  bigip_message_routing_peer:
    name: foobar
    partition: baz
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

通用返回值已在此处记录 此处，以下是此模块独有的字段

键	描述
auto_init 布尔值	启用创建到活动池成员的出站连接。 返回: changed 示例: true
auto_init_interval 整数	尝试发起连接的间隔。 返回: changed 示例: 2000
connection_mode 字符串	指定如何限制每个主机的连接数。 返回: changed 示例: "per-peer"
description 字符串	用户定义的对等端描述。 返回: changed 示例: "Some description"
number_of_connections 整数	BIG-IP 和远程主机之间的连接分配。 返回: changed 示例: 2000
pool 字符串	消息路由指向的池的名称。 返回: changed 示例: "/Bazbar/foobar"
ratio 整数	用于在 LTM 路由中的对等端列表中选择对等端的比率。 返回: changed 示例: 500
transport_config 字符串	用于创建出站连接的 LTM 虚拟或 LTM 传输配置。 返回: changed 示例: "/Common/foobar"

作者

• Wojciech Wypior (@wojtek0806)

集合链接

• 问题跟踪器
• 主页
• 存储库（源代码）