acos-events¶
Configure message logging
acos-events Specification¶
Type
Intermediate Resource
Element Name
acos-events
Element URI
/axapi/v3/acos-events
Element Attributes
acos-events_attributes
Schema
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Get Object | GET | /axapi/v3/acos-events | acos-events_attributes |
acos-events attributes¶
active-template
Description: active-template is a JSON Block. Please see below for active-template
Type: Object
Refernce Object: /axapi/v3/acos-events/active-template
collector-group-list
Type: List
Refernce Object: /axapi/v3/acos-events/collector-group/{name}
local-logging
Description: local-logging is a JSON Block. Please see below for local-logging
Type: Object
Refernce Object: /axapi/v3/acos-events/local-logging
log-properties
Description: log-properties is a JSON Block. Please see below for log-properties
Type: Object
Refernce Object: /axapi/v3/acos-events/log-properties
log-server-list
Type: List
Refernce Object: /axapi/v3/acos-events/log-server/{name}
logdb
Description: logdb is a JSON Block. Please see below for logdb
Type: Object
Refernce Object: /axapi/v3/acos-events/logdb
message-id-list
Type: List
Refernce Object: /axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}
message-selector-list
Type: List
Refernce Object: /axapi/v3/acos-events/message-selector/{name}
messages
Description: messages is a JSON Block. Please see below for messages
Type: Object
Refernce Object: /axapi/v3/acos-events/messages
rate-limit-local
Description: rate-limit-local is a JSON Block. Please see below for rate-limit-local
Type: Object
Refernce Object: /axapi/v3/acos-events/rate-limit-local
rate-limit-remote
Description: rate-limit-remote is a JSON Block. Please see below for rate-limit-remote
Type: Object
Refernce Object: /axapi/v3/acos-events/rate-limit-remote
statistics
Description: statistics is a JSON Block. Please see below for statistics
Type: Object
Refernce Object: /axapi/v3/acos-events/statistics
template-list
Type: List
Refernce Object: /axapi/v3/acos-events/template/{name}
use-partition
Description: use-partition is a JSON Block. Please see below for use-partition
Type: Object
Refernce Object: /axapi/v3/acos-events/use-partition
rate-limit-remote¶
Specification
Type
object
limit
Description Configure rate limit for logs sent to remote via classic logging config
Type: number
Range: 0-250
Default: 32
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
statistics¶
Specification
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
use-partition¶
Specification
Type
object
partition-name
Description Select partition name for logging
Type: string
Maximum Length: 14 characters
Maximum Length: 1 characters
Refernce Object: /axapi/v3/partition
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
active-template¶
Specification
Type
object
name
Description Specify the logging template name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Refernce Object: /axapi/v3/acos-events/template
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
logdb¶
Specification
Type
object
enable-all
Description Enable logging for all widgets
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
enable-cgn
Description Enable CGN logging
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
enable-fw
Description Enable Firewall logging
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
enable-http-forward-proxy
Description Enable HTTP forward proxy logging
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
enable-link-cost
Description Enable link-cost logging
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
enable-mqtt
Description Enable MQTT logging
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
enable-smtp
Description Enable SMTP logging
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
enable-ssli
Description Enable SSLi logging
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
messages¶
Specification
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
local-logging¶
Specification
Type
object
debug-logs
Description Enable debug logs in var log
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
delete-old-logs-in-disk
Description Operational command to delete the old logs stored in disk
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
enable
Description Enable local-logging when FW log servers are down (Default: Not enabled)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
max-backlog-memory
Description Configure Max memory in MB to be used for processing backlogs (Default: 10MB)
Type: number
Range: 5-500
Default: 10
max-disk-space
Description Configure Max disk space in MB to be used for storing the logs (Default: 100MB)
Type: number
Range: 50-20000
Default: 100
max-memory
Description Configure Max memory in MB to be used for processing the logs (Default: 30MB)
Type: number
Range: 5-500
Default: 30
queue-limit
Description Configure Max number of blocks that can be busy being scheduled (Default: 10, 0 to disable)
Type: number
Range: 0-100
Default: 10
rate-limit
Description Configure number of logs per second to be stored in disk (Default: 1000)
Type: number
Range: 1-60000
Default: 1000
send-if-all-servers-up
Description Start sending the stored logs only when all log servers are up
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
string-decode-special-char
Description Enable processing special characters before storing
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
message-id-list¶
Specification
Type
list
Block object keys
log-msg
Description Specify log message-id lineage
Type: string
Maximum Length: 512 characters
Maximum Length: 1 characters
message-id-scope-route
Description ‘all’: Log messages at this level and all sub-trees; ‘node-only’: Log messages at this node only; ‘children-only’: Log messages at all sub-trees only; ‘log-field-only’: This is a log-field (Default);
Type: string
Supported Values: all, node-only, children-only, log-field-only
Default: log-field-only
property
Description: property is a JSON Block. Please see below for message-id-list_property
Type: Object
Refernce Object: /axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}/property
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
message-id-list_property¶
Specification
Type
object
log-route
Description: log-route is a JSON Block. Please see below for message-id-list_property_log-route
Type: Object
Refernce Object: /axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}/property/log-route
rate-limit
Description: rate-limit is a JSON Block. Please see below for message-id-list_property_rate-limit
Type: Object
Refernce Object: /axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}/property/rate-limit
severity
Description: severity is a JSON Block. Please see below for message-id-list_property_severity
Type: Object
Refernce Object: /axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}/property/severity
message-id-list_property_log-route¶
Specification
Type
object
log-route-val
Description ‘local-only’: send logs to local-only; ‘remote-only’: send logs to remote-only; ‘local-and-remote’: send logs to both local and remote;
Type: string
Supported Values: local-only, remote-only, local-and-remote
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
message-id-list_property_severity¶
Specification
Type
object
severity-val
Description ‘emergency’: System unusable log messages (Most Important); ‘alert’: Action must be taken immediately; ‘critical’: Critical conditions; ‘error’: Error conditions; ‘warning’: Warning conditions; ‘notification’: Normal but significant conditions; ‘information’: Informational messages; ‘debugging’: Debug level messages (Least Important);
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
message-id-list_property_rate-limit¶
Specification
Type
object
rate-limit-val
Description ‘enable’: enable rate-limiting of logs; ‘disable’: disable rate-limiting of logs;
Type: string
Supported Values: enable, disable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
log-properties¶
Specification
Type
object
add-msgid-in-header
Description Add Message ID in log messages
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
use-old-descriptive-name
Description Use the old descriptive name for CEF and LEEF logs
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
use-syslog-standard-header
Description Send syslog messages with Standard Header format
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
log-server-list¶
Specification
Type
list
Block object keys
action
Description ‘enable’: Enable this Logging Server; ‘disable’: Disable this Logging Server;
Type: string
Supported Values: enable, disable
Default: enable
fqdn-name
Description Server hostname
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
health-check
Description Health Check Monitor (Health monitor name)
Type: string
Maximum Length: 31 characters
Maximum Length: 1 characters
Mutual Exclusion: health-check and health-check-disable are mutually exclusive
Refernce Object: /axapi/v3/health/monitor
health-check-disable
Description Disable configured health check configuration
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: health-check-disable and health-check are mutually exclusive
host
Description IP Address
Type: string
Format: ipv4-address
name
Description Server Name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
port-list
Type: List
Refernce Object: /axapi/v3/acos-events/log-server/{name}/port/{port-number}+{protocol}
resolve-as
Description ‘resolve-to-ipv4’: Use A Query only to resolve FQDN; ‘resolve-to-ipv6’: Use AAAA Query only to resolve FQDN; ‘resolve-to-ipv4-and-ipv6’: Use A as well as AAAA Query to resolve FQDN;
Type: string
Supported Values: resolve-to-ipv4, resolve-to-ipv6, resolve-to-ipv4-and-ipv6
Default: resolve-to-ipv4
server-ipv6-addr
Description IPV6 address
Type: string
Format: ipv6-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
log-server-list_port-list¶
Specification
Type
list
Block object keys
action
Description ‘enable’: enable; ‘disable’: disable;
Type: string
Supported Values: enable, disable
Default: enable
health-check
Description Health Check (Monitor Name)
Type: string
Maximum Length: 31 characters
Maximum Length: 1 characters
Mutual Exclusion: health-check and health-check-disable are mutually exclusive
Refernce Object: /axapi/v3/health/monitor
health-check-disable
Description Disable health check
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: health-check-disable and health-check are mutually exclusive
port-number
Description Port Number
Type: number
Range: 0-65534
protocol
Description ‘tcp’: TCP Port; ‘udp’: UDP Port;
Type: string
Supported Values: tcp, udp
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
rate-limit-local¶
Specification
Type
object
limit
Description Configure Rate Limit for Local logs
Type: number
Range: 0-100
Default: 32
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
collector-group-list¶
Specification
Type
list
Block object keys
facility
Description ‘local0’: Local use(Default); ‘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
format
Description ‘syslog’: log message format is syslog (Default); ‘cef’: log message format is cef; ‘leef’: log message format is leef;
Type: string
Supported Values: syslog, cef, leef
Default: syslog
health-check
Description Health Check (Monitor Name)
Type: string
Maximum Length: 31 characters
Maximum Length: 1 characters
Refernce Object: /axapi/v3/health/monitor
log-distribution
Description ‘round-robin’: Log server selection will be based on round-robin (Default); ‘hashing’: Log messages at this node only;
Type: string
Supported Values: round-robin, hashing
Default: round-robin
log-server-list
Type: List
Refernce Object: /axapi/v3/acos-events/collector-group/{name}/log-server/{name}+{port}
name
Description Specify log server group name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
protocol
Description ‘udp’: use udp syslog protocol to send messages to log collector; ‘tcp’: use tcp syslog protocol to send messages to log collector;
Type: string
Supported Values: udp, tcp
rate
Description Specify the log message rate per second(Default 500)
Type: number
Range: 0-2147483647
Default: 500
server-distribution-hash
Description ‘name’: Hashing will be based on log server name (Default); ‘ip-tuple’: Hashing will be based on ip-tuple;
Type: string
Supported Values: name, ip-tuple
Default: name
use-mgmt-port
Description Use managament port to connect to the log servers
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
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
collector-group-list_log-server-list¶
Specification
Type
list
Block object keys
name
Description Member name
Type: string
Format: comp-string
Maximum Length: 63 characters
Maximum Length: 1 characters
Refernce Object: /axapi/v3/acos-events/log-server
port
Description Port number
Type: number
Range: 0-65534
Default: 65534
Refernce Object: /axapi/v3/acos-events/log-server/port
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
template-list¶
Specification
Type
list
Block object keys
message-selector-list
Type: List
Refernce Object: /axapi/v3/acos-events/template/{name}/message-selector/{name}
name
Description Specify logging template name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
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
template-list_message-selector-list¶
Specification
Type
list
Block object keys
collector-group-list
Type: List
Refernce Object: /axapi/v3/acos-events/template/{name}/message-selector/{name}/collector-group/{name}
name
Description Specify the message selector name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Refernce Object: /axapi/v3/acos-events/message-selector
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
template-list_message-selector-list_collector-group-list¶
Specification
Type
list
Block object keys
name
Description Specify the log server group for receiving log messages
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Refernce Object: /axapi/v3/acos-events/collector-group
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
message-selector-list¶
Specification
Type
list
Block object keys
name
Description Specify message selector name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
rule-list
Type: List
Refernce Object: /axapi/v3/acos-events/message-selector/{name}/rule/{index}
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
message-selector-list_rule-list¶
Specification
Type
list
Block object keys
action
Description ‘send’: log messages selected by this rule will be sent; ‘drop’: log messages selected by this rule will be dropped;
Type: string
Supported Values: send, drop
Default: send
index
Description Specify rule index - rules are applied in numeric order
Type: number
Range: 1-256
message-id
Description Select a specific message by message-id and optionally severity
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
message-id-scope
Description ‘all’: Log messages at this level and all sub-trees; ‘node-only’: Log messages at this node only; ‘children-only’: Log messages at all sub-trees only; ‘log-field-only’: Log message for this Log Field only;
Type: string
Supported Values: all, node-only, children-only, log-field-only
severity-oper
Description ‘equal-and-higher’: emergency is highest, debugging lowest; ‘equal’: single severity;
Type: string
Supported Values: equal-and-higher, equal
severity-val
Description ‘emergency’: System unusable log messages (Most Important); ‘alert’: Action must be taken immediately; ‘critical’: Critical conditions; ‘error’: Error conditions; ‘warning’: Warning conditions; ‘notification’: Normal but significant conditions; ‘information’: Informational messages; ‘debugging’: Debug level messages (Least Important);
Type: string
Supported Values: emergency, alert, critical, error, warning, notification, information, debugging
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