acos-events¶

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

Specification	Value
Type	object

sampling-enable

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

Specification	Value
Type	list
Block object keys

counters1

Description ‘all’: all; ‘msg_sent’: Messages sent, to Remote; ‘msg_sent_logdb’: Messages sent, to LogDB; ‘msg_dropped_format_not_defined’: Messages Dropped, format not defined; ‘msg_dropped_malloc_failure’: Messages Dropped, malloc failure; ‘msg_dropped_no_template’: Messages Dropped, no active template; ‘msg_dropped_selector’: Messages Dropped, selector does not enable msg; ‘msg_dropped_too_long’: Messages Dropped, invalid length; ‘msg_dropped_craft_fail’: Messages Dropped, msg crafting failed; ‘msg_dropped_local_log_ratelimit’: Messages Dropped, local log ratelimited; ‘msg_dropped_remote_log_ratelimit’: Messages Dropped, remote log ratelimited; ‘msg_dropped_send_failed’: Messages Dropped, send failed; ‘msg_dropped_no_active_member’: Messages Dropped, no active member in collector grp; ‘msg_dropped_route_fail’: Messages Dropped, Route lookup failed; ‘msg_dropped_other’: Messages Dropped, unexpected error; ‘no_template’: Message API called, with no active template; ‘msg_dropped_lost_during_config_change’: Messages Dropped, lost during config change; ‘local_enqueue_pass’: Messages enqueue to Logd passed; ‘msg_sent_to_logd’: Messages sent to Logd via IPC; ‘msg_retry_after_socket_fail’: Messages retried to be sent to Logd via IPC; ‘msg_sent_direct_syslog’: Messages sent to syslog directly from axlog; ‘msg_dropped_send_to_logd_fail’: Messages Dropped, send to Logd via IPC failed; ‘msg_dropped_trylock_fail’: Messages Dropped, Trylock failed in axlog; ‘msg_dropped_remote_cplane_log_ratelimit’: Messages Dropped, Remote cplane log ratelimited; ‘msg_dropped_remote_dplane_log_ratelimit’: Messages Dropped, Remote dplane log ratelimited; ‘msg_dropped_local_enqueue_failed’: Messages Dropped, Enqueue to Logd failed; ‘msg_dropped_grp_not_used’: Messages Dropped, Collector group not used; ‘msg_sent_remote_cplane’: Messages Sent, to remote in logd; ‘msg_dropped_no_template_logd’: Messages Dropped, no active template in Logd; ‘msg_dropped_lost_during_config_change_logd’: Messages Dropped, lost during config change in Logd; ‘msg_dropped_craft_fail_logd’: Messages Dropped, msg crafting failed in Logd; ‘msg_dropped_send_failed_logd’: Messages Dropped, send failed in Logd; ‘msg_dropped_no_active_member_logd’: Messages Dropped, no active member in collector grp in Logd; ‘msg_dropped_other_logd’: Messages Dropped, unexpected error in Logd; ‘msg_dropped_invalid_part’: Messages Dropped, Invalid partition Id; ‘acos_evt_test_logs_ticks’: Number of ticks when running ACOS Event Test Logs; ‘param_msg_sent_to_hc’: Parameterized log sent to HC; ‘param_msg_sent_fail’: Parameterized log send to HC failed; ‘param_msg_encode_fail’: Parameterized log AVRO encoding failed;

Type: string

Supported Values: all, msg_sent, msg_sent_logdb, msg_dropped_format_not_defined, msg_dropped_malloc_failure, msg_dropped_no_template, msg_dropped_selector, msg_dropped_too_long, msg_dropped_craft_fail, msg_dropped_local_log_ratelimit, msg_dropped_remote_log_ratelimit, msg_dropped_send_failed, msg_dropped_no_active_member, msg_dropped_route_fail, msg_dropped_other, no_template, msg_dropped_lost_during_config_change, local_enqueue_pass, msg_sent_to_logd, msg_retry_after_socket_fail, msg_sent_direct_syslog, msg_dropped_send_to_logd_fail, msg_dropped_trylock_fail, msg_dropped_remote_cplane_log_ratelimit, msg_dropped_remote_dplane_log_ratelimit, msg_dropped_local_enqueue_failed, msg_dropped_grp_not_used, msg_sent_remote_cplane, msg_dropped_no_template_logd, msg_dropped_lost_during_config_change_logd, msg_dropped_craft_fail_logd, msg_dropped_send_failed_logd, msg_dropped_no_active_member_logd, msg_dropped_other_logd, msg_dropped_invalid_part, acos_evt_test_logs_ticks, param_msg_sent_to_hc, param_msg_sent_fail, param_msg_encode_fail

Specification	Value
Type	object

log-rate

Description Max number of parameterized logs sent per second

Type: number

Range: 0-10000

Default: 10

message-selector

Description: message-selector is a JSON Block. Please see below for log-parameterization_message-selector

Type: Object

Reference Object: /axapi/v3/acos-events/log-parameterization/message-selector

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

Specification	Value
Type	object

rule-list

Type: List

Reference Object: /axapi/v3/acos-events/log-parameterization/message-selector/rule/{index}

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

Specification	Value
Type	list
Block object keys

action

Description ‘send’: log messages selected by this rule will be sent (Default); ‘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

Specification	Value
Type	object

partition-name

Description Select partition name for logging

Type: string

Maximum Length: 14 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/partition

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

Specification	Value
Type	object

name

Description Specify the logging template name

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/acos-events/template

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

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

Specification	Value
Type	object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

Specification	Value
Type	object

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

rate-limit

Description Configure number of logs per second to be stored in disk (Default: 1000)

Type: number

Range: 1-60000

Default: 1000

sampling-enable

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

Specification	Value
Type	list
Block object keys

counters1

Description ‘all’: all; ‘init-pass’: Local logging Init Successful; ‘init-fail’: Local logging Init Fail; ‘freed’: Local logging Stopped; ‘disk-over-thres’: Number of logs Dropped, Disk reached threshold; ‘rate-limited’: Number of logs Dropped, Rate limited; ‘not-inited’: Number of logs Dropped, Local logging not inited; ‘sent-to-store’: Number of logs sent to be stored; ‘sent-to-store-fail’: Number of Logs sent to be stored Failed; ‘store-fail’: Number of logs failed to be stored; ‘in-logs’: Number of logs successfully stored; ‘in-bytes’: Number of bytes successfully stored; ‘in-logs-backlog’: Number of backlogs loaded from disk; ‘in-bytes-backlog’: Number of backlog bytes loaded from disk; ‘in-store-fail-no-space’: Number of logs Dropped, failed without disk space; ‘in-discard-logs’: Number of old logs discarded to fit in new logs; ‘in-discard-bytes’: Number of old bytes discarded to fit in new logs; ‘out-logs’: Number of logs sent to log servers; ‘out-bytes’: Number of bytes sent to log-servers; ‘out-error’: Number of errors during send; ‘remaining-logs’: Total number of remaining logs yet to be sent; ‘remaining-bytes’: Total number of remaining bytes yet to be sent; ‘moved-to-delq’: Local Logging moved to delq to be deleted; ‘out-retry’: Number of attempted retries to send logs; ‘out-retry-fail’: Number of retries failed with error; ‘curr-total-chunks’: Current Number of blocks; ‘curr-mem-chunks’: Current blocks in memory; ‘curr-fs-chunks’: Current blocks in file system; ‘curr-fs-chunks-up’: Current blocks in file system loaded in memory; ‘curr-fs-chunks-down’: Current blocks in file system not loaded in memory; ‘in-logs-agg’: Total Aggregate, Number of logs successfully stored; ‘in-bytes-agg’: Total Aggregate, Number of bytes successfully stored; ‘in-logs-backlog-agg’: Total Aggregate, Number of backlogs loaded from disk; ‘in-bytes-backlog-agg’: Total Aggregate, Number of backlog bytes loaded from disk; ‘in-store-fail-no-space-agg’: Total Aggregate, Number of logs Dropped, failed without disk space; ‘in-discard-logs-agg’: Total Aggregate, Number of old logs discarded to fit in new logs; ‘in-discard-bytes-agg’: Total Aggregate, Number of old bytes discarded to fit in new logs; ‘out-logs-agg’: Total Aggregate, Number of logs sent to log servers; ‘out-bytes-agg’: Total Aggregate, Number of bytes sent to log-servers; ‘out-error-agg’: Total Aggregate, Number of errors during send; ‘out-retry-agg’: Total Aggregate, Number of attempted retries to send logs; ‘out-retry-fail-agg’: Total Aggregate, Number of retries failed with error; ‘in-logs-curr-agg’: Current Aggregate, Number of logs successfully stored; ‘in-bytes-curr-agg’: Current Aggregate, Number of bytes successfully stored; ‘in-logs-backlog-curr-agg’: Current Aggregate, Number of backlogs loaded from disk; ‘in-bytes-backlog-curr-agg’: Current Aggregate, Number of backlog bytes loaded from disk; ‘in-discard-logs-curr-agg’: Current Aggregate, Number of old logs discarded to fit in new logs; ‘in-discard-bytes-curr-agg’: Current Aggregate, Number of old bytes discarded to fit in new logs; ‘out-logs-curr-agg’: Current Aggregate, Number of logs sent to log servers; ‘out-bytes-curr-agg’: Current Aggregate, Number of bytes sent to log-servers;

