.. _visibility: visibility ========== Display Network statistics visibility Specification ------------------------ ===================================== =================================================== ===================================== =================================================== **Type** *Configuration Resource* **Element Name** visibility **Element URI** /axapi/v3/visibility **Element Attributes** visibility_attributes **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:`1790_visibility_attributes` .. raw:: html
Get Object .. raw:: html GET .. raw:: html /axapi/v3/visibility .. raw:: html :ref:`1790_visibility_attributes` .. raw:: html
Modify Object .. raw:: html POST .. raw:: html /axapi/v3/visibility .. raw:: html :ref:`1790_visibility_attributes` .. raw:: html
Replace Object .. raw:: html PUT .. raw:: html /axapi/v3/visibility .. raw:: html :ref:`1790_visibility_attributes` .. raw:: html
Delete Object .. raw:: html DELETE .. raw:: html /axapi/v3/visibility .. raw:: html :ref:`1790_visibility_attributes` .. raw:: html
.. _1790_visibility_attributes: visibility attributes --------------------- **anomaly-detection** **Description:** anomaly-detection is a **JSON Block**. Please see below for :ref:`1790_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:`1790_debug-files` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/debug-files ` **file** **Description:** file is a **JSON Block**. Please see below for :ref:`1790_file` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/file ` **flow-collector** **Description:** flow-collector is a **JSON Block**. Please see below for :ref:`1790_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:`1790_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:`1790_monitor` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitor ` **monitored-entity** **Description:** monitored-entity is a **JSON Block**. Please see below for :ref:`1790_monitored-entity` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitored-entity ` **reporting** **Description:** reporting is a **JSON Block**. Please see below for :ref:`1790_reporting` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/reporting ` **resource-usage** **Description:** resource-usage is a **JSON Block**. Please see below for :ref:`1790_resource-usage` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/resource-usage ` **sampling-enable** **Type:** List **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:`1790_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 .. _1790_flow-collector: flow-collector ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **netflow** **Description:** netflow is a **JSON Block**. Please see below for :ref:`1790_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:`1790_flow-collector_sflow` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/flow-collector/sflow ` .. _1790_flow-collector_netflow: flow-collector_netflow ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **template** **Description:** template is a **JSON Block**. Please see below for :ref:`1790_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 .. _1790_flow-collector_netflow_sampling-enable: flow-collector_netflow_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **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; **Type:** string **Supported Values:** 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 .. _1790_flow-collector_netflow_template: flow-collector_netflow_template ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **detail** **Description:** detail is a **JSON Block**. Please see below for :ref:`1790_flow-collector_netflow_template_detail` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/flow-collector/netflow/template/detail ` **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1790_flow-collector_netflow_template_sampling-enable: flow-collector_netflow_template_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **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; **Type:** string **Supported Values:** all, templates-added-to-delq, templates-removed-from-delq .. _1790_flow-collector_netflow_template_detail: flow-collector_netflow_template_detail ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1790_flow-collector_sflow: flow-collector_sflow ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1790_flow-collector_sflow_sampling-enable: flow-collector_sflow_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **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; **Type:** string **Supported Values:** all, pkts-received, frag-dropped, agent-not-found, version-not-supported, unknown-dir .. _1790_resource-usage: resource-usage ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1790_mon-entity-telemetry-data: mon-entity-telemetry-data ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1790_mon-entity-telemetry-data_sampling-enable: mon-entity-telemetry-data_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **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; **Type:** string **Supported Values:** 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 .. _1790_anomaly-detection: anomaly-detection ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **feature-status** **Description** 'enable': Enable anomaly-detection; 'disable': Disable anomaly detection (default); **Type:** string **Supported Values:** enable, disable **Default:** disable **logging** **Description** 'per-entity': Enable per entity logging; 'per-metric': Enable per metric logging with threshold details; 'disable': Disable anomaly notifications (Default); **Type:** string **Supported Values:** per-entity, per-metric, disable **Default:** disable **restart-learning-on-anomaly** **Description** Relearn anomaly detection parameters after detecting an anomaly **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **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 .. _1790_reporting: reporting ^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sampling-enable** **Type:** List **session-logging** **Description** 'enable': Enable session logging; 'disable': Disable session logging(default); **Type:** string **Supported Values:** enable, disable **Default:** disable **telemetry-export-interval** **Description:** telemetry-export-interval is a **JSON Block**. Please see below for :ref:`1790_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:`1790_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 .. _1790_reporting_sampling-enable: reporting_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **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; **Type:** string **Supported Values:** all, log-transmit-failure, buffer-alloc-failure, notif-jobs-in-queue, enqueue-fail, enqueue-pass, dequeued .. _1790_reporting_template: reporting_template ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **notification** **Description:** notification is a **JSON Block**. Please see below for :ref:`1790_reporting_template_notification` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/reporting/template/notification ` .. _1790_reporting_template_notification: reporting_template_notification ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **debug** **Description:** debug is a **JSON Block**. Please see below for :ref:`1790_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} ` .. _1790_reporting_template_notification_debug: reporting_template_notification_debug ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1790_reporting_template_notification_template-name-list: reporting_template_notification_template-name-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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:`1790_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:** / **sampling-enable** **Type:** List **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 .. _1790_reporting_template_notification_template-name-list_authentication: reporting_template_notification_template-name-list_authentication ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1790_reporting_template_notification_template-name-list_sampling-enable: reporting_template_notification_template-name-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'sent_successful': Sent successful; 'send_fail': Send failures; 'response_fail': Response failures; **Type:** string **Supported Values:** all, sent_successful, send_fail, response_fail .. _1790_reporting_telemetry-export-interval: reporting_telemetry-export-interval ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1790_monitored-entity: monitored-entity ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **detail** **Description:** detail is a **JSON Block**. Please see below for :ref:`1790_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:`1790_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:`1790_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:`1790_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 .. _1790_monitored-entity_secondary: monitored-entity_secondary ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **topk** **Description:** topk is a **JSON Block**. Please see below for :ref:`1790_monitored-entity_secondary_topk` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitored-entity/secondary/topk ` .. _1790_monitored-entity_secondary_topk: monitored-entity_secondary_topk ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sources** **Description:** sources is a **JSON Block**. Please see below for :ref:`1790_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 .. _1790_monitored-entity_secondary_topk_sources: monitored-entity_secondary_topk_sources ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1790_monitored-entity_sessions: monitored-entity_sessions ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1790_monitored-entity_topk: monitored-entity_topk ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sources** **Description:** sources is a **JSON Block**. Please see below for :ref:`1790_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 .. _1790_monitored-entity_topk_sources: monitored-entity_topk_sources ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1790_monitored-entity_detail: monitored-entity_detail ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **debug** **Description:** debug is a **JSON Block**. Please see below for :ref:`1790_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 .. _1790_monitored-entity_detail_debug: monitored-entity_detail_debug ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1790_debug-files: debug-files ^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1790_sampling-enable: sampling-enable ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **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; **Type:** string **Supported Values:** 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 .. _1790_file: file ^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **metrics** **Description:** metrics is a **JSON Block**. Please see below for :ref:`1790_file_metrics` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/file/metrics ` .. _1790_file_metrics: file_metrics ^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1790_topk: topk ^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **sources** **Description:** sources is a **JSON Block**. Please see below for :ref:`1790_topk_sources` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/topk/sources ` .. _1790_topk_sources: topk_sources ^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1790_monitor: monitor ^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **agent-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/visibility/monitor/agent/{agent-name} ` **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:`1790_monitor_delete-debug-file` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitor/delete-debug-file/{debug-ip-addr} ` **index-sessions** **Description** Start indexing associated sessions **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **index-sessions-type** **Description** 'per-cpu': Use per cpu list; **Type:** string **Supported Values:** per-cpu **mon-entity-topk** **Description** Enable topk for primary entities **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **monitor-key** **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; **Type:** string **Supported Values:** source, dest, service, source-nat-ip **netflow** **Description:** netflow is a **JSON Block**. Please see below for :ref:`1790_monitor_netflow` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/monitor/netflow ` **primary-monitor** **Description** 'traffic': Mointor traffic; **Type:** string **Supported Values:** traffic **replay-debug-file** **Description:** replay-debug-file is a **JSON Block**. Please see below for :ref:`1790_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:`1790_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:`1790_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:`1790_monitor_template` **Type:** Object **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1790_monitor_debug-list: monitor_debug-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1790_monitor_sflow: monitor_sflow ^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1790_monitor_delete-debug-file: monitor_delete-debug-file ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1790_monitor_template: monitor_template ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **notification** **Type:** List .. _1790_monitor_template_notification: monitor_template_notification ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 ` .. _1790_monitor_replay-debug-file: monitor_replay-debug-file ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1790_monitor_netflow: monitor_netflow ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1790_monitor_secondary-monitor: monitor_secondary-monitor ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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:`1790_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:`1790_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 .. _1790_monitor_secondary-monitor_debug-list: monitor_secondary-monitor_debug-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1790_monitor_secondary-monitor_delete-debug-file: monitor_secondary-monitor_delete-debug-file ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1790_monitor_secondary-monitor_replay-debug-file: monitor_secondary-monitor_replay-debug-file ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1790_monitor_agent-list: monitor_agent-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **agent-name** **Description** Specify name for the agent **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **agent-v4-addr** **Description** Configure agent's IPv4 address **Type:** string **Format:** ipv4-address **agent-v6-addr** **Description** Configure agent's IPv6 address **Type:** string **Format:** ipv6-address **sampling-enable** **Type:** List **user-tag** **Description** Customized tag **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 .. _1790_monitor_agent-list_sampling-enable: monitor_agent-list_sampling-enable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **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; **Type:** string **Supported Values:** 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 .. _1790_stats_data: stats data ---------- .. list-table:: :widths: 10 20 30 80 :header-rows: 2 :stub-columns: 1 * - - Counter - Size - Description * - - - - * - - ha-entity-delete-sent - 8 - Total montior entity HA delete messages sent * - - out-of-memory-alloc-failures - 8 - Out of memory allocation failures * - - mon-entity-rrd-tune-err - 8 - Total monitor entity rrd tune error * - - mon-entity-rrd-file-timestamp-err - 8 - Total monitor entity rrd file timestamp errors * - - lw-mon-entity-limit-exceed - 8 - Light weight limit exceeded errors * - - ha-entity-periodic-sync-sent - 8 - Total monitor entity periodic sync messages sent * - - mon-entity-rrd-last-update-fetch-failed-err - 8 - Total monitor entity rrd last update fetch failed error * - - ha-entity-create-sent - 8 - Total montior entity HA create messages sent * - - lw-mon-entity-created - 8 - Total Light-weight entities created * - - mon-entity-rrd-update-err - 8 - Total monitor entity rrd update error * - - mon-entity-rrd-out-of-memory-err - 8 - Total monitor entity rrd load failed, out of memory error * - - ha-entity-anomaly-off-sent - 8 - Total anomaly off HA messages sent * - - mon-entity-rrd-file-create-err - 8 - Total monitor entity rrd file create error * - - mon-entity-limit-exceed - 8 - Total monitor entity limit exceed failures * - - lw-mon-entity-deleted - 8 - Total Light-weight entities deleted * - - lw-out-of-memory-alloc-failures - 8 - Light Weight Out-of-memory allocation failures * - - ha-entity-anomaly-on-sent - 8 - Total anomaly on HA messages sent