Avi AnalyticsProfile Object API

CLI ``` - configure analyticsprofile - show analyticsprofile ```

More information: https://avinetworks.com/contact-us

Contact Info: support@avinetworks.com

Version: 21.1.6

BasePath:/api

http://apache.org/licenses/LICENSE-2.0.html

Access

HTTP Basic Authentication

Methods

[ Jump to Models ]

get /analyticsprofile
post /analyticsprofile
delete /analyticsprofile/{uuid}
get /analyticsprofile/{uuid}
patch /analyticsprofile/{uuid}
put /analyticsprofile/{uuid}
get /analyticsprofile/{uuid}/runtime/internal/

get /analyticsprofile

(analyticsprofileGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

name (optional)

Query Parameter — object name

refers_to (optional)

Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid

referred_by (optional)

Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid

fields (optional)

Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

include_name (optional)

Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

skip_default (optional)

Query Parameter — Default values are not set.

join_subresources (optional)

Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

AnalyticsProfileApiResponse

Example data

Content-Type: application/json

{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "exclude_stale_ocsp_responses_as_error" : true,
    "hs_security_encalgo_score_rc4" : 1.3579000000000001069366817318950779736042022705078125,
    "hs_security_certscore_le30d" : 1.3579000000000001069366817318950779736042022705078125,
    "apdex_rum_threshold" : 123,
    "enable_vs_analytics" : true,
    "disable_ondemand_metrics" : true,
    "hs_security_tls11_score" : 1.3579000000000001069366817318950779736042022705078125,
    "disable_vs_analytics" : true,
    "hs_security_cipherscore_lt128b" : 1.3579000000000001069366817318950779736042022705078125,
    "apdex_server_response_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
    "hs_security_weak_signature_algo_penalty" : 1.3579000000000001069366817318950779736042022705078125,
    "hs_security_encalgo_score_none" : 1.3579000000000001069366817318950779736042022705078125,
    "apdex_server_rtt_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
    "uuid" : "aeiou",
    "conn_server_lossy_ooo_threshold" : 123,
    "hs_security_selfsignedcert_penalty" : 1.3579000000000001069366817318950779736042022705078125,
    "apdex_server_response_threshold" : 123,
    "exclude_no_dns_record_as_error" : true,
    "exclude_client_close_before_request_as_error" : true,
    "configpb_attributes" : {
      "version" : 123
    },
    "sip_log_depth" : 123,
    "apdex_response_threshold" : 123,
    "apdex_response_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
    "conn_server_lossy_zero_win_size_event_threshold" : 123,
    "exclude_syn_retransmit_as_error" : true,
    "hs_performance_boost" : 123,
    "hs_security_tls10_score" : 1.3579000000000001069366817318950779736042022705078125,
    "client_log_streaming_config" : {
      "protocol" : "aeiou",
      "syslog_config" : {
        "hostname" : "aeiou",
        "filtered_log_severity" : 123,
        "significant_log_severity" : 123,
        "facility" : 123,
        "non_significant_log_severity" : 123
      },
      "external_server" : "aeiou",
      "format_config" : {
        "included_fields" : [ "aeiou" ],
        "format" : "aeiou"
      },
      "log_types_to_send" : "aeiou",
      "external_server_port" : 123,
      "max_logs_per_second" : 123
    },
    "exclude_revoked_ocsp_responses_as_error" : true,
    "exclude_invalid_dns_domain_as_error" : true,
    "exclude_issuer_revoked_ocsp_responses_as_error" : true,
    "apdex_rtt_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
    "conn_lossy_ooo_threshold" : 123,
    "enable_server_analytics" : true,
    "exclude_unavailable_ocsp_responses_as_error" : true,
    "conn_server_lossy_total_rexmt_threshold" : 123,
    "exclude_sip_error_codes" : [ "" ],
    "hs_security_cipherscore_ge128b" : 1.3579000000000001069366817318950779736042022705078125,
    "labels" : [ {
      "value" : "aeiou",
      "key" : "aeiou"
    } ],
    "conn_lossy_timeo_rexmt_threshold" : 123,
    "hs_event_throttle_window" : 123,
    "resp_code_block" : [ "aeiou" ],
    "hs_security_hsts_penalty" : 1.3579000000000001069366817318950779736042022705078125,
    "healthscore_max_server_limit" : 123,
    "exclude_gs_down_as_error" : true,
    "disable_se_analytics" : true,
    "exclude_persistence_change_as_error" : true,
    "ondemand_metrics_idle_timeout" : 123,
    "apdex_rum_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
    "name" : "aeiou",
    "hs_max_security_penalty" : 123,
    "enable_se_analytics" : true,
    "exclude_unsupported_dns_query_as_error" : true,
    "conn_lossy_zero_win_size_event_threshold" : 123,
    "enable_adaptive_config" : true,
    "hs_security_chain_invalidity_penalty" : 1.3579000000000001069366817318950779736042022705078125,
    "ranges" : [ {
      "end" : 123,
      "begin" : 123
    } ],
    "client_log_config" : {
      "filtered_log_processing" : "aeiou",
      "non_significant_log_processing" : "aeiou",
      "significant_log_processing" : "aeiou",
      "enable_significant_log_collection" : true
    },
    "exclude_server_tcp_reset_as_error" : true,
    "exclude_http_error_codes" : [ "" ],
    "hs_min_dos_rate" : 123,
    "enable_ondemand_metrics" : true,
    "description" : "aeiou",
    "apdex_server_rtt_threshold" : 123,
    "hs_security_certscore_gt30d" : 1.3579000000000001069366817318950779736042022705078125,
    "exclude_dns_policy_drop_as_significant" : true,
    "_last_modified" : "aeiou",
    "hs_max_resources_penalty" : 123,
    "hs_pscore_traffic_threshold_l4_client" : 1.3579000000000001069366817318950779736042022705078125,
    "hs_max_anomaly_penalty" : 123,
    "hs_security_tls13_score" : 1.3579000000000001069366817318950779736042022705078125,
    "hs_security_certscore_expired" : 1.3579000000000001069366817318950779736042022705078125,
    "hs_security_ocsp_revoked_score" : 1.3579000000000001069366817318950779736042022705078125,
    "hs_security_nonpfs_penalty" : 1.3579000000000001069366817318950779736042022705078125,
    "sensitive_log_profile" : {
      "uri_query_field_rules" : [ "" ],
      "waf_field_rules" : [ "" ],
      "header_field_rules" : [ {
        "match" : {
          "match_criteria" : "aeiou",
          "string_group_refs" : [ "aeiou" ],
          "match_str" : [ "aeiou" ]
        },
        "name" : "aeiou",
        "action" : "aeiou",
        "index" : 123,
        "enabled" : true
      } ]
    },
    "exclude_tcp_reset_as_error" : true,
    "hs_security_cipherscore_eq000b" : 1.3579000000000001069366817318950779736042022705078125,
    "exclude_invalid_dns_query_as_error" : true,
    "exclude_server_dns_error_as_error" : true,
    "hs_security_tls12_score" : 1.3579000000000001069366817318950779736042022705078125,
    "apdex_rtt_threshold" : 123,
    "enable_advanced_analytics" : true,
    "exclude_no_valid_gs_member_as_error" : true,
    "url" : "aeiou",
    "disable_server_analytics" : true,
    "hs_security_ssl30_score" : 1.3579000000000001069366817318950779736042022705078125,
    "conn_server_lossy_timeo_rexmt_threshold" : 123,
    "tenant_ref" : "aeiou",
    "latency_audit_props" : {
      "latency_audit_mode" : "aeiou",
      "conn_est_audit_mode" : "aeiou",
      "conn_est_threshold" : 123,
      "latency_threshold" : 123
    },
    "hs_pscore_traffic_threshold_l4_server" : 1.3579000000000001069366817318950779736042022705078125,
    "hs_security_certscore_le07d" : 1.3579000000000001069366817318950779736042022705078125,
    "markers" : [ {
      "values" : [ "aeiou" ],
      "key" : "aeiou"
    } ],
    "conn_lossy_total_rexmt_threshold" : 123
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK AnalyticsProfileApiResponse

401

post /analyticsprofile

(analyticsprofilePost)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — AnalyticsProfile object creation

Return type

AnalyticsProfile

Example data

Content-Type: application/json

{
  "exclude_stale_ocsp_responses_as_error" : true,
  "hs_security_encalgo_score_rc4" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_certscore_le30d" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_rum_threshold" : 123,
  "enable_vs_analytics" : true,
  "disable_ondemand_metrics" : true,
  "hs_security_tls11_score" : 1.3579000000000001069366817318950779736042022705078125,
  "disable_vs_analytics" : true,
  "hs_security_cipherscore_lt128b" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_server_response_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_weak_signature_algo_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_encalgo_score_none" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_server_rtt_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "uuid" : "aeiou",
  "conn_server_lossy_ooo_threshold" : 123,
  "hs_security_selfsignedcert_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_server_response_threshold" : 123,
  "exclude_no_dns_record_as_error" : true,
  "exclude_client_close_before_request_as_error" : true,
  "configpb_attributes" : {
    "version" : 123
  },
  "sip_log_depth" : 123,
  "apdex_response_threshold" : 123,
  "apdex_response_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_server_lossy_zero_win_size_event_threshold" : 123,
  "exclude_syn_retransmit_as_error" : true,
  "hs_performance_boost" : 123,
  "hs_security_tls10_score" : 1.3579000000000001069366817318950779736042022705078125,
  "client_log_streaming_config" : {
    "protocol" : "aeiou",
    "syslog_config" : {
      "hostname" : "aeiou",
      "filtered_log_severity" : 123,
      "significant_log_severity" : 123,
      "facility" : 123,
      "non_significant_log_severity" : 123
    },
    "external_server" : "aeiou",
    "format_config" : {
      "included_fields" : [ "aeiou" ],
      "format" : "aeiou"
    },
    "log_types_to_send" : "aeiou",
    "external_server_port" : 123,
    "max_logs_per_second" : 123
  },
  "exclude_revoked_ocsp_responses_as_error" : true,
  "exclude_invalid_dns_domain_as_error" : true,
  "exclude_issuer_revoked_ocsp_responses_as_error" : true,
  "apdex_rtt_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_lossy_ooo_threshold" : 123,
  "enable_server_analytics" : true,
  "exclude_unavailable_ocsp_responses_as_error" : true,
  "conn_server_lossy_total_rexmt_threshold" : 123,
  "exclude_sip_error_codes" : [ "" ],
  "hs_security_cipherscore_ge128b" : 1.3579000000000001069366817318950779736042022705078125,
  "labels" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "conn_lossy_timeo_rexmt_threshold" : 123,
  "hs_event_throttle_window" : 123,
  "resp_code_block" : [ "aeiou" ],
  "hs_security_hsts_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "healthscore_max_server_limit" : 123,
  "exclude_gs_down_as_error" : true,
  "disable_se_analytics" : true,
  "exclude_persistence_change_as_error" : true,
  "ondemand_metrics_idle_timeout" : 123,
  "apdex_rum_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "name" : "aeiou",
  "hs_max_security_penalty" : 123,
  "enable_se_analytics" : true,
  "exclude_unsupported_dns_query_as_error" : true,
  "conn_lossy_zero_win_size_event_threshold" : 123,
  "enable_adaptive_config" : true,
  "hs_security_chain_invalidity_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "ranges" : [ {
    "end" : 123,
    "begin" : 123
  } ],
  "client_log_config" : {
    "filtered_log_processing" : "aeiou",
    "non_significant_log_processing" : "aeiou",
    "significant_log_processing" : "aeiou",
    "enable_significant_log_collection" : true
  },
  "exclude_server_tcp_reset_as_error" : true,
  "exclude_http_error_codes" : [ "" ],
  "hs_min_dos_rate" : 123,
  "enable_ondemand_metrics" : true,
  "description" : "aeiou",
  "apdex_server_rtt_threshold" : 123,
  "hs_security_certscore_gt30d" : 1.3579000000000001069366817318950779736042022705078125,
  "exclude_dns_policy_drop_as_significant" : true,
  "_last_modified" : "aeiou",
  "hs_max_resources_penalty" : 123,
  "hs_pscore_traffic_threshold_l4_client" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_max_anomaly_penalty" : 123,
  "hs_security_tls13_score" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_certscore_expired" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_ocsp_revoked_score" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_nonpfs_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "sensitive_log_profile" : {
    "uri_query_field_rules" : [ "" ],
    "waf_field_rules" : [ "" ],
    "header_field_rules" : [ {
      "match" : {
        "match_criteria" : "aeiou",
        "string_group_refs" : [ "aeiou" ],
        "match_str" : [ "aeiou" ]
      },
      "name" : "aeiou",
      "action" : "aeiou",
      "index" : 123,
      "enabled" : true
    } ]
  },
  "exclude_tcp_reset_as_error" : true,
  "hs_security_cipherscore_eq000b" : 1.3579000000000001069366817318950779736042022705078125,
  "exclude_invalid_dns_query_as_error" : true,
  "exclude_server_dns_error_as_error" : true,
  "hs_security_tls12_score" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_rtt_threshold" : 123,
  "enable_advanced_analytics" : true,
  "exclude_no_valid_gs_member_as_error" : true,
  "url" : "aeiou",
  "disable_server_analytics" : true,
  "hs_security_ssl30_score" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_server_lossy_timeo_rexmt_threshold" : 123,
  "tenant_ref" : "aeiou",
  "latency_audit_props" : {
    "latency_audit_mode" : "aeiou",
    "conn_est_audit_mode" : "aeiou",
    "conn_est_threshold" : 123,
    "latency_threshold" : 123
  },
  "hs_pscore_traffic_threshold_l4_server" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_certscore_le07d" : 1.3579000000000001069366817318950779736042022705078125,
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "aeiou"
  } ],
  "conn_lossy_total_rexmt_threshold" : 123
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK AnalyticsProfile

401

delete /analyticsprofile/{uuid}

(analyticsprofileUuidDelete)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

name (optional)

Query Parameter — object name

Return type

String

Example data

Content-Type: application/json

"aeiou"

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204

object deleted String

404

not found

get /analyticsprofile/{uuid}

(analyticsprofileUuidGet)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

name (optional)

Query Parameter — object name

fields (optional)

Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

include_name (optional)

Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

skip_default (optional)

Query Parameter — Default values are not set.

join_subresources (optional)

Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

AnalyticsProfile

Example data

Content-Type: application/json

{
  "exclude_stale_ocsp_responses_as_error" : true,
  "hs_security_encalgo_score_rc4" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_certscore_le30d" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_rum_threshold" : 123,
  "enable_vs_analytics" : true,
  "disable_ondemand_metrics" : true,
  "hs_security_tls11_score" : 1.3579000000000001069366817318950779736042022705078125,
  "disable_vs_analytics" : true,
  "hs_security_cipherscore_lt128b" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_server_response_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_weak_signature_algo_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_encalgo_score_none" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_server_rtt_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "uuid" : "aeiou",
  "conn_server_lossy_ooo_threshold" : 123,
  "hs_security_selfsignedcert_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_server_response_threshold" : 123,
  "exclude_no_dns_record_as_error" : true,
  "exclude_client_close_before_request_as_error" : true,
  "configpb_attributes" : {
    "version" : 123
  },
  "sip_log_depth" : 123,
  "apdex_response_threshold" : 123,
  "apdex_response_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_server_lossy_zero_win_size_event_threshold" : 123,
  "exclude_syn_retransmit_as_error" : true,
  "hs_performance_boost" : 123,
  "hs_security_tls10_score" : 1.3579000000000001069366817318950779736042022705078125,
  "client_log_streaming_config" : {
    "protocol" : "aeiou",
    "syslog_config" : {
      "hostname" : "aeiou",
      "filtered_log_severity" : 123,
      "significant_log_severity" : 123,
      "facility" : 123,
      "non_significant_log_severity" : 123
    },
    "external_server" : "aeiou",
    "format_config" : {
      "included_fields" : [ "aeiou" ],
      "format" : "aeiou"
    },
    "log_types_to_send" : "aeiou",
    "external_server_port" : 123,
    "max_logs_per_second" : 123
  },
  "exclude_revoked_ocsp_responses_as_error" : true,
  "exclude_invalid_dns_domain_as_error" : true,
  "exclude_issuer_revoked_ocsp_responses_as_error" : true,
  "apdex_rtt_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_lossy_ooo_threshold" : 123,
  "enable_server_analytics" : true,
  "exclude_unavailable_ocsp_responses_as_error" : true,
  "conn_server_lossy_total_rexmt_threshold" : 123,
  "exclude_sip_error_codes" : [ "" ],
  "hs_security_cipherscore_ge128b" : 1.3579000000000001069366817318950779736042022705078125,
  "labels" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "conn_lossy_timeo_rexmt_threshold" : 123,
  "hs_event_throttle_window" : 123,
  "resp_code_block" : [ "aeiou" ],
  "hs_security_hsts_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "healthscore_max_server_limit" : 123,
  "exclude_gs_down_as_error" : true,
  "disable_se_analytics" : true,
  "exclude_persistence_change_as_error" : true,
  "ondemand_metrics_idle_timeout" : 123,
  "apdex_rum_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "name" : "aeiou",
  "hs_max_security_penalty" : 123,
  "enable_se_analytics" : true,
  "exclude_unsupported_dns_query_as_error" : true,
  "conn_lossy_zero_win_size_event_threshold" : 123,
  "enable_adaptive_config" : true,
  "hs_security_chain_invalidity_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "ranges" : [ {
    "end" : 123,
    "begin" : 123
  } ],
  "client_log_config" : {
    "filtered_log_processing" : "aeiou",
    "non_significant_log_processing" : "aeiou",
    "significant_log_processing" : "aeiou",
    "enable_significant_log_collection" : true
  },
  "exclude_server_tcp_reset_as_error" : true,
  "exclude_http_error_codes" : [ "" ],
  "hs_min_dos_rate" : 123,
  "enable_ondemand_metrics" : true,
  "description" : "aeiou",
  "apdex_server_rtt_threshold" : 123,
  "hs_security_certscore_gt30d" : 1.3579000000000001069366817318950779736042022705078125,
  "exclude_dns_policy_drop_as_significant" : true,
  "_last_modified" : "aeiou",
  "hs_max_resources_penalty" : 123,
  "hs_pscore_traffic_threshold_l4_client" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_max_anomaly_penalty" : 123,
  "hs_security_tls13_score" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_certscore_expired" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_ocsp_revoked_score" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_nonpfs_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "sensitive_log_profile" : {
    "uri_query_field_rules" : [ "" ],
    "waf_field_rules" : [ "" ],
    "header_field_rules" : [ {
      "match" : {
        "match_criteria" : "aeiou",
        "string_group_refs" : [ "aeiou" ],
        "match_str" : [ "aeiou" ]
      },
      "name" : "aeiou",
      "action" : "aeiou",
      "index" : 123,
      "enabled" : true
    } ]
  },
  "exclude_tcp_reset_as_error" : true,
  "hs_security_cipherscore_eq000b" : 1.3579000000000001069366817318950779736042022705078125,
  "exclude_invalid_dns_query_as_error" : true,
  "exclude_server_dns_error_as_error" : true,
  "hs_security_tls12_score" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_rtt_threshold" : 123,
  "enable_advanced_analytics" : true,
  "exclude_no_valid_gs_member_as_error" : true,
  "url" : "aeiou",
  "disable_server_analytics" : true,
  "hs_security_ssl30_score" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_server_lossy_timeo_rexmt_threshold" : 123,
  "tenant_ref" : "aeiou",
  "latency_audit_props" : {
    "latency_audit_mode" : "aeiou",
    "conn_est_audit_mode" : "aeiou",
    "conn_est_threshold" : 123,
    "latency_threshold" : 123
  },
  "hs_pscore_traffic_threshold_l4_server" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_certscore_le07d" : 1.3579000000000001069366817318950779736042022705078125,
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "aeiou"
  } ],
  "conn_lossy_total_rexmt_threshold" : 123
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK AnalyticsProfile

