a10_acos_events_local_logging
Synopsis
Configure local logging/persistant storage of FW logs
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 |
||
enable bool |
Enable local-logging when FW log servers are down (Default= Not enabled) |
||
rate_limit int |
Configure number of logs per second to be stored in disk (Default= 1000) |
||
max_disk_space int |
Configure Max disk space in MB to be used for storing the logs (Default= 100MB) |
||
delete_old_logs_in_disk bool |
Operational command to delete the old logs stored in disk |
||
uuid str |
uuid of the object |
||
sampling_enable list |
Field sampling_enable |
||
counters1 str |
‘all’= all; ‘init-pass’= Local logging Init Successful; ‘init-fail’= Local logging Init Fail; ‘freed’= Local logging Stopped; ‘disk-over-thres’= Number of logs Dropped, Disk reached threshold; ‘rate-limited’= Number of logs Dropped, Rate limited; ‘not-inited’= Number of logs Dropped, Local logging not inited; ‘sent-to-store’= Number of logs sent to be stored; ‘sent-to-store-fail’= Number of Logs sent to be stored Failed; ‘store-fail’= Number of logs failed to be stored; ‘in-logs’= Number of logs successfully stored; ‘in-bytes’= Number of bytes successfully stored; ‘in-logs-backlog’= Number of backlogs loaded from disk; ‘in-bytes-backlog’= Number of backlog bytes loaded from disk; ‘in-store- fail-no-space’= Number of logs Dropped, failed without disk space; ‘in-discard- logs’= Number of old logs discarded to fit in new logs; ‘in-discard-bytes’= Number of old bytes discarded to fit in new logs; ‘out-logs’= Number of logs sent to log servers; ‘out-bytes’= Number of bytes sent to log-servers; ‘out- error’= Number of errors during send; ‘remaining-logs’= Total number of remaining logs yet to be sent; ‘remaining-bytes’= Total number of remaining bytes yet to be sent; ‘moved-to-delq’= Local Logging moved to delq to be deleted; ‘out-retry’= Number of attempted retries to send logs; ‘out-retry- fail’= Number of retries failed with error; ‘curr-total-chunks’= Current Number of blocks; ‘curr-mem-chunks’= Current blocks in memory; ‘curr-fs-chunks’= Current blocks in file system; ‘curr-fs-chunks-up’= Current blocks in file system loaded in memory; ‘curr-fs-chunks-down’= Current blocks in file system not loaded in memory; ‘in-logs-agg’= Total Aggregate, Number of logs successfully stored; ‘in-bytes-agg’= Total Aggregate, Number of bytes successfully stored; ‘in-logs-backlog-agg’= Total Aggregate, Number of backlogs loaded from disk; ‘in-bytes-backlog-agg’= Total Aggregate, Number of backlog bytes loaded from disk; ‘in-store-fail-no-space-agg’= Total Aggregate, Number of logs Dropped, failed without disk space; ‘in-discard-logs-agg’= Total Aggregate, Number of old logs discarded to fit in new logs; ‘in-discard-bytes- agg’= Total Aggregate, Number of old bytes discarded to fit in new logs; ‘out- logs-agg’= Total Aggregate, Number of logs sent to log servers; ‘out-bytes- agg’= Total Aggregate, Number of bytes sent to log-servers; ‘out-error-agg’= Total Aggregate, Number of errors during send; ‘out-retry-agg’= Total Aggregate, Number of attempted retries to send logs; ‘out-retry-fail-agg’= Total Aggregate, Number of retries failed with error; ‘in-logs-curr-agg’= Current Aggregate, Number of logs successfully stored; ‘in-bytes-curr-agg’= Current Aggregate, Number of bytes successfully stored; ‘in-logs-backlog-curr- agg’= Current Aggregate, Number of backlogs loaded from disk; ‘in-bytes- backlog-curr-agg’= Current Aggregate, Number of backlog bytes loaded from disk; ‘in-discard-logs-curr-agg’= Current Aggregate, Number of old logs discarded to fit in new logs; ‘in-discard-bytes-curr-agg’= Current Aggregate, Number of old bytes discarded to fit in new logs; ‘out-logs-curr-agg’= Current Aggregate, Number of logs sent to log servers; ‘out-bytes-curr-agg’= Current Aggregate, Number of bytes sent to log-servers; |
||
stats dict |
Field stats |
||
init_pass str |
Local logging Init Successful |
||
init_fail str |
Local logging Init Fail |
||
freed str |
Local logging Stopped |
||
disk_over_thres str |
Number of logs Dropped, Disk reached threshold |
||
rate_limited str |
Number of logs Dropped, Rate limited |
||
not_inited str |
Number of logs Dropped, Local logging not inited |
||
sent_to_store str |
Number of logs sent to be stored |
||
sent_to_store_fail str |
Number of Logs sent to be stored Failed |
||
store_fail str |
Number of logs failed to be stored |
||
in_logs str |
Number of logs successfully stored |
||
in_bytes str |
Number of bytes successfully stored |
||
in_logs_backlog str |
Number of backlogs loaded from disk |
||
in_bytes_backlog str |
Number of backlog bytes loaded from disk |
||
in_store_fail_no_space str |
Number of logs Dropped, failed without disk space |
||
in_discard_logs str |
Number of old logs discarded to fit in new logs |
||
in_discard_bytes str |
Number of old bytes discarded to fit in new logs |
||
out_logs str |
Number of logs sent to log servers |
||
out_bytes str |
Number of bytes sent to log-servers |
||
out_error str |
Number of errors during send |
||
remaining_logs str |
Total number of remaining logs yet to be sent |
||
remaining_bytes str |
Total number of remaining bytes yet to be sent |
||
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.