community.network.avi_analyticsprofile 模块 – 用于设置 AnalyticsProfile Avi RESTful 对象的模块

注意

此模块是 community.network 集合 (版本 5.1.0) 的一部分。

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

要安装它,请使用:ansible-galaxy collection install community.network。您需要其他要求才能使用此模块,有关详细信息,请参阅 要求

要在 playbook 中使用它,请指定:community.network.avi_analyticsprofile

注意

community.network 集合已弃用,并将从 Ansible 12 中删除。有关更多信息,请参阅 讨论主题

已弃用

在以下版本中移除:

6.0.0 版本

原因:

此集合及其中的所有内容均未维护且已弃用。

替代方案:

未知。

摘要

别名:network.avi.avi_analyticsprofile

要求

执行此模块的主机需要以下要求。

  • avisdk

参数

参数

注释

apdex_response_threshold

字符串

如果客户端在小于满意延迟阈值的时间内收到 HTTP 响应,则请求被认为是满意的。

如果未满足且小于容忍延迟因子乘以满意延迟阈值,则认为是可容忍的。

大于此数字,则客户端的请求被认为是失败的。

允许的值为 1-30000。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 500。

apdex_response_tolerated_factor

字符串

客户端可容忍的响应延迟因子。

客户端必须在满意阈值(apdex_response_threshold)的此因子倍数内收到响应才能被认为是可容忍的。

允许的值为 1-1000。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 4.0。

apdex_rtt_threshold

字符串

令人满意的客户端到 Avi 往返时间 (rtt)。

允许的值为 1-2000。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 250。

apdex_rtt_tolerated_factor

字符串

可容忍的客户端到 Avi 往返时间 (rtt) 因子。

它是 apdex_rtt_tolerated_factor 的倍数。

允许的值为 1-1000。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 4.0。

apdex_rum_threshold

字符串

如果客户端能够在小于满意延迟阈值的时间内加载页面,则页面加载被认为是满意的。

如果大于满意但小于容忍延迟乘以满意延迟,则认为是可容忍的。

大于此数字,则客户端的请求被认为是失败的。

页面加载包括 DNS 查询时间、所有 HTTP 对象的下载时间和页面渲染时间。

允许的值为 1-30000。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 5000。

apdex_rum_tolerated_factor

字符串

作为 apdex_rum_threshold 倍数的可容忍页面加载时间 (plt) 的虚拟服务阈值因子。

允许的值为 1-1000。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 4.0。

apdex_server_response_threshold

字符串

如果延迟小于满意延迟阈值,则服务器 HTTP 响应被认为是满意的。

当响应大于满意但小于容忍延迟因子 * 满意延迟时,则认为是可容忍的。

大于此数字,则服务器响应被认为是失败的。

允许的值为 1-30000。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 400。

apdex_server_response_tolerated_factor

字符串

服务器可容忍的响应延迟因子。

服务器必须在满意阈值 (apdex_server_response_threshold) 的此因子倍数内响应才能被认为是可容忍的。

允许的值为 1-1000。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 4.0。

apdex_server_rtt_threshold

字符串

令人满意的客户端到 Avi 往返时间 (rtt)。

允许的值为 1-2000。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 125。

apdex_server_rtt_tolerated_factor

字符串

可容忍的客户端到 Avi 往返时间 (rtt) 因子。

它是 apdex_rtt_tolerated_factor 的倍数。

允许的值为 1-1000。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 4.0。

api_context

字典

包含当前会话 ID 和 CSRF 令牌的 Avi API 上下文。

这允许用户执行单点登录并重用会话。

api_version

字符串

用于 Avi API 和对象的 Avi API 版本。

默认值: "16.4.4"

avi_api_patch_op

字符串

当使用 avi_api_update_method 为 patch 时使用的修补操作。

选项

  • "add"

  • "replace"

  • "delete"

avi_api_update_method

字符串

对象更新的默认方法是 HTTP PUT。

设置为 patch 将覆盖该行为以使用 HTTP PATCH。