401

patch /analyticsprofile/{uuid}

(analyticsprofileUuidPatch)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — AnalyticsProfile object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

AnalyticsProfile

Example data

Content-Type: application/json

{
  "exclude_stale_ocsp_responses_as_error" : true,
  "hs_security_encalgo_score_rc4" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_certscore_le30d" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_rum_threshold" : 123,
  "enable_vs_analytics" : true,
  "disable_ondemand_metrics" : true,
  "hs_security_tls11_score" : 1.3579000000000001069366817318950779736042022705078125,
  "disable_vs_analytics" : true,
  "hs_security_cipherscore_lt128b" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_server_response_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_weak_signature_algo_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_encalgo_score_none" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_server_rtt_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "uuid" : "aeiou",
  "conn_server_lossy_ooo_threshold" : 123,
  "hs_security_selfsignedcert_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_server_response_threshold" : 123,
  "exclude_no_dns_record_as_error" : true,
  "exclude_client_close_before_request_as_error" : true,
  "configpb_attributes" : {
    "version" : 123
  },
  "sip_log_depth" : 123,
  "apdex_response_threshold" : 123,
  "apdex_response_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_server_lossy_zero_win_size_event_threshold" : 123,
  "exclude_syn_retransmit_as_error" : true,
  "hs_performance_boost" : 123,
  "hs_security_tls10_score" : 1.3579000000000001069366817318950779736042022705078125,
  "client_log_streaming_config" : {
    "protocol" : "aeiou",
    "syslog_config" : {
      "hostname" : "aeiou",
      "filtered_log_severity" : 123,
      "significant_log_severity" : 123,
      "facility" : 123,
      "non_significant_log_severity" : 123
    },
    "external_server" : "aeiou",
    "format_config" : {
      "included_fields" : [ "aeiou" ],
      "format" : "aeiou"
    },
    "log_types_to_send" : "aeiou",
    "external_server_port" : 123,
    "max_logs_per_second" : 123
  },
  "exclude_revoked_ocsp_responses_as_error" : true,
  "exclude_invalid_dns_domain_as_error" : true,
  "exclude_issuer_revoked_ocsp_responses_as_error" : true,
  "apdex_rtt_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_lossy_ooo_threshold" : 123,
  "enable_server_analytics" : true,
  "exclude_unavailable_ocsp_responses_as_error" : true,
  "conn_server_lossy_total_rexmt_threshold" : 123,
  "exclude_sip_error_codes" : [ "" ],
  "hs_security_cipherscore_ge128b" : 1.3579000000000001069366817318950779736042022705078125,
  "labels" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "conn_lossy_timeo_rexmt_threshold" : 123,
  "hs_event_throttle_window" : 123,
  "resp_code_block" : [ "aeiou" ],
  "hs_security_hsts_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "healthscore_max_server_limit" : 123,
  "exclude_gs_down_as_error" : true,
  "disable_se_analytics" : true,
  "exclude_persistence_change_as_error" : true,
  "ondemand_metrics_idle_timeout" : 123,
  "apdex_rum_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "name" : "aeiou",
  "hs_max_security_penalty" : 123,
  "enable_se_analytics" : true,
  "exclude_unsupported_dns_query_as_error" : true,
  "conn_lossy_zero_win_size_event_threshold" : 123,
  "enable_adaptive_config" : true,
  "hs_security_chain_invalidity_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "ranges" : [ {
    "end" : 123,
    "begin" : 123
  } ],
  "client_log_config" : {
    "filtered_log_processing" : "aeiou",
    "non_significant_log_processing" : "aeiou",
    "significant_log_processing" : "aeiou",
    "enable_significant_log_collection" : true
  },
  "exclude_server_tcp_reset_as_error" : true,
  "exclude_http_error_codes" : [ "" ],
  "hs_min_dos_rate" : 123,
  "enable_ondemand_metrics" : true,
  "description" : "aeiou",
  "apdex_server_rtt_threshold" : 123,
  "hs_security_certscore_gt30d" : 1.3579000000000001069366817318950779736042022705078125,
  "exclude_dns_policy_drop_as_significant" : true,
  "_last_modified" : "aeiou",
  "hs_max_resources_penalty" : 123,
  "hs_pscore_traffic_threshold_l4_client" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_max_anomaly_penalty" : 123,
  "hs_security_tls13_score" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_certscore_expired" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_ocsp_revoked_score" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_nonpfs_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "sensitive_log_profile" : {
    "uri_query_field_rules" : [ "" ],
    "waf_field_rules" : [ "" ],
    "header_field_rules" : [ {
      "match" : {
        "match_criteria" : "aeiou",
        "string_group_refs" : [ "aeiou" ],
        "match_str" : [ "aeiou" ]
      },
      "name" : "aeiou",
      "action" : "aeiou",
      "index" : 123,
      "enabled" : true
    } ]
  },
  "exclude_tcp_reset_as_error" : true,
  "hs_security_cipherscore_eq000b" : 1.3579000000000001069366817318950779736042022705078125,
  "exclude_invalid_dns_query_as_error" : true,
  "exclude_server_dns_error_as_error" : true,
  "hs_security_tls12_score" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_rtt_threshold" : 123,
  "enable_advanced_analytics" : true,
  "exclude_no_valid_gs_member_as_error" : true,
  "url" : "aeiou",
  "disable_server_analytics" : true,
  "hs_security_ssl30_score" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_server_lossy_timeo_rexmt_threshold" : 123,
  "tenant_ref" : "aeiou",
  "latency_audit_props" : {
    "latency_audit_mode" : "aeiou",
    "conn_est_audit_mode" : "aeiou",
    "conn_est_threshold" : 123,
    "latency_threshold" : 123
  },
  "hs_pscore_traffic_threshold_l4_server" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_certscore_le07d" : 1.3579000000000001069366817318950779736042022705078125,
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "aeiou"
  } ],
  "conn_lossy_total_rexmt_threshold" : 123
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK AnalyticsProfile

