a10_event_notification_kafka_server

Synopsis

Set remote kafka server ip address

Parameters

Parameters

Choices/Defaults

Comment

state

str/required

[‘noop’, ‘present’, ‘absent’]

State of the object to be created.

ansible_host

str/required

Host for AXAPI authentication

ansible_username

str/required

Username for AXAPI authentication

ansible_password

str/required

Password for AXAPI authentication

ansible_port

int/required

Port for AXAPI authentication

a10_device_context_id

int

[‘1-8’]

Device ID for aVCS configuration

a10_partition

str

Destination/target partition for object/command

host_ipv4

str

Set kafka Broker ip address or hostname

use_mgmt_port

bool

Use management port for connections

port

int

Set remote kafka port number (Remote kafka port number 1-32767, default is 9092)

uuid

str

uuid of the object

sampling_enable

list

Field sampling_enable

counters1

str

‘all’= all; ‘pr-acos-harmony-topic’= L7 PR logs sent; ‘avro-device-status- topic’= Device Status Metrics sent; ‘avro-partition-metrics-topic’= Partition Metrics sent; ‘avro-generic-sent’= Generic Metrics sent; ‘pr-acos-harmony- topic-enqueue-err’= L7 PR dropped,enq error on acos queues; ‘pr-acos-harmony- topic-dequeue-err’= L7 PR dropped,enq error analytics queues; ‘avro-generic- failed-encoding’= Generic Metrics dropped,encoding error; ‘avro-generic-failed- sending’= Generic Metrics dropped,sending failure; ‘avro-device-status-topic- enqueue-err’= Device Status dropped,enq error on acos queues; ‘avro-device- status-topic-dequeue-err’= Device Status dropped,enq error analytics queues; ‘avro-partition-metrics-topic-enqueue-err’= Part metrics dropped,enq error on acos queues; ‘avro-partition-metrics-topic-dequeue-err’= Part metrics dropped,enq error analytics queues; ‘kafka-unknown-topic-dequeue-err’= Unknown type dropped,enq error analytics queues; ‘kafka-broker-down’= Messages dropped,analytics down; ‘kafka-queue-full-err’= Messages dropped,acos analytics queue full; ‘pr-throttle-drop’= L7 PR dropped,log throttling; ‘pr-not-allowed- drop’= L7 PR dropped, not allowed to be sent; ‘pr-be-ttfb-anomaly’= L7 PR back- end ttfb is negative; ‘pr-be-ttlb-anomaly’= L7 PR back-end ttlb is negative; ‘pr-in-latency-threshold-exceed’= L7 PR on latency threshold exceeded; ‘pr-out- latency-threshold-exceed’= L7 PR out latency threshold exceeded; ‘pr-out- latency-anomaly’= L7 PR out latency negative; ‘pr-in-latency-anomaly’= L7 PR on latency negative; ‘kafka-topic-error’= Module not supported by analytics; ‘pc- encoding-failed’= L4 PC logs dropped,encoding error; ‘pc-acos-harmony-topic’= L4 PC logs sent; ‘pc-acos-harmony-topic-dequeue-err’= L4 PC logs dropped,enq error analytics queues; ‘cgn-pc-acos-harmony-topic’= CGN PC logs sent; ‘cgn-pc- acos-harmony-topic-dequeue-err’= CGN PC logs dropped,enq error analytics queues; ‘cgn-pe-acos-harmony-topic’= CGN PE logs sent; ‘cgn-pe-acos-harmony- topic-dequeue-err’= CGN PE logs dropped,enq error analytics queues; ‘fw-pc- acos-harmony-topic’= FW PC logs sent; ‘fw-pc-acos-harmony-topic-dequeue-err’= FW PC logs dropped,enq error analytics queues; ‘fw-deny-pc-acos-harmony-topic’= FW DENY PC logs sent; ‘fw-deny-pc-acos-harmony-topic-dequeue-err’= FW DENY PC logs dropped,enq error analytics queues; ‘fw-rst-pc-acos-harmony-topic’= FW RST PC logs sent; ‘fw-rst-pc-acos-harmony-topic-dequeue-err’= FW RST PC logs dropped,enq error analytics queues; ‘cgn-summary-error-acos-harmony-topic’= CGN PE logs sent; ‘cgn-summary-error-acos-harmony-topic-dequeue-err’= CGN PE logs dropped,enq error analytics queues; ‘rule-set-application-metrics-topic’= AppFW metrics sent; ‘rule-set-application-metrics-topic-dequeue-err’= AppFW metrics dropped,enq error analytics queues; ‘slb-ssl-stats-metrics-topic’= SSL metrics sent; ‘slb-ssl-stats-metrics-topic-dequeue-err’= SSL metrics dropped,enq error analytics queues; ‘slb-client-ssl-counters-metrics-topic’= Client SSL metrics sent; ‘slb-client-ssl-counters-metrics-topic-dequeue-err’= Cilent SSL metrics dropped,enq error analytics qs; ‘slb-server-ssl-counters-metrics-topic’= Server SSL metrics sent; ‘slb-server-ssl-counters-metrics-topic-dequeue-err’= Server SSL metrics dropped,enq error analytics qs; ‘pc-throttle-drop’= L4 PC logs dropped,throttling; ‘metrics-dropped-pt-missing’= Metrics dropped,missing partition tenant mapping; ‘ssli-pc-acos-harmony-topic’= SSLi PC topic counter from acos to harmony; ‘ssli-pc-acos-harmony-topic-dequeue-err’= SSLi PC topic to harmony dequeue error; ‘ssli-pe-acos-harmony-topic’= SSLi PE topic counter from acos to harmony; ‘ssli-pe-acos-harmony-topic-dequeue-err’= SSLi PE topic to harmony dequeue error; ‘analytics-bus-restart’= Analytics bus restart count; ‘waf-learn-pr-topic’= WAF learn topic counter; ‘waf-learn-pr-topic-dequeue- err’= WAF learn metrics dropped,enq error analytics qs; ‘waf-events-topic’= WAF events topic counter; ‘waf-events-topic-dequeue-err’= WAF events metrics dropped,enq error analytics qs; ‘visibility-topn-harmony-topic’= Visibility TopN sent; ‘visibility-topn-harmony-topic-dequeue-err’= Visibility TopN metrics dropped,enq error analytics qs; ‘hc-logs-sent-to-master’= HC logs sent to master; ‘hc-logs-received-from-blade’= HC logs received from blade; ‘hc-oper- sent-to-master’= HC oper to master; ‘hc-oper-received-from-blade’= HC oper received from blade; ‘hc-counters-sent-to-master’= HC counters sent to master; ‘hc-counters-received-from-blade’= HC counters received from blade; ‘hc- counters-dropped-from-blade’= HC counters dropped from blade (uuid or size mismatch); ‘pe-acos-harmony-topic’= L7 PE logs sent; ‘pe-acos-harmony-topic- enqueue-err’= L7 PE dropped,enq error on acos queues; ‘pe-acos-harmony-topic- dequeue-err’= L7 PE dropped,enq error analytics queues; ‘vpn-ipsec-sa-metrics- topic’= IPSec SA metrics sent; ‘vpn-ipsec-sa-metrics-topic-dequeue-err’= IPSec SA metrics dropped,enq error analytics qs; ‘vpn-ike-gateway-metrics-topic’= IKE gateway metrics sent; ‘vpn-ike-gateway-metrics-topic-dequeue-err’= IKE gateway metrics dropped,enq error analytics qs; ‘vpn-stats-metrics-topic’= VPN STATS metrics sent; ‘vpn-stats-metrics-topic-dequeue-err’= VPN STATS metrics dropped,enq error analytics qs; ‘cgn-port-usage-hstgrm-acos-harmony-topic’= CGN Port Usage Histogram HC Export; ‘cgn-port-usage-hstgrm-acos-harmony-topic- dequeue-err’= CGN Port Usage Histogram HC Export Failed; ‘avro-system-env- topic’= System environment sent; ‘avro-system-env-dequeue-err’= System Environmet dropped,enq error analytics queues; ‘cert-pinning-list-topic’= Cert- pinning candidate list sent; ‘cert-pinning-list-topic-dequeue-err’= Cert- pinning candidate list dropped,enq error analytics queues; ‘ngwaf-hc-ep-topic’= NGWAF HC PE export; ‘ngwaf-hc-ep-topic-dequeue-err’= NGWAF HC PE export failed; ‘ngwaf-hc-metrics-topic’= NGWAF HC metrics export; ‘ngwaf-hc-metrics-topic- dequeue-err’= NGWAF HC metrics export failed;

