ALBAnalyticsProfile (schema)

AnalyticsProfile

Advanced load balancer AnalyticsProfile object
Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
Sortable
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
Sortable
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
string Readonly
_revision Generation of this resource config

The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.
int
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
apdex_response_threshold Apdex response threshold

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.
Unit is MILLISECONDS.
Default value when not specified in API or module is
interpreted by ALB Controller as 500.
integer Minimum: 1
Maximum: 30000
Default: "500"
apdex_response_tolerated_factor Apdex response tolerated factor

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 ALB Controller as 4.0.
number Default: "4.0"
apdex_rtt_threshold Apdex rtt threshold

Satisfactory client to Avi Round Trip Time(RTT).
Allowed values are 1-2000.
Unit is MILLISECONDS.
Default value when not specified in API or module is
interpreted by ALB Controller as 250.
integer Minimum: 1
Maximum: 2000
Default: "250"
apdex_rtt_tolerated_factor Apdex rtt tolerated factor

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 ALB Controller as 4.0.
number Default: "4.0"
apdex_rum_threshold Apdex rum threshold

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.
Unit is MILLISECONDS.
Default value when not specified in API or module is
interpreted by ALB Controller as 5000.
integer Minimum: 1
Maximum: 30000
Default: "5000"
apdex_rum_tolerated_factor Apdex rum tolerated factor

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 ALB Controller as 4.0.
number Default: "4.0"
apdex_server_response_threshold Apdex server response threshold

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 (STAR)
S_Latency.
Greater than this number and the server response is
considered Frustrated.
Allowed values are 1-30000.
Unit is MILLISECONDS.
Default value when not specified in API or module is
interpreted by ALB Controller as 400.
integer Minimum: 1
Maximum: 30000
Default: "400"
apdex_server_response_tolerated_factor Apdex server response tolerated factor

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 ALB Controller as 4.0.
number Default: "4.0"
apdex_server_rtt_threshold Apdex server rtt threshold

Satisfactory client to Avi Round Trip Time(RTT).
Allowed values are 1-2000.
Unit is MILLISECONDS.
Default value when not specified in API or module is
interpreted by ALB Controller as 125.
integer Minimum: 1
Maximum: 2000
Default: "125"
apdex_server_rtt_tolerated_factor Apdex server rtt tolerated factor

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 ALB Controller as 4.0.
number Default: "4.0"
children subtree for this type within policy tree

subtree for this type within policy tree containing nested elements.
array of ChildPolicyConfigResource
Children are not allowed for this type
client_log_config Client log config

Configure which logs are sent to the Avi Controller from
SEs and how they are processed.
ALBClientLogConfiguration
client_log_streaming_config Client log streaming config

Configure to stream logs to an external server.
ALBClientLogStreamingConfig
conn_lossy_ooo_threshold Conn lossy ooo threshold

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.
Unit is PERCENT.
Default value when not specified in API or module is
interpreted by ALB Controller as 50.
integer Minimum: 1
Maximum: 100
Default: "50"
conn_lossy_timeo_rexmt_threshold Conn lossy timeo rexmt threshold

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.
Unit is PERCENT.
Default value when not specified in API or module is
interpreted by ALB Controller as 20.
integer Minimum: 1
Maximum: 100
Default: "20"
conn_lossy_total_rexmt_threshold Conn lossy total rexmt threshold

A connection between client and Avi is considered lossy
when more than this percentage of packets are retransmitted.
Allowed values are 1-100.
Unit is PERCENT.
Default value when not specified in API or module is
interpreted by ALB Controller as 50.
integer Minimum: 1
Maximum: 100
Default: "50"
conn_lossy_zero_win_size_event_threshold Conn lossy zero win size event threshold

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.
Unit is PERCENT.
Default value when not specified in API or module is
interpreted by ALB Controller as 2.
integer Minimum: 0
Maximum: 100
Default: "2"
conn_server_lossy_ooo_threshold Conn server lossy ooo threshold

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.
Unit is PERCENT.
Default value when not specified in API or module is
interpreted by ALB Controller as 50.
integer Minimum: 1
Maximum: 100
Default: "50"
conn_server_lossy_timeo_rexmt_threshold Conn server lossy timeo rexmt threshold

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.
Unit is PERCENT.
Default value when not specified in API or module is
interpreted by ALB Controller as 20.
integer Minimum: 1
Maximum: 100
Default: "20"
conn_server_lossy_total_rexmt_threshold Conn server lossy total rexmt threshold

