{ "id":"/axapi/v3/visibility", "type":"object", "node-type":"scalar", "title":"visibility", "partition-visibility":"shared", "auto-created-object":1, "description":"Display Network statistics", "properties":{ "granularity":{ "type":"number", "format":"number", "minimum":1, "maximum":300, "default":5, "partition-visibility":"shared", "description":"Granularity for rate based calculations in seconds (default 5)", "optional":true }, "initial-learning-interval":{ "type":"number", "format":"number", "minimum":1, "maximum":168, "partition-visibility":"shared", "description":"Initial learning interval (in hours) before processing", "optional":true }, "source-entity-topk":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable topk for sources", "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 }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'mon-entity-limit-exceed': Total monitor entity limit exceed failures; 'ha-entity-create-sent': Total montior entity HA create messages sent; 'ha-entity-delete-sent': Total montior entity HA delete messages sent; 'ha-entity-anomaly-on-sent': Total anomaly on HA messages sent; 'ha-entity-anomaly-off-sent': Total anomaly off HA messages sent; 'ha-entity-periodic-sync-sent': Total monitor entity periodic sync messages sent; 'out-of-memory-alloc-failures': Out of memory allocation failures; 'lw-mon-entity-created': Total Light-weight entities created; 'lw-mon-entity-deleted': Total Light-weight entities deleted; 'lw-mon-entity-limit-exceed': Light weight limit exceeded errors; 'lw-out-of-memory-alloc-failures': Light Weight Out-of-memory allocation failures; 'mon-entity-rrd-file-timestamp-err': Total monitor entity rrd file timestamp errors; 'mon-entity-rrd-update-err': Total monitor entity rrd update error; 'mon-entity-rrd-last-update-fetch-failed-err': Total monitor entity rrd last update fetch failed error; 'mon-entity-rrd-tune-err': Total monitor entity rrd tune error; 'mon-entity-rrd-out-of-memory-err': Total monitor entity rrd load failed, out of memory error; 'mon-entity-rrd-file-create-err': Total monitor entity rrd file create error; ", "enum":[ "all", "mon-entity-limit-exceed", "ha-entity-create-sent", "ha-entity-delete-sent", "ha-entity-anomaly-on-sent", "ha-entity-anomaly-off-sent", "ha-entity-periodic-sync-sent", "out-of-memory-alloc-failures", "lw-mon-entity-created", "lw-mon-entity-deleted", "lw-mon-entity-limit-exceed", "lw-out-of-memory-alloc-failures", "mon-entity-rrd-file-timestamp-err", "mon-entity-rrd-update-err", "mon-entity-rrd-last-update-fetch-failed-err", "mon-entity-rrd-tune-err", "mon-entity-rrd-out-of-memory-err", "mon-entity-rrd-file-create-err" ] }, "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, "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; 'in_pkts': Monitored Entity telemetry Metric IN pkts; 'out_pkts': Monitored Entity telemetry Metric OUT pkts; 'in_bytes': Monitored Entity telemetry Metric IN bytes; 'out_bytes': Monitored Entity telemetry Metric OUT bytes; 'errors': Monitored Entity telemetry Metric ERRORS; 'in_small_pkt': Monitored Entity telemetry Metric IN SMALL pkt; 'in_frag': Monitored Entity telemetry Metric IN frag; 'out_small_pkt': Monitored Entity telemetry Metric OUT SMALL pkt; 'out_frag': Monitored Entity telemetry Metric OUT frag; 'new-conn': Monitored Entity telemetry Metric New Sessions; 'concurrent-conn': concurrent-conn; 'in_bytes_per_out_bytes': Monitored Entity telemetry Metric IN bytes per OUT bytes; 'drop_pkts_per_pkts': Monitored Entity telemetry Metric Drop pkts per pkts; 'tcp_in_syn': Monitored Entity telemetry Metric TCP IN syn; 'tcp_out_syn': Monitored Entity telemetry Metric TCP OUT syn; 'tcp_in_fin': Monitored Entity telemetry Metric TCP IN fin; 'tcp_out_fin': Monitored Entity telemetry Metric TCP OUT fin; 'tcp_in_payload': Monitored Entity telemetry Metric TCP IN payload; 'tcp_out_payload': Monitored Entity telemetry Metric TCP OUT payload; 'tcp_in_rexmit': Monitored Entity telemetry Metric TCP IN rexmit; 'tcp_out_rexmit': Monitored Entity telemetry Metric TCP OUT rexmit; 'tcp_in_rst': Monitored Entity telemetry Metric TCP IN rst; 'tcp_out_rst': Monitored Entity telemetry Metric TCP OUT rst; 'tcp_in_empty_ack': Monitored Entity telemetry Metric TCP_IN EMPTY ack; 'tcp_out_empty_ack': Monitored Entity telemetry Metric TCP OUT EMPTY ack; 'tcp_in_zero_wnd': Monitored Entity telemetry Metric TCP IN ZERO wnd; 'tcp_out_zero_wnd': Monitored Entity telemetry Metric TCP OUT ZERO wnd; 'tcp_fwd_syn_per_fin': Monitored Entity telemetry Metric TCP FWD SYN per FIN; ", "enum":[ "all", "in_pkts", "out_pkts", "in_bytes", "out_bytes", "errors", "in_small_pkt", "in_frag", "out_small_pkt", "out_frag", "new-conn", "concurrent-conn", "in_bytes_per_out_bytes", "drop_pkts_per_pkts", "tcp_in_syn", "tcp_out_syn", "tcp_in_fin", "tcp_out_fin", "tcp_in_payload", "tcp_out_payload", "tcp_in_rexmit", "tcp_out_rexmit", "tcp_in_rst", "tcp_out_rst", "tcp_in_empty_ack", "tcp_out_empty_ack", "tcp_in_zero_wnd", "tcp_out_zero_wnd", "tcp_fwd_syn_per_fin" ] }, "optional":true } } ] } } }, "debug-files":{ "type":"object", "$ref":"/axapi/v3/visibility/debug-files", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "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, "partition-visibility":"shared", "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, "partition-visibility":"shared", "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, "partition-visibility":"shared", "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, "partition-visibility":"shared", "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, "partition-visibility":"shared", "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, "partition-visibility":"shared", "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, "partition-visibility":"shared", "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, "partition-visibility":"shared", "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, "partition-visibility":"shared", "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", "partition-visibility":"shared", "description":"'enable': Enable persistent storage(default); 'disable': Disable persistent storage; ", "enum":[ "enable", "disable" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "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, "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; 'log-transmit-failure': Total log transmit failures; 'buffer-alloc-failure': Total reporting buffer allocation failures; 'notif-jobs-in-queue': Total notification jobs in queue; 'enqueue-fail': Total enqueue jobs failed; 'enqueue-pass': Total enqueue jobs passed; 'dequeued': Total jobs dequeued; ", "enum":[ "all", "log-transmit-failure", "buffer-alloc-failure", "notif-jobs-in-queue", "enqueue-fail", "enqueue-pass", "dequeued" ] }, "optional":true } } ] }, "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, "partition-visibility":"shared", "description":"Monitored entity telemetry data export interval in mins (Default 5 mins)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "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, "partition-visibility":"shared", "description":"Notification template name", "optional":false }, "ipv4-address":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "not-list":[ "ipv6-address", "host-name" ], "description":"Configure the host IPv4 address", "optional":true }, "ipv6-address":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "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, "partition-visibility":"shared", "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, "partition-visibility":"shared", "description":"Use management port for notifications", "optional":true }, "protocol":{ "type":"string", "format":"enum", "default":"https", "partition-visibility":"shared", "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, "partition-visibility":"shared", "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, "partition-visibility":"shared", "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":"/", "partition-visibility":"shared", "description":"Configure the relative uri(e.g /example , default /)", "optional":true }, "action":{ "type":"string", "format":"enum", "default":"enable", "partition-visibility":"shared", "description":"'enable': Enable; 'disable': Disable; ", "enum":[ "enable", "disable" ], "optional":true }, "debug-mode":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable debug mode", "optional":true }, "test-connectivity":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Test connectivity to notification receiver", "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 }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'sent_successful': Sent successful; 'send_fail': Send failures; 'response_fail': Response failures; ", "enum":[ "all", "sent_successful", "send_fail", "response_fail" ] }, "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, "partition-visibility":"shared", "description":"Configure the authentication login uri" }, "relative-logoff-uri":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Configure the authentication logoff uri" }, "auth-username":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Configure the authentication user name" }, "auth-password":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure the authentication user password (Authentication password)" }, "auth-password-string":{ "type":"string", "format":"password", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Configure the authentication user password (Authentication password)" }, "encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "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, "partition-visibility":"shared", "description":"Configure api-key as a mode of authentication" }, "api-key-string":{ "type":"string", "format":"password", "minLength":1, "maxLength":64, "partition-visibility":"shared", "description":"Configure api-key as a mode of authentication" }, "api-key-encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "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, "partition-visibility":"shared", "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, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } } } } } } }, "monitor":{ "type":"object", "$ref":"/axapi/v3/visibility/monitor", "properties":{ "primary-monitor":{ "type":"string", "format":"enum", "partition-visibility":"shared", "modify-not-allowed":1, "description":"'traffic': Mointor traffic; ", "enum":[ "traffic" ] }, "monitor-key":{ "type":"string", "format":"enum", "partition-visibility":"shared", "modify-not-allowed":1, "description":"'source': Monitor traffic from all sources; 'dest': Monitor traffic to any destination; 'service': Monitor traffic to any service; 'source-nat-ip': Monitor traffic to all source nat IPs; ", "enum":[ "source", "dest", "service", "source-nat-ip" ] }, "mon-entity-topk":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable topk for primary entities" }, "source-entity-topk":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable topk for sources to primary-entities" }, "index-sessions":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Start indexing associated sessions" }, "index-sessions-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'per-cpu': Use per cpu list; ", "enum":[ "per-cpu" ] }, "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, "partition-visibility":"shared", "$ref":"/axapi/v3/visibility/reporting/template/notification/template-name" }, "optional":true } } ] } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "agent-list":{ "type":"array", "minItems":1, "items":{ "type":"agent" }, "uniqueItems":true, "$ref":"/axapi/v3/visibility/monitor/agent/{agent-name}", "array":[ { "properties":{ "agent-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify name for the agent", "optional":false }, "agent-v4-addr":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"Configure agent's IPv4 address", "optional":true }, "agent-v6-addr":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "description":"Configure agent's IPv6 address", "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; 'sflow-packets-received': sFlow Packets Received; 'sflow-samples-received': sFlow Samples Received; 'sflow-samples-bad-len': sFlow Samples Bad Length; 'sflow-samples-non-std': sFlow Samples Non-standard; 'sflow-samples-skipped': sFlow Samples Skipped; 'sflow-sample-record-bad-len': sFlow Sample Records Bad Length; 'sflow-samples-sent-for-detection': sFlow Samples Processed For Detection; 'sflow-sample-record-invalid-layer2': sFlow Sample Records Unknown Layer-2; 'sflow-sample-ipv6-hdr-parse-fail': sFlow Sample IPv6 Record Header Parse Failures; 'sflow-disabled': sFlow Packet Samples Processing Disabled; 'netflow-disabled': Netflow Flow Samples Processing Disabled; 'netflow-v5-packets-received': Netflow v5 Packets Received; 'netflow-v5-samples-received': Netflow v5 Samples Received; 'netflow-v5-samples-sent-for-detection': Netflow v5 Samples Processed For Detection; 'netflow-v5-sample-records-bad-len': Netflow v5 Sample Records Bad Length; 'netflow-v5-max-records-exceed': Netflow v5 Sample Max Records Error; 'netflow-v9-packets-received': Netflow v9 Packets Received; 'netflow-v9-samples-received': Netflow v9 Samples Received; 'netflow-v9-samples-sent-for-detection': Netflow v9 Samples Processed For Detection; 'netflow-v9-sample-records-bad-len': Netflow v9 Sample Records Bad Length; 'netflow-v9-max-records-exceed': Netflow v9 Sample Max Records Error; 'netflow-v10-packets-received': Netflow v10 Packets Received; 'netflow-v10-samples-received': Netflow v10 Samples Received; 'netflow-v10-samples-sent-for-detection': Netflow v10 Samples Procssed For Detection; 'netflow-v10-sample-records-bad-len': Netflow v10 Sample Records Bad Length; 'netflow-v10-max-records-exceed': Netflow v10 Sample Max records Error; 'netflow-tcp-sample-received': Netflow TCP Samples Received; 'netflow-udp-sample-received': Netflow UDP Samples received; 'netflow-icmp-sample-received': Netflow ICMP Samples Received; 'netflow-other-sample-received': Netflow OTHER Samples Received; 'netflow-record-copy-oom-error': Netflow Data Record Copy Fail OOM; 'netflow-record-rse-invalid': Netflow Data Record Reduced Size Invalid; 'netflow-sample-flow-dur-error': Netflow Sample Flow Duration Error; ", "enum":[ "all", "sflow-packets-received", "sflow-samples-received", "sflow-samples-bad-len", "sflow-samples-non-std", "sflow-samples-skipped", "sflow-sample-record-bad-len", "sflow-samples-sent-for-detection", "sflow-sample-record-invalid-layer2", "sflow-sample-ipv6-hdr-parse-fail", "sflow-disabled", "netflow-disabled", "netflow-v5-packets-received", "netflow-v5-samples-received", "netflow-v5-samples-sent-for-detection", "netflow-v5-sample-records-bad-len", "netflow-v5-max-records-exceed", "netflow-v9-packets-received", "netflow-v9-samples-received", "netflow-v9-samples-sent-for-detection", "netflow-v9-sample-records-bad-len", "netflow-v9-max-records-exceed", "netflow-v10-packets-received", "netflow-v10-samples-received", "netflow-v10-samples-sent-for-detection", "netflow-v10-sample-records-bad-len", "netflow-v10-max-records-exceed", "netflow-tcp-sample-received", "netflow-udp-sample-received", "netflow-icmp-sample-received", "netflow-other-sample-received", "netflow-record-copy-oom-error", "netflow-record-rse-invalid", "netflow-sample-flow-dur-error" ] }, "optional":true } } ] } }, "required":[ "agent-name" ] } ] }, "sflow":{ "type":"object", "$ref":"/axapi/v3/visibility/monitor/sflow", "properties":{ "listening-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":6343, "partition-visibility":"shared", "description":"sFlow port to receive packets (sFlow port number(default 6343))" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "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, "partition-visibility":"shared", "description":"Netflow port to receive packets (Netflow port number(default 9996))" }, "template-active-timeout":{ "type":"number", "format":"number", "minimum":2, "maximum":300, "default":30, "partition-visibility":"shared", "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, "partition-visibility":"shared", "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, "partition-visibility":"shared", "description":"Specify source/dest ip addr", "optional":false }, "debug-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Specify port", "optional":false }, "debug-protocol":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'TCP': TCP; 'UDP': UDP; 'ICMP': ICMP; ", "enum":[ "TCP", "UDP", "ICMP" ], "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":[ "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, "partition-visibility":"shared", "description":"Specify source/dest ip addr" }, "debug-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Specify port" }, "debug-protocol":{ "type":"string", "format":"enum", "partition-visibility":"shared", "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, "partition-visibility":"shared", "description":"Specify source/dest ip addr" }, "debug-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Specify port" }, "debug-protocol":{ "type":"string", "format":"enum", "partition-visibility":"shared", "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", "partition-visibility":"shared", "description":"'service': Monitor traffic to any service; ", "enum":[ "service" ] }, "mon-entity-topk":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable topk for secondary entities" }, "source-entity-topk":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable topk for sources to secondary-entities" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "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, "partition-visibility":"shared", "description":"Specify source/dest ip addr", "optional":false }, "debug-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Specify port", "optional":false }, "debug-protocol":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'TCP': TCP; 'UDP': UDP; 'ICMP': ICMP; ", "enum":[ "TCP", "UDP", "ICMP" ], "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":[ "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, "partition-visibility":"shared", "description":"Specify source/dest ip addr" }, "debug-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Specify port" }, "debug-protocol":{ "type":"string", "format":"enum", "partition-visibility":"shared", "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, "partition-visibility":"shared", "description":"Specify source/dest ip addr" }, "debug-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Specify port" }, "debug-protocol":{ "type":"string", "format":"enum", "partition-visibility":"shared", "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", "partition-visibility":"shared", "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" ] }, "feature-status":{ "type":"string", "format":"enum", "default":"disable", "partition-visibility":"shared", "description":"'enable': Enable anomaly-detection; 'disable': Disable anomaly detection (default); ", "enum":[ "enable", "disable" ] }, "logging":{ "type":"string", "format":"enum", "default":"disable", "partition-visibility":"shared", "description":"'per-entity': Enable per entity logging; 'per-metric': Enable per metric logging with threshold details; 'disable': Disable anomaly notifications (Default); ", "enum":[ "per-entity", "per-metric", "disable" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "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, "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; 'pkts-received': Total sflow pkts received; 'frag-dropped': Total sflow fragment packets droppped; 'agent-not-found': sflow pkts from not configured agents; 'version-not-supported': sflow version not supported; 'unknown-dir': sflow sample direction is unknown; ", "enum":[ "all", "pkts-received", "frag-dropped", "agent-not-found", "version-not-supported", "unknown-dir" ] }, "optional":true } } ] } } }, "netflow":{ "type":"object", "$ref":"/axapi/v3/visibility/flow-collector/netflow", "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; 'pkts-rcvd': Total nflow packets received; 'v9-templates-created': Total v9 templates created; 'v9-templates-deleted': Total v9 templates deleted; 'v10-templates-created': Total v10(IPFIX) templates created; 'v10-templates-deleted': Total v10(IPFIX) templates deleted; 'template-drop-exceeded': Total templates dropped because of maximum limit; 'template-drop-out-of-memory': Total templates dropped becuase of out of memory; 'frag-dropped': Total nflow fragment packets droppped; 'agent-not-found': nflow pkts from not configured agents; 'version-not-supported': nflow version not supported; 'unknown-dir': nflow sample direction is unknown; ", "enum":[ "all", "pkts-rcvd", "v9-templates-created", "v9-templates-deleted", "v10-templates-created", "v10-templates-deleted", "template-drop-exceeded", "template-drop-out-of-memory", "frag-dropped", "agent-not-found", "version-not-supported", "unknown-dir" ] }, "optional":true } } ] }, "template":{ "type":"object", "$ref":"/axapi/v3/visibility/flow-collector/netflow/template", "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; 'templates-added-to-delq': Netflow templates added to the delete queue; 'templates-removed-from-delq': Netflow templates removed from the delete queue; ", "enum":[ "all", "templates-added-to-delq", "templates-removed-from-delq" ] }, "optional":true } } ] }, "detail":{ "type":"object", "$ref":"/axapi/v3/visibility/flow-collector/netflow/template/detail", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "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, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } } }