f5networks.f5_modules.bigiq_application_http 模块 – 管理 BIG-IQ HTTP 应用程序

注意

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

f5networks.f5_modules 1.0.0 中的新增功能

概要

  • 管理用于在 BIG-IP 系统上 80 端口上负载均衡 HTTP 应用程序的 BIG-IQ 应用程序。

参数

参数

注释

add_analytics

布尔值

收集部署应用程序的 BIG-IP 的统计信息。

此参数仅在指定 service_environment 为 BIG-IP 时才相关;而不是 SSG。

选项

  • false ← (默认)

  • true

description

字符串

应用程序的描述。

inbound_virtual

字典

配置接收入站连接的虚拟机的设置。

此虚拟机用于托管应用程序的 HTTP 端点。

address

字符串 / 必需

指定虚拟服务器发送流量的目标 IP 地址信息。

创建新应用程序时,此参数是必需的。

netmask

字符串 / 必需

指定与给定 destination 关联的子网掩码。

创建新应用程序时,此参数是必需的。

port

整数

虚拟机监听连接的端口。

创建新应用程序时,如果未指定此参数,则默认值为 80

默认值: 80

name

字符串 / 必需

新应用程序的名称。

provider

字典

f5networks.f5_modules 1.0.0 中新增

包含连接详细信息的字典对象。

auth_provider

字符串

配置 auth 提供程序,以从远程设备获取身份验证令牌。

此选项在使用 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 ← (默认)

servers

列表 / 元素=字典

托管应用程序的服务器列表。

如果您熟悉其他 BIG-IP 设置,您也可以将此列表称为池成员列表。

创建新应用程序时,至少需要一个服务器。

address

字符串 / 必需

服务器的 IP 地址。

port

整数

服务器的端口。

创建新应用程序并指定服务器时,如果未提供此参数,则默认为 80

默认值: 80

service_environment

字符串

指定部署应用程序的服务环境的名称。

创建新应用程序时,此参数是必需的。

此模块会自动发现服务环境类型。因此,务必为不同服务环境类型(目前为 SSG 和 BIG-IP)中的项目维护唯一的名称。

state

字符串

系统上资源的状态。

present 时,保证资源存在并具有提供的属性。

absent时,会从系统中移除资源。

选项

  • "absent"

  • "present" ← (默认)

等待

布尔值

如果模块应该等待应用程序创建、删除或更新。

选项

  • 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 HTTP application on port 80 on BIG-IP
  bigiq_application_http:
    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:
      name: foo
      address: 2.2.2.2
      netmask: 255.255.255.255
      port: 443
    provider:
      password: secret
      server: cm.mydomain.com
      user: admin
    state: present
  delegate_to: localhost

返回值

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

描述

description

字符串

资源应用程序的新描述。

返回:已更改

示例: "我的 应用程序"

inbound_virtual_destination

字符串

已创建虚拟机的目标。

返回:已更改

示例: "6.7.8.9"

inbound_virtual_netmask

字符串

提供的入站目标的网络掩码。

返回:已更改

示例: "255.255.255.0"

inbound_virtual_port

整数

入站虚拟地址监听的端口。

返回:已更改

示例: 80

servers

复杂

构成应用程序的服务器及其端口列表。

返回:已更改

示例: "值 哈希/字典"

address

字符串

服务器的 IP 地址。

返回:已更改

示例: "2.3.4.5"

port

整数

服务器监听的端口。

返回:已更改

示例: 8080

service_environment

字符串

部署服务的环境。

返回:已更改

示例: "my-ssg1"

作者

  • Tim Rupp (@caphrim007)