f5networks.f5_modules.bigip_monitor_oracle 模块 – 管理 BIG-IP Oracle 监控器

注意

此模块是 f5networks.f5_modules 集合 (版本 1.32.1) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install f5networks.f5_modules。

要在剧本中使用它，请指定： f5networks.f5_modules.bigip_monitor_oracle。

f5networks.f5_modules 1.3.0 中的新增功能

概要

• 管理 BIG-IP Oracle 监控器。

参数

参数	注释
app_service 字符串	要与此配置文件关联的 iApp 服务。未指定服务时，默认为 None。
count 整数	指定监控探测次数，之后将终止与数据库的连接。 计数值为零表示连接将永远不会终止。
database 字符串	指定监控器尝试访问的数据库名称。
debug 布尔值	指定监控器是否将错误消息和附加信息发送到为此监控器创建和特别标记的日志文件。 选项 false true
description 字符串	指定标识监控器的描述性文本。
interval 整数	指定系统在资源关闭或资源状态未知时发出监控检查的频率（以秒为单位）。
ip 字符串	IP/端口定义的 IP 地址部分。如果在创建新监控器时未提供此参数，则默认值为“*”。
manual_resume 布尔值	指定系统是否在下次成功的监控检查时自动将资源状态更改为**已启用**。 如果将此选项设置为true，则必须在系统可以使用它进行负载均衡连接之前手动重新启用资源。 当true时，指定在监控检查失败后必须手动重新启用资源。 当false时，指定系统在下次成功的监控检查时自动将资源状态更改为**已启用**。 选项 false true
name 字符串 / 必填	监控器名称。
parent 字符串	此监控器模板的父模板。设置此值后，将无法更改。 默认情况下，此值为 Common 分区上的 oracle 父项。
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 ← (默认)
recv 字符串	指定监控程序在返回的资源中查找的文本字符串。 最常见的接收表达式包含数据库字段中包含的文本字符串。 如果您未同时指定 send 和 recv 参数，则监控程序仅执行简单的服务检查和连接。
recv_column 字符串	指定数据库中应位于指定 recv 字符串的列。 这是一个可选设置，仅当您配置 send 和 recv 参数时才适用。
recv_row 字符串	指定数据库中应位于指定 recv 字符串的行。 这是一个可选设置，仅当您配置 send 和 recv 参数时才适用。
send 字符串	指定监控程序发送到目标对象的 SQL 查询。 由于字符串可能包含特殊字符，因此系统可能需要用单引号括住字符串。如果此值为 none，则有效的连接足以确定服务已启动。在这种情况下，系统不需要 recv、recv-row 和 recv-column 选项，即使不是 none 也将忽略它们。
state 字符串	当为 present 时，确保监控程序存在。 当为 absent 时，确保监控程序已删除。 选项 "present" ← (默认) "absent"
target_password 字符串	如果被监控的目标需要身份验证，则指定密码。
target_username 字符串	如果被监控的目标需要身份验证，则指定用户名。
time_until_up 整数	指定资源第一次正确响应监控程序后等待的秒数，然后再将资源设置为“启动”。 在此期间，资源的所有响应都必须正确。 当时间间隔到期时，资源将标记为“启动”。 值为 0 表示在收到第一个正确响应后立即将资源标记为启动。
timeout 整数	指定目标必须在多长时间内响应监控程序请求。 如果目标在设定的时间段内响应，则认为它处于“启动”状态。如果目标在设定的时间段内没有响应，则认为它处于“停止”状态。当此值设置为 0（零）时，系统使用父监控程序的时间间隔。 请注意，timeout 和 time_until_up 结合起来控制何时将资源设置为启动。
up_interval 整数	指定系统在资源启动时用于执行运行状况检查的时间间隔。 当为 0 时，指定系统使用 interval 中的时间间隔来检查资源的运行状况。 当为任何其他数字时，允许您指定在检查处于启动状态的资源的运行状况时要使用的不同时间间隔。
update_password 字符串	always 将在指定 target_password 时更新密码。 on_create 仅为新创建的监控程序设置密码。 选项 "always" ← (默认) "on_create"

备注

注意

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

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

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

示例

- name: Create an oracle monitor
  bigip_monitor_oracle:
    ip: 10.10.10.10
    port: 10923
    name: my_oracle_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 oracle monitor
  bigip_monitor_oracle:
    name: my_oracle_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 oracle monitor
  bigip_monitor_oracle:
    state: absent
    name: my_oracle_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 布尔值	指定系统是否在下次成功的监控程序检查时自动将资源的状态更改为启动。 返回：changed 示例： true
parent 字符串	父监控程序。 返回：changed 示例： "/Common/foo_oracle"
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 整数	第一次成功响应后将系统标记为启动的新时间。 返回：changed 示例： 2
timeout 整数	远程系统必须在多长时间内响应监控程序。 返回：changed 示例： 10
up_interval 整数	资源启动时系统用于执行运行状况检查的时间间隔。 返回：changed 示例： 0

作者

• Wojciech Wypior (@wojtek0806)

集合链接

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