logging¶
System logging configuration
logging Specification¶
Parameter Value Type Intermediate Resource Element Name logging Element URI /axapi/v3/logging Element Attributes logging_attributes Partition Visibility shared Schema logging schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Get Object | GET | /axapi/v3/logging | logging_attributes |
logging attributes¶
auditlog
Description: auditlog is a JSON Block. Please see below for auditlog
Type: Object
Reference Object: /axapi/v3/logging/auditlog
buffered
Description: buffered is a JSON Block. Please see below for buffered
Type: Object
Reference Object: /axapi/v3/logging/buffered
configure
Description: configure is a JSON Block. Please see below for configure
Type: Object
Reference Object: /axapi/v3/logging/configure
console
Description: console is a JSON Block. Please see below for console
Type: Object
Reference Object: /axapi/v3/logging/console
disable-partition-name
Description: disable-partition-name is a JSON Block. Please see below for disable-partition-name
Type: Object
Reference Object: /axapi/v3/logging/disable-partition-name
Description: email is a JSON Block. Please see below for email
Type: Object
Reference Object: /axapi/v3/logging/email
email-address
Description: email-address is a JSON Block. Please see below for email-address
Type: Object
Reference Object: /axapi/v3/logging/email-address
export
Description: export is a JSON Block. Please see below for export
Type: Object
Reference Object: /axapi/v3/logging/export
facility
Description: facility is a JSON Block. Please see below for facility
Type: Object
Reference Object: /axapi/v3/logging/facility
host
Description: host is a JSON Block. Please see below for host
Type: Object
Reference Object: /axapi/v3/logging/host
local-log
Description: local-log is a JSON Block. Please see below for local-log
Type: Object
Reference Object: /axapi/v3/logging/local-log
lsn
Description: lsn is a JSON Block. Please see below for lsn
Type: Object
Reference Object: /axapi/v3/logging/lsn
monitor
Description: monitor is a JSON Block. Please see below for monitor
Type: Object
Reference Object: /axapi/v3/logging/monitor
single-priority-list
Type: List
Reference Object: /axapi/v3/logging/single-priority/{levelname}
syslog
Description: syslog is a JSON Block. Please see below for syslog
Type: Object
Reference Object: /axapi/v3/logging/syslog
trap
Description: trap is a JSON Block. Please see below for trap
Type: Object
Reference Object: /axapi/v3/logging/trap
buffered¶
Specification Value Type object buffersize
Description Logging buffer size (in items), default 30000
Type: number
Range: 10000-50000
Default: 30000
levelname
Description ‘disable’: Do not send log to buffer; ‘emergency’: System unusable log messages (severity=0); ‘alert’: Action must be taken immediately (severity=1); ‘critical’: Critical conditions (severity=2); ‘error’: Error conditions (severity=3); ‘warning’: Warning conditions (severity=4); ‘notification’: Normal but significant conditions (severity=5); ‘information’: Informational messages (severity=6); ‘debugging’: Debug level messages (severity=7);
Type: string
Supported Values: disable, emergency, alert, critical, error, warning, notification, information, debugging
Default: debugging
partition-buffersize
Description Logging buffer size (in items), default 3000
Type: number
Range: 1000-5000
Default: 3000
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
email-address¶
Specification Value Type object email-list
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
email-address_email-list¶
Specification Value Type list Block object keys email-address
Description Email address information of recipients
Type: string
Format: email-addr
Maximum Length: 63 characters
Maximum Length: 1 characters
console¶
Specification Value Type object console-levelname
Description ‘disable’: Do not send log to console; ‘emergency’: System unusable log messages (severity=0); ‘alert’: Action must be taken immediately (severity=1); ‘critical’: Critical conditions (severity=2); ‘error’: Error conditions (severity=3); ‘warning’: Warning conditions (severity=4); ‘notification’: Normal but significant conditions (severity=5); ‘information’: Informational messages (severity=6); ‘debugging’: Debug level messages (severity=7);
Type: string
Supported Values: disable, emergency, alert, critical, error, warning, notification, information, debugging
Default: error
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
monitor¶
Specification Value Type object monitor-levelname
Description ‘disable’: Do not send log to monitor; ‘emergency’: System unusable log messages (severity=0); ‘alert’: Action must be taken immediately (severity=1); ‘critical’: Critical conditions (severity=2); ‘error’: Error conditions (severity=3); ‘warning’: Warning conditions (severity=4); ‘notification’: Normal but significant conditions (severity=5); ‘information’: Informational messages (severity=6); ‘debugging’: Debug level messages (severity=7);
Type: string
Supported Values: disable, emergency, alert, critical, error, warning, notification, information, debugging
Default: disable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
facility¶
Specification Value Type object facilityname
Description ‘local0’: Local use; ‘local1’: Local use; ‘local2’: Local use; ‘local3’: Local use; ‘local4’: Local use; ‘local5’: Local use; ‘local6’: Local use; ‘local7’: Local use; (Facility parameter for syslog messages)
Type: string
Supported Values: local0, local1, local2, local3, local4, local5, local6, local7
Default: local0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
lsn¶
Specification Value Type object log-suppression
Description: log-suppression is a JSON Block. Please see below for lsn_log-suppression
Type: Object
Reference Object: /axapi/v3/logging/lsn/log-suppression
port-unavailable
Description: port-unavailable is a JSON Block. Please see below for lsn_port-unavailable
Type: Object
Reference Object: /axapi/v3/logging/lsn/port-unavailable
quota-exceeded
Description: quota-exceeded is a JSON Block. Please see below for lsn_quota-exceeded
Type: Object
Reference Object: /axapi/v3/logging/lsn/quota-exceeded
lsn_quota-exceeded¶
Specification Value Type object custom1
Description Customized attribute No.1
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
custom2
Description Customized attribute No.2
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
custom3
Description Customized attribute No.3
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
custom4
Description Customized attribute No.4
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
custom5
Description Customized attribute No.5
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
custom6
Description Customized attribute No.6
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
disable-pool-based
Description Disable log LSN user quota exceeded based on LSN pool(Default: enabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
imei
Description International Mobile Equipment Identity (IMEI)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
imsi
Description International Mobile Subscriber Identity (IMSI)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ip-based
Description Log LSN user quota exceeded based on private IP(Default: disabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
msisdn
Description Mobile Subscriber Integrated Services Digital Netwrok-Number (MSISDN)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
with-radius-attribute
Description Log with radius attribute
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
lsn_log-suppression¶
Specification Value Type object count
Description Configure log suppression count (default: 100)
Type: number
Range: 50-500
Default: 100
time
Description Log generation timeout(default: 30 seconds)
Type: number
Range: 1-300
Default: 30
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
disable-partition-name¶
Specification Value Type object disable-partition-name
Description Disable partition name in logs
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
local-log¶
Specification Value Type object access
Description: access is a JSON Block. Please see below for local-log_access
Type: Object
Reference Object: /axapi/v3/logging/local-log/access
app-fw
Description: app-fw is a JSON Block. Please see below for local-log_app-fw
Type: Object
Reference Object: /axapi/v3/logging/local-log/app-fw
authentication
Description: authentication is a JSON Block. Please see below for local-log_authentication
Type: Object
Reference Object: /axapi/v3/logging/local-log/authentication
global
Description: global is a JSON Block. Please see below for local-log_global
Type: Object
Reference Object: /axapi/v3/logging/local-log/global
local-log_access¶
Specification Value Type object log
Description: log is a JSON Block. Please see below for local-log_access_log
Type: Object
Reference Object: /axapi/v3/logging/local-log/access/log
top-n
Description: top-n is a JSON Block. Please see below for local-log_access_top-n
Type: Object
Reference Object: /axapi/v3/logging/local-log/access/top-n
local-log_access_top-n¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
local-log_access_log¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
local-log_authentication¶
Specification Value Type object log
Description: log is a JSON Block. Please see below for local-log_authentication_log
Type: Object
Reference Object: /axapi/v3/logging/local-log/authentication/log
top-n
Description: top-n is a JSON Block. Please see below for local-log_authentication_top-n
Type: Object
Reference Object: /axapi/v3/logging/local-log/authentication/top-n
local-log_authentication_top-n¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
local-log_authentication_log¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
local-log_global¶
Specification Value Type object sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
local-log_global_sampling-enable¶
Specification Value Type list Block object keys counters1
Description ‘all’: all; ‘enqueue’: Total local-log enqueue; ‘enqueue-full’: Total local-log queue full; ‘enqueue-error’: Total local-log enqueue error; ‘dequeue’: Total local-log dequeue; ‘dequeue-error’: Total local-log dequeue processing error; ‘raw-log’: Total local-log raw logs; ‘raw-log-error’: Total raw log logging error; ‘log-summarized’: Total raw log summarized; ‘l1-log-summarized’: Total layer 1 log summarized; ‘l2-log-summarized’: Total layer 2 log summarized; ‘log-summarized-error’: Total local-log summarization error; ‘aam-db’: Total local-log AAM raw database; ‘ep-db’: Total local-log EP raw database; ‘fw-db’: Total local-log Firewall raw database; ‘aam-top-user-db’: Total local-log AAM top user summary database; ‘ep-top-user-db’: Total local-log EP top user summary database; ‘ep-top-src-db’: Total local-log EP top client summary database; ‘ep-top-dst-db’: Total local-log EP top destination summary database; ‘ep-top-domain-db’: Total local-log EP top domain summary database; ‘ep-top-web-category-db’: Total local-log EP top web-category summary database; ‘ep-top-host-db’: Total local-log EP top host summary database; ‘fw-top-app-db’: Total local-log Firewall top application summary database; ‘fw-top-src-db’: Total local-log Firewall top source summary database; ‘fw-top-app-src-db’: Total local-log Firewall top application and source summary database; ‘fw-top-category-db’: Total local-log Firewall top category summary database; ‘db-erro’: Total local-log database create error; ‘query’: Total local-log axapi query; ‘response’: Total local-log axapi response; ‘query-error’: Total local-log axapi query error; ‘fw-top-thr-db’: Total local-log Firewall top threat summary database; ‘fw-top-thr-src-db’: Total local-log Firewall top threat and source summary database;
Type: string
Supported Values: all, enqueue, enqueue-full, enqueue-error, dequeue, dequeue-error, raw-log, raw-log-error, log-summarized, l1-log-summarized, l2-log-summarized, log-summarized-error, aam-db, ep-db, fw-db, aam-top-user-db, ep-top-user-db, ep-top-src-db, ep-top-dst-db, ep-top-domain-db, ep-top-web-category-db, ep-top-host-db, fw-top-app-db, fw-top-src-db, fw-top-app-src-db, fw-top-category-db, db-erro, query, response, query-error, fw-top-thr-db, fw-top-thr-src-db
local-log_app-fw¶
Specification Value Type object dot-plot
Description: dot-plot is a JSON Block. Please see below for local-log_app-fw_dot-plot
Type: Object
Reference Object: /axapi/v3/logging/local-log/app-fw/dot-plot
top-n
Description: top-n is a JSON Block. Please see below for local-log_app-fw_top-n
Type: Object
Reference Object: /axapi/v3/logging/local-log/app-fw/top-n
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
local-log_app-fw_top-n¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
local-log_app-fw_dot-plot¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
email¶
Specification Value Type object buffer
Description: buffer is a JSON Block. Please see below for email_buffer
Type: Object
Reference Object: /axapi/v3/logging/email/buffer
filter-list
Type: List
Reference Object: /axapi/v3/logging/email/filter/{filter-id}
level
Description: level is a JSON Block. Please see below for email_level
Type: Object
Reference Object: /axapi/v3/logging/email/level
email_buffer¶
Specification Value Type object number
Description Number of log messages that can be buffered (Number of log messages that can be buffered, default 50)
Type: number
Range: 16-256
Default: 50
time
Description Number of minutes a log message can stay in buffer (Number of minutes a log message can stay in buffer, default 10)
Type: number
Range: 10-1440
Default: 10
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
email_filter-list¶
Specification Value Type list Block object keys expression
Description Reverse Polish Notation, consists of level 0-7, module AFLEX/HMON/…, pattern log-content-pattern, and or/and/not
Type: string
Format: string-rlx
Maximum Length: 511 characters
Maximum Length: 1 characters
filter-id
Description Logging via email filter settings
Type: number
Range: 1-8
trigger
Description Trigger email, override buffer settings
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
email_level¶
Specification Value Type object email-levelname
Description ‘disable’: Do not send log to email address; ‘emergency’: System unusable log messages (severity=0); ‘alert’: Action must be taken immediately (severity=1); ‘critical’: Critical conditions (severity=2); ‘notification’: Normal but significant conditions (severity=5);
Type: string
Supported Values: disable, emergency, alert, critical, notification
Default: disable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
syslog¶
Specification Value Type object syslog-levelname
Description ‘disable’: Do not send log to syslog; ‘emergency’: System unusable log messages (severity=0); ‘alert’: Action must be taken immediately (severity=1); ‘critical’: Critical conditions (severity=2); ‘error’: Error conditions (severity=3); ‘warning’: Warning conditions (severity=4); ‘notification’: Normal but significant conditions (severity=5); ‘information’: Informational messages (severity=6); ‘debugging’: Debug level messages (severity=7);
Type: string
Supported Values: disable, emergency, alert, critical, error, warning, notification, information, debugging
Default: disable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
host¶
Specification Value Type object ipv4addr-list
Type: List
Reference Object: /axapi/v3/logging/host/ipv4addr/{host-ipv4}
ipv6addr-list
Type: List
Reference Object: /axapi/v3/logging/host/ipv6addr/{host-ipv6}
partition
Description: partition is a JSON Block. Please see below for host_partition
Type: Object
Reference Object: /axapi/v3/logging/host/partition
host_ipv6addr-list¶
Specification Value Type list Block object keys host-ipv6
Description Set syslog host ipv6 address
Type: string
Format: ipv6-address
over-tls
Description Enable remote logging over TLS session
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
port
Description Set remote syslog port number
Type: number
Range: 1-32767
Default: 514
tcp
Description Use TCP as transport protocol
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
use-mgmt-port
Description Use management port for connections
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
host_partition¶
Specification Value Type object partition-name
Description Select partition name for logging
Type: string
Maximum Length: 14 characters
Maximum Length: 1 characters
Mutual Exclusion: partition-name and shared are mutually exclusive
Reference Object: /axapi/v3/partition
shared
Description Select shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared and partition-name are mutually exclusive
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
host_ipv4addr-list¶
Specification Value Type list Block object keys host-ipv4
Description Set syslog host ip address
Type: string
Format: host
over-tls
Description Enable remote logging over TLS session
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
port
Description Set remote syslog port number
Type: number
Range: 1-32767
Default: 514
tcp
Description Use TCP as transport protocol
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
use-mgmt-port
Description Use management port for connections
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
export¶
Specification Value Type object all
Description System support messages
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
remote-file
Description Remote url
Type: string
Format: url
use-mgmt-port
Description Use management port as source port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
trap¶
Specification Value Type object trap-levelname
Description ‘disable’: Do not send trap to snmp host; ‘emergency’: System unusable log messages (severity=0); ‘alert’: Action must be taken immediately (severity=1); ‘critical’: Critical conditions (severity=2);
Type: string
Supported Values: disable, emergency, alert, critical
Default: disable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
auditlog¶
Specification Value Type object audit-facility
Description ‘local0’: Local use; ‘local1’: Local use; ‘local2’: Local use; ‘local3’: Local use; ‘local4’: Local use; ‘local5’: Local use; ‘local6’: Local use; ‘local7’: Local use; (Configure the facility of auditlog)
Type: string
Supported Values: local0, local1, local2, local3, local4, local5, local6, local7
host4
Description Configure the auditlog host
Type: string
Format: host
Maximum Length: 31 characters
Maximum Length: 1 characters
Mutual Exclusion: host4,shared, partition-name, and host6 are mutually exclusive
host6
Description Configure the auditlog host
Type: string
Format: ipv6-address
Mutual Exclusion: host6,shared, partition-name, and host4 are mutually exclusive
partition-name
Description Select partition name for logging
Type: string
Maximum Length: 14 characters
Maximum Length: 1 characters
Mutual Exclusion: partition-name,shared, host6, and host4 are mutually exclusive
Reference Object: /axapi/v3/partition
port
Description Set remote audit log port number(Default 514)
Type: number
Range: 1-32767
Default: 514
shared
Description Select shared partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: shared,partition-name, host6, and host4 are mutually exclusive
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
single-priority-list¶
Specification Value Type list Block object keys levelname
Description ‘emergency’: System unusable log messages (severity=0); ‘alert’: Action must be taken immediately (severity=1); ‘critical’: Critical conditions (severity=2); ‘error’: Error conditions (severity=3); ‘warning’: Warning conditions (severity=4); ‘notification’: Normal but significant conditions (severity=5); ‘information’: Informational messages (severity=6); ‘debugging’: Debug level messages (severity=7);
Type: string
Supported Values: emergency, alert, critical, error, warning, notification, information, debugging
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
configure¶
Specification Value Type object line-feed-in-udp-syslog
Description Add newline for syslog over UDP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters