f5networks.f5_modules.bigip_message_routing_protocol 模块 – 管理通用消息解析器配置文件。

注意

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

f5networks.f5_modules 1.0.0 中的新增功能

概要 

管理与消息路由框架一起使用的通用消息解析器配置文件。

参数 

参数	注释
description 字符串	通用解析器配置文件的用户定义描述。
disable_parser 布尔值	当 `true` 时，通用消息解析器被禁用，忽略所有传入的数据包，并且不直接发送消息数据。此模式支持 iRule 脚本协议实现，该实现从传入的传输流生成消息，并在传出的传输流上发送传出消息。选项 `false` `true`
max_egress_buffer 整数	指定发送缓冲区的最大大小（以字节为单位）。如果连接的发送缓冲区中的字节数超过此值，则通用消息协议将停止接收来自路由器的传出消息，直到缓冲区的大小低于此设置。可接受的范围是 0 到 4294967295（含）。
max_msg_size 整数	指定接收消息的最大大小。如果消息超过此大小，则连接将被重置。可接受的范围是 0 到 4294967295（含）。
msg_terminator 字符串	用于终止消息的字符字符串。如果未指定消息终止符，则通用消息解析器不会将输入流分成消息。
name 字符串 / 必填	指定通用解析器配置文件的名称。
no_response 布尔值	设置后，将禁用对请求的响应匹配。选项 `false` `true`
parent 字符串	此解析器配置文件的父模板。设置此值后，将无法更改。创建新配置文件时，如果未指定此参数，则默认为系统提供的 `genericmsg` 配置文件。
partition 字符串	在其中创建路由对象的设备分区。默认值： `"Common"`
provider 字典 f5networks.f5_modules 1.0.0 中新增	包含连接详细信息的字典对象。
auth_provider 字符串	配置 auth 提供程序以从远程设备获取身份验证令牌。此选项在使用 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` ← (默认)
state 字符串	当 `present` 时，确保路由存在。当 `absent` 时，确保路由被删除。选项 `"present"` ← (默认) `"absent"`

备注 

注意

需要 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 parser
  bigip_message_routing_protocol:
    name: foo
    description: 'This is parser'
    no_response: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Modify a generic parser
  bigip_message_routing_protocol:
    name: foo
    no_response: false
    max_egress_buffer: 10000
    max_msg_size: 2000
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove generic parser
  bigip_message_routing_protocol:
    name: foo
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值 

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

键	描述
description 字符串	用户定义的解析器配置文件描述。返回：已更改示例： `"My description"`
disable_parser 布尔值	禁用通用消息解析器。返回：已更改示例： `true`
max_egress_buffer 整数	发送缓冲区的最大大小（以字节为单位）。返回：已更改示例： `10000`
max_msg_size 整数	接收消息的最大大小。返回：已更改示例： `4000`
msg_terminator 字符串	用于终止消息的字符字符串。返回：已更改示例： `"%%%%"`
no_response 布尔值	禁用响应与请求的匹配。返回：已更改示例： `true`
parent 字符串	此解析器配置文件的父模板。返回：已更改示例： `"/Common/genericmsg"`

作者

Wojciech Wypior (@wojtek0806)