f5networks.f5_modules.bigip_profile_persistence_universal 模块 – 管理通用持久性配置文件

注意

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

f5networks.f5_modules 1.1.0 中的新增功能

概要 

管理 BIG-IP 系统上的通用持久性配置文件。

参数 

参数	注释
app_service 字符串	要与此配置文件关联的 iApp 服务。如果未指定服务，则默认值为 None。
match_across_pools 布尔值	当 `true` 时，指定系统可以使用包含此持久性记录的任何池。创建新配置文件时，如果未指定此参数，则默认值由父配置文件提供。选择 `false` `true`
match_across_services 布尔值	当 `true` 时，指定来自客户端 IP 地址的所有持久连接，这些连接到同一虚拟 IP 地址，也会转到同一节点。创建新配置文件时，如果未指定此参数，则默认值由父配置文件提供。选择 `false` `true`
match_across_virtuals 布尔值	当 `true` 时，指定来自同一客户端 IP 地址的所有持久连接都转到同一节点。创建新配置文件时，如果未指定此参数，则默认值由父配置文件提供。选择 `false` `true`
mirror 布尔值	当 `true` 时，指定如果活动单元进入备用模式，系统会将任何持久性记录镜像到其对等方。创建新配置文件时，如果未指定此参数，则默认值由父配置文件提供。选择 `false` `true`
name 字符串 / 必需	指定配置文件的名称。
override_connection_limit 布尔值	当 `true` 时，指定系统允许您指定池成员连接限制将为持久客户端覆盖。每个虚拟连接的限制仍然是硬限制，不会被覆盖。选择 `false` `true`
parent 字符串	指定此配置文件从中继承设置的配置文件。创建新配置文件时，如果未指定此参数，则默认值为系统提供的 `universal` 配置文件。
partition 字符串	设备分区，用于管理资源。默认: `"Common"`
provider 字典在 f5networks.f5_modules 1.0.0 中添加	包含连接详细信息的字典对象。
auth_provider 字符串	配置身份验证提供程序以从远程设备获取身份验证令牌。此选项主要在处理 BIG-IQ 设备时使用。
no_f5_teem 布尔值	如果 `yes`，则不会将 TEEM 遥测数据发送到 F5。您可以通过设置环境变量 `F5_TELEMETRY_OFF` 来省略此选项。以前使用的变量 `F5_TEEM` 已弃用，因为其名称令人困惑。选择 `false` ← (默认) `true`
密码别名: 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` ← (默认)
rule 字符串	指定用于选择持久性条目的 iRule。创建新配置文件时，如果未指定此参数，则默认值为 `None`，这将禁用此设置。
state 字符串	当为 `present` 时，确保配置文件存在。当为 `absent` 时，确保配置文件被删除。选择 `"present"` ← (默认) `"absent"`
timeout 字符串	指定持久性条目的持续时间。创建新配置文件时，如果未指定此参数，则默认值由父配置文件提供。要指定无限超时，请使用值 `indefinite`。如果指定数值超时，则该值必须介于 `1` 和 `4294967295` 之间。

备注 

注意

有关使用 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 profile
  bigip_profile_persistence_universal:
    name: foo
    state: present
    match_across_services: true
    match_across_virtuals: true
    mirror: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值 

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

Key	描述
app_service 字符串	与此配置文件关联的 iApp 服务返回: changed 示例: `"/Common/good_service.app/good_service"`
match_across_pools 布尔值	新的 Match Across Pools 值。返回: changed 示例: `true`
match_across_services 布尔值	新的 Match Across Services 值。返回: changed 示例: `false`
match_across_virtuals 布尔值	新的 Match Across Virtuals 值。返回: changed 示例: `true`
mirror 布尔值	新的 Mirror 值。返回: changed 示例: `true`
override_connection_limit 布尔值	新的 Override Connection Limit 值。返回: changed 示例: `false`
parent 字符串	父配置文件。返回: changed 示例: `"/Common/cookie"`
rule 字符串	用于选择持久性条目的 iRule。返回: changed 示例: `"/Common/_sys_https_redirect"`
timeout 字符串	持久性条目的持续时间。返回: changed 示例: `"180"`

作者

Nitin Khanna (@nitinthewiz)