{ "id":"/axapi/v3/logging", "type":"object", "node-type":"intermediate", "title":"logging", "operation-not-allowed": ["PUT", "POST", "DELETE"], "partition-visibility":"shared", "auto-created-object":1, "description":"System logging configuration", "properties":{ "auditlog":{ "type":"object", "$ref":"/axapi/v3/logging/auditlog", "properties":{ "shared":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"private", "not-list":[ "partition-name", "host6", "host4" ], "description":"Select shared partition" }, "partition-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":14, "partition-visibility":"shared", "$ref":"/axapi/v3/partition", "not-list":[ "shared", "host6", "host4" ], "description":"Select partition name for logging" }, "host6":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "not-list":[ "shared", "partition-name", "host4" ], "description":"Configure the auditlog host" }, "host4":{ "type":"string", "format":"host", "minLength":1, "maxLength":31, "partition-visibility":"shared", "not-list":[ "shared", "partition-name", "host6" ], "description":"Configure the auditlog host" }, "audit-facility":{ "type":"string", "format":"enum", "partition-visibility":"shared", "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)", "enum":[ "local0", "local1", "local2", "local3", "local4", "local5", "local6", "local7" ] }, "port":{ "type":"number", "format":"number", "minimum":1, "maximum":32767, "default":514, "partition-visibility":"shared", "description":"Set remote audit log port number(Default 514)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "email-address":{ "type":"object", "$ref":"/axapi/v3/logging/email-address", "properties":{ "email-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "email-address":{ "type":"string", "format":"email-addr", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Email address information of recipients" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "facility":{ "type":"object", "$ref":"/axapi/v3/logging/facility", "properties":{ "facilityname":{ "type":"string", "format":"enum", "default":"local0", "partition-visibility":"shared", "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)", "enum":[ "local0", "local1", "local2", "local3", "local4", "local5", "local6", "local7" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "monitor":{ "type":"object", "$ref":"/axapi/v3/logging/monitor", "properties":{ "monitor-levelname":{ "type":"string", "format":"enum", "default":"disable", "partition-visibility":"shared", "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); ", "enum":[ "disable", "emergency", "alert", "critical", "error", "warning", "notification", "information", "debugging" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "syslog":{ "type":"object", "$ref":"/axapi/v3/logging/syslog", "properties":{ "syslog-levelname":{ "type":"string", "format":"enum", "default":"disable", "partition-visibility":"shared", "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); ", "enum":[ "disable", "emergency", "alert", "critical", "error", "warning", "notification", "information", "debugging" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "configure":{ "type":"object", "$ref":"/axapi/v3/logging/configure", "properties":{ "line-feed-in-udp-syslog":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Add newline for syslog over UDP" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "trap":{ "type":"object", "$ref":"/axapi/v3/logging/trap", "properties":{ "trap-levelname":{ "type":"string", "format":"enum", "default":"disable", "partition-visibility":"shared", "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); ", "enum":[ "disable", "emergency", "alert", "critical" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "export":{ "type":"object", "$ref":"/axapi/v3/logging/export", "properties":{ "all":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"System support messages" }, "use-mgmt-port":{ "type":"number", "format":"flag", "plat-neg-list":["softax-aws"], "default":0, "partition-visibility":"shared", "description":"Use management port as source port" }, "remote-file":{ "type":"string", "format":"url", "partition-visibility":"shared", "description":"Remote url" }, "password":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"password for the remote site" } } }, "console":{ "type":"object", "$ref":"/axapi/v3/logging/console", "properties":{ "console-levelname":{ "type":"string", "format":"enum", "default":"error", "partition-visibility":"shared", "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); ", "enum":[ "disable", "emergency", "alert", "critical", "error", "warning", "notification", "information", "debugging" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "email":{ "type":"object", "$ref":"/axapi/v3/logging/email", "properties":{ "level":{ "type":"object", "$ref":"/axapi/v3/logging/email/level", "properties":{ "email-levelname":{ "type":"string", "format":"enum", "default":"disable", "partition-visibility":"shared", "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); ", "enum":[ "disable", "emergency", "alert", "critical", "notification" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "buffer":{ "type":"object", "$ref":"/axapi/v3/logging/email/buffer", "properties":{ "number":{ "type":"number", "format":"number", "minimum":16, "maximum":256, "default":50, "partition-visibility":"shared", "description":"Number of log messages that can be buffered (Number of log messages that can be buffered, default 50)" }, "time":{ "type":"number", "format":"number", "minimum":10, "maximum":1440, "default":10, "partition-visibility":"shared", "description":"Number of minutes a log message can stay in buffer (Number of minutes a log message can stay in buffer, default 10)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "filter-list":{ "type":"array", "minItems":1, "items":{ "type":"filter" }, "uniqueItems":true, "$ref":"/axapi/v3/logging/email/filter/{filter-id}", "array":[ { "properties":{ "filter-id":{ "type":"number", "format":"number", "minimum":1, "maximum":8, "partition-visibility":"shared", "description":"Logging via email filter settings", "optional":false }, "expression":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":511, "partition-visibility":"shared", "description":"Reverse Polish Notation, consists of level 0-7, module AFLEX/HMON/..., pattern log-content-pattern, and or/and/not", "optional":true }, "trigger":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Trigger email, override buffer settings", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "filter-id" ] } ] } } }, "host":{ "type":"object", "$ref":"/axapi/v3/logging/host", "properties":{ "ipv4addr-list":{ "type":"array", "minItems":1, "items":{ "type":"ipv4addr" }, "uniqueItems":true, "$ref":"/axapi/v3/logging/host/ipv4addr/{host-ipv4}", "array":[ { "properties":{ "host-ipv4":{ "type":"string", "format":"host", "partition-visibility":"shared", "description":"Set syslog host ip address", "optional":false }, "use-mgmt-port":{ "type":"number", "format":"flag", "plat-neg-list":["softax-aws"], "default":0, "partition-visibility":"shared", "description":"Use management port for connections", "optional":true }, "port":{ "type":"number", "format":"number", "minimum":1, "maximum":32767, "default":514, "partition-visibility":"shared", "description":"Set remote syslog port number", "optional":true }, "tcp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use TCP as transport protocol", "optional":true }, "over-tls":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable remote logging over TLS session", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "host-ipv4" ] } ] }, "ipv6addr-list":{ "type":"array", "minItems":1, "items":{ "type":"ipv6addr" }, "uniqueItems":true, "$ref":"/axapi/v3/logging/host/ipv6addr/{host-ipv6}", "array":[ { "properties":{ "host-ipv6":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "description":"Set syslog host ipv6 address", "optional":false }, "use-mgmt-port":{ "type":"number", "format":"flag", "plat-neg-list":["softax-aws"], "default":0, "partition-visibility":"shared", "description":"Use management port for connections", "optional":true }, "port":{ "type":"number", "format":"number", "minimum":1, "maximum":32767, "default":514, "partition-visibility":"shared", "description":"Set remote syslog port number", "optional":true }, "tcp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use TCP as transport protocol", "optional":true }, "over-tls":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable remote logging over TLS session", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "host-ipv6" ] } ] }, "partition":{ "type":"object", "$ref":"/axapi/v3/logging/host/partition", "properties":{ "shared":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"private", "not":"partition-name", "description":"Select shared partition" }, "partition-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":14, "partition-visibility":"shared", "$ref":"/axapi/v3/partition", "not":"shared", "description":"Select partition name for logging" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } } }, "disable-partition-name":{ "type":"object", "$ref":"/axapi/v3/logging/disable-partition-name", "properties":{ "disable-partition-name":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable partition name in logs" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "single-priority-list":{ "type":"array", "minItems":1, "items":{ "type":"single-priority" }, "uniqueItems":true, "$ref":"/axapi/v3/logging/single-priority/{levelname}", "array":[ { "properties":{ "levelname":{ "type":"string", "format":"enum", "partition-visibility":"shared", "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); ", "enum":[ "emergency", "alert", "critical", "error", "warning", "notification", "information", "debugging" ], "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "levelname" ] } ] }, "buffered":{ "type":"object", "$ref":"/axapi/v3/logging/buffered", "properties":{ "buffersize":{ "type":"number", "format":"number", "minimum":10000, "maximum":50000, "default":30000, "partition-visibility":"shared", "description":"Logging buffer size (in items), default 30000" }, "partition-buffersize":{ "type":"number", "format":"number", "minimum":1000, "maximum":5000, "default":3000, "partition-visibility":"private", "description":"Logging buffer size (in items), default 3000" }, "levelname":{ "type":"string", "format":"enum", "default":"debugging", "partition-visibility":"shared", "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); ", "enum":[ "disable", "emergency", "alert", "critical", "error", "warning", "notification", "information", "debugging" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "lsn":{ "type":"object", "$ref":"/axapi/v3/logging/lsn", "properties":{ "quota-exceeded":{ "type":"object", "$ref":"/axapi/v3/logging/lsn/quota-exceeded", "properties":{ "ip-based":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Log LSN user quota exceeded based on private IP(Default: disabled)" }, "disable-pool-based":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable log LSN user quota exceeded based on LSN pool(Default: enabled)" }, "with-radius-attribute":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Log with radius attribute" }, "custom1":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Customized attribute No.1" }, "custom2":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Customized attribute No.2" }, "custom3":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Customized attribute No.3" }, "custom4":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Customized attribute No.4" }, "custom5":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Customized attribute No.5" }, "custom6":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Customized attribute No.6" }, "imei":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":" International Mobile Equipment Identity (IMEI)" }, "imsi":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"International Mobile Subscriber Identity (IMSI)" }, "msisdn":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Mobile Subscriber Integrated Services Digital Netwrok-Number (MSISDN)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "log-suppression":{ "type":"object", "$ref":"/axapi/v3/logging/lsn/log-suppression", "properties":{ "time":{ "type":"number", "format":"number", "minimum":1, "maximum":300, "default":30, "partition-visibility":"shared", "description":"Log generation timeout(default: 30 seconds)" }, "count":{ "type":"number", "format":"number", "minimum":50, "maximum":500, "default":100, "partition-visibility":"shared", "description":"Configure log suppression count (default: 100)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "port-unavailable":{ "type":"object", "$ref":"/axapi/v3/logging/lsn/port-unavailable", "properties":{ "ip-based":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Log LSN port unavailable based on NAT IP (Default: disabled)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } } }, "local-log":{ "type":"object", "$ref":"/axapi/v3/logging/local-log", "properties":{ "authentication":{ "type":"object", "$ref":"/axapi/v3/logging/local-log/authentication", "properties":{ "log":{ "type":"object", "$ref":"/axapi/v3/logging/local-log/authentication/log", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "top-n":{ "type":"object", "$ref":"/axapi/v3/logging/local-log/authentication/top-n", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } } }, "access":{ "type":"object", "$ref":"/axapi/v3/logging/local-log/access", "properties":{ "log":{ "type":"object", "$ref":"/axapi/v3/logging/local-log/access/log", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "top-n":{ "type":"object", "$ref":"/axapi/v3/logging/local-log/access/top-n", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } } }, "app-fw":{ "type":"object", "$ref":"/axapi/v3/logging/local-log/app-fw", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "top-n":{ "type":"object", "$ref":"/axapi/v3/logging/local-log/app-fw/top-n", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "dot-plot":{ "type":"object", "$ref":"/axapi/v3/logging/local-log/app-fw/dot-plot", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } } }, "global":{ "type":"object", "$ref":"/axapi/v3/logging/local-log/global", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "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; ", "enum":[ "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" ] } } } ] } } } } } } }