401

put /analyticsprofile/{uuid}

(analyticsprofileUuidPut)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — AnalyticsProfile object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

AnalyticsProfile

Example data

Content-Type: application/json

{
  "exclude_stale_ocsp_responses_as_error" : true,
  "hs_security_encalgo_score_rc4" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_certscore_le30d" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_rum_threshold" : 123,
  "enable_vs_analytics" : true,
  "disable_ondemand_metrics" : true,
  "hs_security_tls11_score" : 1.3579000000000001069366817318950779736042022705078125,
  "disable_vs_analytics" : true,
  "hs_security_cipherscore_lt128b" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_server_response_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_weak_signature_algo_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_encalgo_score_none" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_server_rtt_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "uuid" : "aeiou",
  "conn_server_lossy_ooo_threshold" : 123,
  "hs_security_selfsignedcert_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_server_response_threshold" : 123,
  "exclude_no_dns_record_as_error" : true,
  "exclude_client_close_before_request_as_error" : true,
  "configpb_attributes" : {
    "version" : 123
  },
  "sip_log_depth" : 123,
  "apdex_response_threshold" : 123,
  "apdex_response_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_server_lossy_zero_win_size_event_threshold" : 123,
  "exclude_syn_retransmit_as_error" : true,
  "hs_performance_boost" : 123,
  "hs_security_tls10_score" : 1.3579000000000001069366817318950779736042022705078125,
  "client_log_streaming_config" : {
    "protocol" : "aeiou",
    "syslog_config" : {
      "hostname" : "aeiou",
      "filtered_log_severity" : 123,
      "significant_log_severity" : 123,
      "facility" : 123,
      "non_significant_log_severity" : 123
    },
    "external_server" : "aeiou",
    "format_config" : {
      "included_fields" : [ "aeiou" ],
      "format" : "aeiou"
    },
    "log_types_to_send" : "aeiou",
    "external_server_port" : 123,
    "max_logs_per_second" : 123
  },
  "exclude_revoked_ocsp_responses_as_error" : true,
  "exclude_invalid_dns_domain_as_error" : true,
  "exclude_issuer_revoked_ocsp_responses_as_error" : true,
  "apdex_rtt_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_lossy_ooo_threshold" : 123,
  "enable_server_analytics" : true,
  "exclude_unavailable_ocsp_responses_as_error" : true,
  "conn_server_lossy_total_rexmt_threshold" : 123,
  "exclude_sip_error_codes" : [ "" ],
  "hs_security_cipherscore_ge128b" : 1.3579000000000001069366817318950779736042022705078125,
  "labels" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "conn_lossy_timeo_rexmt_threshold" : 123,
  "hs_event_throttle_window" : 123,
  "resp_code_block" : [ "aeiou" ],
  "hs_security_hsts_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "healthscore_max_server_limit" : 123,
  "exclude_gs_down_as_error" : true,
  "disable_se_analytics" : true,
  "exclude_persistence_change_as_error" : true,
  "ondemand_metrics_idle_timeout" : 123,
  "apdex_rum_tolerated_factor" : 1.3579000000000001069366817318950779736042022705078125,
  "name" : "aeiou",
  "hs_max_security_penalty" : 123,
  "enable_se_analytics" : true,
  "exclude_unsupported_dns_query_as_error" : true,
  "conn_lossy_zero_win_size_event_threshold" : 123,
  "enable_adaptive_config" : true,
  "hs_security_chain_invalidity_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "ranges" : [ {
    "end" : 123,
    "begin" : 123
  } ],
  "client_log_config" : {
    "filtered_log_processing" : "aeiou",
    "non_significant_log_processing" : "aeiou",
    "significant_log_processing" : "aeiou",
    "enable_significant_log_collection" : true
  },
  "exclude_server_tcp_reset_as_error" : true,
  "exclude_http_error_codes" : [ "" ],
  "hs_min_dos_rate" : 123,
  "enable_ondemand_metrics" : true,
  "description" : "aeiou",
  "apdex_server_rtt_threshold" : 123,
  "hs_security_certscore_gt30d" : 1.3579000000000001069366817318950779736042022705078125,
  "exclude_dns_policy_drop_as_significant" : true,
  "_last_modified" : "aeiou",
  "hs_max_resources_penalty" : 123,
  "hs_pscore_traffic_threshold_l4_client" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_max_anomaly_penalty" : 123,
  "hs_security_tls13_score" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_certscore_expired" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_ocsp_revoked_score" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_nonpfs_penalty" : 1.3579000000000001069366817318950779736042022705078125,
  "sensitive_log_profile" : {
    "uri_query_field_rules" : [ "" ],
    "waf_field_rules" : [ "" ],
    "header_field_rules" : [ {
      "match" : {
        "match_criteria" : "aeiou",
        "string_group_refs" : [ "aeiou" ],
        "match_str" : [ "aeiou" ]
      },
      "name" : "aeiou",
      "action" : "aeiou",
      "index" : 123,
      "enabled" : true
    } ]
  },
  "exclude_tcp_reset_as_error" : true,
  "hs_security_cipherscore_eq000b" : 1.3579000000000001069366817318950779736042022705078125,
  "exclude_invalid_dns_query_as_error" : true,
  "exclude_server_dns_error_as_error" : true,
  "hs_security_tls12_score" : 1.3579000000000001069366817318950779736042022705078125,
  "apdex_rtt_threshold" : 123,
  "enable_advanced_analytics" : true,
  "exclude_no_valid_gs_member_as_error" : true,
  "url" : "aeiou",
  "disable_server_analytics" : true,
  "hs_security_ssl30_score" : 1.3579000000000001069366817318950779736042022705078125,
  "conn_server_lossy_timeo_rexmt_threshold" : 123,
  "tenant_ref" : "aeiou",
  "latency_audit_props" : {
    "latency_audit_mode" : "aeiou",
    "conn_est_audit_mode" : "aeiou",
    "conn_est_threshold" : 123,
    "latency_threshold" : 123
  },
  "hs_pscore_traffic_threshold_l4_server" : 1.3579000000000001069366817318950779736042022705078125,
  "hs_security_certscore_le07d" : 1.3579000000000001069366817318950779736042022705078125,
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "aeiou"
  } ],
  "conn_lossy_total_rexmt_threshold" : 123
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK AnalyticsProfile

