Documentation

avi_analyticsprofile - Module for setup of AnalyticsProfile Avi RESTful Object

New in version 2.3.

Synopsis

Options

parameter required default choices comments
apdex_response_threshold
no
If a client receives an http response in less than the satisfactory latency threshold, the request is considered satisfied.
It is considered tolerated if it is not satisfied and less than tolerated latency factor multiplied by the satisfactory latency threshold.
Greater than this number and the client's request is considered frustrated.
Allowed values are 1-30000.
Default value when not specified in API or module is interpreted by Avi Controller as 500.
apdex_response_tolerated_factor
no
Client tolerated response latency factor.
Client must receive a response within this factor times the satisfactory threshold (apdex_response_threshold) to be considered tolerated.
Allowed values are 1-1000.
Default value when not specified in API or module is interpreted by Avi Controller as 4.0.
apdex_rtt_threshold
no
Satisfactory client to avi round trip time(rtt).
Allowed values are 1-2000.
Default value when not specified in API or module is interpreted by Avi Controller as 250.
apdex_rtt_tolerated_factor
no
Tolerated client to avi round trip time(rtt) factor.
It is a multiple of apdex_rtt_tolerated_factor.
Allowed values are 1-1000.
Default value when not specified in API or module is interpreted by Avi Controller as 4.0.
apdex_rum_threshold
no
If a client is able to load a page in less than the satisfactory latency threshold, the pageload is considered satisfied.
It is considered tolerated if it is greater than satisfied but less than the tolerated latency multiplied by satisifed latency.
Greater than this number and the client's request is considered frustrated.
A pageload includes the time for dns lookup, download of all http objects, and page render time.
Allowed values are 1-30000.
Default value when not specified in API or module is interpreted by Avi Controller as 5000.
apdex_rum_tolerated_factor
no
Virtual service threshold factor for tolerated page load time (plt) as multiple of apdex_rum_threshold.
Allowed values are 1-1000.
Default value when not specified in API or module is interpreted by Avi Controller as 4.0.
apdex_server_response_threshold
no
A server http response is considered satisfied if latency is less than the satisfactory latency threshold.
The response is considered tolerated when it is greater than satisfied but less than the tolerated latency factor * s_latency.
Greater than this number and the server response is considered frustrated.
Allowed values are 1-30000.
Default value when not specified in API or module is interpreted by Avi Controller as 400.
apdex_server_response_tolerated_factor
no
Server tolerated response latency factor.
Servermust response within this factor times the satisfactory threshold (apdex_server_response_threshold) to be considered tolerated.
Allowed values are 1-1000.
Default value when not specified in API or module is interpreted by Avi Controller as 4.0.
apdex_server_rtt_threshold
no
Satisfactory client to avi round trip time(rtt).
Allowed values are 1-2000.
Default value when not specified in API or module is interpreted by Avi Controller as 125.
apdex_server_rtt_tolerated_factor
no
Tolerated client to avi round trip time(rtt) factor.
It is a multiple of apdex_rtt_tolerated_factor.
Allowed values are 1-1000.
Default value when not specified in API or module is interpreted by Avi Controller as 4.0.
api_version
no
Avi API version of to use for Avi API and objects.
client_log_config
no
Configure which logs are sent to the avi controller from ses and how they are processed.
client_log_streaming_config
(added in 2.4)
no
Configure to stream logs to an external server.
Field introduced in 17.1.1.
conn_lossy_ooo_threshold
no
A connection between client and avi is considered lossy when more than this percentage of out of order packets are received.
Allowed values are 1-100.
Default value when not specified in API or module is interpreted by Avi Controller as 50.
conn_lossy_timeo_rexmt_threshold
no
A connection between client and avi is considered lossy when more than this percentage of packets are retransmitted due to timeout.
Allowed values are 1-100.
Default value when not specified in API or module is interpreted by Avi Controller as 20.
conn_lossy_total_rexmt_threshold
no
A connection between client and avi is considered lossy when more than this percentage of packets are retransmitted.
Allowed values are 1-100.
Default value when not specified in API or module is interpreted by Avi Controller as 50.
conn_lossy_zero_win_size_event_threshold
no
A client connection is considered lossy when percentage of times a packet could not be trasmitted due to tcp zero window is above this threshold.
Allowed values are 0-100.
Default value when not specified in API or module is interpreted by Avi Controller as 2.
conn_server_lossy_ooo_threshold
no
A connection between avi and server is considered lossy when more than this percentage of out of order packets are received.
Allowed values are 1-100.
Default value when not specified in API or module is interpreted by Avi Controller as 50.
conn_server_lossy_timeo_rexmt_threshold
no
A connection between avi and server is considered lossy when more than this percentage of packets are retransmitted due to timeout.
Allowed values are 1-100.
Default value when not specified in API or module is interpreted by Avi Controller as 20.
conn_server_lossy_total_rexmt_threshold
no
A connection between avi and server is considered lossy when more than this percentage of packets are retransmitted.
Allowed values are 1-100.
Default value when not specified in API or module is interpreted by Avi Controller as 50.
conn_server_lossy_zero_win_size_event_threshold
no
A server connection is considered lossy when percentage of times a packet could not be trasmitted due to tcp zero window is above this threshold.
Allowed values are 0-100.
Default value when not specified in API or module is interpreted by Avi Controller as 2.
controller
no
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
description
no
User defined description for the object.
disable_se_analytics
no
Disable node (service engine) level analytics forvs metrics.
Default value when not specified in API or module is interpreted by Avi Controller as False.
disable_server_analytics
no
Disable analytics on backend servers.
This may be desired in container environment when there are large number of ephemeral servers.
Default value when not specified in API or module is interpreted by Avi Controller as False.
exclude_client_close_before_request_as_error
no
Exclude client closed connection before an http request could be completed from being classified as an error.
Default value when not specified in API or module is interpreted by Avi Controller as False.
exclude_gs_down_as_error
no
Exclude queries to gslb services that are operationally down from the list of errors.
Default value when not specified in API or module is interpreted by Avi Controller as False.
exclude_http_error_codes
no
List of http status codes to be excluded from being classified as an error.
Error connections or responses impacts health score, are included as significant logs, and may be classified as part of a dos attack.
exclude_invalid_dns_domain_as_error
no
Exclude dns queries to domains outside the domains configured in the dns application profile from the list of errors.
Default value when not specified in API or module is interpreted by Avi Controller as False.
exclude_invalid_dns_query_as_error
no
Exclude invalid dns queries from the list of errors.
Default value when not specified in API or module is interpreted by Avi Controller as False.
exclude_no_dns_record_as_error
no
Exclude queries to domains that did not have configured services/records from the list of errors.
Default value when not specified in API or module is interpreted by Avi Controller as False.
exclude_no_valid_gs_member_as_error
no
Exclude queries to gslb services that have no available members from the list of errors.
Default value when not specified in API or module is interpreted by Avi Controller as False.
exclude_persistence_change_as_error
no
Exclude persistence server changed while load balancing' from the list of errors.
Default value when not specified in API or module is interpreted by Avi Controller as False.
exclude_server_dns_error_as_error
no
Exclude server dns error response from the list of errors.
Default value when not specified in API or module is interpreted by Avi Controller as False.
exclude_server_tcp_reset_as_error
no
Exclude server tcp reset from errors.
It is common for applications like ms exchange.
Default value when not specified in API or module is interpreted by Avi Controller as False.
exclude_syn_retransmit_as_error
no
Exclude 'server unanswered syns' from the list of errors.
Default value when not specified in API or module is interpreted by Avi Controller as False.
exclude_tcp_reset_as_error
no
Exclude tcp resets by client from the list of potential errors.
Default value when not specified in API or module is interpreted by Avi Controller as False.
exclude_unsupported_dns_query_as_error
no
Exclude unsupported dns queries from the list of errors.
Default value when not specified in API or module is interpreted by Avi Controller as False.
hs_event_throttle_window
no
Time window (in secs) within which only unique health change events should occur.
Default value when not specified in API or module is interpreted by Avi Controller as 1209600.
hs_max_anomaly_penalty
no
Maximum penalty that may be deducted from health score for anomalies.
Allowed values are 0-100.
Default value when not specified in API or module is interpreted by Avi Controller as 10.
hs_max_resources_penalty
no
Maximum penalty that may be deducted from health score for high resource utilization.
Allowed values are 0-100.
Default value when not specified in API or module is interpreted by Avi Controller as 25.
hs_max_security_penalty
no
Maximum penalty that may be deducted from health score based on security assessment.
Allowed values are 0-100.
Default value when not specified in API or module is interpreted by Avi Controller as 100.
hs_min_dos_rate
no
Dos connection rate below which the dos security assessment will not kick in.
Default value when not specified in API or module is interpreted by Avi Controller as 1000.
hs_performance_boost
no
Adds free performance score credits to health score.
It can be used for compensating health score for known slow applications.
Allowed values are 0-100.
Default value when not specified in API or module is interpreted by Avi Controller as 0.
hs_pscore_traffic_threshold_l4_client
no
Threshold number of connections in 5min, below which apdexr, apdexc, rum_apdex, and other network quality metrics are not computed.
Default value when not specified in API or module is interpreted by Avi Controller as 10.0.
hs_pscore_traffic_threshold_l4_server
no
Threshold number of connections in 5min, below which apdexr, apdexc, rum_apdex, and other network quality metrics are not computed.
Default value when not specified in API or module is interpreted by Avi Controller as 10.0.
hs_security_certscore_expired
no
Score assigned when the certificate has expired.
Allowed values are 0-5.
Default value when not specified in API or module is interpreted by Avi Controller as 0.0.
hs_security_certscore_gt30d
no
Score assigned when the certificate expires in more than 30 days.
Allowed values are 0-5.
Default value when not specified in API or module is interpreted by Avi Controller as 5.0.
hs_security_certscore_le07d
no
Score assigned when the certificate expires in less than or equal to 7 days.
Allowed values are 0-5.
Default value when not specified in API or module is interpreted by Avi Controller as 2.0.
hs_security_certscore_le30d
no
Score assigned when the certificate expires in less than or equal to 30 days.
Allowed values are 0-5.
Default value when not specified in API or module is interpreted by Avi Controller as 4.0.
hs_security_chain_invalidity_penalty
no
Penalty for allowing certificates with invalid chain.
Allowed values are 0-5.
Default value when not specified in API or module is interpreted by Avi Controller as 1.0.
hs_security_cipherscore_eq000b
no
Score assigned when the minimum cipher strength is 0 bits.
Allowed values are 0-5.
Default value when not specified in API or module is interpreted by Avi Controller as 0.0.
hs_security_cipherscore_ge128b
no
Score assigned when the minimum cipher strength is greater than equal to 128 bits.
Allowed values are 0-5.
Default value when not specified in API or module is interpreted by Avi Controller as 5.0.
hs_security_cipherscore_lt128b
no
Score assigned when the minimum cipher strength is less than 128 bits.
Allowed values are 0-5.
Default value when not specified in API or module is interpreted by Avi Controller as 3.5.
hs_security_encalgo_score_none
no
Score assigned when no algorithm is used for encryption.
Allowed values are 0-5.
Default value when not specified in API or module is interpreted by Avi Controller as 0.0.
hs_security_encalgo_score_rc4
no
Score assigned when rc4 algorithm is used for encryption.
Allowed values are 0-5.
Default value when not specified in API or module is interpreted by Avi Controller as 2.5.
hs_security_hsts_penalty
no
Penalty for not enabling hsts.
Allowed values are 0-5.
Default value when not specified in API or module is interpreted by Avi Controller as 1.0.
hs_security_nonpfs_penalty
no
Penalty for allowing non-pfs handshakes.
Allowed values are 0-5.
Default value when not specified in API or module is interpreted by Avi Controller as 1.0.
hs_security_selfsignedcert_penalty
no
Deprecated.
Allowed values are 0-5.
Default value when not specified in API or module is interpreted by Avi Controller as 1.0.
hs_security_ssl30_score
no
Score assigned when supporting ssl3.0 encryption protocol.
Allowed values are 0-5.
Default value when not specified in API or module is interpreted by Avi Controller as 3.5.
hs_security_tls10_score
no
Score assigned when supporting tls1.0 encryption protocol.
Allowed values are 0-5.
Default value when not specified in API or module is interpreted by Avi Controller as 5.0.
hs_security_tls11_score
no
Score assigned when supporting tls1.1 encryption protocol.
Allowed values are 0-5.
Default value when not specified in API or module is interpreted by Avi Controller as 5.0.
hs_security_tls12_score
no
Score assigned when supporting tls1.2 encryption protocol.
Allowed values are 0-5.
Default value when not specified in API or module is interpreted by Avi Controller as 5.0.
hs_security_weak_signature_algo_penalty
no
Penalty for allowing weak signature algorithm(s).
Allowed values are 0-5.
Default value when not specified in API or module is interpreted by Avi Controller as 1.0.
name
yes
The name of the analytics profile.
password
no
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
ranges
no
List of http status code ranges to be excluded from being classified as an error.
resp_code_block
no
Block of http response codes to be excluded from being classified as an error.
Enum options - AP_HTTP_RSP_4XX, AP_HTTP_RSP_5XX.
state
no present
  • absent
  • present
The state that should be applied on the entity.
tenant
no admin
Name of tenant used for all Avi API calls and context of object.
tenant_ref
no
It is a reference to an object of type tenant.
tenant_uuid
no
UUID of tenant used for all Avi API calls and context of object.
url
no
Avi controller URL of the object.
username
no
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.
uuid
no
Uuid of the analytics profile.

Examples

- name: Create a custom Analytics profile object
  avi_analyticsprofile:
    controller: ''
    username: ''
    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

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
obj AnalyticsProfile (api/analyticsprofile) object success, changed dict


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.