A connection between Avi and server is considered lossy
when more than this percentage of packets are retransmitted.
Allowed values are 1-100.
Unit is PERCENT.
Default value when not specified in API or module is
interpreted by ALB Controller as 50.
integer Minimum: 1
Maximum: 100
Default: "50"
conn_server_lossy_zero_win_size_event_threshold Conn server lossy zero win size event threshold

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.
Unit is PERCENT.
Default value when not specified in API or module is
interpreted by ALB Controller as 2.
integer Minimum: 0
Maximum: 100
Default: "2"
description Description of this resource string Maximum length: 1024
Sortable
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set
string Maximum length: 255
Sortable
enable_adaptive_config Enable adaptive config

Enable adaptive configuration for optimizing resource
usage.
Default value when not specified in API or module is
interpreted by ALB Controller as true.
boolean Default: "True"
enable_advanced_analytics Enable advanced analytics

Enables Advanced Analytics features like Anomaly detection.
If set to false, anomaly computation (and associated
rules/events) for VS, Pool and Server metrics will be
deactivated.
However, setting it to false reduces cpu and memory
requirements for Analytics subsystem.
Default value when not specified in API or module is
interpreted by ALB Controller as true.
boolean Default: "True"
enable_ondemand_metrics Enable ondemand metrics

Virtual Service (VS) metrics are processed only when there
is live data traffic on the VS.
In case, VS is idle for a period of time as specified by
ondemand_metrics_idle_timeout then metrics processing is
suspended for that VS.
Default value when not specified in API or module is
interpreted by ALB Controller as true.
boolean Default: "True"
enable_se_analytics Enable se analytics

Enable node (service engine) level analytics forvs metrics.
Default value when not specified in API or module is
interpreted by ALB Controller as true.
boolean Default: "True"
enable_server_analytics Enable server analytics

Enables analytics on backend servers.
This may be desired in container environment when there are
large number of ephemeral servers.
Additionally, no healthscore of servers is computed when
server analytics is enabled.
Default value when not specified in API or module is
interpreted by ALB Controller as true.
boolean Default: "True"
enable_vs_analytics Enable vs analytics

Enable VirtualService (frontend) Analytics.
This flag enables metrics and healthscore for
Virtualservice.
Default value when not specified in API or module is
interpreted by ALB Controller as true.
boolean Default: "True"
exclude_client_close_before_request_as_error Exclude client close before request as error

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 ALB Controller as false.
boolean Default: "False"
exclude_dns_policy_drop_as_significant Exclude dns policy drop as significant

Exclude dns policy drops from the list of errors.
Default value when not specified in API or module is
interpreted by ALB Controller as false.
boolean Default: "False"
exclude_gs_down_as_error Exclude gs down as error

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 ALB Controller as false.
boolean Default: "False"
exclude_http_error_codes Exclude http error codes

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.
array of integer
exclude_invalid_dns_domain_as_error Exclude invalid dns domain as error

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 ALB Controller as false.
boolean Default: "False"
exclude_invalid_dns_query_as_error Exclude invalid dns query as error

Exclude invalid dns queries from the list of errors.
Default value when not specified in API or module is
interpreted by ALB Controller as false.
boolean Default: "False"
exclude_issuer_revoked_ocsp_responses_as_error Exclude issuer revoked ocsp responses as error

Exclude the Issuer-Revoked OCSP Responses from the list of
errors.
Default value when not specified in API or module is
interpreted by ALB Controller as true.
boolean Default: "True"
exclude_no_dns_record_as_error Exclude no dns record as error

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 ALB Controller as false.
boolean Default: "False"
exclude_no_valid_gs_member_as_error Exclude no valid gs member as error

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 ALB Controller as false.
boolean Default: "False"
exclude_persistence_change_as_error Exclude persistence change as error

Exclude persistence server changed while load balancing'
from the list of errors.
Default value when not specified in API or module is
interpreted by ALB Controller as false.
boolean Default: "False"
exclude_revoked_ocsp_responses_as_error Exclude revoked ocsp responses as error

Exclude the Revoked OCSP certificate status responses from
the list of errors.
Default value when not specified in API or module is
interpreted by ALB Controller as true.
boolean Default: "True"
exclude_server_dns_error_as_error Exclude server dns error as error

