f5networks.f5_modules.bigip_monitor_external 模块 – 管理 BIG-IP 上的外部 LTM 监控器

注意

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

f5networks.f5_modules 1.0.0 中的新功能

概要 

管理 BIG-IP 设备上的外部 LTM 监控器。

参数 

参数	注释
arguments 字符串	指定脚本需要的任何命令行参数。
description 字符串	监控器的描述。
external_program 字符串	指定监控器要使用的文件的名称。为了引用文件，您必须首先使用系统 > 文件管理 > 外部监控程序文件列表 > 导入屏幕上的选项导入它。BIG-IP 系统会自动将文件放置在文件系统上的正确位置。
interval 整数	指定此模板的监控器实例将运行的频率的间隔。如果创建新监控器时未提供此参数，则默认值为 5。此值必须小于 `timeout` 值。
ip 字符串	IP/端口定义的 IP 地址部分。如果创建新监控器时未提供此参数，则默认值为“*”。
name 字符串 / 必需	指定监控器的名称。
parent 字符串	此监控器模板的父模板。一旦设置此值，就无法更改。默认情况下，此值是 `Common` 分区上的 `external` 父模板。默认值： `"/Common/external"`
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"`
timeout 整数	节点或服务必须响应监控器请求的秒数。如果目标在设置的时间段内响应，则认为其已启动。如果目标在设置的时间段内未响应，则认为其已关闭。您可以将此更改为任何数字，但是，它应该是间隔秒数的 3 倍加 1 秒。如果创建新监控器时未提供此参数，则默认值为 `16`。
变量字典	指定脚本所需的任何变量。请注意，值中的双引号将被删除。

注释 

注意

有关使用 Ansible 管理 F5 Networks 设备的更多信息，请参阅 https://ansible.org.cn/integrations/networks/f5。
需要 BIG-IP 软件版本 >= 12。
F5 模块仅操作 F5 产品的运行配置。要确保 BIG-IP 的特定配置持久保存到磁盘，请务必包含至少一个使用 f5networks.f5_modules.bigip_config 模块保存运行配置的任务。请参阅该模块的文档，了解如何正确使用该模块来保存您的运行配置。

示例 

- name: Create an external monitor
  bigip_monitor_external:
    name: foo
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Create an external monitor with variables
  bigip_monitor_external:
    name: foo
    timeout: 10
    variables:
      var1: foo
      var2: bar
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Add a variable to an existing set
  bigip_monitor_external:
    name: foo
    timeout: 10
    variables:
      var1: foo
      var2: bar
      cat: dog
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

返回值 

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

键	描述
description 字符串	监控器的描述。返回: changed 示例: `"Important Monitor"`
interval 整数	运行监控检查的新间隔。返回: changed 示例: `2`
ip 字符串	IP/端口定义的新 IP 地址。返回: changed 示例: `"10.12.13.14"`
parent 字符串	监控器的新父模板。返回: changed 示例: `"external"`
timeout 整数	远程系统必须响应监控器的新超时时间。返回: changed 示例: `10`

作者

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)