a10_cgnv6_template_logging

Synopsis

Logging Template

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

name

str/required

Logging template name

resolution

str

‘seconds’= Logging timestamp resolution in seconds (default); ‘10-milliseconds’= Logging timestamp resolution in 10s of milli-seconds;

log

dict

Field log

fixed_nat

dict

Field fixed_nat

map_dhcpv6

dict

Field map_dhcpv6

http_requests

str

‘host’= Log the HTTP Host Header; ‘url’= Log the HTTP Request URL;

port_mappings

str

‘creation’= Log only creation of NAT mappings; ‘disable’= Disable Log creation and deletion of NAT mappings; ‘both’= Log creation and deletion of NAT mappings;

port_overloading

bool

Force logging of all port-overloading sessions

user_data

bool

Log LSN Subscriber Information

sessions

bool

Log all data sessions created using NAT

merged_style

bool

Merge creation and deletion of session logs to one

include_destination

bool

Include the destination IP and port in logs

include_inside_user_mac

bool

Include the inside user MAC address in logs

include_partition_name

bool

Include partition name in logging events

include_session_byte_count

bool

include byte count in session deletion logs

include_port_block_account

bool

include bytes accounting information in port-batch-v2 port-mapping and fixed- nat user-ports messages

include_radius_attribute

dict

Field include_radius_attribute

attr_cfg

list

Field attr_cfg

no_quote

bool

No quotation marks for RADIUS attributes in logs

insert_if_not_existing

bool

Configure what string is to be inserted for custom RADIUS attributes

zero_in_custom_attr

bool

Insert 0000 for standard and custom attributes in log string

framed_ipv6_prefix

bool

Include radius attributes for the prefix

prefix_length

str

‘32’= Prefix length 32; ‘48’= Prefix length 48; ‘64’= Prefix length 64; ‘80’= Prefix length 80; ‘96’= Prefix length 96; ‘112’= Prefix length 112;

include_http

dict

Field include_http

header_cfg

list

Field header_cfg

l4_session_info

bool

Log the L4 session information of the HTTP request

method

bool

Log the HTTP Request Method

request_number

bool

HTTP Request Number

file_extension

bool

HTTP file extension

rule

dict

Field rule

rule_http_requests

dict

Field rule_http_requests

interim_update_interval

int

Log interim update of NAT mappings (Interim update interval in minutes(Interval is floored to a multiple of 5))

facility

str

‘kernel’= 0= Kernel; ‘user’= 1= User-level; ‘mail’= 2= Mail; ‘daemon’= 3= System daemons; ‘security-authorization’= 4= Security/authorization; ‘syslog’= 5= Syslog internal; ‘line-printer’= 6= Line printer; ‘news’= 7= Network news; ‘uucp’= 8= UUCP subsystem; ‘cron’= 9= Time-related; ‘security-authorization- private’= 10= Private security/authorization; ‘ftp’= 11= FTP; ‘ntp’= 12= NTP; ‘audit’= 13= Audit; ‘alert’= 14= Alert; ‘clock’= 15= Clock-related; ‘local0’= 16= Local use 0; ‘local1’= 17= Local use 1; ‘local2’= 18= Local use 2; ‘local3’= 19= Local use 3; ‘local4’= 20= Local use 4; ‘local5’= 21= Local use 5; ‘local6’= 22= Local use 6; ‘local7’= 23= Local use 7;

severity

dict

Field severity

severity_string

str

‘emergency’= 0= Emergency; ‘alert’= 1= Alert; ‘critical’= 2= Critical; ‘error’= 3= Error; ‘warning’= 4= Warning; ‘notice’= 5= Notice; ‘informational’= 6= Informational; ‘debug’= 7= Debug;

severity_val

int

Logging severity level

format

str

‘binary’= Binary logging format; ‘compact’= Compact ASCII logging format (Hex format with compact representation); ‘custom’= Arbitrary custom logging format; ‘default’= Default A10 logging format (ASCII); ‘rfc5424’= RFC5424 compliant logging format; ‘cef’= Common Event Format for logging;

batched_logging_disable

bool

Disable multiple logs per packet

log_receiver

dict

Field log_receiver

radius

bool

Use RADIUS server for NAT logging

secret_string

str

The RADIUS server’s secret

encrypted

str

Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)

service_group

str

Set NAT logging service-group

shared

bool

Service group is in shared patition

source_port

dict

Field source_port

source_port_num

int

Set source port for sending NAT syslogs (default= 514)

any

bool

Use any source port

rfc_custom

dict

Field rfc_custom

header

dict

Field header

message

dict

Field message

custom

dict

Field custom

custom_header

str

‘use-syslog-header’= Use syslog header as custom log header;

custom_message

dict

Field custom_message

custom_time_stamp_format

str

Customize the time stamp format (Customize the time-stamp format. Default=%Y%m%d%H%M%S)

uuid

str

uuid of the object

user_tag

str

Customized tag

source_address

dict

Field source_address

ip

str

Specify source IP address

ipv6

str

Specify source IPv6 address

uuid

str

uuid of the object

disable_log_by_destination

dict

Field disable_log_by_destination

tcp_list

list

Field tcp_list

udp_list

list

Field udp_list

icmp

bool

Disable logging for icmp traffic

others

bool

Disable logging for other L4 protocols

uuid

str

uuid of the object

ip_list

list

Field ip_list

ip6_list

list

Field ip6_list

Status

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

  • This module is maintained by community.

Authors

  • A10 Networks 2021