oper

dict

Field oper

kafka_broker_state

str

Field kafka_broker_state

stats

dict

Field stats

pr_acos_harmony_topic

str

L7 PR logs sent

avro_device_status_topic

str

Device Status Metrics sent

avro_partition_metrics_topic

str

Partition Metrics sent

avro_generic_sent

str

Generic Metrics sent

pr_acos_harmony_topic_enqueue_err

str

L7 PR dropped,enq error on acos queues

pr_acos_harmony_topic_dequeue_err

str

L7 PR dropped,enq error analytics queues

avro_generic_failed_encoding

str

Generic Metrics dropped,encoding error

avro_generic_failed_sending

str

Generic Metrics dropped,sending failure

avro_device_status_topic_enqueue_err

str

Device Status dropped,enq error on acos queues

avro_device_status_topic_dequeue_err

str

Device Status dropped,enq error analytics queues

avro_partition_metrics_topic_enqueue_err

str

Part metrics dropped,enq error on acos queues

avro_partition_metrics_topic_dequeue_err

str

Part metrics dropped,enq error analytics queues

kafka_unknown_topic_dequeue_err

str

Unknown type dropped,enq error analytics queues

kafka_broker_down

str

Messages dropped,analytics down

kafka_queue_full_err

str

Messages dropped,acos analytics queue full

