.. _visibility: visibility ========== Display Network statistics visibility Specification ------------------------ ===================================== =================================================== **Parameter** **Value** ===================================== =================================================== **Type** *Configuration Resource* **Element Name** visibility **Element URI** /axapi/v3/visibility **Element Attributes** visibility_attributes **Partition Visibility** None **Statistics Data URI** /axapi/v3/visibility/stats **Schema** :download:`visibility schema ` ===================================== =================================================== **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Create Object .. raw:: html POST .. raw:: html /axapi/v3/visibility .. raw:: html :ref:`1298_visibility_attributes` .. raw:: html
Get Object .. raw:: html GET .. raw:: html /axapi/v3/visibility .. raw:: html :ref:`1298_visibility_attributes` .. raw:: html
Modify Object .. raw:: html POST .. raw:: html /axapi/v3/visibility .. raw:: html :ref:`1298_visibility_attributes` .. raw:: html
Replace Object .. raw:: html PUT .. raw:: html /axapi/v3/visibility .. raw:: html :ref:`1298_visibility_attributes` .. raw:: html
Delete Object .. raw:: html DELETE .. raw:: html /axapi/v3/visibility .. raw:: html :ref:`1298_visibility_attributes` .. raw:: html
.. _1298_visibility_attributes: visibility attributes --------------------- **anomaly-detection** **Description:** anomaly-detection is a **JSON Block**. Please see below for :ref:`1298_anomaly-detection` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/anomaly-detection ` **debug-files** **Description:** debug-files is a **JSON Block**. Please see below for :ref:`1298_debug-files` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/debug-files ` **file** **Description:** file is a **JSON Block**. Please see below for :ref:`1298_file` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/file ` **flow-collector** **Description:** flow-collector is a **JSON Block**. Please see below for :ref:`1298_flow-collector` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/flow-collector ` **granularity** **Description** Granularity for rate based calculations in seconds (default 5) **Type:** number **Range:** 1-300 **Default:** 5 **initial-learning-interval** **Description** Initial learning interval (in hours) before processing **Type:** number **Range:** 1-168 **mon-entity-telemetry-data** **Description:** mon-entity-telemetry-data is a **JSON Block**. Please see below for :ref:`1298_mon-entity-telemetry-data` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/mon-entity-telemetry-data ` **monitor** **Description:** monitor is a **JSON Block**. Please see below for :ref:`1298_monitor` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitor ` **monitored-entity** **Description:** monitored-entity is a **JSON Block**. Please see below for :ref:`1298_monitored-entity` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitored-entity ` **reporting** **Description:** reporting is a **JSON Block**. Please see below for :ref:`1298_reporting` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/reporting ` **resource-usage** **Description:** resource-usage is a **JSON Block**. Please see below for :ref:`1298_resource-usage` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/resource-usage ` **source-entity-topk** **Description** Enable topk for sources **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **topk** **Description:** topk is a **JSON Block**. Please see below for :ref:`1298_topk` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/topk ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **zbar** **Description:** zbar is a **JSON Block**. Please see below for :ref:`1298_zbar` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/zbar ` .. _1298_flow-collector: flow-collector ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **netflow** **Description:** netflow is a **JSON Block**. Please see below for :ref:`1298_flow-collector_netflow` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/flow-collector/netflow ` **sflow** **Description:** sflow is a **JSON Block**. Please see below for :ref:`1298_flow-collector_sflow` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/flow-collector/sflow ` .. _1298_flow-collector_netflow: flow-collector_netflow ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **template** **Description:** template is a **JSON Block**. Please see below for :ref:`1298_flow-collector_netflow_template` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/flow-collector/netflow/template ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_flow-collector_netflow_template: flow-collector_netflow_template ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **detail** **Description:** detail is a **JSON Block**. Please see below for :ref:`1298_flow-collector_netflow_template_detail` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/flow-collector/netflow/template/detail ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_flow-collector_netflow_template_detail: flow-collector_netflow_template_detail ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_flow-collector_sflow: flow-collector_sflow ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_resource-usage: resource-usage ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_zbar: zbar ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'enable': Enable zbar infra; 'disable': Disable zbar infra(default); **Type:** string **Supported Values:** enable, disable **Default:** disable **dest** **Description:** dest is a **JSON Block**. Please see below for :ref:`1298_zbar_dest` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/zbar/dest ` **truples** **Description:** truples is a **JSON Block**. Please see below for :ref:`1298_zbar_truples` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/zbar/truples ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_zbar_dest: zbar_dest ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_zbar_truples: zbar_truples ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_mon-entity-telemetry-data: mon-entity-telemetry-data ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_anomaly-detection: anomaly-detection ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sensitivity** **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); **Type:** string **Supported Values:** high, low **Default:** low **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_reporting: reporting ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **grouping-export-interval** **Description:** grouping-export-interval is a **JSON Block**. Please see below for :ref:`1298_reporting_grouping-export-interval` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/reporting/grouping-export-interval ` **telemetry-export-interval** **Description:** telemetry-export-interval is a **JSON Block**. Please see below for :ref:`1298_reporting_telemetry-export-interval` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/reporting/telemetry-export-interval ` **template** **Description:** template is a **JSON Block**. Please see below for :ref:`1298_reporting_template` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/reporting/template ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_reporting_grouping-export-interval: reporting_grouping-export-interval ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **value** **Description** The aggregation and exporting interval in seconds (Default 30 seconds) **Type:** number **Range:** 10-300 **Default:** 30 .. _1298_reporting_template: reporting_template ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **notification** **Description:** notification is a **JSON Block**. Please see below for :ref:`1298_reporting_template_notification` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/reporting/template/notification ` .. _1298_reporting_template_notification: reporting_template_notification ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **debug** **Description:** debug is a **JSON Block**. Please see below for :ref:`1298_reporting_template_notification_debug` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/reporting/template/notification/debug ` **template-name-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/visibility/reporting/template/notification/template-name/{name} ` .. _1298_reporting_template_notification_debug: reporting_template_notification_debug ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_reporting_template_notification_template-name-list: reporting_template_notification_template-name-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** 'enable': Enable; 'disable': Disable; **Type:** string **Supported Values:** enable, disable **Default:** enable **authentication** **Description:** authentication is a **JSON Block**. Please see below for :ref:`1298_reporting_template_notification_template-name-list_authentication` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/reporting/template/notification/template-name/{name}/authentication ` **debug-mode** **Description** Enable debug mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **host-name** **Description** Configure the host name(e.g www.a10networks.com) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Mutual Exclusion:** host-name, ipv4-address, and ipv6-address are mutually exclusive **http-port** **Description** Configure the http port to use(default 80) (http port(default 80)) **Type:** number **Range:** 1-65535 **Default:** 80 **https-port** **Description** Configure the https port to use(default 443) (http port(default 443)) **Type:** number **Range:** 1-65535 **Default:** 443 **ipv4-address** **Description** Configure the host IPv4 address **Type:** string **Format:** ipv4-address **Mutual Exclusion:** ipv4-address, ipv6-address, and host-name are mutually exclusive **ipv6-address** **Description** Configure the host IPv6 address **Type:** string **Format:** ipv6-address **Mutual Exclusion:** ipv6-address, ipv4-address, and host-name are mutually exclusive **name** **Description** Notification template name **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **protocol** **Description** 'http': Use http protocol; 'https': Use https protocol(default); (http protocol) **Type:** string **Supported Values:** http, https **Default:** https **relative-uri** **Description** Configure the relative uri(e.g /example , default /) **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **Default:** / **test-connectivity** **Description** Test connectivity to notification receiver **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **use-mgmt-port** **Description** Use management port for notifications **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_reporting_template_notification_template-name-list_authentication: reporting_template_notification_template-name-list_authentication ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **api-key** **Description** Configure api-key as a mode of authentication **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **api-key-encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string) **api-key-string** **Description** Configure api-key as a mode of authentication **Type:** string **Format:** password **Maximum Length:** 64 characters **Maximum Length:** 1 characters **auth-password** **Description** Configure the authentication user password (Authentication password) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **auth-password-string** **Description** Configure the authentication user password (Authentication password) **Type:** string **Format:** password **Maximum Length:** 63 characters **Maximum Length:** 1 characters **auth-username** **Description** Configure the authentication user name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string) **relative-login-uri** **Description** Configure the authentication login uri **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **relative-logoff-uri** **Description** Configure the authentication logoff uri **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_reporting_telemetry-export-interval: reporting_telemetry-export-interval ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **value** **Description** Monitored entity telemetry data export interval in mins (Default 5 mins) **Type:** number **Range:** 1-5 **Default:** 5 .. _1298_monitored-entity: monitored-entity ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **detail** **Description:** detail is a **JSON Block**. Please see below for :ref:`1298_monitored-entity_detail` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitored-entity/detail ` **secondary** **Description:** secondary is a **JSON Block**. Please see below for :ref:`1298_monitored-entity_secondary` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitored-entity/secondary ` **sessions** **Description:** sessions is a **JSON Block**. Please see below for :ref:`1298_monitored-entity_sessions` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitored-entity/sessions ` **topk** **Description:** topk is a **JSON Block**. Please see below for :ref:`1298_monitored-entity_topk` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitored-entity/topk ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_monitored-entity_secondary: monitored-entity_secondary ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **topk** **Description:** topk is a **JSON Block**. Please see below for :ref:`1298_monitored-entity_secondary_topk` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitored-entity/secondary/topk ` .. _1298_monitored-entity_secondary_topk: monitored-entity_secondary_topk ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sources** **Description:** sources is a **JSON Block**. Please see below for :ref:`1298_monitored-entity_secondary_topk_sources` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitored-entity/secondary/topk/sources ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_monitored-entity_secondary_topk_sources: monitored-entity_secondary_topk_sources ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_monitored-entity_sessions: monitored-entity_sessions ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_monitored-entity_topk: monitored-entity_topk ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sources** **Description:** sources is a **JSON Block**. Please see below for :ref:`1298_monitored-entity_topk_sources` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitored-entity/topk/sources ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_monitored-entity_topk_sources: monitored-entity_topk_sources ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_monitored-entity_detail: monitored-entity_detail ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **debug** **Description:** debug is a **JSON Block**. Please see below for :ref:`1298_monitored-entity_detail_debug` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitored-entity/detail/debug ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_monitored-entity_detail_debug: monitored-entity_detail_debug ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_debug-files: debug-files ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_file: file ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **metrics** **Description:** metrics is a **JSON Block**. Please see below for :ref:`1298_file_metrics` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/file/metrics ` .. _1298_file_metrics: file_metrics ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'enable': Enable persistent storage(default); 'disable': Disable persistent storage; **Type:** string **Supported Values:** enable, disable **Default:** enable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_topk: topk ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **sources** **Description:** sources is a **JSON Block**. Please see below for :ref:`1298_topk_sources` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/topk/sources ` .. _1298_topk_sources: topk_sources ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_monitor: monitor ^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **debug-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/visibility/monitor/debug/{debug-ip-addr}+{debug-port}+{debug-protocol} ` **delete-debug-file** **Description:** delete-debug-file is a **JSON Block**. Please see below for :ref:`1298_monitor_delete-debug-file` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitor/delete-debug-file/{debug-ip-addr} ` **mon-entity-topk** **Description** Enable topk for primary entities **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **monitor-key** **Description** 'dest': Monitor traffic to any destination; 'service': Monitor traffic to any service; **Type:** string **Supported Values:** dest, service **netflow** **Description:** netflow is a **JSON Block**. Please see below for :ref:`1298_monitor_netflow` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitor/netflow ` **port-scan-filter-settings** **Description:** port-scan-filter-settings is a **JSON Block**. Please see below for :ref:`1298_monitor_port-scan-filter-settings` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitor/port-scan-filter-settings ` **primary-monitor** **Description** 'xflow': Monitor xflow samples; **Type:** string **Supported Values:** xflow **replay-debug-file** **Description:** replay-debug-file is a **JSON Block**. Please see below for :ref:`1298_monitor_replay-debug-file` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitor/replay-debug-file/{debug-ip-addr} ` **secondary-monitor** **Description:** secondary-monitor is a **JSON Block**. Please see below for :ref:`1298_monitor_secondary-monitor` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitor/secondary-monitor ` **sflow** **Description:** sflow is a **JSON Block**. Please see below for :ref:`1298_monitor_sflow` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitor/sflow ` **source-entity-topk** **Description** Enable topk for sources to primary-entities **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **template** **Description:** template is a **JSON Block**. Please see below for :ref:`1298_monitor_template` **Type:** Object **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **v4-class-list** **Description** Class list of ipv4 addresses to be monitored **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` **v4-grouping** **Description** Enable aggregate the log and notification per class-list **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **v6-class-list** **Description** Class list of ipv6 addresses to be monitored **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/class-list ` **v6-grouping** **Description** Enable aggregate the log and notification per class-list **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1298_monitor_debug-list: monitor_debug-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **debug-ip-addr** **Description** Specify source/dest ip addr **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **debug-port** **Description** Specify port **Type:** number **Range:** 1-65535 **debug-protocol** **Description** 'TCP': TCP; 'UDP': UDP; 'ICMP': ICMP; **Type:** string **Supported Values:** TCP, UDP, ICMP **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_monitor_sflow: monitor_sflow ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **listening-port** **Description** sFlow port to receive packets (sFlow port number(default 6343)) **Type:** number **Range:** 1-65535 **Default:** 6343 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_monitor_delete-debug-file: monitor_delete-debug-file ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **debug-ip-addr** **Description** Specify source/dest ip addr **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **debug-port** **Description** Specify port **Type:** number **Range:** 1-65535 **debug-protocol** **Description** 'TCP': TCP; 'UDP': UDP; 'ICMP': ICMP; **Type:** string **Supported Values:** TCP, UDP, ICMP .. _1298_monitor_replay-debug-file: monitor_replay-debug-file ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **debug-ip-addr** **Description** Specify source/dest ip addr **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **debug-port** **Description** Specify port **Type:** number **Range:** 1-65535 **debug-protocol** **Description** 'TCP': TCP; 'UDP': UDP; 'ICMP': ICMP; **Type:** string **Supported Values:** TCP, UDP, ICMP .. _1298_monitor_port-scan-filter-settings: monitor_port-scan-filter-settings ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **pkt-rate-threshold** **Description** packet rate threshold for the filter (default 10 pkts/sec, set to 0 pkts/sec to disable the feature) **Type:** number **Range:** 0-255 **Default:** 10 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_monitor_template: monitor_template ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **notification** **Type:** List .. _1298_monitor_template_notification: monitor_template_notification ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **notif-template-name** **Description** **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/visibility/reporting/template/notification/template-name ` .. _1298_monitor_netflow: monitor_netflow ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **listening-port** **Description** Netflow port to receive packets (Netflow port number(default 9996)) **Type:** number **Range:** 1-65535 **Default:** 9996 **template-active-timeout** **Description** Configure active timeout of the netflow templates received in mins (Template active timeout(mins)(default 30mins)) **Type:** number **Range:** 2-300 **Default:** 30 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_monitor_secondary-monitor: monitor_secondary-monitor ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **debug-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/visibility/monitor/secondary-monitor/debug/{debug-ip-addr}+{debug-port}+{debug-protocol} ` **delete-debug-file** **Description:** delete-debug-file is a **JSON Block**. Please see below for :ref:`1298_monitor_secondary-monitor_delete-debug-file` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitor/secondary-monitor/delete-debug-file/{debug-ip-addr} ` **mon-entity-topk** **Description** Enable topk for secondary entities **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **replay-debug-file** **Description:** replay-debug-file is a **JSON Block**. Please see below for :ref:`1298_monitor_secondary-monitor_replay-debug-file` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitor/secondary-monitor/replay-debug-file/{debug-ip-addr} ` **secondary-monitoring-key** **Description** 'service': Monitor traffic to any service; **Type:** string **Supported Values:** service **source-entity-topk** **Description** Enable topk for sources to secondary-entities **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_monitor_secondary-monitor_debug-list: monitor_secondary-monitor_debug-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **debug-ip-addr** **Description** Specify source/dest ip addr **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **debug-port** **Description** Specify port **Type:** number **Range:** 1-65535 **debug-protocol** **Description** 'TCP': TCP; 'UDP': UDP; 'ICMP': ICMP; **Type:** string **Supported Values:** TCP, UDP, ICMP **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1298_monitor_secondary-monitor_delete-debug-file: monitor_secondary-monitor_delete-debug-file ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **debug-ip-addr** **Description** Specify source/dest ip addr **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **debug-port** **Description** Specify port **Type:** number **Range:** 1-65535 **debug-protocol** **Description** 'TCP': TCP; 'UDP': UDP; 'ICMP': ICMP; **Type:** string **Supported Values:** TCP, UDP, ICMP .. _1298_monitor_secondary-monitor_replay-debug-file: monitor_secondary-monitor_replay-debug-file ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **debug-ip-addr** **Description** Specify source/dest ip addr **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **debug-port** **Description** Specify port **Type:** number **Range:** 1-65535 **debug-protocol** **Description** 'TCP': TCP; 'UDP': UDP; 'ICMP': ICMP; **Type:** string **Supported Values:** TCP, UDP, ICMP