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 字符串	配置 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 ← (默认)
接收字符串 (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) 字符串	always 如果指定了 target_password，则始终更新密码。 on_create 仅为新创建的监控设置密码。 选项 "always" ← (默认) "on_create"

注释

注意

• 有关使用 Ansible 管理 F5 网络设备的更多信息，请参见 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)

集合链接

• 问题追踪器
• 主页
• 代码仓库