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

string

配置文件的描述。

idle_timeout_override

string

指定在连接流符合删除条件之前连接空闲的秒数。

创建新配置文件时，如果未指定此参数，则默认值由父配置文件提供。

您可以为超时覆盖指定秒数。

当 disabled 时，指定连接没有超时覆盖。

当 indefinite 时，指定连接可以空闲而没有超时覆盖。

limit_type

string

当 none 时，通过 TCP 连接到池成员的并发飞行中的请求和响应会计算到限制中。这是历史行为。

当 idle 时，当达到 TCP 连接限制时，将删除空闲连接。对于短时间间隔，在删除空闲连接和建立新连接的重叠期间，可能会超过 TCP 连接限制。

当 strict 时，TCP 连接限制将被遵守，没有例外。这意味着空闲连接将阻止建立新的 TCP 连接，直到它们过期，即使它们可以被重用。

除了在具有短过期超时的非常特殊的情况下，不建议使用 strict。

创建新配置文件时，如果未指定此参数，则默认值由父配置文件提供。

选择

  • "none"

  • "idle"

  • "strict"

maximum_age

integer

指定连接在连接重用池中允许的最大秒数。

对于任何年龄高于此值的连接，系统都会从重用池中删除该连接。

创建新配置文件时，如果未指定此参数，则默认值由父配置文件提供。

maximum_reuse

integer

指定服务器端连接可以重用的最大次数。

创建新配置文件时，如果未指定此参数，则默认值由父配置文件提供。

maximum_size

integer

指定系统在连接重用池中保持的最大连接数。

如果池已满，则服务器端连接会在响应完成后关闭。

创建新配置文件时，如果未指定此参数，则默认值由父配置文件提供。

name

string / 必需

指定 OneConnect 配置文件的名称。

parent

string

指定此配置文件从中继承设置的配置文件。

创建新配置文件时，如果未指定此参数，则默认值是系统提供的 oneconnect 配置文件。

partition

string

设备分区以管理资源。

默认值： "Common"

provider

dictionary

在 f5networks.f5_modules 1.0.0 中添加

包含连接详细信息的 dict 对象。

auth_provider

string

配置身份验证提供程序以从远程设备获取身份验证令牌。

此选项实际上用于处理 BIG-IQ 设备。

no_f5_teem

boolean

如果 yes，则不会将 TEEM 遥测数据发送到 F5。

您可以通过设置环境变量 F5_TELEMETRY_OFF 来省略此选项。

以前使用的变量 F5_TEEM 已被弃用，因为它的名称令人困惑。

选择

  • false ←（默认）

  • true

password

别名：pass, pwd

string / 必需

用于连接到 BIG-IP 或 BIG-IQ 的用户帐户的密码。

您可以通过设置环境变量 F5_PASSWORD 来省略此选项。

server

string / 必需

BIG-IP 主机或 BIG-IQ 主机。

您可以通过设置环境变量 F5_SERVER 来省略此选项。

server_port

integer

BIG-IP 服务器端口。

您可以通过设置环境变量 F5_SERVER_PORT 来省略此选项。

默认值： 443

timeout

integer

指定与网络设备通信（连接或发送命令）的超时时间（以秒为单位）。如果在操作完成之前超时，模块将出错。

transport

string

配置连接到远程设备时使用的传输连接。

选择

  • "rest" ←（默认）

user

string / 必需

连接到 BIG-IP 或 BIG-IQ 的用户名。此用户必须在设备上具有管理权限。

您可以通过设置环境变量 F5_USER 来省略此选项。

validate_certs

boolean

如果为 no，则不验证 SSL 证书。仅在个人控制的、使用自签名证书的站点上使用此选项。

您可以通过设置环境变量 F5_VALIDATE_CERTS 来省略此选项。

选择

  • false

  • true ← (默认)

share_pools

boolean

表示连接不仅可以在虚拟服务器内共享，还可以在类似的虚拟服务器之间共享。

当为 true 时，所有使用相同 OneConnect 和其他内部网络配置文件的虚拟服务器都可以共享连接。

创建新配置文件时，如果未指定此参数，则默认值由父配置文件提供。

选择

  • false

  • true

source_mask

string

指定系统应用于源地址以确定其重用资格的值。

创建新配置文件时，如果未指定此参数，则默认值由父配置文件提供。

系统将此设置的值应用于服务器端源地址，以确定其重用资格。

掩码为 0 会导致系统跨所有源地址共享重用的连接。主机掩码为 32 会导致系统仅共享来自同一源地址的重用连接。

当您使用 SNAT 或 SNAT 池时，会先转换服务器端源地址，然后将 OneConnect 掩码应用于转换后的地址。

state

string

当为 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

string

配置文件的描述。

返回: changed

示例: "My profile"

idle_timeout_override

string

新的空闲超时覆盖。

返回: changed

示例: "disabled"

limit_type

string

配置文件的新限制类型。

返回: changed

示例: "idle"

maximum_age

integer

连接在连接重用池中允许的最大秒数。

返回: changed

示例: 2000

maximum_reuse

integer

服务器端连接可以重用的最大次数。

返回: changed

示例: 1000

maximum_size

integer

系统在连接重用池中保持的最大连接数。

返回: changed

示例: 3000

share_pools

boolean

在类似的虚拟服务器之间共享连接。

返回: changed

示例: true

source_mask

string

系统应用于源地址以确定其重用资格的值。

返回: changed

示例: "255.255.255.255"

作者

  • Tim Rupp (@caphrim007)