cgnv6 template logging

Logging Template

logging Specification

   
Type Collection
Object Key(s) name
Collection Name logging-list
Collection URI /axapi/v3/cgnv6/template/logging
Element Name logging
Element URI /axapi/v3/cgnv6/template/logging/{name}
Element Attributes logging_attributes
Schema logging schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/cgnv6/template/logging

logging attributes

Create List

POST

/axapi/v3/cgnv6/template/logging

logging attributes

Get Object

GET

/axapi/v3/cgnv6/template/logging/{name}

logging attributes

Get List

GET

/axapi/v3/cgnv6/template/logging

logging-list

Modify Object

POST

/axapi/v3/cgnv6/template/logging/{name}

logging attributes

Replace Object

PUT

/axapi/v3/cgnv6/template/logging/{name}

logging attributes

Replace List

PUT

/axapi/v3/cgnv6/template/logging

logging-list

Delete Object

DELETE

/axapi/v3/cgnv6/template/logging/{name}

logging attributes

logging-list

logging-list is JSON List of logging attributes

logging-list : [

logging attributes

batched-logging-disable

Description Disable multiple logs per packet

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

custom

Description: custom is a JSON Block. Please see below for custom

Type: Object

facility

Description ‘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;

Type: string

Supported Values: kernel, user, mail, daemon, security-authorization, syslog, line-printer, news, uucp, cron, security-authorization-private, ftp, ntp, audit, alert, clock, local0, local1, local2, local3, local4, local5, local6, local7

Default: local0

format

Description ‘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;

Type: string

Supported Values: binary, compact, custom, default, rfc5424

Default: default

include-destination

Description Include the destination IP and port in logs

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

include-http

Description: include-http is a JSON Block. Please see below for include-http

Type: Object

include-inside-user-mac

Description Include the inside user MAC address in logs

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

include-partition-name

Description Include partition name in logging events

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

include-radius-attribute

Description: include-radius-attribute is a JSON Block. Please see below for include-radius-attribute

Type: Object

log

Description: log is a JSON Block. Please see below for log

Type: Object

log-receiver

Description: log-receiver is a JSON Block. Please see below for log-receiver

Type: Object

name

Description Logging template name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

resolution

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

Type: string

Supported Values: seconds, 10-milliseconds

Default: seconds

rfc-custom

Description: rfc-custom is a JSON Block. Please see below for rfc-custom

Type: Object

rule

Description: rule is a JSON Block. Please see below for rule

Type: Object

service-group

Description Set NAT logging service-group

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

severity

Description: severity is a JSON Block. Please see below for severity

Type: Object

shared

Description Service group is in shared patition

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

source-address

Description: source-address is a JSON Block. Please see below for source-address

Type: Object

source-port

Description: source-port is a JSON Block. Please see below for source-port

Type: Object

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

include-http

Specification  
Type object

header-cfg

Type: List

l4-session-info

Description Log the L4 session information of the HTTP request

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

method

Description Log the HTTP Request Method

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

request-number

Description HTTP Request Number

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

include-http_header-cfg

Specification  
Type list
Block object keys  

custom-header-name

Description Header name

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

custom-max-length

Description Max length for a HTTP request log (Max header length (Default: 100 char))

Type: number

Range: 100-1000

Default: 100

http-header

Description ‘cookie’: Log HTTP Cookie Header; ‘referer’: Log HTTP Referer Header; ‘user-agent’: Log HTTP User-Agent Header; ‘header1’: Log HTTP Header 1; ‘header2’: Log HTTP Header 2; ‘header3’: Log HTTP Header 3;

Type: string

Supported Values: cookie, referer, user-agent, header1, header2, header3

max-length

Description Max length for a HTTP request log (Max header length (Default: 100 char))

Type: number

Range: 100-1000

Default: 100

severity

Specification  
Type object

severity-string

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

Type: string

Supported Values: emergency, alert, critical, error, warning, notice, informational, debug

Default: debug

Mutual Exclusion: severity-string and severity-val are mutually exclusive

severity-val

Description Logging severity level

Type: number

Range: 0-7

Default: 7

Mutual Exclusion: severity-val and severity-string are mutually exclusive

custom

Specification  
Type object

custom-header

Description ‘use-syslog-header’: Use syslog header as custom log header;

Type: string

Supported Values: use-syslog-header

custom-message

Description: custom-message is a JSON Block. Please see below for custom_custom-message

Type: Object

custom-time-stamp-format

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

Type: string

Format: string-rlx

Maximum Length: 31 characters

Maximum Length: 1 characters

custom_custom-message

Specification  
Type object

custom-fixed-nat-allocated

Description Fixed-NAT allocated (Custom message string)

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

custom-fixed-nat-freed

Description Fixed-NAT freed (Custom message string)

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

custom-http-request-got

Description HTTP request got (Custom message string)

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

custom-port-allocated

Description Port allocated (Custom message string)

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

custom-port-batch-allocated

Description Port Batch allocated (Custom message string)

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

custom-port-batch-freed

Description Port Batch freed (Custom message string)

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

custom-port-freed

Description Port freed (Custom message string)

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

custom-session-created

Description Session created (Custom message string)

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

custom-session-deleted

Description Session deleted (Custom message string)

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

source-address

Specification  
Type object

ip

Description Specify source IP address

Type: string

Format: ipv4-address

ipv6

Description Specify source IPv6 address

Type: string

Format: ipv6-address

log

Specification  
Type object

fixed-nat

Description: fixed-nat is a JSON Block. Please see below for log_fixed-nat

Type: Object

http-requests

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

Type: string

Supported Values: host, url

port-mappings

Description ‘creation’: Log only creation of NAT mappgins; ‘disable’: Disable Log creation and deletion of NAT mappings;

Type: string

Supported Values: creation, disable

port-overloading

Description Force logging of all port-overloading sessions

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sessions

Description Log all data sessions created using NAT

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

log_fixed-nat

Specification  
Type object

fixed-nat-http-requests

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

Type: string

Supported Values: host, url

fixed-nat-port-mappings

Description ‘both’: Log creation and deletion of NAT mappings; ‘creation’: Log creation of NAT mappings;

Type: string

Supported Values: both, creation

fixed-nat-sessions

Description Log all Fixed NAT sessions

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

user-ports

Description: user-ports is a JSON Block. Please see below for log_fixed-nat_user-ports

Type: Object

log_fixed-nat_user-ports

Specification  
Type object

days

Description Specify period in days

Type: number

Range: 1-30

start-time

Description Time when periodic logging starts (Specify start time(hh:mm))

Type: string

Format: time-hhmm

user-ports

Description Log Fixed NAT User Ports Configured

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

source-port

Specification  
Type object

any

Description Use any source port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: any and source-port-num are mutually exclusive

source-port-num

Description Set source port for sending NAT syslogs (default: 514)

Type: number

Range: 1-65535

Default: 514

Mutual Exclusion: source-port-num and any are mutually exclusive

log-receiver

Specification  
Type object

encrypted

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

radius

Description Use RADIUS server for NAT logging

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

secret-string

Description The RADIUS server’s secret

Type: string

Format: password

Maximum Length: 127 characters

Maximum Length: 1 characters

include-radius-attribute

Specification  
Type object

attr-cfg

Type: List

include-radius-attribute_attr-cfg

Specification  
Type list
Block object keys  

attr

Description ‘imei’: Include IMEI; ‘imsi’: Include IMSI; ‘msisdn’: Include MSISDN; ‘custom1’: Customized attribute 1; ‘custom2’: Customized attribute 2; ‘custom3’: Customized attribute 3;

Type: string

Supported Values: imei, imsi, msisdn, custom1, custom2, custom3

attr-event

Description ‘http-requests’: Include in HTTP request logs; ‘port-mappings’: Include in port-mapping logs; ‘sessions’: Include in session logs;

Type: string

Supported Values: http-requests, port-mappings, sessions

rule

Specification  
Type object

rule-http-requests

Description: rule-http-requests is a JSON Block. Please see below for rule_rule-http-requests

Type: Object

rule_rule-http-requests

Specification  
Type object

dest-port

Type: List

log-every-http-request

Description Log every HTTP request in an HTTP 1.1 session (Default: Log the first HTTP request in a session)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

max-url-len

Description Max length of URL log (Max URL length (Default: 100 char))

Type: number

Range: 100-1000

Default: 100

rule_rule-http-requests_dest-port

Specification  
Type list
Block object keys  

dest-port-number

Description

Type: number

Range: 1-65535

include-byte-count

Description Include the byte count of HTTP Request/Response in CGN session deletion logs

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

rfc-custom

Specification  
Type object

header

Description: header is a JSON Block. Please see below for rfc-custom_header

Type: Object

message

Description: message is a JSON Block. Please see below for rfc-custom_message

Type: Object

rfc-custom_header

Specification  
Type object

use-alternate-timestamp

Description Use alternate non-RFC5424 compliant timestamp. Ex: 1990 Jan 15 12:30:30

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

rfc-custom_message

Specification  
Type object

http-request-got

Description HTTP request got (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

ipv6-tech

Type: List

session-created

Description Session created (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

session-deleted

Description Session deleted (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

rfc-custom_message_ipv6-tech

Specification  
Type list
Block object keys  

fixed-nat-allocated

Description Fixed-NAT allocated (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

fixed-nat-freed

Description Fixed-NAT freed (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

port-allocated

Description Port allocated (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

port-batch-allocated

Description Port Batch allocated (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

port-batch-freed

Description Port Batch freed (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

port-freed

Description Port freed (Custom message string. Should be in the format of “MSGID [STRUCTURED-DATA] MSG”)

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

tech-type

Description ‘lsn’: LSN; ‘nat64’: NAT64; ‘ds-lite’: DS-Lite; ‘sixrd-nat64’: 6rd-NAT64;

Type: string

Supported Values: lsn, nat64, ds-lite, sixrd-nat64