Type: string

Supported Values: all, init-pass, init-fail, freed, disk-over-thres, rate-limited, not-inited, sent-to-store, sent-to-store-fail, store-fail, in-logs, in-bytes, in-logs-backlog, in-bytes-backlog, in-store-fail-no-space, in-discard-logs, in-discard-bytes, out-logs, out-bytes, out-error, remaining-logs, remaining-bytes, moved-to-delq, out-retry, out-retry-fail, curr-total-chunks, curr-mem-chunks, curr-fs-chunks, curr-fs-chunks-up, curr-fs-chunks-down, in-logs-agg, in-bytes-agg, in-logs-backlog-agg, in-bytes-backlog-agg, in-store-fail-no-space-agg, in-discard-logs-agg, in-discard-bytes-agg, out-logs-agg, out-bytes-agg, out-error-agg, out-retry-agg, out-retry-fail-agg, in-logs-curr-agg, in-bytes-curr-agg, in-logs-backlog-curr-agg, in-bytes-backlog-curr-agg, in-discard-logs-curr-agg, in-discard-bytes-curr-agg, out-logs-curr-agg, out-bytes-curr-agg

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

Reference 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

Specification	Value
Type	object

log-route

Description: log-route is a JSON Block. Please see below for message-id-list_property_log-route

Type: Object

Reference 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

Reference 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

Reference Object: /axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}/property/severity

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

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

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

Specification	Value
Type	object

add-msgid-in-header

Description Add Message ID in log messages

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

enable-8K-tcp-syslog

Description Enable 8K size remote TCP syslog

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

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

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

Reference 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

Reference 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

sampling-enable

Type: List

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

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

Reference 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

sampling-enable

Type: List

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

Specification	Value
Type	list
Block object keys

counters1

Description ‘all’: all; ‘msgs_sent’: Number of log messages sent;

Type: string

Supported Values: all, msgs_sent

Specification	Value
Type	list
Block object keys

counters1

Description ‘all’: all; ‘msgs_sent’: Number of log messages sent;

Type: string

Supported Values: all, msgs_sent

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

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

Reference 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

Reference 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

sampling-enable

Type: List

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

Specification	Value
Type	list
Block object keys

counters1

Description ‘all’: all; ‘msgs_sent’: Number of log messages sent; ‘msgs_rate_limited’: Number of rate limited log messages; ‘msgs_dropped’: Number of messages dropped for other reasons;

Type: string

Supported Values: all, msgs_sent, msgs_rate_limited, msgs_dropped

Specification	Value
Type	list
Block object keys

name

Description Member name

Type: string

Format: comp-string

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/acos-events/log-server

port

Description Port number

Type: number

Range: 0-65534

Default: 65534

Reference Object: /axapi/v3/acos-events/log-server/port

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

Specification	Value
Type	list
Block object keys

message-selector-list

Type: List

Reference 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

Specification	Value
Type	list
Block object keys

collector-group-list

Type: List

Reference 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

Reference 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

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

Reference 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

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

Reference 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

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