401

get /analyticsprofile/{uuid}/runtime/internal/

(analyticsprofileUuidRuntimeInternalGet)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Return type

String

Example data

Content-Type: application/json

"aeiou"

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK String

401

Models

[ Jump to Methods ]

AnalyticsProfile
AnalyticsProfileApiResponse
ClientLogConfiguration
ClientLogStreamingConfig
ClientLogStreamingFormat
ConfigPbAttributes
HTTPStatusRange
KeyValue
LatencyAuditProperties
RoleFilterMatchLabel
SensitiveFieldRule
SensitiveLogProfile
StreamingSyslogConfig
StringMatch

AnalyticsProfile Up

_last_modified (optional)

String UNIX time since epoch in microseconds. Units(MICROSECONDS).

apdex_response_threshold (optional)

Integer 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. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 500), Basic edition(Allowed values- 500), Enterprise with Cloud Services edition. format: int32

apdex_response_tolerated_factor (optional)

Double 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. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 4), Basic edition(Allowed values- 4), Enterprise with Cloud Services edition. format: double

apdex_rtt_threshold (optional)

Integer Satisfactory client to Avi Round Trip Time(RTT). Allowed values are 1-2000. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 250), Basic edition(Allowed values- 250), Enterprise with Cloud Services edition. format: int32

apdex_rtt_tolerated_factor (optional)

Double Tolerated client to Avi Round Trip Time(RTT) factor. It is a multiple of apdex_rtt_tolerated_factor. Allowed values are 1-1000. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 4), Basic edition(Allowed values- 4), Enterprise with Cloud Services edition. format: double

apdex_rum_threshold (optional)

Integer 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. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 5000), Basic edition(Allowed values- 5000), Enterprise with Cloud Services edition. format: int32

apdex_rum_tolerated_factor (optional)

Double Virtual service threshold factor for tolerated Page Load Time (PLT) as multiple of apdex_rum_threshold. Allowed values are 1-1000. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 4), Basic edition(Allowed values- 4), Enterprise with Cloud Services edition. format: double

apdex_server_response_threshold (optional)

Integer 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. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 400), Basic edition(Allowed values- 400), Enterprise with Cloud Services edition. format: int32

apdex_server_response_tolerated_factor (optional)

Double 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. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 4), Basic edition(Allowed values- 4), Enterprise with Cloud Services edition. format: double

apdex_server_rtt_threshold (optional)

Integer Satisfactory client to Avi Round Trip Time(RTT). Allowed values are 1-2000. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 125), Basic edition(Allowed values- 125), Enterprise with Cloud Services edition. format: int32

