f5networks.f5_modules.bigip_message_routing_route 模块 – 管理消息路由协议的静态路由

注意

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

f5networks.f5_modules 1.0.0 中的新增功能

概要 

管理消息路由协议的静态路由。

参数 

参数	注释
描述字符串	静态路由的用户定义描述。
dst_address 字符串	指定路由的目标地址。将属性设置为空字符串将创建一个匹配所有消息目标地址的通配符，这是创建新路由时的默认值。
名称字符串 / 必需	指定静态路由的名称。
分区字符串	要在其上创建路由对象的设备分区。默认值： `"Common"`
peer_selection_mode 字符串	指定从提供的 `peers` 列表中选择对等体时要使用的方法。选择 `"ratio"` `"sequential"`
peers 列表 / elements=string	指定 ltm messagerouting-peer 对象的列表。指定的对等体必须与路由位于同一分区上。
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` ← (默认)
src_address 字符串	指定路由的源地址。将属性设置为空字符串将创建一个匹配所有消息源地址的通配符，这是创建新路由时的默认值。
state 字符串	当为 `present` 时，确保路由存在。当为 `absent` 时，确保路由被删除。选择 `"present"` ← (默认) `"absent"`
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 generic route
  bigip_message_routing_route:
    name: foobar
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Modify a generic route
  bigip_message_routing_route:
    name: foobar
    peers:
      - peer1
      - peer2
    peer_selection_mode: ratio
    src_address: annoying_user
    dst_address: blackhole
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove a generic
  bigip_message_routing_route:
    name: foobar
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值 

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

Key	描述
描述字符串	路由的用户定义描述。返回： changed 示例： `"Some description"`
dst_address 字符串	路由的目标地址。返回： changed 示例: `"blackhole"`
peer_selection_mode 字符串	选择对等节点时使用的方法。返回： changed 示例: `"ratio"`
peers 列表 / elements=string	ltm messagerouting-peer 对象的列表。返回： changed 示例: `["/Common/peer1", "/Common/peer2"]`
src_address 字符串	路由的源地址。返回： changed 示例: `"annyoing_user"`

作者

Wojciech Wypior (@wojtek0806)