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

要在 playbook 中使用它,请指定: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

字符串

配置身份验证提供程序,以从远程设备获取身份验证令牌。

此选项在使用 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

字符串

指定监控器在返回的资源中查找的文本字符串。

最常见的接收表达式包含数据库字段中包含的文本字符串。

如果您未同时指定sendrecv参数,则监控器将仅执行简单的服务检查和连接。

recv_column

字符串

指定数据库中应位于指定recv字符串的列。

这是一个可选设置,仅当您配置sendrecv参数时才适用。

recv_row

字符串

指定数据库中应位于指定recv字符串的行。

这是一个可选设置,仅当您配置sendrecv参数时才适用。

send

字符串

指定监控器发送到目标对象的SQL查询。

由于字符串可能包含特殊字符,因此系统可能要求字符串用单引号括起来。如果此值为none,则有效的连接足以确定服务已启动。在这种情况下,系统不需要recv、recv-row和recv-column选项,即使不是none也会忽略它们。

state

字符串

present时,确保监控器存在。

absent时,确保监控器被移除。

选项

  • "present" ← (默认)

  • "absent"

target_password

字符串

如果被监控的目标需要身份验证,则指定密码。

target_username

字符串

如果被监控的目标需要身份验证,则指定用户名。

time_until_up

整数

指定资源首次正确响应监控器后等待的秒数,然后再将资源设置为“启动”。

在此期间,资源的所有响应都必须正确。

当间隔时间到期时,资源将标记为“启动”。

值为0表示在收到第一个正确响应后立即将资源标记为启动。

timeout

整数

指定目标必须在其中响应监控器请求的秒数。

如果目标在设定的时间段内响应,则认为它处于“启动”状态。如果目标在设定的时间段内未响应,则认为它处于“关闭”状态。当此值设置为0(零)时,系统将使用父监控器的间隔。

请注意,timeouttime_until_up结合控制何时将资源设置为启动。

up_interval

整数

指定系统在资源启动时用于执行健康检查的间隔。

0时,指定系统使用interval中的间隔来检查资源的健康状况。

当为任何其他数字时,您可以指定不同的间隔,用于检查已启动的资源的健康状况。

update_password

字符串

always将在指定target_password时更新密码。

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 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)