a10_visibility

Synopsis

Display Network statistics

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

granularity

int

Granularity for rate based calculations in seconds (default 5)

initial_learning_interval

int

Initial learning interval (in hours) before processing

source_entity_topk

bool

Enable monitoring entity topk for sources

uuid

str

uuid of the object

sampling_enable

list

Field sampling_enable

counters1

str

‘all’= all; ‘mon-entity-limit-exceed’= Total monitor entity limit exceed failures; ‘ha-entity-create-sent’= Total montior entity HA create messages sent; ‘ha-entity-delete-sent’= Total montior entity HA delete messages sent; ‘ha-entity-anomaly-on-sent’= Total anomaly on HA messages sent; ‘ha-entity- anomaly-off-sent’= Total anomaly off HA messages sent; ‘ha-entity-periodic- sync-sent’= Total monitor entity periodic sync messages sent; ‘out-of-memory- alloc-failures’= Out of memory allocation failures; ‘lw-mon-entity-created’= Total Light-weight entities created; ‘lw-mon-entity-deleted’= Total Light- weight entities deleted; ‘lw-mon-entity-limit-exceed’= Light weight limit exceeded errors; ‘lw-out-of-memory-alloc-failures’= Light Weight Out-of-memory allocation failures; ‘mon-entity-rrd-file-timestamp-err’= Total monitor entity rrd file timestamp errors; ‘mon-entity-rrd-update-err’= Total monitor entity rrd update error; ‘mon-entity-rrd-last-update-fetch-failed-err’= Total monitor entity rrd last update fetch failed error; ‘mon-entity-rrd-tune-err’= Total monitor entity rrd tune error; ‘mon-entity-rrd-out-of-memory-err’= Total monitor entity rrd load failed, out of memory error; ‘mon-entity-rrd-file- create-err’= Total monitor entity rrd file create error;

mon_entity_telemetry_data

dict

Field mon_entity_telemetry_data

uuid

str

uuid of the object

sampling_enable

list

Field sampling_enable

debug_files

dict

Field debug_files

uuid

str

uuid of the object

mon_topk

dict

Field mon_topk

sources

dict

Field sources

monitored_entity

dict

Field monitored_entity

uuid

str

uuid of the object

detail

dict

Field detail

sessions

dict

Field sessions

mon_topk

dict

Field mon_topk

secondary

dict

Field secondary

file

dict

Field file

metrics

dict

Field metrics

reporting

dict

Field reporting

session_logging

str

‘enable’= Enable session logging; ‘disable’= Disable session logging(default);

uuid

str

uuid of the object

sampling_enable

list

Field sampling_enable

telemetry_export_interval

dict

Field telemetry_export_interval

template

dict

Field template

monitor

dict

Field monitor

primary_monitor

str

‘traffic’= Mointor traffic; ‘xflow’= Monitor xflow samples;

monitor_key

str

‘source’= Monitor traffic from all sources; ‘dest’= Monitor traffic to any destination; ‘service’= Monitor traffic to any service; ‘source-nat-ip’= Monitor traffic to all source nat IPs;

mon_entity_topk

bool

Enable topk for primary entities

source_entity_topk

bool

Enable topk for sources to primary-entities

index_sessions

bool

Start indexing associated sessions

index_sessions_type

str

‘per-cpu’= Use per cpu list;

template

dict

Field template

uuid

str

uuid of the object

agent_list

list

Field agent_list

sflow

dict

Field sflow

netflow

dict

Field netflow

debug_list

list

Field debug_list

replay_debug_file

dict

Field replay_debug_file

delete_debug_file

dict

Field delete_debug_file

secondary_monitor

dict

Field secondary_monitor

anomaly_detection

dict

Field anomaly_detection

sensitivity

str

‘high’= Highly sensitive anomaly detection. Can lead to false positives; ‘low’= Low sensitivity anomaly detection. Can cause delay in detection and might not detect certain attacks. (default);

restart_learning_on_anomaly

bool

Relearn anomaly detection parameters after detecting an anomaly

feature_status

