f5networks.f5_modules.bigip_profile_oneconnect 模块 – 在 BIG-IP 上管理 OneConnect 配置文件

注意

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

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 管理 BIG-IP 系统上的 OneConnect 配置文件。

参数

参数	注释
description 字符串	配置文件的描述。
idle_timeout_override 字符串	指定连接空闲多少秒后，连接流才符合删除条件。 创建新配置文件时，如果未指定此参数，则由父配置文件提供默认值。 您可以指定超时替代的秒数。 当为 disabled 时，表示连接没有超时替代。 当为 indefinite 时，表示连接可以空闲，没有超时替代。
limit_type 字符串	当为 none 时，通过 TCP 连接到池成员的并发进行中的请求和响应都计入限制。这是历史行为。 当为 idle 时，达到 TCP 连接限制时，空闲连接将被丢弃。在短暂的时间间隔内，在丢弃空闲连接和建立新连接重叠期间，TCP 连接限制可能会超出。 当为 strict 时，TCP 连接限制将被严格遵守，没有任何例外。这意味着空闲连接将阻止建立新的 TCP 连接，直到它们过期，即使它们可以重用。 strict 除非在具有短过期超时的非常特殊情况下，否则不建议配置。 创建新配置文件时，如果未指定此参数，则由父配置文件提供默认值。 选项 "none" "idle" "strict"
maximum_age 整数	指定连接在连接重用池中允许的最长时间（秒）。 对于任何年龄超过此值的连接，系统都会将其从重用池中删除。 创建新配置文件时，如果未指定此参数，则由父配置文件提供默认值。
maximum_reuse 整数	指定服务器端连接可以重用的最大次数。 创建新配置文件时，如果未指定此参数，则由父配置文件提供默认值。
maximum_size 整数	指定系统在连接重用池中保存的连接的最大数量。 如果池已满，则服务器端连接在响应完成后关闭。 创建新配置文件时，如果未指定此参数，则由父配置文件提供默认值。
name 字符串 / 必需	指定 OneConnect 配置文件的名称。
parent 字符串	指定此配置文件继承设置的配置文件。 创建新配置文件时，如果未指定此参数，则默认为系统提供的 oneconnect 配置文件。
partition 字符串	用于管理资源的设备分区。 默认值： "Common"
provider 字典 f5networks.f5_modules 1.0.0 中新增	包含连接详细信息的字典对象。
auth_provider 字符串	配置 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 ← (默认)
share_pools 布尔值	指示连接不仅可以在虚拟服务器内共享，还可以在类似的虚拟服务器之间共享。 当true时，所有使用相同OneConnect和其他内部网络配置文件的虚拟服务器都可以共享连接。 创建新配置文件时，如果未指定此参数，则由父配置文件提供默认值。 选项 false true
source_mask 字符串	指定系统应用于源地址的值，以确定其是否符合重用条件。 创建新配置文件时，如果未指定此参数，则由父配置文件提供默认值。 系统将此设置的值应用于服务器端源地址，以确定其是否符合重用条件。 掩码为0会导致系统跨所有源地址共享重用连接。主机掩码为32会导致系统仅共享来自同一源地址的重用连接。 使用SNAT或SNAT池时，系统会先转换服务器端源地址，然后将OneConnect掩码应用于转换后的地址。
state 字符串	当present时，确保配置文件存在。 当absent时，确保配置文件被删除。 选项 "present" ← (默认) "absent"

备注

注意

• 有关使用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 OneConnect profile
  bigip_profile_oneconnect:
    name: foo
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

返回值

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

键	描述
description 字符串	配置文件的描述。 返回：changed 示例："My profile"
idle_timeout_override 字符串	新的空闲超时覆盖。 返回：changed 示例："disabled"
limit_type 字符串	配置文件的新限制类型。 返回：changed 示例："idle"
maximum_age 整数	连接重用池中允许的连接最大秒数。 返回：changed 示例：2000
maximum_reuse 整数	服务器端连接可以重用的最大次数。 返回：changed 示例：1000
maximum_size 整数	系统在连接重用池中持有的最大连接数。 返回：changed 示例：3000
share_pools 布尔值	在类似的虚拟服务器之间共享连接。 返回：changed 示例：true
source_mask 字符串	系统应用于源地址的值，以确定其是否符合重用条件。 返回：changed 示例："255.255.255.255"

作者

• Tim Rupp (@caphrim007)

收藏链接

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