a10_visibility_packet_capture

Synopsis 

Configure automated packet capture

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
uuid str			uuid of the object
capture_config_list list			Field capture_config_list
	name str		Specify the name of the capture-config
	disable bool		Disable packet capture (default enabled)
	concurrent_captures int		Enable and specify maximum concurrent 3 tuple filter based captures in seperate pcaps.
	concurrent_conn_per_capture int		Specify maximum number of concurrent connnections(5 tuple matches) to be captured within in a 3 tuple based capture. (default 1
	concurrent_captures_age int		Specify the time in minutes upto which a 3 tuple filter based capture will be kept active(default 1)
	concurrent_conn_tag int		Enable and specify maximum concurrent connnections(only 5 tuple based) to be captured in common pcaps.
	number_of_packets_per_conn int		Specify maximum number of packets to be captured in a 5 tuple based connection (default 0 unlimited).
	packet_length int		Packet length in Bytes to capture (Default 128)
	file_size int		Specify pcapng filesize in MB, Will be distributed per CPU (default 1)
	file_count int		Specify the number of continuous pcapng files that can be created for capturing packets (default 10)
	number_of_packets_per_capture int		Specify Maximum number of packets per global or dynamic capture (default 0 unlimited)
	number_of_packets_total int		Specify Maximum number of packets for all captures (default 0 unlimited)
	enable_continuous_global_capture bool		Enable continuous capture of packets for the global capture(non 3 tuple based capture) overriding size limits
	create_pcap_files_now bool		Operational command to force create temporary pcapng files before completion (for global/non 3 tuple based captures)
	disable_auto_merge bool		Disable auto merging per CPU pcapng files(default enabled)
	keep_pcap_files_after_merge bool		Keep original per CPU pcapng files after auto merging pcapng files(default disabled)
	uuid str		uuid of the object
	user_tag str		Customized tag
delete_packet_capture_file dict			Field delete_packet_capture_file
	file_name str		Specify the name of the packet capture file to be deleted
	all bool		Delete all files in this partition
global_templates dict			Field global_templates
	uuid str		uuid of the object
	template_list list		Field template_list
	activate dict		Field activate
object_templates dict			Field object_templates
	uuid str		uuid of the object
	templ_gtp_plcy_tmpl_list list		Field templ_gtp_plcy_tmpl_list
	interface_ethernet_tmpl_list list		Field interface_ethernet_tmpl_list
	interface_tunnel_tmpl_list list		Field interface_tunnel_tmpl_list
	aam_jwt_authorization_tmpl_list list		Field aam_jwt_authorization_tmpl_list
	aam_aaa_policy_tmpl_list list		Field aam_aaa_policy_tmpl_list
	aam_auth_logon_http_ins_tmpl_list list		Field aam_auth_logon_http_ins_tmpl_list
	aam_auth_server_ldap_inst_tmpl_list list		Field aam_auth_server_ldap_inst_tmpl_list
	aam_auth_server_ocsp_inst_tmpl_list list		Field aam_auth_server_ocsp_inst_tmpl_list
	aam_auth_server_rad_inst_tmpl_list list		Field aam_auth_server_rad_inst_tmpl_list
	aam_auth_server_win_inst_tmpl_list list		Field aam_auth_server_win_inst_tmpl_list
	aam_auth_saml_service_prov_tmpl_list list		Field aam_auth_saml_service_prov_tmpl_list
	aam_auth_saml_id_prov_tmpl_list list		Field aam_auth_saml_id_prov_tmpl_list
	aam_auth_service_group_tmpl_list list		Field aam_auth_service_group_tmpl_list
	aam_auth_service_group_mem_tmpl_list list		Field aam_auth_service_group_mem_tmpl_list
	aam_auth_relay_hbase_inst_tmpl_list list		Field aam_auth_relay_hbase_inst_tmpl_list
	aam_auth_relay_form_inst_tmpl_list list		Field aam_auth_relay_form_inst_tmpl_list
	aam_auth_relay_ntlm_tmpl_list list		Field aam_auth_relay_ntlm_tmpl_list
	aam_auth_relay_ws_fed_tmpl_list list		Field aam_auth_relay_ws_fed_tmpl_list
	aam_auth_captcha_inst_tmpl_list list		Field aam_auth_captcha_inst_tmpl_list
	slb_templ_cache_tmpl_list list		Field slb_templ_cache_tmpl_list
	slb_port_tmpl_list list		Field slb_port_tmpl_list
	slb_vport_tmpl_list list		Field slb_vport_tmpl_list
	cgnv6_serv_group_tmpl_list list		Field cgnv6_serv_group_tmpl_list
	cgnv6_dns64_vs_port_tmpl_list list		Field cgnv6_dns64_vs_port_tmpl_list
	cgnv6_map_trans_domain_tmpl_list list		Field cgnv6_map_trans_domain_tmpl_list
	cgnv6_encap_domain_tmpl_list list		Field cgnv6_encap_domain_tmpl_list
	netflow_monitor_tmpl_list list		Field netflow_monitor_tmpl_list
	rule_set_tmpl_list list		Field rule_set_tmpl_list
	fw_server_port_tmpl_list list		Field fw_server_port_tmpl_list
	fw_service_group_tmpl_list list		Field fw_service_group_tmpl_list
	fw_service_group_mem_tmpl_list list		Field fw_service_group_mem_tmpl_list
	dns_vport_tmpl_list list		Field dns_vport_tmpl_list
	smtp_vport_tmpl_list list		Field smtp_vport_tmpl_list
	pop3_vport_tmpl_list list		Field pop3_vport_tmpl_list
	imap_vport_tmpl_list list		Field imap_vport_tmpl_list
automated_captures dict			Field automated_captures
	slb_port_tmpl_error_code_return_inc bool		Trigger capture when there is 3xx or 4xx or 5xx responses from server
	slb_port_tmpl_high_error_code_return bool		Trigger capture when there is high number of 3xx or 4xx or 5xx responses from server
	uuid str		uuid of the object
oper dict			Field oper
	packet_capture_files bool		Field packet_capture_files
	memory_usage bool		Field memory_usage
	total_number_of_files int		Field total_number_of_files
	packet_capture_file_name_list list		Field packet_capture_file_name_list
	total_memory str		Field total_memory
	used_memory str		Field used_memory
	automated_captures dict		Field automated_captures
stats dict			Field stats
	Concurrent_capture_created_by_ctr_increment str		Dynamic 3 tuple based capture created (ctr increment based)
	Concurrent_capture_created_by_ctr_anomaly str		Dynamic 3 tuple based capture created (ctr anomaly based)
	Concurrent_capture_created_by_other_feature str		Dynamic 3 tuple based capture created (Other feature based)
	Concurrent_capture_create_failed_by_ctr_increment str		Error, Dynamic Capture(ctr increment based) create failed
	Concurrent_capture_create_failed_by_ctr_anomaly str		Error, Dynamic Capture(ctr anomaly based) create failed
	Concurrent_capture_create_failed_by_other_feature str		Error, Dynamic Capture(Other feature based) create failed
	Concurrent_capture_create_failed_oom str		Error, Dynamic Capture create failed, OOM
	Concurrent_capture_limit_reached str		Dynamic Capture configured concurrent limit reached
	Concurrent_capture_by_ctr_increment_freed str		Dynamic Capture(ctr increment based) freed
	Concurrent_capture_by_ctr_anomaly_freed str		Dynamic Capture(ctr anomaly based) freed
	Concurrent_capture_by_ctr_other_feature_freed str		Dynamic Capture(Other feature based) freed
	Global_capture_finished str		Number of times global capture finished capturing
	Concurrent_capture_finished str		Number of Dynamic captures(3 tuple based) finished capturing
	pktcapture_with_no_conn_success str		Capture success, Packets without conn
	pktcapture_with_no_conn_failure str		Capture fail, Packets without conn
	pktcapture_with_conn_but_not_tagged_success str		Capture success, Packets with untagged conn
	pktcapture_with_conn_but_not_tagged_failure str		Capture fail, Packets with untagged conn
	pktcapture_with_conn_success_global str		Capture success, Packets with tagged conn (global capture)
	pktcapture_with_conn_success str		Capture success, Packets with tagged conn (dynamic capture)
	pktcapture_with_conn_failure_global str		Capture fail, Packets with tagged conn (global capture)
	pktcapture_with_conn_failure str		Capture fail, Packets with tagged conn (dynamic capture)
	pktcapture_failure_wait_for_block str		Capture fail, waiting to get free buffer
	pktcapture_failure_file_size_rchd str		Capture fail, file size reached
	num_conns_tagged_global_increment str		Conn tag success (based on ctr increment, Global)
	num_conns_tagged_global_anomaly str		Conn tag success (based on ctr anomaly, Global)
	num_conns_tagged_global_other_feature str		Conn tag success (based on Other feature, Global)
	num_conns_tagged_global_increment_fail str		Conn tag fail (based on ctr increment, Global)
	num_conns_tagged_global_anomaly_fail str		Conn tag fail (based on ctr anomaly, Global)
	num_conns_tagged_global_other_feature_fail str		Conn tag fail (based on Other feature, Global)
	num_conns_tagged_global_increment_maxed str		Conn tag fail, reached limit (based on ctr increment, Global)
	num_conns_tagged_global_anomaly_maxed str		Conn tag fail, reached limit (based on ctr anomaly, Global)
	num_conns_tagged_global_other_feature_maxed str		Conn tag fail, reached limit (based on Other feature, Global)
	num_conns_tagged_increment str		Conn tag success (based on ctr increment, dynamic)
	num_conns_tagged_anomaly str		Conn tag success (based on ctr anomaly, dynamic)
	num_conns_tagged_other_feature str		Conn tag success (based on Other feature, dynamic)
	num_conns_tagged_increment_fail str		Conn tag fail (based on ctr increment, dynamic)
	num_conns_tagged_anomaly_fail str		Conn tag fail (based on ctr anomaly, dynamic)
	num_conns_tagged_other_feature_fail str		Conn tag fail (based on Other feature, dynamic)
	num_conns_tagged_increment_maxed str		Conn tag fail, reached limit (based on ctr increment, dynamic)
	num_conns_tagged_anomaly_maxed str		Conn tag fail, reached limit (based on ctr anomaly, dynamic)
	num_conns_tagged_other_feature_maxed str		Conn tag fail, reached limit (based on Other feature, dynamic)
	num_conns_untagged str		Number of conns untagged (done with conn limit or capture)
	pktcapture_triggered_by_increment str		Capture triggered by counter increment
	pktcapture_triggered_by_anomaly str		Capture triggered by counter anomaly
	pktcapture_triggered_by_other_feature str		Capture triggered by Other feature
	num_of_anomalies_detected str		Number of times ctr Anomaly detected
	num_of_anomalies_cleared str		Number of times ctr Anomaly cleared
	num_pcaps_created str		Number of pcapng files created
	num_tmp_pcaps_created str		Number of temporary pcapng files created
	num_pcaps_create_failed str		Error, Number of pcapng files creation failed
	pktcap_oom str		Error, Automated Packet capture infra OOM
	failed_disk_full str		Error, Capture fail, Disk limit reached
	conn_ext_failed str		Error, Conn extension creation fail
	skip_as_conn_already_recapture str		Skip creating capture, conn was already captured
	skip_capture_as_conn_created_before_smp str		Skip capturing, conn was created before the capture started
	failed_as_return_completed_set str		Skip capturing, capture-config marked completed
	non_pkt_path str		Skip capturing, not packet processing path
	pkt_already_captured str		Skip capturing, packet already captured
	wrong_ctr_incremented str		Counter increment issue
	auto_pcap_file_merged str		Auto pcapng files merged
	auto_pcap_file_merged_failed str		Auto pcapng files merged failed
	num_global_tmpl_created str		Number of global templates created
	num_object_tmpl_created str		Number of object templates created
	num_global_tmpl_deleted str		Number of global templates deleted
	num_object_tmpl_deleted str		Number of object templates deleted
	num_capture_config_created str		Number of capture-config created
	num_dynamic_capture_config_created str		Number of dynamic capture-config created
	num_capture_config_deleted str		Number of capture-config deleted
	num_dynamic_capture_config_deleted str		Number of dynamic capture-config deleted
	num_capture_config_delete_q str		Number of capture-config set for deletion
	num_dynamic_capture_config_delete_q str		Number of dynamic capture-config set for deletion
	num_capture_config_linked str		Number of times capture-config linked to template
	num_dynamic_capture_config_linked str		Number of times dynamic capture-config linked to template
	num_capture_config_unlinked str		Number of times capture-config unlinked from template
	num_dynamic_capture_config_unlinked str		Number of times dynamic capture-config unlinked from template
	num_global_counters_registered str		Number of global objects registered
	num_global_counters_deregistered str		Number of global objects deregistered
	num_per_object_counters_registered str		Number of per instance objects registered
	num_per_object_counters_deregistered str		Number of per instance objects deregistered
	capture_config_list list		Field capture_config_list
	automated_captures dict		Field automated_captures

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