pr_throttle_drop

str

L7 PR dropped,log throttling

pr_not_allowed_drop

str

L7 PR dropped, not allowed to be sent

pr_be_ttfb_anomaly

str

L7 PR back-end ttfb is negative

pr_be_ttlb_anomaly

str

L7 PR back-end ttlb is negative

pr_in_latency_threshold_exceed

str

L7 PR on latency threshold exceeded

pr_out_latency_threshold_exceed

str

L7 PR out latency threshold exceeded

pr_out_latency_anomaly

str

L7 PR out latency negative

pr_in_latency_anomaly

str

L7 PR on latency negative

kafka_topic_error

str

Module not supported by analytics

pc_encoding_failed

str

L4 PC logs dropped,encoding error

pc_acos_harmony_topic

str

L4 PC logs sent

pc_acos_harmony_topic_dequeue_err

str

L4 PC logs dropped,enq error analytics queues

cgn_pc_acos_harmony_topic

str

CGN PC logs sent

cgn_pc_acos_harmony_topic_dequeue_err

str

CGN PC logs dropped,enq error analytics queues

cgn_pe_acos_harmony_topic

str

CGN PE logs sent

cgn_pe_acos_harmony_topic_dequeue_err

str

CGN PE logs dropped,enq error analytics queues

fw_pc_acos_harmony_topic

str

FW PC logs sent

fw_pc_acos_harmony_topic_dequeue_err

str

FW PC logs dropped,enq error analytics queues

fw_deny_pc_acos_harmony_topic

str

FW DENY PC logs sent

fw_deny_pc_acos_harmony_topic_dequeue_err

str

FW DENY PC logs dropped,enq error analytics queues

fw_rst_pc_acos_harmony_topic

str

FW RST PC logs sent

fw_rst_pc_acos_harmony_topic_dequeue_err

str

FW RST PC logs dropped,enq error analytics queues

cgn_summary_error_acos_harmony_topic

str

CGN PE logs sent

cgn_summary_error_acos_harmony_topic_dequeue_err

str

CGN PE logs dropped,enq error analytics queues

rule_set_application_metrics_topic

str

AppFW metrics sent

rule_set_application_metrics_topic_dequeue_err

str

AppFW metrics dropped,enq error analytics queues

slb_ssl_stats_metrics_topic

str

SSL metrics sent

slb_ssl_stats_metrics_topic_dequeue_err

str

SSL metrics dropped,enq error analytics queues

slb_client_ssl_counters_metrics_topic

str

Client SSL metrics sent

slb_client_ssl_counters_metrics_topic_dequeue_err

str

Cilent SSL metrics dropped,enq error analytics qs

