{ "id":"/axapi/v3/visibility", "type":"object", "node-type":"scalar", "title":"visibility", "auto-created-object":1, "description":"Display Network statistics", "properties":{ "granularity":{ "type":"number", "format":"number", "minimum":1, "maximum":300, "default":5, "description":"Granularity for rate based calculations in seconds (default 5)", "optional":true }, "initial-learning-interval":{ "type":"number", "format":"number", "minimum":1, "maximum":168, "description":"Initial learning interval (in hours) before processing", "optional":true }, "source-entity-topk":{ "type":"number", "format":"flag", "default":0, "description":"Enable topk for sources", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "mon-entity-telemetry-data":{ "type":"object", "$ref":"/axapi/v3/visibility/mon-entity-telemetry-data", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "debug-files":{ "type":"object", "$ref":"/axapi/v3/visibility/debug-files", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "topk":{ "type":"object", "$ref":"/axapi/v3/visibility/topk", "properties":{ "sources":{ "type":"object", "$ref":"/axapi/v3/visibility/topk/sources", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } } }, "monitored-entity":{ "type":"object", "$ref":"/axapi/v3/visibility/monitored-entity", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" }, "detail":{ "type":"object", "$ref":"/axapi/v3/visibility/monitored-entity/detail", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" }, "debug":{ "type":"object", "$ref":"/axapi/v3/visibility/monitored-entity/detail/debug", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } } }, "sessions":{ "type":"object", "$ref":"/axapi/v3/visibility/monitored-entity/sessions", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "topk":{ "type":"object", "$ref":"/axapi/v3/visibility/monitored-entity/topk", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" }, "sources":{ "type":"object", "$ref":"/axapi/v3/visibility/monitored-entity/topk/sources", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } } }, "secondary":{ "type":"object", "$ref":"/axapi/v3/visibility/monitored-entity/secondary", "properties":{ "topk":{ "type":"object", "$ref":"/axapi/v3/visibility/monitored-entity/secondary/topk", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" }, "sources":{ "type":"object", "$ref":"/axapi/v3/visibility/monitored-entity/secondary/topk/sources", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } } } } } } }, "file":{ "type":"object", "$ref":"/axapi/v3/visibility/file", "properties":{ "metrics":{ "type":"object", "$ref":"/axapi/v3/visibility/file/metrics", "properties":{ "action":{ "type":"string", "format":"enum", "default":"enable", "description":"'enable': Enable persistent storage(default); 'disable': Disable persistent storage; ", "enum":[ "enable", "disable" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } } }, "reporting":{ "type":"object", "$ref":"/axapi/v3/visibility/reporting", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" }, "telemetry-export-interval":{ "type":"object", "$ref":"/axapi/v3/visibility/reporting/telemetry-export-interval", "properties":{ "value":{ "type":"number", "format":"number", "minimum":1, "maximum":5, "default":5, "description":"Monitored entity telemetry data export interval in mins (Default 5 mins)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "grouping-export-interval":{ "type":"object", "$ref":"/axapi/v3/visibility/reporting/grouping-export-interval", "properties":{ "value":{ "type":"number", "format":"number", "minimum":10, "maximum":300, "default":30, "description":"The aggregation and exporting interval in seconds (Default 30 seconds)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "template":{ "type":"object", "$ref":"/axapi/v3/visibility/reporting/template", "properties":{ "notification":{ "type":"object", "$ref":"/axapi/v3/visibility/reporting/template/notification", "properties":{ "template-name-list":{ "type":"array", "minItems":1, "items":{ "type":"template-name" }, "uniqueItems":true, "$ref":"/axapi/v3/visibility/reporting/template/notification/template-name/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "description":"Notification template name", "optional":false }, "ipv4-address":{ "type":"string", "format":"ipv4-address", "not-list":[ "ipv6-address", "host-name" ], "description":"Configure the host IPv4 address", "optional":true }, "ipv6-address":{ "type":"string", "format":"ipv6-address", "not-list":[ "ipv4-address", "host-name" ], "description":"Configure the host IPv6 address", "optional":true }, "host-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "not-list":[ "ipv4-address", "ipv6-address" ], "description":"Configure the host name(e.g www.a10networks.com)", "optional":true }, "use-mgmt-port":{ "type":"number", "format":"flag", "default":0, "description":"Use management port for notifications", "optional":true }, "protocol":{ "type":"string", "format":"enum", "default":"https", "description":"'http': Use http protocol; 'https': Use https protocol(default); (http protocol)", "enum":[ "http", "https" ], "optional":true }, "http-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":80, "description":"Configure the http port to use(default 80) (http port(default 80))", "optional":true }, "https-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":443, "description":"Configure the https port to use(default 443) (http port(default 443))", "optional":true }, "relative-uri":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "default":"/", "description":"Configure the relative uri(e.g /example , default /)", "optional":true }, "action":{ "type":"string", "format":"enum", "default":"enable", "description":"'enable': Enable; 'disable': Disable; ", "enum":[ "enable", "disable" ], "optional":true }, "debug-mode":{ "type":"number", "format":"flag", "default":0, "description":"Enable debug mode", "optional":true }, "test-connectivity":{ "type":"number", "format":"flag", "default":0, "description":"Test connectivity to notification receiver", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "authentication":{ "type":"object", "$ref":"/axapi/v3/visibility/reporting/template/notification/template-name/{name}/authentication", "properties":{ "relative-login-uri":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Configure the authentication login uri" }, "relative-logoff-uri":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "description":"Configure the authentication logoff uri" }, "auth-username":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "description":"Configure the authentication user name" }, "auth-password":{ "type":"number", "format":"flag", "default":0, "description":"Configure the authentication user password (Authentication password)" }, "auth-password-string":{ "type":"string", "format":"password", "minLength":1, "maxLength":63, "description":"Configure the authentication user password (Authentication password)" }, "encrypted":{ "type":"encrypted", "format":"encrypted", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)" }, "api-key":{ "type":"number", "format":"flag", "default":0, "description":"Configure api-key as a mode of authentication" }, "api-key-string":{ "type":"string", "format":"password", "minLength":1, "maxLength":64, "description":"Configure api-key as a mode of authentication" }, "api-key-encrypted":{ "type":"encrypted", "format":"encrypted", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } }, "required":[ "name" ] } ] }, "debug":{ "type":"object", "$ref":"/axapi/v3/visibility/reporting/template/notification/debug", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } } } } } } }, "monitor":{ "type":"object", "$ref":"/axapi/v3/visibility/monitor", "properties":{ "primary-monitor":{ "type":"string", "format":"enum", "modify-not-allowed":1, "description":"'xflow': Monitor xflow samples; ", "enum":[ "xflow" ] }, "monitor-key":{ "type":"string", "format":"enum", "modify-not-allowed":1, "description":"'dest': Monitor traffic to any destination; 'service': Monitor traffic to any service; ", "enum":[ "dest", "service" ] }, "mon-entity-topk":{ "type":"number", "format":"flag", "default":0, "description":"Enable topk for primary entities" }, "source-entity-topk":{ "type":"number", "format":"flag", "default":0, "description":"Enable topk for sources to primary-entities" }, "v4-class-list":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "$ref":"/axapi/v3/class-list", "description":"Class list of ipv4 addresses to be monitored" }, "v4-grouping":{ "type":"number", "format":"flag", "default":0, "description":"Enable aggregate the log and notification per class-list" }, "v6-class-list":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "$ref":"/axapi/v3/class-list", "description":"Class list of ipv6 addresses to be monitored" }, "v6-grouping":{ "type":"number", "format":"flag", "default":0, "description":"Enable aggregate the log and notification per class-list" }, "template":{ "type":"object", "properties":{ "notification":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "notif-template-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "$ref":"/axapi/v3/visibility/reporting/template/notification/template-name" }, "optional":true } } ] } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" }, "port-scan-filter-settings":{ "type":"object", "$ref":"/axapi/v3/visibility/monitor/port-scan-filter-settings", "properties":{ "pkt-rate-threshold":{ "type":"number", "format":"number", "minimum":0, "maximum":255, "default":10, "description":"packet rate threshold for the filter (default 10 pkts/sec, set to 0 pkts/sec to disable the feature)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "sflow":{ "type":"object", "$ref":"/axapi/v3/visibility/monitor/sflow", "properties":{ "listening-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":6343, "description":"sFlow port to receive packets (sFlow port number(default 6343))" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "netflow":{ "type":"object", "$ref":"/axapi/v3/visibility/monitor/netflow", "properties":{ "listening-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":9996, "description":"Netflow port to receive packets (Netflow port number(default 9996))" }, "template-active-timeout":{ "type":"number", "format":"number", "minimum":2, "maximum":300, "default":30, "description":"Configure active timeout of the netflow templates received in mins (Template active timeout(mins)(default 30mins))" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "debug-list":{ "type":"array", "minItems":1, "items":{ "type":"debug" }, "uniqueItems":true, "$ref":"/axapi/v3/visibility/monitor/debug/{debug-ip-addr}+{debug-port}+{debug-protocol}", "array":[ { "properties":{ "debug-ip-addr":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Specify source/dest ip addr", "optional":false }, "debug-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Specify port", "optional":false }, "debug-protocol":{ "type":"string", "format":"enum", "description":"'TCP': TCP; 'UDP': UDP; 'ICMP': ICMP; ", "enum":[ "TCP", "UDP", "ICMP" ], "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "debug-ip-addr", "debug-port", "debug-protocol" ] } ] }, "replay-debug-file":{ "type":"object", "$ref":"/axapi/v3/visibility/monitor/replay-debug-file/{debug-ip-addr}", "properties":{ "debug-ip-addr":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Specify source/dest ip addr" }, "debug-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Specify port" }, "debug-protocol":{ "type":"string", "format":"enum", "description":"'TCP': TCP; 'UDP': UDP; 'ICMP': ICMP; ", "enum":[ "TCP", "UDP", "ICMP" ] } }, "required":[ "debug-ip-addr" ] }, "delete-debug-file":{ "type":"object", "$ref":"/axapi/v3/visibility/monitor/delete-debug-file/{debug-ip-addr}", "properties":{ "debug-ip-addr":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Specify source/dest ip addr" }, "debug-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Specify port" }, "debug-protocol":{ "type":"string", "format":"enum", "description":"'TCP': TCP; 'UDP': UDP; 'ICMP': ICMP; ", "enum":[ "TCP", "UDP", "ICMP" ] } }, "required":[ "debug-ip-addr" ] }, "secondary-monitor":{ "type":"object", "$ref":"/axapi/v3/visibility/monitor/secondary-monitor", "properties":{ "secondary-monitoring-key":{ "type":"string", "format":"enum", "description":"'service': Monitor traffic to any service; ", "enum":[ "service" ] }, "mon-entity-topk":{ "type":"number", "format":"flag", "default":0, "description":"Enable topk for secondary entities" }, "source-entity-topk":{ "type":"number", "format":"flag", "default":0, "description":"Enable topk for sources to secondary-entities" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" }, "debug-list":{ "type":"array", "minItems":1, "items":{ "type":"debug" }, "uniqueItems":true, "$ref":"/axapi/v3/visibility/monitor/secondary-monitor/debug/{debug-ip-addr}+{debug-port}+{debug-protocol}", "array":[ { "properties":{ "debug-ip-addr":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Specify source/dest ip addr", "optional":false }, "debug-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Specify port", "optional":false }, "debug-protocol":{ "type":"string", "format":"enum", "description":"'TCP': TCP; 'UDP': UDP; 'ICMP': ICMP; ", "enum":[ "TCP", "UDP", "ICMP" ], "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "debug-ip-addr", "debug-port", "debug-protocol" ] } ] }, "delete-debug-file":{ "type":"object", "$ref":"/axapi/v3/visibility/monitor/secondary-monitor/delete-debug-file/{debug-ip-addr}", "properties":{ "debug-ip-addr":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Specify source/dest ip addr" }, "debug-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Specify port" }, "debug-protocol":{ "type":"string", "format":"enum", "description":"'TCP': TCP; 'UDP': UDP; 'ICMP': ICMP; ", "enum":[ "TCP", "UDP", "ICMP" ] } }, "required":[ "debug-ip-addr" ] }, "replay-debug-file":{ "type":"object", "$ref":"/axapi/v3/visibility/monitor/secondary-monitor/replay-debug-file/{debug-ip-addr}", "properties":{ "debug-ip-addr":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "description":"Specify source/dest ip addr" }, "debug-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "description":"Specify port" }, "debug-protocol":{ "type":"string", "format":"enum", "description":"'TCP': TCP; 'UDP': UDP; 'ICMP': ICMP; ", "enum":[ "TCP", "UDP", "ICMP" ] } }, "required":[ "debug-ip-addr" ] } } } } }, "anomaly-detection":{ "type":"object", "$ref":"/axapi/v3/visibility/anomaly-detection", "properties":{ "sensitivity":{ "type":"string", "format":"enum", "default":"low", "description":"'high': Highly sensitive anomaly detection. Can lead to false positives; 'low': Low sensitivity anomaly detection. Can cause delay in detection and might not detect certain attacks. (default); ", "enum":[ "high", "low" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "flow-collector":{ "type":"object", "$ref":"/axapi/v3/visibility/flow-collector", "properties":{ "sflow":{ "type":"object", "$ref":"/axapi/v3/visibility/flow-collector/sflow", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "netflow":{ "type":"object", "$ref":"/axapi/v3/visibility/flow-collector/netflow", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" }, "template":{ "type":"object", "$ref":"/axapi/v3/visibility/flow-collector/netflow/template", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" }, "detail":{ "type":"object", "$ref":"/axapi/v3/visibility/flow-collector/netflow/template/detail", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } } } } } } }, "resource-usage":{ "type":"object", "$ref":"/axapi/v3/visibility/resource-usage", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "zbar":{ "type":"object", "$ref":"/axapi/v3/visibility/zbar", "properties":{ "action":{ "type":"string", "format":"enum", "default":"disable", "description":"'enable': Enable zbar infra; 'disable': Disable zbar infra(default); ", "enum":[ "enable", "disable" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" }, "dest":{ "type":"object", "$ref":"/axapi/v3/visibility/zbar/dest", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } }, "truples":{ "type":"object", "$ref":"/axapi/v3/visibility/zbar/truples", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "modify-not-allowed":1, "description":"uuid of the object" } } } } } } }