f5networks.f5_modules.bigip_profile_persistence_cookie 模块 – 管理 BIG-IP 上的 Cookie 持久性配置文件

注意

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

f5networks.f5_modules 1.0.0 中的新增功能

概要

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

参数

参数	注释
always_send 布尔值	在每次回复时发送 Cookie 持久性条目，即使该条目之前已提供给客户端。 选项 false true
cookie_encryption 字符串	指定 Cookie 加密格式的使用方式。 当 disabled 时，生成未加密的 Cookie 格式。 当 preferred 时，生成加密的 Cookie，但接受加密和未加密的格式。 当 required 时，Cookie 格式必须加密。 选项 "disabled" "preferred" "required"
cookie_method 字符串	指定系统使用的 Cookie 处理类型。 当 hash 时，指定服务器提供 Cookie，然后系统将其一致地映射到特定节点。 此持久性类型需要一个 cookie_name 值。 当 insert 时，指定系统将服务器信息（以 Cookie 的形式）插入到服务器响应的标头中。 当 passive 时，指定服务器提供 Cookie，该 Cookie 格式化为正确的服务器信息和超时。 此持久性类型需要一个 cookie_name 值。 当 rewrite 时，指定系统拦截从服务器发送的 BIGipCookie 标头，并覆盖该 Cookie 的名称和值。 选项 "hash" "insert" "passive" "rewrite"
cookie_name 字符串	指定 Cookie 的唯一名称。
description 字符串	配置文件的描述。
encrypt_cookie_pool_name 布尔值	指定是否应加密插入的 BIG-IP 默认 Cookie 中的池名称。 选项 false true
encryption_passphrase 字符串	指定用于 Cookie 加密的密码。
expiration 字典	指定 Cookie 的过期时间。 默认情况下，系统生成并使用会话 Cookie。 此 Cookie 在用户会话过期时过期（当浏览器关闭时）。
days 整数	Cookie 过期时间（以天为单位）。 该值必须在 0 到 24855 天的范围内。
hours 整数	Cookie 过期时间（以小时为单位）。 该值必须在 0 到 23 小时的范围内。
minutes 整数	Cookie 过期时间（以分钟为单位）。 该值必须在 0 到 59 分钟的范围内。
seconds 整数	Cookie 过期时间（以秒为单位）。 该值必须在 0 到 59 秒的范围内。 默认值： 0
http_only 布尔值	指定是否应为插入的 Cookie 启用或禁用 httponly 属性。 选项 false true
match_across_pools 布尔值	当 true 时，指定系统可以使用任何包含此持久性记录的池。 创建新配置文件时，如果未指定此参数，则默认值由父配置文件提供。 选项 false true
match_across_services 布尔值	当 true 时，指定来自客户端 IP 地址的所有到同一虚拟 IP 地址的持久连接也到同一节点。 创建新配置文件时，如果未指定此参数，则默认值由父配置文件提供。 选项 false true
match_across_virtuals 布尔值	当 true 时，指定来自同一客户端 IP 地址的所有持久连接都到同一节点。 创建新配置文件时，如果未指定此参数，则默认值由父配置文件提供。 选项 false true
name 字符串 / 必需	指定配置文件的名称。
override_connection_limit 布尔值	当为 true 时，指定系统允许您指定为持久化客户端覆盖池成员连接限制。 每个虚拟连接的限制仍然是硬性限制，不会被覆盖。 选项 false true
父级 字符串	指定此配置文件从中继承设置的配置文件。 创建新配置文件时，如果未指定此参数，则默认值为系统提供的 cookie 配置文件。 默认值: "cookie"
分区 字符串	要在其上管理资源的设备分区。 默认值: "Common"
提供程序 字典 在 f5networks.f5_modules 1.0.0 中添加	包含连接详细信息的 dict 对象。
身份验证提供程序 字符串	配置身份验证提供程序以从远程设备获取身份验证令牌。 此选项主要用于处理 BIG-IQ 设备。
no_f5_teem 布尔值	如果为 yes，则不会将 TEEM 遥测数据发送到 F5。 您可以通过设置环境变量 F5_TELEMETRY_OFF 来省略此选项。 以前使用的变量 F5_TEEM 已弃用，因为其名称容易混淆。 选项 false ← (默认) true
密码 别名: pass, pwd 字符串 / 必需	用于连接 BIG-IP 或 BIG-IQ 的用户帐户的密码。 您可以通过设置环境变量 F5_PASSWORD 来省略此选项。
服务器 字符串 / 必需	BIG-IP 主机或 BIG-IQ 主机。 您可以通过设置环境变量 F5_SERVER 来省略此选项。
服务器端口 整数	BIG-IP 服务器端口。 您可以通过设置环境变量 F5_SERVER_PORT 来省略此选项。 默认值: 443
超时 整数	指定与网络设备通信的超时时间（以秒为单位），用于连接或发送命令。如果在操作完成之前超过超时时间，模块将出错。
传输 字符串	配置连接到远程设备时使用的传输连接。 选项 "rest" ← (默认)
用户 字符串 / 必需	用于连接 BIG-IP 或 BIG-IQ 的用户名。此用户必须具有设备上的管理权限。 您可以通过设置环境变量 F5_USER 来省略此选项。
验证证书 布尔值	如果为 no，则不验证 SSL 证书。仅在个人控制的使用自签名证书的站点上使用此选项。 您可以通过设置环境变量 F5_VALIDATE_CERTS 来省略此选项。 选项 false true ← (默认)
安全 布尔值	指定是否应为插入的 cookie 启用或禁用安全属性。 选项 false true
状态 字符串	当为 present 时，确保配置文件存在。 当为 absent 时，确保配置文件被删除。 选项 "present" ← (默认) "absent"
更新密码 字符串	always 将允许在用户选择这样做时更新密码。on_create 将仅为新创建的配置文件设置密码。 选项 "always" ← (默认) "on_create"