apdex_server_rtt_tolerated_factor (optional)

client_log_config (optional)

ClientLogConfiguration Configure which logs are sent to the Avi Controller from SEs and how they are processed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

client_log_streaming_config (optional)

ClientLogStreamingConfig Configure to stream logs to an external server. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

configpb_attributes (optional)

ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

conn_lossy_ooo_threshold (optional)

Integer 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. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 50), Basic edition(Allowed values- 50), Enterprise with Cloud Services edition. format: int32

conn_lossy_timeo_rexmt_threshold (optional)

Integer 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. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 20), Basic edition(Allowed values- 20), Enterprise with Cloud Services edition. format: int32

conn_lossy_total_rexmt_threshold (optional)

Integer 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. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 50), Basic edition(Allowed values- 50), Enterprise with Cloud Services edition. format: int32

conn_lossy_zero_win_size_event_threshold (optional)

Integer 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. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 2), Basic edition(Allowed values- 2), Enterprise with Cloud Services edition. format: int32

conn_server_lossy_ooo_threshold (optional)

Integer 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. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 50), Basic edition(Allowed values- 50), Enterprise with Cloud Services edition. format: int32

conn_server_lossy_timeo_rexmt_threshold (optional)

Integer 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. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 20), Basic edition(Allowed values- 20), Enterprise with Cloud Services edition. format: int32

conn_server_lossy_total_rexmt_threshold (optional)

Integer 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. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 50), Basic edition(Allowed values- 50), Enterprise with Cloud Services edition. format: int32

conn_server_lossy_zero_win_size_event_threshold (optional)

Integer 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. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 2), Basic edition(Allowed values- 2), Enterprise with Cloud Services edition. format: int32

description (optional)

String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

disable_ondemand_metrics (optional)

Boolean 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. Field deprecated in 20.1.3. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

disable_se_analytics (optional)

Boolean Disable node (service engine) level analytics forvs metrics. Field deprecated in 20.1.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

disable_server_analytics (optional)

Boolean Disable 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 disabled. Field deprecated in 20.1.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

disable_vs_analytics (optional)

Boolean Disable VirtualService (frontend) Analytics. This flag disables metrics and healthscore for Virtualservice. Field deprecated in 20.1.3. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

enable_adaptive_config (optional)

Boolean Enable adaptive configuration for optimizing resource usage. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

enable_advanced_analytics (optional)

Boolean 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. Field introduced in 17.2.13, 18.1.5, 18.2.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition. Special default for Essentials edition is false, Basic edition is false, Enterprise is True.

enable_ondemand_metrics (optional)

Boolean 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. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

enable_se_analytics (optional)

Boolean Enable node (service engine) level analytics forvs metrics. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

enable_server_analytics (optional)

Boolean 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. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

enable_vs_analytics (optional)

Boolean Enable VirtualService (frontend) Analytics. This flag enables metrics and healthscore for Virtualservice. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

exclude_client_close_before_request_as_error (optional)

Boolean Exclude client closed connection before an HTTP request could be completed from being classified as an error. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

exclude_dns_policy_drop_as_significant (optional)

Boolean Exclude dns policy drops from the list of errors. Field introduced in 17.2.2. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

exclude_gs_down_as_error (optional)

Boolean Exclude queries to GSLB services that are operationally down from the list of errors. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

exclude_http_error_codes (optional)

array[Integer] 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. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

exclude_invalid_dns_domain_as_error (optional)

Boolean Exclude dns queries to domains outside the domains configured in the DNS application profile from the list of errors. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

exclude_invalid_dns_query_as_error (optional)

Boolean Exclude invalid dns queries from the list of errors. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

exclude_issuer_revoked_ocsp_responses_as_error (optional)

Boolean Exclude the Issuer-Revoked OCSP Responses from the list of errors. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- true), Basic edition(Allowed values- true), Enterprise with Cloud Services edition.

exclude_no_dns_record_as_error (optional)

Boolean Exclude queries to domains that did not have configured services/records from the list of errors. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

exclude_no_valid_gs_member_as_error (optional)

Boolean Exclude queries to GSLB services that have no available members from the list of errors. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

exclude_persistence_change_as_error (optional)

Boolean Exclude persistence server changed while load balancing' from the list of errors. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

exclude_revoked_ocsp_responses_as_error (optional)

Boolean Exclude the Revoked OCSP certificate status responses from the list of errors. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- true), Basic edition(Allowed values- true), Enterprise with Cloud Services edition.

exclude_server_dns_error_as_error (optional)

Boolean Exclude server dns error response from the list of errors. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

exclude_server_tcp_reset_as_error (optional)

Boolean Exclude server TCP reset from errors. It is common for applications like MS Exchange. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

exclude_sip_error_codes (optional)

array[Integer] List of SIP status codes to be excluded from being classified as an error. Field introduced in 17.2.13, 18.1.5, 18.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

exclude_stale_ocsp_responses_as_error (optional)

Boolean Exclude the Stale OCSP certificate status responses from the list of errors. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- true), Basic edition(Allowed values- true), Enterprise with Cloud Services edition.

exclude_syn_retransmit_as_error (optional)

Boolean Exclude 'server unanswered syns' from the list of errors. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

exclude_tcp_reset_as_error (optional)

Boolean Exclude TCP resets by client from the list of potential errors. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

exclude_unavailable_ocsp_responses_as_error (optional)

Boolean Exclude the unavailable OCSP Responses from the list of errors. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- true), Basic edition(Allowed values- true), Enterprise with Cloud Services edition.

exclude_unsupported_dns_query_as_error (optional)

Boolean Exclude unsupported dns queries from the list of errors. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

healthscore_max_server_limit (optional)

Integer 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. Field introduced in 17.2.13, 18.1.4. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 0), Basic edition(Allowed values- 0), Enterprise with Cloud Services edition. Special default for Essentials edition is 0, Basic edition is 0, Enterprise is 20. format: int32

hs_event_throttle_window (optional)

Integer Time window (in secs) within which only unique health change events should occur. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 1209600), Basic edition(Allowed values- 1209600), Enterprise with Cloud Services edition. format: int32

hs_max_anomaly_penalty (optional)

Integer Maximum penalty that may be deducted from health score for anomalies. Allowed values are 0-100. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 10), Basic edition(Allowed values- 10), Enterprise with Cloud Services edition. format: int32

hs_max_resources_penalty (optional)

Integer Maximum penalty that may be deducted from health score for high resource utilization. Allowed values are 0-100. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 25), Basic edition(Allowed values- 25), Enterprise with Cloud Services edition. format: int32

hs_max_security_penalty (optional)

Integer Maximum penalty that may be deducted from health score based on security assessment. Allowed values are 0-100. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 100), Basic edition(Allowed values- 100), Enterprise with Cloud Services edition. format: int32

hs_min_dos_rate (optional)

Integer DoS connection rate below which the DoS security assessment will not kick in. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 1000), Basic edition(Allowed values- 1000), Enterprise with Cloud Services edition. format: int32