选项

  • "put" ← (默认)

  • "patch"

avi_credentials

字典

Avi 凭据字典,可用于代替枚举 Avi Controller 登录详细信息。

api_version

字符串

Avi 控制器版本

默认值: "16.4.4"

控制器

字符串

Avi 控制器 IP 地址或 SQDN

csrftoken

字符串

Avi 控制器 API csrftoken,用于与 session id 一起重用现有会话。

默认值: ""

密码

字符串

Avi 控制器密码

端口

字符串

Avi 控制器端口

session_id

字符串

Avi 控制器 API session id,用于与 csrftoken 一起重用现有会话。

默认值: ""

租户

字符串

Avi 控制器租户

默认值: "admin"

租户 UUID

字符串

Avi 控制器租户 UUID

默认值: ""

超时

字符串

Avi 控制器请求超时

默认值: 300

令牌

字符串

Avi 控制器 API 令牌

默认值: ""

用户名

字符串

Avi 控制器用户名

avi_disable_session_cache_as_fact

布尔值

禁用将 Avi 会话信息缓存为事实。

选项

  • false ← (默认值)

  • true

client_log_config

字符串

配置从 SES 发送到 Avi 控制器的日志以及如何处理这些日志。

client_log_streaming_config

字符串

配置将日志流式传输到外部服务器。

在 17.1.1 版本中引入。

conn_lossy_ooo_threshold

字符串

当接收到的乱序数据包百分比超过此值时,客户端与 Avi 之间的连接被认为是损耗的。

允许的值为 1-100。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 50。

conn_lossy_timeo_rexmt_threshold

字符串

当由于超时而重传的数据包百分比超过此值时,客户端与 Avi 之间的连接被认为是损耗的。

允许的值为 1-100。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 20。

conn_lossy_total_rexmt_threshold

字符串

当重传的数据包百分比超过此值时,客户端与 Avi 之间的连接被认为是损耗的。

允许的值为 1-100。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 50。

conn_lossy_zero_win_size_event_threshold

字符串

当由于 TCP 零窗口而无法传输数据包的次数百分比高于此阈值时,客户端连接被认为是损耗的。

允许的值为 0-100。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 2。

conn_server_lossy_ooo_threshold

字符串

当接收到的乱序数据包百分比超过此值时,Avi 与服务器之间的连接被认为是损耗的。

允许的值为 1-100。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 50。

conn_server_lossy_timeo_rexmt_threshold

字符串

当由于超时而重传的数据包百分比超过此值时,Avi 与服务器之间的连接被认为是损耗的。

允许的值为 1-100。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 20。

conn_server_lossy_total_rexmt_threshold

字符串

当重传的数据包百分比超过此值时,Avi 与服务器之间的连接被认为是损耗的。

允许的值为 1-100。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 50。

conn_server_lossy_zero_win_size_event_threshold

字符串

当由于 TCP 零窗口而无法传输数据包的次数百分比高于此阈值时,服务器连接被认为是损耗的。

允许的值为 0-100。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 2。

控制器

字符串

控制器的 IP 地址或主机名。默认值为环境变量 AVI_CONTROLLER

描述

字符串

用户为对象定义的描述。

disable_ondemand_metrics

布尔值

虚拟服务 (vs) 指标仅在 vs 上有实时数据流量时才进行处理。

如果 vs 在 ondemand_metrics_idle_timeout 指定的时间段内处于空闲状态,则该 vs 的指标处理将暂停。

在 18.1.1 版本中引入。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 False。

选项

  • false

  • true

disable_se_analytics

布尔值

禁用节点(服务引擎)级别的 vs 指标分析。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 False。

选项

  • false

  • true

disable_server_analytics

布尔值

禁用后端服务器上的分析。

在容器环境中,当有大量短暂服务器时,这可能是理想的选择。

此外,禁用服务器分析时,不会计算服务器的健康评分。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 False。

选项

  • false

  • true

disable_vs_analytics

布尔值

禁用虚拟服务(前端)分析。

此标志禁用虚拟服务的指标和健康评分。

