f5networks.f5_modules.bigip_profile_analytics 模块 – 在 BIG-IP 上管理 HTTP 分析配置文件

注意

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

f5networks.f5_modules 1.0.0 中的新增功能

概要 

管理 BIG-IP 设备上的 HTTP 分析配置文件。

参数 

参数	注释
collect_geo 布尔值	启用或禁用收集流量发送来源国家/地区的名称。选项 `false` `true`
collect_ip 布尔值	启用或禁用收集客户端 IP 统计信息。选项 `false` `true`
collect_max_tps_and_throughput 布尔值	启用或禁用收集所有已收集实体的最大 TPS 和吞吐量。选项 `false` `true`
collect_page_load_time 布尔值	启用或禁用收集页面加载时间统计信息。选项 `false` `true`
collect_url 布尔值	启用或禁用收集请求的 URL 统计信息。选项 `false` `true`
collect_user_agent 布尔值	启用或禁用收集用户代理。选项 `false` `true`
collect_user_sessions 布尔值	启用或禁用收集唯一用户会话。选项 `false` `true`
collected_stats_external_logging 布尔值	启用或禁用收集到的统计信息的外部日志记录。选项 `false` `true`
collected_stats_internal_logging 布尔值	启用或禁用收集到的统计信息的内部日志记录。选项 `false` `true`
description 字符串	配置文件的描述。
external_logging_publisher 字符串	指定用于将统计数据发送到一个或多个目标的外部日志记录发布者。
name 字符串 / 必填	指定配置文件的名称。
notification_by_email 布尔值	启用或禁用通过电子邮件发送分析警报。选项 `false` `true`
notification_by_syslog 布尔值	启用或禁用将分析警报记录到 Syslog 中。选项 `false` `true`
notification_email_addresses 列表 / 元素=字符串	指定当启用 `notification_by_email` 时，哪些电子邮件地址会收到警报电子邮件。
parent 字符串	指定此配置文件继承设置的配置文件。创建新配置文件时，如果未指定此参数，则默认为系统提供的 `analytics` 配置文件。
partition 字符串	用于管理资源的设备分区。默认值： `"Common"`
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"`

注释 

注意

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

示例 

- name: Create a profile
  bigip_profile_analytics:
    name: profile1
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值 

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

键	描述
param1 布尔值	资源的新 param1 值。返回：已更改示例： `true`
param2 字符串	资源的新 param2 值。返回：已更改示例： `"Foo is bar"`

作者

Tim Rupp (@caphrim007)