Exclude server dns error response from the list of errors.
Default value when not specified in API or module is
interpreted by ALB Controller as false.
boolean Default: "False"
exclude_server_tcp_reset_as_error Exclude server tcp reset as error

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 ALB Controller as false.
boolean Default: "False"
exclude_sip_error_codes Exclude sip error codes

List of SIP status codes to be excluded from being
classified as an error.
array of integer
exclude_stale_ocsp_responses_as_error Exclude stale ocsp responses as error

Exclude the Stale OCSP certificate status responses from
the list of errors.
Default value when not specified in API or module is
interpreted by ALB Controller as true.
boolean Default: "True"
exclude_syn_retransmit_as_error Exclude syn retransmit as error

Exclude 'server unanswered syns' from the list of errors.
Default value when not specified in API or module is
interpreted by ALB Controller as false.
boolean Default: "False"
exclude_tcp_reset_as_error Exclude tcp reset as error

Exclude TCP resets by client from the list of potential
errors.
Default value when not specified in API or module is
interpreted by ALB Controller as false.
boolean Default: "False"
exclude_unavailable_ocsp_responses_as_error Exclude unavailable ocsp responses as error

Exclude the unavailable OCSP Responses from the list of
errors.
Default value when not specified in API or module is
interpreted by ALB Controller as true.
boolean Default: "True"
exclude_unsupported_dns_query_as_error Exclude unsupported dns query as error

Exclude unsupported dns queries from the list of errors.
Default value when not specified in API or module is
interpreted by ALB Controller as false.
boolean Default: "False"
healthscore_max_server_limit Healthscore max server limit

Skips health score computation of pool servers when number
of servers in a pool is more than this setting.
Allowed values are 0-5000.
Special values are 0- 'server health score is deactivated'.
Default value when not specified in API or module is
interpreted by ALB Controller as 20.
integer Minimum: 0
Maximum: 5000
Default: "20"
hs_event_throttle_window Hs event throttle window

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 ALB Controller as 1209600.
integer Default: "1209600"
hs_max_anomaly_penalty Hs max anomaly penalty

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 ALB Controller as 10.
integer Minimum: 0
Maximum: 100
Default: "10"
hs_max_resources_penalty Hs max resources penalty

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 ALB Controller as 25.
integer Minimum: 0
Maximum: 100
Default: "25"
hs_max_security_penalty Hs max security penalty

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 ALB Controller as 100.
integer Minimum: 0
Maximum: 100
Default: "100"
hs_min_dos_rate Hs min dos rate

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 ALB Controller as 1000.
integer Default: "1000"
hs_performance_boost Hs performance boost

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 ALB Controller as 0.
integer Minimum: 0
Maximum: 100
Default: "0"
hs_pscore_traffic_threshold_l4_client Hs pscore traffic threshold l4 client

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 ALB Controller as 10.0.
number Default: "10.0"
hs_pscore_traffic_threshold_l4_server Hs pscore traffic threshold l4 server

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 ALB Controller as 10.0.
number Default: "10.0"
hs_security_certscore_expired Hs security certscore expired

Score assigned when the certificate has expired.
Allowed values are 0-5.
Default value when not specified in API or module is
interpreted by ALB Controller as 0.0.
number Default: "0.0"
hs_security_certscore_gt30d Hs security certscore gt30d

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 ALB Controller as 5.0.
number Default: "5.0"
hs_security_certscore_le07d Hs security certscore le07d

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 ALB Controller as 2.0.
number Default: "2.0"
hs_security_certscore_le30d Hs security certscore le30d

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 ALB Controller as 4.0.
number Default: "4.0"
hs_security_chain_invalidity_penalty Hs security chain invalidity penalty

Penalty for allowing certificates with invalid chain.
Allowed values are 0-5.
Default value when not specified in API or module is
interpreted by ALB Controller as 1.0.
number Default: "1.0"
hs_security_cipherscore_eq000b Hs security cipherscore eq000b

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 ALB Controller as 0.0.
number Default: "0.0"
hs_security_cipherscore_ge128b Hs security cipherscore ge128b

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 ALB Controller as 5.0.
number Default: "5.0"
hs_security_cipherscore_lt128b Hs security cipherscore lt128b

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 ALB Controller as 3.5.
number Default: "3.5"
hs_security_encalgo_score_none Hs security encalgo score none

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 ALB Controller as 0.0.
number Default: "0.0"
hs_security_encalgo_score_rc4 Hs security encalgo score rc4

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 ALB Controller as 2.5.
number Default: "2.5"
hs_security_hsts_penalty Hs security hsts penalty