在 18.2.1 版本中引入。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 False。

选项

  • false

  • true

enable_advanced_analytics

布尔值

启用高级分析功能,如异常检测。

如果设置为 false,则将禁用 vs、池和服务器指标的异常计算(以及相关的规则/事件)。

但是,将其设置为 false 会降低分析子系统的 CPU 和内存需求。

在 17.2.13、18.1.5、18.2.1 版本中引入。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 True。

选项

  • false

  • true

exclude_client_close_before_request_as_error

布尔值

排除在完成 HTTP 请求之前客户端关闭连接的情况,不被归类为错误。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 False。

选项

  • false

  • true

exclude_dns_policy_drop_as_significant

布尔值

从错误列表中排除 DNS 策略丢弃。

在 17.2.2 版本中引入。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 False。

选项

  • false

  • true

exclude_gs_down_as_error

布尔值

从错误列表中排除对操作上已关闭的 GSLB 服务的查询。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 False。

选项

  • false

  • true

exclude_http_error_codes

字符串

要从被归类为错误的列表中排除的 HTTP 状态代码列表。

错误连接或响应会影响健康评分,被包含为重要日志,并可能被归类为 DDoS 攻击的一部分。

exclude_invalid_dns_domain_as_error

布尔值

从错误列表中排除对 DNS 应用程序配置文件中未配置的域的 DNS 查询。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 False。

选项

  • false

  • true

exclude_invalid_dns_query_as_error

布尔值

从错误列表中排除无效的 DNS 查询。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 False。

选项

  • false

  • true

exclude_no_dns_record_as_error

布尔值

从错误列表中排除对未配置服务/记录的域的查询。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 False。

选项

  • false

  • true

exclude_no_valid_gs_member_as_error

布尔值

从错误列表中排除对没有可用成员的 GSLB 服务的查询。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 False。

选项

  • false

  • true

exclude_persistence_change_as_error

布尔值

从错误列表中排除“负载均衡期间持久性服务器发生更改”。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 False。

选项

  • false

  • true

exclude_server_dns_error_as_error

布尔值

从错误列表中排除服务器 DNS 错误响应。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 False。

选项

  • false

  • true

exclude_server_tcp_reset_as_error

布尔值

从错误中排除服务器 TCP 重置。

对于像 MS Exchange 这样的应用程序来说很常见。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 False。

选项

  • false

  • true

exclude_sip_error_codes

字符串

要从被归类为错误的列表中排除的 SIP 状态代码列表。

在 17.2.13、18.1.5、18.2.1 版本中引入。

exclude_syn_retransmit_as_error

布尔值

从错误列表中排除“服务器未响应 SYN”。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 False。

选项

  • false

  • true

exclude_tcp_reset_as_error

布尔值

从潜在错误列表中排除客户端的 TCP 重置。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 False。

选项

  • false

  • true

exclude_unsupported_dns_query_as_error

布尔值

从错误列表中排除不支持的 DNS 查询。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 False。

选项

  • false

  • true

healthscore_max_server_limit

字符串

当池中服务器数量超过此设置时,跳过池服务器的健康评分计算。

允许的值为 0-5000。

特殊值为 0 - “服务器健康评分已禁用”。

在 17.2.13、18.1.4 版本中引入。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 20。

hs_event_throttle_window

字符串

时间窗口(以秒为单位),在此窗口内,仅应发生唯一健康变化事件。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 1209600。

hs_max_anomaly_penalty

字符串

可能从健康评分中扣除的异常最大惩罚。

允许的值为 0-100。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 10。

hs_max_resources_penalty

字符串

可能从健康评分中扣除的高资源利用率最大惩罚。

允许的值为 0-100。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 25。

hs_max_security_penalty

字符串

基于安全评估可能从健康评分中扣除的最大惩罚。

允许的值为 0-100。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 100。

hs_min_dos_rate

字符串

DDoS 连接速率低于此值时,DDoS 安全评估将不会启动。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 1000。

hs_performance_boost

字符串

向健康评分添加免费性能评分积分。

