f5networks.f5_modules.bigip_monitor_mysql 模块 – 管理 BIG-IP MySQL 监控器

注意

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

f5networks.f5_modules 1.3.0 中的新功能

概要

• 管理 BIG-IP MySQL 监控器。

参数

参数	注释
app_service 字符串	要与此配置文件关联的 iApp 服务。如果未指定服务，则默认为 None。
count 整数	指定与数据库的连接终止之前的监控探针次数。
database 字符串	指定监控器尝试访问的数据库的名称。
debug 布尔值	指定监控器是否将错误消息和其他信息发送到专门为此监控器创建和标记的日志文件。 选项 false true
description 字符串	指定标识监控器的描述性文本。
interval 整数	指定系统发出监控检查的频率。
ip 字符串	IP/端口定义的 IP 地址部分。如果创建新监控器时未提供此参数，则默认值为“*”。
manual_resume 布尔值	指定系统是否在下一次成功的监控检查时自动将资源的状态更改为启用。 如果将此选项设置为 true，则必须在系统可以使用该资源进行负载平衡连接之前手动重新启用该资源。 当 true 时，指定您必须在监控检查失败后手动重新启用资源。 当 false 时，指定系统在下一次成功的监控检查时自动将资源的状态更改为启用。 选项 false true
name 字符串 / 必需	监控器名称。
parent 字符串	此监控器模板的父模板。设置此值后，无法更改它。 默认情况下，此值是 Common 分区上的 mysql 父项。
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 ←（默认）
recv 字符串	指定监控器在返回的资源中查找的文本字符串。 最常见的接收表达式包含数据库中字段中包含的文本字符串。 如果您没有同时指定“发送字符串”和“接收字符串”，则监控器仅执行简单的服务检查并连接。
recv_column 字符串	指定系统期望在数据库中查找指定接收字符串的列。 这是一个可选设置，仅当您配置了 send 和 recv 选项时才适用。
recv_row 字符串	指定系统期望在数据库中查找指定接收字符串的行。 这是一个可选设置，仅当您配置了 send 和 recv 选项时才适用。
send 字符串	指定监视器发送到目标对象的 SQL 查询。 由于字符串可能包含特殊字符，系统可能需要使用单引号将字符串括起来。如果此值为 none，则有效的连接足以确定服务已启动。在这种情况下，系统不需要 recv、recv-row 和 recv-column 选项，即使它们不是 none，系统也会忽略它们。
state 字符串	当为 present 时，确保监视器存在。 当为 absent 时，确保监视器被删除。 选项 "present" ← (默认) "absent"
target_password 字符串	指定受监控目标需要身份验证时的密码。
target_username 字符串	指定受监控目标需要身份验证时的用户名。
time_until_up 整数	指定在资源首次正确响应监视器后，等待多少秒才将资源设置为“up”。 在此期间，来自资源的所有响应都必须正确。 当时间间隔到期时，资源将被标记为“up”。 值为 0 表示在收到第一个正确响应后立即将资源标记为“up”。
timeout 整数	指定目标必须在多长时间内响应监视器请求。 如果目标在设定的时间段内响应，则认为它是“up”。如果目标在设定的时间段内没有响应，则认为它是“down”。当此值设置为 0（零）时，系统将使用父监视器的时间间隔。 请注意，timeout 和 time_until_up 结合起来控制何时将资源设置为 up。
up_interval 整数	指定当资源处于 up 状态时，系统用于执行健康检查的时间间隔。 当为 0 时，指定系统使用 interval 中指定的时间间隔来检查资源的健康状况。 当为任何其他数字时，您可以指定一个不同的时间间隔，用于检查处于 up 状态的资源的健康状况。
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 an mysql monitor
  bigip_monitor_mysql:
    ip: 10.10.10.10
    port: 10923
    name: my_mysql_monitor
    send: "SELECT status FROM v$instance"
    recv: OPEN
    recv_column: 2
    recv_row: 1
    database: primary1
    target_username: bigip
    target_password: secret
    update_password: on_create
    state: present
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Modify an mysql monitor
  bigip_monitor_mysql:
    name: my_mysql_monitor
    recv_column: 4
    recv_row: 3
    database: primary2
    state: present
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Remove mysql monitor
  bigip_monitor_mysql:
    state: absent
    name: my_mysql_monitor
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

返回值

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

Key	描述
app_service 字符串	与此监视器关联的 iApp 服务。 返回: changed 示例: "/Common/good_service.app/good_service"
database 字符串	监视器尝试访问的数据库名称。 返回: changed 示例: "primary1"
debug 布尔值	监视器是否将错误消息和其他信息发送到专门为此监视器创建和标记的日志文件。 返回: changed 示例: false
description 字符串	监视器的描述。 返回: changed 示例: "Important Monitor"
interval 整数	运行监视器检查的新时间间隔。 返回: changed 示例: 2
ip 字符串	IP/端口定义的新 IP。 返回: changed 示例: "10.12.13.14"
manual_resume 布尔值	指定系统是否在下次成功监视器检查时自动将资源的状态更改为 up。 返回: changed 示例: true
parent 字符串	父监视器。 返回: changed 示例: "/Common/foo_mysql"
port 字符串	监视器代表与之关联的池或池成员检查的别名端口或服务。 返回: changed 示例: "80"
recv 字符串	监视器在返回的资源中查找的文本字符串。 返回: changed 示例: "OPEN"
recv_column 字符串	指定字符串所在的数据库列。 返回: changed 示例: "2"
recv_row 字符串	指定字符串所在的数据库行。 返回: changed 示例: "1"
send 字符串	监视器发送到目标对象的 SQL 查询。 返回: changed 示例: "SELECT status FROM v$instance"
target_username 字符串	受监控目标的用户名。 返回: changed 示例: "bigip"
time_until_up 整数	在首次成功响应后将系统标记为 up 的新时间。 返回: changed 示例: 2
timeout 整数	远程系统必须响应监视器的新超时时间。 返回: changed 示例: 10
up_interval 整数	当资源处于 up 状态时，系统用于执行健康检查的时间间隔。 返回: changed 示例: 0

作者

• Andrey Kashcheev (@andreykashcheev)

集合链接

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