Penalty for not enabling HSTS.
Allowed values are 0-5.
Default value when not specified in API or module is
interpreted by ALB Controller as 1.0.
number Default: "1.0"
hs_security_nonpfs_penalty Hs security nonpfs penalty

Penalty for allowing non-PFS handshakes.
Allowed values are 0-5.
Default value when not specified in API or module is
interpreted by ALB Controller as 1.0.
number Default: "1.0"
hs_security_ocsp_revoked_score Hs security ocsp revoked score

Score assigned when OCSP Certificate Status is set to
Revoked or Issuer Revoked.
Allowed values are 0.0-5.0.
Default value when not specified in API or module is
interpreted by ALB Controller as 0.0.
number Default: "0.0"
hs_security_selfsignedcert_penalty Hs security selfsignedcert penalty

Deprecated.
Allowed values are 0-5.
Default value when not specified in API or module is
interpreted by ALB Controller as 1.0.
number Default: "1.0"
hs_security_ssl30_score Hs security ssl30 score

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 ALB Controller as 3.5.
number Default: "3.5"
hs_security_tls10_score Hs security tls10 score

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 ALB Controller as 5.0.
number Default: "5.0"
hs_security_tls11_score Hs security tls11 score

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 ALB Controller as 5.0.
number Default: "5.0"
hs_security_tls12_score Hs security tls12 score

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 ALB Controller as 5.0.
number Default: "5.0"
hs_security_tls13_score Hs security tls13 score

Score assigned when supporting TLS1.3 encryption protocol.
Allowed values are 0-5.
number
hs_security_weak_signature_algo_penalty Hs security weak signature algo penalty

Penalty for allowing weak signature algorithm(s).
Allowed values are 0-5.
Default value when not specified in API or module is
interpreted by ALB Controller as 1.0.
number Default: "1.0"
id Unique identifier of this resource string Sortable
marked_for_delete Indicates whether the intent object is marked for deletion

Intent objects are not directly deleted from the system when a delete
is invoked on them. They are marked for deletion and only when all the
realized entities for that intent object gets deleted, the intent object
is deleted. Objects that are marked for deletion are not returned in
GET call. One can use the search API to get these objects.
boolean Readonly
Default: "False"
ondemand_metrics_idle_timeout Ondemand metrics idle timeout

This flag sets the time duration of no live data traffic
after which Virtual Service metrics processing is suspended.
It is applicable only when enable_ondemand_metrics is set
to false.
Unit is SECONDS.
Default value when not specified in API or module is
interpreted by ALB Controller as 1800.
integer Default: "1800"
overridden Indicates whether this object is the overridden intent object

Global intent objects cannot be modified by the user.
However, certain global intent objects can be overridden locally by use
of this property. In such cases, the overridden local values take
precedence over the globally defined values for the properties.
boolean Readonly
Default: "False"
parent_path Path of its parent

Path of its parent
string Readonly
path Absolute path of this object

Absolute path of this object
string Readonly
ranges Ranges

List of HTTP status code ranges to be excluded from being
classified as an error.
array of ALBHTTPStatusRange
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value ALBAnalyticsProfile string
resp_code_block Resp code block

Block of HTTP response codes to be excluded from being
classified as an error.
Enum options - AP_HTTP_RSP_4XX, AP_HTTP_RSP_5XX.
array of ALBAnalyticsProfileRespCodeBlock
sensitive_log_profile Sensitive log profile

Rules applied to the HTTP application log for filtering
sensitive information.
ALBSensitiveLogProfile
sip_log_depth Sip log depth

Maximum number of SIP messages added in logs for a SIP
transaction.
By default, this value is 20.
Allowed values are 1-1000.
Default value when not specified in API or module is
interpreted by ALB Controller as 20.
integer Minimum: 1
Maximum: 1000
Default: "20"
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
unique_id A unique identifier assigned by the system

This is a UUID generated by the GM/LM to uniquely identify
entites in a federated environment. For entities that are
stretched across multiple sites, the same ID will be used
on all the stretched sites.
string Readonly