备注

注意

• 有关使用 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 persistence cookie profile
  bigip_profile_persistence_cookie:
    name: foo
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost
- name: Create a persistence cookie profile with expiration time
  bigip_profile_persistence_cookie:
    name: foo
    expiration:
      days: 7
      hours: 12
      minutes: 30
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

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

键	描述
always_send 布尔值	新的“始终发送”值。 返回值: 已更改 示例: false
cookie_encryption 字符串	新的 Cookie 加密类型。 返回值: 已更改 示例: "preferred"
cookie_method 字符串	新的 Cookie 方法。 返回值: 已更改 示例: "insert"
cookie_name 字符串	新的 Cookie 名称值。 返回值: 已更改 示例: "cookie1"
description 字符串	新的描述。 返回值: 已更改 示例: "My description"
encrypt_cookie_pool_name 布尔值	新的“加密 Cookie 池名称”值。 返回值: 已更改 示例: true
expiration 复杂	cookie 的过期时间。 返回值: 已更改 示例: "hash/dictionary of values"
days 整数	cookie 过期时间（以天为单位）。 返回值: 已更改 示例: 125
hours 整数	cookie 过期时间（以小时为单位）。 返回值: 已更改 示例: 22
minutes 整数	cookie 过期时间（以分钟为单位）。 返回值: 已更改 示例: 58
seconds 整数	cookie 过期时间（以秒为单位）。 返回值: 已更改 示例: 20
http_only 布尔值	新的“仅 HTTP”值。 返回值: 已更改 示例: true
match_across_pools 布尔值	新的“跨池匹配”值。 返回值: 已更改 示例: true
match_across_services 布尔值	新的“跨服务匹配”值。 返回值: 已更改 示例: false
match_across_virtuals 布尔值	新的“跨虚拟匹配”值。 返回值: 已更改 示例: true
override_connection_limit 布尔值	新的“覆盖连接限制”值。 返回值: 已更改 示例: false
父级 字符串	父配置文件。 返回值: 已更改 示例: "/Common/cookie"
安全 布尔值	新的“安全 Cookie”值。 返回值: 已更改 示例: false

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

集合链接

• 问题跟踪器
• 主页
• 存储库（源）