{ "id":"/axapi/v3/acos-events/collector-group/{name}", "type":"object", "node-type":"list", "title":"collector-group", "partition-visibility":"shared", "description":"Configure log servers group", "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify log server group name", "optional":false }, "protocol":{ "type":"string", "format":"enum", "partition-visibility":"shared", "modify-not-allowed":1, "description":"'udp': use udp syslog protocol to send messages to log collector; 'tcp': use tcp syslog protocol to send messages to log collector; ", "enum":[ "udp", "tcp" ], "optional":true }, "format":{ "type":"string", "format":"enum", "default":"syslog", "partition-visibility":"shared", "description":"'syslog': log message format is syslog (Default); 'cef': log message format is cef; 'leef': log message format is leef; ", "enum":[ "syslog", "cef", "leef" ], "optional":true }, "facility":{ "type":"string", "format":"enum", "default":"local0", "partition-visibility":"shared", "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)", "enum":[ "local0", "local1", "local2", "local3", "local4", "local5", "local6", "local7" ], "optional":true }, "health-check":{ "type":"string", "format":"string", "minLength":1, "maxLength":31, "partition-visibility":"shared", "$ref":"/axapi/v3/health/monitor", "description":"Health Check (Monitor Name)", "optional":true }, "rate":{ "type":"number", "format":"number", "minimum":0, "maximum":2147483647, "default":500, "partition-visibility":"shared", "description":"Specify the log message rate per second(Default 500)", "optional":true }, "use-mgmt-port":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Use managament port to connect to the log servers", "optional":true }, "log-distribution":{ "type":"string", "format":"enum", "default":"round-robin", "partition-visibility":"shared", "description":"'round-robin': Log server selection will be based on round-robin (Default); 'hashing': Log messages at this node only; ", "enum":[ "round-robin", "hashing" ], "optional":true }, "server-distribution-hash":{ "type":"string", "format":"enum", "default":"name", "partition-visibility":"shared", "description":"'name': Hashing will be based on log server name (Default); 'ip-tuple': Hashing will be based on ip-tuple; ", "enum":[ "name", "ip-tuple" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "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; ", "enum":[ "all", "msgs_sent", "msgs_rate_limited", "msgs_dropped" ] } } } ] }, "log-server-list":{ "type":"array", "minItems":1, "items":{ "type":"log-server" }, "uniqueItems":true, "$ref":"/axapi/v3/acos-events/collector-group/{name}/log-server/{name}+{port}", "array":[ { "properties":{ "name":{ "type":"string", "format":"comp-string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/acos-events/log-server", "description":"Member name", "optional":false }, "port":{ "type":"number", "format":"number", "minimum":0, "maximum":65534, "default":65534, "partition-visibility":"shared", "$ref":"/axapi/v3/acos-events/log-server/port", "description":"Port number", "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "name", "port" ] } ] } }, "object-keys":[ "name" ], "required":[ "name" ] }