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_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
parent 字符串	指定此配置文件继承设置的配置文件。 创建新配置文件时，如果未指定此参数，则默认为系统提供的 cookie 配置文件。 默认值： "cookie"
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
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 ← (默认)
secure 布尔值	指定是否应为插入的 Cookie 启用或禁用安全属性。 选项 false true
state 字符串	当 present 时，确保配置文件存在。 当 absent 时，确保配置文件已删除。 选项 "present" ← (默认) "absent"
update_password 字符串	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

返回值

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

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

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

收藏链接

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