它可用于补偿已知缓慢应用程序的健康评分。

允许的值为 0-100。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 0。

hs_pscore_traffic_threshold_l4_client

字符串

5 分钟内的连接数阈值,低于此阈值时,不会计算 apdexr、apdexc、rum_apdex 和其他网络质量指标。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 10.0。

hs_pscore_traffic_threshold_l4_server

字符串

5 分钟内的连接数阈值,低于此阈值时,不会计算 apdexr、apdexc、rum_apdex 和其他网络质量指标。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 10.0。

hs_security_certscore_expired

字符串

证书过期时分配的分数。

允许的值为 0-5。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 0.0。

hs_security_certscore_gt30d

字符串

证书在 30 天后过期时分配的分数。

允许的值为 0-5。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 5.0。

hs_security_certscore_le07d

字符串

证书在 7 天或更短时间内过期时分配的分数。

允许的值为 0-5。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 2.0。

hs_security_certscore_le30d

字符串

证书在 30 天或更短时间内过期时分配的分数。

允许的值为 0-5。

在 API 或模块中未指定时的默认值由 Avi Controller 解释为 4.0。

hs_security_chain_invalidity_penalty

字符串

允许具有无效链的证书的惩罚。

允许的值为 0-5。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 1.0。

hs_security_cipherscore_eq000b

字符串

最小密码强度为 0 位时分配的分数。

允许的值为 0-5。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 0.0。

hs_security_cipherscore_ge128b

字符串

最小密码强度大于等于 128 位时分配的分数。

允许的值为 0-5。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 5.0。

hs_security_cipherscore_lt128b

字符串

最小密码强度小于 128 位时分配的分数。

允许的值为 0-5。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 3.5。

hs_security_encalgo_score_none

字符串

不使用任何算法进行加密时分配的分数。

允许的值为 0-5。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 0.0。

hs_security_encalgo_score_rc4

字符串

使用 RC4 算法进行加密时分配的分数。

允许的值为 0-5。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 2.5。

hs_security_hsts_penalty

字符串

未启用 HSTS 的惩罚。

允许的值为 0-5。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 1.0。

hs_security_nonpfs_penalty

字符串

允许非 PFS 握手操作的惩罚。

允许的值为 0-5。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 1.0。

hs_security_selfsignedcert_penalty

字符串

已弃用。

允许的值为 0-5。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 1.0。

hs_security_ssl30_score

字符串

支持 SSL 3.0 加密协议时分配的分数。

允许的值为 0-5。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 3.5。

hs_security_tls10_score

字符串

支持 TLS 1.0 加密协议时分配的分数。

允许的值为 0-5。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 5.0。

hs_security_tls11_score

字符串

支持 TLS 1.1 加密协议时分配的分数。

允许的值为 0-5。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 5.0。

hs_security_tls12_score

字符串

支持 TLS 1.2 加密协议时分配的分数。

允许的值为 0-5。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 5.0。

hs_security_weak_signature_algo_penalty

字符串

允许弱签名算法的惩罚。

允许的值为 0-5。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 1.0。

名称

字符串 / 必需

分析配置文件的名称。

ondemand_metrics_idle_timeout

字符串

此标志设置虚拟服务指标处理暂停之前的无实时数据流量持续时间。

仅当 disable_ondemand_metrics 设置为 false 时才适用。

在 18.1.1 版本中引入。

如果在 API 或模块中未指定,Avi 控制器将默认值解释为 1800。

密码

字符串

Avi 控制器中 Avi 用户的密码。默认值为环境变量 AVI_PASSWORD

范围

字符串

要排除在被分类为错误之外的 HTTP 状态代码范围列表。

resp_code_block

字符串

要排除在被分类为错误之外的 HTTP 响应代码块。

枚举选项 - AP_HTTP_RSP_4XX、AP_HTTP_RSP_5XX。

sensitive_log_profile

字符串

应用于 HTTP 应用程序日志以过滤敏感信息的规则。

在 17.2.10、18.1.2 版本中引入的字段。

