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 字符串	配置 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 字符串	监控器调用的接收字符串。
receive_disable 字符串	此设置的工作方式类似于receive，不同之处在于，当节点或池成员的响应与receive_disable字符串匹配但与receive不匹配时，系统会将该节点或池成员标记为禁用。要使用此设置，必须同时指定receive_disable和receive。
反向 布尔值 添加于 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 整数	指定在第一次成功响应后，将节点标记为启动之前的时间（以秒为单位）。值为 0 表示在从节点收到有效响应后立即将节点标记为启动。如果创建新的监控器时未提供此参数，则默认值为 0。
timeout 整数	节点或服务必须在多长时间内响应监控器请求（以秒为单位）。如果目标在设定的时间段内响应，则认为其处于启动状态；如果目标在设定的时间段内未响应，则认为其处于关闭状态。您可以将其更改为任何数字，但是，它应为间隔秒数的 3 倍加上 1 秒。如果创建新的监控器时未提供此参数，则默认值为 16。
up_interval 整数	指定系统在资源启动时执行健康检查所使用的间隔时间。 当为0时，指定系统使用interval中指定的间隔时间来检查资源的健康状况。 当为任何其他数字时，允许您在检查已启动资源的健康状况时指定不同的间隔时间。

注释

注意

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

• 有关使用 Ansible 管理 F5 网络设备的更多信息，请参见 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 字符串	密码列表的新值。 返回：changed 示例："+3DES:+kEDH"
description 字符串	监控器的描述。 返回：changed 示例："Important Monitor"
interval 整数	运行监控器检查的新间隔时间。 返回：changed 示例：2
ip 字符串	IP/端口定义的新IP。 返回：changed 示例："10.12.13.14"
parent 字符串	监控器的新父模板。 返回：changed 示例："https"
反向 布尔值	监控器是否以反向模式运行。 返回：changed 示例：true
time_until_up 整数	第一次成功响应后将系统标记为启动的新时间。 返回：changed 示例：2
timeout 整数	远程系统必须在多长时间内响应监控器（新的超时时间）。 返回：changed 示例：10
up_interval 整数	系统在资源启动时执行健康检查所使用的间隔时间。 返回：changed 示例：0

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

收藏链接

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