acos-events collector-group

Configure log servers group

collector-group Specification

Parameter Value
Type Collection
Object Key(s) name
Collection Name collector-group-list
Collection URI /axapi/v3/acos-events/collector-group
Element Name collector-group
Element URI /axapi/v3/acos-events/collector-group/{name}
Element Attributes collector-group_attributes
Partition Visibility shared
Statistics Data URI /axapi/v3/acos-events/collector-group/{name}/stats
Schema collector-group schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/acos-events/collector-group

collector-group attributes

Create List

POST

/axapi/v3/acos-events/collector-group

collector-group attributes

Get Object

GET

/axapi/v3/acos-events/collector-group/{name}

collector-group attributes

Get List

GET

/axapi/v3/acos-events/collector-group

collector-group-list

Modify Object

POST

/axapi/v3/acos-events/collector-group/{name}

collector-group attributes

Replace Object

PUT

/axapi/v3/acos-events/collector-group/{name}

collector-group attributes

Replace List

PUT

/axapi/v3/acos-events/collector-group

collector-group-list

Delete Object

DELETE

/axapi/v3/acos-events/collector-group/{name}

collector-group attributes

collector-group-list

collector-group-list is JSON List of collector-group attributes

collector-group-list : [

collector-group attributes

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

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

sampling-enable

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

log-server-list

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