fw template logging

Logging Template

logging Specification

Parameter	Value
Type	Collection
Object Key(s)	name
Collection Name	logging-list
Collection URI	/axapi/v3/fw/template/logging
Element Name	logging
Element URI	/axapi/v3/fw/template/logging/{name}
Element Attributes	logging_attributes
Partition Visibility	shared
Schema	logging schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/fw/template/logging	logging attributes	example close
POST /axapi/v3/fw/template/logging/ Payload: { "logging": { "name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/fw/template/logging	logging attributes
Get Object	GET	/axapi/v3/fw/template/logging/{name}	logging attributes	example close
GET /axapi/v3/fw/template/logging/a Reponse: { "logging": { "name": "a", "resolution": "seconds", "include-dest-fqdn": 0, "merged-style": 0, "include-year": 0, "include-radius-attribute": { "no-quote": 0, "framed-ipv6-prefix": 0, "insert-if-not-existing": 0 }, "include-http": { "l4-session-info": 0, "method": 0, "request-number": 0, "file-extension": 0 }, "rule": { "rule-http-requests": { "log-every-http-request": 0, "max-url-len": 128, "include-all-headers": 0, "disable-sequence-check": 0 } }, "facility": "local0", "severity": "informational", "format": "cef", "uuid": "17a219da-5e9b-11d9-84e2-c91372b0d052", "user-tag": "a", "a10-url": "/axapi/v3/fw/template/logging/a" } }
Get List	GET	/axapi/v3/fw/template/logging	logging-list
Modify Object	POST	/axapi/v3/fw/template/logging/{name}	logging attributes
Replace Object	PUT	/axapi/v3/fw/template/logging/{name}	logging attributes	example close
PUT /axapi/v3/fw/template/logging/a Payload: { "logging": { "name": "a", "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/fw/template/logging	logging-list
Delete Object	DELETE	/axapi/v3/fw/template/logging/{name}	logging attributes	example close
DELETE /axapi/v3/fw/template/logging/a Reponse: { "response": { "status": "OK" } }

logging-list

logging-list is JSON List of logging attributes

logging-list : [

{ logging attributes },

{ logging attributes },

…

]

logging attributes

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 ‘ascii’: A10 Text logging format (ASCII); ‘cef’: Common Event Format for logging (default);

Type: string

Supported Values: ascii, cef

Default: cef

include-dest-fqdn

Description Include destination FQDN string

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-radius-attribute

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

Type: Object

include-year

Description include the 4-digit year in logs

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

log

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

Type: Object

merged-style

Description Merge creation and deletion of session logs to one

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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

rule

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

Type: Object

service-group

Description Bind a Service Group to the logging template (Service Group Name)

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/fw/service-group

session-periodic-log

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

Type: Object

Reference Object: /axapi/v3/fw/template/logging/{name}/session-periodic-log

severity

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: informational

source-address

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

Type: Object

Reference Object: /axapi/v3/fw/template/logging/{name}/source-address

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

session-periodic-log

Specification	Value
Type	object

interval

Description Logging time interval (minutes) for long lived sessions

Type: number

Range: 1-60

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

source-address

Specification	Value
Type	object

ip

Description Specify source IP address

Type: string

Format: ipv4-address

ipv6

Description Specify source IPv6 address

Type: string

Format: ipv6-address

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

include-radius-attribute

Specification	Value
Type	object

attr-cfg

Type: List

framed-ipv6-prefix

Description Include radius attributes for the prefix

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

insert-if-not-existing

Description Configure what string is to be inserted for custom RADIUS attributes

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

no-quote

Description No quotation marks for RADIUS attributes in logs

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

prefix-length

Description ‘32’: Prefix length 32; ‘48’: Prefix length 48; ‘64’: Prefix length 64; ‘80’: Prefix length 80; ‘96’: Prefix length 96; ‘112’: Prefix length 112;

Type: string

Supported Values: 32, 48, 64, 80, 96, 112

zero-in-custom-attr

Description Insert 0000 for standard and custom attributes in log string

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

include-radius-attribute_attr-cfg

Specification	Value
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; ‘custom4’: Customized attribute 4; ‘custom5’: Customized attribute 5; ‘custom6’: Customized attribute 6;

Type: string

Supported Values: imei, imsi, msisdn, custom1, custom2, custom3, custom4, custom5, custom6

attr-event

Description ‘http-requests’: Include in HTTP request logs; ‘sessions’: Include in session logs; ‘limit-policy’: Include in limit policy logs;

Type: string

Supported Values: http-requests, sessions, limit-policy

rule

Specification	Value
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	Value
Type	object

dest-port

Type: List

disable-sequence-check

Description Disable http packet sequence check and don’t drop out of order packets

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

include-all-headers

Description Include all configured headers despite of absence in HTTP request

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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: 128 char))

Type: number

Range: 100-1000

Default: 128

rule_rule-http-requests_dest-port

Specification	Value
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 FW session deletion logs

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

include-http

Specification	Value
Type	object

file-extension

Description HTTP file extension

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

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	Value
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

log

Specification	Value
Type	object

http-requests

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

Type: string

Supported Values: host, url