f5networks.f5_modules.bigip_gtm_monitor_firepass 模块 – 管理 F5 BIG-IP GTM FirePass 监控器

注意

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

f5networks.f5_modules 1.0.0 中的新增功能

概要 

管理 F5 BIG-IP GTM（现为 BIG-IP DNS）FirePass 监控器。

参数 

参数	注释
cipher_list 字符串	指定此监控器的密码列表。密码列表中的项目用冒号 `:` 分隔。创建新的监控器时，如果未指定此参数，则默认列表为 `HIGH:!ADH`。
concurrency_limit 整数	指定监控器将安全访问管理器系统标记为启动状态时，当前正在使用的已许可连接的最大百分比。例如，设置为 95% 表示监控器将安全访问管理器系统标记为启动状态，直到使用 95% 的已许可连接。当正在使用的已许可连接数超过 95% 时，监控器将安全访问管理器系统标记为关闭状态。创建新的监控器时，如果未指定此参数，则默认为 `95`。
ignore_down_response 布尔值	指定监控器是否允许每个间隔多次探测尝试。当为 `true` 时，指定监控器忽略监控器超时持续时间内的关闭响应。一旦监控器超时达到而系统未收到启动响应，系统将对象标记为关闭状态。当为 `no` 时，指定监控器在收到关闭响应时立即将对象标记为关闭状态。创建新的监控器时，如果未提供此参数，则默认值为 `false`。选项 `false` `true`
interval 整数	指定此模板的监控器实例运行频率的间隔。创建新的监控器时，如果未提供此参数，则默认值为 30。此值必须小于 `timeout` 值。
ip 字符串	IP/端口定义的 IP 地址部分。创建新的监控器时，如果未提供此参数，则默认值为 '*'。如果此值为 IP 地址，则必须指定 `port` 编号。
max_load_average 整数	指定监控器用于将安全访问管理器系统标记为启动或关闭状态的数字。系统将“最大负载平均值”设置与安全访问管理器系统负载的 1 分钟平均值进行比较。当安全访问管理器系统负载平均值在指定的“最大负载平均值”范围内时，监控器将安全访问管理器系统标记为启动状态。当平均值超过设置值时，监控器将系统标记为关闭状态。创建新的监控器时，如果未指定此参数，则默认为 `12`。
name 字符串 / 必需	监控器名称。
parent 字符串	此监控器模板的父模板。设置此值后，将无法更改。默认情况下，此值为 `Common` 分区上的 `tcp` 父项。默认值： `"/Common/firepass_gtm"`
partition 字符串	用于管理资源的设备分区。默认值： `"Common"`
port 字符串	IP/端口定义的端口地址部分。创建新的监控器时，如果未提供此参数，则默认值为 '*'。请注意，如果指定 IP 地址，则必须指定 1 到 65535 之间的值。
probe_timeout 整数	指定系统对系统的探测请求超时的时间（秒）。创建新的监控器时，如果未提供此参数，则默认值为 `5`。
provider 字典 f5networks.f5_modules 1.0.0 中新增	包含连接详细信息的字典对象。
auth_provider 字符串	配置身份验证提供程序，以便从远程设备获取身份验证令牌。此选项主要用于与 BIG-IQ 设备配合使用。
no_f5_teem 布尔值	如果为 `yes`，则不会将 TEEM 遥测数据发送到 F5。您可以通过设置环境变量 `F5_TELEMETRY_OFF` 来省略此选项。先前使用的变量 `F5_TEEM` 已弃用，因为其名称令人困惑。选项 `false` ← (默认) `true`
密码别名：pass、pwd 字符串 / 必需	用于连接到 BIG-IP 或 BIG-IQ 的用户帐户的密码。您可以通过设置环境变量 `F5_PASSWORD` 来省略此选项。
服务器字符串 / 必需	BIG-IP 主机或 BIG-IQ 主机。您可以通过设置环境变量 `F5_SERVER` 来省略此选项。
服务器端口整数	BIG-IP 服务器端口。您可以通过设置环境变量 `F5_SERVER_PORT` 来省略此选项。默认： `443`
超时整数	指定与网络设备通信的超时时间（以秒为单位），用于连接或发送命令。如果在操作完成之前超时，模块将出错。
传输字符串	配置连接到远程设备时使用的传输连接。选项 `"rest"` ← (默认)
用户字符串 / 必需	连接到 BIG-IP 或 BIG-IQ 的用户名。此用户必须拥有设备上的管理员权限。您可以通过设置环境变量 `F5_USER` 来省略此选项。
验证证书布尔值	如果为 `no`，则不验证 SSL 证书。仅在使用自签名证书的个人控制站点上使用此选项。您可以通过设置环境变量 `F5_VALIDATE_CERTS` 来省略此选项。选项 `false` `true` ← (默认)
状态字符串	当 `present` 时，确保监视器存在。当 `absent` 时，确保监视器被移除。选项 `"present"` ← (默认) `"absent"`
目标密码字符串	如果被监视的目标需要身份验证，则指定密码。
目标用户名字符串	如果被监视的目标需要身份验证，则指定用户名。
超时整数	节点或服务必须响应监视器请求的秒数。如果目标在设定的时间段内响应，则认为其处于活动状态。如果目标在设定的时间段内未响应，则认为其处于非活动状态。您可以将其更改为任何数字，但是，它应该为间隔秒数的 3 倍加 1 秒。如果创建新的监视器时未提供此参数，则默认值为 90。
更新密码字符串	`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 a GTM FirePass monitor
  bigip_gtm_monitor_firepass:
    name: my_monitor
    ip: 1.1.1.1
    port: 80
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Remove FirePass Monitor
  bigip_gtm_monitor_firepass:
    name: my_monitor
    state: absent
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Add FirePass monitor for all addresses, port 514
  bigip_gtm_monitor_firepass:
    name: my_monitor
    port: 514
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

返回值 

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

键	描述
cipher_list 字符串	密码列表的新值。返回：已更改示例： `"+3DES:+kEDH"`
concurrency_limit 整数	并发限制的新值。返回：已更改示例： `95`
ignore_down_response 布尔值	是否忽略关闭响应。返回：已更改示例： `true`
interval 整数	运行监视器检查的新间隔。返回：已更改示例： `2`
ip 字符串	IP/端口定义的新 IP。返回：已更改示例： `"10.12.13.14"`
max_load_average 整数	最大负载平均值的新值。返回：已更改示例： `12`
parent 字符串	监视器的新父模板。返回：已更改示例： `"firepass_gtm"`
port 字符串	监视器检查资源的新端口。返回：已更改示例： `"8080"`
probe_timeout 整数	系统将超时监视器探测的新超时。返回：已更改示例： `10`
超时整数	远程系统必须响应监视器的新超时。返回：已更改示例： `10`

作者

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