acos-events log-server¶

Acos logging Server

log-server Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name log-server-list

Collection URI /axapi/v3/acos-events/log-server

Element Name log-server

Element URI /axapi/v3/acos-events/log-server/{name}

Element Attributes log-server_attributes

Partition Visibility shared

Statistics Data URI /axapi/v3/acos-events/log-server/{name}/stats

Schema log-server schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/acos-events/log-server	log-server attributes
POST /axapi/v3/acos-events/log-server/ Payload: { "log-server": { "name": "a", "server-ipv6-addr": "2003::1" } }
Create List	POST	/axapi/v3/acos-events/log-server	log-server attributes
Get Object	GET	/axapi/v3/acos-events/log-server/{name}	log-server attributes
GET /axapi/v3/acos-events/log-server/a Reponse: { "log-server": { "name": "a", "server-ipv6-addr": "2003::1", "action": "enable", "health-check-disable": 0, "uuid": "91174104-50ea-11ee-a47e-3b140db7f68c", "a10-url": "/axapi/v3/acos-events/log-server/a" } }
Get List	GET	/axapi/v3/acos-events/log-server	log-server-list
Modify Object	POST	/axapi/v3/acos-events/log-server/{name}	log-server attributes
Replace Object	PUT	/axapi/v3/acos-events/log-server/{name}	log-server attributes
PUT /axapi/v3/acos-events/log-server/a Payload: { "log-server": { "name": "a", "server-ipv6-addr": "2003::1" } }
Replace List	PUT	/axapi/v3/acos-events/log-server	log-server-list
Delete Object	DELETE	/axapi/v3/acos-events/log-server/{name}	log-server attributes
DELETE /axapi/v3/acos-events/log-server/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

log-server-list¶

log-server-list is JSON List of log-server attributes

log-server-list : [

{ log-server attributes },

{ log-server attributes },

…

]

log-server attributes¶

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

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

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

port-list_sampling-enable¶

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

sampling-enable¶

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