f5networks.f5_modules.bigiq_application_https_offload 模块 – 管理 BIG-IQ HTTPS 卸载应用程序

注意

此模块是 f5networks.f5_modules 集合 (版本 1.32.1) 的一部分。

如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install f5networks.f5_modules。

要在 playbook 中使用它，请指定：f5networks.f5_modules.bigiq_application_https_offload。

f5networks.f5_modules 1.0.0 中的新功能

概要 

管理用于在 BIG-IP 上使用 SSL 卸载来负载均衡端口 443 上的 HTTPS 应用程序的 BIG-IQ 应用程序。

参数 

参数	注释
add_analytics 布尔值	收集应用程序部署到的 BIG-IP 的统计信息。此参数仅在指定 `service_environment` 时才相关，该 `service_environment` 是 BIG-IP 而不是 SSG。选项 `false` ←（默认） `true`
client_ssl_profile 字典	指定用于管理客户端 SSL 流量的 SSL 配置文件。
cert_key_chain 任何	要与 SSL 配置文件关联的一个或多个证书和密钥。此选项始终是一个列表。列表中的键指定客户端/密钥/链/密码组合的详细信息。 BIG-IP 每个证书/密钥类型只能有一种类型。这意味着每个配置文件只能有一个 RSA、一个 DSA 和一个 ECDSA。如果您尝试分配两个 RSA、DSA 或 ECDSA 证书/密钥组合，设备会拒绝它。此列表是一个复杂的列表，指定了许多键。创建新配置文件时，如果未指定此参数，则默认值为 `inherit`。
cert 字符串	指定要使用的证书名称。
chain 字符串	指定与指定证书和密钥相关的证书链。此键是可选的。
key 字符串	指定密钥名称。
passphrase 字符串	包含密钥文件的密码短语（如果需要）。密码短语在远程 BIG-IP 设备上进行加密。
name 字符串	要创建和使用的客户端 SSL 配置文件的名称。创建新应用程序时，如果未指定此值，则默认值为 `clientssl`。默认值： `"clientssl"`
description 字符串	应用程序的描述。
inbound_virtual 字典	用于配置接收入站连接的虚拟服务器的设置。此虚拟服务器用于托管应用程序的 HTTPS 端点。目标为 `redirect_virtual` 的流量被卸载到此参数，以确保从不安全到安全发生正确的重定向。
address 字符串 / 必需	指定虚拟服务器将流量发送到的目标 IP 地址信息。创建新应用程序时，此参数是必需的。
netmask 字符串 / 必需	指定要与给定的 `address` 关联的网络掩码。创建新应用程序时，此参数是必需的。
port 整数	虚拟服务器侦听连接的端口。创建新应用程序时，如果未指定此参数，则默认值为 `443`。默认值： `443`
name 字符串 / 必需	新应用程序的名称。
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` ←（默认）
redirect_virtual 字典	用于配置接收要重定向的连接的虚拟服务器的设置。此虚拟服务器用于托管应用程序的 HTTP 端点。目标为此参数的流量被卸载到 `inbound_virtual` 参数，以确保从不安全到安全发生正确的重定向。
address 字符串 / 必需	指定虚拟服务器将流量发送到的目标 IP 地址信息。创建新应用程序时，此参数是必需的。
netmask 字符串 / 必需	指定要与给定的 `address` 关联的网络掩码。创建新应用程序时，此参数是必需的。
port 整数	虚拟服务器侦听连接的端口。在创建新应用程序时，如果未指定此参数，则默认值为 `80`。默认值： `80`
servers 列表 / 元素=字典	应用程序托管在其上的服务器列表。如果您熟悉其他 BIG-IP 设置，您也可以将此列表称为池成员列表。在创建新应用程序时，至少需要一台服务器。
address 字符串 / 必需	服务器的 IP 地址。
port 整数	服务器的端口。默认值： `80`
service_environment 字符串	指定将要部署应用程序的服务环境的名称或 BIG-IP 的主机名。在创建新应用程序时，此参数是必需的。
state 字符串	系统上资源的状态。当为 `present` 时，保证资源存在并具有提供的属性。当为 `absent` 时，将从系统中删除资源。选项 `"absent"` `"present"` ← (默认)
wait 布尔值	是否应等待应用程序被创建、删除或更新。选项 `false` `true` ←（默认）

注释 

注意

此模块不适用于 BIG-IQ 6.1.x 或更高版本。
有关使用 Ansible 管理 F5 网络设备的更多信息，请参阅 https://ansible.org.cn/integrations/networks/f5。
需要 BIG-IP 软件版本 >= 12。
F5 模块仅操作 F5 产品的运行配置。为确保特定于 BIG-IP 的配置持久保存到磁盘，请务必至少包含一个使用 f5networks.f5_modules.bigip_config 模块保存运行配置的任务。有关正确使用该模块来保存运行配置的信息，请参阅该模块的文档。

示例 

- name: BIG-IQ CM an HTTPS application on port 443 with SSL offloading on BIG-IP
  bigiq_application_https_offload:
    name: my-app
    description: Redirect HTTP to HTTPS
    service_environment: my-ssg
    servers:
      - address: 1.2.3.4
        port: 8080
      - address: 5.6.7.8
        port: 8080
    inbound_virtual:
      address: 2.2.2.2
      netmask: 255.255.255.255
      port: 443
    redirect_virtual:
      address: 2.2.2.2
      netmask: 255.255.255.255
      port: 80
    provider:
      password: secret
      server: cm.mydomain.com
      user: admin
    state: present
  delegate_to: localhost

返回值 

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

Key	描述
description 字符串	资源的新应用程序描述。返回： changed 示例： `"My application"`
inbound_virtual_destination 字符串	已创建的虚拟的地址。返回： changed 示例： `"6.7.8.9"`
inbound_virtual_netmask 字符串	提供的入站地址的网络掩码。返回： changed 示例： `"255.255.255.0"`
inbound_virtual_port 整数	入站虚拟地址侦听的端口。返回： changed 示例： `80`
servers complex	构成应用程序的服务器及其端口的列表。返回： changed 示例： `"hash/dictionary of values"`
address 字符串	服务器的 IP 地址。返回： changed 示例： `"2.3.4.5"`
port 整数	服务器侦听的端口。返回： changed 示例： `8080`
service_environment 字符串	部署服务的环境。返回： changed 示例： `"my-ssg1"`

作者

Tim Rupp (@caphrim007)