slb_server_ssl_counters_metrics_topic

str

Server SSL metrics sent

slb_server_ssl_counters_metrics_topic_dequeue_err

str

Server SSL metrics dropped,enq error analytics qs

pc_throttle_drop

str

L4 PC logs dropped,throttling

metrics_dropped_pt_missing

str

Metrics dropped,missing partition tenant mapping

ssli_pc_acos_harmony_topic

str

SSLi PC topic counter from acos to harmony

ssli_pc_acos_harmony_topic_dequeue_err

str

SSLi PC topic to harmony dequeue error

ssli_pe_acos_harmony_topic

str

SSLi PE topic counter from acos to harmony

ssli_pe_acos_harmony_topic_dequeue_err

str

SSLi PE topic to harmony dequeue error

analytics_bus_restart

str

Analytics bus restart count

waf_learn_pr_topic

str

WAF learn topic counter

waf_learn_pr_topic_dequeue_err

str

WAF learn metrics dropped,enq error analytics qs

waf_events_topic

str

WAF events topic counter

waf_events_topic_dequeue_err

str

WAF events metrics dropped,enq error analytics qs

visibility_topn_harmony_topic

str

Visibility TopN sent

visibility_topn_harmony_topic_dequeue_err

str

Visibility TopN metrics dropped,enq error analytics qs

hc_logs_sent_to_master

str

HC logs sent to master

hc_logs_received_from_blade

str

HC logs received from blade

hc_oper_sent_to_master

str

HC oper to master

hc_oper_received_from_blade

str

HC oper received from blade

hc_counters_sent_to_master

str

HC counters sent to master

hc_counters_received_from_blade

str

HC counters received from blade

hc_counters_dropped_from_blade

str

HC counters dropped from blade (uuid or size mismatch)

pe_acos_harmony_topic

str

L7 PE logs sent

pe_acos_harmony_topic_enqueue_err

str

L7 PE dropped,enq error on acos queues

pe_acos_harmony_topic_dequeue_err

str

L7 PE dropped,enq error analytics queues

vpn_ipsec_sa_metrics_topic

str

IPSec SA metrics sent

vpn_ipsec_sa_metrics_topic_dequeue_err

str

IPSec SA metrics dropped,enq error analytics qs

vpn_ike_gateway_metrics_topic

str

IKE gateway metrics sent

vpn_ike_gateway_metrics_topic_dequeue_err

str

IKE gateway metrics dropped,enq error analytics qs

vpn_stats_metrics_topic

str

VPN STATS metrics sent

vpn_stats_metrics_topic_dequeue_err

str

VPN STATS metrics dropped,enq error analytics qs

cgn_port_usage_hstgrm_acos_harmony_topic

str

CGN Port Usage Histogram HC Export

cgn_port_usage_hstgrm_acos_harmony_topic_dequeue_err

str

CGN Port Usage Histogram HC Export Failed

avro_system_env_topic

str

System environment sent

avro_system_env_dequeue_err

str

System Environmet dropped,enq error analytics queues

cert_pinning_list_topic

str

Cert-pinning candidate list sent

cert_pinning_list_topic_dequeue_err

str

Cert-pinning candidate list dropped,enq error analytics queues

ngwaf_hc_ep_topic

str

NGWAF HC PE export

ngwaf_hc_ep_topic_dequeue_err

str

NGWAF HC PE export failed

ngwaf_hc_metrics_topic

str

NGWAF HC metrics export

ngwaf_hc_metrics_topic_dequeue_err

str

NGWAF HC metrics export failed

Examples


Return Values

modified_values (changed, dict, )

Values modified (or potential changes if using check_mode) as a result of task operation

axapi_calls (always, list, )

Sequential list of AXAPI calls made by the task

endpoint (, str, [‘/axapi/v3/slb/virtual_server’, ‘/axapi/v3/file/ssl-cert’])

The AXAPI endpoint being accessed.

http_method (, str, [‘POST’, ‘GET’])

HTTP method being used by the primary task to interact with the AXAPI endpoint.

request_body (, complex, )

Params used to query the AXAPI

response_body (, complex, )

Response from the AXAPI

Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]

  • This module is maintained by community.

Authors

  • A10 Networks