{ "id":"/axapi/v3/acos-events", "type":"object", "node-type":"intermediate", "title":"acos-events", "operation-not-allowed": ["PUT", "POST", "DELETE"], "partition-visibility":"shared", "auto-created-object":1, "description":"Configure message logging", "properties":{ "log-properties":{ "type":"object", "$ref":"/axapi/v3/acos-events/log-properties", "properties":{ "add-msgid-in-header":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Add Message ID in log messages" }, "enable-8K-tcp-syslog":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable 8K size remote TCP syslog" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "local-logging":{ "type":"object", "$ref":"/axapi/v3/acos-events/local-logging", "properties":{ "enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable local-logging when FW log servers are down (Default: Not enabled)" }, "rate-limit":{ "type":"number", "format":"number", "minimum":1, "maximum":60000, "default":1000, "partition-visibility":"shared", "description":"Configure number of logs per second to be stored in disk (Default: 1000)" }, "max-disk-space":{ "type":"number", "format":"number", "minimum":50, "maximum":20000, "default":100, "partition-visibility":"shared", "description":"Configure Max disk space in MB to be used for storing the logs (Default: 100MB)" }, "delete-old-logs-in-disk":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Operational command to delete the old logs stored in disk" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "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; ", "enum":[ "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" ] } } } ] } } }, "use-partition":{ "type":"object", "$ref":"/axapi/v3/acos-events/use-partition", "properties":{ "partition-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":14, "partition-visibility":"shared", "$ref":"/axapi/v3/partition", "description":"Select partition name for logging" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "rate-limit-remote":{ "type":"object", "$ref":"/axapi/v3/acos-events/rate-limit-remote", "properties":{ "limit":{ "type":"number", "format":"number", "minimum":0, "maximum":250, "default":32, "partition-visibility":"shared", "description":"Configure rate limit for logs sent to remote via classic logging config" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "rate-limit-local":{ "type":"object", "$ref":"/axapi/v3/acos-events/rate-limit-local", "properties":{ "limit":{ "type":"number", "format":"number", "minimum":0, "maximum":100, "default":32, "partition-visibility":"shared", "description":"Configure Rate Limit for Local logs" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "message-id-list":{ "type":"array", "minItems":1, "items":{ "type":"message-id" }, "uniqueItems":true, "$ref":"/axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}", "array":[ { "properties":{ "log-msg":{ "type":"string", "format":"string", "minLength":1, "maxLength":512, "partition-visibility":"shared", "description":"Specify log message-id lineage", "optional":false }, "message-id-scope-route":{ "type":"string", "format":"enum", "default":"log-field-only", "partition-visibility":"shared", "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); ", "enum":[ "all", "node-only", "children-only", "log-field-only" ], "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 }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "property":{ "type":"object", "$ref":"/axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}/property", "properties":{ "severity":{ "type":"object", "$ref":"/axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}/property/severity", "properties":{ "severity-val":{ "type":"string", "format":"enum", "partition-visibility":"shared", "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); ", "enum":[ "emergency", "alert", "critical", "error", "warning", "notification", "information", "debugging" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "log-route":{ "type":"object", "$ref":"/axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}/property/log-route", "properties":{ "log-route-val":{ "type":"string", "format":"enum", "partition-visibility":"shared", "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; ", "enum":[ "local-only", "remote-only", "local-and-remote" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "rate-limit":{ "type":"object", "$ref":"/axapi/v3/acos-events/message-id/{log-msg}+{message-id-scope-route}/property/rate-limit", "properties":{ "rate-limit-val":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'enable': enable rate-limiting of logs; 'disable': disable rate-limiting of logs; ", "enum":[ "enable", "disable" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } } } }, "required":[ "log-msg", "message-id-scope-route" ] } ] }, "message-selector-list":{ "type":"array", "minItems":1, "items":{ "type":"message-selector" }, "uniqueItems":true, "$ref":"/axapi/v3/acos-events/message-selector/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify message selector name", "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 }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "rule-list":{ "type":"array", "minItems":1, "items":{ "type":"rule" }, "uniqueItems":true, "$ref":"/axapi/v3/acos-events/message-selector/{name}/rule/{index}", "array":[ { "properties":{ "index":{ "type":"number", "format":"number", "minimum":1, "maximum":256, "partition-visibility":"shared", "description":"Specify rule index - rules are applied in numeric order", "optional":false }, "action":{ "type":"string", "format":"enum", "default":"send", "partition-visibility":"shared", "description":"'send': log messages selected by this rule will be sent; 'drop': log messages selected by this rule will be dropped; ", "enum":[ "send", "drop" ], "optional":true }, "message-id":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"Select a specific message by message-id and optionally severity", "optional":true }, "message-id-scope":{ "type":"string", "format":"enum", "partition-visibility":"shared", "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; ", "enum":[ "all", "node-only", "children-only", "log-field-only" ], "optional":true }, "severity-oper":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'equal-and-higher': emergency is highest, debugging lowest; 'equal': single severity; ", "enum":[ "equal-and-higher", "equal" ], "optional":true }, "severity-val":{ "type":"string", "format":"enum", "partition-visibility":"shared", "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); ", "enum":[ "emergency", "alert", "critical", "error", "warning", "notification", "information", "debugging" ], "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 } }, "required":[ "index" ] } ] } }, "required":[ "name" ] } ] }, "log-server-list":{ "type":"array", "minItems":1, "items":{ "type":"log-server" }, "uniqueItems":true, "$ref":"/axapi/v3/acos-events/log-server/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Server Name", "optional":false }, "server-ipv6-addr":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "modify-not-allowed":1, "description":"IPV6 address", "optional":true }, "host":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "modify-not-allowed":1, "description":"IP Address", "optional":true }, "resolve-as":{ "type":"string", "format":"enum", "default":"resolve-to-ipv4", "partition-visibility":"shared", "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; ", "enum":[ "resolve-to-ipv4", "resolve-to-ipv6", "resolve-to-ipv4-and-ipv6" ], "optional":true }, "action":{ "type":"string", "format":"enum", "default":"enable", "partition-visibility":"shared", "description":"'enable': Enable this Logging Server; 'disable': Disable this Logging Server; ", "enum":[ "enable", "disable" ], "optional":true }, "health-check":{ "type":"string", "format":"string", "minLength":1, "maxLength":31, "partition-visibility":"shared", "$ref":"/axapi/v3/health/monitor", "not":"health-check-disable", "description":"Health Check Monitor (Health monitor name)", "optional":true }, "health-check-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"health-check", "description":"Disable configured health check configuration", "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; ", "enum":[ "all", "msgs_sent" ] } } } ] }, "port-list":{ "type":"array", "minItems":1, "items":{ "type":"port" }, "uniqueItems":true, "$ref":"/axapi/v3/acos-events/log-server/{name}/port/{port-number}+{protocol}", "array":[ { "properties":{ "port-number":{ "type":"number", "format":"number", "minimum":0, "maximum":65534, "partition-visibility":"shared", "description":"Port Number", "optional":false }, "protocol":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'tcp': TCP Port; 'udp': UDP Port; ", "enum":[ "tcp", "udp" ], "optional":false }, "action":{ "type":"string", "format":"enum", "default":"enable", "partition-visibility":"shared", "description":"'enable': enable; 'disable': disable; ", "enum":[ "enable", "disable" ], "optional":true }, "health-check":{ "type":"string", "format":"string", "minLength":1, "maxLength":31, "partition-visibility":"shared", "$ref":"/axapi/v3/health/monitor", "not":"health-check-disable", "description":"Health Check (Monitor Name)", "optional":true }, "health-check-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"health-check", "description":"Disable health check", "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; ", "enum":[ "all", "msgs_sent" ] } } } ] } }, "required":[ "port-number", "protocol" ] } ] } }, "required":[ "name" ] } ] }, "collector-group-list":{ "type":"array", "minItems":1, "items":{ "type":"collector-group" }, "uniqueItems":true, "$ref":"/axapi/v3/acos-events/collector-group/{name}", "array":[ { "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" ] } ] } }, "required":[ "name" ] } ] }, "template-list":{ "type":"array", "minItems":1, "items":{ "type":"template" }, "uniqueItems":true, "$ref":"/axapi/v3/acos-events/template/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify logging template name", "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 }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "message-selector-list":{ "type":"array", "minItems":1, "items":{ "type":"message-selector" }, "uniqueItems":true, "$ref":"/axapi/v3/acos-events/template/{name}/message-selector/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/acos-events/message-selector", "description":"Specify the message selector name", "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 }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "collector-group-list":{ "type":"array", "minItems":1, "items":{ "type":"collector-group" }, "uniqueItems":true, "$ref":"/axapi/v3/acos-events/template/{name}/message-selector/{name}/collector-group/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/acos-events/collector-group", "description":"Specify the log server group for receiving log messages", "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 }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true } }, "required":[ "name" ] } ] } }, "required":[ "name" ] } ] } }, "required":[ "name" ] } ] }, "active-template":{ "type":"object", "$ref":"/axapi/v3/acos-events/active-template", "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/acos-events/template", "description":"Specify the logging template name" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "messages":{ "type":"object", "$ref":"/axapi/v3/acos-events/messages", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "logdb":{ "type":"object", "$ref":"/axapi/v3/acos-events/logdb", "properties":{ "enable-all":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable logging for all widgets" }, "enable-ssli":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable SSLi logging" }, "enable-smtp":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable SMTP logging" }, "enable-mqtt":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable MQTT logging" }, "enable-fw":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable Firewall logging" }, "enable-http-forward-proxy":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable HTTP forward proxy logging" }, "enable-link-cost":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable link-cost logging" }, "enable-cgn":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable CGN logging" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "statistics":{ "type":"object", "$ref":"/axapi/v3/acos-events/statistics", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "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; ", "enum":[ "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" ] } } } ] } } }, "log-parameterization":{ "type":"object", "$ref":"/axapi/v3/acos-events/log-parameterization", "properties":{ "log-rate":{ "type":"number", "format":"number", "minimum":0, "maximum":10000, "default":10, "partition-visibility":"shared", "description":"Max number of parameterized logs sent per second" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "message-selector":{ "type":"object", "$ref":"/axapi/v3/acos-events/log-parameterization/message-selector", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "rule-list":{ "type":"array", "minItems":1, "items":{ "type":"rule" }, "uniqueItems":true, "$ref":"/axapi/v3/acos-events/log-parameterization/message-selector/rule/{index}", "array":[ { "properties":{ "index":{ "type":"number", "format":"number", "minimum":1, "maximum":256, "partition-visibility":"shared", "description":"Specify rule index - rules are applied in numeric order", "optional":false }, "action":{ "type":"string", "format":"enum", "default":"send", "partition-visibility":"shared", "description":"'send': log messages selected by this rule will be sent (Default); 'drop': log messages selected by this rule will be dropped; ", "enum":[ "send", "drop" ], "optional":true }, "message-id":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"Select a specific message by message-id and optionally severity", "optional":true }, "message-id-scope":{ "type":"string", "format":"enum", "partition-visibility":"shared", "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; ", "enum":[ "all", "node-only", "children-only", "log-field-only" ], "optional":true }, "severity-oper":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'equal-and-higher': emergency is highest, debugging lowest; 'equal': single severity; ", "enum":[ "equal-and-higher", "equal" ], "optional":true }, "severity-val":{ "type":"string", "format":"enum", "partition-visibility":"shared", "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); ", "enum":[ "emergency", "alert", "critical", "error", "warning", "notification", "information", "debugging" ], "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 } }, "required":[ "index" ] } ] } } } } } } }