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

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 管理 F5 BIG-IP LTM HTTPS 监控器。

参数

参数	注释
cipher_list 字符串 在 f5networks.f5_modules 1.3.0 中添加	指定此监控器的密码列表。 密码列表中的项目用冒号 : 分隔。
description 字符串	监控器的描述。
interval 整数	指定此模板的监控器实例运行频率的间隔。如果创建新监控器时未提供此参数，则默认值为 5。此值必须小于 timeout 值。
ip 字符串	IP/端口定义中的 IP 地址部分。如果创建新监控器时未提供此参数，则默认值为“*”。
name 字符串 / 必需	监控器名称。
parent 字符串	此监控器模板的父模板。一旦设置此值，就无法更改。默认情况下，此值是 Common 分区上的 https 父模板。 默认： "/Common/https"
partition 字符串	设备分区，用于管理资源。 默认： "Common"
port 字符串	IP/端口定义中的端口地址部分。如果创建新监控器时未提供此参数，则默认值为“*”。如果指定 IP 地址，则必须指定 1 到 65535 之间的值。
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 字符串	监控器调用的接收字符串。
receive_disable 字符串	此设置的工作方式类似于 receive，不同之处在于，当其响应与 receive_disable 字符串匹配但不与 receive 匹配时，系统会将节点或池成员标记为禁用。要使用此设置，必须同时指定 receive_disable 和 receive。
reverse 布尔值 在 f5networks.f5_modules 1.12.0 中添加	指定监控器是否在反向模式下运行。 当监控器处于反向模式时，成功的接收字符串匹配会将受监控的对象标记为关闭而不是开启。只有在配置 receive 选项时才能使用此模式。 此参数与 time_until_up 参数不兼容。如果指定了 time_until_up，则其值必须为 0。或者，如果它已存在，则其值必须为 0。 选择 false true
发送 字符串	用于监控调用的发送字符串。创建新监控器时，如果未提供此值，则使用默认的 GET /\\r\\n。
ssl_profile 字符串	指定用于 HTTPS 监控的 SSL 配置文件。 定义 SSL 配置文件可以精细定制 HTTPS 监控的 SSL 属性。 此参数仅在 BIG-IP 13.x 及更高版本上受支持。
状态 字符串	当 present 时，确保监控器存在。 当 absent 时，确保删除监控器。 选择 "present" ← (默认) "absent"
target_password 字符串	指定被监控目标需要身份验证时的密码。
target_username 字符串	指定被监控目标需要身份验证时的用户名。
time_until_up 整数	指定在第一次成功响应后，将节点标记为“up”之前的时间（以秒为单位）。值为 0 会导致在从节点收到有效响应后立即将节点标记为“up”。如果在创建新监控器时未提供此参数，则默认值为 0。
timeout 整数	节点或服务必须响应监控器请求的秒数。如果目标在设定的时间内响应，则认为其处于“up”状态。如果目标未在设定的时间内响应，则认为其处于“down”状态。您可以将其更改为任何数字，但是，它应该是间隔秒数的 3 倍加 1 秒。如果在创建新监控器时未提供此参数，则默认值为 16。
up_interval 整数	指定当资源处于“up”状态时，系统用于执行健康检查的间隔。 当 0 时，指定系统使用 interval 中指定的间隔来检查资源的健康状况。 当为任何其他数字时，允许您在检查处于“up”状态的资源的健康状况时指定不同的间隔。

备注

注意

• 需要 BIG-IP 软件版本 >= 12

• 有关使用 Ansible 管理 F5 Networks 设备的更多信息，请参阅 https://ansible.org.cn/integrations/networks/f5。

• 需要 BIG-IP 软件版本 >= 12。

• F5 模块仅操作 F5 产品的运行配置。为确保 BIG-IP 特定配置持久保存到磁盘，请务必至少包含一个使用 f5networks.f5_modules.bigip_config 模块保存运行配置的任务。有关正确使用模块保存运行配置的信息，请参阅模块的文档。

示例

- name: Create HTTPS Monitor
  bigip_monitor_https:
    name: my_http_monitor
    state: present
    ip: 10.10.10.10
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

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

返回值

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

键	描述
cipher_list 字符串	密码列表的新值。 返回: 已更改 示例: "+3DES:+kEDH"
description 字符串	监控器的描述。 返回: 已更改 示例: "Important Monitor"
interval 整数	运行监控检查的新间隔。 返回: 已更改 示例: 2
ip 字符串	IP/端口定义的新 IP。 返回: 已更改 示例: "10.12.13.14"
parent 字符串	监控器的新父模板。 返回: 已更改 示例: "https"
reverse 布尔值	监控器是否以反向模式运行。 返回: 已更改 示例: true
time_until_up 整数	在第一次成功响应后将系统标记为“up”的新时间。 返回: 已更改 示例: 2
timeout 整数	远程系统必须响应监控的新超时时间。 返回: 已更改 示例: 10
up_interval 整数	当资源处于“up”状态时，系统用于执行健康检查的间隔。 返回: 已更改 示例: 0

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

集合链接

• 问题跟踪器
• 主页
• 存储库（来源）