sip_log_depth

字符串

为 SIP 事务添加到日志中的 SIP 消息的最大数量。

默认情况下,此值为 20。

允许的值为 1-1000。

在 17.2.13、18.1.5、18.2.1 版本中引入。

如果 API 或模块中未指定,则 Avi 控制器将默认值解释为 20。

状态

字符串

应应用于实体的状态。

选项

  • “absent”

  • "present" ← (默认)

租户

字符串

用于所有 Avi API 调用和对象上下文的租户名称。

默认值: "admin"

tenant_ref

字符串

它是对 tenant 类型对象的引用。

租户 UUID

字符串

用于所有 Avi API 调用和对象上下文的租户 UUID。

默认值: ""

url

字符串

对象的 Avi 控制器 URL。

用户名

字符串

用于访问 Avi 控制器的用户名。默认值为环境变量 AVI_USERNAME

uuid

字符串

分析配置文件的 UUID。

注释

注意

示例

- name: Create a custom Analytics profile object
  community.network.avi_analyticsprofile:
    controller: '{{ controller }}'
    username: '{{ username }}'
    password: '{{ password }}'
    apdex_response_threshold: 500
    apdex_response_tolerated_factor: 4.0
    apdex_rtt_threshold: 250
    apdex_rtt_tolerated_factor: 4.0
    apdex_rum_threshold: 5000
    apdex_rum_tolerated_factor: 4.0
    apdex_server_response_threshold: 400
    apdex_server_response_tolerated_factor: 4.0
    apdex_server_rtt_threshold: 125
    apdex_server_rtt_tolerated_factor: 4.0
    conn_lossy_ooo_threshold: 50
    conn_lossy_timeo_rexmt_threshold: 20
    conn_lossy_total_rexmt_threshold: 50
    conn_lossy_zero_win_size_event_threshold: 2
    conn_server_lossy_ooo_threshold: 50
    conn_server_lossy_timeo_rexmt_threshold: 20
    conn_server_lossy_total_rexmt_threshold: 50
    conn_server_lossy_zero_win_size_event_threshold: 2
    disable_se_analytics: false
    disable_server_analytics: false
    exclude_client_close_before_request_as_error: false
    exclude_persistence_change_as_error: false
    exclude_server_tcp_reset_as_error: false
    exclude_syn_retransmit_as_error: false
    exclude_tcp_reset_as_error: false
    hs_event_throttle_window: 1209600
    hs_max_anomaly_penalty: 10
    hs_max_resources_penalty: 25
    hs_max_security_penalty: 100
    hs_min_dos_rate: 1000
    hs_performance_boost: 20
    hs_pscore_traffic_threshold_l4_client: 10.0
    hs_pscore_traffic_threshold_l4_server: 10.0
    hs_security_certscore_expired: 0.0
    hs_security_certscore_gt30d: 5.0
    hs_security_certscore_le07d: 2.0
    hs_security_certscore_le30d: 4.0
    hs_security_chain_invalidity_penalty: 1.0
    hs_security_cipherscore_eq000b: 0.0
    hs_security_cipherscore_ge128b: 5.0
    hs_security_cipherscore_lt128b: 3.5
    hs_security_encalgo_score_none: 0.0
    hs_security_encalgo_score_rc4: 2.5
    hs_security_hsts_penalty: 0.0
    hs_security_nonpfs_penalty: 1.0
    hs_security_selfsignedcert_penalty: 1.0
    hs_security_ssl30_score: 3.5
    hs_security_tls10_score: 5.0
    hs_security_tls11_score: 5.0
    hs_security_tls12_score: 5.0
    hs_security_weak_signature_algo_penalty: 1.0
    name: jason-analytics-profile
    tenant_ref: Demo

返回值

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

描述

obj

字典

AnalyticsProfile (api/analyticsprofile) 对象

返回:成功、已更改

状态

  • 此模块将在 6.0.0 版本中移除。[已弃用]

  • 更多信息请参见 已弃用

作者

  • Gaurav Rastogi (@grastogi23)