f5networks.f5_modules.bigip_gtm_monitor_https 模块 – 管理 F5 BIG-IP GTM 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.bigip_gtm_monitor_https。

f5networks.f5_modules 1.0.0 中的新功能

概要

• 管理 F5 BIG-IP GTM（现在是 BIG-IP DNS）HTTPS 监视器。

参数

参数	注释
cipher_list 字符串	指定此监视器的密码列表。 密码列表中的项目用冒号 : 符号分隔。 创建新监视器时，如果未指定此参数，则默认列表为 DEFAULT:+SHA:+3DES:+kEDH。
client_cert 字符串	指定客户端证书的完整路径，监视器将该证书发送到目标 SSL 服务器。
client_key 字符串	指定客户端证书的密钥，监视器将该密钥发送到目标 SSL 服务器。
compatibility 布尔值	启用时，指定 SSL 选项设置（在 OpenSSL 中）设置为 all。 创建新监视器时，如果未指定此值，则默认值为 true 选择 false true
ignore_down_response 布尔值	指定监视器允许每个间隔进行多次探测尝试。 当 true 时，指定监视器在监视器超时期间忽略下降响应。一旦在系统没有收到上升响应的情况下达到监视器超时，系统会将对象标记为下降。 当 false 时，指定监视器在收到下降响应时立即将对象标记为下降。 创建新监视器时，如果未提供此参数，则默认值为 false。 选择 false true
interval 整数	指定此模板的监视器实例运行频率的间隔。 如果在创建新监视器时未提供此参数，则默认值为 30。 此值必须小于 timeout 值。
ip 字符串	IP/端口定义中的 IP 地址部分。如果在创建新监视器时未提供此参数，则默认值为“*”。 如果此值为 IP 地址，则必须指定一个 port 号码。
name 字符串 / 必需	监视器名称。
parent 字符串	此监视器模板的父模板。设置此值后，将无法更改。默认情况下，此值是 Common 分区上的 https 父级。 默认值： "/Common/https"
partition 字符串	设备分区以管理资源。 默认值： "Common"
port 字符串	IP/端口定义中的端口地址部分。如果在创建新监视器时未提供此参数，则默认值为“*”。如果指定 IP 地址，则必须指定 1 到 65535 之间的值。
probe_timeout 整数	指定系统在探测请求超时后经过的秒数。 如果在创建新监视器时未提供此参数，则默认值为 5。
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 ←（默认）
receive 字符串	监视器调用的接收字符串。
reverse 布尔值	指示系统在测试成功时将目标资源标记为“宕机”。此设置很有用，例如，如果您的网站主页上的内容是动态的并且经常更改，您可能希望设置一个反向ECV服务检查，查找字符串“Error”。 匹配到此字符串意味着 Web 服务器已宕机。 要使用此选项，您必须为 send 和 receive 指定值。 选择 false true
send 字符串	监视器调用的发送字符串。 创建新监视器时，如果未提供此参数，则使用默认值 GET /\r\n。
state 字符串	当为 present 时，确保监视器存在。 当为 absent 时，确保删除监视器。 选择 "present" ← (默认) "absent"
target_password 字符串	指定密码，如果受监视的目标需要身份验证。
target_username 字符串	指定用户名，如果受监视的目标需要身份验证。
timeout 整数	节点或服务必须在多少秒内响应监视器请求。 如果目标在设定的时间段内响应，则认为它是“启动”的。 如果目标在设定的时间段内没有响应，则认为它是“宕机”的。 您可以将此更改为任何数字，但是，它应该是间隔秒数的 3 倍加 1 秒。 如果创建新监视器时未提供此参数，则默认值为 120。
transparent 布尔值	指定监视器是否以透明模式运行。 处于透明模式的监视器将流量引导通过关联的池成员或节点（通常是路由器或防火墙）到达别名目的地（即，它探测监视器中指定的 ip-port 组合）。 如果监视器无法成功到达别名目的地，则发送监视器流量的池成员或节点将被标记为“宕机”。 创建新监视器时，如果未提供此参数，则默认值为 false。 选择 false true
update_password 字符串	如果指定了 target_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 GTM HTTPS monitor
  bigip_gtm_monitor_https:
    name: my_monitor
    ip: 1.1.1.1
    port: 80
    send: my send string
    receive: my receive string
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Remove HTTPS Monitor
  bigip_gtm_monitor_https:
    name: my_monitor
    state: absent
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Add HTTPS monitor for all addresses, port 514
  bigip_gtm_monitor_https:
    name: my_monitor
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
    port: 514
  delegate_to: localhost

返回值

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

Key	描述
cipher_list 字符串	密码列表的新值。 返回: changed 示例: "+3DES:+kEDH"
client_cert 字符串	新的客户端证书设置。 返回: changed 示例: "/Common/default"
client_key 字符串	新的客户端密钥设置。 返回: changed 示例: "/Common/default"
compatibility 布尔值	新的 SSL 兼容性设置。 返回: changed 示例: true
ignore_down_response 布尔值	是否忽略“宕机”响应。 返回: changed 示例: true
interval 整数	运行监视器检查的新间隔。 返回: changed 示例: 2
ip 字符串	IP/端口定义的新 IP。 返回: changed 示例: "10.12.13.14"
parent 字符串	监视器的新父模板。 返回: changed 示例: "https"
port 字符串	监视器检查资源的新端口。 返回: changed 示例: "8080"
probe_timeout 整数	系统将监视器探测超时的新的超时时间。 返回: changed 示例: 10
receive 字符串	此监视器的新接收字符串。 返回: changed 示例: "tcp string to receive"
reverse 布尔值	监视器是否以反向模式运行的新值。 返回: changed 示例: false
send 字符串	此监视器的新发送字符串。 返回: changed 示例: "tcp string to send"
timeout 整数	远程系统必须响应监视器的新的超时时间。 返回: changed 示例: 10
transparent 布尔值	监视器是否以透明模式运行的新值。 返回: changed 示例: false

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

合集链接

• 问题跟踪器
• 主页
• 存储库 (来源)