f5networks.f5_modules.bigip_monitor_ftp 模块 – 管理 BIG-IP 上的 FTP 监控器

注意

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

f5networks.f5_modules 1.1.0 中的新增功能

概要

• 管理 BIG-IP 设备上的 FTP 监控器。

参数

参数	注释
app_service 字符串	要与此配置文件关联的 iApp 服务。如果未指定服务，则默认值为 None。
debug 布尔值	指定监控器是否将错误消息和其他信息发送到专门为此监控器创建和标记的日志文件。 当 true 时，系统会将错误消息和其他信息重定向到 /var/log/monitors/<monitor_name>-<node_name>-<port>.log 文件。 选项 false true
description 字符串	监控器的描述。
filename 字符串	指定系统尝试下载的文件的完整路径和文件名。如果系统可以下载该文件，则运行状况检查成功。
interval 整数	指定此模板的监控器实例运行频率的间隔。 此值必须小于 timeout 值。 创建新监控器时，如果未提供此参数，则将使用默认值 5。
ip 字符串	IP/端口定义中的 IP 地址部分。如果创建新监控器时未提供此参数，则默认值为“*”。
manual_resume 布尔值	指定系统是否在下次成功监控检查时自动将资源的状态更改为 启用。 如果将此选项设置为 true，则必须手动重新启用资源，系统才能将其用于负载平衡连接。 创建新监控器时，如果未指定此参数，则默认值为 false。 当 true 时，指定您必须在监控检查不成功后手动重新启用资源。 当 false 时，指定系统在下次成功监控检查时自动将资源的状态更改为 启用。 选项 false true
mode 字符串	指定数据传输过程 (DTP) 模式。 当 passive 时，监控器向 FTP 服务器发送数据传输请求。当 FTP 服务器收到请求时，FTP 服务器会启动并建立数据连接。 当 port 时，监控器启动并与 FTP 服务器建立数据连接。 选项 "passive" "port"
name 字符串 / 必需	指定监控器的名称。
parent 字符串	此监控器模板的父模板。设置此值后，不能更改。 创建新监控器时，如果未指定此参数，则默认为系统提供的 ftp 监控器。
partition 字符串	用于管理资源的设备分区。 默认值： "Common"
port 字符串	IP/端口定义中的端口地址部分。如果创建新监控器时未提供此参数，则默认值为“*”。如果指定 IP 地址，则必须使用 1 到 65535 之间的值。
provider 字典 在 f5networks.f5_modules 1.0.0 中添加	包含连接详细信息的 dict 对象。
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"
target_password 字符串	如果被监控的目标需要身份验证，则指定密码。
target_username 字符串	如果被监控的目标需要身份验证，则指定用户名。
time_until_up 整数	指定在首次成功响应后，节点被标记为 up 之前等待的时间（以秒为单位）。 值为 0 将导致节点在从节点收到有效响应后立即被标记为 up。 如果在创建新监视器时未提供此参数，则默认值将为 0。
timeout 整数	节点或服务必须响应监视器请求的秒数。 如果目标在设定的时间段内响应，则认为其处于 up 状态。 如果目标在设定的时间段内未响应，则认为其处于 down 状态。 您可以将其更改为任何数字，但是，它应该是间隔秒数的 3 倍加上 1 秒。 如果在创建新监视器时未提供此参数，则默认值将为 31。
up_interval 整数	指定当资源处于 up 状态时，系统执行健康检查的间隔。 当为 0 时，指定系统使用 interval 中指定的间隔来检查资源的健康状况。 当为其他任何数字时，您可以指定一个不同的间隔，用于检查处于 up 状态的资源的健康状况。 创建新监视器时，如果未提供此参数，则将使用默认值 0。
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 FTP Monitor
  bigip_monitor_ftp:
    state: present
    ip: 10.10.10.10
    name: my_ft_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Remove FTP Monitor
  bigip_monitor_ftp:
    state: absent
    name: my_ftp_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Include a username and password in the FTP monitor
  bigip_monitor_ftp:
    state: absent
    name: my_ftp_monitor
    target_username: monitor_user
    target_password: monitor_pass
    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"
filename 字符串	指定系统尝试下载的文件的完整路径和文件名。 返回： changed 示例： "/ftp/var/health.txt"
interval 整数	运行监视器检查的新间隔。 返回： changed 示例： 2
ip 字符串	IP/端口定义的新 IP。 返回： changed 示例： "10.12.13.14"
manual_resume 布尔值	指定系统是否在下一次成功的监视器检查时自动将资源的状态更改为 up。 返回： changed 示例： true
mode 字符串	指定数据传输过程 (DTP) 模式。 返回： changed 示例： "passive"
parent 字符串	父监视器。 返回： changed 示例： "/Common/foo_ftp"
port 字符串	代表与监视器关联的池或池成员检查的监视器的别名端口或服务。 返回： changed 示例： "80"
time_until_up 整数	首次成功响应后将系统标记为 up 的新时间。 返回： changed 示例： 2
timeout 整数	远程系统必须响应监视器的新超时时间。 返回： changed 示例： 10
up_interval 整数	当资源处于 up 状态时，系统用于执行健康检查的间隔。 返回： changed 示例： 0

作者

• Wojciech Wypior (@wojtek0806)

收集链接

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