acos-events

Configure message logging

acos-events Specification

Parameter Value
Type Intermediate Resource
Element Name acos-events
Element URI /axapi/v3/acos-events
Element Attributes acos-events_attributes
Partition Visibility shared
Schema acos-events schema

Operations Allowed:

OperationMethodURIPayload

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

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

collector-group-list

Type: List

Reference Object: /axapi/v3/acos-events/collector-group/{name}

log-properties

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

Type: Object

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

log-server-list

Type: List

Reference Object: /axapi/v3/acos-events/log-server/{name}

logdb

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

Type: Object

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

message-id-list

Type: List

Reference Object: /axapi/v3/acos-events/message-id/{log-msg}

message-info

Description: message-info is a JSON Block. Please see below for message-info

Type: Object

Reference Object: /axapi/v3/acos-events/message-info

message-selector-list

Type: List

Reference Object: /axapi/v3/acos-events/message-selector/{name}

rate-limit-local

Description: rate-limit-local is a JSON Block. Please see below for rate-limit-local

Type: Object

Reference 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

Reference Object: /axapi/v3/acos-events/rate-limit-remote

statistics

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

Type: Object

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

template-list

Type: List

Reference Object: /axapi/v3/acos-events/template/{name}

use-partition

Description: use-partition is a JSON Block. Please see below for use-partition

Type: Object

Reference Object: /axapi/v3/acos-events/use-partition

rate-limit-remote

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

statistics

Specification Value
Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

use-partition

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

active-template

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

logdb

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-http-forward-proxy

Description Enable HTTP forward proxy 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

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

message-id-list

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

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}/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 Value
Type object

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}/property/severity

message-id-list_property_severity

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

message-info

Specification Value
Type object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

log-properties

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

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

log-server-list

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: 127 characters

Maximum Length: 1 characters

port-list

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

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

collector-group-list

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

name

Description Specify log server group name

Type: string

Maximum Length: 127 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

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 Value
Type list
Block object keys  

name

Description Member name

Type: string

Format: comp-string

Maximum Length: 127 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

template-list

Specification Value
Type list
Block object keys  

message-selector-list

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 Value
Type list
Block object keys  

collector-group-list

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

template-list_message-selector-list_collector-group-list

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

message-selector-list

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

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