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 上对 443 端口上的 HTTPS 应用程序进行负载均衡并进行 SSL 卸载的 BIG-IQ 应用程序。

参数

参数	注释
add_analytics 布尔值	收集部署应用程序的 BIG-IP 的统计信息。 此参数仅在指定 service_environment 为 BIG-IP（而非 SSG）时才相关。 选项 false ← (默认) true
client_ssl_profile 字典	指定用于管理客户端 SSL 流量的 SSL 配置文件。
cert_key_chain 任意类型	一个或多个与 SSL 配置文件关联的证书和密钥。 此选项始终为列表。列表中的键决定客户端/密钥/链/密码组合的详细信息。 BIG-IP 每个证书/密钥类型只能拥有一个。 如果您尝试分配两个 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 ← (默认)

注释

注意

• 此模块不适用于BIGIQ 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)

收藏链接

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