str

‘enable’= Enable anomaly-detection (Not valid for source-nat-ip and source monitor types); ‘disable’= Disable anomaly detection (default);

logging

str

‘per-entity’= Enable per entity logging; ‘per-metric’= Enable per metric logging with threshold details; ‘disable’= Disable anomaly notifications (Default);

uuid

str

uuid of the object

flow_collector

dict

Field flow_collector

sflow

dict

Field sflow

netflow

dict

Field netflow

resource_usage

dict

Field resource_usage

uuid

str

uuid of the object

port_scan_detection

dict

Field port_scan_detection

events

int

Number of scanned port events (default 10)

interval

int

Time interval for port scan detection (default 60)

v4_list

str

Class list of ipv4 addresses to be whitelisted

v6_list

str

Class list of ipv6 addresses to be whitelisted

uuid

str

uuid of the object

ping_sweep_detection

dict

Field ping_sweep_detection

events

int

Number of scanned ip events (default 10)

interval

int

Time interval for ip sweep detection (default 60)

v4_list

str

Class list of ipv4 addresses to be whitelisted

v6_list

str

Class list of ipv6 addresses to be whitelisted

uuid

str

uuid of the object

zbar

dict

Field zbar

action

str

‘enable’= Enable zbar infra; ‘disable’= Disable zbar infra(default);

uuid

str

uuid of the object

dest

dict

Field dest

truples

dict

Field truples

topn

dict

Field topn

uuid

str

uuid of the object

sampling_enable

list

Field sampling_enable

cgnv6_nat_pool_topn_tmpl_list

list

Field cgnv6_nat_pool_topn_tmpl_list

cgnv6_nat_pool_topn_node

dict

Field cgnv6_nat_pool_topn_node

gtp_apn_prefix_topn_tmpl_list

list

Field gtp_apn_prefix_topn_tmpl_list

gtp_apn_prefix_topn_node

dict

Field gtp_apn_prefix_topn_node

gtp_network_element_topn_tmpl_list

list

Field gtp_network_element_topn_tmpl_list

gtp_network_element_topn_node

dict

Field gtp_network_element_topn_node

packet_capture

dict

Field packet_capture

uuid

str

uuid of the object

capture_config_list

list

Field capture_config_list

delete_packet_capture_file

dict

Field delete_packet_capture_file

global_templates

dict

Field global_templates

object_templates

dict

Field object_templates

automated_captures

dict

Field automated_captures

stats

dict

Field stats

mon_entity_limit_exceed

str

Total monitor entity limit exceed failures

ha_entity_create_sent

str

Total montior entity HA create messages sent

ha_entity_delete_sent

str

Total montior entity HA delete messages sent

ha_entity_anomaly_on_sent

str

Total anomaly on HA messages sent

ha_entity_anomaly_off_sent

str

Total anomaly off HA messages sent

ha_entity_periodic_sync_sent

str

Total monitor entity periodic sync messages sent

out_of_memory_alloc_failures

str

Out of memory allocation failures

lw_mon_entity_created

str

Total Light-weight entities created

lw_mon_entity_deleted

str

Total Light-weight entities deleted

lw_mon_entity_limit_exceed

str

Light weight limit exceeded errors

lw_out_of_memory_alloc_failures

str

Light Weight Out-of-memory allocation failures

mon_entity_rrd_file_timestamp_err

str

Total monitor entity rrd file timestamp errors

mon_entity_rrd_update_err

str

Total monitor entity rrd update error

mon_entity_rrd_last_update_fetch_failed_err

str

Total monitor entity rrd last update fetch failed error

mon_entity_rrd_tune_err

str

Total monitor entity rrd tune error

mon_entity_rrd_out_of_memory_err

str

Total monitor entity rrd load failed, out of memory error

mon_entity_rrd_file_create_err

str

Total monitor entity rrd file create error

mon_entity_telemetry_data

dict

Field mon_entity_telemetry_data

reporting

dict

Field reporting

topn

dict

Field topn

packet_capture

dict

Field packet_capture

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