f5networks.f5_modules.bigip_monitor_smtp 模块 – 在 BIG-IP 上管理 SMTP 监控

注意

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

f5networks.f5_modules 1.1.0 中的新增功能

概要

• 在 BIG-IP 上管理 SMTP 监控。

参数

参数	注释
app_service 字符串	要与此配置文件关联的 iApp 服务。未指定服务时，默认为 None。
debug 布尔值	指定监控程序是否将错误消息和附加信息发送到为此监控程序创建并特别标记的日志文件。 当 true 时，系统会将错误消息和附加信息重定向到 /var/log/monitors/<monitor_name>-<node_name>-<port>.log 文件。 选项 false true
description 字符串	监控程序的描述。
domain 字符串	指定要检查的域名。
interval 整数	指定此模板的监控程序实例运行频率的间隔。 此值**必须**小于timeout值。 创建新的监控程序时，如果未提供此参数，则将使用默认值 5。
ip 字符串	IP/端口定义的 IP 地址部分。如果在创建新的监控程序时未提供此参数，则默认值为 '*'。
manual_resume 布尔值	指定系统是否在下次成功的监控程序检查时自动将资源的状态更改为**已启用**。 如果将此选项设置为 true，则必须在系统可以使用它进行负载均衡连接之前手动重新启用资源。 创建新的监控程序时，如果未指定此参数，则默认值为 false。 当 true 时，指定在监控程序检查失败后必须手动重新启用资源。 当 false 时，指定系统在下次成功的监控程序检查时自动将资源的状态更改为**已启用**。 选项 false true
name 字符串 / 必需	指定监控程序的名称。
parent 字符串	此监控程序模板的父模板。设置此值后，便无法更改。 创建新的监控程序时，如果未指定此参数，则默认为系统提供的 smtp 监控程序。
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 ← (默认)
状态 (state) 字符串	当present时，确保监控器存在。 当absent时，确保监控器被移除。 选项 "present" ← (默认) "absent"
就绪时间 (time_until_up) 整数	指定节点在第一次成功响应后被标记为就绪状态之前需要等待的秒数。 值为0表示在从节点收到有效响应后立即将其标记为就绪状态。 如果在创建新的监控器时未提供此参数，则默认值为0。
timeout 整数	节点或服务必须在该时间段内响应监控器请求的秒数。 如果目标在设定的时间段内响应，则认为其处于正常状态。 如果目标在设定的时间段内没有响应，则认为其处于故障状态。 您可以将其更改为任何数字，但是，它应该为间隔秒数的 3 倍加上 1 秒。 如果在创建新的监控器时未提供此参数，则默认值为31。
正常间隔 (up_interval) 整数	指定系统在资源正常时执行健康检查的间隔。 当0时，表示系统使用interval中指定的间隔来检查资源的健康状况。 当为任何其他数字时，您可以指定不同的间隔来检查处于正常状态的资源的健康状况。 创建新的监控器时，如果未提供此参数，则将使用默认值0。

备注

注意

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

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

• F5 模块仅操作 F5 产品的运行配置。为了确保 BIG-IP 特定的配置持久保存到磁盘，请务必包含至少一项使用f5networks.f5_modules.bigip_config模块保存运行配置的任务。请参考该模块的文档以了解保存运行配置的正确使用方法。

示例

- name: Create SMTP Monitor
  bigip_monitor_smtp:
    state: present
    ip: 10.10.10.10
    name: my_smtp_monitor
    domain: foo.com
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Remove SMTP Monitor
  bigip_monitor_smtp:
    state: absent
    name: my_smtp_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

返回值

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

键 (Key)	描述
app_service 字符串	与该监控器关联的 iApp 服务。 返回：changed 示例："/Common/good_service.app/good_service"
debug 布尔值	监控器是否将错误消息和附加信息发送到为此监控器专门创建和标记的日志文件中。 返回：changed 示例：false
description 字符串	监控程序的描述。 返回：changed 示例："Important Monitor"
domain 字符串	指定要检查的域名。 返回：changed 示例："bigipinternal.com"
interval 整数	运行监控器检查的新间隔。 返回：changed 示例：2
ip 字符串	IP/端口定义的新IP。 返回：changed 示例："10.12.13.14"
manual_resume 布尔值	指定系统是否在下次成功监控检查时自动将资源的状态更改为正常。 返回：changed 示例：true
parent 字符串	父监控器。 返回：changed 示例："/Common/foo_smtp"
port 字符串	监控器代表与其关联的池或池成员检查的别名端口或服务。 返回：changed 示例："80"
就绪时间 (time_until_up) 整数	第一次成功响应后将系统标记为正常状态的新时间。 返回：changed 示例：2
timeout 整数	远程系统必须在该时间内响应监控器的新超时时间。 返回：changed 示例：10
正常间隔 (up_interval) 整数	系统在资源正常时执行健康检查的间隔。 返回：changed 示例：0

作者

• Wojciech Wypior (@wojtek0806)

资源链接

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