hs_performance_boost (optional)

Integer 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. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 0), Basic edition(Allowed values- 0), Enterprise with Cloud Services edition. format: int32

hs_pscore_traffic_threshold_l4_client (optional)

Double Threshold number of connections in 5min, below which apdexr, apdexc, rum_apdex, and other network quality metrics are not computed. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 10), Basic edition(Allowed values- 10), Enterprise with Cloud Services edition. format: double

hs_pscore_traffic_threshold_l4_server (optional)

hs_security_certscore_expired (optional)

Double Score assigned when the certificate has expired. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 0.0), Basic edition(Allowed values- 0.0), Enterprise with Cloud Services edition. format: double

hs_security_certscore_gt30d (optional)

Double Score assigned when the certificate expires in more than 30 days. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 5.0), Basic edition(Allowed values- 5.0), Enterprise with Cloud Services edition. format: double

hs_security_certscore_le07d (optional)

Double Score assigned when the certificate expires in less than or equal to 7 days. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 2.0), Basic edition(Allowed values- 2.0), Enterprise with Cloud Services edition. format: double

hs_security_certscore_le30d (optional)

Double Score assigned when the certificate expires in less than or equal to 30 days. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 4.0), Basic edition(Allowed values- 4.0), Enterprise with Cloud Services edition. format: double

hs_security_chain_invalidity_penalty (optional)

Double Penalty for allowing certificates with invalid chain. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 1.0), Basic edition(Allowed values- 1.0), Enterprise with Cloud Services edition. format: double

hs_security_cipherscore_eq000b (optional)

Double Score assigned when the minimum cipher strength is 0 bits. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 0.0), Basic edition(Allowed values- 0.0), Enterprise with Cloud Services edition. format: double

hs_security_cipherscore_ge128b (optional)

Double Score assigned when the minimum cipher strength is greater than equal to 128 bits. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 5.0), Basic edition(Allowed values- 5.0), Enterprise with Cloud Services edition. format: double

hs_security_cipherscore_lt128b (optional)

Double Score assigned when the minimum cipher strength is less than 128 bits. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 3.5), Basic edition(Allowed values- 3.5), Enterprise with Cloud Services edition. format: double

hs_security_encalgo_score_none (optional)

Double Score assigned when no algorithm is used for encryption. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 0.0), Basic edition(Allowed values- 0.0), Enterprise with Cloud Services edition. format: double

hs_security_encalgo_score_rc4 (optional)

Double Score assigned when RC4 algorithm is used for encryption. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 2.5), Basic edition(Allowed values- 2.5), Enterprise with Cloud Services edition. format: double

hs_security_hsts_penalty (optional)

Double Penalty for not enabling HSTS. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 1.0), Basic edition(Allowed values- 1.0), Enterprise with Cloud Services edition. format: double

hs_security_nonpfs_penalty (optional)

Double Penalty for allowing non-PFS handshakes. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 1.0), Basic edition(Allowed values- 1.0), Enterprise with Cloud Services edition. format: double

hs_security_ocsp_revoked_score (optional)

Double Score assigned when OCSP Certificate Status is set to Revoked or Issuer Revoked. Allowed values are 0.0-5.0. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 0.0), Basic edition(Allowed values- 0.0), Enterprise with Cloud Services edition. format: double

hs_security_selfsignedcert_penalty (optional)

Double Deprecated. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 1.0), Basic edition(Allowed values- 1.0), Enterprise with Cloud Services edition. format: double

hs_security_ssl30_score (optional)

Double Score assigned when supporting SSL3.0 encryption protocol. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 3.5), Basic edition(Allowed values- 3.5), Enterprise with Cloud Services edition. format: double

hs_security_tls10_score (optional)

Double Score assigned when supporting TLS1.0 encryption protocol. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 5.0), Basic edition(Allowed values- 5.0), Enterprise with Cloud Services edition. format: double

hs_security_tls11_score (optional)

Double Score assigned when supporting TLS1.1 encryption protocol. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 5.0), Basic edition(Allowed values- 5.0), Enterprise with Cloud Services edition. format: double

hs_security_tls12_score (optional)

Double Score assigned when supporting TLS1.2 encryption protocol. Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 5.0), Basic edition(Allowed values- 5.0), Enterprise with Cloud Services edition. format: double

hs_security_tls13_score (optional)

Double Score assigned when supporting TLS1.3 encryption protocol. Allowed values are 0-5. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 5.0), Basic edition(Allowed values- 5.0), Enterprise with Cloud Services edition. format: double

hs_security_weak_signature_algo_penalty (optional)

Double Penalty for allowing weak signature algorithm(s). Allowed values are 0-5. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 1.0), Basic edition(Allowed values- 1.0), Enterprise with Cloud Services edition. format: double

labels (optional)

array[KeyValue] Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field deprecated in 20.1.5. Field introduced in 20.1.2. Maximum of 4 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

latency_audit_props (optional)

LatencyAuditProperties Influence the audit of ingress latency and connection establishement time. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

markers (optional)

array[RoleFilterMatchLabel] List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

name

String The name of the analytics profile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ondemand_metrics_idle_timeout (optional)

Integer 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. Field introduced in 18.1.1. Unit is SECONDS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

ranges (optional)

array[HTTPStatusRange] List of HTTP status code ranges to be excluded from being classified as an error. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

resp_code_block (optional)

array[String] Block of HTTP response codes to be excluded from being classified as an error. Enum options - AP_HTTP_RSP_4XX, AP_HTTP_RSP_5XX. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

sensitive_log_profile (optional)

SensitiveLogProfile Rules applied to the HTTP application log for filtering sensitive information. Field introduced in 17.2.10, 18.1.2. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

sip_log_depth (optional)

Integer Maximum number of SIP messages added in logs for a SIP transaction. By default, this value is 20. Allowed values are 1-1000. Field introduced in 17.2.13, 18.1.5, 18.2.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 20), Basic edition(Allowed values- 20), Enterprise with Cloud Services edition. format: int32

tenant_ref (optional)

String It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

url (optional)

String url

uuid (optional)

String UUID of the analytics profile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

AnalyticsProfileApiResponse Up

count

Integer format: int32

results

array[AnalyticsProfile]

next (optional)

String

ClientLogConfiguration Up

enable_significant_log_collection (optional)

Boolean Enable significant log collection. By default, this flag is enabled, which means that Avi SEs collect significant logs and forward them to Controller for further processing. For example, these logs correspond to error conditions such as when the response code for a request is 500. Users can deactivate this flag to turn off default significant log collection. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition. Special default for Essentials edition is false, Basic edition is false, Enterprise is True.

filtered_log_processing (optional)

String Filtered logs are logs that match any client log filters or rules with logging enabled. Such logs are processed by the Logs Analytics system according to this setting. Enum options - LOGS_PROCESSING_NONE, LOGS_PROCESSING_SYNC_AND_INDEX_ON_DEMAND, LOGS_PROCESSING_AUTO_SYNC_AND_INDEX, LOGS_PROCESSING_AUTO_SYNC_BUT_INDEX_ON_DEMAND. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

non_significant_log_processing (optional)

String Logs that are neither significant nor filtered, are processed by the Logs Analytics system according to this setting. Enum options - LOGS_PROCESSING_NONE, LOGS_PROCESSING_SYNC_AND_INDEX_ON_DEMAND, LOGS_PROCESSING_AUTO_SYNC_AND_INDEX, LOGS_PROCESSING_AUTO_SYNC_BUT_INDEX_ON_DEMAND. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

significant_log_processing (optional)

String Significant logs are processed by the Logs Analytics system according to this setting. Enum options - LOGS_PROCESSING_NONE, LOGS_PROCESSING_SYNC_AND_INDEX_ON_DEMAND, LOGS_PROCESSING_AUTO_SYNC_AND_INDEX, LOGS_PROCESSING_AUTO_SYNC_BUT_INDEX_ON_DEMAND. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ClientLogStreamingConfig Up

external_server

String IP address or hostnames (FQDNs) of destination servers. If an FQDN is provided, this should be resolvable on Avi Service Engines. Multiple servers are supported by furnishing a comma-separated list of IP addresses or host names, for example, 11.11.11.11,23.12.12.4. Optionally, a separate port can be specified for each external server in the list, for example, 11.11.11.11 234,12.12.12.12 343. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

external_server_port (optional)

Integer The service port to use for the external servers. If multiple external servers have been specified, the single port number specified here will apply to all those servers for which an explicit port number has not been specified in the external server list. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

format_config (optional)

ClientLogStreamingFormat Configuration to specify the format of streamed logs. By default, each log is encoded in JSON format. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

log_types_to_send (optional)

String Type of logs to stream to the external server. Default is LOGS_ALL, i.e., send all logs. Enum options - LOGS_SIGNIFICANT_ONLY, LOGS_UDF_ONLY, LOGS_UDF_SIGNIFICANT, LOGS_ALL. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

max_logs_per_second (optional)

Integer Maximum number of logs per second streamed to the remote server. By default, 100 logs per second are streamed. Set this to zero(0) to not enforce any limit. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

protocol (optional)

String Protocol to use for streaming logs. Enum options - LOG_STREAMING_PROTOCOL_UDP, LOG_STREAMING_PROTOCOL_SYSLOG_OVER_UDP, LOG_STREAMING_PROTOCOL_TCP, LOG_STREAMING_PROTOCOL_SYSLOG_OVER_TCP, LOG_STREAMING_PROTOCOL_RAW_OVER_UDP, LOG_STREAMING_PROTOCOL_TLS, LOG_STREAMING_PROTOCOL_SYSLOG_OVER_TLS. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

syslog_config (optional)

StreamingSyslogConfig Syslog configuration if a Syslog-based protocol is specified for streaming. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ClientLogStreamingFormat Up

format

String Format for the streamed logs. Enum options - LOG_STREAMING_FORMAT_JSON_FULL, LOG_STREAMING_FORMAT_JSON_SELECTED. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

included_fields (optional)

array[String] List of log fields to be streamed, when selective fields (LOG_STREAMING_FORMAT_JSON_SELECTED) option is chosen. Only top-level fields in application or connection logs are supported. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ConfigPbAttributes Up

version (optional)

Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32

HTTPStatusRange Up

begin

Integer Starting HTTP response status code. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

end

Integer Ending HTTP response status code. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

KeyValue Up

key

String Key. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

value (optional)

String Value. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

LatencyAuditProperties Up

conn_est_audit_mode (optional)

String Audit TCP connection establishment time. Enum options - LATENCY_AUDIT_OFF, LATENCY_AUDIT_ON, LATENCY_AUDIT_ON_WITH_SIG. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

conn_est_threshold (optional)

Integer Maximum threshold for connection establishment time. Field introduced in 21.1.1. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32

latency_audit_mode (optional)

String Audit dispatcher to proxy latency. Enum options - LATENCY_AUDIT_OFF, LATENCY_AUDIT_ON, LATENCY_AUDIT_ON_WITH_SIG. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

latency_threshold (optional)

Integer Maximum latency threshold between dispatcher and proxy. Field introduced in 21.1.1. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32

RoleFilterMatchLabel Up

key

String Key for filter match. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

values (optional)

array[String] Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

SensitiveFieldRule Up

action (optional)

String Action for the matched log field, for instance the matched field can be removed or masked off. Enum options - LOG_FIELD_REMOVE, LOG_FIELD_MASKOFF. Field introduced in 17.2.10, 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

enabled (optional)

Boolean Enable rule to match the sensitive fields. Field introduced in 17.2.10, 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

index (optional)

Integer Index of the rule. Field introduced in 17.2.10, 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

match (optional)

StringMatch Criterion to use for matching in the Log. Field introduced in 17.2.10, 18.1.2. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

name (optional)

String Name of the rule. Field introduced in 17.2.10, 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

SensitiveLogProfile Up

header_field_rules (optional)

array[SensitiveFieldRule] Match sensitive header fields in HTTP application log. Field introduced in 17.2.10, 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

uri_query_field_rules (optional)

array[SensitiveFieldRule] Match sensitive URI query params in HTTP application log. Query params from the URI are extracted and checked for matching sensitive parameter names. A successful match will mask the parameter values in accordance with this rule action. Field introduced in 20.1.7, 21.1.2. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

waf_field_rules (optional)

array[SensitiveFieldRule] Match sensitive WAF log fields in HTTP application log. Field introduced in 17.2.13, 18.1.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

StreamingSyslogConfig Up

facility (optional)

Integer Facility value, as defined in RFC5424, must be between 0 and 23 inclusive. Allowed values are 0-23. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

filtered_log_severity (optional)

Integer Severity code, as defined in RFC5424, for filtered logs. This must be between 0 and 7 inclusive. Allowed values are 0-7. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

hostname (optional)

String String to use as the hostname in the syslog messages. This string can contain only printable ASCII characters (hex 21 to hex 7E; no space allowed). Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

non_significant_log_severity (optional)

Integer Severity code, as defined in RFC5424, for non-significant logs. This must be between 0 and 7 inclusive. Allowed values are 0-7. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

significant_log_severity (optional)

Integer Severity code, as defined in RFC5424, for significant logs. This must be between 0 and 7 inclusive. Allowed values are 0-7. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

StringMatch Up

match_criteria

String Criterion to use for string matching the HTTP request. Enum options - BEGINS_WITH, DOES_NOT_BEGIN_WITH, CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, DOES_NOT_END_WITH, EQUALS, DOES_NOT_EQUAL, REGEX_MATCH, REGEX_DOES_NOT_MATCH. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL), Basic edition(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL), Enterprise with Cloud Services edition.

match_str (optional)

array[String] String value(s). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string_group_refs (optional)

array[String] UUID of the string group(s). It is a reference to an object of type StringGroup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

Avi AnalyticsProfile Object API

Access

Table of Contents

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Consumes

Request body

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

204

404

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Return type

Example data

Produces

Responses

200

401

Table of Contents